Executes the Add action for the Revenue Projection Batches data object.

post

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

Creates a new JC Revenue Projection batch for a contract and populates default contract item lines. Mirrors proj_batches Add but scoped to contract instead of job.

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

Creates a new JC Revenue Projection batch for a contract and populates default contract item lines. Mirrors proj_batches Add but scoped to contract instead of job.

integer

required

1 to 255

Job Cost company.

Mth

date

required

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

Batch month. Format YYYY-MM-01. Month must be open in subledgers.

Contract

string

required

length ≤ 10

Contract for the revenue projection batch. Key to jc/contracts(Co, Contract). Contract cannot exist in another open revenue projection batch.

Notes

string | null

Optional batch notes.

__custom_fields

object

Custom field values for the new batch header.

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.