Skip to main content
Interfaces / BECS

Create BECS disbursements batch

Creates a BECS disbursements batch and, in the same atomic transaction, updates the linked salary-packaging employee-transaction ledger records in realtime. This method requires the InterfaceExports:BecsDisbursementsBatchCreate permission to be associated with your role.

POST
/gb/interface/exports/becs/disbursements

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Headers

Audit-User-Idstringheader

(Optional) User Id to use for audit purposes. This header requires the Audit:UserIdOverride permission to be associated with your role.

Maximum string length: 5
Pattern: ^[1-9]{1}[0-9]*$

Body

application/x-www-form-urlencoded
aba_typeenum<string>required

Determines the paying bank account source and the selection streams.

Available options: client, company
bank_account_idstring

Paying bank account for aba_type 'company'.

Pattern: ^[1-9]{1}[0-9]*$
client_codestring

Client identifier as entered on screen; resolved server-side to the internal client id. Required when aba_type is 'client'; an optional filter when aba_type is 'company'.

company_idstring

Paying company for aba_type 'company'. Derived from the chosen bank account where not supplied.

Pattern: ^[1-9]{1}[0-9]*$
pay_cycle_idstring

Restricts the batch to a single pay cycle when supplied.

Pattern: ^[1-9]{1}[0-9]*$
transaction_datestringrequired

Batch payment date (YYYY-MM-DD). Propagated to the linked employee-transaction records.

Response

application/vnd.catch-e-api.v1+json

Success

aba_typestring
Example: client
becs_idinteger
Example: 123456
control_invoice_countnumber
Example: 12
control_item_countnumber
Example: 12
control_totalnumber
Example: 12345.67
status_flagstring
Example: pending
transaction_datestring
Example: 2026-07-15

Still need help? Ask the team