01. DADOS GERAIS

Produto:

TOTVS Varejo Gestão Fiscal

Lina 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

        Para realizar um cadastro de provedor, precisamos criar um CRUD ( POST, PUT, GET), para ser realizado ação via API e posteriormente isso seria habilitado via Front. 

03. SOLUÇÃO

Cadastro de Provedor - POST

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"
 }

Descrição Campos JSON

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

"tipo" : Forma de comunicação, por parceiro ou direto com a Prefeitura  ( PROVEDOR_LAYOUT - PROVEDOR_HUB)

"intervaloBusca" :  Tempo que ocorre a busca (por dia)

"jsonUrl" :  Comunicação com o Provedor 

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)


Alterar/ Atualizar o Provedor - PUT

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)


Consulta do Provedor Cadastrado - GET

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):

{
        "idProvedor": 1,
        "nome": "São Paulo/SP",
        "tipo": "",
        "intervaloBusca": 3,
        "jsonUrl": "{}"
    },
    {
        "idProvedor": 2,
        "nome": "São Paulo",
        "tipo": "",
        "intervaloBusca": 1,
        "jsonUrl": "jsonUrls"
    },

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)


Consulta de Provedor Específico - GET

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):

{
    "idProvedor": 3,
    "nome": "Teste 012",
    "tipo": "",
    "intervaloBusca": 1,
    "jsonUrl": "jsonUrls"
}

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)


04. DEMAIS INFORMAÇÕES


         Não se aplica

05. ASSUNTOS RELACIONADOS

        Não se aplica