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

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.

Exemplo de Resposta

{
  "idPayable": 0,
  "description": "string",
  "recipient": "string",
  "costCenter": {
    "id": 0,
    "name": "string"
  },
  "inputDate": "2025-07-30T15:55:22.569Z",
  "dueDate": "2025-07-30T15:55:22.569Z",
  "paymentDate": "2025-07-30T15:55:22.569Z",
  "competenceDate": "2025-07-30T15:55:22.569Z",
  "cancellationDate": "2025-07-30T15:55:22.569Z",
  "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"
}