...
- Visão Geral
- Exemplo de utilização
2.1. Namespace da API
2.2. Método POST - Tabelas utilizadas
- Assuntos Relacionados
01. VISÃO GERAL
Essa API tem como função retornar a quantidade de documentos eletrônicos (NF-e, NFC-e, NFS-e, CT-e, CTe-OS, MDF-e, MD-e, GNRE, REINF, ESOCIAL., REMITO (MI), FACT (MI) ) emitidos em determinado período.
...
2.1 Namespace da API
2.2 Método POST
| Deck of Cards |
|---|
|
| Card |
|---|
| label | Método POST- Parâmetros de entrada |
|---|
| | Bloco de código |
|---|
| theme | RDark |
|---|
| firstline | 1 |
|---|
| title | Exemplo body |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
| {
"EMPRESAS": [
{
"CNPJ": "XXXXXXXXXXXXXX"
},
{
"ENTIDADE": "XXXXXX"
}
],
"ANO": "2024",
"MESES": "1/2",
"MODELOS": "NFE/CTE"
} |
| Estrutura esperada |
|---|
| Campo | Pai | Tipo | Tamanho | Observação | | Empresas | - | Array | - | Array utilizado para enviar CNPJ ou entidade. | | CNPJ | Empresas | String | 14 | CNPJ da empresa utilizado no TSS. | | Entidade | Empresas | String | 6 | Entidade utilizada pela empresa no TSS. | | Ano | - | String | 4 | Ano que deseja obter a quantidade dos registros. | | Meses | - | String | 3 | Meses que deseja obter a quantidade dos registros. Pode se passar mais de um mês, por exemplo: 01/02/03/010 Pode-se enviar também no seguinte exemplo: 1/2/3/10 | | Modelos | - | String | - | Modelos de documentos que desejo retornar, por exemplo: NFE/MDFE/CTE |
Observação: No Json de exemplo citado acima estamos passando um CNPJ e uma entidade, porém a API foi desenvolvida e entende caso enviar mais de um CNPJ e mais de uma entidade. Os meses e os modelos passar separados por "/" se não irá quebrar na hora da consulta. Caso enviar CNPJ e entidade o sistema irá priorizar a entidade. Quando realizado apenas o envio do CNPJ a API aglutina na TAG quantidade com um valor total somando todas as entidades, ou seja irá pegar todas as entidades daquele CNPJ e caso existir registros na CONSOLID02 da entidade que consta o CNPJ, irá somar o valor total de todas entidades conforme o exemplo na aba "Parâmetros de saída "- SUCESSO CNPJ. Caso enviar apenas entidade, irá retornar indicando qual a entidade e a quantidade não será somada, conforme o exemplo na aba "Parâmetros de saída - SUCESSO ENTIDADE".
|
| Card |
|---|
| label | Método POST - Parâmetros de saída |
|---|
| | Deck of Cards |
|---|
| | Card |
|---|
| | Bloco de código |
|---|
| theme | RDark |
|---|
| firstline | 1 |
|---|
| title | Exemplo de retorno - Sucesso CNPJ |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
| {
"status": "200",
"message": "Sucesso",
"CTE": [
{
"periodo": "JANEIRO/2024",
"quantidade": 12,
"cnpj": "XXXXXXXXXXXXXX"
},
{
"periodo": "FEVEREIRO/2024",
"quantidade": 12,
"cnpj": "XXXXXXXXXXXXXX"
}
],
"NFE": [
{
"periodo": "JANEIRO/2024",
"quantidade": 666,
"cnpj": "XXXXXXXXXXXXXX"
},
{
"periodo": "FEVEREIRO/2024",
"quantidade": 65,
"cnpj": "XXXXXXXXXXXXXX"
}
]
} |
| Card |
|---|
| | Bloco de código |
|---|
| theme | RDark |
|---|
| firstline | 1 |
|---|
| title | Exemplo de retorno - Sucesso Entidade |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
| {
"status": "200",
"message": "Sucesso",
"NFE": [
{
"periodo": "JANEIRO/2024",
"quantidade": 10,
"entidade": "XXXXXX"
},
{
"periodo": "FEVEREIRO/2024",
"quantidade": 20,
"entidade": "XXXXXX"
}
],
"CTE": [
{
"periodo": "JANEIRO/2024",
"quantidade": 2,
"entidade": "XXXXXX"
},
{
"periodo": "FEVEREIRO/2024",
"quantidade": 2,
"entidade": "XXXXXX"
}
]
} |
|
|
|
| Estrutura - JSON |
|---|
| Campo | Tipo | Estrutura pai | Descrição | Observação | | status | Numérico | - | Código de status de retorno. | Sucesso: 200 Falha: 400 | | message | String | - | Indica se a requisição foi bem-sucedida. | Em caso de retorno positivo: "sucesso" Em caso de retorno negativo: Mensagem com a descrição do erro. | | modelo | Vetor | - | Vetor contendo as informações de retorno da requisição conforme os modelos solicitado. | - | | periodo | String | modelo | Retorna o mês e ano do período solicitado. | Retornado em caso de sucesso. | | quantidade | String | modelo | Retorna a quantidade de documentos no período. | Retornado em caso de sucesso, podendo retornar com valor zerado caso não existir registro na CONSOLID02. | | entidade/CNPJ | String | modelo | Retorna a entidade ou CNPJ utilizado no TSS. | Retorna em caso de sucesso, podendo retornar mensagem de erro caso CNPJ ou entidade não exista. |
|
| Card |
|---|
| label | Método POST - Retornos |
|---|
| | Retorno de sucesso possíveis |
|---|
| Descrição | Observação | | Sucesso | Estrutura completa com os dados requeridos |
| Retorno de erro possíveis |
|---|
| Descrição | Observação | | Erro na estrutura do JSON | Validar se a estrutura confere com o modelo esperado. | | Nenhum dado encontrado com o filtro informado, verifique os filtros | Verifique os campos como: modelos, ANO, CNPJ e Entidade. | | CNPJ ou Entidade não preenchidos. | Necessário informar ao menos uma entidade ou um CNPJ. | | Dado incorreto: campo, esperado caractere | Dado informado no campo, foi diferente de string. | | Estrutura incorreta parte faltante campo | Validar se todos os campos necessários foram informados na requisição. | | CNPJ ou Entidade não existe | Validar se o CNPJ ou a Entidade informada possuem cadastros. |
|
|
03. TABELAS UTILIZADAS
SPED050, CONSOLID01, CONSOLID02, TSS0010.
04. ASSUNTOS RELACIONADOS
Documentação de como fazer a consulta pelo TSSINTERFACE.
