The Tax Category object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

title string required
disabled boolean

Default: false

The Tax Category object 
{
  "id": "tax-category_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "title": "title_example",
  "disabled": false
}
GET /api/accounts/tax-category/{id}

Retrieve a tax category

Retrieves the details of an existing tax category. Supply the unique tax category ID that was returned from a previous request.

Path parameters

id string required

The identifier of the tax category to retrieve.

Returns

Returns the tax category object if a valid identifier was provided.

GET /api/accounts/tax-category/{id} 
curl https://api.overplane.dev/api/accounts/tax-category/tax-category_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "tax-category_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "title": "title_example",
  "disabled": false
}
GET /api/accounts/tax-category

List all tax categorys

Returns a list of tax categorys. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of tax category objects.

GET /api/accounts/tax-category 
curl https://api.overplane.dev/api/accounts/tax-category \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "tax-category_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "title": "title_example",
      "disabled": false
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/tax-category

Create a tax category

Creates a new tax category object.

Body parameters

title string required
disabled boolean

Default: false

Returns

Returns the newly created tax category object if the call succeeded.

POST /api/accounts/tax-category 
curl https://api.overplane.dev/api/accounts/tax-category \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"title":"title_example"}'
Response 
{
  "id": "tax-category_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "title": "title_example",
  "disabled": false
}
PATCH /api/accounts/tax-category/{id}

Update a tax category

Updates the specified tax category 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 tax category to update.

Body parameters

title string
disabled boolean

Default: false

Returns

Returns the updated tax category object.

PATCH /api/accounts/tax-category/{id} 
curl https://api.overplane.dev/api/accounts/tax-category/tax-category_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"title":"title_example","disabled":false}'
Response 
{
  "id": "tax-category_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "title": "title_example",
  "disabled": false
}
DELETE /api/accounts/tax-category/{id}

Delete a tax category

Permanently deletes a tax category. This cannot be undone.

Path parameters

id string required

The identifier of the tax category to delete.

Returns

Returns a confirmation that the tax category has been deleted.

DELETE /api/accounts/tax-category/{id} 
curl https://api.overplane.dev/api/accounts/tax-category/tax-category_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "tax-category_abc123",
  "deleted": true
}