v1

latestOpenAPI 3.0.12026-07-267912192.3 MB

Batch Entries

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

Adds a Vista AR Adjustment

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

subscriber_codestring required

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

X-Application-Keystring required

Used to authorize access to the Direct API.

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).

Invoicestring required

Invoice Number. The invoice you are looking to credit.

AppliedMthstring required

Applied Mth. The Mth value the invoice you are looking to credit was applied to.

AppliedTransinteger required

Applied Trans. The ArTrans value the invoice you are looking to credit was applied to.

CustRefstring nullable

Customer Reference.

Descriptionstring nullable

Optional. If omitted, it will be defaulted to the description of the invoice you are crediting.

TransDatestring date required

Invoice Date. Format: YYYY-MM-DD.

ReasonCodestring nullable

Key to hq/reason_codes(ReasonCode)

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.

Success

idstring

operationstring

statusstring