The POS Closing Entry Taxes object

Attributes

id string

Unique identifier for the object.

idx integer
pos_closing_entry_id string required
amount number
account_head string
The POS Closing Entry Taxes object 
{
  "id": "p-o-s-closing-entry-taxes_abc123",
  "idx": 1,
  "pos_closing_entry_id": "pos_closing_entry_id_example",
  "amount": 0,
  "account_head": "account_head_example"
}
GET /api/accounts/p-o-s-closing-entry-taxes?parent_id={id}

List pos closing entry taxess by parent

Returns all pos closing entry taxess belonging to the specified parent.

Query parameters

parent_id string required

The ID of the parent to list children for.

Returns

A list of pos closing entry taxes objects belonging to the parent.

GET /api/accounts/p-o-s-closing-entry-taxes?parent_id={id} 
curl https://api.overplane.dev/api/accounts/p-o-s-closing-entry-taxes?parent_id=parent_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "p-o-s-closing-entry-taxes_abc123",
      "idx": 1,
      "pos_closing_entry_id": "pos_closing_entry_id_example",
      "amount": 0,
      "account_head": "account_head_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/p-o-s-closing-entry-taxes

Create a pos closing entry taxes

Creates a new pos closing entry taxes object.

Body parameters

idx integer
pos_closing_entry_id string required
amount number
account_head string

Returns

Returns the newly created pos closing entry taxes object if the call succeeded.

POST /api/accounts/p-o-s-closing-entry-taxes 
curl https://api.overplane.dev/api/accounts/p-o-s-closing-entry-taxes \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"pos_closing_entry_id":"pos_closing_entry_id_example"}'
Response 
{
  "id": "p-o-s-closing-entry-taxes_abc123",
  "idx": 1,
  "pos_closing_entry_id": "pos_closing_entry_id_example",
  "amount": 0,
  "account_head": "account_head_example"
}
PATCH /api/accounts/p-o-s-closing-entry-taxes/{id}

Update a pos closing entry taxes

Updates the specified pos closing entry taxes 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 pos closing entry taxes to update.

Body parameters

idx integer
pos_closing_entry_id string
amount number
account_head string

Returns

Returns the updated pos closing entry taxes object.

PATCH /api/accounts/p-o-s-closing-entry-taxes/{id} 
curl https://api.overplane.dev/api/accounts/p-o-s-closing-entry-taxes/p-o-s-closing-entry-taxes_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"idx":1,"pos_closing_entry_id":"pos_closing_entry_id_example"}'
Response 
{
  "id": "p-o-s-closing-entry-taxes_abc123",
  "idx": 1,
  "pos_closing_entry_id": "pos_closing_entry_id_example",
  "amount": 0,
  "account_head": "account_head_example"
}
DELETE /api/accounts/p-o-s-closing-entry-taxes/{id}

Delete a pos closing entry taxes

Permanently deletes a pos closing entry taxes. This cannot be undone.

Path parameters

id string required

The identifier of the pos closing entry taxes to delete.

Returns

Returns a confirmation that the pos closing entry taxes has been deleted.

DELETE /api/accounts/p-o-s-closing-entry-taxes/{id} 
curl https://api.overplane.dev/api/accounts/p-o-s-closing-entry-taxes/p-o-s-closing-entry-taxes_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "p-o-s-closing-entry-taxes_abc123",
  "deleted": true
}
POST /api/accounts/p-o-s-closing-entry-taxes/reorder

Reorder pos closing entry taxess

Updates the sort order of pos closing entry taxess within their parent by setting new index values.

Returns

Returns the reordered list.

POST /api/accounts/p-o-s-closing-entry-taxes/reorder 
curl https://api.overplane.dev/api/accounts/p-o-s-closing-entry-taxes/reorder \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "p-o-s-closing-entry-taxes_abc123",
  "idx": 1,
  "pos_closing_entry_id": "pos_closing_entry_id_example",
  "amount": 0,
  "account_head": "account_head_example"
}