v1

latestOpenAPI 3.0.12026-07-267912192.3 MB
Batch Entries

Executes the Add Receipt action for the Batch Entries data object.

Adds a new Cash Receipt to a Cash Receipt type batch

post/direct/subscribers/{subscriber_code}/vista/ar/2/data/batch_entries/actions/add_receipt

Path parameters

subscriber_codestring required

The code of the subscriber that you are making this request for.

Headers

X-Application-Keystring required

Used to authorize access to the Direct API.

Request body

Cointeger required

Key to ar/batches(Co, Mth, BatchId).

Mthstring date required

Key to ar/batches(Co, Mth, BatchId). Format: YYYY-MM-01.

BatchIdinteger required

Key to ar/batches(Co, Mth, BatchId).

Customerinteger required

Key to ar/customers(CustGroup, Customer). CustGroup is defaulted based on $.Co

TransDatestring date

Transaction Date. Format: YYYY-MM-DD. Optional. If omitted, defaulted to today.

CheckNostring nullable

Check Number. Optional. If omitted, null will be defaulted.

CheckDatestring date nullable

Check Date. Format: YYYY-MM-DD. Optional. If omitted, null will be defaulted.

CreditAmtstring required

Check Amount.

CMCointeger

CM Company. Optional. If omitted, defaulted based on AR Company Settings.

CMAcctinteger

CM Account. Optional. If omitted, defaulted based on AR Company Settings.

CMDepositstring required

Deposit No.

Notesstring nullable

Optional.

__custom_fieldsobject

Add a property for each user defined values that should be set on the header of the batch transaction as part of this action.

Response

Success

idstring
operationstring
statusstring