Getting StartedAPI Reference
API Reference

Executes the Add action for the Cost Adjustment Batch Entries data object.

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

Adds a new Cost Adjustment Entry to the specified 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

Key to jc/cost_adj_bat_entries(Co, Mth, BatchId, BatchSeq). Key to jc/cost_adj_batches(Co, Mth, BatchId)

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

Key to jc/cost_adj_batches(Co, Mth, BatchId). Format YYYY-MM-01.

integer
required

Key to jc/cost_adj_batches(Co, Mth, BatchId).

string
enum
required
length ≤ 2

Options: JC-Job Cost, AP-Accounts Payable, EM-Equipment, MO-Material Orders, MS-Material Sales, PR-Payroll, IC-InterCompany.

Allowed:
integer
1 to 255

Key to jc/jobs(JCCo, Job). Optional. If omitted, Co value will be defaulted. This value can only be set differently than Co only if JCTransType = IC. If JCTransType is != IC any provided value will be ignored and replaced with the Co value.

string
required
length ≤ 10

Key to jc/jobs(JCCo, Job).

string
required
length ≤ 20

Key to jc/job_phases(JCCo, Job, PhaseGroup, Phase).

integer
required

Key to CostTypes array in jc/job_phases(JCCo, Job, PhaseGroup, Phase).

date | null
^([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.

string | null

Optional. If omitted, null will be defaulted.

string
length ≤ 20

Key to gl/chart_of_accounts(GLCo, GLAcct). GLCo based on ToJCCo. Account must have a 'Job' or 'null'/blank sub ledger code. Optional. If omitted, it will be defaulted based on Vista defaulting behavior. If a default value is calculated and the Allow GL Override is false in JC Company Parameters, this value will be ignored.

string | null

Key to gl/chart_of_accounts(GLCo, GLAcct). GLCo based on Co. Account must have a 'null'/blank sub ledger code. Optional for ReversalStatus = 0. Required for ReversalStatus = 1

integer
enum

Options: 0-Regular (Default), 1-Auto Reverse. When 1 is specified the GLOffsetAcct must be provided.

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

Optional. If omitted, 0 will be defaulted. Providing this value is only valid when jc/cost_types.TrackHours = Y. If jc/cost_types.TrackHours != Y, then 0 will be defaulted.

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

Optional. If omitted, 0 will be defaulted.

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

Optional. If omitted, 0 will be defaulted.

integer | null
APTransTypeDetail
object

Optional. If omitted all properties will default as specified. This property is ignored unless JCTransType = AP.

EMTransTypeDetail
object

Optional. If omitted all properties will default as specified. This property is ignored unless JCTransType = EM.

MOTransTypeDetail
object

Optional. If omitted all properties will default as specified. This property is ignored unless JCTransType = MO.

MSTransTypeDetail
object

Optional. If omitted all properties will default as specified. This property is ignored unless JCTransType = MS.

PRTransTypeDetail
object

Optional. If omitted all properties will default as specified. This property is ignored unless JCTransType = PR.

__disable_validation
array of strings

Optional. Validation will be skipped each property in this array.

__disable_validation
__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