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/ms/2/data/inv_batch_entries/actions/add

Add Invoice Batch Entries

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

Key to this object.

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

Format: YYYY-MM-01. Key to this object.

integer
required

Key to this object.

integer
required

Key to ar/customers(CustomerGroup, Customer) where CustomerGroup is determined by the $.Co property.

string | null

As found on ms/tickets. If omitted, null will be applied.

string | null

As found on ms/tickets. If omitted, null will be applied.

string | null

If omitted, Vista default will be applied.

string
required
length ≤ 10

If omitted, Vista default will be applied.

integer

If omitted, Vista default will be applied.

string | null

If omitted, Vista default will be applied.

integer

Invoice Report. If omitted, Vista default will be applied.

date

Format: YYYY-MM-DD. If omitted, current date will be applied.

date | null

Format: YYYY-MM-DD. If omitted, Vista default will be applied.

date

Format: YYYY-MM-DD. If omitted, Vista default will be applied.

string | null

If omitted, null will be applied.

string
enum
required
length ≤ 1

Options: A-On Account, C-Cash, X-Credit Card.

Allowed:
string | null

If omitted, null will be applied.

string | null

If omitted, null will be applied.

string | null

If omitted, null will be applied.

string | null

If omitted, null will be applied.

string | null

If omitted, null will be applied.

string | null

If omitted, null will be applied.

integer | null

key to in/location_groups, key to in/locations(LocGroup, Location). If omitted, null will be applied.

string | null

key to in/locations(LocGroup, Location). If omitted, null will be applied.

integer
enum

Options: 1-Unit Price, 2-Trans#. If omitted, Vista default will be applied.

Allowed:
integer
enum

Options: 1-CustJob, 2-CustJob/CustPO, 3-CustJob/CustPO/Date, 4-CustJob/CustPO/Date/Loc, 5-CustJob/CustPO/Date/Loc/Matl, 6-CustJob/CustPO/Date/Loc,Matl/UM. If omitted, Vista default will be applied.

Allowed:
string
enum

If omitted, Vista default will be applied.

Allowed:
integer | null

Input ignored if MSCompany Parameter 'auto-apply payments' feature is off or if PaymentType is not C-Cash. If omitted, Vista default will be applied.

integer | null

Input ignored if MSCompany Parameter 'auto-apply payments' feature is off or if PaymentType is not C-Cash. If omitted, Vista default will be applied.

string | null

If omitted, null will be applied.

__custom_fields
object

Add properties to this object with the property name matching the user defined field name in Vista for each user defined field you need to set.

__InvoiceDetails
array
__InvoiceDetails
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