Central de ajudaIntegrações

Para: Administradores

Leia as faturas com uma chave de gerenciamento.

Liste as faturas emitidas pelo seu centro de distribuição e leia uma delas, com os respectivos valores, pagamentos e reembolsos, para fins de contabilidade ou relatórios.

Neste artigo4 seções

Antes de começar

Esta página aborda o processo de leitura de faturas. Os caminhos estão indicados em https://prd-api-manage.caseactive.com/v1/<hub id>. A função “Key” permite visualizar todas as faturas publicadas, incluindo aquelas que já foram concluídas, mas nunca as faturas em andamento. Não é possível criar, alterar, reembolsar ou pagar uma fatura com essa função.

Chamadas

ChamarO que faz
GET /invoicesListas com as faturas publicadas, com as mais recentes em primeiro lugar.
GET /invoices/<case_id>/<invoice_id>Lê uma fatura.
ParâmetroO que fazObrigatórioPadrão
statusApenas as faturas com esse status: open, paid, void, uncollectible ou processing.NãoTudo
case_idApenas as faturas de um único caso.NãoCada caso é diferente.
limitQuantas faturas uma página pode conter, até 1000.Não20
start_keyO startKey da página anteriorNãoPrimeira página

Enquanto ainda houver faturas pendentes, ligue para nextLink, ou envie startKey como start_key. Esta lista não possui filtros baseados em data, nem indica quando uma fatura foi alterada pela última vez. Para saber o que mudou desde sua última sincronização, incluindo pagamentos e reembolsos, procure na tabela case_invoices utilizando filter_by=updated_on:>, seguido pelo horário da sua última sincronização, em segundos Unix. Uma alteração é registrada alguns segundos após ser salva. Portanto, inicie cada janela um pouco antes do fim da anterior. Adicione filter_by=refund_status:=succeeded para encontrar reembolsos. Veja Busca de casos e usuários com a opção de gerenciamento.

Uma fatura

Cada valor é representado por um número inteiro em centavos, em dólares americanos: 96300 equivale a $963,00.

{
  "data": {
    "case_id": "cc-1a2b3c4d5e6f70",
    "invoice_id": "invoice::20260915143000_ab12cd34ef5678",
    "host_id": "ca-7e6d5c4b3a2f10",
    "name": "September legal services",
    "description": "Consultation and filing for Jane Sample's claim",
    "invoice_number": "INV-1042",
    "po_number": "PO-778",
    "terms": "Net 15",
    "host_ref_id": "acct-1042",
    "notes": "Thank you for your business.",
    "participants_ids": ["cu-4f1c2a9e8b7d60"],
    "user_id": "cu-9d8c7b6a5f4e30",
    "status": "paid",
    "due_date": "2026-09-30T17:00:00+00:00",
    "transactions": {
      "transactions": [
        {"transaction_type": "charge", "description": "Consultation (hours)", "value": 35000, "quantity": 2, "currency": "usd"},
        {"transaction_type": "charge", "description": "Court filing fee", "value": 30000, "quantity": 1, "currency": "usd"}
      ],
      "discount": 0.1,
      "tax": 0.07
    },
    "subtotal": 100000,
    "discount": 0.1,
    "discount_amount": 10000,
    "discounted_amount": 90000,
    "tax": 0.07,
    "tax_amount": 6300,
    "total": 96300,
    "payment_gateway": "stripe",
    "stripe_payment": {"user_id": "cu-4f1c2a9e8b7d60", "fees": 2863, "stripe_fee": 2823, "application_fee": 40, "net": 93437},
    "payment_attempts": [{"datetime": "2026-09-20T14:05:12+00:00", "success": true, "user_id": "cu-4f1c2a9e8b7d60"}],
    "completed_on": "2026-09-20T14:05:20+00:00",
    "published": 1,
    "created_on": "2026-09-15T14:30:00+00:00",
    "updated_on": "2026-09-20T14:05:20+00:00"
  }
}
CampoO que contém
invoice_id, case_idA fatura, e o recipiente em que ela está guardada. Leia uma fatura com ambos os documentos.
name, descriptionSeu título e descrição
invoice_number, po_number, terms, notes, host_ref_idDigitado na fatura. host_ref_id é o seu ID de referência.
participants_idsAs pessoas a quem o produto é destinado…
user_idQuem o criou?
statusopen: em espera para ser pago. paid: pago online ou marcado como pago. void: cancelado. uncollectible e processing: definidos pelo seu pessoal. paid e void são os resultados finais.
due_dateQuando chega a hora…
transactionsSuas linhas são: cada uma delas é um charge ou um credit. Além disso, há um description, um value em centavos, e um quantity. E também existem as taxas aplicadas.
subtotalDeduções menos créditos; nunca abaixo de 0.
discount, discount_amount, discounted_amountA taxa de desconto, expressa como fração (0.1), é de 10%. O valor do desconto, em centavos, também é indicado. Por fim, apresenta-se o valor total após o desconto.
tax, tax_amountA taxa de imposto, expressa como fração (0.07), é de 7%. O valor do imposto, em centavos, é calculado sobre o montante após o desconto.
totalO que é devido, em centavos
payment_gatewaystripe quando o pagamento é feito online; manual quando os funcionários marcam que o pagamento foi realizado.
stripe_paymentPara pagamento online: quem pagou, quais foram as taxas e o valor líquido, em centavos.
payment_attemptsTodos tentam pagar online: quando isso funcionou, e por que não funcionou.
refundedO reembolso, se houver: seu valor é indicado por status (pending, succeeded, failed ou canceled), amount em centavos e reason. O status da própria fatura permanece como paid.
completed_onQuando o pagamento foi realizado ou o documento foi anulado.

Se uma chamada for recusada

StatusmessagePor que
404InvoiceDoesNotExistExceptionNão existe nenhuma fatura com esse número de identificação na sua central de atendimento.
400InvoiceNotPublishedExceptionA fatura é um documento em forma de cheque.
400SchemaFieldsExceptionstatus não é um dos cinco.
400InvalidStartKeyExceptionstart_key não fazia parte dessa lista.

Para informações sobre o corpo do erro e os demais códigos de erro, consulte Como lidar com erros da API e códigos de status.

Artigos relacionados

Lidar com erros e códigos de status da APILeia o corpo da mensagem de erro, o que significam os códigos 400, 401, 403, 404, 500 e 503 e por que um item que sua chave não consegue ver responde ao erro 404.Integrações