Pagamentos do Documento
Documentos de cobrança imediata, como Factura-Recibo ou Factura Simplificada, requerem que, para que possam ser finalizados com sucesso, existam pagamentos cujo somatório seja igual ao total do documento.
API - Pagamento do Documento:
Apresentamos alguns end-points que permitem lançar, editar e apagar pagamentos nos documentos.
- Listar Pagamentos de Documento
- Criar Pagamento de Documento
- Alterar Pagamento de Documento
- Apagar Pagamento de Documento
Importante:
Os exemplos dados são referentes a documentos de venda, mas poderá usar, de forma análoga, os end-points para outros tipos de documentos, substituindo no URL '/sale' por:
- /receipt - para recibos;
| Parâmetros | |
|---|---|
| payment_method |
Forma de Pagamento int
Relação com o campo 'id' da tabela 'Formas de Pagamento'. Preenchimento Obrigatório* |
| amount_received_currency |
Valor do Pagamento decimal
Preenchimento Obrigatório* |
| payment_doc_reference |
Referência do Pagamento string
O preenchimento deste campo é obrigatório em alguns métodos de pagamento. |
| payment_doc_date |
Data do Documento de Pagamento date
O preenchimento deste campo é obrigatório em alguns métodos de pagamento. |
Listar Pagamentos de Documento /sale/<document_id>/payments GET
Listar pagamentos de um documento.
$ curl https://www.cloudinvoice.net/v3/sale/1/payments/
[
{
"id": 1,
"payment_method_id": 1,
"payment_method": "Dinheiro",
"payment_method__code": 1,
"amount_received_currency": 50.0,
"payment_doc_reference": "",
"payment_doc_date": "",
},
{
"id": 2,
"payment_method_id": 4,
"payment_method": "Visa",
"payment_method__code": 4,
"amount_received_currency": 73.0,
"payment_doc_reference": "",
"payment_doc_date": "",
}
]
Criar Pagamento de Documento /sale/<document_id>/payment/add POST
Criar pagamento de um documento. A resposta contém também informação actualizada do documento.
curl -X POST https://www.cloudinvoice.net/v3/sale/1/payment/add/
-d '{
"payment_method": 1,
"amount_received_currency": 50.0
}'
{
"has_document": true,
"document": {
"id": 1,
"document_key": "FSI A01/-1",
"document_nature": 302,
"document_name": "Factura Simplificada",
"document_status": 1201,
"status_reason": "",
"document_date": "2020-06-20",
"document_time": "12:56:47.205",
"is_valued": true,
"is_tax_included": true,
"is_paid": false,
"line_details_count": 1,
"lines_total_quantity": 1.0,
"total_amount": 123.0,
"total_gross_amount_currency": 123.0,
"total_global_discount_currency": 0.0,
"total_line_discount_currency": 0.0,
"total_net_amount_currency": 100.0,
"total_taxes_amount_currency": 23.0,
"total_amount_currency": 123.0,
"total_document_amount_currency": 123.0,
"paid_total_amount_currency": 50.0,
"total_due_amount_currency": 73.0,
"can_finalize": true,
...
},
"payments": [
{
"id": 1,
"payment_method_id": 1,
"payment_method": "Dinheiro",
"payment_method__code": 1,
"amount_received_currency": 50.0,
"payment_doc_reference": "",
"payment_doc_date": ""
}
],
...
}
Alterar Linha de Documento /sale/<document_id>/payment/<id>/update GET
Alterar pagamento de um documento. A resposta contém também informação actualizada do documento.
curl -X POST https://www.cloudinvoice.net/v3/sale/1/payment/update/
-d '{
"amount_received_currency": 123.0
}'
{
"has_document": true,
"document": {
"id": 1,
"document_key": "FSI A01/-1",
"document_nature": 302,
"document_name": "Factura Simplificada",
"document_status": 1201,
"status_reason": "",
"document_date": "2020-06-20",
"document_time": "12:56:47.205",
"is_valued": true,
"is_tax_included": true,
"is_paid": false,
"line_details_count": 1,
"lines_total_quantity": 1.0,
"total_amount": 123.0,
"total_gross_amount_currency": 123.0,
"total_global_discount_currency": 0.0,
"total_line_discount_currency": 0.0,
"total_net_amount_currency": 100.0,
"total_taxes_amount_currency": 23.0,
"total_amount_currency": 123.0,
"total_document_amount_currency": 123.0,
"paid_total_amount_currency": 123.0,
"total_due_amount_currency": 0.0,
"can_finalize": true,
...
},
"payments": [
{
"id": 1,
"payment_method_id": 1,
"payment_method": "Dinheiro",
"payment_method__code": 1,
"amount_received_currency": 123.0,
"payment_doc_reference": "",
"payment_doc_date": ""
}
],
...
}
Apagar Pagamento de Documento /sale/<document_id>/payment/<id>/delete POST
Apagar pagamento de um documento. A resposta contém também informação actualizada do documento.
$ curl -X POST https://www.cloudinvoice.net/v3/sale/1/payment/2/delete/
{
"has_document": true,
"document": {
"id": 1,
"document_key": "FSI A01/-1",
"document_nature": 302,
"document_name": "Factura Simplificada",
"document_status": 1201,
"status_reason": "",
"document_date": "2020-06-20",
"document_time": "12:56:47.205",
"is_valued": true,
"is_tax_included": true,
"is_paid": false,
"line_details_count": 1,
"lines_total_quantity": 1.0,
"total_amount": 123.0,
"total_gross_amount_currency": 123.0,
"total_global_discount_currency": 0.0,
"total_line_discount_currency": 0.0,
"total_net_amount_currency": 100.0,
"total_taxes_amount_currency": 23.0,
"total_amount_currency": 123.0,
"total_document_amount_currency": 123.0,
"paid_total_amount_currency": 50.0,
"total_due_amount_currency": 73.0,
"can_finalize": true,
...
},
"payments": [
{
"id": 1,
"payment_method_id": 1,
"payment_method": "Dinheiro",
"payment_method__code": 1,
"amount_received_currency": 50.0,
"payment_doc_reference": "",
"payment_doc_date": ""
}
],
...
}