sgrDocumentoProdutosSeqV2
Class of association of documents with the shipping authorization.
PARAMETERS
Field | Type | Required? | Description |
---|---|---|---|
nrDoc | String | Yes | Document number (up to 20 characters) |
tpDoc | integer | Yes | Document type. This code is returned by the sgrListDocumentType method. |
valueDoc | decimal | Yes | Total document value |
tpOperacao | integer | Yes | Operation Type Code, returned by the sgrListaTiposOperacao method |
dtPrevista | datetime | Yes | Expected delivery date. Send in “YYYY-MM-DD” format |
dtExpectedDeparture | String | No | Expected to leave the delivery location. Send in “YYYY-MM-DD” format |
cdCid | integer | Yes | Delivery city code, returned by the sgrListCities method. |
dsStreet | String | Yes | Delivery address (up to 50 characters) |
nrStreet | string | Yes | Delivery address number (up to 6 characters) |
complementStreet | string | No | Delivery address complement (up to 40 characters) |
dsBairro | String | No | Delivery neighborhood (up to 50 characters) |
nrCep | String | No | Delivery zip code (up to 8 characters) |
nrFone1 | string | No | Delivery address phone number (up to 12 characters) |
nrFone2 | String | No | Delivery address phone number (up to 12 characters) |
cdShipper | integer | Yes | Shipper code. This code is returned by the sgrListShippers method. If it doesn't exist, send the customer's own code in this field. |
cdPaisOrigemEmitente | integer | Yes | Issuer's country of origin code. This code is returned by the sgrListaPais method. You must send -1 when the issuer's data does not exist. |
nrCnpjCPFEmitente | string | No | CNPJ/CPF number of the Issuer of the document. Send “” (blank) when there is no information. (up to 16 characters) |
cdPaisOrigemDestinatario | integer | Yes | Receiver's country of origin code. This code is returned by the sgrListaPais method. You must send -1 when the Recipient's data does not exist. |
nrCnpjCPFDestinatario | string | No | Document recipient's CNPJ/CPF number. Send “” (blank) when the information does not exist. (up to 16 characters) |
nrCnpjCpfDestinatarioSequencia | String | No | Receiver's CNPJ/CPF sequence. Used to control different delivery addresses for the same CNPJ. This sequence is defined by the customer. (up to 50 characters) |
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 the information does not exist. |
dsName | String | Yes | Delivery recipient's name (up to 50 characters) |
qtVolumes | integer | Yes | Number of Volumes. |
qtParts | integer | Yes | Number of Parts. |
nrLacreSIF | String | No | Field for free use by the customer. If not available, send “” (blank). (up to 20 characters) |
nrLacreArmador | |||
dsShip | |||
dsSiglaOrig | string | No | Origin Unit acronym. Send “” (blank) when the information does not exist. (up to 20 characters) |
dsSiglaDest | string | No | Acronym of the Destination Unit. Send “” (blank) when the information does not exist. (up to 20 characters) |
flRegiao | integer | No | Destination Region Code (1-South, 2-Southwest, 3-Central-West, 4-Northeast, 5-North) |
nrCustomerControl1 | String | No | Field for free use by the customer. If not available, send “” (blank). (up to 20 characters) |
nrCustomerControl2 | No | ||
nrCustomerControl3 | No | ||
products | List | Yes | Document product list. 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, returned by the sgrListaTransportadoras method. |
nrDDDFone1 | string | No* | DDD Phone number of delivery address *Mandatory if nrFone1 is entered (up to 5 characters) |
nrDDDFone2 | string | No* | DDD Delivery address phone number. * Mandatory if nrFone2 is entered (up to 5 characters) |
nrCustomerControl7 | string | No | Field for free use by the customer. If not available, send “” (blank). (up to 20 characters) |
nrCustomerControl8 | |||
nrCustomerControl9 | |||
nrCustomerControl10 | |||
flTrocaNota | integer | No | Indicates whether the document allows invoices to be exchanged, i.e. whether the document can be replaced by another. Enter a value of 1 for Yes and 0 for No. |
cdExchangeNote | integer | No | Code of the replacement document. |
cdProgramacaoDestinatario | integer | No | Programming recipient code. |
cdProgramming | integer | No | Programming code. |
nfs | list | No | List of notes to exchange. To use this field, you must create an array of type sgrNF. |
vlStartDiaryOnTerm | integer | No | Indicates whether the start of the per diem is on time. |
vlStartDailyLate | integer | No | Indicates if the start of the daily rate is late. |