The POS Opening Entry Detail object

Attributes

id string

Unique identifier for the object.

idx integer
pos_opening_entry_id string required
mode_of_payment string required
opening_amount number

Default: 0

The POS Opening Entry Detail object 
{
  "id": "p-o-s-opening-entry-detail_abc123",
  "idx": 1,
  "pos_opening_entry_id": "pos_opening_entry_id_example",
  "mode_of_payment": "mode_of_payment_example",
  "opening_amount": 0
}
GET /api/accounts/p-o-s-opening-entry-detail?parent_id={id}

List pos opening entry details by parent

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

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

Create a pos opening entry detail

Creates a new pos opening entry detail object.

Body parameters

idx integer
pos_opening_entry_id string required
mode_of_payment string required
opening_amount number

Default: 0

Returns

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

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

Update a pos opening entry detail

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

Body parameters

idx integer
pos_opening_entry_id string
mode_of_payment string
opening_amount number

Default: 0

Returns

Returns the updated pos opening entry detail object.

PATCH /api/accounts/p-o-s-opening-entry-detail/{id} 
curl https://api.overplane.dev/api/accounts/p-o-s-opening-entry-detail/p-o-s-opening-entry-detail_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"idx":1,"pos_opening_entry_id":"pos_opening_entry_id_example"}'
Response 
{
  "id": "p-o-s-opening-entry-detail_abc123",
  "idx": 1,
  "pos_opening_entry_id": "pos_opening_entry_id_example",
  "mode_of_payment": "mode_of_payment_example",
  "opening_amount": 0
}
DELETE /api/accounts/p-o-s-opening-entry-detail/{id}

Delete a pos opening entry detail

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

Path parameters

id string required

The identifier of the pos opening entry detail to delete.

Returns

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

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

Reorder pos opening entry details

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

Returns

Returns the reordered list.

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