Plantonizei

Plataforma › Cobrança e crédito

Emitir fatura

POST/api/v1/admin/billingPede sessão

Como funciona

Emite uma fatura para uma empresa cliente: empresa (tenantId), competência (competency, AAAA-MM), valor em centavos, vencimento (AAAA-MM-DD) e forma de pagamento (method).

Uma empresa tem uma fatura por competência: emitir de novo dá 409, e a mensagem manda cancelar ou editar a que existe. Fica na trilha de auditoria.

É da equipe interna e pede o módulo Faturamento no papel de quem chama.

Parâmetros

  • amountCentsCorpo · integerValor, em centavos.
  • competencyCorpo · stringCompetência (`AAAA-MM`).
  • dueDateCorpo · stringVencimento (`AAAA-MM-DD`).
  • methodCorpo · stringForma de pagamento.
  • tenantIdCorpo · stringIdentificador da empresa cliente.

Respostas

201 · id da fatura.

  • idstring · Identificador do registro.

Corpo de exemplo

{
  "id": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e"
}