Bank Ledger Transactions

Partial update bank ledger transaction

Changed on

Endpoint for partially updating an existing bank ledger transaction.

patch/bank-accounts/{bank_account_id}/ledger-transactions/{id}/

Request

  • Base URL
    https://api.wafeq.com/v1
  • URL
    https://api.wafeq.com/v1/bank-accounts/{bank_account_id}/ledger-transactions/{id}/
  • Auth
    API key in header Authorization

Path parameters

bank_account_idstring required
idstring required

Query parameters

expandstring

Comma-separated related objects to return in full instead of as IDs. Accepted values: account, account.parent, bank_account, bank_account.account, contact, contact.persons, journal, project, tax_rate. Nested relations are joined with a dot. Pass journal to replace the journal ID with its object (ID, date, currency, reference, notes and timestamps). Documents without a journal still return null. Journal line items are retrieved separately with GET /v1/journal-line-items/?journal={journal_id}.

Headers

X-Wafeq-Idempotency-Keystring

Client-provided UUID to uniquely identify a request

Request body

accountstring

The account associated with this transaction.

amountnumber double

The transaction amount.

bank_accountstring

The bank account associated with this transaction.

contactstring nullable

The contact (customer or supplier) associated with this transaction, if any.

created_tsstring date-time

The timestamp in UTC when the transaction was created

datestring date

The transaction date.

descriptionstring

The transaction description.

idstring

The unique identifier of the transaction.

is_manualboolean

Indicates whether the transaction was manually entered.

legacy_idstring

[Deprecated] The legacy identifier of the transaction.

modified_tsstring date-time

The timestamp in UTC when the transaction was last modified

projectstring nullable

The project associated with this transaction, if any.

referencestring

The transaction reference or identifier.

tax_ratestring nullable

The tax rate to apply to this transaction, if any.

Response

accountstring required

The account associated with this transaction.

amountnumber double required

The transaction amount.

bank_accountstring required

The bank account associated with this transaction.

contactstring nullable

The contact (customer or supplier) associated with this transaction, if any.

created_tsstring date-time required

The timestamp in UTC when the transaction was created

datestring date required

The transaction date.

descriptionstring

The transaction description.

idstring required

The unique identifier of the transaction.

is_manualboolean required

Indicates whether the transaction was manually entered.

legacy_idstring required

[Deprecated] The legacy identifier of the transaction.

modified_tsstring date-time required

The timestamp in UTC when the transaction was last modified

projectstring nullable

The project associated with this transaction, if any.

referencestring

The transaction reference or identifier.

tax_ratestring nullable

The tax rate to apply to this transaction, if any.

Changes

    • info

      added the new optional query request parameter expand

    • info

      added the required property to the response with the status