viniciuh

Manual NFSE API

Nov 27th, 2020 (edited)
936
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
  1.  
  2. 1.0 - Login API:
  3.  
  4.    1.1 - Autenticar usuário para obter token  [MÉTODO POST]
  5.  
  6.    URL: https://nfservico.com.br/prefeitura-teste//token
  7.  
  8.       - Post deve ser feito no formato texto:
  9.       grant_type=password
  10.       &username= username@cnpj
  11.       &password= Senha
  12.       &client_id= NFSeApp (default)
  13.       &client_secret=
  14.  
  15.    EX: grant_type=password&username=username@96805042000179&password=123456&client_id=NFSeApp&client_secret=
  16.  
  17.  
  18.    Exemplo de retorno de autenticação:
  19.    {
  20.       "access_token":"TVl8_P4HSgzRZQmLNdOge71_H2wQfZbwtlC4X8eLpnphMaOHUyDTQxpV0NoKv4kbdcBrNhQsNSWJR0r04sjAYmrmjMM0dtBErOb_HoDs44vDk-Kl8wBObFut6TY3D6
  21.   NUlgyXfR2eQEkkBQKKEwdEVf4dad94wQ4Ky55dlgjGOT2TStnKaa3eXc3Q4TPoQve6e7Ifg_9HeA155iCusDJD1bv6LyCGUC7LZIuZXdIdEq4bKsZwxyOt8iC2QuZHL9mC4TXT8ZUmM7dpEy
  22.   4i-W5ELczvH-4vDmm-cwd-Uqd0BARdY21pJ0eIqY-FJPWXCtntyk1JFOA_QMSk5Zbz55LlcTQ5AmtnS90xJe9ZqnIyC7vR9OM4xAXSbFWjnPmOhRPU-4hYZaPIJtWdZQbkRJfYxkU1bDn1W6
  23.   ut0ipxytLd-f1pKKa5Y3K-VSlXtR7MC7LVHEztuxU0rBmuty-sdxD5AWcXa6PI-P0Nh_GK8Le4NsvUT_cVSn9f8r1JWj9ABv9Bx1H5HgpJ-PdvhZLhIzImDUpR0iLINvGQ6bwAuYWBX0UHxf
  24.   T1qphYjy6f5L-s3SQQQA6mrUV9yRc3L-JOIbWLVw",
  25.  
  26.       "token_type":"bearer","expires_in":7199,
  27.       "as:client_id":"NFSeApp",
  28.       "userName":"username@96805042000179",
  29.       ".issued":"Wed, 25 Nov 2020 17:46:58 GMT",
  30.       ".expires":"Wed, 25 Nov 2020 19:46:58 GMT"
  31.    }
  32.  
  33.    1.2 - OBS: O token de autenticação inicia-se com os parâmetros 'token_typ' e 'access_token'.
  34.  
  35.    Ex: "Bearer TVl8_P4HSgzRZQmLNdOge71_H2wQfZbwt..."
  36.  
  37.  
  38.     1.3 - Para realizar testes de requisição na API disponibilizamos um ambiente de teste:
  39.  
  40.       1.3.1 - Login:   https://nfservico.com.br/prefeitura-teste/token
  41.                username: teste@72416929000107
  42.                password: 123456@
  43.                (Informação para login no item 1.1)
  44.  
  45.       1.3.2 - Cadastro do tomador: https://nfservico.com.br/prefeitura-teste/api/contribuinte/save
  46.                (Informação para cadastro do tomador no item 3.0)
  47.  
  48.       1.3.3 - Emissão de Nota Fiscal: https://nfservico.com.br/prefeitura-teste/api/nota/emitir
  49.                (Informação para emissão da NFSE no item 2.0)
  50.  
  51.       1.3.4 - Consultar informação do tomador para emissão da NFSE:  https://nfservico.com.br/prefeitura-teste/api/contribuinte/tomador/
  52.                CNPJ para testes de consulta: 63682212000116
  53.                Ex: https://nfservico.com.br/prefeitura-teste/api/contribuinte/tomador/63682212000116
  54.                (Informação para consulta no item 4.0)
  55.  
  56.                Exemplo de retorno do item 1.3.4:    
  57.                {
  58.                   "codigo": 19,
  59.                   "razaoSocial": "RAZAO SOCIAL DO TOMADOR",
  60.                   "cpfCNPJ": "63682212000116",
  61.                   "responsavel": "NOME DO RESPONSÁVEL",
  62.                   "tipoDocumento": 0,
  63.                   "tipoPessoa": 1,
  64.                   "tipoContribuinte": 2,
  65.                   "endereco": "Avenida Luís Viana Filho",
  66.                   "numero": "20",
  67.                   "complemento": null,
  68.                   "bairro": "Alphaville I",
  69.                   "cidade": "SALVADOR",
  70.                   "estado": "Bahia",
  71.                   "cep": "41701005",
  72.                   "email": "TOMADOR@MAIL.COM",
  73.                   "telefone": "9999999999",
  74.                   "codMunicipio": 2927408
  75.             }
  76. ==========================================================================================================================================================
  77.  
  78. 2.0 - Emissão de Nota Fiscal:
  79.  
  80.    2.1- Post deve ser feito no formato json. [MÉTODO POST]
  81.  
  82.    URL: https://nfservico.com.br/prefeitura-teste/api/nota/emitir
  83.  
  84.    2.2 - Parâmetros necessário: 'Chave' : 'Valor'
  85.  
  86.    - Token de autenticação:  (ex:  Authorization: "Bearer TVl8_P4HSgzRZQmLNdOge71_H2wQfZbwt...")
  87.  
  88.    2.4 - json nota fiscal:
  89.    {
  90.       "tomador": {
  91.          "codigo": 22776,
  92.          "bairro": "Tijuca",
  93.          "celular": "63430361000",
  94.          "cidade": "RIO DE JANEIRO",
  95.          "codMunicipio": 3304557,
  96.          "cpfCnpj": "63430361000198",
  97.          "endereco": "Rua Garibaldi",
  98.          "estado": "RJ",
  99.          "fantasia": "TESTE 63430361000198",
  100.          "numero": "221",
  101.          "razaoSocial": "TESTE 63430361000198",
  102.          "responsavel": "TESTE 63430361000198",
  103.       },
  104.       "valor":100,
  105.       "totalDeducoes":0,
  106.       "baseCalculo":100,
  107.       "iss":"0.00",
  108.       "credito":0,
  109.       "inss":0,
  110.       "pis":0,
  111.       "cofins":0,
  112.       "irrf":0,
  113.       "csll":0,
  114.       "outrasRetencoes":0,
  115.       "descontoCondicionado":0,
  116.       "descontoIncondicionado":0,
  117.       "liquido":100,
  118.       "codigoTributacaoMunicipio":2926301,
  119.       "competencia":"2020-11-24",
  120.       "cnae":111399,
  121.       "aliquota":0,
  122.       "codigoServico":"0",
  123.       "isIssRetido":0,
  124.       "servico":"DESCRIÇÃO DA NOTA"
  125.    }
  126.  
  127.    2.5 - OBS:  
  128.          - tomador Json {}: Para obter informações do tomador consulte o item 4.0.
  129.  
  130.          - codMunicipio, codigoTributacaoMunicipio: (Consulte o código do município da tabela do IBGE)
  131.          
  132.          - competencia: formato da data deve ser: ANO-MES-DIA (ex: 2020-11-24)
  133. ==========================================================================================================================================================
  134.  
  135. 3.0 - Cadastro do tomador:
  136.  
  137.    3.1  - Post deve ser feito no formato json.  [MÉTODO POST]
  138.  
  139.    URL: https://nfservico.com.br/prefeitura-teste/api/contribuinte/save
  140.  
  141.    * Parâmetros necessário:
  142.  
  143.    - Token de autenticação:  (ex:  Authorization: "Bearer TVl8_P4HSgzRZQmLNdOge71_H2wQfZbwt...")
  144.  
  145.    3.2 -  json tomador:
  146.    {
  147.       "tipoPessoa":1,
  148.       "cnae":0,
  149.       "tipoDocumento":0,
  150.       "aliquota":0,
  151.       "isSimplesNacional":true,
  152.       "cpfCnpj":"91280438000126",
  153.       "razaoSocial":"RAZAO SOCIAL DO TOMADOR",
  154.       "fantasia":"FANTASIA DO TOMADOR",
  155.       "responsavel":"NOME DO RESPONSÁVEL",
  156.       "telefone":"9999999999",
  157.       "celular":"99919125252",
  158.       "email":"TOMADOR@MAIL.COM",
  159.       "cep":"41701005",
  160.       "endereco":"Avenida Luís Viana Filho",
  161.       "bairro":"Alphaville I",
  162.       "estado":"BA",
  163.       "cidade":"Salvador",
  164.       "numero":"20"
  165.    }
  166.  
  167.    3.3 - OBS:
  168.  
  169.    - tipoPessoa: 0: PF, 1: PJ
  170.    - cnae, tipoDocumento, aliquota: (default) 0
  171.    - isSimplesNacional: (default) true para tomador
  172.  
  173. ==========================================================================================================================================================
  174.  
  175. 4.0 - Consultar tomador por CNPJ ou razão social [MÉTODO GET]
  176.    
  177.    4.1 - Para consultar o código referente ao tomador para emissão da nota fiscal, busque através do cnpj ou razão social:
  178.  
  179.    https://nfservico.com.br/prefeitura-teste/api/contribuinte/tomador/ cpfCnpj ou razaoSocial
  180.  
  181.    EX:  https://nfservico.com.br/prefeitura-teste/api/contribuinte/tomador/63682212000116
  182.  
  183.    ou supondo que a razão social do tomador chama-se: José Silva LTDA:
  184.    https://nfservico.com.br/prefeitura-teste/api/contribuinte/tomador/jose
  185.    ou
  186.    https://nfservico.com.br/prefeitura-teste/api/contribuinte/tomador/silva
RAW Paste Data