The POS Closing Entry Detail object

Attributes

id string

Unique identifier for the object.

idx integer
pos_closing_entry_id string required
mode_of_payment string required
expected_amount number
difference number
opening_amount number required
closing_amount number

Default: 0

The POS Closing Entry Detail object 
{
  "id": "p-o-s-closing-entry-detail_abc123",
  "idx": 1,
  "pos_closing_entry_id": "pos_closing_entry_id_example",
  "mode_of_payment": "mode_of_payment_example",
  "expected_amount": 0,
  "difference": 0,
  "opening_amount": 0,
  "closing_amount": 0
}
GET /api/accounts/p-o-s-closing-entry-detail?parent_id={id}

List pos closing entry details by parent

Returns all pos closing entry details 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 detail objects belonging to the parent.

GET /api/accounts/p-o-s-closing-entry-detail?parent_id={id} 
curl https://api.overplane.dev/api/accounts/p-o-s-closing-entry-detail?parent_id=parent_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "p-o-s-closing-entry-detail_abc123",
      "idx": 1,
      "pos_closing_entry_id": "pos_closing_entry_id_example",
      "mode_of_payment": "mode_of_payment_example",
      "expected_amount": 0,
      "difference": 0,
      "opening_amount": 0,
      "closing_amount": 0
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/p-o-s-closing-entry-detail

Create a pos closing entry detail

Creates a new pos closing entry detail object.

Body parameters

idx integer
pos_closing_entry_id string required
mode_of_payment string required
expected_amount number
difference number
opening_amount number required
closing_amount number

Default: 0

Returns

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

POST /api/accounts/p-o-s-closing-entry-detail 
curl https://api.overplane.dev/api/accounts/p-o-s-closing-entry-detail \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"pos_closing_entry_id":"pos_closing_entry_id_example","mode_of_payment":"mode_of_payment_example","opening_amount":0}'
Response 
{
  "id": "p-o-s-closing-entry-detail_abc123",
  "idx": 1,
  "pos_closing_entry_id": "pos_closing_entry_id_example",
  "mode_of_payment": "mode_of_payment_example",
  "expected_amount": 0,
  "difference": 0,
  "opening_amount": 0,
  "closing_amount": 0
}
PATCH /api/accounts/p-o-s-closing-entry-detail/{id}

Update a pos closing entry detail

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

Body parameters

idx integer
pos_closing_entry_id string
mode_of_payment string
expected_amount number
difference number
opening_amount number
closing_amount number

Default: 0

Returns

Returns the updated pos closing entry detail object.

PATCH /api/accounts/p-o-s-closing-entry-detail/{id} 
curl https://api.overplane.dev/api/accounts/p-o-s-closing-entry-detail/p-o-s-closing-entry-detail_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-detail_abc123",
  "idx": 1,
  "pos_closing_entry_id": "pos_closing_entry_id_example",
  "mode_of_payment": "mode_of_payment_example",
  "expected_amount": 0,
  "difference": 0,
  "opening_amount": 0,
  "closing_amount": 0
}
DELETE /api/accounts/p-o-s-closing-entry-detail/{id}

Delete a pos closing entry detail

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

Path parameters

id string required

The identifier of the pos closing entry detail to delete.

Returns

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

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

Reorder pos closing entry details

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

Returns

Returns the reordered list.

POST /api/accounts/p-o-s-closing-entry-detail/reorder 
curl https://api.overplane.dev/api/accounts/p-o-s-closing-entry-detail/reorder \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "p-o-s-closing-entry-detail_abc123",
  "idx": 1,
  "pos_closing_entry_id": "pos_closing_entry_id_example",
  "mode_of_payment": "mode_of_payment_example",
  "expected_amount": 0,
  "difference": 0,
  "opening_amount": 0,
  "closing_amount": 0
}