Bank Transfers

Create BankTransfer record

Changed on

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

Side effects

  • If an approval workflow matches this request, DualEntry can set record_status back to draft.
  • If this record already has an active bank match, and an approval workflow holds the record, DualEntry returns those matches to draft.
post/public/v2/bank-transfers/

Request

  • Base URL: https://api.dualentry.com
  • URL: https://api.dualentry.com/public/v2/bank-transfers/
  • Auth: none declared

Query parameters

apply_default_classificationsboolean

When false, store submitted line classifications, including an empty list. When omitted, organization defaults apply to new lines with omitted or empty classifications only when the organization setting is enabled.

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
reference_numberstring nullable
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'
sending_base_amountstring required
receiving_base_amountstring required
sending_base_ratestring required
receiving_base_ratestring required
memostring required
reference_numberstring nullable
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

  • 7588ae19aaffRevision changes
    • info

      added the new optional query request parameter apply_default_classifications

  • 3d645439b1e4Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status