Emit

Criar Recibo

Emite um novo recibo.

POST https://api.cloudinvoice.net/receipts/emit/

Os Recibos podem ser emitidos fornecendo uma lista de documentos a incluir ou por valor a liquidar. Ao emitir por valor a liquidar, os documentos a incluir no recibo serão selecionados automaticamente, do mais antigo para o mais recente, até prefazer o valor a liquidar fornecido.

Request Body

Name
Type
Description

customer_id

integer

Cliente

Consulte a tabela Clientes.

documents

array

Linhas do Recibo

Deverá conter uma lista de objectos, sendo que cada objecto poderá conter os parâmetros de um documento a incluir no Recibo conforme descritos no Apêndice.

total_amount

float

Valor a Liquidar

Seleção automática de documentos por valor a liquidar. ⚠️ Apenas surtirá efeito se o campo 'documents' não for fornecido.

payments

array

Pagamentos do Recibo

Deverá conter uma lista de objetos, sendo que cada objeto poderá conter os parâmetros de um pagamento conforme descritos no Apêndice.

finalize

boolean Default: false

Finalizar o Recibo após criação

Finalizar o recibo de imediato. Deverá também fornecer dados relativos ao(s) pagamento(s) no campo payments equivalentes ao valor do recibo na sua totalidade.

print

boolean

Imprimir Recibo após Emissão

⚠️ O Recibo deverá estar finalizado.

Consulte os parâmetros disponíveis para impressão no Apêndice.

email

boolean

Enviar por E-mail após Emissão

⚠️ O Recibo deverá estar finalizado.

Consulte os parâmetros disponíveis para impressão no Apêndice.

curl -X POST https://api.cloudinvoice.net/receipts/emit/
    -d '{
        "customer_id": 2,
        "documents": [
            {
                "id": 5078,
                "amount": 1
            }
        ],
        "payments": [
            {
                "payment_method_id": 1
            }
        ],
        "finalize": true
    }'

Para ver exemplos de pedidos nas várias linguagens, consulte a página Exemplos de Pedidos.

Last updated