The Bank Clearance 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.

account string required
account_currency string
from_date string required
to_date string required
bank_account string
include_reconciled_entries boolean

Default: false

include_pos_transactions boolean

Default: false

The Bank Clearance object 
{
  "id": "bank-clearance_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "account": "account_example",
  "account_currency": "USD",
  "from_date": "2024-01-15",
  "to_date": "2024-01-15",
  "bank_account": "bank_account_example",
  "include_reconciled_entries": false,
  "include_pos_transactions": false
}
GET /api/accounts/bank-clearance/{id}

Retrieve a bank clearance

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

Path parameters

id string required

The identifier of the bank clearance to retrieve.

Returns

Returns the bank clearance object if a valid identifier was provided.

GET /api/accounts/bank-clearance/{id} 
curl https://api.overplane.dev/api/accounts/bank-clearance/bank-clearance_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "bank-clearance_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "account": "account_example",
  "account_currency": "USD",
  "from_date": "2024-01-15",
  "to_date": "2024-01-15",
  "bank_account": "bank_account_example",
  "include_reconciled_entries": false,
  "include_pos_transactions": false
}
GET /api/accounts/bank-clearance

List all bank clearances

Returns a list of bank clearances. 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 bank clearance objects.

GET /api/accounts/bank-clearance 
curl https://api.overplane.dev/api/accounts/bank-clearance \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "bank-clearance_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "account": "account_example",
      "account_currency": "USD",
      "from_date": "2024-01-15",
      "to_date": "2024-01-15",
      "bank_account": "bank_account_example",
      "include_reconciled_entries": false,
      "include_pos_transactions": false
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/bank-clearance

Create a bank clearance

Creates a new bank clearance object.

Body parameters

account string required
account_currency string
from_date string required
to_date string required
bank_account string
include_reconciled_entries boolean

Default: false

include_pos_transactions boolean

Default: false

Returns

Returns the newly created bank clearance object if the call succeeded.

POST /api/accounts/bank-clearance 
curl https://api.overplane.dev/api/accounts/bank-clearance \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"account":"account_example","from_date":"2024-01-15","to_date":"2024-01-15"}'
Response 
{
  "id": "bank-clearance_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "account": "account_example",
  "account_currency": "USD",
  "from_date": "2024-01-15",
  "to_date": "2024-01-15",
  "bank_account": "bank_account_example",
  "include_reconciled_entries": false,
  "include_pos_transactions": false
}
PATCH /api/accounts/bank-clearance/{id}

Update a bank clearance

Updates the specified bank clearance 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 bank clearance to update.

Body parameters

account string
account_currency string
from_date string
to_date string
bank_account string
include_reconciled_entries boolean

Default: false

include_pos_transactions boolean

Default: false

Returns

Returns the updated bank clearance object.

PATCH /api/accounts/bank-clearance/{id} 
curl https://api.overplane.dev/api/accounts/bank-clearance/bank-clearance_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"account":"account_example","account_currency":"USD"}'
Response 
{
  "id": "bank-clearance_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "account": "account_example",
  "account_currency": "USD",
  "from_date": "2024-01-15",
  "to_date": "2024-01-15",
  "bank_account": "bank_account_example",
  "include_reconciled_entries": false,
  "include_pos_transactions": false
}
DELETE /api/accounts/bank-clearance/{id}

Delete a bank clearance

Permanently deletes a bank clearance. This cannot be undone.

Path parameters

id string required

The identifier of the bank clearance to delete.

Returns

Returns a confirmation that the bank clearance has been deleted.

DELETE /api/accounts/bank-clearance/{id} 
curl https://api.overplane.dev/api/accounts/bank-clearance/bank-clearance_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "bank-clearance_abc123",
  "deleted": true
}

Line items

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

Bank Clearance Detail

Attributes

idx integer
bank_clearance_id string required
payment_document string
payment_entry string
against_account string
amount string
posting_date string
cheque_number string
cheque_date string
clearance_date string

Endpoints

GET /api/accounts/bank-clearance-detail?parent_id={id}
POST /api/accounts/bank-clearance-detail
PATCH /api/accounts/bank-clearance-detail/{id}
DELETE /api/accounts/bank-clearance-detail/{id}
POST /api/accounts/bank-clearance-detail/reorder
Bank Clearance Detail object 
{
  "id": "bank-clearance-detail_abc123",
  "idx": 1,
  "bank_clearance_id": "bank_clearance_id_example",
  "payment_document": "payment_document_example",
  "payment_entry": "payment_entry_example",
  "against_account": "against_account_example",
  "amount": "amount_example",
  "posting_date": "2024-01-15",
  "cheque_number": "cheque_number_example",
  "cheque_date": "2024-01-15",
  "clearance_date": "2024-01-15"
}