There are 5 endpoints available for the implementation of work order integration.
Create
...
Workorder detail uri:
| Code Block |
|---|
/integration/api/v1/workOrders/{externalId/externalCode/localId} |
Method
...
Edit
...
:
| Code Block |
|---|
GET |
Header:
| Code Block |
|---|
'X-SIMA-APIKEY: {API-KEY}',
'X-SIMA-SYSTEM-ID: {API-SYSTEM-ID}',
'Accept: application/json',
'Content-Type: application/json' |
Response example:
| Code Block |
|---|
{
"data": {
"header": {
"system_id": "sima",
"local_id": 1416991,
"external_id": 234278,
"local_code": null,
"external_code": null,
"date": "2021-12-20T17:34:02-03:00",
"voucher_date": "2022-06-18T00:00:00-03:00",
"name": "-",
"is_read_only": false,
"concurrency_token": null,
"currency": {
"local_id": 1,
"external_id": null,
"local_code": null,
"external_code": null,
"origin": {
"local_id": 1,
"external_id": null,
"local_code": null,
"external_code": null
}
},
"observations": "Cosecha - Servicio : COST",
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"extra_fields": {
"company": {
"local_id": 1,
"external_id": null,
"local_code": null,
"external_code": null
},
"voucher_type": {
"local_id": 150,
"external_id": null,
"local_code": null,
"external_code": null
},
"dimension": {
"local_id": 1121,
"external_id": null,
"local_code": null,
"external_code": null
}
}
},
"supplies": [],
"labours": [
{
"local_id": 170654,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": null,
"external_id": null,
"local_code": "6285",
"external_code": null
},
"date": "2021-12-20T17:34:02-03:00",
"area_applied": 81,
"unit_dose": null,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"applicators": [],
"contractors": [],
"machines": [],
"service": {
"local_id": null,
"external_id": null,
"local_code": "195",
"external_code": null,
"price": null
},
"extra_fields": {
"voucher_type": {
"local_id": 25,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
}
]
}
} |
Workorder list uri:
| Code Block |
|---|
/app_dev.php/integration/api/v1/workOrders |
...
Method: PATCH
Delete
Uri: /integration/api/v1/workOrders/{externalId/localId}
Method: DELETE
Detail
...
?page={pageNumber} |
Method:
| Code Block |
|---|
GET |
Header:
| Code Block |
|---|
'X-SIMA-APIKEY: {API-KEY}',
'X-SIMA-SYSTEM-ID: {API-SYSTEM-ID}',
'Accept: application/json',
'Content-Type: application/json' |
Response example:
| Code Block |
|---|
{
"data": [
{
"header": {
"system_id": "sima",
"local_id": 1416991,
"external_id": 234278,
"local_code": null,
"external_code": null,
"date": "2021-12-20T17:34:02-03:00",
"voucher_date": "2022-06-18T00:00:00-03:00",
"name": "-",
"is_read_only": false,
"concurrency_token": null,
"currency": {
"local_id": 1,
"external_id": null,
"local_code": null,
"external_code": null,
"origin": {
"local_id": 1,
"external_id": null,
"local_code": null,
"external_code": null
}
},
"observations": "Cosecha - Servicio : COST",
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"extra_fields": {
"company": {
"local_id": 1,
"external_id": null,
"local_code": null,
"external_code": null
},
"voucher_type": {
"local_id": 150,
"external_id": null,
"local_code": null,
"external_code": null
},
"dimension": {
"local_id": 1121,
"external_id": null,
"local_code": null,
"external_code": null
}
}
},
"supplies": [],
"labours": [
{
"local_id": 170654,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": null,
"external_id": null,
"local_code": "6285",
"external_code": null
},
"date": "2021-12-20T17:34:02-03:00",
"area_applied": 81,
"unit_dose": null,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"applicators": [],
"contractors": [],
"machines": [],
"service": {
"local_id": null,
"external_id": null,
"local_code": "195",
"external_code": null,
"price": null
},
"extra_fields": {
"voucher_type": {
"local_id": 25,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
}
]
},
{
"header": {
"system_id": "sima",
"local_id": 1416998,
"external_id": 234280,
"local_code": null,
"external_code": null,
"date": "2021-12-20T17:34:06-03:00",
"voucher_date": "2022-06-18T00:00:00-03:00",
"name": "-",
'X-SIMA-SYSTEM-ID: {API-SYSTEM-ID}',"is_read_only": false,
"concurrency_token": null,
"currency": {
"local_id": 1,
"external_id": null,
"local_code": null,
"external_code": null,
"origin": {
"local_id": 1,
"external_id": null,
"local_code": null,
"external_code": null
}
},
"observations": "Cosecha - Servicio : COST",
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"extra_fields": {
"company": {
"local_id": 1,
"external_id": null,
"local_code": null,
"external_code": null
},
"voucher_type": {
"local_id": 150,
"external_id": null,
"local_code": null,
"external_code": null
},
"dimension": {
"local_id": 1121,
"external_id": null,
"local_code": null,
"external_code": null
}
}
},
"supplies": [],
"labours": [
{
"local_id": 170674,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": null,
"external_id": null,
"local_code": "6285",
"external_code": null
},
"date": "2021-12-20T17:34:06-03:00",
"area_applied": 81,
"unit_dose": null,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"applicators": [],
"contractors": [],
"machines": [],
"service": {
"local_id": null,
"external_id": null,
"local_code": "195",
"external_code": null,
"price": null
},
"extra_fields": {
"voucher_type": {
"local_id": 25,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
}
]
},
]
} |
Workorder create uri:
| Code Block |
|---|
/integration/api/v1/workOrders |
Method:
| Code Block |
|---|
POST |
Header:
| Code Block |
|---|
'X-SIMA-APIKEY: {API-KEY}',
'X-SIMA-SYSTEM-ID: {API-SYSTEM-ID}',
'Accept: application/json',
'Content-Type: application/json' |
Body example:
| Code Block |
|---|
{
"header": {
"system_id": "third_party",
"date": "2021-10-27T15:56:09Z",
"voucher_date": "2020-07-01T00:00:00Z",
"name": "name-test",
"is_read_only": true,
"concurrency_token": null,
"currency": {
"origin": {
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null
},
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null
},
"observations": "Barbecho - Servicio : FTW - Insumo : RizoSpray Corrector,Power Plus II,24D",
"state": {
"pending": false,
"executed": false,
"confirmed": true
},
"extra_fields": {
"company": {
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null
},
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"dimension": {
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null
}
},
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null
},
"supplies": [
{
"cultivation": {
"local_id": 146740,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2020-08-03T00:00:00Z",
"area_applied": 45.00,
"state": {
"pending": false,
"executed": false,
"confirmed": true
},
"date_applied": "2020-08-19T00:00:00Z",
"formulated": {
"local_id": 19574,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": {
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null
},
"total_applied": 0.2250,
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
},
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null
}
],
"labours": [
{
"cultivation": {
"local_id": 146740,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2020-08-03T00:00:00Z",
"area_applied": 45.00,
"unit_dose": 1.00,
"state": {
"pending": false,
"executed": false,
"confirmed": true
},
"date_applied": "2020-08-19T00:00:00Z",
"applicators": [],
"machines": [],
"contractors": [],
"service": {
"price": null,
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null
},
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
},
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null
}
]
} |
Response example:
| Code Block |
|---|
Workorder edit uri:
| Code Block |
|---|
/integration/api/v1/workOrders/{externalId/externalCode/localId} |
Method
...
List
...
:
| Code Block |
|---|
PATCH |
Header:
| Code Block |
|---|
'X-SIMA-APIKEY: {API-KEY}',
'X-SIMA-SYSTEM-ID: {API-SYSTEM-ID}',
'Accept: application/json',
'Content-Type: application/json' |
Body example:
| Code Block |
|---|
Response example:
| Code Block |
|---|
Workorder delete uri:
| Code Block |
|---|
/integration/api/v1/workOrders |
...
/{externalId/externalCode/localId} |
Method:
...
Headers for the request
...
Key
...
Value
| Code Block |
|---|
PATCH |
Header:
| Code Block |
|---|
'X-SIMA-APIKEY |
...
{api_key}
: {API-KEY}', 'X-SIMA-SYSTEM-ID |
...
{protocol_system_id}
...
Accept
...
application/json
...
Content-type
...
: {API-SYSTEM-ID}',
'Accept: application/json',
'Content-Type: application/json' |
Response example:
| Code Block |
|---|
Detail of the variables used
{api_keyAPI-KEY}: Authentication api key.
{externalId/externalCode/localId}:Unique identifier of the system that integrates with SIMA of the integrated work order (externalId) or the unique identifier in SIMA (localId).
{pageNumber}: Requested page number from the list of integrated work orders.
{protocol_system_idAPI-SYSTEM-ID}: Unique identifier assigned by SIMA to the integrated external entity or if you will integrate as a Third Party you must use the protocol_system_id = 8.