Obter Contas a Pagar

Descrição

Recupera uma lista de contas a pagar registradas no sistema. O endpoint permite aplicar diversos filtros para refinar os resultados com base em datas, valores, status e dados bancários.

🔑 Parâmetros de Consulta (Query Params)

Este endpoint suporta filtros opcionais através de parâmetros de consulta (query parameters) para refinar os resultados.

Parâmetro	Tipo	Obrigatório	Descrição
description	string	Não	Filtra pela descrição da conta.
dateInputStart	date-time	Não	Filtra contas com data de lançamento a partir de uma data (YYYY-MM-DD).
dateInputEnd	date-time	Não	Filtra contas com data de lançamento até uma data (YYYY-MM-DD).
dueDateStart	date-time	Não	Filtra contas com data de vencimento a partir de uma data (YYYY-MM-DD).
dueDateEnd	date-time	Não	Filtra contas com data de vencimento até uma data (YYYY-MM-DD).
datePaymentStart	date-time	Não	Filtra contas com data de pagamento a partir de uma data (YYYY-MM-DD).
datePaymentEnd	date-time	Não	Filtra contas com data de pagamento até uma data (YYYY-MM-DD).
compentenceStart	date-time	Não	Filtra contas com data de competência a partir de uma data (YYYY-MM-DD).
competenceEnd	date-time	Não	Filtra contas com data de competência até uma data (YYYY-MM-DD).
bankAccount	string	Não	Filtra pelas contas bancárias associadas. Pode usar múltiplos IDs separados por vírgula, ex: 2,215.
ammountStart	number	Não	Filtra contas com valor mínimo a pagar.
ammountEnd	number	Não	Filtra contas com valor máximo a pagar.
accountStatus	string	Não	Filtra pelo status da conta. Utilize IDs separados por vírgula: 1 - Aberta, 2 - Paga, 3 - Cancelada.
take	int32	Não	Número total de registros a serem retornados. Valor padrão: 50. Máximo permitido: 50.
skip	int32	Não	Número total de registros a serem ignorados (para paginação). Valor padrão: 0.

📤 Estrutura da Resposta

A resposta retorna uma lista de contas a pagar cadastradas, contendo informações financeiras, datas de controle, centro de custo, status, destino, conta bancária e dados complementares.

Campo	Tipo	Descrição
`idPayable`	int32	Identificador único da conta a pagar.
`description`	string	Descrição da conta a pagar.
`recipient`	string	Destinatário do pagamento.
`costCenter`	object	Centro de custo associado à conta a pagar. Veja mais abaixo.
`inputDate`	date-time	Data de lançamento da conta a pagar.
`dueDate`	date-time	Data de vencimento da conta a pagar.
`paymentDate`	date-time	Data em que o pagamento foi realizado.
`competenceDate`	date-time	Data de competência contábil da conta.
`cancellationDate`	date-time	Data de cancelamento da conta a pagar, se aplicável.
`ammount`	number	Valor total da conta a pagar.
`ammountPaid`	number	Valor efetivamente pago.
`status`	object	Status atual da conta a pagar. Veja mais abaixo.
`destination`	object	Destino financeiro do pagamento. Veja mais abaixo.
`bankAccount`	object	Conta bancária utilizada para o pagamento. Veja mais abaixo.
`beneficiary`	string	Beneficiário do pagamento.
`categories`	string	Categoria(s) associada(s) à conta a pagar.
`observation`	string	Observações adicionais sobre a conta a pagar.

🧩 Estrutura do Objeto `costCenter`

Campo	Tipo	Descrição
`id`	int32	Identificador do centro de custo.
`name`	string	Nome do centro de custo.

🧩 Estrutura do Objeto status

Campo	Tipo	Descrição
`id`	int32	Identificador do status da conta a pagar.
`name`	string	Nome ou descrição do status.

🧩 Estrutura do Objeto destination

Campo	Tipo	Descrição
`id`	int32	Identificador do destino financeiro.
`name`	string	Nome do destino financeiro.

🧩 Estrutura do Objeto bankAccount

Campo	Tipo	Descrição
`id`	int32	Identificador da conta bancária.
`name`	string	Nome ou descrição da conta bancária.

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

Authorization: Basic *****************

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200OK

application/json

Success

Body

Exemplo

{
    "idPayable": 0,
    "description": "string",
    "recipient": "string",
    "costCenter": {
        "id": 0,
        "name": "string"
    },
    "inputDate": "2019-08-24T14:15:22.123Z",
    "dueDate": "2019-08-24T14:15:22.123Z",
    "paymentDate": "2019-08-24T14:15:22.123Z",
    "competenceDate": "2019-08-24T14:15:22.123Z",
    "cancellationDate": "2019-08-24T14:15:22.123Z",
    "ammount": 0,
    "ammountPaid": 0,
    "status": {
        "id": 0,
        "name": "string"
    },
    "destination": {
        "id": 0,
        "name": "string"
    },
    "bankAccount": {
        "id": 0,
        "name": "string"
    },
    "beneficiary": "string",
    "categories": "string",
    "observation": "string"
}

🟠400Bad Request

Get payables

Obter Contas a Pagar#

Descrição#

🔑 Parâmetros de Consulta (Query Params)#

📤 Estrutura da Resposta#

🧩 Estrutura do Objeto costCenter#

🧩 Estrutura do Objeto status#

🧩 Estrutura do Objeto destination#

🧩 Estrutura do Objeto bankAccount#

Requisição