v1

latestOpenAPI 3.0.12026-07-267912192.3 MB

Usage Batch Entries

Executes the Add action for the Usage Batch Entries data object.

Adds a new Usage entry to an existing Usage batch

post/direct/subscribers/{subscriber_code}/vista/em/2/data/usage_batch_entries/actions/add

Path parameters

subscriber_codestring required

The code of the subscriber that you are making this request for.

Headers

X-Application-Keystring required

Used to authorize access to the Direct API.

Request body

Cointeger required

Mthstring required

BatchIdinteger required

EMTransTypestring required

Which usage type: J-Job, E-Equipment, X-Expense, W-WorkOrder

ActualDatestring date nullable

Optional. If omitted, null will be defaulted. Format: YYYY-MM-DD.

Equipmentstring required

RevCodestring required

GLOffsetAcctstring nullable

Required if EMTransType is X or W; otherwise will default

PRCointeger nullable

Defaults to company

JCCointeger nullable

Defaults to the Job Company of the Equipment Record, if none is found defaults to the Job Company of the EM Company.

PREmployeestring nullable

Defaults to the Operator configured on the Equipment. The Employee must be active.

CurrentOdometerstring nullable

CurrentHourMeterstring nullable

RevTimeUnitsstring nullable

RevWorkUnitsstring nullable

RevRatestring nullable

Descriptionstring nullable

Jobstring nullable

Required if EMTransType is J

JCPhasestring nullable

Required if EMTransType is J

JCCostTypeinteger nullable

RevUsedOnEquipCointeger nullable

Defaults to equipment company

RevUsedOnEquipstring nullable

EMCo Required if EMTransType is E

ComponentTypeCodestring nullable

Componentstring nullable

EMCostTypeinteger nullable

Required if ComponentType not supplied and EMTransType is E

CostCodestring nullable

Required if ComponentCode not supplied and EMTransType is E

WorkOrderstring nullable

Required if EMTransType is W

WOIteminteger nullable

Required if EMTransType is W

__custom_fieldsobject

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.

Response

Success

idstring

operationstring

statusstring