Páginas filhas
  • TSSAPIDOC - API REST para retorno de DANFE e do XML referente a integração com o Portal Financeiro..

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Deck of Cards
idapirest
Card
labelMétodo POST- Parâmetros de entrada
Bloco de código
themeRDark
firstline1
titleExemplo body - JSON
linenumberstrue
collapsetrue
{
   "entidade":"000001",
   "serie":"111",
   "numero":"111111111",
   "modelo":"55"
}
Estrutura esperada
CampoTipoTamanhoObservação
entidadestring6Entidade utilizada pela empresa no TSS.
seriestring3Série do documento.
numerostring9Número do documento.
modelostring2Modelo do documento. Exemplo: NF-e: 55.



Card
labelMétodo POST - Parâmetros de saída
Deck of Cards
idRetornos API
Card
labelSucesso
Bloco de código
themeRDark
firstline1
titleExemplo de retorno - Sucesso - JSON
linenumberstrue
collapsetrue
{
    "status": 200,
    "message": "sucesso",
    "data": [
        {
            "xml": "XMLDANFE_BASE64",
            "danfe": "DANFE_BASE64"
        }
    ]
}
Card
labelFalha
Bloco de código
themeRDark
firstline1
titleExemplo de retorno - Falha
linenumberstrue
collapsetrue
{
   "status":400,
   "message":"Erro na estrutura do json",
   "data":[
      
   ]
}
Estrutura - JSON
CampoTipoEstrutura paiDescriçãoObservação
statusNumérico-Código de status de retorno.

Sucesso: 200

Falha: 400

messageString-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.

dataVetor-Vetor contendo as informações de retorno da requisição.Retorna vazio em caso de falha.
xmlStringdataRetorna o arquivo XML da requisição encodado em BASE64.Retornado apenas em caso de sucesso.
danfeStringdataRetorna o arquivo DANFE da requisição encodado em BASE64.Retornado apenas em caso de sucesso.
Card
labelMétodo POST - Retornos
Retorno de sucesso possíveis
DescriçãoObservação
SucessoEstrutura completa com os dados requeridos
Retorno de erro possíveis 
DescriçãoObservação
Erro na estrutura do JSONValidar se a estrutura confere com o modelo esperado JSON 
Falha criacao de arquivoValidar acesso a pastas.
Registro nao localizado na SPED050Validar se os dados informados na requisição estão vinculados a um registro existente na tabela SPED050
Dado incorreto: campo , tamanho esperado tamanhoTamanho do campo informado na requisição maior que o esperado.
Dado incorreto: campo, esperado caractereDado informado no campo, foi diferente de string.
Estrutura incorreta parte faltante campoValidar se todos os campos necessários foram informados na requisição.



...