ReferênciaFinanceiro

Contas a receber

Parcelas a receber no período (sempre paginado). O campo de data filtrado é definido por `tipo_periodo`. É possível buscar uma parcela específica por `id`.

GET
/integracoes/financeiro/contas-a-receber/periodo

Authorization

userToken
AuthorizationBearer <token>

Token de usuário do ssOtica, obtido na tela de perfil do sistema. Enviado como Authorization: Bearer {token}.

In: header

Query Parameters

cnpj?string

CNPJ/CPF da empresa (com ou sem máscara). Informe cnpj e/ou empresa.

empresa?string

Chave de contrato da empresa. Informe cnpj e/ou empresa.

inicio_periodo*string

Início do período (YYYY-MM-DD).

fim_periodo*string

Fim do período (YYYY-MM-DD).

tipo_periodo?string
id?integer

ID do parcelamento (ignora os filtros de período quando informado).

numero_documento?string
page?integer

Página.

perPage?integer

Itens por página, 1–100 (nos endpoints de período, ativa a paginação).

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/integracoes/financeiro/contas-a-receber/periodo?inicio_periodo=2026-06-01&fim_periodo=2026-06-30"
{  "currentPage": 1,  "totalPages": 5,  "totalItems": 48,  "perPage": 10,  "data": [    {}  ]}

{  "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)."}

{  "error": "Unauthenticated."}

Lançamentos de caixa GET

Lançamentos de caixa do período, filtrados pela **data de lançamento do caixa**. Paginação opt-in (`page`/`perPage`). Intervalo máximo de 180 dias.

Contas a pagar GET

Parcelas a pagar no período (sempre paginado), excluindo rateios. O campo de data filtrado é definido por `tipo_periodo`. É possível buscar uma parcela específica por `id`. Cada parcela inclui `ocorrencias` (linha do tempo `INCLUSAO`/`EDICAO`/`EXCLUSAO`) e `ocorrencias_caixa` (detalhe dos lançamentos de caixa excluídos).