Getting StartedAPI Reference
API Reference

Executes the Add action for the Purchase Order Batch Entries data object.

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

Adds a new Purchase Order to an existing Purchase Order batch

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

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

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

integer
required

Key to po/po_batches(Co, Mth, BatchId).

string
required
length ≤ 30

Key to po/po_header(POCo, PO)

integer
required

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

string | null

Optional. If omitted, null will be defaulted.

date

Format: YYY-MM-DD. Optional. If omitted, it will be defaulted to the current date.

string | null

Person placing the order. Optional. If omitted, null will be defaulted.

string | null

Expected Date. Format: YYY-MM-DD. Optional. If omitted, null will be defaulted.

integer

Options: 0-Open, 1-Complete, 2-Close. Optional. If omitted, 0 will be defaulted.

integer | null

Key to jc/jobs(JCCo, Job). Optional. If omitted, null will be defaulted.

string | null

Key to jc/jobs(JCCo, Job). Optional. If omitted, null will be defaulted. Default Job for this Purchase order. The shipping location will be defaulted based on this Job as well as the Job on the Line types if not overridden.

integer | null

Key to in/locations(INCo, Loc). Optional. If omitted, null will be defaulted.

string | null

Key to in/locations(INCo, Loc). Optional. If omitted, null will be defaulted. Default Inventory Location for this Purchase order. The shipping location can be defaulted based on this Location as well as the Loc on the Line types if not overridden.

string | null

Key as found in PO Shipping Locations application.

ShipAddress
object

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

integer | null

Override Vendor's standard Payment Address. Key to AdditionalAddresses array in ap/vendors(VendorGroup, Vendor, AdditionalAddresses.Seq). VendorGroup value is defaulted based on the Co value. Optional. If omitted, null will be defaulted.

integer | null

Override Vendor's standard Purchasing Address. Key to AdditionalAddresses array in ap/vendors(VendorGroup, Vendor, AdditionalAddresses.Seq). VendorGroup value is defaulted based on the Co value. Optional. If omitted, null will be defaulted.

string | null

Key to hq/hold_codes(HoldCode). Optional. If omitted, will be defaulted based on Vista defaulting logic.

string | null

Key to hq/payment_terms(PayTerms). Optional. If omitted, will be defaulted based on Vista defaulting logic.

string | null

Key to hq/compliance_groups(CompGroup). Optional. If omitted, null will be defaulted.

string | null
integer | null

Optional. If omitted, null will be defaulted.

integer | null

Optional. If omitted, null will be defaulted.

string
enum

Prevent Auto Close from final invoice. Optional. If omitted, N will be defaulted.

Allowed:
__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.

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