Histórico da Página

...

Visão Geral
Exemplo de utilização
Tabelas utilizadas
Informações relacionadas

01. VISÃO GERAL

Essa API tem como função retornar a quantidade de documentos eletrônicos (NF-e, CT-e, MDF-e, etc.) emitidos em determinado mês.

...

Deck of Cards

id	apirest

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	-	Meses que deseja obter a quantidade dos registros.
Modelos	-	String	-	Modelos de documentos que desejo retornar, por exemplo (NF-e, CT-e, MDF-e)

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. Caso enviar CNPJ e entidade o sistema irá priorizar a entidade.

Quando realizado apenas o envio do CNPJ a API aglutina na TAG quantidade um valor total somando todas as entidades, ou seja irá pegar todas as entidades daquele CNPJ e caso existir registros na CONSOLID02 irá somar o valor total de todas entidades conforme o exemplo "Sucesso CNPJ".

Caso enviar apenas entidade, irá retornar indicando qual a entidade e a quantidade não será somada, conforme o exemplo de "Sucesso entidade".

Card

label	Método POST - Parâmetros de saída

Deck of Cards

id	Retornos API

Falha

Card

label	Sucesso CNPJ

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

label

Falha

Sucesso Entidade

Bloco de código

theme	RDark
firstline	1
title	Exemplo de retorno -

Sucesso Entidade
linenumbers	true
collapse	true

{
    "status":

400

 "200",
    "message": "Sucesso",
    "NFE": [
        {
            "periodo": "JANEIRO/2024",
            "quantidade": 10,
            "entidade": "XXXXXX"
        },
        {
            "periodo":

"Erro na estrutura do json"

 "FEVEREIRO/2024",
            "quantidade": 20,
            "entidade": "XXXXXX"
        }
    ],
    "

data

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.
datamodelo	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 Retorna vazio em caso de falhasucesso.
xmlquantidade	String	datamodelo	Retorna o arquivo XML da requisição encodado em BASE64a quantidade de documentos no período.	Retornado apenas em caso de sucesso, podendo retornar com valor zerado caso não existir registro na CONSOLID02.
danfeentidade/CNPJ	String	data	Retorna o arquivo DANFE da requisição encodado em BASE64.	modelo	Retorna a entidade ou CNPJ utilizado no TSS.	Retorna Retornado apenas 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.
Falha criacao de arquivo	Validar acesso a pastas do diretório de instalação do TSS.
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	Registro nao localizado na SPED050	Validar se os dados informados na requisição estão vinculados a um registro existente na tabela SPED050.
Dado incorreto: *campo, tamanho esperado tamanho*	Tamanho do campo informado na requisição maior que o esperado.	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.

...

SPED050, CONSOLID01, CONSOLID02, TSS0010.

04. Informações relacionadas

Para o uso da API é necessário que o arquivo Printer.exe, esteja na pasta do AppServer do TSS.

Páginas filhas

Versões comparadas

Versão antiga 1

Nova versão 2

Chave

01. VISÃO GERAL

04. Informações relacionadas