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

post

https://api.xchange.trimble.com/connect/v1/direct/subscribers/{subscriber_code}/vista/ms/2/data/ticket_batch_entries/actions/add

Add Ticket Batch Entries

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 ms/ticket_bathces(Co, Mth, BatchId).

Mth

date

required

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

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

BatchId

integer

required

Key to ms/ticket_bathces(Co, Mth, BatchId).

SaleDate

date

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

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

FromLoc

string

required

length ≤ 10

Key to in/locations(INCo, Loc). INCo set based on $.Co.

Ticket

string | null

If omitted, null will be applied.

Void

string

enum

If omitted, N will be applied.

Allowed:

MatlVendor

integer | null

VendorGroup applied based on the $.Co value. If omitted, null will be applied.

__SaleTypeDetails

required

Material

string

required

length ≤ 20

Key to hq/materials(MatlGroup, Material). MatlGroup is applied based on $.Co.

string

length ≤ 3

Key to hq/units_of_measures(UM). If omitted, Vista defaults will apply.

MatlUnits

string

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

If omitted, Vista default will be applied.

UnitPrice

string

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

If omitted, Vista default will be applied.

ECM

string

enum

length ≤ 1

If omitted, Vista default will be applied.

Allowed:

MatlTotal

string | null

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

If omitted, Vista default will be applied.

__HaulerTypeDetails

__Tax

object

If omitted, Vista defaults will be applied.

DiscBasis

string

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

Ignored when SaleType != C. Ignored if DiscType = N. DiscType is set by Vista defaulting only, see Vista documentation for the MS Ticket Entry form for details. If omitted, Vista defaults will be applied.

DiscRate

string

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

DiscOff

string

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

TaxDisc

string

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

ShipAddress

string | null

If omitted, null will be applied.

City

string | null

If omitted, null will be applied.

State

string | null

If omitted, null will be applied.

Zip

string | null

If omitted, null will be applied.

Country

string | null

If omitted, null will be applied.

ReasonCode

string | null

Key to hq/reason_codes(ReasonCode). 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.

__Surcharges

array

If omitted, Vista default Surcharges will be applied.

__Surcharges

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.