The Cashier Closing 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.

status string

Default: draft

user string required
date string
from_time string required
time string required
expense number

Default: 0

custody number

Default: 0

returns number

Default: 0

outstanding_amount number

Default: 0

net_amount number
The Cashier Closing object 
{
  "id": "cashier-closing_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "user": "user_example",
  "date": "2024-01-15",
  "from_time": "from_time_example",
  "time": "time_example",
  "expense": 0,
  "custody": 0,
  "returns": 0,
  "outstanding_amount": 0,
  "net_amount": 0
}
GET /api/accounts/cashier-closing/{id}

Retrieve a cashier closing

Retrieves the details of an existing cashier closing. Supply the unique cashier closing ID that was returned from a previous request.

Path parameters

id string required

The identifier of the cashier closing to retrieve.

Returns

Returns the cashier closing object if a valid identifier was provided.

GET /api/accounts/cashier-closing/{id} 
curl https://api.overplane.dev/api/accounts/cashier-closing/cashier-closing_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "cashier-closing_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "user": "user_example",
  "date": "2024-01-15",
  "from_time": "from_time_example",
  "time": "time_example",
  "expense": 0,
  "custody": 0,
  "returns": 0,
  "outstanding_amount": 0,
  "net_amount": 0
}
GET /api/accounts/cashier-closing

List all cashier closings

Returns a list of cashier closings. 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 cashier closing objects.

GET /api/accounts/cashier-closing 
curl https://api.overplane.dev/api/accounts/cashier-closing \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "cashier-closing_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "user": "user_example",
      "date": "2024-01-15",
      "from_time": "from_time_example",
      "time": "time_example",
      "expense": 0,
      "custody": 0,
      "returns": 0,
      "outstanding_amount": 0,
      "net_amount": 0
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/cashier-closing

Create a cashier closing

Creates a new cashier closing object.

Body parameters

status string

Default: draft

user string required
date string
from_time string required
time string required
expense number

Default: 0

custody number

Default: 0

returns number

Default: 0

outstanding_amount number

Default: 0

net_amount number

Returns

Returns the newly created cashier closing object if the call succeeded.

POST /api/accounts/cashier-closing 
curl https://api.overplane.dev/api/accounts/cashier-closing \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"user":"user_example","from_time":"from_time_example","time":"time_example"}'
Response 
{
  "id": "cashier-closing_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "user": "user_example",
  "date": "2024-01-15",
  "from_time": "from_time_example",
  "time": "time_example",
  "expense": 0,
  "custody": 0,
  "returns": 0,
  "outstanding_amount": 0,
  "net_amount": 0
}
PATCH /api/accounts/cashier-closing/{id}

Update a cashier closing

Updates the specified cashier closing 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 cashier closing to update.

Body parameters

status string

Default: draft

user string
date string
from_time string
time string
expense number

Default: 0

custody number

Default: 0

returns number

Default: 0

outstanding_amount number

Default: 0

net_amount number

Returns

Returns the updated cashier closing object.

PATCH /api/accounts/cashier-closing/{id} 
curl https://api.overplane.dev/api/accounts/cashier-closing/cashier-closing_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","user":"user_example"}'
Response 
{
  "id": "cashier-closing_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "user": "user_example",
  "date": "2024-01-15",
  "from_time": "from_time_example",
  "time": "time_example",
  "expense": 0,
  "custody": 0,
  "returns": 0,
  "outstanding_amount": 0,
  "net_amount": 0
}
DELETE /api/accounts/cashier-closing/{id}

Delete a cashier closing

Permanently deletes a cashier closing. This cannot be undone.

Path parameters

id string required

The identifier of the cashier closing to delete.

Returns

Returns a confirmation that the cashier closing has been deleted.

DELETE /api/accounts/cashier-closing/{id} 
curl https://api.overplane.dev/api/accounts/cashier-closing/cashier-closing_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "cashier-closing_abc123",
  "deleted": true
}
POST /api/accounts/cashier-closing/{id}/submit

Submit a cashier closing

Submits a draft cashier closing, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the cashier closing to act on.

Returns

Returns the cashier closing object with updated status.

POST /api/accounts/cashier-closing/{id}/submit 
curl https://api.overplane.dev/api/accounts/cashier-closing/cashier-closing_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "cashier-closing_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "user": "user_example",
  "date": "2024-01-15",
  "from_time": "from_time_example",
  "time": "time_example",
  "expense": 0,
  "custody": 0,
  "returns": 0,
  "outstanding_amount": 0,
  "net_amount": 0
}
POST /api/accounts/cashier-closing/{id}/cancel

Cancel a cashier closing

Cancels a submitted cashier closing, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the cashier closing to act on.

Returns

Returns the cashier closing object with updated status.

POST /api/accounts/cashier-closing/{id}/cancel 
curl https://api.overplane.dev/api/accounts/cashier-closing/cashier-closing_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "cashier-closing_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "user": "user_example",
  "date": "2024-01-15",
  "from_time": "from_time_example",
  "time": "time_example",
  "expense": 0,
  "custody": 0,
  "returns": 0,
  "outstanding_amount": 0,
  "net_amount": 0
}

Line items

Child objects that belong to this cashier closing. These are accessed via the parent's ID.

Cashier Closing Payments

Attributes

idx integer
cashier_closing_id string required
mode_of_payment string required
amount number

Endpoints

GET /api/accounts/cashier-closing-payments?parent_id={id}
POST /api/accounts/cashier-closing-payments
PATCH /api/accounts/cashier-closing-payments/{id}
DELETE /api/accounts/cashier-closing-payments/{id}
POST /api/accounts/cashier-closing-payments/reorder
Cashier Closing Payments object 
{
  "id": "cashier-closing-payments_abc123",
  "idx": 1,
  "cashier_closing_id": "cashier_closing_id_example",
  "mode_of_payment": "mode_of_payment_example",
  "amount": 0
}