Lançamentos de caixa
Entradas e saídas do caixa no período, como pagamentos à vista de vendas, adiantamentos de O.S. e pagamentos de parcelas. Lançamentos estornados não são incluídos.
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.
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. A paginação é ativada ao informar page e/ou perPage; sem esses parâmetros, a resposta traz a lista completa. Quando apenas page é informado, são retornados 10 itens por página. O nome deve ser escrito exatamente como perPage; outras grafias, como per_page, são desconsideradas sem aviso.
Se presente, a resposta é retornada como JSONP.
Response Body
application/json
application/json
text/html
curl -X GET "https://example.com/integracoes/financeiro/lancamentos-caixa/periodo?inicio_periodo=2026-06-01&fim_periodo=2026-06-30"{ "currentPage": 1, "totalPages": 1, "totalItems": 1, "perPage": 100, "data": [ { "id": 171, "data": "2022-04-07 16:32", "registrado_em": "2022-04-07 13:32", "registrado_por": "João Vendedor", "valor": 966.15, "parcelas": 1, "tipo": "CREDITO", "descricao": "Recebimento de adiantamento de O.S. 12.", "numero_documento": "ordem de serviço 12", "forma_recebimento": { "id": 81699, "nome": "Dinheiro", "tipo": "Dinheiro" }, "categoria": { "id": 822836, "descricao": "Adiantamento Ordem Serviço", "tipo": "CREDITO", "conta_pai": { "id": 822834, "descricao": "Receitas de Vendas", "tipo": "CREDITO" } }, "lancamentos_conta": [ { "id": 171, "data": "2022-04-07", "tipo": "CREDITO", "valor": 966.15, "descricao": "Recebimento de adiantamento de O.S. 12.", "conta": { "id": 43070, "descricao": "Loja" } } ], "cliente": { "id": 2799763, "nome": "Ana Souza", "apelido": "", "nascimento": "1977-11-08", "cpf_cnpj": "123.456.789-09", "rg_ie": "1234567", "nome_pai": "José da Silva", "nome_mae": "Maria Aparecida da Silva", "profissao": "Professora", "observacao": "", "ativo": true, "contribuinte_icms": false, "tipo": "PF", "cadastrado_em": "2016-01-25 08:52:37", "sexo": "M", "renda_familiar": "0.00", "convenio": "", "endereco": { "logradouro": "Rua das Flores", "numero": "100", "complemento": "", "bairro": "Centro", "cep": "01001-000", "cidade": "Uberlândia", "uf": "MG", "pais": "Brasil" }, "telefones": [ { "numero": "(11) 9999-9000", "identificacao": "" }, { "numero": "(11) 9.9999-0000", "identificacao": "Celular" }, { "numero": "(11) 9999-9000", "identificacao": "Numero Internacional" } ], "emails": [] }, "ordem_servico": { "id": 28, "numero": 12, "status": "ABERTO", "valor": 966.15, "data_abertura": "2022-04-07", "data_entrega": "", "adiantamento_pago": 966.15 } } ]}{ "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."Extrato financeiro (lançamentos de conta) GET
Movimentações das contas no período, filtradas pela data de crédito, incluindo cada parcela do cartão de crédito na data prevista pela operadora.
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.