Skip to main content
GET
Listar contas a pagar

Query Parameters

nomeCliente
string

Pesquisa por nome do cliente de contas a pagar

situacao
enum<string>

Pesquisa por situação de contas a pagar

  • aberto - Aberto
  • cancelada - Cancelada
  • pago - Pago
  • parcial - Parcial
  • prevista - Prevista
  • atrasadas - Atrasadas
  • emissao - Emissao
Available options:
aberto,
cancelada,
pago,
parcial,
prevista,
atrasadas,
emissao
dataInicialEmissao
string

Pesquisa por data inicial da emissão de contas a pagar

Example:

"2024-01-01"

dataFinalEmissao
string

Pesquisa por data final da emissão de contas a pagar

Example:

"2024-01-01"

dataInicialVencimento
string

Pesquisa por data inicial do vencimento de contas a pagar

Example:

"2024-01-01"

dataFinalVencimento
string

Pesquisa por data final do vencimento de contas a pagar

Example:

"2024-01-01"

numeroDocumento
string

Pesquisa por número do documento de contas a pagar

marcadores
string[]

Pesquisa por marcadores

idContato
integer

Pesquisa por ID do contato de contas a pagar

orderBy
enum<string>

Define a ordenação da listagem por ordem crescente ou decrescente

  • asc - Crescente
  • desc - Descrescente
Available options:
asc,
desc
limit
integer
default:100

Limite da paginação

offset
integer
default:0

Offset da paginação

Response

OK

id
integer | null
situacao
enum<string> | null
  • aberto - Aberto
  • cancelada - Cancelada
  • pago - Pago
  • parcial - Parcial
  • prevista - Prevista
  • atrasadas - Atrasadas
  • emissao - Emissao
Available options:
aberto,
cancelada,
pago,
parcial,
prevista,
atrasadas,
emissao
data
string | null
dataVencimento
string | null
historico
string | null
valor
number<float> | null
saldo
number<float> | null
numeroDocumento
string | null
serieDocumento
string | null
cliente
· object
marcadores
any