Docs

Add Change Order Batch Entry

POST

Body

Arguments
numberrequired

Company. Key to the change order batch.

stringrequired

Batch posting month in YYYY-MM-01 format.

numberrequired

Change order batch ID.

stringrequired

Purchase order number.

numberrequired

Purchase order line item number.

object

Optional details used when adding a new PO line item.

number

Required only when adding a new purchase order line. 1: Job; 2: Inventory; 3: Expense; 4: Equipment; 5: EM Work Order; 6: SM Work Order. Leave all New Line Item fields empty for an existing line.

number

Required when adding a new line with item type 1. Used for item type 1. Key to jc/jobs(JCCo, Job).

string

Required when adding a new line with item type 1. Used for item type 1. Key to jc/jobs(JCCo, Job).

string

Material code. Required for Inventory (Item Type 2); optional for other types. Material group is resolved from the applicable company.

number

Required when adding a new line with item type 2. Used for item type 2. Key to in/locations(INCo, Loc).

string

Required when adding a new line with item type 2. Used for item type 2. Key to in/locations(INCo, Loc).

number

Required when adding a new line with item type 3. Used for item type 3. Key to gl/chart_of_accounts(GLCo, GLAcct).

number

Equipment company. Required for Equipment (4) and EM Work Order (5).

string

Required when adding a new line with item type 4. Used for item type 4. Key to em/equipment(EMCo, Equipment).

string

Equipment cost code. Required for Equipment (4); for EM Work Order (5), may be ignored when specified by the work order item.

number

Required when adding a new line with item type 4, 5. Used for item type 4, 5. key to CostTypes array in em/cost_codes(EMGroup, CostCode, $.CostTypes.CostType).

string

Required when adding a new line with item type 5. Used for item type 5. Equipment Work Order.

number

Required when adding a new line with item type 5. Used for item type 5. Equipment Work Order Item.

number

Required when adding a new line with item type 6. Used for item type 6. SM Company.

number

Required when adding a new line with item type 6. Used for item type 6. SM Work Order

number

Required when adding a new line with item type 6. Used for item type 6. SM Scope

number

Required when adding a new line with item type 6. Used for item type 6. SM Cost Type.

Uncommon arguments
number

Optional PO change order number; the next available number is used when omitted.

string

Optional change order number used to group related changes.

string

Optional action date in YYYY-MM-DD format.

string

Optional change description.

string

Optional change to current units for non-LS items.

string

Optional change to backorder units for non-LS items.

string

Optional change to current cost for LS items.

string

Optional change to backorder cost for LS items.

string

Optional. if omitted, null will be defaulted.

string

Used for item type 1. Key to jc/job_phases(JCCo, Job, PhaseGroup, Phase) The PhaseGroup will be selected based on the JCCo value. Optional. If omitted, it will be defaulted based on Vista defaulting logic. If a default cannot be applied, this action may fail or force a Vista user to supply this value before posting.

number

Used for item type 1. Key to CostTypes array in jc/job_phases(JCCo, Job, PhaseGroup, Phase, $.CostTypes.CostType) Optional. If omitted, it will be defaulted based on Vista defaulting logic. If a default cannot be applied, this action may fail or force a Vista user to supply this value before posting.

string

GL account. Optional; company selection and defaults depend on Item Type and Vista configuration. Some item types disallow account overrides.

string

Key to po/vendor_materials(VendorGroup, Vendor, MaterlGroup, Material, UM). Vendor's Material Number. Optional. If Omitted, it will be defaulted based Vista defaulting behavior.

string

Receiving in PO Module. Optional. If omitted, N will be defaulted. Send Y if this item will be received in the PO module.

date

Required Date. Format: YYYY-MM-DD. Optional. If not provided it will be defaulted to $.ExpDate.

number

Key to ap/pay_categories(APCo, PayCategory). APCo will be defaulted based on Vista defaulting logic. Optional. If omitted, it will be 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.

number

Key to ap/pay_categories(APCo, PayCategory). APCo will be defaulted based on Vista defaulting logic. 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. In all cases if PayCategory is provided or defaulted this value must be in the PayCategory or in no PayCategory

object

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

string

Key to hq/units_of_measures(UM). Optional. If omitted, it will be defaulted based on Vista defaulting behavior.

string

Optional. If omitted, it will be defaulted based on Vista defaulting logic. If UM is LS, this value is ignored and will be set to 0.

string

Options: E-CostPerEach, C-CostPer100, M-CostPer1000. Optional. If omitted, it will be defaulted based on Vista defaulting behavior. If UM is LS, this value is ignored and will be set to null.

object

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

number

Options: 1-Sales, 2-Use, 3-VAT. Optional. If not provided, it will be defaulted based on Vista defaulting behavior.

string

Key to hq/tax_codes(TaxGroup, TaxCode). TaxGroup will be determined based on JCCo. Optional. If not provided, it will be defaulted based on Vista defaulting behavior.

number

Key to ap/vendors(SupplierGroup, Supplier) for supplier for this line. SupplierGroup is defaulted based on Co. Optional. If omitted, null will be defaulted.

string

Optional. If not provided, null will be defaulted.

object

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

string

Used for item type 4. Optional. If omitted, null will be defaulted.

string

Used for item type 4. Optional. If omitted, null will be defaulted.

string

Used for item type 6. Key to jc/job_phases(SMPhaseGroup, SMPhase). SMPhaseGroup will be defaulted based on the JCCo associated to the SM Work Order. Optional. This value should only be supplied if the SM Scope does not have a Phase assigned.

number

Used for item type 6. Key to CostTypes array in jc/job_phases(JCCo, Job, PhaseGroup, Phase, $.CostTypes.CostType) Optional. This value should only be supplied if the SM Scope does not have a CostType assigned.

string

Optional entry notes.

object

Optional Vista user-defined fields, keyed by field name.

Field selectionChoose which fields should be included in the response. Learn more
string

Comma-separated response fields to include.

Every app you connect,one REST pattern

Call any app with one REST pattern. MindCloud handles each provider's auth, request shape, and responses for you.

Learn what the Universal API is
One REST patternUse the same request structure across apps like Slack, HubSpot, Salesforce, and thousands more.
Managed connectionsSend a MindCloud connection ID instead of handling provider tokens, refresh logic, and credential storage yourself.
Action-level docsEach action page shows the exact endpoint, required arguments, optional controls, and response behavior for that app version.