Cidades integradas
curl --request GET \
--url https://api.spedy.com.br/v1/service-invoices/cities \
--header 'X-Api-Key: <api-key>'import requests
url = "https://api.spedy.com.br/v1/service-invoices/cities"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://api.spedy.com.br/v1/service-invoices/cities', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.spedy.com.br/v1/service-invoices/cities",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.spedy.com.br/v1/service-invoices/cities"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.spedy.com.br/v1/service-invoices/cities")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spedy.com.br/v1/service-invoices/cities")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"totalCount": 123,
"pageCount": 123,
"pageSize": 123,
"hasNext": true,
"items": [
{
"code": "<string>",
"name": "<string>",
"state": "<string>",
"provider": {
"code": "issNet",
"name": "<string>",
"options": {
"rps": true,
"series": true,
"batchNumber": true,
"invoiceNumber": true,
"requiresNumberInSequence": true,
"federalServiceCode": true,
"nbsCode": true,
"cnaeCode": true,
"cityServiceCode": true,
"newBatchNumberForEachAttempt": true,
"removeAccents": true,
"supportsTaxReform": true,
"useNationalLayout": true,
"nationalTaxationCode": true,
"useSimplesNacionalAnnex": true,
"authentication": "certificate",
"requiresDigitalCertificate": true
}
},
"nationalServiceInvoiceRegimes": "none"
}
]
}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:
| Campo | Descrição |
|---|---|
rps | Exige numeração de RPS/DPS |
series | Exige série de RPS/DPS |
batchNumber | Exige número de lote |
requiresNumberInSequence | RPS/DPS deve ser enviado em sequência rigorosa |
requiresDigitalCertificate | Exige certificado digital |
federalServiceCode | Exige código do item da lista de serviços LC 116/03 |
nbsCode | Exige código NBS (Nomenclatura Brasileira de Serviços) |
cnaeCode | Exige código CNAE |
cityServiceCode | Exige o código do serviço no município |
supportsTaxReform | Suporta campos de IBS/CBS da Reforma Tributária |
useNationalLayout | Utiliza o layout do Ambiente Nacional da NFS-e |
authentication | Tipo 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 devolvido em provider no exemplo de emissão por município.
GET
/
v1
/
service-invoices
/
cities
Cidades integradas
curl --request GET \
--url https://api.spedy.com.br/v1/service-invoices/cities \
--header 'X-Api-Key: <api-key>'import requests
url = "https://api.spedy.com.br/v1/service-invoices/cities"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://api.spedy.com.br/v1/service-invoices/cities', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.spedy.com.br/v1/service-invoices/cities",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.spedy.com.br/v1/service-invoices/cities"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.spedy.com.br/v1/service-invoices/cities")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spedy.com.br/v1/service-invoices/cities")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"totalCount": 123,
"pageCount": 123,
"pageSize": 123,
"hasNext": true,
"items": [
{
"code": "<string>",
"name": "<string>",
"state": "<string>",
"provider": {
"code": "issNet",
"name": "<string>",
"options": {
"rps": true,
"series": true,
"batchNumber": true,
"invoiceNumber": true,
"requiresNumberInSequence": true,
"federalServiceCode": true,
"nbsCode": true,
"cnaeCode": true,
"cityServiceCode": true,
"newBatchNumberForEachAttempt": true,
"removeAccents": true,
"supportsTaxReform": true,
"useNationalLayout": true,
"nationalTaxationCode": true,
"useSimplesNacionalAnnex": true,
"authentication": "certificate",
"requiresDigitalCertificate": true
}
},
"nationalServiceInvoiceRegimes": "none"
}
]
}Authorizations
Authorization By X-Api-Key inside request's header
Query Parameters
Código
Estado
Valores possíveis:
- rO: Rondônia
- aC: Acre
- aM: Amazonas
- rR: Roraima
- pA: Pará
- aP: Amapá
- tO: Tocantins
- mA: Maranhão
- pI: Piauí
- cE: Ceará
- rN: Rio Grande do Norte
- pB: Paraíba
- pE: Pernambuco
- aL: Alagoas
- sE: Sergipe
- bA: Bahia
- mG: Minas Gerais
- eS: Espírito Santo
- rJ: Rio de Janeiro
- sP: São Paulo
- pR: Paraná
- sC: Santa Catarina
- rS: Rio Grande do Sul
- mS: Mato Grosso do Sul
- mT: Mato Grosso
- gO: Goiás
- dF: Distrito Federal
- aN: Ambiente Nacional
- eX: Exterior
Available options:
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