The Sales Taxes And Charges Template 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
is_default boolean

Default: false

disabled boolean

Default: false

company string required
tax_category string
The Sales Taxes And Charges Template object 
{
  "id": "sales-taxes-and-charges-template_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "title": "title_example",
  "is_default": false,
  "disabled": false,
  "company": "Example Corp",
  "tax_category": "tax_category_example"
}
GET /api/accounts/sales-taxes-and-charges-template/{id}

Retrieve a sales taxes and charges template

Retrieves the details of an existing sales taxes and charges template. Supply the unique sales taxes and charges template ID that was returned from a previous request.

Path parameters

id string required

The identifier of the sales taxes and charges template to retrieve.

Returns

Returns the sales taxes and charges template object if a valid identifier was provided.

GET /api/accounts/sales-taxes-and-charges-template/{id} 
curl https://api.overplane.dev/api/accounts/sales-taxes-and-charges-template/sales-taxes-and-charges-template_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "sales-taxes-and-charges-template_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "title": "title_example",
  "is_default": false,
  "disabled": false,
  "company": "Example Corp",
  "tax_category": "tax_category_example"
}
GET /api/accounts/sales-taxes-and-charges-template

List all sales taxes and charges templates

Returns a list of sales taxes and charges templates. 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 sales taxes and charges template objects.

GET /api/accounts/sales-taxes-and-charges-template 
curl https://api.overplane.dev/api/accounts/sales-taxes-and-charges-template \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "sales-taxes-and-charges-template_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "title": "title_example",
      "is_default": false,
      "disabled": false,
      "company": "Example Corp",
      "tax_category": "tax_category_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/sales-taxes-and-charges-template

Create a sales taxes and charges template

Creates a new sales taxes and charges template object.

Body parameters

title string required
is_default boolean

Default: false

disabled boolean

Default: false

company string required
tax_category string

Returns

Returns the newly created sales taxes and charges template object if the call succeeded.

POST /api/accounts/sales-taxes-and-charges-template 
curl https://api.overplane.dev/api/accounts/sales-taxes-and-charges-template \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"title":"title_example","company":"Example Corp"}'
Response 
{
  "id": "sales-taxes-and-charges-template_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "title": "title_example",
  "is_default": false,
  "disabled": false,
  "company": "Example Corp",
  "tax_category": "tax_category_example"
}
PATCH /api/accounts/sales-taxes-and-charges-template/{id}

Update a sales taxes and charges template

Updates the specified sales taxes and charges template 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 sales taxes and charges template to update.

Body parameters

title string
is_default boolean

Default: false

disabled boolean

Default: false

company string
tax_category string

Returns

Returns the updated sales taxes and charges template object.

PATCH /api/accounts/sales-taxes-and-charges-template/{id} 
curl https://api.overplane.dev/api/accounts/sales-taxes-and-charges-template/sales-taxes-and-charges-template_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"title":"title_example","is_default":false}'
Response 
{
  "id": "sales-taxes-and-charges-template_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "title": "title_example",
  "is_default": false,
  "disabled": false,
  "company": "Example Corp",
  "tax_category": "tax_category_example"
}
DELETE /api/accounts/sales-taxes-and-charges-template/{id}

Delete a sales taxes and charges template

Permanently deletes a sales taxes and charges template. This cannot be undone.

Path parameters

id string required

The identifier of the sales taxes and charges template to delete.

Returns

Returns a confirmation that the sales taxes and charges template has been deleted.

DELETE /api/accounts/sales-taxes-and-charges-template/{id} 
curl https://api.overplane.dev/api/accounts/sales-taxes-and-charges-template/sales-taxes-and-charges-template_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "sales-taxes-and-charges-template_abc123",
  "deleted": true
}