Pagamentos
Last updated
Last updated
Os pagamentos seguem a mesma estrutura anteriormente definida: São compostos por um cabeçalho, e linhas. Nesta nova versão, é possível criar ambas as componentes num só pedido, descrito de seguida.
Os detalhes do pedido POST para a criação de recibos estão descritos de seguida, em formato OpenAPI, e em cURL.
Este pedido permite criar um pagamento, e respetivas linhas, em simultâneo.
Neste, o payload JSON deverá vir no seguinte formato
Não é necessário. Os pagamentos são sempre fechados.
O seguinte pedido pode ser realizado, após a criação do documento, e permite alterar informações sobre o documento. A estrutura do payload é a mesma do POST de criação. Neste, deverá enviar no id do pedido o id do documento a alterar. Os atributos enviados no body irão substituir os guardados no momento, e cada linha enviada dentro de lines irá substituir os dados guardados na linha com id especificado em payment_line_id
Caso pretenda adicionar novas linhas ao documento, após a sua criação, pode utilizar a seguinte rota, que utiliza o mesmo payload das lines do pedido POST de criação. Neste, o id a enviar no path é o do documento ao qual pretende adicionar a linha
Do mesmo modo, caso pretenda remover linhas de um documento, pode utilizar a seguinte rota, onde apenas tem de indicar o id da linha a remover, no path.
Por fim, se pretender obter informações sobre um dado documento, pode utilizar a seguinte rota, onde deverá especificar o id do documento a analisar no path.
/v1/commercial_purchases_payments/{id}
id of the payment line to delete
Texto descritivo do motivo de anulação
No body
/v1/commercial_purchases_payments/{id}
id of the payment to edit the information of
15-7-2022
MO|CH|DC|CC|TR|DDA|MB|OU|...
No body
/v1/commercial_purchases_payment_lines/{id}
id of the payment to add the line to
No body
/v1/commercial_purchases_payment_lines/{id}
id of the payment line to delete
No body
/v1/commercial_purchases_payments/{id}
id of the payment to get the information of
/v1/commercial_purchases_payments