Actualiza uma guia de remessa.
Não é possível actualizar uma guia de remessa que já se encontre no estado fechado.
Os campos salesman_commission
e discount
de cada elemento do conjunto products
, caso sejam preenchidos, devem ser valores em percentagem, de 0 a 100.
O campo exemption_reason
de cada elemento do conjunto products
torna-se obrigatório caso o conjunto taxes
esteja vazio, não contenha elementos cujo imposto correspondente seja do tipo IVA ou que estes tenham valor zero.
O campo origin_id
refere-se ao documento associado de onde este produto é originário. Caso tenha guias globais associadas ao documento, existe uma obrigação legal de declarar os artigos com origem nesse documento e deverá usar este campo. Se tentar usar um id de documento que não esteja presente nos associados, irá receber um erro.
Caso a empresa só tenha um CAE e o eac_id
não for enviado, ou o que tenha sido enviado seja inválido, o eac_id
será automaticamente preenchido com o único CAE existente. Caso a empresa tenha mais do que um CAE, este será mantido em branco.
O campo value
de cada elemento dos conjuntos taxes existentes torna-se obrigatório caso o imposto definido por tax_id
seja um imposto cujo valor seja definido por artigo.
Todos os campos *_id
apenas aceitam valores válidos. Esses valores podem ser consultados nos respectivos endpoints da API. No caso dos associated_id
dos elementos do conjunto associated_documents
, têm de pertencer a documentos cujo tipo possa ser associado com guias de remessa.
Os campos delivery_departure_country
e delivery_destination_country
apenas aceitam id de países válidos. Para além disso, se o país for Portugal (id 1), o código postal deve ser válido (4 dígitos, traço, 3 dígitos).
Pode enviar os campos vehicle_name e vehicle_number_plate para definir uma viatura de transporte sem a gravar na sua empresa. Se também enviar o campo vehicle_id, a viatura por este identificada será usada em vez daqueles campos.
O campo status
aceita os valores 0 (por defeito, caso não seja preenchido) e 1, que correspondem, respectivamente, aos estados de rascunho e fechado. Ao inserir uma guia de remessa com o estado fechado, esta será comunicada para a Autoridade Tributária, caso a empresa tenha essa opção activa.
Para criar documentos noutras moedas, os campos exchange_currency_id
e exchange_rate
devem ser preenchidos. O campo exchange_currency_id
deverá ser preenchido com um id de moeda válido, que pode consultar no endpoint currencies/getAll. O campo
exchange_rate
deverá ser preenchido com o valor monetário apropriado. Pode consultar as tabelas de conversão que actualizamos todos os dias, no endpoint currencyExchange/getAll
.
Caso pretenda usar dados de transporte no documento, os dados referentes à morada de carga e à morada de descarga deverão ser preenchidos obrigatoriamente e deverá também ser preenchido um dos seguintes parâmetros:
delivery_method_id
ou vehicle_number_plate