Olá Cliente!

Para entender melhor o funcionamento da API Consultiva do ssOtica, acesse o material "Entendendo a API Consultiva", disponível na Central de Ajuda.

➡️ Temos disponíveis 06 processos de configuração de API:

1- API de consulta de vendas ativas do ssOtica;
2- API de consulta de Ordens de Serviço do ssOtica;
3- API de Consulta de Lançamentos Financeiros.
4- API para consulta de produtos, estoque, produtos reservados em O.S., preço, grupo, grife e fornecedores;
5- API para consulta de Contas a Pagar
6- API para consulta de Contas a Receber

Para todas* elas, deverá ser seguido o parâmetro e segurança definidos abaixo:
* Exceto na API de Consultas de Produtos - Estoque - Preço, contas a pagar e a receber, para essas API’s, siga os parâmetros detalhados nos itens destinados a elas

Parâmetros: 

• 1 - empresa: informe a chave de identificação da empresa (CNPJ sem pontuação), conforme encaminhado via e-mail após a contratação;
• 2 - inicio_periodo: data de início no formato YYYY-MM-DD;
• 3 - fim_periodo: data final do período no formato YYYY-MM-DD

◾ Além de ser enviada por e-mail, a Chave de Identificação (solicitada nos parâmetros) pode ser localizada no painel de informações do sistema ssOtica, sob o nome "Código da Licença.": 

 O intervalo máximo permitido entre as consultas é de 30 dias.
  

Exemplo: 

⚠️ Caso encontre algum problema na consulta, verifique se os parâmetros na URL (Endpoint) estão configurados corretamente.

 
➡️ Segurança:

• A autenticação de acesso para uso da API é feito via Bearer Token no cabeçalho da requisição GET.

Header
Ex. Authorization: Bearer XXXyyyXXXyXXXXXXXXXXyXXXyXXXyXXX

Já o passo a passo específico de cada API, deverá ser configurado de acordo com sua necessidade.

Qualquer dúvida, acesse o material: Passo-a-passo para acessar a API do ssOtica.  

1- API de consulta de vendas do ssOtica.

Endpoint - Método GET 
https://app.ssotica.com.br/api/v1/integracoes/vendas/periodo?cnpj=07585769000168&inicio_periodo=2021-02-01&fim_periodo=2021-02-28

Formato do Retorno:
Serão retornadas as vendas em formato JSON com as seguintes informações sobre as vendas ativas no período:

• id 
• data
• hora
• status
• numero
• valor_bruto
• acrescimo
• desconto
• valor_liquido
• itens (lista com os itens da venda)
  • id do item
  • produto
    • id do produto
    • referencia
    • descricao
    • grupo
    • id do grupo
    • grife
    • id da grife
    • unidade
    • codigo_gtin
  • quantidade
  • custo
  • valor_unitario_bruto
  • desconto
  • acrescimo
  • valor_unitario_liquido
  • valor_total_liquido
• formas_pagamento (lista com as formas de pagamento da venda)
  • id
  • data
  • valor
  • quantidade de parcelas
  • forma_pagamento (nome da forma de pagamento cadastrada no ssOtica)
  • código autorização
• cliente (cliente vinculado a venda)
  • id
  • nome
  • apelido
  • nascimento
  • cpf_cnpj
  • rg_ie
  • nome_pai
  • nome_mae
  • profissao
  • observacao
  • ativo (true, false)
  • contribuinte_icms (true, false)
  • suframa
  • ie
  • im
  • tipo (PF, PJ)
  • cadastrado_em
  • sexo
  • renda_familiar
  • codigo
  • convenio
  • escolaridade
  • referencia
  • endereço
    • logradouro
    • numero
    • complemento
    • bairro
    • cep
    • cidade
    • pais
  • telefones:
    • numero
    • identificacao
  • emails
    • endereco
    • identificacao
  • origem
• funcionario (funcionário que realizou a venda)
  • id
  • nome
  • cpf
  • rg
  • telefone_fixo
  • telefone_movel
  • endereço
    • logradouro
    • bairro
    • cep
    • cidade
    • uf
  • funcao
  • observacao
• origens_cliente: lista com origens de cliente vinculadas a venda

[

{

"id": 22844285,

"data": "2023-01-12",

"hora": "10:02:25",

"status": "ATIVA",

"numero": 5728,

"valor_bruto": 595,

"acrescimo": 0,

"desconto": 17.05,

"credito_troca": 577.95,

"valor_liquido": 0,

"itens": [

{

"id": 43278661,

"produto": {

"id": 458095,

"referencia": "V/S CR-39 ESF. 2,25 A 4,00 C/ CIL ATÉ 5,00",

"descricao": "Lente Oftalmica",

"grupo": "Lentes Oftálmicas",

"grupo_id": 19206,

"grife": "** Não Especificado **",

"grife_id": 277112,

"unidade": "PR",

"código_gtin": null

},

"quantidade": 1,

"custo": 0,

"valor_unitario_bruto": 595,

"desconto": 17.05,

"acrescimo": 0,

"valor_unitario_liquido": 577.95,

"valor_total_liquido": 577.95

}

],

"formas_pagamento": [],

"cliente": {

"id": 16813359,

"nome": "Joao da Silva",

"apelido": "Jo",

"nascimento": "1956-05-01",

"cpf_cnpj": "000.000.000-00",

"rg_ie": "00000000",

"nome_pai": "Jose da Silva",

"nome_mae": "Francisca da Silva",

"profissao": "Agricultor",

"observacao": "",

"ativo": true,

"contribuinte_icms": false,

"suframa": null,

"ie": null,

"im": null,

"tipo": "PF",

"cadastrado_em": "2022-05-31 11:44:56",

"sexo": "M",

"renda_familiar": "0.00",

"codigo": null,

"convenio": "",

"escolaridade": "MEDIO_INCOMPLETO",

"referencia": null,

"endereco": {

"logradouro": "Av das flores",

"numero": "S/N",

"complemento": "",

"bairro": "",

"cep": "00.000-000",

"cidade": "Cruz",

"uf": "CE",

"pais": "Brasil"

},

"telefones": [

{

"numero": "(00) 9.00000-0000",

"identificacao": ""

}

],

"emails": [

{

"email": "exemplo@hotmail.com",

"identificacao": ""

}

],

"origem": ""

},

"funcionario": {

"id": 105287,

"nome": "Maria Aparecida",

"cpf": "000.000.000-00",

"rg": "0000000000",

"telefone_fixo": "",

"telefone_movel": "(88) 9.0000-0000",

"endereco": {

"logradouro": "Flores",

"bairro": "Zona Rural",

"cep": "00.000-000",

"cidade": "Cruz",

"uf": "CE"

},

"funcao": "Vendedor",

"observacao": "dATA DE NASCIMENTO: 08/11/2004\r\nPis: 000.000.000.00\r\nNaturalidade: Cruz\r\nEstado Civil: Solteiro\r\nRaça ou Cor: Parda\r\nCTPS Número:00000000000 CTPS Série: 00000\r\nPIS/PASEP: 2

000.000.000.00\r\n\r\n"

},

"origensCliente": []

}

]

⚠️ Está API retorna apenas vendas ativas, não incluindo vendas canceladas ou excluídas.

2- API para consulta de ordens de serviço

Endpoint - Método GET:

https://app.ssotica.com.br/api/v1/integracoes/ordens-servico/periodo?cnpj=XXX&inicio_periodo=2023-01-12&fim_periodo=2023-01-12

Dados retornados:

• Dados das ordens de serviço.
• Dados da receita (chave "receita"  no json)
• Funcionário (chave "funcionário" no json)
• Produtos (chave "itens" no json)
• Adiantamentos (chave "forma_pagamento" no json)
• Cliente (chave "cliente" no json)
• Origens do cliente (chave "origensCliente" no json)

👉 Exemplo de JSON retornado:
 

[

 {

"id": 999,

"numero": 9999,

"codigo_os_externo": null,

"tipo_os": "Ótica",

"etapa_atual": "Serviço Pronto - Cliente Avisado",

"status": "ABERTO",

"data": "2023-01-12",

"previsao_entrega": "2023-01-19",

"data_entrega": "",

"valor_bruto": "1429.90",

"acrescimo": 0,

"desconto": "29.90",

"valor_liquido": 1400,

"tipo_armacao": "Metal",

"material_lente": "Resina",

"aro": "54",

"ponte": "17",

"maior_diagonal": "54",

"altura_vertical": "42",

"descricao_material_lente": null,

"descricao_lente": "xxxxxxxxxxxxxxx",

"descricao_coloracao": "",

"tipo_lente": "SURFAÇADA",

"distancia_pupilar": "0.00",

"altura_centro_otico": {

"altura_od_longe": "",

"altura_od_perto": "",

"altura_oe_longe": "",

"altura_oe_perto": ""

},

"possui_receita": 1,

"possui_armacao": 0,

"segue_armacao": 1,

"local_montagem": "LABORATORIO",

"gaveta_caixa": "",

"receita": {

"id": 9999999,

"esferico_oe_longe": -1.5,

"esferico_oe_perto": 2,

"cilindrico_oe_longe": -3,

"cilindrico_oe_perto": -3,

"prisma_oe_longe": null,

"prisma_oe_perto": null,

"base_oe_longe": null,

"base_oe_perto": null,

"eixo_oe_longe": 90,

"eixo_oe_perto": 90,

"altura_oe_longe": 25,

"altura_oe_perto": null,

"dnp_oe_longe": 27.5,

"dnp_oe_perto": null,

"distancia_pupila_oe": null,

"percentual_visao_oe": null,

"desconto_oe": null,

"ceratometria_oe_longe": null,

"esferico_od_longe": -2.25,

"esferico_od_perto": 1.25,

"cilindrico_od_longe": -1,

"cilindrico_od_perto": -1,

"prisma_od_longe": null,

"prisma_od_perto": null,

"base_od_longe": null,

"base_od_perto": null,

"eixo_od_longe": 15,

"eixo_od_perto": 15,

"altura_od_longe": 25,

"altura_od_perto": null,

"dnp_od_longe": 26.5,

"dnp_od_perto": null,

"distancia_pupila_od": null,

"percentual_visao_od": null,

"desconto_od": null,

"ceratometria_od_longe": null,

"adicao": 3.5,

"validade": "2024-01-12 00:00:00",

"observacao": "Multi em dobro 2° aro clip on alt. 29 54.16. 54 44\r\n",

"curva_base": null,

"olho_dominante": null,

"ceratometria_od_horizontal": null,

"ceratometria_od_horizontal_eixo": null,

"ceratometria_od_vertical": null,

"ceratometria_od_vertical_eixo": null,

"ceratometria_oe_horizontal": null,

"ceratometria_oe_horizontal_eixo": null,

"ceratometria_oe_vertical": null,

"ceratometria_oe_vertical_eixo": null,

"indicacao": null,

"dnp_oe": null,

"dnp_od": null,

"altura_oe": null,

"altura_od": null,

"diametro_lente_oe": null,

"diametro_lente_od": null,

"angulo_pantoscopico": null,

"medido_pupilometro": null,

"layout_novo": 0,

"medicao_id": null,

"optometrista": "Nome Optometrista"

},

"observacao": "",

"ocorrencias": null,

"responsavel_tecnico": "",

"funcionario": {

"id": 9999,

"nome": "Nome do Funcionário",

"cpf": "",

"rg": "",

"telefone_fixo": "",

"telefone_movel": "",

"endereco": {

"logradouro": "",

"bairro": "",

"cep": "",

"cidade": "",

"uf": ""

},

"funcao": "Vendedor",

"observacao": ""

},

"itens": [

     {

"id": 9999,

"produto": {

"id": 9999,

"referencia": "XXXXX",

"descricao": "1.56 Hiper Clean Sha",

"grupo": "Multifocal Free Form",

"grife": "XXXXXXX",

"unidade": "UN",

"código_gtin": null

},

"quantidade": "1.0000",

"desconto": 20.909999999999968,

"acrescimo": 0,

"valor_unitario_liquido": "979.0900",

"valor_total_liquido": 979.09,

"custo": 150

},

{

"id": 9999,

"produto": {

"id": 9999,

"referencia": "52335 C2",

"descricao": "Armação Rx (Grau) Feminino",

"grupo": "Rx",

"grife": "XXXXXXX",

"unidade": "UN",

"código_gtin": null

},

"quantidade": "1.0000",

"desconto": 2.930000000000007,

"acrescimo": 0,

"valor_unitario_liquido": "136.9700",

"valor_total_liquido": 136.97,

"custo": 79.9

},

{

"id": 9999,

"produto": {

"id": 9999,

"referencia": "YS3867 C1",

"descricao": "Armação Rx Feminino Clip On",

"grupo": "Clip On",

"grife": "XXXXXXX",

"unidade": "UN",

"código_gtin": null

},

"quantidade": "1.0000",

"desconto": 6.060000000000002,

"acrescimo": 0,

"valor_unitario_liquido": "283.9400",

"valor_total_liquido": 283.94,

"custo": 129

}

],

"formas_pagamento": [

     {

"id": 9999,

"data": "2023-01-12",

"valor": "700.00",

"qtd_parcelas": 1,

"forma_pagamento": "Pix",

"codigo_autorizacao": null

}

],

"cliente": {

"id": 99999,

"nome": "NOME DO CLIENTE",

"apelido": "",

"nascimento": "1954-10-23",

"cpf_cnpj": "999.999.999-99",

"rg_ie": "",

"nome_pai": "",

"nome_mae": "",

"profissao": null,

"observacao": "",

"ativo": true,

"contribuinte_icms": false,

"suframa": null,

"ie": null,

"im": null,

"tipo": "PF",

"cadastrado_em": "2023-01-12 14:42:09",

"sexo": "F",

"renda_familiar": "0.00",

"codigo": null,

"convenio": "",

"escolaridade": null,

"referencia": null,

"endereco": {

"logradouro": "XXXXXXXXXXXXXXX",

"numero": "600",

"complemento": "Apto 4101",

"bairro": "",

"cep": "",

"cidade": "XXXXXXX",

"uf": "SP",

"pais": "Brasil"

},

"telefones": [

       {

"numero": "(99) 9.9999-9999",

"identificacao": ""

}

],

"emails": [

       {

"email": "xxxxxxxx@gmail.com",

"identificacao": ""

}

],

"origem": "Instagram"

},

"origensCliente": [

"Instagram"

]

 }

]

3- API para consulta de lançamentos financeiros

Endpoint - Método GET
https://app.ssotica.com.br/api/v1/integracoes/financeiro/extrato/periodo?cnpj=XXX&inicio_periodo=2023-01-12&fim_periodo=2023-01-12

Os dados retornados são:

• data_operacao: data de lançamento do registro;
• data_credito: data de efetivação do lançamento;
• codigo_autorizacao_adquirente: código de autorização para transações de cartão de crédito;
• valor: valor do lançamento;
• tipo: informar se o lançamento é CRÉDITO ou DÉBITO (positivo ou negativo). Note que essa informação não significa que é um lançamento de RECEITA ou DESPESA. Essa informação fica na categoria. Um lançamento de categoria RECEITA pode ser do tipo DÉBITO (saída), isso geralmente ocorre em lançamento de estorno, onde o lançamento negativo cancela o lançamento positivo;
• descricao: descrição detalhada do lançamento;
• numero_documento: número do documento informado no lançamento;
• tipo_documento: tipo de documento, caso tenha sido informado;
• forma_recebimento: dados da forma de recebimento vinculada ao lançamento;
• conta: informações sobre a conta vinculada ao lançamento;
• categoria: informações sobre a categoria vinculada ao lançamento. Permite saber se é uma RECEITA ou DESPESA;
• cliente: informações completas sobre o cliente (se existir) vinculado ao lançamento;
• venda: informações sobre a venda (se existir) vinculada ao lançamento;
• ordem_servico: informações sobre a ordem de serviço (se existir) vinculada ao lançamento;
• fornecedor: informações sobre o fornecedor (se existir) vinculado ao lançamento;

👉 Exemplo:

{

"data_operacao": "2020-02-12",

"data_credito": "2020-02-12",

"codigo_autorizacao_adquirente": "038043",

"valor": 116.5,

"tipo": "CREDITO",

"descricao": "Recebimento de venda no. 1570. Parcela 3/4",

"numero_documento": "venda 1570",

"forma_recebimento": {

"id": 51976,

"nome": "Cartao de Credito Parcelado 2 Ate 6X",

"tipo": "Cartão de Crédito/débito"

},

"conta": {

"id": 26407,

"descricao": "Banco"

},

"categoria": {

"id": 388677,

"descricao": "Vendas",

"tipo": "CREDITO",

"conta_pai": {

"id": 388676,

"descricao": "Receitas de Vendas",

"tipo": "CREDITO"

}

},

"cliente": {

"id": 7428731,

"nome": "xxxxxxxxxxx",

"nascimento": "",

"cpf_cnpj": "000.000.000-00",

"ativo": true,

"contribuinte_icms": false,

"tipo": "PF",

"cadastrado_em": "2020-02-12 11:05:51",

"convenio": "",

"endereco": {

"cep": "",

"pais": "Brasil"

},

"telefones": [

{

"numero": "(61) 9.0000-0000",

"identificacao": null

}

],

"emails": []

},

"venda": {

"id": 7714210,

"numero": 1570,

"data": "2020-02-12",

"valor": 466

}

},

Detalhes sobre a forma de recebimento:

Retorna maiores detalhes sobre a forma de recebimento vinculado ao lançamento, geralmente lançamentos de receita.

"forma_recebimento": {

"id": 51976,

"nome": "Cartao de Credito Parcelado 2 Ate 6X",

"tipo": "Cartão de Crédito/débito"

},

Detalhes sobre a conta:

Informa maiores detalhes sobre a conta onde o lançamento foi realizado.

• código: código da conta.
• nome: nome cadastrado para a conta.
   
  

Exemplo:

Detalhes sobre a categoria:

Informa detalhes sobre a categoria do lançamento. Se for uma subcategoria, traz também informações sobre a categoria pai. Através dessas informações é possível saber se o lançamento é uma RECEITA ou DESPESA.
 

• id: ID da categoria;
• descricao: descrição da categoria;
• tipo: pode conter 2 valores - CREDITO (receita) e DÉBITO (despesa);
• conta_pai: se for uma subcategoria, são os dados da categoria pai. Os dados são os mesmos, id, descrição e tipo.

👉 Exemplo:

Detalhes sobre o cliente:

Retorna todas as informações sobre o cliente vinculado ao lançamento, como vendas, adiantamento de ordem de serviço e contas a receber.
 

Detalhes sobre a venda:

Quando é um recebimento de venda, retorna os dados dessa venda.
 

Detalhes sobre a ordem de serviço:

Quando é um adiantamento de ordem de serviço, retorna os dados da ordem de serviço.
 

Detalhes sobre o fornecedor:

Quando o lançamento é um "Contas a Pagar" e possui um fornecedor vinculado, retorna os dados desse fornecedor.

4- API para consulta de produtos, estoque, produtos reservados em O.S., preço, grupo, grife e fornecedores:

Endpoint - Método GET:

https://app.ssotica.com.br/api/v1/produto/estoque/busca

Parâmetros: 

• • empresa: Cód. da Licença.
  • referencia: Referência do produto para busca.
  • id: ID do produto para busca.
  • page: Página a ser retornada (Exemplo: Nº da Pág).
  • perPage: Quantidade de itens a serem retornados (Limite: 100 itens por página). 

Explicação da Paginação:

 É necessário especificar um valor para o parâmetro "page", o padrão é 1 (primeira página). Caso não seja informado nenhum valor, não será apresentado o resultado esperado.

Ao buscar itens, a página 1 retorna os itens de 1 a 100 (se disponíveis), a página 2 retorna os itens de 101 a 200, e assim por diante.

A quantidade total de páginas é calculada com base na quantidade de itens da busca.

Exemplo de Cálculo de Páginas:

Suponhamos que você tenha 234 itens no total, será apresentado os seguintes itens por página:

Página 1: Itens 1-100

Página 2: Itens 101-200

Página 3: Itens 201-234

Dessa forma, você precisará apenas ajustar o número da página para visualizar as informações desejadas. Logo abaixo virá o detalhamento de produto por produto. 

Formato do Retorno:

• "currentPage": página atual
• "totalPages": total de páginas
• "totalItems": total de itens
• "perPage": itens por página
• "data": Conjunto de itens de resposta da requisição:

Informações do Produto

• "id": identificador único do produto.
• "referencia": código ou referência interna do produto.
• "descricao": descrição detalhada do produto.
• "unidade": unidade de medida (ex.: UN, CX, PCT).
• "grife": nome da grife ou marca do produto.
• "grife_id": identificador da grife vinculada.
• "grupo": grupo de classificação do produto.
• "grupo_id": identificador do grupo.
• "subgrupo": subgrupo de classificação do produto.
• "subgrupo_id": identificador do subgrupo.
• "cor": cor do produto (ex.: Azul, Preto).
• "tamanho": tamanho do produto 
• "formato": formato ou variação do produto (ex.: redondo, retangular).

Fornecedores Vinculados

• "fornecedores": lista de fornecedores associados ao produto:
  1. "id": identificador único do fornecedor.
  2. "documento": CNPJ ou CPF do fornecedor.
  3. "razao_social": razão social do fornecedor.
  4. "nome_fantasia": nome fantasia do fornecedor.

Estoque e Valores

• "estoque_atual": quantidade atual em estoque.
• "reservado_os": quantidade reservada em ordens de serviço.
• "preco_venda": preço de venda do produto.
• “preco_custo”: preço de custo do produto
• "ativo": indica se o produto está ativo no cadastro (true ou false).
• "codigo_ean": código de barras (EAN) do produto.
• "imagens": link(s) da imagem do produto.

Informações de Cadastro

• "criado_em": data de criação do registro do produto.
• "criado_por": usuário responsável pela criação do cadastro.
• "atualizado_em": data da última atualização do registro.
• "atualizado_por": usuário que realizou a última atualização.

👉 Exemplo de JSON retornado:

5- API de consulta do Contas a Pagar do ssOtica.

 Endpoint - Método GET 
  https://app.ssotica.com.br/api/v1/integracoes/financeiro/contas-a-pagar/periodo?empresa=XXXX-XXXX&inicio_periodo=2025-08-01&fim_periodo=2025-08-31
 

Parâmetros: 

• empresa: Código da Licença
• inicio_periodo: data de início no formato YYYY-MM-DD;
• fim_periodo: data final do período no formato YYYY-MM-DD.
• tipo_periodo: você pode usar “vencimento”, “cancelamento”, “pagamento”, “lançamento” ou “emissao”. Obs: Se este parâmetro não for utilizado, o tipo de período padrão será “vencimento”. 
• id: ID da conta a pagar para busca. Obs: Filtrando pelo ID de uma conta especifica, os demais parâmetros serão ignorados
• page: Página a ser retornada (Exemplo: Nº da Pág).
• perPage: Quantidade de itens a serem retornados (Limite: 100 itens por página). 
• documento:  número do documento
• emissao: data da emissão da conta. 

Formato do Retorno:

• "currentPage": página atual
• "totalPages": total de páginas
• "totalItems": total de itens
• "perPage": itens por página
• "data": Conjunto de itens de resposta da requisição:

Informações da Parcela

• "id": identificador único da parcela.
• "numero_parcela": número da parcela dentro do título.
• "vencimento": data de vencimento da parcela.
• "situacao": situação atual da parcela (ex.: "Pago", "Em Aberto", "Cancelado").
• "arquivos": conjunto de arquivos vinculados à parcela.
• "anexo": link de imagem anexada à parcela.
• "comprovante": link do comprovante de pagamento anexado.

Movimentações da Parcela

• "baixado_por": usuário que registrou a baixa da parcela.
• "baixado_em": data e hora em que a parcela foi baixada.
• "cancelado_por": usuário que cancelou a parcela (caso tenha sido cancelada).
• "cancelado_em": data e hora do cancelamento.
• "motivo_cancelamento": justificativa do cancelamento.

Valores da Parcela

• "valor_original": valor inicial da parcela.
• "juros": valor de juros aplicados.
• "desconto": desconto concedido.
• "valor_pago": valor efetivamente pago.
• "observacao": observações adicionais sobre a parcela.

Informações do Título

• "titulo": dados do título financeiro vinculado:
  1. "id": identificador único do título.
  2. "documento": número do documento associado.
  3. "lancamento": data de lançamento do título.
  4. "criado_por": usuário que criou o título.
  5. "data_emissao": data de emissão do título (ex.: "2025-08-19").
  6. "valor": valor total do título.
  7. "mes_competencia": mês de competência do título.
  8. "qtd_parcelas": quantidade total de parcelas.
  9. "plano_conta": plano de contas vinculado.
  10. "tipo_documento": tipo de documento associado (ex.: NF, Recibo, etc.).
  11. "descricao": descrição do título.
  12. "quitado": indica se todas as parcelas foram quitadas ("Sim" ou "Não").

Informações do Fornecedor

• "fornecedor": dados do fornecedor vinculado:
  1. "id": identificador único do fornecedor (ex.: "230563").
  2. "nome_fantasia": nome fantasia do fornecedor.
  3. "razao_social": razão social do fornecedor.
  4. "documento": CNPJ ou CPF do fornecedor.
  5. "laboratorio": nome do laboratório (se aplicável).
  6. "email": e-mail principal de contato.
  7. "inscricao_estadual": número de inscrição estadual.
  8. "inscricao_municipal": número de inscrição municipal.
  9. "suframa": código de inscrição SUFRAMA (quando aplicável).
  10. "contribuinte_icms": indica se o fornecedor é contribuinte de ICMS.
  11. "ocorrencias_caixa": registros ou observações relacionadas a ocorrências de caixa

6- API de consulta do Contas a Receber do ssOtica.

 Endpoint - Método GET 

https://app.ssotica.com.br/api/v1/integracoes/financeiro/contas-a-receber/periodo?empresa=XXXX-XXXX&inicio_periodo=2025-08-01&fim_periodo=2025-08-31
 

Parâmetros: 

• empresa: Código da Licença
• inicio_periodo: data de início no formato YYYY-MM-DD;
• fim_periodo: data final do período no formato YYYY-MM-DD.
• tipo_periodo: você pode usar “vencimento”, “cancelamento”, “pagamento”, “lançamento” ou “renegociacao”. Obs: Se este parâmetro não for utilizado, o tipo de período padrão será “vencimento”. 
• id: ID da conta a receber para busca. Obs: Filtrando pelo ID de uma conta específica, os demais parâmetros serão ignorados
• page: Página a ser retornada (Exemplo: Nº da Pág).
• perPage: Quantidade de itens a serem retornados (Limite: 100 itens por página). 
• documento:  número do documento
• renegociação: data da renegociação da conta. 

Formato do Retorno:

• "currentPage": página atual
• "totalPages": total de páginas
• "totalItems": total de itens
• "perPage": itens por página
• "data": Conjunto de itens de resposta da requisição:

Informações da Parcela

• "id": identificador único da parcela.
• "numero_parcela": número da parcela dentro do título.
• "vencimento": data de vencimento da parcela.
• "forma_pagamento": forma de pagamento utilizada (ex.: boleto, cartão, PIX).
• "situação": status atual da parcela (ex.: em aberto, pago, cancelado).
• "valor_original": valor inicial da parcela sem ajustes.
• "juros": valor de juros aplicados.
• "multa": valor de multa aplicada.
• "desconto": desconto concedido.
• "valor_reajustado": valor final da parcela após ajustes (juros, multa, desconto).
• "valor_pago": valor efetivamente pago.
• "baixado_por": usuário que registrou a baixa do pagamento.
• "baixado_em": data em que o pagamento foi baixado.
• "estornado_por": usuário que realizou o estorno.
• "estornado_em": data do estorno.
• "motivo_estorno": motivo pelo qual a parcela foi estornada.
• "cancelado_por": usuário que cancelou a parcela.
• "cancelado_em": data do cancelamento.
• "motivo_cancelamento": motivo do cancelamento.

Informações do Título

• "titulo": identificador do título financeiro.
• "id": identificador interno do título.
• "numero_documento": número do documento
• "descricao": descrição do título.
• "qtd_parcelas": quantidade total de parcelas.

Informações do Cliente

• "cliente": dados do cliente associado à venda:
  1. "id": identificador do cliente.
  2. "nome": nome completo do cliente.
  3. "documento": CPF ou CNPJ.
  4. "rg": número do RG (se aplicável).
  5. "telefone_principal": telefone principal de contato.
  6. "email_principal": e-mail principal.

Informações Complementares

• "plano_conta": plano de contas vinculado.
• "tipo_documento": tipo do documento financeiro.
• "forma_pagamento": forma de pagamento definida no título.
• "venda": venda vinculada

Informações de Boleto

• "boleto": detalhes do boleto gerado:
  1. "id": identificador do boleto.
  2. "nosso_numero": número único do boleto no banco.
  3. "forma_pagamento": forma de pagamento do boleto.
  4. "valor": valor do boleto.
  5. "vencimento": data de vencimento do boleto.
  6. "status": situação atual (ex.: emitido, pago, vencido).

Outras Informações

• "renegociacao": dados de renegociações vinculadas (se houver).
• "dependente": informações de dependente relacionado (se houver).

👉  Exemplo de JSON retornado: