Contas a pagar
Parcelas a pagar no período, sem rateios, com o histórico de inclusão, edição e exclusão de cada parcela.
Authorization
userToken Chave de acesso que aparece no cadastro do usuário, no ssOtica. Envie como
Authorization: Bearer {chave}.
In: header
Query Parameters
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; emissao, data de emissão do título; cancelamento, data do cancelamento. Outros valores retornam erro 400.
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.
Response Body
application/json
application/json
text/html
curl -X GET "https://example.com/integracoes/financeiro/contas-a-pagar/periodo?inicio_periodo=2026-06-01&fim_periodo=2026-06-30"{ "currentPage": 1, "totalPages": 1, "totalItems": 1, "perPage": 100, "data": [ { "id": 435, "numero_parcela": 1, "vencimento": "2024-03-05", "situacao": "Em atraso", "arquivos": [], "baixado_por": null, "baixado_em": null, "cancelado_por": null, "cancelado_em": null, "motivo_cancelamento": null, "valor_original": 1000, "juros": 0, "desconto": 0, "valor_pago": 0, "observacao": null, "titulo": { "id": 26, "documento": "", "lancamento": "2024-03-05", "criado_por": "João Vendedor", "data_emissao": "2024-02-29", "valor": 1000, "mes_competencia": "03/2024", "qtd_parcelas": 1, "plano_conta": "Deducoes e Abatimentos", "tipo_documento": "Cheque", "descricao": "Teste de Alteração na Baixa", "quitado": "Não", "fornecedor": { "id": 63763, "nome_fantasia": "Distribuidora Exemplo", "razao_social": "Distribuidora Exemplo LTDA", "documento": null, "laboratorio": "Não", "email": null, "inscricao_estadual": null, "inscricao_municipal": null, "suframa": " ", "contribuinte_icms": "Não" } }, "ocorrencias_caixa": [], "ocorrencias": [ { "tipo": "INCLUSAO", "usuario": "Ana Caixa", "data": "2024-03-05", "hora": "12:09:24" }, { "tipo": "EDICAO", "usuario": "Maria Operadora", "data": "2024-03-05", "hora": "12:09:24" } ] } ]}{ "error": "DATA_INVALIDA", "error_info": "O campo \"inicio_periodo\" contém uma data inválida. Utilize o formato AAAA-MM-DD (ex.: 2026-06-30)."}"Unauthorized."Contas a receber GET
Parcelas do crediário da loja (boleto, carnê) no período. Pagamentos em dinheiro, PIX ou cartão não geram parcelas e constam nos lançamentos de caixa e no extrato.
Ordens de serviço por período GET
Ordens de serviço abertas no período, com itens, receita, cliente e valores. Sem o parâmetro status, retorna somente as O.S. ativas.