Description of protocol attributes

Versión actual (v. 2)

25/09/2023

@Juan Eduardo Sosa

v. 1

13/12/2021

@Angel Javier Larrosa

Attribute

Type

Description

system_id

string

Is the system identification. For Third Party integrations you must put 'third_party'

local_id

int|null

• SIMA sends to ERP.

• SIMA receives from Third Party. Is SIMA unique identification for work orders.

(Only one of local_id, local_code, external_id, external_code is used)

local_code

string|null

• SIMA sends to ERP.

• Not used in Third Party integrations.

(Only one of local_id, local_code, external_id, external_code is used)

external_id

int|null

• SIMA receives from ERP.

• Not used in Third Party integrations.

(Only one of local_id, local_code, external_id, external_code is used)

external_code

string|null

• SIMA receives from ERP.

• Not used in Third Party integrations.

(Only one of local_id, local_code, external_id, external_code is used)

date

datetime

• Is the creation date.

• ISO-8601 format, Ex: "2019-10-13T11:29:20-03:00"

voucher_date

datetime

• Is the work order date.

• ISO-8601 format, Ex: "2019-10-13T11:29:20-03:00"

name

string|null

• Is the name to identify the work order.

is_read_only

bool

• Indicates if the work order is editable in the external ERP.

• In Third Party integrations, the value true will be returned when OT is in status “En sistema externo“ and Status is 'Confirmed' => true.

concurrency_token

int|null

• It is used to control the flow of an OT. It allows to avoid writing of unwanted OTs.

• Third Party not implemented yet.

currency

Object

• Object used by ERPs to define the currency

• Not used in Third Party integrations.

(Only one of local_id, local_code, external_id, external_code is used)

observations

string|null

• Work order observation.

state

Object

• Object used to define the status of the work order.

• Only one of pending, executed, confirmed can be true. The others mus be false.

• For ThirdParty integrations there can be three cases.

1. Pending true. When the work order is approved.

2. Executed true: When the work order is approved and has confirmation dates.

3. Confirmed true: When the work order is executed. This alos implies that all confirmations have execution dates.

extra_fields

Object

• Object used to define other attributes necessary for integration between systems.

• The object dimension and company are used by ERPs.

• The object voucher_type is used to specify the work order type. In Third Party integrations local_id must match with one of the SIMA voucher type.

(Only one of local_id, local_code, external_id, external_code is used)

Attribute

Type

Description

local_id

int|null

• SIMA sends to ERP.

• SIMA receives from Third Party. Is SIMA unique identification for work orders confirmations.

(Only one of local_id, local_code, external_id, external_code is used)

local_code

string|null

• SIMA sends to ERP.

• Not used in Third Party integrations.

(Only one of local_id, local_code, external_id, external_code is used)

external_id

int|null

• SIMA receives from ERP.

• Not used in Third Party integrations.

(Only one of local_id, local_code, external_id, external_code is used)

external_code

string|null

• SIMA receives from ERP.

• Not used in Third Party integrations.

(Only one of local_id, local_code, external_id, external_code is used)

cultivation

object

• Object used to indicate the crop.

• In Third Party integrations you must fill local_id with SIMA campaign_id.

(Only one of local_id, local_code, external_id, external_code is used)

date

datetime

• Is the work order date.

• ISO-8601 format, Ex: "2019-10-13T11:29:20-03:00"

area_applied

float

• Area applied.

state

object

• Object used to define the status of the work order.

• Only one of pending, executed, confirmed can be true. The others mus be false.

(Only one of local_id, local_code, external_id, external_code is used)

date_applied

datetime

• It is the day of application of the work order.

• ISO-8601 format, Ex: "2019-10-13T11:29:20-03:00"

formulated

object

• This Object specify the formulated used in the work order.

• In Third Party integrations you must fill local_id with SIMA formulated_id.

(Only one of local_id, local_code, external_id, external_code is used)

warehouse

object

• Object used to specify the warehouse, used in ERP integrations.

• Not used in Third Party integrations.

(Only one of local_id, local_code, external_id, external_code is used)

total_applied

float

• Total applied.

extra_fields

object

• Object used to define other attributes necessary for integration between systems.

• The object voucher_type is used to specify the work order type. In Third Party integrations local_id must match with one of the SIMA work orders type.

(Only one of local_id, local_code, external_id, external_code is used)

Attribute

Type

Description

local_id

int|null

• SIMA sends to ERP.

• SIMA receives from Third Party. Is SIMA unique identification for work orders campaigns.

(Only one of local_id, local_code, external_id, external_code is used)

local_code

string|null

• SIMA sends to ERP.

• Not used in Third Party integrations.

(Only one of local_id, local_code, external_id, external_code is used)

external_id

int|null

• SIMA receives from ERP.

• Not used in Third Party integrations.

(Only one of local_id, local_code, external_id, external_code is used)

external_code

string|null

• SIMA receives from ERP.

• Not used in Third Party integrations.

(Only one of local_id, local_code, external_id, external_code is used)

cultivation

object

• Object used to indicate the crop.

• In Third Party integrations you must fill local_id with SIMA campaign_id.

(Only one of local_id, local_code, external_id, external_code is used)

date

datetime

• It is the estimated date of execution of the labour.

• ISO-8601 format, Ex: "2019-10-13T11:29:20-03:00".

area_applied

float

• Area applied

state

object

• Object used to define the status of the work order.

• Only one of pending, executed, confirmed can be true. The others mus be false.

(Only one of local_id, local_code, external_id, external_code is used)

date_applied

datetime

• Is the labour applied date.

• ISO-8601 format, Ex: "2019-10-13T11:29:20-03:00".

applicators

array of objects

• Not used in SIMA integrations

machines

array of objects

• The ERPs uses external_code or external_id.

• The Third Party integrations use local_id that must fill with SIMA machine_id.

(Only one of local_id, local_code, external_id, external_code is used)

contractors

array of objects

• The ERPs uses external_code or external_id.

• The Third Party integrations use local_id that must fill with SIMA applicator_id.

(Only one of local_id, local_code, external_id, external_code is used)

service

object

• Object used to specify the service.

• The ERPs uses external_code or external_id.

• The Third Party integrations use local_id that must fill with SIMA Application Order Labour Type.

(Only one of local_id, local_code, external_id, external_code is used)

extra_fields

object

• Object used to define other attributes necessary for integration between systems.

• The object voucher_type is used to specify the work order type. In Third Party integrations local_id must match with one of the SIMA work orders type.

(Only one of local_id, local_code, external_id, external_code is used)