Saltar para a documentação
API

Obter a fatura de uma cobrança

A ligação para o PDF, em JSON.

GET/billing/invoices/{orderId}

Executa a chamada real no seu espaço de trabalho.

GET /billing/invoices/{orderId}

A ligação para o PDF, em JSON.

Exemplo

Requer billing:read. Uma fatura que ainda não foi emitida é emitida primeiro, com os dados de faturação da cobrança ou da conta, o que pode demorar alguns segundos.

curl
curl "$OE/billing/invoices/8c51f0d2-3b7e-4a19-b6c4-0e9d2f7a1c38" -H "$AUTH"
Resposta
{  "object": "invoice_link",  "orderId": "8c51f0d2-3b7e-4a19-b6c4-0e9d2f7a1c38",  "url": "https://files.example.com/invoices/acme-0007.pdf?signature=5f2c9a",  "fileName": "Invoice-ACME-0007.pdf"}

A ligação é assinada pelo prestador de pagamentos, descarrega o PDF e deixa de funcionar ao fim de algum tempo, por isso obtenha-a de novo em vez de a guardar.

Uma cobrança sem nome nem morada de faturação dá um 409 billing_details_required, uma cobrança em rascunho ou anulada dá um 409 invoice_unavailable, e uma fatura que ainda está a ser emitida dá um 504 invoice_not_ready.

Referência