The Bank Transaction 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

date string
bank_account string
company string
currency string
description string
reference_number string
transaction_id string
allocated_amount number
unallocated_amount number
party_type string
party string
deposit number
withdrawal number
transaction_type string
bank_party_name string
bank_party_iban string
bank_party_account_number string
included_fee number
excluded_fee number
The Bank Transaction object 
{
  "id": "bank-transaction_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "date": "2024-01-15",
  "bank_account": "bank_account_example",
  "company": "Example Corp",
  "currency": "USD",
  "description": "description_example",
  "reference_number": "reference_number_example",
  "transaction_id": "transaction_id_example",
  "allocated_amount": 0,
  "unallocated_amount": 0,
  "party_type": "party_type_example",
  "party": "party_example",
  "deposit": 0,
  "withdrawal": 0,
  "transaction_type": "transaction_type_example",
  "bank_party_name": "bank_party_name_example",
  "bank_party_iban": "bank_party_iban_example",
  "bank_party_account_number": "bank_party_account_number_example",
  "included_fee": 0,
  "excluded_fee": 0
}
GET /api/accounts/bank-transaction/{id}

Retrieve a bank transaction

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

Path parameters

id string required

The identifier of the bank transaction to retrieve.

Returns

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

GET /api/accounts/bank-transaction/{id} 
curl https://api.overplane.dev/api/accounts/bank-transaction/bank-transaction_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "bank-transaction_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "date": "2024-01-15",
  "bank_account": "bank_account_example",
  "company": "Example Corp",
  "currency": "USD",
  "description": "description_example",
  "reference_number": "reference_number_example",
  "transaction_id": "transaction_id_example",
  "allocated_amount": 0,
  "unallocated_amount": 0,
  "party_type": "party_type_example",
  "party": "party_example",
  "deposit": 0,
  "withdrawal": 0,
  "transaction_type": "transaction_type_example",
  "bank_party_name": "bank_party_name_example",
  "bank_party_iban": "bank_party_iban_example",
  "bank_party_account_number": "bank_party_account_number_example",
  "included_fee": 0,
  "excluded_fee": 0
}
GET /api/accounts/bank-transaction

List all bank transactions

Returns a list of bank transactions. 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 transaction objects.

GET /api/accounts/bank-transaction 
curl https://api.overplane.dev/api/accounts/bank-transaction \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "bank-transaction_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "date": "2024-01-15",
      "bank_account": "bank_account_example",
      "company": "Example Corp",
      "currency": "USD",
      "description": "description_example",
      "reference_number": "reference_number_example",
      "transaction_id": "transaction_id_example",
      "allocated_amount": 0,
      "unallocated_amount": 0,
      "party_type": "party_type_example",
      "party": "party_example",
      "deposit": 0,
      "withdrawal": 0,
      "transaction_type": "transaction_type_example",
      "bank_party_name": "bank_party_name_example",
      "bank_party_iban": "bank_party_iban_example",
      "bank_party_account_number": "bank_party_account_number_example",
      "included_fee": 0,
      "excluded_fee": 0
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/bank-transaction

Create a bank transaction

Creates a new bank transaction object.

Body parameters

status string

Default: draft

date string
bank_account string
company string
currency string
description string
reference_number string
transaction_id string
allocated_amount number
unallocated_amount number
party_type string
party string
deposit number
withdrawal number
transaction_type string
bank_party_name string
bank_party_iban string
bank_party_account_number string
included_fee number
excluded_fee number

Returns

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

POST /api/accounts/bank-transaction 
curl https://api.overplane.dev/api/accounts/bank-transaction \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json"
Response 
{
  "id": "bank-transaction_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "date": "2024-01-15",
  "bank_account": "bank_account_example",
  "company": "Example Corp",
  "currency": "USD",
  "description": "description_example",
  "reference_number": "reference_number_example",
  "transaction_id": "transaction_id_example",
  "allocated_amount": 0,
  "unallocated_amount": 0,
  "party_type": "party_type_example",
  "party": "party_example",
  "deposit": 0,
  "withdrawal": 0,
  "transaction_type": "transaction_type_example",
  "bank_party_name": "bank_party_name_example",
  "bank_party_iban": "bank_party_iban_example",
  "bank_party_account_number": "bank_party_account_number_example",
  "included_fee": 0,
  "excluded_fee": 0
}
PATCH /api/accounts/bank-transaction/{id}

Update a bank transaction

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

Body parameters

status string

Default: draft

date string
bank_account string
company string
currency string
description string
reference_number string
transaction_id string
allocated_amount number
unallocated_amount number
party_type string
party string
deposit number
withdrawal number
transaction_type string
bank_party_name string
bank_party_iban string
bank_party_account_number string
included_fee number
excluded_fee number

Returns

Returns the updated bank transaction object.

PATCH /api/accounts/bank-transaction/{id} 
curl https://api.overplane.dev/api/accounts/bank-transaction/bank-transaction_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","date":"2024-01-15"}'
Response 
{
  "id": "bank-transaction_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "date": "2024-01-15",
  "bank_account": "bank_account_example",
  "company": "Example Corp",
  "currency": "USD",
  "description": "description_example",
  "reference_number": "reference_number_example",
  "transaction_id": "transaction_id_example",
  "allocated_amount": 0,
  "unallocated_amount": 0,
  "party_type": "party_type_example",
  "party": "party_example",
  "deposit": 0,
  "withdrawal": 0,
  "transaction_type": "transaction_type_example",
  "bank_party_name": "bank_party_name_example",
  "bank_party_iban": "bank_party_iban_example",
  "bank_party_account_number": "bank_party_account_number_example",
  "included_fee": 0,
  "excluded_fee": 0
}
DELETE /api/accounts/bank-transaction/{id}

Delete a bank transaction

Permanently deletes a bank transaction. This cannot be undone.

Path parameters

id string required

The identifier of the bank transaction to delete.

Returns

Returns a confirmation that the bank transaction has been deleted.

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

Submit a bank transaction

Submits a draft bank transaction, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the bank transaction to act on.

Returns

Returns the bank transaction object with updated status.

POST /api/accounts/bank-transaction/{id}/submit 
curl https://api.overplane.dev/api/accounts/bank-transaction/bank-transaction_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "bank-transaction_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "date": "2024-01-15",
  "bank_account": "bank_account_example",
  "company": "Example Corp",
  "currency": "USD",
  "description": "description_example",
  "reference_number": "reference_number_example",
  "transaction_id": "transaction_id_example",
  "allocated_amount": 0,
  "unallocated_amount": 0,
  "party_type": "party_type_example",
  "party": "party_example",
  "deposit": 0,
  "withdrawal": 0,
  "transaction_type": "transaction_type_example",
  "bank_party_name": "bank_party_name_example",
  "bank_party_iban": "bank_party_iban_example",
  "bank_party_account_number": "bank_party_account_number_example",
  "included_fee": 0,
  "excluded_fee": 0
}
POST /api/accounts/bank-transaction/{id}/cancel

Cancel a bank transaction

Cancels a submitted bank transaction, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the bank transaction to act on.

Returns

Returns the bank transaction object with updated status.

POST /api/accounts/bank-transaction/{id}/cancel 
curl https://api.overplane.dev/api/accounts/bank-transaction/bank-transaction_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "bank-transaction_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "date": "2024-01-15",
  "bank_account": "bank_account_example",
  "company": "Example Corp",
  "currency": "USD",
  "description": "description_example",
  "reference_number": "reference_number_example",
  "transaction_id": "transaction_id_example",
  "allocated_amount": 0,
  "unallocated_amount": 0,
  "party_type": "party_type_example",
  "party": "party_example",
  "deposit": 0,
  "withdrawal": 0,
  "transaction_type": "transaction_type_example",
  "bank_party_name": "bank_party_name_example",
  "bank_party_iban": "bank_party_iban_example",
  "bank_party_account_number": "bank_party_account_number_example",
  "included_fee": 0,
  "excluded_fee": 0
}

Line items

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

Bank Transaction Payments

Attributes

idx integer
bank_transaction_id string required
payment_document string required
payment_entry string required
allocated_amount number required
clearance_date string

Endpoints

GET /api/accounts/bank-transaction-payments?parent_id={id}
POST /api/accounts/bank-transaction-payments
PATCH /api/accounts/bank-transaction-payments/{id}
DELETE /api/accounts/bank-transaction-payments/{id}
POST /api/accounts/bank-transaction-payments/reorder
Bank Transaction Payments object 
{
  "id": "bank-transaction-payments_abc123",
  "idx": 1,
  "bank_transaction_id": "bank_transaction_id_example",
  "payment_document": "payment_document_example",
  "payment_entry": "payment_entry_example",
  "allocated_amount": 0,
  "clearance_date": "2024-01-15"
}