Sign in
Bank Transfers

Create BankTransfer record

Create a new BankTransfer record with the provided data. Validates all required fields and business rules.

post/public/v1/bank-transfers/

Headers

Idempotency-Keystring

Optional. A unique value (a UUID works well) identifying this operation. If the request is repeated with the same key, the original response is replayed instead of the operation running again, so a retry cannot create a duplicate record. Results are replayable for 48 hours. Reusing a key with a different request body returns 422.

Request body

datestring date required
transaction_datestring date nullable
company_idinteger required
debit_bank_account_numberinteger required
credit_bank_account_numberinteger required
calculate_gain_lossboolean
base_currency_anchor'sending' | 'receiving'
memostring
record_status'draft' | 'posted' | 'archived'

Response

OK

bank_match_statusstring nullable
reconciliation_statusstring nullable
internal_idinteger required
numberinteger required
codestring nullable
transaction_idinteger required
debit_entry_idinteger required
credit_entry_idinteger required
datestring date required

Posting date (GL date) - the date when the transaction is recorded in the general ledger

transaction_datestring date required

Transaction date (inception date) - the date when the transaction actually occurred

company_idinteger required
company_namestring required
company_currencystring required
debit_bank_account_numberinteger nullable required
credit_bank_account_numberinteger nullable required
amountstring required

Transfer amount

exchange_ratestring required
calculate_gain_lossboolean
base_currency_anchor'sending' | 'receiving'
memostring required
record_status'draft' | 'posted' | 'archived' required
currency_iso_4217_codestring[]
created_atstring date-time required

Date and time the record was created

updated_atstring date-time required

Date and time the record was last updated

Changes

Changed in 3 of the 27 revisions of this API.6

  • 1e0766b030141See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • cebcad5c6f724See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • af0ec77e52771See the full diff
    • ○

      added the new optional header request parameter Idempotency-Key

      new-optional-request-parameter

Of the 27 revisions, 1 has no diff computed.