Getting StartedAPI Reference
API Reference

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

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

Adds a new Purchase Order Change Order Entry to an existing Purchase Order Change 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/co_batches(Co, Mth, BatchId).

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

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

integer
required

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

integer

PO Change Order Number. Optional. If not provided the next available POCO number will be used.

string | null

Change Order Number. Optional. If omitted, null will be defaulted. If you are applying multiple changes that are logically grouped together, they can share the same ChangeOrder value.

date

Format: YYYY-MM-DD. Optional. If omitted, it will be defaulted to today.

string
required
length ≤ 30

Key to po/po_headers(POCo, PO)

required

Key to po/po_items(POCo, PO, POItem). If adding a new PO Item to the PO. You must also provide values for the new PO Line in the $.NewLineItem property

provide the value.

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

Change to Current Units. Optional. If omitted, 0 will be defaulted. This Property can only be provided if the UM for this PO Item is NOT LS.

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

Change to Backorder Units. Optional. If omitted, 0 will be defaulted. This Property can only be provided if the UM for this PO Item is NOT LS.

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

Change to Current Cost. Optional. If omitted, 0 will be defaulted. This Property can only be provided if the UM for this PO Item is LS.

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

Change to BackOrder Cost. Optional. If omitted, 0 will be defaulted. This Property can only be provided if the UM for this PO Item is LS.

NewLineItem

This property is only used when a POItem is provided that needs to be added to the Purchase Order.

string | null

Optional. If not provided, null will be defaulted.

__custom_fields
object

Add a property to this object for each user defined field to be set. Property name set to the user defined field name.

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