curl --request GET \
--url https://api.spedy.com.br/v1/service-invoices/cities/{cityCode}/payload-example \
--header 'X-Api-Key: <api-key>'import requests
url = "https://api.spedy.com.br/v1/service-invoices/cities/{cityCode}/payload-example"
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/{cityCode}/payload-example', 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/{cityCode}/payload-example",
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/{cityCode}/payload-example"
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/{cityCode}/payload-example")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spedy.com.br/v1/service-invoices/cities/{cityCode}/payload-example")
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{
"code": 123,
"name": "<string>",
"state": "<string>",
"examples": [
{
"provider": "issNet",
"sourceIssuedOn": "2023-11-07T05:31:56Z",
"payload": "<unknown>"
}
]
}Exemplo de emissão por município
Retorna um corpo de exemplo para a criação de NFS-e no município informado, com os códigos fiscais no formato que aquele município aceita.
Não existe formato único de código de serviço municipal no Brasil — em Goiânia é 1.01, em
Santos é 9700500, em São Bernardo do Campo é 1.01/102301. O exemplo carrega um valor real
de nota autorizada, e sourceIssuedOn informa a data dessa emissão.
Municípios que adotaram o Emissor Nacional para parte dos regimes devolvem dois
exemplos: um do provedor do município e outro com provider = nacional. Os regimes a que o
Emissor Nacional se aplica estão em nationalServiceInvoiceRegimes, na consulta de municípios
integrados — escolha pelo enquadramento da empresa que vai emitir.
O exemplo traz apenas campos que o provedor do município envia à prefeitura. Um campo ausente do exemplo pode ser enviado normalmente: ele é aceito e não tem efeito naquele município.
rpsNumber, rpsSeries e batchNumber aparecem nos provedores que os transmitem, mas só
devem ser enviados quando você controla a própria numeração. A série do exemplo é a mais usada
naquele provedor; envie a série cadastrada pela sua empresa na prefeitura. Quando omitidos, o
Spedy numera o RPS e o lote e usa a série configurada na empresa.
cstPisCofins não aparece nos exemplos porque depende do regime tributário da empresa: só é
necessário para empresas do Lucro Presumido ou Real que destacam PIS e COFINS na nota, em especial
quando o tomador retém. Quando omitido, o Spedy usa o CST configurado no grupo de tributação ou na
natureza de operação; no Emissor Nacional, sem essa configuração, envia 00 (nenhum).
examples vazio significa que o município é atendido, mas ainda não há exemplo publicado
para o provedor dele. A emissão funciona normalmente.
O exemplo é material de apoio: não valida nem bloqueia a emissão, e a responsabilidade pela informação fiscal declarada permanece do emissor.
curl --request GET \
--url https://api.spedy.com.br/v1/service-invoices/cities/{cityCode}/payload-example \
--header 'X-Api-Key: <api-key>'import requests
url = "https://api.spedy.com.br/v1/service-invoices/cities/{cityCode}/payload-example"
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/{cityCode}/payload-example', 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/{cityCode}/payload-example",
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/{cityCode}/payload-example"
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/{cityCode}/payload-example")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spedy.com.br/v1/service-invoices/cities/{cityCode}/payload-example")
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{
"code": 123,
"name": "<string>",
"state": "<string>",
"examples": [
{
"provider": "issNet",
"sourceIssuedOn": "2023-11-07T05:31:56Z",
"payload": "<unknown>"
}
]
}Authorizations
Authorization By X-Api-Key inside request's header