Getting StartedAPI Reference
API Reference

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

post
https://api.xchange.trimble.com/connect/v1/direct/subscribers//vista/ap/2/data/inv_batch_entries/actions/add

Adds an invoice batch entry

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

Company. Key to ap/inv_batches(Co, Mth, BatchId).

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

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

integer
required

Key to ap/inv_batches(Co, Mth, BatchId).

integer
required

Key to ap/vendors(VendorGroup, Vendor). Note: the VendorGroup value is defaulted based on the Co value.

string
required
length ≤ 30

Invoice Number.

string | null

Optional. If omitted, null will be defaulted.

date
required

Format: YYYY-MM-DD.

date | null

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

date

Optional. If omitted, it will be defaulted based on the default pay terms for the vendor. Format: YYYY-MM-DD.

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

Optional. If omitted, it will be calculated based on line items.

PaymentOverride
object

Optional. If omitted, all properties will be defaulted as noted on each property.

AddressOverride
string | null
__custom_fields
object

This property will be added if there are any custom fields defined for this object in Vista. Each custom field will be a property of this object.

boolean | null

Disable Vista Validations

LineItems
array
required
length ≥ 1
LineItems*
integer

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

integer
enum
required

1-Job

Allowed:
string | null

Optional. If omitted, null will be defaulted.

integer
required

Key to jc/jobs(JCCo, Job). Optional. If not provided, it will be defaulted based on ap/company_parameters. Omitting this value will force a Vista user to supply this value before posting.

string
required
length ≤ 10

Key to jc/jobs(JCCo, Job). Optional. If not provided, it will be defaulted to empty string. Omitting this value will force a Vista user to supply this value before posting.

string
required
length ≤ 20

Key to jc/job_phases(JCCo, Job, PhaseGroup, Phase) The PhaseGroup will be selected based on the JCCo value. Optional. If not provided, it will be defaulted to null. Omitting this value will force a Vista user to supply this value before posting.

integer | null

Key to CostTypes array in jc/job_phases(JCCo, Job, PhaseGroup, Phase) Optional. If not provided, it will be defaulted to null.

string
length ≤ 20

Key to gl/chart_of_accounts(GLCo, GLAcct). The GLCo will be selected based on HQ company_parameters for the JCCo company. Optional, If omitted this value will be defaulted based Vista defaulting behavior.

string | null

Key to hq/materials(MatlGroup, Material). Optional for this line type. The MatlGroup will be selected based on the HQ company_parameters for the JCCo company.

integer | null

Optional. If omitted Vista defaulted based on Vista defaulting behavior. In some configurations, overrides are not allowed. Providing this property when overrides are not allowed will result in an error.

integer

Optional. If omitted, it will be defaulted from the ap/company_parameters configuration. In some configurations, overrides are not allowed. Providing this property when overrides are not allowed will result in an error. In all cases if PayCategory is provided or defaulted this value must be in the PayCategory or in no PayCategory

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

Optional. If omitted, it will default based on the PayTerms of the Vendor. This property expects a dollar amount for the discount.

Tax
object

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

integer | null

Key to ap/vendors(VendorGroup, Supplier) for supplier for this line. VendorGroup is defaulted based on Co.

string | null
__custom_fields
object

This property will be added if there are any custom fields defined for this object in Vista. Each custom field will be a property of this object.

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 2 months ago

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

Updated 2 months ago