Introdução
Este documento tem como objetivo fornecer uma visão abrangente e detalhada da API de integração, do Data Collector, permitindo a compreensão da estrutura, os métodos de autenticação e os formatos de dados necessários para uma integração bem-sucedida. A API foi projetada para facilitar a troca de informações de forma segura e eficiente, abrangendo desde a autenticação até o gerenciamento de dados de: Empresas, Fornecedores, Participantes, Notas Fiscais e Cupons Fiscais.
Para garantir a clareza e a facilidade de uso, cada seção da API será detalhada com exemplos de requisições e respostas em formato JSON, além de explicações sobre cada campo, seu tipo de dado, se é obrigatório e a formatação esperada. O objetivo é que este guia sirva como uma referência técnica completa para desenvolvedores e equipes de TI que buscam integrar seus sistemas com a nossa plataforma.
🔗 https://api.recebimento.skytax360.com.br/docs#/
Autenticação (Token-controller)
Endpoint (exemplo):https://api.recebimento.skytax360.com.br/docs#/
A autenticação é o primeiro passo para acessar os recursos protegidos da API. O Token-controller é responsável por gerar um token de acesso (Bearer Token) que deve ser utilizado em todas as requisições subsequentes aos demais endpoints. Este token garante que apenas usuários autorizados possam interagir com a API
Endpoint de Autenticação
- Método:
POST - URL:
https://api.recebimento.skytax360.com.br/auth/login
Corpo da Requisição (Request Body)
Para obter o token de autenticação é necessário enviar um objeto JSON contendo as credenciais de username e password. É crucial que esses dados sejam enviados corretamente para que a autenticação seja bem-sucedida.
| Campo | Descrição | Tipo | Obrigatório | Formato/Exemplo |
|---|---|---|---|---|
| username | Nome de usuário para autenticação | String | Sim | "seu_usuario" |
| password | Senha de usuário para autenticação | String | Sim | "sua_senha" |
🔐 Exemplo de Requisição
[
{
"username": "usuario_exemplo_1",
"password": "senha_exemplo_1"
},
{
"username": "usuario_exemplo_2",
"password": "senha_exemplo_2"
},
{
"username": "usuario_exemplo_3",
"password": "senha_exemplo_3"
}
]Resposta de Sucesso (Success Response)
Se as credenciais forem válidas, a API retornará um status HTTP OK e um objeto JSON contendo o access Token e o expiresIn (tempo de expiração do token em segundos)
| Campo | Descrição | Tipo | Obrigatório | Formato/Exemplo |
|---|---|---|---|---|
| accessToken | Token de autenticação a ser usado em requisições futuras. | String | Sim | "token_gerado" |
| expiresIn | Tempo de expiração do token em segundos | Inteiro | Sim | 3600 (equivalente a 1 hora) |
🔐 Exemplo de Resposta de Sucesso
[
{
"accessToken": "token_gerado_1",
"expiresIn": 3600
},
{
"accessToken": "token_gerado_2",
"expiresIn": 3600
},
{
"accessToken": "token_gerado_3",
"expiresIn": 3600
}
]Estrutura de Dados
As seções a seguir detalham as estruturas de dados para diferentes entidades que podem ser enviadas ou recebidas através da API. Cada estrutura representa uma tabela ou um conjunto de informações relacionadas
Empresas (Cadastro das empresas que serão enviadas)
Endpoint (exemplo):https://api.recebimento.skytax360.com.br/empresas
Esta estrutura é utilizada para o cadastro e atualização de informações das filiais da empresa.
| Campo | Descrição | Tipo | Obrigatório | Formato/Exemplo |
|---|---|---|---|---|
| cnpj | CNPJ da Filial | String | Sim | " 11. 111. 111/ 0001- 11"(apenas dígitos) |
| razaoSocial | Nome da Filial | String | Sim | "Nome da Filial Ltda" |
| grupoEmpresarial | Nome do Grupo Empresarial ao qual a filial pertence. | String | Sim | "Grupo X" |
| dt_periodo | Mês e Ano de referência para o período enviado (uma linha por período). | String | Sim | "AAAA. MM" (ex: " 2025. 01" ) |
🔐 Exemplo de Requisição/Corpo:
[
{
"cnpj": "11111111111111",
"razaoSocial": "Empresa Exemplo Um",
"grupoEmpresarial": "Grupo A",
"dt_periodo": "01/2025"
},
{
"cnpj": "22222222222222",
"razaoSocial": "Empresa Exemplo Dois",
"grupoEmpresarial": "Grupo B",
"dt_periodo": "02/2025"
},
{
"cnpj": "33333333333333",
"razaoSocial": "Empresa Exemplo Três",
"grupoEmpresarial": "Grupo C",
"dt_periodo": "03/2025"
}
]Fornecedores
Endpoint (exemplo):https://api.recebimento.skytax360.com.br/dados/fornecedores
Esta estrutura contém os dados dos fornecedores associados às Notas Fiscais ou Cupons Fiscais.
| Campo | Descrição | Tipo | Obrigatório | Formato/Exemplo |
|---|---|---|---|---|
| cnpj _cpf | CNPJ/CPF do fornecedor | String | Sim | "11111111000111" (apenas dígitos) |
| razaoSocial | Nome/Razão Social do fornecedor | String | Sim | "Fornecedor Alpha Ltda" |
| logradouro | Logradouro do fornecedor | String | Não | "Rua das Flores" |
| nroLogradouro | Logradouro do fornecedor | String | Não | "123" |
| bairro | Bairro do fornecedor | String | Não | "Centro" |
| cidade | Cidade do fornecedor | String | Não | "São Paulo" |
| uf | UF(Estado) do fornecedor | String | Não | "SP" |
| cep | CEP do fornecedor | String | Não | "01000-000"(apenas dígitos) |
| inscricaoEstadual | Inscrição Estadual do fornecedor | String | Não | " 123.456.789.012" (apenas dígitos) |
🔐 Exemplo de Requisição/Corpo:
[
{
"cnpj_cpf": "11111111000111",
"razaoSocial": "Fornecedor Alpha Ltda",
"logradouro": "Rua A",
"numero": "123",
"bairro": "Centro",
"cidade": "Cidade A",
"uf": "SP",
"cep": "11111-111",
"inscricaoEstadual": "111.111.111.111"
},
{
"cnpj_cpf": "22222222000122",
"razaoSocial": "Fornecedor Beta S.A.",
"logradouro": "Avenida B",
"numero": "456",
"bairro": "Bairro B",
"cidade": "Cidade B",
"uf": "RJ",
"cep": "22222-222",
"inscricaoEstadual": "222.222.222.222"
},
{
"cnpj_cpf": "33333333000133",
"razaoSocial": "Fornecedor Gama Eireli",
"logradouro": "Praça C",
"numero": "789",
"bairro": "Bairro C",
"cidade": "Cidade C",
"uf": "MG",
"cep": "33333-333",
"inscricaoEstadual": "333.333.333.333"
}
]Participantes
Endpoint (exemplo):https://api.recebimento.skytax360.com.br/dados/participantes
Esta estrutura detalha os participantes envolvidos nas Notas Fiscais ou Cupons Fiscais, que podem ser destinatários ou outros envolvidos
| Campo | Descrição | Tipo | Obrigatório | Formato/Exemplo |
|---|---|---|---|---|
| cnpj_cpf | CNPJ/CPF do participante. | String | Sim | "44444444000144" (apenas dígitos) |
| razaoSocial | Nome/Razão Social do participante. | String | Sim | "Participante Delta Ltda" |
| logradouro | Logradouro do participante. | String | Não | "Rua dos Coqueiros" |
| nroLogradouro | Número do logradouro. | String | Não | "101" |
| bairro | Bairro do participante. | String | Não | "Jardim" |
| cidade | Cidade do participante. | String | Não | "Belo Horizonte" |
| uf | UF (Estado) do participante. | String | Não | "MG" |
| cep | CEP do participante. | String | Não | "30000-000" (apenas dígitos) |
| inscricaoEstadual | Inscrição Estadual do participante. | String | Não | "444.444.444.444" (apenas dígitos) |
🔐Exemplo de Requisição/Corpo
[
{
"cnpj_cpf": "44444444000144",
"razaoSocial": "Participante Delta Ltda",
"logradouro": "Rua D",
"nroLogradouro": "101",
"bairro": "Centro",
"cidade": "Cidade D",
"uf": "ES",
"cep": "44444-444",
"inscricaoEstadual": "444.444.444.444"
},
{
"cnpj_cpf": "55555555000155",
"razaoSocial": "Participante Epsilon S.A.",
"logradouro": "Avenida E",
"nroLogradouro": "202",
"bairro": "Bairro E",
"cidade": "Cidade E",
"uf": "PR",
"cep": "55555-555",
"inscricaoEstadual": "555.555.555.555"
},
{
"cnpj_cpf": "66666666000166",
"razaoSocial": "Participante Zeta Eireli",
"logradouro": "Praça F",
"nroLogradouro": "303",
"bairro": "Bairro F",
"cidade": "Cidade F",
"uf": "SC",
"cep": "66666-666",
"inscricaoEstadual": "666.666.666.666"
}
]Notas Fiscais
Endpoint (exemplo):https://api.recebimento.skytax360.com.br/dados/notas
Esta seção descreve a estrutura de dados para o envio de informações detalhadas sobre Notas Fiscais Eletrônicas (NF-e). Cada item da nota fiscal deve ser detalhado com suas respectivas informações tributárias e comerciais.
| Campo | Descrição | Tipo | Obrigatório | Formato/Exemplo |
|---|---|---|---|---|
| DT_Periodo | Data do período da nota fiscal. | String | Sim | "2025.01" (AAAA.MM) |
| numDoc | Número do documento da nota. | String | Sim | "000000001" |
| serie | Série da nota fiscal. | String | Não | "1" |
| codModelo | Código do modelo da nota (55 para NF-e). | String | Sim | "55" |
| indEntradaSaida | Indicador de entrada (0) ou saída (1). | String | Sim | "0" ou "1" |
| codEmitente | CNPJ do emitente da nota. | String | Sim | "11111111000111" (apenas dígitos) |
| razaoSocialEmitente | Razão social do emitente. | String | Não | "Empresa Emitente" |
| ufEmitente | UF do emitente. | String | Não | "SP" |
| codDestinatario | CNPJ do destinatário (obrigatório para entrada). | String | Sim | "44444444000144" (apenas dígitos) |
| razaoSocialDestinatario | Razão social do destinatário. | String | Não | "Empresa Destinatária" |
| ufDestinatario | UF do destinatário. | String | Não | "ES" |
| chaveNfe | Chave de acesso da nota (44 dígitos). | String | Sim | "1111222233334444555566667777888899990000" |
| seqItem | Sequencial do item na nota. | Inteiro | Sim | 1 |
| cprod | Código do item. | String | Sim | "PROD001" |
| descricao | Descrição do item. | String | Sim | "Produto Exemplo" |
| cfop | CFOP do item. | String | Sim | "5102" |
| cstOrig | CST de Origem do item. | String | Sim | "0" (0 a 8) |
| cstIcms | CST ICMS do item. | String | Sim | "00" |
| ncm | NCM do item. | String | Sim | "12345678" |
| CEST | CEST do item. | String | Não | "2806100" |
| codEfetivadoEAN | Código EAN do item (ou "SEM-GTIN"). | String | Sim | "7891234567890" ou "SEM-GTIN" |
| quantidade | Quantidade do item. | Decimal | Sim | 10.00 |
| unitario | Unidade de medida (UN, KG, M...). | String | Sim | "UN" |
| valorUnitario | Valor unitário do item. | Decimal | Sim | 100.00 |
| valorTotal | Valor total do item. | Decimal | Não | 1000.00 |
| mva | Margem de valor agregado. | Decimal | Não | 0.00 |
| vlrBaseIcmsProp | Base de cálculo do ICMS próprio. | Decimal | Sim | 1000.00 ou 0 |
| aliquotaIcms | Alíquota do ICMS próprio. | Decimal | Sim | 18.00 ou 0 |
| vlrIcms | Valor do ICMS próprio. | Decimal | Sim | 180.00 ou 0 |
| vlrBaseIcmsSt | Base de cálculo do ICMS-ST. | Decimal | Sim | 0.00 ou 0 |
| vlrIcmsSt | Valor do ICMS-ST. | Decimal | Sim | 0.00 ou 0 |
| perAliquotaIcmsSt | Percentual de alíquota do ICMS-ST. | Decimal | Sim | 0.00 ou 0 |
| vlrIcmsRet | Valor do ICMS-ST Retido. | Decimal | Sim | 0.00 ou 0 |
| vlrBaseIcmsRetido | Base de cálculo do ICMS-ST Retido. | Decimal | Sim | 0.00 ou 0 |
| indPautaST | Pauta Fiscal do ICMS-ST. | Decimal | Sim | 0.00 ou 0 |
| vlrBcFCPST | Base de cálculo FCP do ICMS-ST. | Decimal | Sim | 0.00 ou 0 |
| vlrPercFCPST | Percentual de FCP do ICMS-ST. | Decimal | Sim | 0.00 ou 0 |
| vlrFCPST | Valor de FCP do ICMS-ST. | Decimal | Sim | 0.00 ou 0 |
| redBC | Redução da base de cálculo do ICMS. | Decimal | Sim | 0.00 ou 0 |
| desconto | Desconto do item. | Decimal | Sim | 0.00 ou 0 |
| cstPis | CST PIS do item. | String | Sim | "01" |
| vlBasePis | Base de cálculo do PIS. | Decimal | Sim | 0.00 ou 0 |
| aliqPis | Alíquota do PIS. | Decimal | Sim | 0.00 ou 0 |
| vlPis | Valor do PIS. | Decimal | Sim | 0.00 ou 0 |
| cstCofins | CST COFINS do item. | String | Sim | "01" |
| vlBaseCofins | Base de cálculo do COFINS. | Decimal | Sim | 0.00 ou 0 |
| aliqCofins | Alíquota do COFINS. | Decimal | Sim | 0.00 ou 0 |
| vlCofins | Valor do COFINS. | Decimal | Sim | 0.00 ou 0 |
| vlIss | Valor de ISS (se houver serviço). | Decimal | Sim | 0.00 ou 0 |
| vlBaseIpi | Base de cálculo do IPI. | Decimal | Sim | 0.00 ou 0 |
| aliqIPI | Alíquota do IPI. | Decimal | Sim | 0.00 ou 0 |
| vlIpi | Valor do IPI. | Decimal | Sim | 0.00 ou 0 |
| vlFrete | Valor de frete da nota. | Decimal | Sim | 0.00 ou 0 |
🔐Exemplo de Requisição/Corpo
[
{
"DT_Periodo": "2025.01",
"numDoc": "000000001",
"serie": "1",
"codModelo": "55",
"indEntradaSaida": "0",
"codEmitente": "11111111000111",
"razaoSocialEmitente": "Empresa Emitente A",
"ufEmitente": "SP",
"codDestinatario": "44444444000144",
"razaoSocialDestinatario": "Empresa Destinatária D",
"ufDestinatario": "ES",
"chaveNfe": "1111222233334444555566667777888899990000",
"seqItem": 1,
"cprod": "PROD001",
"descricao": "Produto A",
"cfop": "5102",
"cstOrig": "0",
"cstIcms": "00",
"ncm": "12345678",
"CEST": "2806100",
"codEfetivadoEAN": "7891234567890",
"quantidade": 10.00,
"unitario": "UN",
"valorUnitario": 100.00,
"valorTotal": 1000.00,
"mva": 0.00,
"vlrBaseIcmsProp": 1000.00,
"aliquotaIcms": 18.00,
"vlrIcms": 180.00,
"vlrBaseIcmsSt": 0.00,
"vlrIcmsSt": 0.00,
"perAliquotaIcmsSt": 0.00,
"vlrIcmsRet": 0.00,
"vlrBaseIcmsRetido": 0.00,
"indPautaST": 0.00,
"vlrBcFCPST": 0.00,
"vlrPercFCPST": 0.00,
"vlrFCPST": 0.00,
"redBC": 0.00,
"desconto": 0.00,
"cstPis": "01",
"vlBasePis": 1000.00,
"aliqPis": 0.65,
"vlPis": 6.50,
"cstCofins": "01",
"vlBaseCofins": 1000.00,
"aliqCofins": 3.00,
"vlCofins": 30.00,
"vlIss": 0.00,
"vlBaseIpi": 0.00,
"aliqIPI": 0.00,
"vlIpi": 0.00,
"vlFrete": 0.00
},
{
"DT_Periodo": "2025.01",
"numDoc": "000000002",
"serie": "1",
"codModelo": "55",
"indEntradaSaida": "1",
"codEmitente": "22222222000122",
"razaoSocialEmitente": "Empresa Emitente B",
"ufEmitente": "RJ",
"codDestinatario": "55555555000155",
"razaoSocialDestinatario": "Empresa Destinatária E",
"ufDestinatario": "PR",
"chaveNfe": "0000999988887777666655554444333322221111",
"seqItem": 1,
"cprod": "PROD002",
"descricao": "Produto B",
"cfop": "6102",
"cstOrig": "0",
"cstIcms": "00",
"ncm": "87654321",
"CEST": "2806100",
"codEfetivadoEAN": "SEM-GTIN",
"quantidade": 5.00,
"unitario": "PC",
"valorUnitario": 250.00,
"valorTotal": 1250.00,
"mva": 0.00,
"vlrBaseIcmsProp": 1250.00,
"aliquotaIcms": 12.00,
"vlrIcms": 150.00,
"vlrBaseIcmsSt": 0.00,
"vlrIcmsSt": 0.00,
"perAliquotaIcmsSt": 0.00,
"vlrIcmsRet": 0.00,
"vlrBaseIcmsRetido": 0.00,
"indPautaST": 0.00,
"vlrBcFCPST": 0.00,
"vlrPercFCPST": 0.00,
"vlrFCPST": 0.00,
"redBC": 0.00,
"desconto": 0.00,
"cstPis": "01",
"vlBasePis": 1250.00,
"aliqPis": 0.65,
"vlPis": 8.13,
"cstCofins": "01",
"vlBaseCofins": 1250.00,
"aliqCofins": 3.00,
"vlCofins": 37.50,
"vlIss": 0.00,
"vlBaseIpi": 0.00,
"aliqIPI": 0.00,
"vlIpi": 0.00,
"vlFrete": 0.00
},
{
"DT_Periodo": "2025.01",
"numDoc": "000000003",
"serie": "2",
"codModelo": "55",
"indEntradaSaida": "0",
"codEmitente": "33333333000133",
"razaoSocialEmitente": "Empresa Emitente C",
"ufEmitente": "MG",
"codDestinatario": "66666666000166",
"razaoSocialDestinatario": "Empresa Destinatária F",
"ufDestinatario": "SC",
"chaveNfe": "1234567890123456789012345678901234567890",
"seqItem": 1,
"cprod": "PROD003",
"descricao": "Serviço C",
"cfop": "1933",
"cstOrig": "0",
"cstIcms": "00",
"ncm": "00000000",
"CEST": "",
"codEfetivadoEAN": "SEM-GTIN",
"quantidade": 1.00,
"unitario": "SRV",
"valorUnitario": 500.00,
"valorTotal": 500.00,
"mva": 0.00,
"vlrBaseIcmsProp": 0.00,
"aliquotaIcms": 0.00,
"vlrIcms": 0.00,
"vlrBaseIcmsSt": 0.00,
"vlrIcmsSt": 0.00,
"perAliquotaIcmsSt": 0.00,
"vlrIcmsRet": 0.00,
"vlrBaseIcmsRetido": 0.00,
"indPautaST": 0.00,
"vlrBcFCPST": 0.00,
"vlrPercFCPST": 0.00,
"vlrFCPST": 0.00,
"redBC": 0.00,
"desconto": 0.00,
"cstPis": "01",
"vlBasePis": 0.00,
"aliqPis": 0.00,
"vlPis": 0.00,
"cstCofins": "01",
"vlBaseCofins": 0.00,
"aliqCofins": 0.00,
"vlCofins": 0.00,
"vlIss": 500.00,
"vlBaseIpi": 0.00,
"aliqIPI": 0.00,
"vlIpi": 0.00,
"vlFrete": 0.00
}
]Cupons Fiscais - Item a Item
Endpoint (exemplo):https://api.recebimento.skytax360.com.br/dadosLista/cupons
Esta estrutura é utilizada para o envio de dados de Cupons Fiscais (CF-e) detalhados item a item. É fundamental que todos os campos obrigatórios sejam preenchidos corretamente para o processamento adequado
| Campo | Descrição | Tipo | Obrigatório | Formato/Exemplo |
|---|---|---|---|---|
| DT_Periodo | Data do período do cupom fiscal. | String | Sim | "2025.01" (AAAA.MM) |
| numDoc | Número do documento do cupom fiscal. | String | Sim | "000000001" |
| serie | Série do cupom fiscal. | String | Não | "D1" |
| codModelo | Código do modelo do cupom (59 = CF-e SAT, 2D = NFC-e). | String | Não | "59" ou "2D" |
| codEmitente | CNPJ do emitente do cupom fiscal. | String | Sim | "11111111000111" (apenas dígitos) |
| razaoSocialEmitente | Razão social do emitente do cupom fiscal. | String | Não | "Empresa Emitente" |
| ufEmitente | UF do emitente do cupom fiscal. | String | Não | "SP" |
| codDestinatario | CNPJ do destinatário do cupom fiscal. | String | Não | "44444444000144" (apenas dígitos) |
| razaoSocialDestinatario | Razão social do destinatário do cupom fiscal. | String | Não | "Empresa Destinatária" |
| ufDestinatario | UF do destinatário do cupom fiscal. | String | Não | "ES" |
| chaveNfe | Chave de acesso do cupom fiscal (44 dígitos). | String | Sim | "1111222233334444555566667777888899990000" |
| seqItem | Sequencial do item no cupom fiscal. | Inteiro | Sim | 1 |
| cprod | Código do item do cupom fiscal. | String | Sim | "PROD001" |
| descricao | Descrição do item do cupom fiscal. | String | Sim | "Produto Exemplo" |
| cfop | CFOP do item do cupom fiscal. | String | Sim | "5102" |
| cstOrig | CST Origem do item do cupom fiscal. | String | Sim | "0" (0 a 8) |
| cstIcms | CST ICMS do item do cupom fiscal. | String | Sim | "00" |
| ncm | NCM do item do cupom fiscal. | String | Sim | "12345678" |
| CEST | Código CEST do item do cupom fiscal. | String | Não | "2806100" |
| codEfetivadoEAN | Código EAN do item; usar "SEM-GTIN" se não houver. | String | Sim | "7891234567890" ou "SEM-GTIN" |
| quantidade | Quantidade do item do cupom fiscal. | Decimal | Sim | 2.00 |
| unitario | Unidade de medida do item do cupom fiscal. | String | Sim | "UN" |
| valorUnitario | Valor unitário do item do cupom fiscal. | Decimal | Sim | 50.00 |
| valorTotal | Valor total do item do cupom fiscal. | Decimal | Não | 100.00 |
| mva | Margem de valor agregado do item do cupom fiscal. | Decimal | Não | 0.00 |
| vlrBaseIcmsProp | Base de cálculo do ICMS próprio (enviar 0 se zerado). | Decimal | Sim | 100.00 ou 0 |
| aliquotaIcms | Alíquota do ICMS próprio (enviar 0 se zerado). | Decimal | Sim | 18.00 ou 0 |
| vlrIcms | Valor de ICMS próprio (enviar 0 se zerado). | Decimal | Sim | 18.00 ou 0 |
| desconto | Desconto do item do cupom fiscal (enviar 0 se zerado). | Decimal | Sim | 0.00 ou 0 |
🔐Exemplo de Requisição/Corpo
[
{
"DT_Periodo": "2025-01-15",
"numDoc": "000000001",
"serie": "D1",
"codModelo": "59",
"codEmitente": "11111111000111",
"razaoSocialEmitente": "Empresa Emitente A",
"ufEmitente": "SP",
"codDestinatario": "",
"razaoSocialDestinatario": "",
"ufDestinatario": "",
"chaveNfe": "1111222233334444555566667777888899990000",
"seqItem": 1,
"cprod": "PROD001",
"descricao": "Produto A",
"cfop": "5102",
"cstOrig": "0",
"cstIcms": "00",
"ncm": "12345678",
"CEST": "2806100",
"codEfetivadoEAN": "7891234567890",
"quantidade": 2.00,
"unitario": "UN",
"valorUnitario": 50.00,
"valorTotal": 100.00,
"mva": 0.00,
"vlrBaseIcmsProp": 100.00,
"aliquotaIcms": 18.00,
"vlrIcms": 18.00,
"desconto": 0.00
},
{
"DT_Periodo": "2025-01-16",
"numDoc": "000000002",
"serie": "D1",
"codModelo": "59",
"codEmitente": "22222222000122",
"razaoSocialEmitente": "Empresa Emitente B",
"ufEmitente": "RJ",
"codDestinatario": "",
"razaoSocialDestinatario": "",
"ufDestinatario": "",
"chaveNfe": "0000999988887777666655554444333322221111",
"seqItem": 1,
"cprod": "PROD002",
"descricao": "Produto B",
"cfop": "6102",
"cstOrig": "0",
"cstIcms": "00",
"ncm": "87654321",
"CEST": "2806100",
"codEfetivadoEAN": "SEM-GTIN",
"quantidade": 1.00,
"unitario": "PC",
"valorUnitario": 120.00,
"valorTotal": 120.00,
"mva": 0.00,
"vlrBaseIcmsProp": 120.00,
"aliquotaIcms": 12.00,
"vlrIcms": 14.40,
"desconto": 0.00
},
{
"DT_Periodo": "2025-01-17",
"numDoc": "000000003",
"serie": "D1",
"codModelo": "59",
"codEmitente": "33333333000133",
"razaoSocialEmitente": "Empresa Emitente C",
"ufEmitente": "MG",
"codDestinatario": "",
"razaoSocialDestinatario": "",
"ufDestinatario": "",
"chaveNfe": "1234567890123456789012345678901234567890",
"seqItem": 1,
"cprod": "PROD003",
"descricao": "Produto C",
"cfop": "5102",
"cstOrig": "0",
"cstIcms": "00",
"ncm": "11223344",
"CEST": "",
"codEfetivadoEAN": "7890000000000",
"quantidade": 3.00,
"unitario": "CX",
"valorUnitario": 25.00,
"valorTotal": 75.00,
"mva": 0.00,
"vlrBaseIcmsProp": 75.00,
"aliquotaIcms": 18.00,
"vlrIcms": 13.50,
"desconto": 0.00
}
]Cupons Fiscais - Em Lista
Endpoint (exemplo):https://api.recebimento.skytax360.com.br/dadosLista/cupons
Esta estrutura é similar à anterior, mas pode ser utilizada para o envio de múltiplos itens de cupom fiscal em uma única lista, otimizando a comunicação para grandes volumes de dados
| Campo | Descrição | Tipo | Obrigatório | Formato/Exemplo |
|---|---|---|---|---|
| DT_Periodo | Data do período do cupom fiscal. | String | Sim | "2025.02" (AAAA.MM) |
| numDoc | Número do documento do cupom fiscal. | String | Sim | "000000004" |
| serie | Série do cupom fiscal. | String | Não | "D1" |
| codModelo | Código do modelo do cupom fiscal (59 ou 2D). | String | Não | "59" ou "2D" |
| codEmitente | CNPJ do emitente do cupom fiscal. | String | Sim | "11111111000111" (apenas dígitos) |
| razaoSocialEmitente | Razão social do emitente do cupom fiscal. | String | Não | "Empresa Emitente" |
| ufEmitente | UF do emitente do cupom fiscal. | String | Não | "SP" |
| codDestinatario | CNPJ do destinatário do cupom fiscal. | String | Não | "44444444000144" (apenas dígitos) |
| razaoSocialDestinatario | Razão social do destinatário do cupom fiscal. | String | Não | "Empresa Destinatária" |
| ufDestinatario | UF do destinatário do cupom fiscal. | String | Não | "ES" |
| chaveNfe | Chave de acesso do cupom fiscal (44 dígitos). | String | Sim | "1111222233334444555566667777888899990001" |
| seqItem | Sequencial do item no cupom fiscal. | Inteiro | Sim | 1 |
| cprod | Código de item do cupom fiscal. | String | Sim | "PROD004" |
| descricao | Descrição de item do cupom fiscal. | String | Sim | "Produto Exemplo" |
| cfop | CFOP do item do cupom fiscal. | String | Sim | "5102" |
| cstOrig | CST Origem do item do cupom fiscal. | String | Sim | "0" (0 a 8) |
| cstIcms | CST ICMS do item do cupom fiscal. | String | Sim | "00" |
| ncm | NCM do item do cupom fiscal. | String | Sim | "12345678" |
| CEST | Código CEST do item do cupom fiscal. | String | Não | "2806100" |
| codEfetivadoEAN | Código EAN do item; usar "SEM-GTIN" se não houver. | String | Sim | "7891234567890" ou "SEM-GTIN" |
| quantidade | Quantidade do item do cupom fiscal. | Decimal | Sim | 5.00 |
| unitario | Unidade de medida do item do cupom fiscal. | String | Sim | "UN" |
| valorUnitario | Valor unitário do item do cupom fiscal. | Decimal | Sim | 20.00 |
| valorTotal | Valor total do item do cupom fiscal. | Decimal | Não | 100.00 |
| mva | Margem de valor agregado do item do cupom fiscal. | Decimal | Não | 0.00 |
| vlrBaseIcmsProp | Valor de base de cálculo de ICMS próprio (enviar 0 se zerado). | Decimal | Sim | 100.00 ou 0 |
| aliquotaIcms | Alíquota do ICMS próprio (enviar 0 se zerado). | Decimal | Sim | 18.00 ou 0 |
| vlrIcms | Valor de ICMS próprio (enviar 0 se zerado). | Decimal | Sim | 18.00 ou 0 |
| desconto | Valor de desconto do item do cupom fiscal. | Decimal | Não | 0.00 ou 0 |
🔐Exemplo de Requisição/Corpo
[
{
"DT_Periodo": "2025-02-01",
"numDoc": "000000004",
"serie": "D1",
"codModelo": "59",
"codEmitente": "11111111000111",
"razaoSocialEmitente": "Empresa Emitente A",
"ufEmitente": "SP",
"codDestinatario": "",
"razaoSocialDestinatario": "",
"ufDestinatario": "",
"chaveNfe": "1111222233334444555566667777888899990001",
"seqItem": 1,
"cprod": "PROD004",
"descricao": "Produto D",
"cfop": "5102",
"cstOrig": "0",
"cstIcms": "00",
"ncm": "12345678",
"CEST": "2806100",
"codEfetivadoEAN": "7891234567891",
"quantidade": 5.00,
"unitario": "UN",
"valorUnitario": 20.00,
"valorTotal": 100.00,
"mva": 0.00,
"vlrBaseIcmsProp": 100.00,
"aliquotaIcms": 18.00,
"vlrIcms": 18.00,
"desconto": 0.00
},
{
"DT_Periodo": "2025-02-02",
"numDoc": "000000005",
"serie": "D1",
"codModelo": "59",
"codEmitente": "22222222000122",
"razaoSocialEmitente": "Empresa Emitente B",
"ufEmitente": "RJ",
"codDestinatario": "",
"razaoSocialDestinatario": "",
"ufDestinatario": "",
"chaveNfe": "0000999988887777666655554444333322221112",
"seqItem": 1,
"cprod": "PROD005",
"descricao": "Produto E",
"cfop": "6102",
"cstOrig": "0",
"cstIcms": "00",
"ncm": "87654321",
"CEST": "2806100",
"codEfetivadoEAN": "SEM-GTIN",
"quantidade": 2.00,
"unitario": "PC",
"valorUnitario": 60.00,
"valorTotal": 120.00,
"mva": 0.00,
"vlrBaseIcmsProp": 120.00,
"aliquotaIcms": 12.00,
"vlrIcms": 14.40,
"desconto": 0.00
},
{
"DT_Periodo": "2025-02-03",
"numDoc": "000000006",
"serie": "D1",
"codModelo": "59",
"codEmitente": "33333333000133",
"razaoSocialEmitente": "Empresa Emitente C",
"ufEmitente": "MG",
"codDestinatario": "",
"razaoSocialDestinatario": "",
"ufDestinatario": "",
"chaveNfe": "1234567890123456789012345678901234567891",
"seqItem": 1,
"cprod": "PROD006",
"descricao": "Produto F",
"cfop": "5102",
"cstOrig": "0",
"cstIcms": "00",
"ncm": "11223344",
"CEST": "",
"codEfetivadoEAN": "7890000000000",
"quantidade": 1.00,
"unitario": "CX",
"valorUnitario": 75.00,
"valorTotal": 75.00,
"mva": 0.00,
"vlrBaseIcmsProp": 75.00,
"aliquotaIcms": 18.00,
"vlrIcms": 13.50,
"desconto": 0.00
}
]Fator de Conversão
Endpoint (exemplo):https://api.recebimento.skytax360.com.br/dados/fatorConv
Esta estrutura é utilizada para definir fatores de conversão entre diferentes unidades de medida de produtos, essencial para a padronização de estoque e vendas
| Campo | Descrição | Tipo | Obrigatório | Formato/Exemplo |
|---|---|---|---|---|
| codProdFornecedor | Código do produto na NF-e de entrada (código de entrada do produto). | String | Sim | "PROD_FORN_001" |
| descProdutoForn | Descrição do produto na NF-e de entrada. | String | Sim | "Produto Fornecedor A" |
| unidMedidaForn | Unidade de medida do produto na NF-e de entrada. | String | Sim | "UN" |
| codProdInt | Código do produto interno. | String | Sim | "PROD_INT_001" |
| descProdutoInt | Descrição do produto interno. | String | Sim | "Produto Interno A" |
| unidMedidaInt | Unidade de medida do produto interno (ou de cadastro). | String | Sim | "PC" |
| unidConvertida | Unidade comercial a ser convertida na unidade de estoque. | String | Sim | "CX" |
| fatConversao | Fator para converter (multiplicar) a unidade comercial na unidade adotada no inventário. | Decimal | Sim | 2.00 |
🔐Exemplo de Requisição/Corpo
[
{
"codProdFornecedor": "PROD_FORN_001",
"descProdutoForn": "Produto Fornecedor A",
"unidMedidaForn": "UN",
"codProdInt": "PROD_INT_001",
"descProdutoInt": "Produto Interno A",
"unidMedidaInt": "PC",
"unidConvertida": "CX",
"fatConversao": 2.00
},
{
"codProdFornecedor": "PROD_FORN_002",
"descProdutoForn": "Produto Fornecedor B",
"unidMedidaForn": "KG",
"codProdInt": "PROD_INT_002",
"descProdutoInt": "Produto Interno B",
"unidMedidaInt": "GR",
"unidConvertida": "UN",
"fatConversao": 1000.00
},
{
"codProdFornecedor": "PROD_FORN_003",
"descProdutoForn": "Produto Fornecedor C",
"unidMedidaForn": "M",
"codProdInt": "PROD_INT_003",
"descProdutoInt": "Produto Interno C",
"unidMedidaInt": "CM",
"unidConvertida": "MM",
"fatConversao": 100.00
}
]DePara
Endpoint (exemplo):https://api.recebimento.skytax360.com.br/dados/dePara
A estrutura 'DePara' é utilizada para mapear códigos de produtos de fornecedores para códigos de produtos internos, facilitando a padronização e o controle de estoque.
| Campo | Descrição | Tipo | Obrigatório | Formato/Exemplo |
|---|---|---|---|---|
| cnpj_cpf | CNPJ/CPF do fornecedor. | String | Sim | "11111111000111" (apenas dígitos) |
| codProdFornecedor | Código do produto na NF-e de entrada / código de entrada. | String | Sim | "PROD_FORN_001" |
| descProdutoForn | Descrição do produto da NF-e de entrada. | String | Sim | "Produto Fornecedor A" |
| unidMedidaForn | Unidade de medida do produto na NF-e de entrada. | String | Sim | "UN" |
| codProdInt | Código do produto interno. | String | Sim | "PROD_INT_001" |
| descProdutoInt | Descrição do produto interno. | String | Sim | "Produto Interno A" |
| unidMedidaInt | Unidade de medida do produto interno. | String | Sim | "PC" |
| ncm | NCM do item. | String | Sim | "12345678" |
| codEfetivadoEAN | Código EAN (usar "SEM-GTIN" se não houver). | String | Sim | "7891234567890" ou "SEM-GTIN" |
🔐Exemplo de Requisição/Corpo
[
{
"cnpj_cpf": "11111111000111",
"codProdFornecedor": "PROD_FORN_001",
"descProdutoForn": "Produto Fornecedor A",
"unidMedidaForn": "UN",
"codProdInt": "PROD_INT_001",
"descProdutoInt": "Produto Interno A",
"unidMedidaInt": "PC",
"ncm": "12345678",
"codEfetivadoEAN": "7891234567890"
},
{
"cnpj_cpf": "22222222000122",
"codProdFornecedor": "PROD_FORN_002",
"descProdutoForn": "Produto Fornecedor B",
"unidMedidaForn": "KG",
"codProdInt": "PROD_INT_002",
"descProdutoInt": "Produto Interno B",
"unidMedidaInt": "GR",
"ncm": "87654321",
"codEfetivadoEAN": "SEM-GTIN"
},
{
"cnpj_cpf": "33333333000133",
"codProdFornecedor": "PROD_FORN_003",
"descProdutoForn": "Produto Fornecedor C",
"unidMedidaForn": "M",
"codProdInt": "PROD_INT_003",
"descProdutoInt": "Produto Interno C",
"unidMedidaInt": "CM",
"ncm": "11223344",
"codEfetivadoEAN": "7890000000000"
}
]Produção de Fabricação Própria
Esta estrutura é utilizada para registrar produtos que são de fabricação própria, associando um código interno a um código EAN.
| Campo | Descrição | Tipo | Obrigatório | Formato/Exemplo |
|---|---|---|---|---|
| codProd | Código do produto interno para produtos de fabricação própria. | String | Sim | "PROD_FP_001" |
| codEfetivadoEAN | Código EAN (usar "SEM-GTIN" se não houver). | String | Sim | "7891111111111" ou "SEM-GTIN" |
🔐Exemplo de Requisição/Corpo
[
{
"codProd": "PROD_FP_001",
"codEfetivadoEAN": "7891111111111"
},
{
"codProd": "PROD_FP_002",
"codEfetivadoEAN": "SEM-GTIN"
},
{
"codProd": "PROD_FP_003",
"codEfetivadoEAN": "7892222222222"
}
]Tabela de Produtos (Consolidado DePara e Fator de Conversão)
Esta tabela consolida informações de 'DePara' e 'Fator de Conversão', fornecendo uma visão completa dos produtos, seus mapeamentos e fatores de conversão entre unidades
| Campo | Descrição | Tipo | Obrigatório | Formato/Exemplo |
|---|---|---|---|---|
| cnpj_cpfForn | CNPJ/CPF do fornecedor do produto. | String | Sim | "11111111000111" (apenas dígitos) |
| codProdFornecedor | Código do produto na NF-e de entrada / código de entrada. | String | Sim | "PROD_FORN_001" |
| descProdutoForn | Descrição do produto na NF-e de entrada. | String | Sim | "Produto Fornecedor A" |
| unidMedidaForn | Unidade de medida do produto na NF-e de entrada. | String | Sim | "UN" |
| codProdInt | Código do produto interno. | String | Sim | "PROD_INT_001" |
| descProdutoInt | Descrição do produto interno. | String | Sim | "Produto Interno A" |
| unidMedidaInt | Unidade de medida do produto interno. | String | Sim | "PC" |
| unidConvertida | Unidade comercial a ser convertida na unidade de estoque. | String | Sim | "CX" |
| fatConversao | Fator de conversão para a unidade de estoque. | Decimal | Sim | 2.00 |
| ncm | NCM do item. | String | Sim | "12345678" |
| codEfetivadoEAN | Código EAN (usar "SEM-GTIN" se não houver). | String | Sim | "7891234567890" ou "SEM-GTIN" |
Endpoint (exemplo):https://api.recebimento.skytax360.com.br/dados/produto
🔐Exemplo de Requisição/Corpo
[
{
"cnpj_cpfForn": "11111111000111",
"codProdFornecedor": "PROD_FORN_001",
"descProdutoForn": "Produto Fornecedor A",
"unidMedidaForn": "UN",
"codProdInt": "PROD_INT_001",
"descProdutoInt": "Produto Interno A",
"unidMedidaInt": "PC",
"unidConvertida": "CX",
"fatConversao": 2.00,
"ncm": "12345678",
"codEfetivadoEAN": "7891234567890"
},
{
"cnpj_cpfForn": "22222222000122",
"codProdFornecedor": "PROD_FORN_002",
"descProdutoForn": "Produto Fornecedor B",
"unidMedidaForn": "KG",
"codProdInt": "PROD_INT_002",
"descProdutoInt": "Produto Interno B",
"unidMedidaInt": "GR",
"unidConvertida": "UN",
"fatConversao": 1000.00,
"ncm": "87654321",
"codEfetivadoEAN": "SEM-GTIN"
},
{
"cnpj_cpfForn": "33333333000133",
"codProdFornecedor": "PROD_FORN_003",
"descProdutoForn": "Produto Fornecedor C",
"unidMedidaForn": "M",
"codProdInt": "PROD_INT_003",
"descProdutoInt": "Produto Interno C",
"unidMedidaInt": "CM",
"unidConvertida": "MM",
"fatConversao": 100.00,
"ncm": "11223344",
"codEfetivadoEAN": "7890000000000"
}
]Considerações Finais
Este documento serve como um guia fundamental para a integração com a nossa API. É crucial que os desenvolvedores sigam as especificações de formato e obrigatoriedade de cada campo para garantir a integridade e o sucesso das operações. Em caso de dúvidas ou necessidade de suporte adicional, nossa equipe técnica está à disposição para auxiliar no processo de integração. Continuaremos aprimorando esta documentação e a API para oferecer a melhor experiência possível aos nossos parceiros. Fique atento a futuras atualizações e novas funcionalidades
