Executes the Add Contract Invoice action for the Batch Entries data object.

post

https://api.xchange.trimble.com/connect/v1/direct/subscribers/{subscriber_code}/vista/ar/2/data/batch_entries/actions/add_contract_inv

Adds a Contract based Invoice

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

subscriber_code

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

Mth

date

required

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

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

BatchId

integer

required

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

CustGroup

integer

required

Key to ar/customers(CustGroup, Customer).

Customer

integer

required

Key to ar/customers(CustGroup, Customer).

RecType

integer

Receivable Type. Optional. If omitted, Vista defaulting logic will be used..

JCCo

integer

required

Key to jc/contracts(JCCo, Contract).

Contract

string

required

length ≤ 10

Key to jc/contracts(JCCo, Contract).

CustRef

string | null

Customer Reference.

Invoice

string

length ≤ 10

Invoice Number. If omitted, Vista defaulting logic will be used.

Description

string | null

TransDate

date

required

Invoice Date. Format: YYYY-MM-DD.

DueDate

date

Due Date. Format: YYYY-MM-DD.

DiscDate

date

Discount Date. Format: YYYY-MM-DD.

ReasonCode

string | null

Key to hq/reason_codes(ReasonCode)

Notes

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 of objects

length ≥ 1

LineItems

ARLine

integer

Optional. If omitted, it will be defaulted to the next ARLine number. If provided, the value must be unique among all LineItems on this Invoice.

LineType

string

enum

length ≤ 1

C-Contract Item line type.

Allowed:

Item

string

required

length ≤ 16

Key to jc/contracts.LineItems(JCCo, Contract, Item)

Description

string

length ≤ 30

Optional. If omitted, Vista defaulting logic will apply.

ContractUnits

string

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

Optional. If omitted, 0 will be defaulted.

Amount

string

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

Obsolete. Use BaseAmount

BaseAmount

string

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

Optional. If omitted, Vista defaulting logic will apply.

DiscOffered

string

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

Optional. If omitted, Vista defaulting logic will apply.

GLAcct

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.

RetgPct

string

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

Optional. If omitted, Vista defaulting logic will apply.

Retainage

string

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

Optional. If omitted, Vista defaulting logic will apply.

Notes

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

X-Application-Key

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.

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Describes issues with the request.