Alterar configurações
curl --request PUT \
--url https://api.spedy.com.br/v1/companies/{id}/settings \
--header 'Content-Type: application/json-patch+json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"serviceInvoice": {
"series": "<string>",
"userName": "<string>",
"password": "<string>",
"nextBatchNumber": 123,
"authNumber": "<string>",
"nextNumber": 123
},
"productInvoice": {
"series": "<string>",
"nextNumber": 123
},
"consumerInvoice": {
"series": "<string>",
"nextNumber": 123,
"tokenId": "<string>",
"csc": "<string>",
"allowOfflineContingency": true
},
"general": {
"allowDuplicateFederalTaxNumbers": false,
"allowNaturalPersonCompany": true,
"allowMultipleInvoiceModelsPerOrder": false,
"decimalPrecision": 2,
"taxReformFieldsEnabled": false
}
}
'import requests
url = "https://api.spedy.com.br/v1/companies/{id}/settings"
payload = {
"serviceInvoice": {
"series": "<string>",
"userName": "<string>",
"password": "<string>",
"nextBatchNumber": 123,
"authNumber": "<string>",
"nextNumber": 123
},
"productInvoice": {
"series": "<string>",
"nextNumber": 123
},
"consumerInvoice": {
"series": "<string>",
"nextNumber": 123,
"tokenId": "<string>",
"csc": "<string>",
"allowOfflineContingency": True
},
"general": {
"allowDuplicateFederalTaxNumbers": False,
"allowNaturalPersonCompany": True,
"allowMultipleInvoiceModelsPerOrder": False,
"decimalPrecision": 2,
"taxReformFieldsEnabled": False
}
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json-patch+json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
serviceInvoice: {
series: '<string>',
userName: '<string>',
password: '<string>',
nextBatchNumber: 123,
authNumber: '<string>',
nextNumber: 123
},
productInvoice: {series: '<string>', nextNumber: 123},
consumerInvoice: {
series: '<string>',
nextNumber: 123,
tokenId: '<string>',
csc: '<string>',
allowOfflineContingency: true
},
general: {
allowDuplicateFederalTaxNumbers: false,
allowNaturalPersonCompany: true,
allowMultipleInvoiceModelsPerOrder: false,
decimalPrecision: 2,
taxReformFieldsEnabled: false
}
})
};
fetch('https://api.spedy.com.br/v1/companies/{id}/settings', 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/companies/{id}/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'serviceInvoice' => [
'series' => '<string>',
'userName' => '<string>',
'password' => '<string>',
'nextBatchNumber' => 123,
'authNumber' => '<string>',
'nextNumber' => 123
],
'productInvoice' => [
'series' => '<string>',
'nextNumber' => 123
],
'consumerInvoice' => [
'series' => '<string>',
'nextNumber' => 123,
'tokenId' => '<string>',
'csc' => '<string>',
'allowOfflineContingency' => true
],
'general' => [
'allowDuplicateFederalTaxNumbers' => false,
'allowNaturalPersonCompany' => true,
'allowMultipleInvoiceModelsPerOrder' => false,
'decimalPrecision' => 2,
'taxReformFieldsEnabled' => false
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json-patch+json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.spedy.com.br/v1/companies/{id}/settings"
payload := strings.NewReader("{\n \"serviceInvoice\": {\n \"series\": \"<string>\",\n \"userName\": \"<string>\",\n \"password\": \"<string>\",\n \"nextBatchNumber\": 123,\n \"authNumber\": \"<string>\",\n \"nextNumber\": 123\n },\n \"productInvoice\": {\n \"series\": \"<string>\",\n \"nextNumber\": 123\n },\n \"consumerInvoice\": {\n \"series\": \"<string>\",\n \"nextNumber\": 123,\n \"tokenId\": \"<string>\",\n \"csc\": \"<string>\",\n \"allowOfflineContingency\": true\n },\n \"general\": {\n \"allowDuplicateFederalTaxNumbers\": false,\n \"allowNaturalPersonCompany\": true,\n \"allowMultipleInvoiceModelsPerOrder\": false,\n \"decimalPrecision\": 2,\n \"taxReformFieldsEnabled\": false\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.spedy.com.br/v1/companies/{id}/settings")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"serviceInvoice\": {\n \"series\": \"<string>\",\n \"userName\": \"<string>\",\n \"password\": \"<string>\",\n \"nextBatchNumber\": 123,\n \"authNumber\": \"<string>\",\n \"nextNumber\": 123\n },\n \"productInvoice\": {\n \"series\": \"<string>\",\n \"nextNumber\": 123\n },\n \"consumerInvoice\": {\n \"series\": \"<string>\",\n \"nextNumber\": 123,\n \"tokenId\": \"<string>\",\n \"csc\": \"<string>\",\n \"allowOfflineContingency\": true\n },\n \"general\": {\n \"allowDuplicateFederalTaxNumbers\": false,\n \"allowNaturalPersonCompany\": true,\n \"allowMultipleInvoiceModelsPerOrder\": false,\n \"decimalPrecision\": 2,\n \"taxReformFieldsEnabled\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spedy.com.br/v1/companies/{id}/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"serviceInvoice\": {\n \"series\": \"<string>\",\n \"userName\": \"<string>\",\n \"password\": \"<string>\",\n \"nextBatchNumber\": 123,\n \"authNumber\": \"<string>\",\n \"nextNumber\": 123\n },\n \"productInvoice\": {\n \"series\": \"<string>\",\n \"nextNumber\": 123\n },\n \"consumerInvoice\": {\n \"series\": \"<string>\",\n \"nextNumber\": 123,\n \"tokenId\": \"<string>\",\n \"csc\": \"<string>\",\n \"allowOfflineContingency\": true\n },\n \"general\": {\n \"allowDuplicateFederalTaxNumbers\": false,\n \"allowNaturalPersonCompany\": true,\n \"allowMultipleInvoiceModelsPerOrder\": false,\n \"decimalPrecision\": 2,\n \"taxReformFieldsEnabled\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"serviceInvoice": {
"series": "<string>",
"userName": "<string>",
"password": "<string>",
"nextBatchNumber": 123,
"authNumber": "<string>",
"nextNumber": 123
},
"productInvoice": {
"series": "<string>",
"nextNumber": 123
},
"consumerInvoice": {
"series": "<string>",
"nextNumber": 123,
"tokenId": "<string>",
"csc": "<string>",
"allowOfflineContingency": true
},
"general": {
"allowDuplicateFederalTaxNumbers": false,
"allowNaturalPersonCompany": true,
"allowMultipleInvoiceModelsPerOrder": false,
"decimalPrecision": 2,
"taxReformFieldsEnabled": false,
"technicalResponsible": {
"federalTaxNumber": "<string>",
"contactName": "<string>",
"email": "<string>",
"phone": "<string>",
"csrts": [
{
"idCsrt": 123,
"csrt": "<string>"
}
]
}
}
}Empresas
Alterar configurações
Atualiza as configurações de emissão da empresa, organizadas em quatro blocos independentes:
- general — comportamento geral e o responsável técnico (
infRespTecda NF-e/NFC-e), casas decimais dos valores e o flag de campos da Reforma Tributária. - productInvoice — emissão de NF-e: série, próxima numeração, ambiente e layout do DANFE.
- consumerInvoice — emissão de NFC-e: série, numeração, ambiente,
tokenId/csc(usados no QR Code) e contingência offline. - serviceInvoice — emissão de NFS-e: série, ambiente, tipo de emissão e credenciais do provedor municipal.
Cada bloco é independente: envie apenas o(s) que deseja atualizar (ex.: só serviceInvoice).
Configure apenas os modelos que a empresa realmente emite.
Guias relacionados: Configuração inicial (detalha cada bloco, o responsável técnico e a autorização de uso na SEFAZ), Emissão de NF-e, Emissão de NFC-e, Emissão de NFS-e e Regimes e códigos fiscais.
PUT
/
v1
/
companies
/
{id}
/
settings
Alterar configurações
curl --request PUT \
--url https://api.spedy.com.br/v1/companies/{id}/settings \
--header 'Content-Type: application/json-patch+json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"serviceInvoice": {
"series": "<string>",
"userName": "<string>",
"password": "<string>",
"nextBatchNumber": 123,
"authNumber": "<string>",
"nextNumber": 123
},
"productInvoice": {
"series": "<string>",
"nextNumber": 123
},
"consumerInvoice": {
"series": "<string>",
"nextNumber": 123,
"tokenId": "<string>",
"csc": "<string>",
"allowOfflineContingency": true
},
"general": {
"allowDuplicateFederalTaxNumbers": false,
"allowNaturalPersonCompany": true,
"allowMultipleInvoiceModelsPerOrder": false,
"decimalPrecision": 2,
"taxReformFieldsEnabled": false
}
}
'import requests
url = "https://api.spedy.com.br/v1/companies/{id}/settings"
payload = {
"serviceInvoice": {
"series": "<string>",
"userName": "<string>",
"password": "<string>",
"nextBatchNumber": 123,
"authNumber": "<string>",
"nextNumber": 123
},
"productInvoice": {
"series": "<string>",
"nextNumber": 123
},
"consumerInvoice": {
"series": "<string>",
"nextNumber": 123,
"tokenId": "<string>",
"csc": "<string>",
"allowOfflineContingency": True
},
"general": {
"allowDuplicateFederalTaxNumbers": False,
"allowNaturalPersonCompany": True,
"allowMultipleInvoiceModelsPerOrder": False,
"decimalPrecision": 2,
"taxReformFieldsEnabled": False
}
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json-patch+json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
serviceInvoice: {
series: '<string>',
userName: '<string>',
password: '<string>',
nextBatchNumber: 123,
authNumber: '<string>',
nextNumber: 123
},
productInvoice: {series: '<string>', nextNumber: 123},
consumerInvoice: {
series: '<string>',
nextNumber: 123,
tokenId: '<string>',
csc: '<string>',
allowOfflineContingency: true
},
general: {
allowDuplicateFederalTaxNumbers: false,
allowNaturalPersonCompany: true,
allowMultipleInvoiceModelsPerOrder: false,
decimalPrecision: 2,
taxReformFieldsEnabled: false
}
})
};
fetch('https://api.spedy.com.br/v1/companies/{id}/settings', 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/companies/{id}/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'serviceInvoice' => [
'series' => '<string>',
'userName' => '<string>',
'password' => '<string>',
'nextBatchNumber' => 123,
'authNumber' => '<string>',
'nextNumber' => 123
],
'productInvoice' => [
'series' => '<string>',
'nextNumber' => 123
],
'consumerInvoice' => [
'series' => '<string>',
'nextNumber' => 123,
'tokenId' => '<string>',
'csc' => '<string>',
'allowOfflineContingency' => true
],
'general' => [
'allowDuplicateFederalTaxNumbers' => false,
'allowNaturalPersonCompany' => true,
'allowMultipleInvoiceModelsPerOrder' => false,
'decimalPrecision' => 2,
'taxReformFieldsEnabled' => false
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json-patch+json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.spedy.com.br/v1/companies/{id}/settings"
payload := strings.NewReader("{\n \"serviceInvoice\": {\n \"series\": \"<string>\",\n \"userName\": \"<string>\",\n \"password\": \"<string>\",\n \"nextBatchNumber\": 123,\n \"authNumber\": \"<string>\",\n \"nextNumber\": 123\n },\n \"productInvoice\": {\n \"series\": \"<string>\",\n \"nextNumber\": 123\n },\n \"consumerInvoice\": {\n \"series\": \"<string>\",\n \"nextNumber\": 123,\n \"tokenId\": \"<string>\",\n \"csc\": \"<string>\",\n \"allowOfflineContingency\": true\n },\n \"general\": {\n \"allowDuplicateFederalTaxNumbers\": false,\n \"allowNaturalPersonCompany\": true,\n \"allowMultipleInvoiceModelsPerOrder\": false,\n \"decimalPrecision\": 2,\n \"taxReformFieldsEnabled\": false\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.spedy.com.br/v1/companies/{id}/settings")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"serviceInvoice\": {\n \"series\": \"<string>\",\n \"userName\": \"<string>\",\n \"password\": \"<string>\",\n \"nextBatchNumber\": 123,\n \"authNumber\": \"<string>\",\n \"nextNumber\": 123\n },\n \"productInvoice\": {\n \"series\": \"<string>\",\n \"nextNumber\": 123\n },\n \"consumerInvoice\": {\n \"series\": \"<string>\",\n \"nextNumber\": 123,\n \"tokenId\": \"<string>\",\n \"csc\": \"<string>\",\n \"allowOfflineContingency\": true\n },\n \"general\": {\n \"allowDuplicateFederalTaxNumbers\": false,\n \"allowNaturalPersonCompany\": true,\n \"allowMultipleInvoiceModelsPerOrder\": false,\n \"decimalPrecision\": 2,\n \"taxReformFieldsEnabled\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spedy.com.br/v1/companies/{id}/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"serviceInvoice\": {\n \"series\": \"<string>\",\n \"userName\": \"<string>\",\n \"password\": \"<string>\",\n \"nextBatchNumber\": 123,\n \"authNumber\": \"<string>\",\n \"nextNumber\": 123\n },\n \"productInvoice\": {\n \"series\": \"<string>\",\n \"nextNumber\": 123\n },\n \"consumerInvoice\": {\n \"series\": \"<string>\",\n \"nextNumber\": 123,\n \"tokenId\": \"<string>\",\n \"csc\": \"<string>\",\n \"allowOfflineContingency\": true\n },\n \"general\": {\n \"allowDuplicateFederalTaxNumbers\": false,\n \"allowNaturalPersonCompany\": true,\n \"allowMultipleInvoiceModelsPerOrder\": false,\n \"decimalPrecision\": 2,\n \"taxReformFieldsEnabled\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"serviceInvoice": {
"series": "<string>",
"userName": "<string>",
"password": "<string>",
"nextBatchNumber": 123,
"authNumber": "<string>",
"nextNumber": 123
},
"productInvoice": {
"series": "<string>",
"nextNumber": 123
},
"consumerInvoice": {
"series": "<string>",
"nextNumber": 123,
"tokenId": "<string>",
"csc": "<string>",
"allowOfflineContingency": true
},
"general": {
"allowDuplicateFederalTaxNumbers": false,
"allowNaturalPersonCompany": true,
"allowMultipleInvoiceModelsPerOrder": false,
"decimalPrecision": 2,
"taxReformFieldsEnabled": false,
"technicalResponsible": {
"federalTaxNumber": "<string>",
"contactName": "<string>",
"email": "<string>",
"phone": "<string>",
"csrts": [
{
"idCsrt": 123,
"csrt": "<string>"
}
]
}
}
}Authorizations
Authorization By X-Api-Key inside request's header
Path Parameters
ID da empresa
Body
application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Configurações NF-e/NFS-e
⌘I