| Change History |
|---|
There are 5 endpoints available for the implementation of work order integration.
...
Detail
Uri
...
:
...
...
| Code Block |
|---|
...
/integration/api/v1/workOrders |
...
Method: PATCH
Delete
...
/ |
...
{externalId/externalCode/localId} |
Method:
...
Detail
Uri: /integration/api/v1/workOrders/{externalId/localId}
Method: GET
List
Uri: /integration/api/v1/workOrders?page={pageNumber}
Method: GET
Headers for the request
...
Key
...
Value
| Code Block |
|---|
GET |
Header:
| Code Block |
|---|
'X-SIMA-APIKEY |
...
{api_key}
: {API-KEY}', 'X-SIMA-SYSTEM-ID |
...
{protocol_system_id}
...
Accept
...
application/json
...
Content-type
...
application/json
Detail of the variables used
{api_key}: Authentication api key.
...
{pageNumber}: Requested page number from the list of integrated work orders.
...
: {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
}
}
]
}
} |
List:
Uri:
| Code Block |
|---|
/integration/api/v1/workOrders |
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' |
Parameters:
| Code Block |
|---|
page: (int) default value 1
id: (int) optional
updated_from: (datetime) optional
created_from: (datetime) optional
created_to: (datetime) optional
voucher_date_from: (datetime) optional
voucher_date_to: (datetime) optional
voucher_type_ids: (string) optional
cultivation_id: int optional
state: (string) optional (confirmed|pending)
name: (string) optional
date_applied_from: (datetime) optional
date_applied_to: (datetime) optional
warehouse_id: (int) optional
formulated_id: (int) optional
contractor_id: (int) optional
machine_id: (int) optional
service_id: (int) optional
deleted_at_from: (datetime) optional
deleted_at_to: (datetime) optional |
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
}
}
]
},
]
} |
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",
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null,
"date": "2022-07-04T17:03:14-03:00",
"voucher_date": "2022-07-04T00:00:00-03:00",
"name": "barbecho largo L1 y L2 / MAIZ-04/07/2022",
"is_read_only": false,
"concurrency_token": null,
"currency": {
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null,
"origin": {
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null
}
},
"observations": null,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"extra_fields": {
"company": {
"local_id": 32,
"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
}
}
},
"supplies": [
{
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243405,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-07-04T17:03:14-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 8844,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 59.999,
"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,
"cultivation": {
"local_id": 243405,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-07-04T17:03:14-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 39034,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 19.999,
"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,
"cultivation": {
"local_id": 243405,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-07-04T17:03:14-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 89,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 7.5,
"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,
"cultivation": {
"local_id": 243405,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-07-04T17:03:14-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 170,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 34.998,
"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,
"cultivation": {
"local_id": 243406,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-07-04T17:03:14-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 8844,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 59.999,
"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,
"cultivation": {
"local_id": 243406,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-07-04T17:03:14-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 39034,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 19.999,
"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,
"cultivation": {
"local_id": 243406,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-07-04T17:03:14-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 89,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 7.5,
"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,
"cultivation": {
"local_id": 243406,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-07-04T17:03:14-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 170,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 34.998,
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
}
],
"labours": [
{
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243405,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-07-04T00:00:00-03:00",
"area_applied": 37,
"unit_dose": null,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"applicators": [],
"contractors": [
{
"local_id": 3056,
"external_id": null,
"local_code": null,
"external_code": null
}
],
"machines": [
{
"local_id": 4419,
"external_id": null,
"local_code": null,
"external_code": null
}
],
"service": {
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null,
"price": 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,
"cultivation": {
"local_id": 243406,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-07-04T00:00:00-03:00",
"area_applied": 37,
"unit_dose": null,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"applicators": [],
"contractors": [
{
"local_id": 3056,
"external_id": null,
"local_code": null,
"external_code": null
}
],
"machines": [
{
"local_id": 4419,
"external_id": null,
"local_code": null,
"external_code": null
}
],
"service": {
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null,
"price": null
},
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
}
]
} |
Response example:
| Code Block |
|---|
{
"data": {
"header": {
"system_id": "sima",
"local_id": 292781,
"external_id": null,
"local_code": null,
"external_code": null,
"date": "2022-08-08T10:07:36-03:00",
"voucher_date": "2022-07-04T00:00:00-03:00",
"name": "barbecho largo L1 y L2 / MAIZ-04/07/2022",
"is_read_only": false,
"concurrency_token": null,
"currency": {
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null,
"origin": {
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null
}
},
"observations": null,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"extra_fields": {
"company": {
"local_id": 32,
"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
}
}
},
"supplies": [
{
"local_id": 2517893,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243405,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-08-08T10:07:36-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 8844,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 119.998,
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
},
{
"local_id": 2517894,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243405,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-08-08T10:07:36-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 39034,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 39.998,
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
},
{
"local_id": 2517895,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243405,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-08-08T10:07:36-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 89,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 15,
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
},
{
"local_id": 2517896,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243405,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-08-08T10:07:36-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 170,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 69.996,
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
},
{
"local_id": 2517897,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243406,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-08-08T10:07:36-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 8844,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 119.998,
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
},
{
"local_id": 2517898,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243406,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-08-08T10:07:36-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 39034,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 39.998,
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
},
{
"local_id": 2517899,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243406,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-08-08T10:07:36-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 89,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 15,
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
},
{
"local_id": 2517900,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243406,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-08-08T10:07:36-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 170,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 69.996,
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
}
],
"labours": [
{
"local_id": 761553,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243405,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-07-04T00:00:00-03:00",
"area_applied": 37,
"unit_dose": null,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"applicators": [],
"contractors": [
{
"local_id": 3056,
"external_id": null,
"local_code": null,
"external_code": null
}
],
"machines": [
{
"local_id": 4419,
"external_id": null,
"local_code": null,
"external_code": null
}
],
"service": {
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null,
"price": 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": 761554,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243406,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-07-04T00:00:00-03:00",
"area_applied": 37,
"unit_dose": null,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"applicators": [],
"contractors": [
{
"local_id": 3056,
"external_id": null,
"local_code": null,
"external_code": null
}
],
"machines": [
{
"local_id": 4419,
"external_id": null,
"local_code": null,
"external_code": null
}
],
"service": {
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null,
"price": null
},
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
}
]
}
} |
Edit
Uri:
| Code Block |
|---|
/integration/api/v1/workOrders/{externalId/externalCode/localId} |
Method:
| 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 |
|---|
{
"header": {
"system_id": "third_party",
"local_id": 292781,
"external_id": null,
"local_code": null,
"external_code": null,
"date": "2022-08-08T10:07:36-03:00",
"voucher_date": "2022-07-04T00:00:00-03:00",
"name": "barbecho largo L1 y L2 / MAIZ-04/07/2022",
"is_read_only": false,
"concurrency_token": null,
"currency": {
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null,
"origin": {
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null
}
},
"observations": "Una observación",
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"extra_fields": {
"company": {
"local_id": 32,
"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
}
}
},
"supplies": [
{
"local_id": 2517893,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243405,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-08-08T10:07:36-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 8844,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 119.998,
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
},
{
"local_id": 2517894,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243405,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-08-08T10:07:36-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 39034,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 39.998,
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
},
{
"local_id": 2517895,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243405,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-08-08T10:07:36-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 89,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 15,
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
},
{
"local_id": 2517896,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243405,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-08-08T10:07:36-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 170,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 69.996,
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
},
{
"local_id": 2517897,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243406,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-08-08T10:07:36-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 8844,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 119.998,
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
},
{
"local_id": 2517898,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243406,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-08-08T10:07:36-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 39034,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 39.998,
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
},
{
"local_id": 2517899,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243406,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-08-08T10:07:36-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 89,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 15,
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
},
{
"local_id": 2517900,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243406,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-08-08T10:07:36-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 170,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 69.996,
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
}
],
"labours": [
{
"local_id": 761553,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243405,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-07-04T00:00:00-03:00",
"area_applied": 37,
"unit_dose": null,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"applicators": [],
"contractors": [
{
"local_id": 3056,
"external_id": null,
"local_code": null,
"external_code": null
}
],
"machines": [
{
"local_id": 4419,
"external_id": null,
"local_code": null,
"external_code": null
}
],
"service": {
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null,
"price": 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": 761554,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243406,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-07-04T00:00:00-03:00",
"area_applied": 37,
"unit_dose": null,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"applicators": [],
"contractors": [
{
"local_id": 3056,
"external_id": null,
"local_code": null,
"external_code": null
}
],
"machines": [
{
"local_id": 4419,
"external_id": null,
"local_code": null,
"external_code": null
}
],
"service": {
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null,
"price": null
},
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
}
]
} |
Response example:
| Code Block |
|---|
{
"data": {
"header": {
"system_id": "sima",
"local_id": 292781,
"external_id": null,
"local_code": null,
"external_code": null,
"date": "2022-08-08T10:28:59-03:00",
"voucher_date": "2022-07-04T00:00:00-03:00",
"name": "barbecho largo L1 y L2 / MAIZ-04/07/2022",
"is_read_only": false,
"concurrency_token": null,
"currency": {
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null,
"origin": {
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null
}
},
"observations": "Una observación",
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"extra_fields": {
"company": {
"local_id": 32,
"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
}
}
},
"supplies": [
{
"local_id": 2517917,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243405,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-08-08T10:28:59-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 8844,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 119.991,
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
},
{
"local_id": 2517918,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243405,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-08-08T10:28:59-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 39034,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 39.997,
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
},
{
"local_id": 2517919,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243405,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-08-08T10:28:59-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 89,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 14.985000000000001,
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
},
{
"local_id": 2517920,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243405,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-08-08T10:28:59-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 170,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 70.00399999999999,
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
},
{
"local_id": 2517921,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243406,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-08-08T10:28:59-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 8844,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 119.991,
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
},
{
"local_id": 2517922,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243406,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-08-08T10:28:59-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 39034,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 39.997,
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
},
{
"local_id": 2517923,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243406,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-08-08T10:28:59-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 89,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 14.985000000000001,
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
},
{
"local_id": 2517924,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243406,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-08-08T10:28:59-03:00",
"area_applied": 37,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"formulated": {
"local_id": 170,
"external_id": null,
"local_code": null,
"external_code": null
},
"warehouse": null,
"total_applied": 70.00399999999999,
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
}
],
"labours": [
{
"local_id": 761559,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243405,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-07-04T00:00:00-03:00",
"area_applied": 37,
"unit_dose": null,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"applicators": [],
"contractors": [
{
"local_id": 3056,
"external_id": null,
"local_code": null,
"external_code": null
}
],
"machines": [
{
"local_id": 4419,
"external_id": null,
"local_code": null,
"external_code": null
}
],
"service": {
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null,
"price": 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": 761560,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 243406,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2022-07-04T00:00:00-03:00",
"area_applied": 37,
"unit_dose": null,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"applicators": [],
"contractors": [
{
"local_id": 3056,
"external_id": null,
"local_code": null,
"external_code": null
}
],
"machines": [
{
"local_id": 4419,
"external_id": null,
"local_code": null,
"external_code": null
}
],
"service": {
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null,
"price": null
},
"extra_fields": {
"voucher_type": {
"local_id": 7,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
}
]
}
} |
Delete
Uri:
| Code Block |
|---|
/integration/api/v1/workOrders/{externalId/externalCode/localId} |
Method:
| Code Block |
|---|
DELETE |
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 |
|---|
Empty Body: Status 204 No Content |
Detail of the variables used
{API-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).
{API-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.
Delete
Uri:
| Code Block |
|---|
/integration/api/v1/workOrdersGroup |
Method:
| Code Block |
|---|
DELETE |
Header:
| Code Block |
|---|
'X-SIMA-APIKEY: {API-KEY}',
'X-SIMA-SYSTEM-ID: {API-SYSTEM-ID}',
'Accept: application/json',
'Content-Type: application/json' |
Request example:
| Code Block |
|---|
{"data":
[
473229,
473228
]
} |
Response example:
| Code Block |
|---|
{
"processed": 2,
"ok": {
"count": 2,
"ids": [
473229,
473228
]
},
"error": {
"count": 0,
"ids": []
}
} |
Third Party Structure
For Third Party we are including in extra fields of Header the values of attributes for work orders of type Labour.
Structure Example:
| Code Block |
|---|
{
"data": {
"header": {
"system_id": "sima",
"local_id": 628875,
"external_id": null,
"local_code": null,
"external_code": null,
"date": "2024-07-02T11:18:37-03:00",
"voucher_date": "2024-07-02T00:00:00-03:00",
"name": "OL-02/07/2024",
"is_read_only": false,
"concurrency_token": null,
"currency": {
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null,
"origin": {
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null
}
},
"observations": null,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"extra_fields": {
"company": {
"local_id": 32,
"external_id": null,
"local_code": null,
"external_code": null
},
"voucher_type": {
"local_id": 47,
"external_id": null,
"local_code": null,
"external_code": null
},
"dimension": {
"local_id": null,
"external_id": null,
"local_code": null,
"external_code": null
},
"attributes": [
{
"attribute_id": 3,
"value": "1"
},
{
"attribute_id": 5,
"value": ""
},
{
"attribute_id": 7,
"value": "2024-07-11"
}
]
}
},
"supplies": [],
"labours": [
{
"local_id": 1777024,
"external_id": null,
"local_code": null,
"external_code": null,
"cultivation": {
"local_id": 403304,
"external_id": null,
"local_code": null,
"external_code": null
},
"date": "2024-07-02T00:00:00-03:00",
"area_applied": 20,
"unit_dose": null,
"state": {
"pending": true,
"executed": false,
"confirmed": false
},
"date_applied": null,
"applicators": [],
"contractors": [],
"machines": [],
"service": {
"local_id": 2772,
"external_id": null,
"local_code": null,
"external_code": null,
"price": null
},
"extra_fields": {
"voucher_type": {
"local_id": 47,
"external_id": null,
"local_code": null,
"external_code": null
},
"quotation_coefficient": null,
"unit_price": null
}
}
]
}
} |