The Allowed To Transact With object

Attributes

id string

Unique identifier for the object.

idx integer
parent_id string required
parent_type string required
company string required
The Allowed To Transact With object 
{
  "id": "allowed-to-transact-with_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "company": "Example Corp"
}
GET /api/accounts/allowed-to-transact-with?parent_id={id}

List allowed to transact withs by parent

Returns all allowed to transact withs belonging to the specified parent.

Query parameters

parent_id string required

The ID of the parent to list children for.

Returns

A list of allowed to transact with objects belonging to the parent.

GET /api/accounts/allowed-to-transact-with?parent_id={id} 
curl https://api.overplane.dev/api/accounts/allowed-to-transact-with?parent_id=parent_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "allowed-to-transact-with_abc123",
      "idx": 1,
      "parent_id": null,
      "parent_type": "parent_type_example",
      "company": "Example Corp"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/allowed-to-transact-with

Create a allowed to transact with

Creates a new allowed to transact with object.

Body parameters

idx integer
parent_id string required
parent_type string required
company string required

Returns

Returns the newly created allowed to transact with object if the call succeeded.

POST /api/accounts/allowed-to-transact-with 
curl https://api.overplane.dev/api/accounts/allowed-to-transact-with \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"parent_id":null,"parent_type":"parent_type_example","company":"Example Corp"}'
Response 
{
  "id": "allowed-to-transact-with_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "company": "Example Corp"
}
PATCH /api/accounts/allowed-to-transact-with/{id}

Update a allowed to transact with

Updates the specified allowed to transact with by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the allowed to transact with to update.

Body parameters

idx integer
parent_id string
parent_type string
company string

Returns

Returns the updated allowed to transact with object.

PATCH /api/accounts/allowed-to-transact-with/{id} 
curl https://api.overplane.dev/api/accounts/allowed-to-transact-with/allowed-to-transact-with_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"idx":1,"parent_id":null}'
Response 
{
  "id": "allowed-to-transact-with_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "company": "Example Corp"
}
DELETE /api/accounts/allowed-to-transact-with/{id}

Delete a allowed to transact with

Permanently deletes a allowed to transact with. This cannot be undone.

Path parameters

id string required

The identifier of the allowed to transact with to delete.

Returns

Returns a confirmation that the allowed to transact with has been deleted.

DELETE /api/accounts/allowed-to-transact-with/{id} 
curl https://api.overplane.dev/api/accounts/allowed-to-transact-with/allowed-to-transact-with_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "allowed-to-transact-with_abc123",
  "deleted": true
}
POST /api/accounts/allowed-to-transact-with/reorder

Reorder allowed to transact withs

Updates the sort order of allowed to transact withs within their parent by setting new index values.

Returns

Returns the reordered list.

POST /api/accounts/allowed-to-transact-with/reorder 
curl https://api.overplane.dev/api/accounts/allowed-to-transact-with/reorder \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "allowed-to-transact-with_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "company": "Example Corp"
}