Executes the Add action for the Time Batch Entry data object.

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

Adds a new Time Batch Entry record to the batch.

Path Params

subscriber_code

string

required

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

Body Params

integer

required

1 to 255

Key to pr/time_batches(Co, Mth, BatchId).

Mth

date

required

Key to pr/time_batches(Co, Mth, BatchId). Format YYYY-MM-01.

BatchId

integer

required

Key to pr/time_batches(Co, Mth, BatchId).

Employee

integer

required

Key to pr/employees(PRCo, Employee).

PostDate

date

required

Date you are entering time for. Format: YYYY-MM-DD.

PaySeq

integer

Optional. If omitted, the first Pay Sequence setup for the Pay Period associated to this batch.

PRDept

string

length ≤ 10

Key to pr/departments(PRCo, PRDept). Optional. If omitted, it will be defaulted based on Vista defaulting logic.

InsState

string | null

Key to pr/states(PRCo, State). Key to pr/insurance_codes(PRCo, InsState, InsCode). Optional. If omitted, will be defaulted based on Vista defaulting logic. Provide null if you want to override the defaulting behavior with no value.

TaxState

string

length ≤ 4

Key to pr/states(PRCo, State). Optional. If omitted, will be defaulted based on Vista defaulting logic.

LocalCode

string | null

Key to pr/locals(PRCo, LocalCode). Optional. If omitted, will be defaulted based on Vista defaulting logic. Provide null if you want to override the defaulting behavior with no value.

UnempState

string

length ≤ 4

Key to pr/states(PRCo, State). Optional. If omitted, will be defaulted based on Vista defaulting logic.

InsCode

string | null

Key to pr/insurance_codes(PRCo, InsState, InsCode). Optional. If omitted, will be defaulted based on Vista defaulting logic. Provide null if you want to override the defaulting behavior with no value.

Cert

string

Should Earnings appear on Certified PR Reports. Optional. If omitted, N will be defaulted.

Craft

string | null

Key to pr/crafts(PRCo, Craft). Key to pr/classes(PRCo, Craft, Class). Optional. If omitted, will be defaulted based on Vista defaulting logic. Provide null if you want to override the defaulting behavior with no value.

Class

string | null

Key to pr/classes(PRCo, Craft, Class). Optional. If omitted, will be defaulted based on Vista defaulting logic. Provide null if you want to override the defaulting behavior with no value.

StartTime

string

Format 24H:mm (13:24). Optional. If omitted, empty string will be defaulted. This value will only be stored if the StartTime and StopTime are provided. The Hours property will override any calculation based on StartTime, StopTime, and BreakHours.

StopTime

string

BreakHours

string

Optional. If omitted, 0 will be defaulted. This value will only be stored if the StartTime and StopTime have also been provided. The Hours property will override any calculation based on StartTime, StopTime, and BreakHours.

EarnCode

integer

Key to pr/earn_codes(PRCo, EarnCode). Optional. If omitted, will be defaulted based on Vista defaulting logic.

Memo

string | null

Optional. If omitted, null will be defaulted.

Shift

integer

Shift. Optional. If omitted, will be defaulted based on Vista defaulting logic.

Rate

string

Optional. If omitted, will be defaulted based on Vista defaulting logic.

Hours

string

required

Hours.

Amt

string

Amount. Optional. If omitted, it will be defaulted based on Vista defaulting logic.

CrewTemplateID

integer | null

Crew Template ID related to the Vista Web Portal. Optional. If omitted, null will be defaulted.

__custom_fields

object

Add a property for each user defined values that should be set on the header form as part of this action.

__disable_validation

array of strings

Disable Vista validations for properties listed in this field.

__disable_validation

TypeDetails

required

Provide the object based on the entry type. Options for $.TypeDetails.Type: J-Job, M-Mechanic, S-SM Work Order.

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


xxxxxxxxxx
11
1
curl --request POST \
2
     --url https://api.xchange.trimble.com/connect/v1/direct/subscribers/subscriber_code/vista/pr/2/data/time_batch_entries/actions/add \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "TypeDetails": {
8
    "Type": "J"
9
  }
10
}
11
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Describes issues with the request.

x-$.result for SuccessfulObject returned at $.result from GET /direct/actions/{action_key_value} when $.status = "Successful"

x-$.result for FailedObject returned at $.result from GET /direct/actions/{action_key_value} when $.status = "Failed"