Getting StartedAPI Reference
API Reference

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

post
https://api.xchange.trimble.com/connect/v1/direct/subscribers//vista/ar/2/data/batch_entries/actions/add_receipt

Adds a new Cash Receipt to a Cash Receipt type batch

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

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

Body Params
integer
required
1 to 255

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

date
required
^([0-9]{4})-(1[0-2]|0[1-9])-01$

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

integer
required

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

integer
required

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

date
^([0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|2[0-9]|1[0-9]|0[1-9])$

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

string | null

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

date | null
^([0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|2[0-9]|1[0-9]|0[1-9])$

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

string
required
^[-+]?[0-9]{1,10}(?:.[0-9]{0,2})?$

Check Amount.

integer
1 to 255

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

integer

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

string
required
length ≤ 10

Deposit No.

string | null

Optional.

__custom_fields
object

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

MiscDistributions
array of objects

Optional.

MiscDistributions
LineItems
array
LineItems
Headers
string
required

Used to authorize access to the Direct API.

Responses

401

You have not provided a proper X-Application-Key in the header of this request.

403

The X-Application-Key provided is valid but the key does not have access to this resource.

404

The object with the given ID was not found OR a subscriber with the given URL was not found.

Updated about 1 month ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago