Sign in

v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB
Pagamentos

Listar lotes de pagamento

Retorna lista paginada dos lotes de pagamento da empresa com filtros opcionais. Paginação por cursor: use o valor de _links.next.href para navegar entre páginas.

Nota: A listagem aplica filtro implícito por janela de tempo. Pagamentos fora da janela padrão podem não aparecer mesmo após liquidação. Use startDate e endDate para ampliar o período de busca.

get/{companyId}/banking/payroll/payments

Path parameters

companyIdstring required

Query parameters

companyTaxIdsstring[]

CNPJs das empresas (14 dígitos, sem formatação). Aceita múltiplos valores.

pageSizeinteger

Quantidade de itens por página (default 20, máximo 50)

cursorstring

Token opaco de cursor para paginação. Ausente na primeira requisição. Extrair de _links.next.href. Não construir manualmente.

startDatestring date-time

Data de início do filtro (YYYY-MM-DD)

endDatestring date-time

Data de fim do filtro (YYYY-MM-DD)

referencestring

Filtrar por referência/nome do lote

statusinteger[]

Filtrar por status do lote de pagamento

unitPaymentboolean

Filtrar por pagamento individual (true) ou lote (false)

recurrenceIdinteger

Filtrar por ID de recorrência

Response

OK