Plantonizei

Painel da empresa › Financeiro

Lançar conta

POST/api/v1/accountsPede sessão

Como funciona

Lança uma conta a pagar ou a receber.

  • kind: payable (a pagar) ou receivable (a receber).
  • description é obrigatória e amountCents precisa ser positivo, em centavos.
  • dueDate é o vencimento, em AAAA-MM-DD.
  • category, counterparty (fornecedor ou cliente) e method (forma de pagamento) organizam os relatórios e os gráficos.

A conta nasce em aberto; a baixa é feita por POST /accounts/{id}/payment. Fica na trilha de auditoria. Pede a permissão de criar e editar contas.

Parâmetros

  • amountCentsCorpo · integerValor, em centavos.
  • categoryCorpo · stringCategoria.
  • counterpartyCorpo · stringFornecedor ou cliente.
  • companyIdCorpo · stringEmpresa (centro de custo) da conta, das cadastradas do cliente (`GET /settings/registered-companies`). Vazio ou ausente = da empresa toda. Empresa de outro cliente é recusada (400). Na lista, a conta automática da escala traz a empresa da escala.
  • counterpartyDocCorpo · stringCPF ou CNPJ de quem recebe/paga. Entra com ou sem pontuação e é gravado só com dígitos; dígito verificador errado é recusado com 400. Vazio = não informado.
  • descriptionCorpo · stringDescrição.
  • dueDateCorpo · stringVencimento (`AAAA-MM-DD`).
  • kindCorpo · stringTipo.
  • methodCorpo · stringForma de pagamento.
  • repetitionCorpo · objectRepetição (ADR 0129). Ausente ou `unica`: uma conta. `parcelada`: `installments` (2 a 48) contas mensais "1/6"…; com `perInstallment` o valor é o de cada parcela, senão é o total (os centavos que sobram vão na 1ª). `fixa`: lança esta e a de cada mês até dezembro de dois anos à frente — ano atual e os dois seguintes (o job diário anda a janela) até encerrar (`POST /accounts/{id}/recurrence/stop`).
  • repetition.typeCorpo · string: unica | parcelada | fixa—
  • repetition.installmentsCorpo · integer—
  • repetition.perInstallmentCorpo · boolean—

Respostas

201 · id da conta.

  • idstring · Identificador do registro.

Corpo de exemplo

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