Contas a receber

CNPJ (ou CPF) da loja, com ou sem máscara. Informe cnpj ou empresa.

Código da Licença da loja (chave de contrato). Informe cnpj ou empresa.

Data inicial, no formato AAAA-MM-DD. O intervalo até fim_periodo pode ter no máximo 180 dias (ex.: 2025-07-01 a 2025-12-28 é aceito; 2025-07-01 a 2025-12-31, com 183 dias, é recusado).

Data final, no formato AAAA-MM-DD. O dia informado é considerado por completo. Deve estar a no máximo 180 dias de inicio_periodo.

Data da parcela utilizada no filtro: vencimento (padrão), vencimento da parcela; pagamento, data do pagamento; lancamento, data em que o título foi registrado; cancelamento, data do cancelamento; renegociacao, data da renegociação. Outros valores retornam erro 400. Para comparação com a consulta de vendas, utilize lancamento nesta consulta e dataLancamento nas vendas.

ID da parcela. Quando informado, retorna somente essa parcela, e o período, o tipo_periodo e o numero_documento deixam de ser aplicados como filtro. Ainda assim, inicio_periodo e fim_periodo permanecem obrigatórios e são validados (na ausência deles, retorna PERIODO_OBRIGATORIO).

Número do documento do título (ex.: número do carnê ou do boleto). Desconsiderado quando id é informado.

Número da página, a partir de 1 (padrão 1). As páginas devem ser consultadas até o valor de totalPages informado na resposta.

Itens por página, de 1 a 100 (padrão 10; recomenda-se perPage=100). O nome deve ser escrito exatamente como perPage; outras grafias, como per_page, são desconsideradas sem aviso.