Árvore de páginas


01. DADOS GERAIS

Produto:

TOTVS Varejo Gestão Fiscal

Linha de Produto:

Linha Fiscal Cloud 

Segmento:

Varejo 

Módulo:DOCUMENTO FISCAL
Função:FISCAL CLOUD
Ticket:
Requisito/Story/Issue (informe o requisito relacionado) :DVNFSE-1436


02. 
SITUAÇÃO/REQUISITO

Cadastro de Provedor, precisamos criar um CRUD (Sem o DELETE) para que possamos realizar essa ação via API e posteriormente via Front.

03. SOLUÇÃO

Criação de CRUD de Provedor.

Endpoint:

Ambiente Homologação: https://stage.plataformafiscal.totvs.com.br/nfse/provedor
Ambiente Produção: https://plataformafiscal.totvs.com.br/nfse/provedor

Método:GET
Descrição:Consulta dos Provedores Cadastrados
Modelo JSON (Retorno):


Status de retorno:

  • 200 - Retorna uma lista de provedores.
  • 400 - Bad Request (Um ou mais campos estão inválidos. Faça o preenchimento correto e tente novamente)
  • 401 - Unauthorized (Falha na autenticação)
  • 500 - Internal Error (Falha no projeto ou algum dado requisitado não foi preenchido)
Endpoint:

Ambiente Homologação: https://stage.plataformafiscal.totvs.com.br/nfse/provedor/{id}
Ambiente Produção: https://plataformafiscal.totvs.com.br/nfse/provedor/{id}/

Método:GET
Descrição:Consulta de provedor específico 
Modelo JSON (Retorno):


Status de retorno:

  • 200 - Retorna o provedor consultado.
  • 400 - Bad Request (Um ou mais campos estão inválidos. Faça o preenchimento correto e tente novamente)
  • 401 - Unauthorized (Falha na autenticação)
  • 500 - Internal Error (Falha no projeto ou algum dado requisitado não foi preenchido)
Endpoint:

Ambiente Homologação: https://stage.plataformafiscal.totvs.com.br/nfse/provedor
Ambiente Produção: https://plataformafiscal.totvs.com.br/nfse/provedor

Método:POST
Descrição:Criação de um novo provedor
Modelo JSON (Retorno):

 {
 "nome": "São Paulo",
 "tipo": "",
"intervaloBusca": 1,
 "jsonUrl": "jsonUrls"
 }

Campos

"nome": "São Paulo" : Campo Obrigatório, sem padrão de nomenclatura

"tipo" : Campo Não Obrigatório ( PROVEDOR_LAYOUT - PROVEDOR_HUB)

"intervaloBusca" : Em quanto tempo ocorre a busca (por dia)

"jsonUrl" : String

Status de retorno:

  • 200 - Retorna o provedor criado.
  • 400 - Bad Request (Um ou mais campos estão inválidos. Faça o preenchimento correto e tente novamente)
  • 401 - Unauthorized (Falha na autenticação)
  • 500 - Internal Error (Falha no projeto ou algum dado requisitado não foi preenchido)
Endpoint:

Ambiente Homologação: https://stage.plataformafiscal.totvs.com.br/nfse/provedor/{id}
Ambiente Produção: https://plataformafiscal.totvs.com.br/nfse/provedor/{id}

Método:PUT
Descrição:Edição de um provedor
Modelo JSON (Retorno):

 {
 "nome": "São Pauloo1234",
 "tipo": "",
"intervaloBusca": 1,
 "jsonUrl": "jsonUrls"
 }

Status de retorno:

  • 200 - Retorna o provedor editado .
  • 400 - Bad Request (Um ou mais campos estão inválidos. Faça o preenchimento correto e tente novamente)
  • 401 - Unauthorized (Falha na autenticação)
  • 500 - Internal Error (Falha no projeto ou algum dado requisitado não foi preenchido)


04. DEMAIS INFORMAÇÕES


05. ASSUNTOS RELACIONADOS

        Não se aplica