Work Order
Create Work Order
Creates a work order with the given values.
POST
/
api
/
vms
/
v1
/
work-order-accept
curl --request POST \
--url https://api.bindbee.dev/api/vms/v1/work-order-accept \
--header 'Content-Type: application/json' \
--data '{
"additional_attributes": {
"contract_end_date": "2025-12-31T00:00:00",
"previous_employer": "TechCorp"
},
"custom_fields": {
"customTshirtSize": "XXL"
},
"model": {
"id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
"remote_id": "123321",
"modified_at": "2021-10-16T00:00:00Z",
"raw_data": {
"key_1": "Platform dependent data 1",
"key_2": "Platform dependent data 2"
},
"custom_fields": {
"category_group": "REG",
"disability_type": "ASBERG",
"hire_date": "1991-03-16T00:00:00",
"hire_source": "REFER",
"nationality": "USA",
"original_hire_date": "1991-03-16T00:00:00"
},
"work_order_id": "KTWO10002",
"job_seeker_id": "KTJS9873264A",
"worker_email": "kunal@bindbee.dev",
"pay_rates": {}
}
}'
"<any>"
Body
application/json
Example:
"018b18ef-c487-703c-afd9-0ca478ccd9d6"
The third-party API ID of the matching object.
Example:
"123321"
This is the datetime that this object was last updated by Bindbee
Example:
"2021-10-16T00:00:00Z"
The custom fields related to the model
Example:
{
"category_group": "REG",
"disability_type": "ASBERG",
"hire_date": "1991-03-16T00:00:00",
"hire_source": "REFER",
"nationality": "USA",
"original_hire_date": "1991-03-16T00:00:00"
}
Work Order ID
Example:
"KTWO10002"
Job Seeker ID
Example:
"KTJS9873264A"
Worker Email
Example:
"kunal@bindbee.dev"
Pay Rates for this Work Order
Allowed rate categories are STANDARD_RATE, OVERTIME_RATE and DOUBLE_RATE
Available options:
ST
, OT
, DT
Allowed rate units are HOURLY and DAILY
Available options:
Hr
, Daily
Value of the rate
Example:
21.02
Available options:
br
, pr
Example:
{}
This is the Raw data
Example:
{
"key_1": "Platform dependent data 1",
"key_2": "Platform dependent data 2"
}
Fields related to models other than employee Model
Example:
{
"contract_end_date": "2025-12-31T00:00:00",
"previous_employer": "TechCorp"
}
The custom fields related to the model
Example:
{ "customTshirtSize": "XXL" }
Response
200
application/json
Successful Response
The response is of type any
.
curl --request POST \
--url https://api.bindbee.dev/api/vms/v1/work-order-accept \
--header 'Content-Type: application/json' \
--data '{
"additional_attributes": {
"contract_end_date": "2025-12-31T00:00:00",
"previous_employer": "TechCorp"
},
"custom_fields": {
"customTshirtSize": "XXL"
},
"model": {
"id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
"remote_id": "123321",
"modified_at": "2021-10-16T00:00:00Z",
"raw_data": {
"key_1": "Platform dependent data 1",
"key_2": "Platform dependent data 2"
},
"custom_fields": {
"category_group": "REG",
"disability_type": "ASBERG",
"hire_date": "1991-03-16T00:00:00",
"hire_source": "REFER",
"nationality": "USA",
"original_hire_date": "1991-03-16T00:00:00"
},
"work_order_id": "KTWO10002",
"job_seeker_id": "KTJS9873264A",
"worker_email": "kunal@bindbee.dev",
"pay_rates": {}
}
}'
"<any>"