Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
/integration/api/v1/workOrders?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'

Parameters:

Code Block
page:  (int) default value 1
id: (int) optional
updated_from: (datetime) optional
created_from: (datetime) optional
issued_from: (datetime) optional
issued_to: (datetime) optional
order_types: string 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
                    }
                }
            ]
        },
    ]
}    

...

{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.

{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.