The South Africa VAT Account object

Attributes

id string

Unique identifier for the object.

idx integer
south_africa_vat_settings_id string required
account string
The South Africa VAT Account object 
{
  "id": "south-africa-v-a-t-account_abc123",
  "idx": 1,
  "south_africa_vat_settings_id": "south_africa_vat_settings_id_example",
  "account": "account_example"
}
GET /api/accounts/south-africa-v-a-t-account?parent_id={id}

List south africa vat accounts by parent

Returns all south africa vat accounts belonging to the specified parent.

Query parameters

parent_id string required

The ID of the parent to list children for.

Returns

A list of south africa vat account objects belonging to the parent.

GET /api/accounts/south-africa-v-a-t-account?parent_id={id} 
curl https://api.overplane.dev/api/accounts/south-africa-v-a-t-account?parent_id=parent_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "south-africa-v-a-t-account_abc123",
      "idx": 1,
      "south_africa_vat_settings_id": "south_africa_vat_settings_id_example",
      "account": "account_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/south-africa-v-a-t-account

Create a south africa vat account

Creates a new south africa vat account object.

Body parameters

idx integer
south_africa_vat_settings_id string required
account string

Returns

Returns the newly created south africa vat account object if the call succeeded.

POST /api/accounts/south-africa-v-a-t-account 
curl https://api.overplane.dev/api/accounts/south-africa-v-a-t-account \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"south_africa_vat_settings_id":"south_africa_vat_settings_id_example"}'
Response 
{
  "id": "south-africa-v-a-t-account_abc123",
  "idx": 1,
  "south_africa_vat_settings_id": "south_africa_vat_settings_id_example",
  "account": "account_example"
}
PATCH /api/accounts/south-africa-v-a-t-account/{id}

Update a south africa vat account

Updates the specified south africa vat account 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 south africa vat account to update.

Body parameters

idx integer
south_africa_vat_settings_id string
account string

Returns

Returns the updated south africa vat account object.

PATCH /api/accounts/south-africa-v-a-t-account/{id} 
curl https://api.overplane.dev/api/accounts/south-africa-v-a-t-account/south-africa-v-a-t-account_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"idx":1,"south_africa_vat_settings_id":"south_africa_vat_settings_id_example"}'
Response 
{
  "id": "south-africa-v-a-t-account_abc123",
  "idx": 1,
  "south_africa_vat_settings_id": "south_africa_vat_settings_id_example",
  "account": "account_example"
}
DELETE /api/accounts/south-africa-v-a-t-account/{id}

Delete a south africa vat account

Permanently deletes a south africa vat account. This cannot be undone.

Path parameters

id string required

The identifier of the south africa vat account to delete.

Returns

Returns a confirmation that the south africa vat account has been deleted.

DELETE /api/accounts/south-africa-v-a-t-account/{id} 
curl https://api.overplane.dev/api/accounts/south-africa-v-a-t-account/south-africa-v-a-t-account_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "south-africa-v-a-t-account_abc123",
  "deleted": true
}
POST /api/accounts/south-africa-v-a-t-account/reorder

Reorder south africa vat accounts

Updates the sort order of south africa vat accounts within their parent by setting new index values.

Returns

Returns the reordered list.

POST /api/accounts/south-africa-v-a-t-account/reorder 
curl https://api.overplane.dev/api/accounts/south-africa-v-a-t-account/reorder \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "south-africa-v-a-t-account_abc123",
  "idx": 1,
  "south_africa_vat_settings_id": "south_africa_vat_settings_id_example",
  "account": "account_example"
}