sgrDocumentoAE
Class of association of documents with the shipping authorization.
PARAMETERS
| Field | Type | Required? | Description |
|---|---|---|---|
| nrDoc | String (max 20 characters) | Yes | Document number |
| tpDoc | integer | Yes | Document type. This code is returned by the method sgrListDocumentType |
| valueDoc | decimal | Yes | Total document value |
| tpOperacao | integer | Yes | Operation Type Code, returned by the sgrListaTiposOperacao method |
| dtPrevista | DateTime | Yes | Expected delivery date |
| dtExpectedDeparture | String (max 20 characters) | No | Expected to leave the delivery location. Send in “YYYY-MM-DD” format |
| cdCidIBGE | int | Yes | IBGE code of the delivery city, returned by the sgrListaCidades method |
| dsRua | String (max 50 characters) | Yes | Delivery address |
| nrStreet | String (max 6 characters) | Yes | Delivery address number |
| complementStreet | String (max 40 characters) | No | Delivery address complement |
| dsBairro | String (max 50 characters) | No | Delivery neighborhood |
| nrCep | String (max 8 characters) | No | Delivery zip code |
| nrFone1 | String (max 12 characters) | No | Delivery address phone number |
| nrFone2 | String (max 12 characters) | No | Phone number of delivery address |
| nrCnpjCPFEmbarcador | String (max 16 characters) | No * | CNPJ/CPF of the shipper. * Only inform if the “cdEmbarcadorCliente” field is not filled in. When not filled in, send “” (blank). |
| cdEmbarcadorCliente | String (max 20 characters) | No * | Code of the shipper in the client. * Only inform if the “nrCnpjCPFEmbarcador” field is not filled in. The use of this field implies the registration of all codes (from-to) in Opentech. When not filled in, send “” (blank). |
| nrCnpjCPFEmitente | String (max 16 characters) | No | CNPJ/CPF number of the Issuer of the document. When the data does not exist, send “” (blank). |
| nrCnpjCPFDestinatario | String (max 16 characters) | No | Document recipient's CNPJ/CPF number. Send “” (blank) when the information does not exist. |
| nrCnpjCpfDestinatarioSequencia | String (max 16 characters) | No | Receiver's CNPJ/CPF sequence. Used to control different delivery addresses for the same CNPJ. This sequence is defined by the customer. |
| Latitude | float | Yes | Latitude of the delivery address. Send 0 (zero) when the information does not exist. |
| Longitude | float | Yes | Longitude of the delivery address. Send 0 (zero) when no information exists. |
| dsName | String (max 50 characters) | Yes | Delivery recipient's name |
| qtVolumes | integer | Yes | Number of Volumes. |
| qtParts | integer | Yes | Number of Parts. |
| nrCustomerControl1 | String (max 20 characters) | No | Field for free use. If not available, send “” (blank). |
| nrCustomerControl2 | String (max 20 characters) | No | Field for free use. When it doesn't exist, send “” (blank). |
| nrCustomerControl3 | String (max 20 characters) | No | Field for free use. When it doesn't exist, send “” (blank). |
| nrCustomerControl4 | String (max 20 characters) | No | Field for free use. When it doesn't exist, send “” (blank). |
| nrCustomerControl5 | String (max 20 characters) | No | Field for free use. When it doesn't exist, send “” (blank). |
| nrCustomerControl6 | String (max 20 characters) | No | Field for free use. When it doesn't exist, send “” (blank). |
| products | List | Yes | List of products in the Document. To use this field, you must create an array of type sgrProduct. |
| vlCubage | integer | No | Total cubage value of the document. |
| vlWeight | integer | No | Total document weight. |
| cdTransp | integer | No | Carrier code |
| flExchangeNote | integer | No | Indicates whether the document allows the invoice to be exchanged, i.e. whether the document can be replaced by another. Enter a value of 1 for Yes and 0 for No. |
| cdProgramacaoDestinatario | integer | No | Programming recipient code. |