Plataforma › Cobrança e crédito
Faturas das empresas
GET/api/v1/admin/billingPede sessãoComo funciona
As faturas emitidas para as empresas clientes: empresa e CNPJ, competência (AAAA-MM), valor, vencimento, forma de pagamento, situação, quando foi paga, quantos médicos foram cobrados (no plano por médico) e, se houve, a renegociação com o vencimento e o valor originais e o desconto.
Quando a aba Financeiro dos ajustes da plataforma está salva, defaults traz o padrão de fatura, para o formulário de emissão já abrir preenchido.
É da equipe interna e pede o módulo Faturamento no papel de quem chama.
Respostas
200 · invoices e, quando houver, defaults.
defaultsobject · Padrão de fatura definido nos ajustes, para o formulário abrir preenchido.invoicesobject[] · As faturas.invoices[].amountCentsinteger · Valor, em centavos.invoices[].doctorsBilledinteger · Médicos cobrados, quando a fatura saiu de um plano por médico.invoices[].dueDatestring · Vencimento (AAAA-MM-DD).invoices[].idstring · Identificador do registro.invoices[].methodstring · Forma de pagamento.invoices[].paidAtstring · Quando foi pago.invoices[].referencestring · Competência da fatura (AAAA-MM).invoices[].renegotiationobject · Renegociação, quando houve: vencimento e valor originais e o desconto.invoices[].renegotiation.discountPctnumber · Desconto, em porcentagem (0 a 99,99).invoices[].renegotiation.notestring · Observação.invoices[].renegotiation.originalAmountCentsinteger · Valor antes da renegociação, em centavos.invoices[].renegotiation.originalDueDatestring · Vencimento antes da renegociação.invoices[].renegotiation.renegotiatedAtstring · Quando a fatura foi renegociada.invoices[].statusstring · Situação.invoices[].tenantCnpjstring · CNPJ da empresa cliente.invoices[].tenantIdstring · Identificador da empresa cliente.invoices[].tenantNamestring · Empresa cliente.
Corpo de exemplo
{
"defaults": {},
"invoices": [
{
"amountCents": 150000,
"doctorsBilled": 1,
"dueDate": "texto",
"id": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
"method": "texto",
"paidAt": "texto",
"reference": "texto",
"renegotiation": {
"discountPct": null,
"note": null,
"originalAmountCents": null,
"originalDueDate": null,
"renegotiatedAt": null
},
"status": "texto",
"tenantCnpj": "texto",
"tenantId": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
"tenantName": "texto"
}
]
}