The Sales Taxes And Charges object
Attributes
id string
Unique identifier for the object.
idx integer
parent_id string required
parent_type string required
charge_type string required
row_id string
account_head string required
cost_center string
description string required
included_in_print_rate boolean
Default: false
rate number
tax_amount number
total number
tax_amount_after_discount_amount number
base_tax_amount number
base_total number
base_tax_amount_after_discount_amount number
project string
included_in_paid_amount boolean
Default: false
dont_recompute_tax boolean
Default: false
account_currency string
net_amount number
base_net_amount number
set_by_item_tax_template boolean
Default: false
is_tax_withholding_account boolean
Default: false
The Sales Taxes And Charges object
{
"id": "sales-taxes-and-charges_abc123",
"idx": 1,
"parent_id": null,
"parent_type": "parent_type_example",
"charge_type": "charge_type_example",
"row_id": "row_id_example",
"account_head": "account_head_example",
"cost_center": "cost_center_example",
"description": "description_example",
"included_in_print_rate": false,
"rate": 0,
"tax_amount": 0,
"total": 0,
"tax_amount_after_discount_amount": 0,
"base_tax_amount": 0,
"base_total": 0,
"base_tax_amount_after_discount_amount": 0,
"project": "project_example",
"included_in_paid_amount": false,
"dont_recompute_tax": false,
"account_currency": "USD",
"net_amount": 0,
"base_net_amount": 0,
"set_by_item_tax_template": false,
"is_tax_withholding_account": false
} GET
/api/accounts/sales-taxes-and-charges?parent_id={id} List sales taxes and chargess by parent
Returns all sales taxes and chargess belonging to the specified parent.
Query parameters
parent_id string required
The ID of the parent to list children for.
Returns
A list of sales taxes and charges objects belonging to the parent.
GET /api/accounts/sales-taxes-and-charges?parent_id={id}
curl https://api.overplane.dev/api/accounts/sales-taxes-and-charges?parent_id=parent_abc123 \
-H "Authorization: Bearer sk_test_..." Response
{
"data": [
{
"id": "sales-taxes-and-charges_abc123",
"idx": 1,
"parent_id": null,
"parent_type": "parent_type_example",
"charge_type": "charge_type_example",
"row_id": "row_id_example",
"account_head": "account_head_example",
"cost_center": "cost_center_example",
"description": "description_example",
"included_in_print_rate": false,
"rate": 0,
"tax_amount": 0,
"total": 0,
"tax_amount_after_discount_amount": 0,
"base_tax_amount": 0,
"base_total": 0,
"base_tax_amount_after_discount_amount": 0,
"project": "project_example",
"included_in_paid_amount": false,
"dont_recompute_tax": false,
"account_currency": "USD",
"net_amount": 0,
"base_net_amount": 0,
"set_by_item_tax_template": false,
"is_tax_withholding_account": false
}
],
"has_more": false,
"total": 1
} POST
/api/accounts/sales-taxes-and-charges Create a sales taxes and charges
Creates a new sales taxes and charges object.
Body parameters
idx integer
parent_id string required
parent_type string required
charge_type string required
row_id string
account_head string required
cost_center string
description string required
included_in_print_rate boolean
Default: false
rate number
tax_amount number
total number
tax_amount_after_discount_amount number
base_tax_amount number
base_total number
base_tax_amount_after_discount_amount number
project string
included_in_paid_amount boolean
Default: false
dont_recompute_tax boolean
Default: false
account_currency string
net_amount number
base_net_amount number
set_by_item_tax_template boolean
Default: false
is_tax_withholding_account boolean
Default: false
Returns
Returns the newly created sales taxes and charges object if the call succeeded.
POST /api/accounts/sales-taxes-and-charges
curl https://api.overplane.dev/api/accounts/sales-taxes-and-charges \
-H "Authorization: Bearer sk_test_..." \
-X POST \
-H "Content-Type: application/json" \
-d '{"parent_id":null,"parent_type":"parent_type_example","charge_type":"charge_type_example","account_head":"account_head_example","description":"description_example"}' Response
{
"id": "sales-taxes-and-charges_abc123",
"idx": 1,
"parent_id": null,
"parent_type": "parent_type_example",
"charge_type": "charge_type_example",
"row_id": "row_id_example",
"account_head": "account_head_example",
"cost_center": "cost_center_example",
"description": "description_example",
"included_in_print_rate": false,
"rate": 0,
"tax_amount": 0,
"total": 0,
"tax_amount_after_discount_amount": 0,
"base_tax_amount": 0,
"base_total": 0,
"base_tax_amount_after_discount_amount": 0,
"project": "project_example",
"included_in_paid_amount": false,
"dont_recompute_tax": false,
"account_currency": "USD",
"net_amount": 0,
"base_net_amount": 0,
"set_by_item_tax_template": false,
"is_tax_withholding_account": false
} PATCH
/api/accounts/sales-taxes-and-charges/{id} Update a sales taxes and charges
Updates the specified sales taxes and charges 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 to update.
Body parameters
idx integer
parent_id string
parent_type string
charge_type string
row_id string
account_head string
cost_center string
description string
included_in_print_rate boolean
Default: false
rate number
tax_amount number
total number
tax_amount_after_discount_amount number
base_tax_amount number
base_total number
base_tax_amount_after_discount_amount number
project string
included_in_paid_amount boolean
Default: false
dont_recompute_tax boolean
Default: false
account_currency string
net_amount number
base_net_amount number
set_by_item_tax_template boolean
Default: false
is_tax_withholding_account boolean
Default: false
Returns
Returns the updated sales taxes and charges object.
PATCH /api/accounts/sales-taxes-and-charges/{id}
curl https://api.overplane.dev/api/accounts/sales-taxes-and-charges/sales-taxes-and-charges_abc123 \
-H "Authorization: Bearer sk_test_..." \
-X PATCH \
-H "Content-Type: application/json" \
-d '{"idx":1,"parent_id":null}' Response
{
"id": "sales-taxes-and-charges_abc123",
"idx": 1,
"parent_id": null,
"parent_type": "parent_type_example",
"charge_type": "charge_type_example",
"row_id": "row_id_example",
"account_head": "account_head_example",
"cost_center": "cost_center_example",
"description": "description_example",
"included_in_print_rate": false,
"rate": 0,
"tax_amount": 0,
"total": 0,
"tax_amount_after_discount_amount": 0,
"base_tax_amount": 0,
"base_total": 0,
"base_tax_amount_after_discount_amount": 0,
"project": "project_example",
"included_in_paid_amount": false,
"dont_recompute_tax": false,
"account_currency": "USD",
"net_amount": 0,
"base_net_amount": 0,
"set_by_item_tax_template": false,
"is_tax_withholding_account": false
} DELETE
/api/accounts/sales-taxes-and-charges/{id} Delete a sales taxes and charges
Permanently deletes a sales taxes and charges. This cannot be undone.
Path parameters
id string required
The identifier of the sales taxes and charges to delete.
Returns
Returns a confirmation that the sales taxes and charges has been deleted.
DELETE /api/accounts/sales-taxes-and-charges/{id}
curl https://api.overplane.dev/api/accounts/sales-taxes-and-charges/sales-taxes-and-charges_abc123 \
-H "Authorization: Bearer sk_test_..." \
-X DELETE Response
{
"id": "sales-taxes-and-charges_abc123",
"deleted": true
} POST
/api/accounts/sales-taxes-and-charges/reorder Reorder sales taxes and chargess
Updates the sort order of sales taxes and chargess within their parent by setting new index values.
Returns
Returns the reordered list.
POST /api/accounts/sales-taxes-and-charges/reorder
curl https://api.overplane.dev/api/accounts/sales-taxes-and-charges/reorder \
-H "Authorization: Bearer sk_test_..." \
-X POST Response
{
"id": "sales-taxes-and-charges_abc123",
"idx": 1,
"parent_id": null,
"parent_type": "parent_type_example",
"charge_type": "charge_type_example",
"row_id": "row_id_example",
"account_head": "account_head_example",
"cost_center": "cost_center_example",
"description": "description_example",
"included_in_print_rate": false,
"rate": 0,
"tax_amount": 0,
"total": 0,
"tax_amount_after_discount_amount": 0,
"base_tax_amount": 0,
"base_total": 0,
"base_tax_amount_after_discount_amount": 0,
"project": "project_example",
"included_in_paid_amount": false,
"dont_recompute_tax": false,
"account_currency": "USD",
"net_amount": 0,
"base_net_amount": 0,
"set_by_item_tax_template": false,
"is_tax_withholding_account": false
}