Getting StartedAPI Reference
API Reference

Executes the Add Credit Memo 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_credit_memo

Adds a Vista AR Credit Memo

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

string
required
length ≤ 10

Invoice Number. The invoice you are looking to credit.

string
required

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

integer
required

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

string | null

Customer Reference.

string | null

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

date
required

Invoice Date. Format: YYYY-MM-DD.

string | null

Key to hq/reason_codes(ReasonCode)

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
length ≥ 1
LineItems
integer
required

Provide the ARLine from the original invoice you are crediting.

string
enum
required
length ≤ 1

C-Contract Item line type. Can only be provided if the original invoices was a contract invoice.

Allowed:
string
length ≤ 30

Optional. If omitted, Vista defaulting logic will apply.

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

Optional. If omitted, 0 will be defaulted. If Contract Item UM = LS then this value will be ignored.

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

Optional. If omitted, Vista defaulting logic will apply.

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

Optional. If omitted, Vista defaulting logic will apply.

string
length ≤ 20

Optional. If omitted, Vista defaulting logic will apply. This value can only be sent if the “Allow GL Account Override” option is checked on the GL Revenue tab of JC Company Parameters.

Tax
object

Optional. If omitted each property will be be defaulted based on Vista defaulting behavior.

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

Optional. If omitted, Vista defaulting logic will apply.

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

Optional. If omitted, Vista defaulting logic will apply.

string | null
__custom_fields
object

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

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