CONTEÚDO
- Visão Geral
- Exemplo de utilização
- Tabelas utilizadas
- Informações relacionadas
01. VISÃO GERAL
Essa API tem como função retornar os dados XML e DANFE de um determinado documento, esses dados são encodados em base64.
02. EXEMPLO DE UTILIZAÇÃO
2.1 Namespace da API
...
| Deck of Cards |
|---|
|
| Card |
|---|
| label | Método POST- Parâmetros de entrada |
|---|
| | Bloco de código |
|---|
| theme | MidnightRDark |
|---|
| firstline | 1 |
|---|
| title | Exemplo body |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
| {
"entidade":"000001",
"serie":"111",
"numero":"111111111",
"modelo":"55"
} |
| Estrutura esperada |
|---|
| Campo | Tipo | Tamanho | Observação | | entidade | string | 6 | Entidade utilizada pela empresa no TSS. | | serie | string | 3 | Série do documento. | | numero | string | 9 | Número do documento. | | modelo | string | 2 | Modelo do documento. Exemplo: NF-e: 55. |
|
| Card |
|---|
| label | Método POST - Parâmetros de saída |
|---|
| | Deck of Cards |
|---|
| | Card |
|---|
| | Bloco de código |
|---|
| theme | ConfluenceRDark |
|---|
| firstline | 1 |
|---|
| title | Exemplo de retorno - Sucesso |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
| {
"status": 200,
"message": "sucesso",
"data": [
{
"xml": "XMLDANFE_BASE64",
"danfe": "DANFE_BASE64"
}
]
} |
|
| Card |
|---|
| | Bloco de código |
|---|
| theme | RDark |
|---|
| firstline | 1 |
|---|
| title | Exemplo de retorno - Falha |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
| {
"status":400,
"message":"Erro na estrutura do json",
"data":[
]
} |
|
|
| 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. | | data | Vetor | - | Vetor contendo as informações de retorno da requisição. | Retorna vazio em caso de falha. | | xml | String | data | Retorna o arquivo XML da requisição encodado em BASE64. | Retornado apenas em caso de sucesso. | | danfe | String | data | Retorna o arquivo DANFE da requisição encodado em BASE64. | Retornado apenas em caso de sucesso. |
|
| 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. | | 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. |
|
|
03. TABELAS UTILIZADAS
SPED050 , SPED059(Legado).
SPED059 (Novo processo quando configurado o parâmetro no Protheus): Configuração para gravação da tabela SPED059. (Quando utilizado envio automático de DANFE).
- Essa tabela possui as informações sintetizadas (XML/DANFE) para retorno mais eficaz da API.
04. Informações relacionadas
- Para o uso da API é necessário que o arquivo Printer.exe, esteja na pasta do AppServer do TSS.
- Configuração do REST: Configuração REST
- Gravação de logs TSS: Gravação de logs da API - TSS
O processo atualmente é dependente do uso do envio automático de DANFE: Distribuição de DANFE Protheus automática
