Painel da empresa › Financeiro
Contas a pagar e a receber
GET/api/v1/accountsPede sessãoComo funciona
As contas a pagar e a receber da empresa, paginadas: tipo, descrição, categoria, contraparte, valor, vencimento, forma de pagamento, situação e a data em que foi paga.
Pagine com page e pageSize. Pede a permissão de ver contas.
Parâmetros
pageQuery · integerPágina, a partir de 1. Padrão: 1.pageSizeQuery · integerItens por página. Padrão: 50; máximo: 100.
Respostas
200 · accounts da página e pagination com o total.
accountsobject[] · As contas.accounts[].amountCentsinteger · Valor, em centavos.accounts[].categorystring · Categoria.accounts[].counterpartystring · Fornecedor ou cliente.accounts[].companyIdstring · Empresa (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.accounts[].counterpartyDocstring · CPF 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.accounts[].descriptionstring · Descrição.accounts[].dueDatestring · Vencimento (AAAA-MM-DD).accounts[].idstring · Identificador do registro.accounts[].kindstring · Tipo.accounts[].methodstring · Forma de pagamento.accounts[].paidAtstring · Quando foi pago.accounts[].statusstring · Situação:pending,partial(folha/taxas da escala com parte paga),paidouoverdue(pendente ou parcial com vencimento passado).accounts[].originstring · De onde veio (ADR 0129):manual,folha(líquido da escala, nasce no 1º pagamento da folha),taxa_antecipacao(taxas da escala) oufaturamento(total do contrato dos plantões da escala). As automáticas não se editam nem se apagam; o faturamento aceita a baixa.accounts[].paidAmountCentsinteger · Quanto já foi pago/recebido, em centavos (parcial nas contas da folha e das taxas).accounts[].competencystring · Competência (AAAA-MM) das contas automáticas e da conta fixa.accounts[].installmentinteger · Número da parcela (conta parcelada).accounts[].installmentsinteger · Total de parcelas (conta parcelada).accounts[].recurringboolean · Conta lançada por uma conta fixa (todo mês).paginationobject · Paginação: página, tamanho e total.pagination.pageinteger · Página.pagination.pageSizeinteger · Itens por página.pagination.totalinteger · Total.
Corpo de exemplo
{
"accounts": [
{
"amountCents": 150000,
"category": "texto",
"counterparty": "texto",
"companyId": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
"counterpartyDoc": "texto",
"description": "texto",
"dueDate": "texto",
"id": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
"kind": "texto",
"method": "texto",
"paidAt": "texto",
"status": "texto",
"origin": "texto",
"paidAmountCents": 150000,
"competency": "texto",
"installment": 1,
"installments": 1,
"recurring": true
}
],
"pagination": {
"page": 1,
"pageSize": 1,
"total": 1
}
}