NFS-e

Cidades integradas

Retorna a lista de municípios disponíveis para emissão de NFS-e, incluindo as configurações do provedor de cada cidade.

Use este endpoint para verificar, antes de integrar, quais requisitos técnicos um município exige:

Campos do objeto provider.options:

CampoDescrição
rpsExige numeração de RPS/DPS
seriesExige série de RPS/DPS
batchNumberExige número de lote
requiresNumberInSequenceRPS/DPS deve ser enviado em sequência rigorosa
requiresDigitalCertificateExige certificado digital
federalServiceCodeExige código do item da lista de serviços LC 116/03
nbsCodeExige código NBS (Nomenclatura Brasileira de Serviços)
cnaeCodeExige código CNAE
cityServiceCodeExige o código do serviço no município
supportsTaxReformSuporta campos de IBS/CBS da Reforma Tributária
useNationalLayoutUtiliza o layout do Ambiente Nacional da NFS-e
authenticationTipo de autenticação exigido pela prefeitura

O campo nationalServiceInvoiceRegimes indica para quais regimes tributários o município adotou o Emissor Nacional. O campo provider.code identifica o provedor e é o mesmo valor de providers[].code em Configurações de emissão por município.

get/v1/service-invoices/cities

Request

  • Base URL: https://api.spedy.com.br (the document declares no server; this is the origin it was published from)
  • URL: https://api.spedy.com.br/v1/service-invoices/cities
  • Auth: none declared

Query parameters

codeinteger

Código

state'ro' | 'ac' | 'am' | 'rr' | 'pa' | 'ap' | 'to' | 'ma' | 'pi' | 'ce' | 'rn' | 'pb' | 'pe' | 'al' | 'se' | 'ba' | 'mg' | 'es' | 'rj' | 'sp' | 'pr' | 'sc' | 'rs' | 'ms' | 'mt' | 'go' | 'df' | 'an' | 'ex'
<p>Valores possíveis:</p> <ul> <li><b>ro</b>: Rondônia</li> <li><b>ac</b>: Acre</li> <li><b>am</b>: Amazonas</li> <li><b>rr</b>: Roraima</li> <li><b>pa</b>: Pará</li> <li><b>ap</b>: Amapá</li> <li><b>to</b>: Tocantins</li> <li><b>ma</b>: Maranhão</li> <li><b>pi</b>: Piauí</li> <li><b>ce</b>: Ceará</li> <li><b>rn</b>: Rio Grande do Norte</li> <li><b>pb</b>: Paraíba</li> <li><b>pe</b>: Pernambuco</li> <li><b>al</b>: Alagoas</li> <li><b>se</b>: Sergipe</li> <li><b>ba</b>: Bahia</li> <li><b>mg</b>: Minas Gerais</li> <li><b>es</b>: Espírito Santo</li> <li><b>rj</b>: Rio de Janeiro</li> <li><b>sp</b>: São Paulo</li> <li><b>pr</b>: Paraná</li> <li><b>sc</b>: Santa Catarina</li> <li><b>rs</b>: Rio Grande do Sul</li> <li><b>ms</b>: Mato Grosso do Sul</li> <li><b>mt</b>: Mato Grosso</li> <li><b>go</b>: Goiás</li> <li><b>df</b>: Distrito Federal</li> <li><b>an</b>: Ambiente Nacional</li> <li><b>ex</b>: Exterior</li> </ul>

Estado

filterTextstring
pageinteger
pageSizeinteger

Response

OK

totalCountinteger nullable
pageCountinteger nullable
pageSizeinteger
hasNextboolean

Changes

No recorded changes to this operation across all 1 revision of this API.