Criar NFS-e
curl --request POST \
--url https://api.spedy.com.br/v1/service-invoices \
--header 'Content-Type: application/json-patch+json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"description": "<string>",
"total": {
"invoiceAmount": 123,
"netAmount": 123,
"issBaseTax": 123,
"irRate": 123,
"csllRate": 123,
"pisRate": 123,
"cofinsRate": 123,
"inssRate": 123,
"issRate": 123,
"issAmount": 123,
"discountUnconditionedAmount": 123,
"discountConditionedAmount": 123,
"irAmount": 123,
"pisCofinsBaseTax": 123,
"pisAmount": 123,
"cofinsAmount": 123,
"inssAmount": 123,
"csllAmount": 123,
"othersAmount": 123,
"deductionsAmount": 123,
"irWithheld": true,
"issWithheld": true,
"cofinsWithheld": true,
"inssWithheld": true,
"csllWithheld": true,
"pisWithheld": true,
"ibsStateRate": 123,
"ibsStateRedRate": 123,
"ibsCityRate": 123,
"ibsCityRedRate": 123,
"cbsRate": 123,
"cbsRedRate": 123,
"ibsCbsBaseTax": 123,
"ibsStateAmount": 123,
"ibsCityAmount": 123,
"ibsAmount": 123,
"cbsAmount": 123,
"receivedAmount": 123
},
"integrationId": "<string>",
"effectiveDate": "2023-11-07T05:31:56Z",
"receiver": {
"name": "<string>",
"federalTaxNumber": "<string>",
"stateTaxNumber": "<string>",
"suframaTaxNumber": "<string>",
"cityTaxNumber": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"name": "<string>",
"state": "<string>",
"code": 123
},
"country": "<string>"
}
},
"number": 123,
"additionalInformation": "<string>",
"sendEmailToCustomer": true,
"issue": true,
"batchNumber": 123,
"rpsNumber": 123,
"rpsSeries": "<string>",
"cnaeCode": "<string>",
"nbsCode": "<string>",
"federalServiceCode": "<string>",
"nationalTaxationCode": "<string>",
"cityServiceCode": "<string>",
"intermediary": {
"sellerRegistrationId": "<string>",
"name": "<string>",
"federalTaxNumber": "<string>",
"cityTaxNumber": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"name": "<string>",
"state": "<string>",
"code": 123
},
"country": "<string>"
}
},
"cstPisCofins": "<string>",
"simplesNacionalAnnex": "<string>",
"location": {
"code": 123,
"name": "<string>"
},
"ibsCbs": {
"cst": 123,
"classification": 123,
"operationIndicatorCode": "<string>",
"isPersonalUse": true,
"property": {
"fiscalPropertyTaxNumber": "<string>",
"cibCode": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"name": "<string>",
"state": "<string>",
"code": 123
},
"country": "<string>"
},
"location": {
"code": 123,
"name": "<string>"
}
}
},
"national": {
"municipalBenefit": {
"identification": "<string>"
},
"construction": {
"fiscalPropertyTaxNumber": "<string>",
"constructionCode": "<string>",
"cibCode": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"name": "<string>",
"state": "<string>",
"code": 123
},
"country": "<string>"
}
},
"event": {
"name": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"identifier": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"name": "<string>",
"state": "<string>",
"code": 123
},
"country": "<string>"
}
},
"suspensionProcessNumber": "<string>"
},
"approximateTaxes": {
"municipalRate": 123,
"stateRate": 123,
"federalRate": 123,
"simplesNacionalRate": 123,
"source": "<string>"
},
"foreignTrade": {
"amount": 123,
"currencyCode": "<string>",
"supportMechanismForServiceProvider": "<string>",
"supportMechanismForBorrower": "<string>",
"sendInvoiceToMdic": true
}
}
'import requests
url = "https://api.spedy.com.br/v1/service-invoices"
payload = {
"description": "<string>",
"total": {
"invoiceAmount": 123,
"netAmount": 123,
"issBaseTax": 123,
"irRate": 123,
"csllRate": 123,
"pisRate": 123,
"cofinsRate": 123,
"inssRate": 123,
"issRate": 123,
"issAmount": 123,
"discountUnconditionedAmount": 123,
"discountConditionedAmount": 123,
"irAmount": 123,
"pisCofinsBaseTax": 123,
"pisAmount": 123,
"cofinsAmount": 123,
"inssAmount": 123,
"csllAmount": 123,
"othersAmount": 123,
"deductionsAmount": 123,
"irWithheld": True,
"issWithheld": True,
"cofinsWithheld": True,
"inssWithheld": True,
"csllWithheld": True,
"pisWithheld": True,
"ibsStateRate": 123,
"ibsStateRedRate": 123,
"ibsCityRate": 123,
"ibsCityRedRate": 123,
"cbsRate": 123,
"cbsRedRate": 123,
"ibsCbsBaseTax": 123,
"ibsStateAmount": 123,
"ibsCityAmount": 123,
"ibsAmount": 123,
"cbsAmount": 123,
"receivedAmount": 123
},
"integrationId": "<string>",
"effectiveDate": "2023-11-07T05:31:56Z",
"receiver": {
"name": "<string>",
"federalTaxNumber": "<string>",
"stateTaxNumber": "<string>",
"suframaTaxNumber": "<string>",
"cityTaxNumber": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"name": "<string>",
"state": "<string>",
"code": 123
},
"country": "<string>"
}
},
"number": 123,
"additionalInformation": "<string>",
"sendEmailToCustomer": True,
"issue": True,
"batchNumber": 123,
"rpsNumber": 123,
"rpsSeries": "<string>",
"cnaeCode": "<string>",
"nbsCode": "<string>",
"federalServiceCode": "<string>",
"nationalTaxationCode": "<string>",
"cityServiceCode": "<string>",
"intermediary": {
"sellerRegistrationId": "<string>",
"name": "<string>",
"federalTaxNumber": "<string>",
"cityTaxNumber": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"name": "<string>",
"state": "<string>",
"code": 123
},
"country": "<string>"
}
},
"cstPisCofins": "<string>",
"simplesNacionalAnnex": "<string>",
"location": {
"code": 123,
"name": "<string>"
},
"ibsCbs": {
"cst": 123,
"classification": 123,
"operationIndicatorCode": "<string>",
"isPersonalUse": True,
"property": {
"fiscalPropertyTaxNumber": "<string>",
"cibCode": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"name": "<string>",
"state": "<string>",
"code": 123
},
"country": "<string>"
},
"location": {
"code": 123,
"name": "<string>"
}
}
},
"national": {
"municipalBenefit": { "identification": "<string>" },
"construction": {
"fiscalPropertyTaxNumber": "<string>",
"constructionCode": "<string>",
"cibCode": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"name": "<string>",
"state": "<string>",
"code": 123
},
"country": "<string>"
}
},
"event": {
"name": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"identifier": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"name": "<string>",
"state": "<string>",
"code": 123
},
"country": "<string>"
}
},
"suspensionProcessNumber": "<string>"
},
"approximateTaxes": {
"municipalRate": 123,
"stateRate": 123,
"federalRate": 123,
"simplesNacionalRate": 123,
"source": "<string>"
},
"foreignTrade": {
"amount": 123,
"currencyCode": "<string>",
"supportMechanismForServiceProvider": "<string>",
"supportMechanismForBorrower": "<string>",
"sendInvoiceToMdic": True
}
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json-patch+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
description: '<string>',
total: {
invoiceAmount: 123,
netAmount: 123,
issBaseTax: 123,
irRate: 123,
csllRate: 123,
pisRate: 123,
cofinsRate: 123,
inssRate: 123,
issRate: 123,
issAmount: 123,
discountUnconditionedAmount: 123,
discountConditionedAmount: 123,
irAmount: 123,
pisCofinsBaseTax: 123,
pisAmount: 123,
cofinsAmount: 123,
inssAmount: 123,
csllAmount: 123,
othersAmount: 123,
deductionsAmount: 123,
irWithheld: true,
issWithheld: true,
cofinsWithheld: true,
inssWithheld: true,
csllWithheld: true,
pisWithheld: true,
ibsStateRate: 123,
ibsStateRedRate: 123,
ibsCityRate: 123,
ibsCityRedRate: 123,
cbsRate: 123,
cbsRedRate: 123,
ibsCbsBaseTax: 123,
ibsStateAmount: 123,
ibsCityAmount: 123,
ibsAmount: 123,
cbsAmount: 123,
receivedAmount: 123
},
integrationId: '<string>',
effectiveDate: '2023-11-07T05:31:56Z',
receiver: {
name: '<string>',
federalTaxNumber: '<string>',
stateTaxNumber: '<string>',
suframaTaxNumber: '<string>',
cityTaxNumber: '<string>',
email: '<string>',
phoneNumber: '<string>',
address: {
street: '<string>',
district: '<string>',
postalCode: '<string>',
number: '<string>',
additionalInformation: '<string>',
city: {name: '<string>', state: '<string>', code: 123},
country: '<string>'
}
},
number: 123,
additionalInformation: '<string>',
sendEmailToCustomer: true,
issue: true,
batchNumber: 123,
rpsNumber: 123,
rpsSeries: '<string>',
cnaeCode: '<string>',
nbsCode: '<string>',
federalServiceCode: '<string>',
nationalTaxationCode: '<string>',
cityServiceCode: '<string>',
intermediary: {
sellerRegistrationId: '<string>',
name: '<string>',
federalTaxNumber: '<string>',
cityTaxNumber: '<string>',
email: '<string>',
phoneNumber: '<string>',
address: {
street: '<string>',
district: '<string>',
postalCode: '<string>',
number: '<string>',
additionalInformation: '<string>',
city: {name: '<string>', state: '<string>', code: 123},
country: '<string>'
}
},
cstPisCofins: '<string>',
simplesNacionalAnnex: '<string>',
location: {code: 123, name: '<string>'},
ibsCbs: {
cst: 123,
classification: 123,
operationIndicatorCode: '<string>',
isPersonalUse: true,
property: {
fiscalPropertyTaxNumber: '<string>',
cibCode: '<string>',
address: {
street: '<string>',
district: '<string>',
postalCode: '<string>',
number: '<string>',
additionalInformation: '<string>',
city: {name: '<string>', state: '<string>', code: 123},
country: '<string>'
},
location: {code: 123, name: '<string>'}
}
},
national: {
municipalBenefit: {identification: '<string>'},
construction: {
fiscalPropertyTaxNumber: '<string>',
constructionCode: '<string>',
cibCode: '<string>',
address: {
street: '<string>',
district: '<string>',
postalCode: '<string>',
number: '<string>',
additionalInformation: '<string>',
city: {name: '<string>', state: '<string>', code: 123},
country: '<string>'
}
},
event: {
name: '<string>',
startDate: '2023-11-07T05:31:56Z',
endDate: '2023-11-07T05:31:56Z',
identifier: '<string>',
address: {
street: '<string>',
district: '<string>',
postalCode: '<string>',
number: '<string>',
additionalInformation: '<string>',
city: {name: '<string>', state: '<string>', code: 123},
country: '<string>'
}
},
suspensionProcessNumber: '<string>'
},
approximateTaxes: {
municipalRate: 123,
stateRate: 123,
federalRate: 123,
simplesNacionalRate: 123,
source: '<string>'
},
foreignTrade: {
amount: 123,
currencyCode: '<string>',
supportMechanismForServiceProvider: '<string>',
supportMechanismForBorrower: '<string>',
sendInvoiceToMdic: true
}
})
};
fetch('https://api.spedy.com.br/v1/service-invoices', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>',
'total' => [
'invoiceAmount' => 123,
'netAmount' => 123,
'issBaseTax' => 123,
'irRate' => 123,
'csllRate' => 123,
'pisRate' => 123,
'cofinsRate' => 123,
'inssRate' => 123,
'issRate' => 123,
'issAmount' => 123,
'discountUnconditionedAmount' => 123,
'discountConditionedAmount' => 123,
'irAmount' => 123,
'pisCofinsBaseTax' => 123,
'pisAmount' => 123,
'cofinsAmount' => 123,
'inssAmount' => 123,
'csllAmount' => 123,
'othersAmount' => 123,
'deductionsAmount' => 123,
'irWithheld' => true,
'issWithheld' => true,
'cofinsWithheld' => true,
'inssWithheld' => true,
'csllWithheld' => true,
'pisWithheld' => true,
'ibsStateRate' => 123,
'ibsStateRedRate' => 123,
'ibsCityRate' => 123,
'ibsCityRedRate' => 123,
'cbsRate' => 123,
'cbsRedRate' => 123,
'ibsCbsBaseTax' => 123,
'ibsStateAmount' => 123,
'ibsCityAmount' => 123,
'ibsAmount' => 123,
'cbsAmount' => 123,
'receivedAmount' => 123
],
'integrationId' => '<string>',
'effectiveDate' => '2023-11-07T05:31:56Z',
'receiver' => [
'name' => '<string>',
'federalTaxNumber' => '<string>',
'stateTaxNumber' => '<string>',
'suframaTaxNumber' => '<string>',
'cityTaxNumber' => '<string>',
'email' => '<string>',
'phoneNumber' => '<string>',
'address' => [
'street' => '<string>',
'district' => '<string>',
'postalCode' => '<string>',
'number' => '<string>',
'additionalInformation' => '<string>',
'city' => [
'name' => '<string>',
'state' => '<string>',
'code' => 123
],
'country' => '<string>'
]
],
'number' => 123,
'additionalInformation' => '<string>',
'sendEmailToCustomer' => true,
'issue' => true,
'batchNumber' => 123,
'rpsNumber' => 123,
'rpsSeries' => '<string>',
'cnaeCode' => '<string>',
'nbsCode' => '<string>',
'federalServiceCode' => '<string>',
'nationalTaxationCode' => '<string>',
'cityServiceCode' => '<string>',
'intermediary' => [
'sellerRegistrationId' => '<string>',
'name' => '<string>',
'federalTaxNumber' => '<string>',
'cityTaxNumber' => '<string>',
'email' => '<string>',
'phoneNumber' => '<string>',
'address' => [
'street' => '<string>',
'district' => '<string>',
'postalCode' => '<string>',
'number' => '<string>',
'additionalInformation' => '<string>',
'city' => [
'name' => '<string>',
'state' => '<string>',
'code' => 123
],
'country' => '<string>'
]
],
'cstPisCofins' => '<string>',
'simplesNacionalAnnex' => '<string>',
'location' => [
'code' => 123,
'name' => '<string>'
],
'ibsCbs' => [
'cst' => 123,
'classification' => 123,
'operationIndicatorCode' => '<string>',
'isPersonalUse' => true,
'property' => [
'fiscalPropertyTaxNumber' => '<string>',
'cibCode' => '<string>',
'address' => [
'street' => '<string>',
'district' => '<string>',
'postalCode' => '<string>',
'number' => '<string>',
'additionalInformation' => '<string>',
'city' => [
'name' => '<string>',
'state' => '<string>',
'code' => 123
],
'country' => '<string>'
],
'location' => [
'code' => 123,
'name' => '<string>'
]
]
],
'national' => [
'municipalBenefit' => [
'identification' => '<string>'
],
'construction' => [
'fiscalPropertyTaxNumber' => '<string>',
'constructionCode' => '<string>',
'cibCode' => '<string>',
'address' => [
'street' => '<string>',
'district' => '<string>',
'postalCode' => '<string>',
'number' => '<string>',
'additionalInformation' => '<string>',
'city' => [
'name' => '<string>',
'state' => '<string>',
'code' => 123
],
'country' => '<string>'
]
],
'event' => [
'name' => '<string>',
'startDate' => '2023-11-07T05:31:56Z',
'endDate' => '2023-11-07T05:31:56Z',
'identifier' => '<string>',
'address' => [
'street' => '<string>',
'district' => '<string>',
'postalCode' => '<string>',
'number' => '<string>',
'additionalInformation' => '<string>',
'city' => [
'name' => '<string>',
'state' => '<string>',
'code' => 123
],
'country' => '<string>'
]
],
'suspensionProcessNumber' => '<string>'
],
'approximateTaxes' => [
'municipalRate' => 123,
'stateRate' => 123,
'federalRate' => 123,
'simplesNacionalRate' => 123,
'source' => '<string>'
],
'foreignTrade' => [
'amount' => 123,
'currencyCode' => '<string>',
'supportMechanismForServiceProvider' => '<string>',
'supportMechanismForBorrower' => '<string>',
'sendInvoiceToMdic' => true
]
]),
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/service-invoices"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"total\": {\n \"invoiceAmount\": 123,\n \"netAmount\": 123,\n \"issBaseTax\": 123,\n \"irRate\": 123,\n \"csllRate\": 123,\n \"pisRate\": 123,\n \"cofinsRate\": 123,\n \"inssRate\": 123,\n \"issRate\": 123,\n \"issAmount\": 123,\n \"discountUnconditionedAmount\": 123,\n \"discountConditionedAmount\": 123,\n \"irAmount\": 123,\n \"pisCofinsBaseTax\": 123,\n \"pisAmount\": 123,\n \"cofinsAmount\": 123,\n \"inssAmount\": 123,\n \"csllAmount\": 123,\n \"othersAmount\": 123,\n \"deductionsAmount\": 123,\n \"irWithheld\": true,\n \"issWithheld\": true,\n \"cofinsWithheld\": true,\n \"inssWithheld\": true,\n \"csllWithheld\": true,\n \"pisWithheld\": true,\n \"ibsStateRate\": 123,\n \"ibsStateRedRate\": 123,\n \"ibsCityRate\": 123,\n \"ibsCityRedRate\": 123,\n \"cbsRate\": 123,\n \"cbsRedRate\": 123,\n \"ibsCbsBaseTax\": 123,\n \"ibsStateAmount\": 123,\n \"ibsCityAmount\": 123,\n \"ibsAmount\": 123,\n \"cbsAmount\": 123,\n \"receivedAmount\": 123\n },\n \"integrationId\": \"<string>\",\n \"effectiveDate\": \"2023-11-07T05:31:56Z\",\n \"receiver\": {\n \"name\": \"<string>\",\n \"federalTaxNumber\": \"<string>\",\n \"stateTaxNumber\": \"<string>\",\n \"suframaTaxNumber\": \"<string>\",\n \"cityTaxNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"code\": 123\n },\n \"country\": \"<string>\"\n }\n },\n \"number\": 123,\n \"additionalInformation\": \"<string>\",\n \"sendEmailToCustomer\": true,\n \"issue\": true,\n \"batchNumber\": 123,\n \"rpsNumber\": 123,\n \"rpsSeries\": \"<string>\",\n \"cnaeCode\": \"<string>\",\n \"nbsCode\": \"<string>\",\n \"federalServiceCode\": \"<string>\",\n \"nationalTaxationCode\": \"<string>\",\n \"cityServiceCode\": \"<string>\",\n \"intermediary\": {\n \"sellerRegistrationId\": \"<string>\",\n \"name\": \"<string>\",\n \"federalTaxNumber\": \"<string>\",\n \"cityTaxNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"code\": 123\n },\n \"country\": \"<string>\"\n }\n },\n \"cstPisCofins\": \"<string>\",\n \"simplesNacionalAnnex\": \"<string>\",\n \"location\": {\n \"code\": 123,\n \"name\": \"<string>\"\n },\n \"ibsCbs\": {\n \"cst\": 123,\n \"classification\": 123,\n \"operationIndicatorCode\": \"<string>\",\n \"isPersonalUse\": true,\n \"property\": {\n \"fiscalPropertyTaxNumber\": \"<string>\",\n \"cibCode\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"code\": 123\n },\n \"country\": \"<string>\"\n },\n \"location\": {\n \"code\": 123,\n \"name\": \"<string>\"\n }\n }\n },\n \"national\": {\n \"municipalBenefit\": {\n \"identification\": \"<string>\"\n },\n \"construction\": {\n \"fiscalPropertyTaxNumber\": \"<string>\",\n \"constructionCode\": \"<string>\",\n \"cibCode\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"code\": 123\n },\n \"country\": \"<string>\"\n }\n },\n \"event\": {\n \"name\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"identifier\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"code\": 123\n },\n \"country\": \"<string>\"\n }\n },\n \"suspensionProcessNumber\": \"<string>\"\n },\n \"approximateTaxes\": {\n \"municipalRate\": 123,\n \"stateRate\": 123,\n \"federalRate\": 123,\n \"simplesNacionalRate\": 123,\n \"source\": \"<string>\"\n },\n \"foreignTrade\": {\n \"amount\": 123,\n \"currencyCode\": \"<string>\",\n \"supportMechanismForServiceProvider\": \"<string>\",\n \"supportMechanismForBorrower\": \"<string>\",\n \"sendInvoiceToMdic\": true\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.spedy.com.br/v1/service-invoices")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"description\": \"<string>\",\n \"total\": {\n \"invoiceAmount\": 123,\n \"netAmount\": 123,\n \"issBaseTax\": 123,\n \"irRate\": 123,\n \"csllRate\": 123,\n \"pisRate\": 123,\n \"cofinsRate\": 123,\n \"inssRate\": 123,\n \"issRate\": 123,\n \"issAmount\": 123,\n \"discountUnconditionedAmount\": 123,\n \"discountConditionedAmount\": 123,\n \"irAmount\": 123,\n \"pisCofinsBaseTax\": 123,\n \"pisAmount\": 123,\n \"cofinsAmount\": 123,\n \"inssAmount\": 123,\n \"csllAmount\": 123,\n \"othersAmount\": 123,\n \"deductionsAmount\": 123,\n \"irWithheld\": true,\n \"issWithheld\": true,\n \"cofinsWithheld\": true,\n \"inssWithheld\": true,\n \"csllWithheld\": true,\n \"pisWithheld\": true,\n \"ibsStateRate\": 123,\n \"ibsStateRedRate\": 123,\n \"ibsCityRate\": 123,\n \"ibsCityRedRate\": 123,\n \"cbsRate\": 123,\n \"cbsRedRate\": 123,\n \"ibsCbsBaseTax\": 123,\n \"ibsStateAmount\": 123,\n \"ibsCityAmount\": 123,\n \"ibsAmount\": 123,\n \"cbsAmount\": 123,\n \"receivedAmount\": 123\n },\n \"integrationId\": \"<string>\",\n \"effectiveDate\": \"2023-11-07T05:31:56Z\",\n \"receiver\": {\n \"name\": \"<string>\",\n \"federalTaxNumber\": \"<string>\",\n \"stateTaxNumber\": \"<string>\",\n \"suframaTaxNumber\": \"<string>\",\n \"cityTaxNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"code\": 123\n },\n \"country\": \"<string>\"\n }\n },\n \"number\": 123,\n \"additionalInformation\": \"<string>\",\n \"sendEmailToCustomer\": true,\n \"issue\": true,\n \"batchNumber\": 123,\n \"rpsNumber\": 123,\n \"rpsSeries\": \"<string>\",\n \"cnaeCode\": \"<string>\",\n \"nbsCode\": \"<string>\",\n \"federalServiceCode\": \"<string>\",\n \"nationalTaxationCode\": \"<string>\",\n \"cityServiceCode\": \"<string>\",\n \"intermediary\": {\n \"sellerRegistrationId\": \"<string>\",\n \"name\": \"<string>\",\n \"federalTaxNumber\": \"<string>\",\n \"cityTaxNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"code\": 123\n },\n \"country\": \"<string>\"\n }\n },\n \"cstPisCofins\": \"<string>\",\n \"simplesNacionalAnnex\": \"<string>\",\n \"location\": {\n \"code\": 123,\n \"name\": \"<string>\"\n },\n \"ibsCbs\": {\n \"cst\": 123,\n \"classification\": 123,\n \"operationIndicatorCode\": \"<string>\",\n \"isPersonalUse\": true,\n \"property\": {\n \"fiscalPropertyTaxNumber\": \"<string>\",\n \"cibCode\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"code\": 123\n },\n \"country\": \"<string>\"\n },\n \"location\": {\n \"code\": 123,\n \"name\": \"<string>\"\n }\n }\n },\n \"national\": {\n \"municipalBenefit\": {\n \"identification\": \"<string>\"\n },\n \"construction\": {\n \"fiscalPropertyTaxNumber\": \"<string>\",\n \"constructionCode\": \"<string>\",\n \"cibCode\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"code\": 123\n },\n \"country\": \"<string>\"\n }\n },\n \"event\": {\n \"name\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"identifier\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"code\": 123\n },\n \"country\": \"<string>\"\n }\n },\n \"suspensionProcessNumber\": \"<string>\"\n },\n \"approximateTaxes\": {\n \"municipalRate\": 123,\n \"stateRate\": 123,\n \"federalRate\": 123,\n \"simplesNacionalRate\": 123,\n \"source\": \"<string>\"\n },\n \"foreignTrade\": {\n \"amount\": 123,\n \"currencyCode\": \"<string>\",\n \"supportMechanismForServiceProvider\": \"<string>\",\n \"supportMechanismForBorrower\": \"<string>\",\n \"sendInvoiceToMdic\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spedy.com.br/v1/service-invoices")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"description\": \"<string>\",\n \"total\": {\n \"invoiceAmount\": 123,\n \"netAmount\": 123,\n \"issBaseTax\": 123,\n \"irRate\": 123,\n \"csllRate\": 123,\n \"pisRate\": 123,\n \"cofinsRate\": 123,\n \"inssRate\": 123,\n \"issRate\": 123,\n \"issAmount\": 123,\n \"discountUnconditionedAmount\": 123,\n \"discountConditionedAmount\": 123,\n \"irAmount\": 123,\n \"pisCofinsBaseTax\": 123,\n \"pisAmount\": 123,\n \"cofinsAmount\": 123,\n \"inssAmount\": 123,\n \"csllAmount\": 123,\n \"othersAmount\": 123,\n \"deductionsAmount\": 123,\n \"irWithheld\": true,\n \"issWithheld\": true,\n \"cofinsWithheld\": true,\n \"inssWithheld\": true,\n \"csllWithheld\": true,\n \"pisWithheld\": true,\n \"ibsStateRate\": 123,\n \"ibsStateRedRate\": 123,\n \"ibsCityRate\": 123,\n \"ibsCityRedRate\": 123,\n \"cbsRate\": 123,\n \"cbsRedRate\": 123,\n \"ibsCbsBaseTax\": 123,\n \"ibsStateAmount\": 123,\n \"ibsCityAmount\": 123,\n \"ibsAmount\": 123,\n \"cbsAmount\": 123,\n \"receivedAmount\": 123\n },\n \"integrationId\": \"<string>\",\n \"effectiveDate\": \"2023-11-07T05:31:56Z\",\n \"receiver\": {\n \"name\": \"<string>\",\n \"federalTaxNumber\": \"<string>\",\n \"stateTaxNumber\": \"<string>\",\n \"suframaTaxNumber\": \"<string>\",\n \"cityTaxNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"code\": 123\n },\n \"country\": \"<string>\"\n }\n },\n \"number\": 123,\n \"additionalInformation\": \"<string>\",\n \"sendEmailToCustomer\": true,\n \"issue\": true,\n \"batchNumber\": 123,\n \"rpsNumber\": 123,\n \"rpsSeries\": \"<string>\",\n \"cnaeCode\": \"<string>\",\n \"nbsCode\": \"<string>\",\n \"federalServiceCode\": \"<string>\",\n \"nationalTaxationCode\": \"<string>\",\n \"cityServiceCode\": \"<string>\",\n \"intermediary\": {\n \"sellerRegistrationId\": \"<string>\",\n \"name\": \"<string>\",\n \"federalTaxNumber\": \"<string>\",\n \"cityTaxNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"code\": 123\n },\n \"country\": \"<string>\"\n }\n },\n \"cstPisCofins\": \"<string>\",\n \"simplesNacionalAnnex\": \"<string>\",\n \"location\": {\n \"code\": 123,\n \"name\": \"<string>\"\n },\n \"ibsCbs\": {\n \"cst\": 123,\n \"classification\": 123,\n \"operationIndicatorCode\": \"<string>\",\n \"isPersonalUse\": true,\n \"property\": {\n \"fiscalPropertyTaxNumber\": \"<string>\",\n \"cibCode\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"code\": 123\n },\n \"country\": \"<string>\"\n },\n \"location\": {\n \"code\": 123,\n \"name\": \"<string>\"\n }\n }\n },\n \"national\": {\n \"municipalBenefit\": {\n \"identification\": \"<string>\"\n },\n \"construction\": {\n \"fiscalPropertyTaxNumber\": \"<string>\",\n \"constructionCode\": \"<string>\",\n \"cibCode\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"code\": 123\n },\n \"country\": \"<string>\"\n }\n },\n \"event\": {\n \"name\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"identifier\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"code\": 123\n },\n \"country\": \"<string>\"\n }\n },\n \"suspensionProcessNumber\": \"<string>\"\n },\n \"approximateTaxes\": {\n \"municipalRate\": 123,\n \"stateRate\": 123,\n \"federalRate\": 123,\n \"simplesNacionalRate\": 123,\n \"source\": \"<string>\"\n },\n \"foreignTrade\": {\n \"amount\": 123,\n \"currencyCode\": \"<string>\",\n \"supportMechanismForServiceProvider\": \"<string>\",\n \"supportMechanismForBorrower\": \"<string>\",\n \"sendInvoiceToMdic\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"integrationId": "<string>",
"status": "created",
"model": "productInvoice",
"environmentType": "production",
"issuedOn": "2023-11-07T05:31:56Z",
"effectiveDate": "2023-11-07T05:31:56Z",
"receiver": {
"name": "<string>",
"federalTaxNumber": "<string>",
"stateTaxNumber": "<string>",
"suframaTaxNumber": "<string>",
"cityTaxNumber": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"name": "<string>",
"state": "<string>",
"code": 123
},
"country": "<string>"
}
},
"company": {
"name": "<string>",
"legalName": "<string>",
"federalTaxNumber": "<string>",
"stateTaxNumber": "<string>",
"cityTaxNumber": "<string>"
},
"order": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"date": "2023-11-07T05:31:56Z",
"transactionId": "<string>"
},
"authorization": {
"date": "2023-11-07T05:31:56Z",
"protocol": "<string>",
"digestValue": "<string>"
},
"cancellation": {
"date": "2023-11-07T05:31:56Z",
"protocol": "<string>",
"justification": "<string>"
},
"amount": 123,
"number": 123,
"processingDetail": {
"status": "processing",
"message": "<string>",
"code": "<string>",
"on": "2023-11-07T05:31:56Z"
},
"isFromApi": true,
"description": "<string>",
"totals": {
"invoiceAmount": 123,
"netAmount": 123,
"issBaseTax": 123,
"irRate": 123,
"csllRate": 123,
"pisRate": 123,
"cofinsRate": 123,
"inssRate": 123,
"issRate": 123,
"issAmount": 123,
"discountUnconditionedAmount": 123,
"discountConditionedAmount": 123,
"irAmount": 123,
"pisCofinsBaseTax": 123,
"pisAmount": 123,
"cofinsAmount": 123,
"inssAmount": 123,
"csllAmount": 123,
"othersAmount": 123,
"deductionsAmount": 123,
"irWithheld": true,
"issWithheld": true,
"cofinsWithheld": true,
"inssWithheld": true,
"csllWithheld": true,
"pisWithheld": true,
"ibsStateRate": 123,
"ibsStateRedRate": 123,
"ibsCityRate": 123,
"ibsCityRedRate": 123,
"cbsRate": 123,
"cbsRedRate": 123,
"ibsCbsBaseTax": 123,
"ibsStateAmount": 123,
"ibsCityAmount": 123,
"ibsAmount": 123,
"cbsAmount": 123,
"receivedAmount": 123
},
"rps": {
"number": 123,
"series": "<string>"
},
"location": {
"code": 123,
"name": "<string>",
"state": "ro"
},
"ibsCbs": {
"cst": 123,
"classification": 123,
"operationIndicatorCode": "<string>",
"isPersonalUse": true,
"operationType": "supplyWithSubsequentPayment",
"governmentEntityType": "union",
"property": {
"fiscalPropertyTaxNumber": "<string>",
"cibCode": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"name": "<string>",
"state": "<string>",
"code": 123
},
"country": "<string>"
},
"location": {
"code": 123,
"name": "<string>",
"state": "ro"
}
}
},
"nbsCode": "<string>",
"nationalTaxationCode": "<string>",
"batchNumber": 123,
"approximateTaxes": {
"federalAmount": 123,
"federalRate": 123,
"municipalRate": 123,
"municipalAmount": 123,
"stateAmount": 123,
"stateRate": 123,
"amount": 123,
"rate": 123,
"version": "<string>",
"source": "<string>",
"mode": "disabled"
},
"foreignTrade": {
"amount": 123,
"currencyCode": "<string>",
"serviceProvisionMode": "unknown",
"relationshipBetweenParties": "withoutLink",
"supportMechanismForServiceProvider": "<string>",
"supportMechanismForBorrower": "<string>",
"relationshipBetweenOperationAndTemporaryMovement": "unknown",
"sendInvoiceToMdic": true
}
}NFS-e
Criar NFS-e
Cria uma NFS-e (nota de serviço) e a enfileira para emissão junto à prefeitura/provedor
municipal. A emissão é assíncrona: a resposta 2xx confirma que a solicitação foi aceita, não
que a nota foi autorizada — acompanhe o resultado por webhook ou consulta.
integrationId — Identificador da nota no seu sistema (máx. 36 caracteres). Recomendado em todas as integrações:
- Associação: vincula a NFS-e gerada pela Spedy a um ID do seu sistema (ex: ID do pedido)
- Idempotência: um segundo POST com o mesmo
integrationIdatualiza a nota existente em vez de criar uma nova — protege contra duplicidade em retries e timeouts - Correção de rejeitada: para corrigir uma NFS-e rejeitada, reenvie o POST com os dados corrigidos e o mesmo
integrationId— sem necessidade de deletar a nota anterior
POST
/
v1
/
service-invoices
Criar NFS-e
curl --request POST \
--url https://api.spedy.com.br/v1/service-invoices \
--header 'Content-Type: application/json-patch+json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"description": "<string>",
"total": {
"invoiceAmount": 123,
"netAmount": 123,
"issBaseTax": 123,
"irRate": 123,
"csllRate": 123,
"pisRate": 123,
"cofinsRate": 123,
"inssRate": 123,
"issRate": 123,
"issAmount": 123,
"discountUnconditionedAmount": 123,
"discountConditionedAmount": 123,
"irAmount": 123,
"pisCofinsBaseTax": 123,
"pisAmount": 123,
"cofinsAmount": 123,
"inssAmount": 123,
"csllAmount": 123,
"othersAmount": 123,
"deductionsAmount": 123,
"irWithheld": true,
"issWithheld": true,
"cofinsWithheld": true,
"inssWithheld": true,
"csllWithheld": true,
"pisWithheld": true,
"ibsStateRate": 123,
"ibsStateRedRate": 123,
"ibsCityRate": 123,
"ibsCityRedRate": 123,
"cbsRate": 123,
"cbsRedRate": 123,
"ibsCbsBaseTax": 123,
"ibsStateAmount": 123,
"ibsCityAmount": 123,
"ibsAmount": 123,
"cbsAmount": 123,
"receivedAmount": 123
},
"integrationId": "<string>",
"effectiveDate": "2023-11-07T05:31:56Z",
"receiver": {
"name": "<string>",
"federalTaxNumber": "<string>",
"stateTaxNumber": "<string>",
"suframaTaxNumber": "<string>",
"cityTaxNumber": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"name": "<string>",
"state": "<string>",
"code": 123
},
"country": "<string>"
}
},
"number": 123,
"additionalInformation": "<string>",
"sendEmailToCustomer": true,
"issue": true,
"batchNumber": 123,
"rpsNumber": 123,
"rpsSeries": "<string>",
"cnaeCode": "<string>",
"nbsCode": "<string>",
"federalServiceCode": "<string>",
"nationalTaxationCode": "<string>",
"cityServiceCode": "<string>",
"intermediary": {
"sellerRegistrationId": "<string>",
"name": "<string>",
"federalTaxNumber": "<string>",
"cityTaxNumber": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"name": "<string>",
"state": "<string>",
"code": 123
},
"country": "<string>"
}
},
"cstPisCofins": "<string>",
"simplesNacionalAnnex": "<string>",
"location": {
"code": 123,
"name": "<string>"
},
"ibsCbs": {
"cst": 123,
"classification": 123,
"operationIndicatorCode": "<string>",
"isPersonalUse": true,
"property": {
"fiscalPropertyTaxNumber": "<string>",
"cibCode": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"name": "<string>",
"state": "<string>",
"code": 123
},
"country": "<string>"
},
"location": {
"code": 123,
"name": "<string>"
}
}
},
"national": {
"municipalBenefit": {
"identification": "<string>"
},
"construction": {
"fiscalPropertyTaxNumber": "<string>",
"constructionCode": "<string>",
"cibCode": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"name": "<string>",
"state": "<string>",
"code": 123
},
"country": "<string>"
}
},
"event": {
"name": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"identifier": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"name": "<string>",
"state": "<string>",
"code": 123
},
"country": "<string>"
}
},
"suspensionProcessNumber": "<string>"
},
"approximateTaxes": {
"municipalRate": 123,
"stateRate": 123,
"federalRate": 123,
"simplesNacionalRate": 123,
"source": "<string>"
},
"foreignTrade": {
"amount": 123,
"currencyCode": "<string>",
"supportMechanismForServiceProvider": "<string>",
"supportMechanismForBorrower": "<string>",
"sendInvoiceToMdic": true
}
}
'import requests
url = "https://api.spedy.com.br/v1/service-invoices"
payload = {
"description": "<string>",
"total": {
"invoiceAmount": 123,
"netAmount": 123,
"issBaseTax": 123,
"irRate": 123,
"csllRate": 123,
"pisRate": 123,
"cofinsRate": 123,
"inssRate": 123,
"issRate": 123,
"issAmount": 123,
"discountUnconditionedAmount": 123,
"discountConditionedAmount": 123,
"irAmount": 123,
"pisCofinsBaseTax": 123,
"pisAmount": 123,
"cofinsAmount": 123,
"inssAmount": 123,
"csllAmount": 123,
"othersAmount": 123,
"deductionsAmount": 123,
"irWithheld": True,
"issWithheld": True,
"cofinsWithheld": True,
"inssWithheld": True,
"csllWithheld": True,
"pisWithheld": True,
"ibsStateRate": 123,
"ibsStateRedRate": 123,
"ibsCityRate": 123,
"ibsCityRedRate": 123,
"cbsRate": 123,
"cbsRedRate": 123,
"ibsCbsBaseTax": 123,
"ibsStateAmount": 123,
"ibsCityAmount": 123,
"ibsAmount": 123,
"cbsAmount": 123,
"receivedAmount": 123
},
"integrationId": "<string>",
"effectiveDate": "2023-11-07T05:31:56Z",
"receiver": {
"name": "<string>",
"federalTaxNumber": "<string>",
"stateTaxNumber": "<string>",
"suframaTaxNumber": "<string>",
"cityTaxNumber": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"name": "<string>",
"state": "<string>",
"code": 123
},
"country": "<string>"
}
},
"number": 123,
"additionalInformation": "<string>",
"sendEmailToCustomer": True,
"issue": True,
"batchNumber": 123,
"rpsNumber": 123,
"rpsSeries": "<string>",
"cnaeCode": "<string>",
"nbsCode": "<string>",
"federalServiceCode": "<string>",
"nationalTaxationCode": "<string>",
"cityServiceCode": "<string>",
"intermediary": {
"sellerRegistrationId": "<string>",
"name": "<string>",
"federalTaxNumber": "<string>",
"cityTaxNumber": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"name": "<string>",
"state": "<string>",
"code": 123
},
"country": "<string>"
}
},
"cstPisCofins": "<string>",
"simplesNacionalAnnex": "<string>",
"location": {
"code": 123,
"name": "<string>"
},
"ibsCbs": {
"cst": 123,
"classification": 123,
"operationIndicatorCode": "<string>",
"isPersonalUse": True,
"property": {
"fiscalPropertyTaxNumber": "<string>",
"cibCode": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"name": "<string>",
"state": "<string>",
"code": 123
},
"country": "<string>"
},
"location": {
"code": 123,
"name": "<string>"
}
}
},
"national": {
"municipalBenefit": { "identification": "<string>" },
"construction": {
"fiscalPropertyTaxNumber": "<string>",
"constructionCode": "<string>",
"cibCode": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"name": "<string>",
"state": "<string>",
"code": 123
},
"country": "<string>"
}
},
"event": {
"name": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"identifier": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"name": "<string>",
"state": "<string>",
"code": 123
},
"country": "<string>"
}
},
"suspensionProcessNumber": "<string>"
},
"approximateTaxes": {
"municipalRate": 123,
"stateRate": 123,
"federalRate": 123,
"simplesNacionalRate": 123,
"source": "<string>"
},
"foreignTrade": {
"amount": 123,
"currencyCode": "<string>",
"supportMechanismForServiceProvider": "<string>",
"supportMechanismForBorrower": "<string>",
"sendInvoiceToMdic": True
}
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json-patch+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
description: '<string>',
total: {
invoiceAmount: 123,
netAmount: 123,
issBaseTax: 123,
irRate: 123,
csllRate: 123,
pisRate: 123,
cofinsRate: 123,
inssRate: 123,
issRate: 123,
issAmount: 123,
discountUnconditionedAmount: 123,
discountConditionedAmount: 123,
irAmount: 123,
pisCofinsBaseTax: 123,
pisAmount: 123,
cofinsAmount: 123,
inssAmount: 123,
csllAmount: 123,
othersAmount: 123,
deductionsAmount: 123,
irWithheld: true,
issWithheld: true,
cofinsWithheld: true,
inssWithheld: true,
csllWithheld: true,
pisWithheld: true,
ibsStateRate: 123,
ibsStateRedRate: 123,
ibsCityRate: 123,
ibsCityRedRate: 123,
cbsRate: 123,
cbsRedRate: 123,
ibsCbsBaseTax: 123,
ibsStateAmount: 123,
ibsCityAmount: 123,
ibsAmount: 123,
cbsAmount: 123,
receivedAmount: 123
},
integrationId: '<string>',
effectiveDate: '2023-11-07T05:31:56Z',
receiver: {
name: '<string>',
federalTaxNumber: '<string>',
stateTaxNumber: '<string>',
suframaTaxNumber: '<string>',
cityTaxNumber: '<string>',
email: '<string>',
phoneNumber: '<string>',
address: {
street: '<string>',
district: '<string>',
postalCode: '<string>',
number: '<string>',
additionalInformation: '<string>',
city: {name: '<string>', state: '<string>', code: 123},
country: '<string>'
}
},
number: 123,
additionalInformation: '<string>',
sendEmailToCustomer: true,
issue: true,
batchNumber: 123,
rpsNumber: 123,
rpsSeries: '<string>',
cnaeCode: '<string>',
nbsCode: '<string>',
federalServiceCode: '<string>',
nationalTaxationCode: '<string>',
cityServiceCode: '<string>',
intermediary: {
sellerRegistrationId: '<string>',
name: '<string>',
federalTaxNumber: '<string>',
cityTaxNumber: '<string>',
email: '<string>',
phoneNumber: '<string>',
address: {
street: '<string>',
district: '<string>',
postalCode: '<string>',
number: '<string>',
additionalInformation: '<string>',
city: {name: '<string>', state: '<string>', code: 123},
country: '<string>'
}
},
cstPisCofins: '<string>',
simplesNacionalAnnex: '<string>',
location: {code: 123, name: '<string>'},
ibsCbs: {
cst: 123,
classification: 123,
operationIndicatorCode: '<string>',
isPersonalUse: true,
property: {
fiscalPropertyTaxNumber: '<string>',
cibCode: '<string>',
address: {
street: '<string>',
district: '<string>',
postalCode: '<string>',
number: '<string>',
additionalInformation: '<string>',
city: {name: '<string>', state: '<string>', code: 123},
country: '<string>'
},
location: {code: 123, name: '<string>'}
}
},
national: {
municipalBenefit: {identification: '<string>'},
construction: {
fiscalPropertyTaxNumber: '<string>',
constructionCode: '<string>',
cibCode: '<string>',
address: {
street: '<string>',
district: '<string>',
postalCode: '<string>',
number: '<string>',
additionalInformation: '<string>',
city: {name: '<string>', state: '<string>', code: 123},
country: '<string>'
}
},
event: {
name: '<string>',
startDate: '2023-11-07T05:31:56Z',
endDate: '2023-11-07T05:31:56Z',
identifier: '<string>',
address: {
street: '<string>',
district: '<string>',
postalCode: '<string>',
number: '<string>',
additionalInformation: '<string>',
city: {name: '<string>', state: '<string>', code: 123},
country: '<string>'
}
},
suspensionProcessNumber: '<string>'
},
approximateTaxes: {
municipalRate: 123,
stateRate: 123,
federalRate: 123,
simplesNacionalRate: 123,
source: '<string>'
},
foreignTrade: {
amount: 123,
currencyCode: '<string>',
supportMechanismForServiceProvider: '<string>',
supportMechanismForBorrower: '<string>',
sendInvoiceToMdic: true
}
})
};
fetch('https://api.spedy.com.br/v1/service-invoices', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>',
'total' => [
'invoiceAmount' => 123,
'netAmount' => 123,
'issBaseTax' => 123,
'irRate' => 123,
'csllRate' => 123,
'pisRate' => 123,
'cofinsRate' => 123,
'inssRate' => 123,
'issRate' => 123,
'issAmount' => 123,
'discountUnconditionedAmount' => 123,
'discountConditionedAmount' => 123,
'irAmount' => 123,
'pisCofinsBaseTax' => 123,
'pisAmount' => 123,
'cofinsAmount' => 123,
'inssAmount' => 123,
'csllAmount' => 123,
'othersAmount' => 123,
'deductionsAmount' => 123,
'irWithheld' => true,
'issWithheld' => true,
'cofinsWithheld' => true,
'inssWithheld' => true,
'csllWithheld' => true,
'pisWithheld' => true,
'ibsStateRate' => 123,
'ibsStateRedRate' => 123,
'ibsCityRate' => 123,
'ibsCityRedRate' => 123,
'cbsRate' => 123,
'cbsRedRate' => 123,
'ibsCbsBaseTax' => 123,
'ibsStateAmount' => 123,
'ibsCityAmount' => 123,
'ibsAmount' => 123,
'cbsAmount' => 123,
'receivedAmount' => 123
],
'integrationId' => '<string>',
'effectiveDate' => '2023-11-07T05:31:56Z',
'receiver' => [
'name' => '<string>',
'federalTaxNumber' => '<string>',
'stateTaxNumber' => '<string>',
'suframaTaxNumber' => '<string>',
'cityTaxNumber' => '<string>',
'email' => '<string>',
'phoneNumber' => '<string>',
'address' => [
'street' => '<string>',
'district' => '<string>',
'postalCode' => '<string>',
'number' => '<string>',
'additionalInformation' => '<string>',
'city' => [
'name' => '<string>',
'state' => '<string>',
'code' => 123
],
'country' => '<string>'
]
],
'number' => 123,
'additionalInformation' => '<string>',
'sendEmailToCustomer' => true,
'issue' => true,
'batchNumber' => 123,
'rpsNumber' => 123,
'rpsSeries' => '<string>',
'cnaeCode' => '<string>',
'nbsCode' => '<string>',
'federalServiceCode' => '<string>',
'nationalTaxationCode' => '<string>',
'cityServiceCode' => '<string>',
'intermediary' => [
'sellerRegistrationId' => '<string>',
'name' => '<string>',
'federalTaxNumber' => '<string>',
'cityTaxNumber' => '<string>',
'email' => '<string>',
'phoneNumber' => '<string>',
'address' => [
'street' => '<string>',
'district' => '<string>',
'postalCode' => '<string>',
'number' => '<string>',
'additionalInformation' => '<string>',
'city' => [
'name' => '<string>',
'state' => '<string>',
'code' => 123
],
'country' => '<string>'
]
],
'cstPisCofins' => '<string>',
'simplesNacionalAnnex' => '<string>',
'location' => [
'code' => 123,
'name' => '<string>'
],
'ibsCbs' => [
'cst' => 123,
'classification' => 123,
'operationIndicatorCode' => '<string>',
'isPersonalUse' => true,
'property' => [
'fiscalPropertyTaxNumber' => '<string>',
'cibCode' => '<string>',
'address' => [
'street' => '<string>',
'district' => '<string>',
'postalCode' => '<string>',
'number' => '<string>',
'additionalInformation' => '<string>',
'city' => [
'name' => '<string>',
'state' => '<string>',
'code' => 123
],
'country' => '<string>'
],
'location' => [
'code' => 123,
'name' => '<string>'
]
]
],
'national' => [
'municipalBenefit' => [
'identification' => '<string>'
],
'construction' => [
'fiscalPropertyTaxNumber' => '<string>',
'constructionCode' => '<string>',
'cibCode' => '<string>',
'address' => [
'street' => '<string>',
'district' => '<string>',
'postalCode' => '<string>',
'number' => '<string>',
'additionalInformation' => '<string>',
'city' => [
'name' => '<string>',
'state' => '<string>',
'code' => 123
],
'country' => '<string>'
]
],
'event' => [
'name' => '<string>',
'startDate' => '2023-11-07T05:31:56Z',
'endDate' => '2023-11-07T05:31:56Z',
'identifier' => '<string>',
'address' => [
'street' => '<string>',
'district' => '<string>',
'postalCode' => '<string>',
'number' => '<string>',
'additionalInformation' => '<string>',
'city' => [
'name' => '<string>',
'state' => '<string>',
'code' => 123
],
'country' => '<string>'
]
],
'suspensionProcessNumber' => '<string>'
],
'approximateTaxes' => [
'municipalRate' => 123,
'stateRate' => 123,
'federalRate' => 123,
'simplesNacionalRate' => 123,
'source' => '<string>'
],
'foreignTrade' => [
'amount' => 123,
'currencyCode' => '<string>',
'supportMechanismForServiceProvider' => '<string>',
'supportMechanismForBorrower' => '<string>',
'sendInvoiceToMdic' => true
]
]),
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/service-invoices"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"total\": {\n \"invoiceAmount\": 123,\n \"netAmount\": 123,\n \"issBaseTax\": 123,\n \"irRate\": 123,\n \"csllRate\": 123,\n \"pisRate\": 123,\n \"cofinsRate\": 123,\n \"inssRate\": 123,\n \"issRate\": 123,\n \"issAmount\": 123,\n \"discountUnconditionedAmount\": 123,\n \"discountConditionedAmount\": 123,\n \"irAmount\": 123,\n \"pisCofinsBaseTax\": 123,\n \"pisAmount\": 123,\n \"cofinsAmount\": 123,\n \"inssAmount\": 123,\n \"csllAmount\": 123,\n \"othersAmount\": 123,\n \"deductionsAmount\": 123,\n \"irWithheld\": true,\n \"issWithheld\": true,\n \"cofinsWithheld\": true,\n \"inssWithheld\": true,\n \"csllWithheld\": true,\n \"pisWithheld\": true,\n \"ibsStateRate\": 123,\n \"ibsStateRedRate\": 123,\n \"ibsCityRate\": 123,\n \"ibsCityRedRate\": 123,\n \"cbsRate\": 123,\n \"cbsRedRate\": 123,\n \"ibsCbsBaseTax\": 123,\n \"ibsStateAmount\": 123,\n \"ibsCityAmount\": 123,\n \"ibsAmount\": 123,\n \"cbsAmount\": 123,\n \"receivedAmount\": 123\n },\n \"integrationId\": \"<string>\",\n \"effectiveDate\": \"2023-11-07T05:31:56Z\",\n \"receiver\": {\n \"name\": \"<string>\",\n \"federalTaxNumber\": \"<string>\",\n \"stateTaxNumber\": \"<string>\",\n \"suframaTaxNumber\": \"<string>\",\n \"cityTaxNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"code\": 123\n },\n \"country\": \"<string>\"\n }\n },\n \"number\": 123,\n \"additionalInformation\": \"<string>\",\n \"sendEmailToCustomer\": true,\n \"issue\": true,\n \"batchNumber\": 123,\n \"rpsNumber\": 123,\n \"rpsSeries\": \"<string>\",\n \"cnaeCode\": \"<string>\",\n \"nbsCode\": \"<string>\",\n \"federalServiceCode\": \"<string>\",\n \"nationalTaxationCode\": \"<string>\",\n \"cityServiceCode\": \"<string>\",\n \"intermediary\": {\n \"sellerRegistrationId\": \"<string>\",\n \"name\": \"<string>\",\n \"federalTaxNumber\": \"<string>\",\n \"cityTaxNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"code\": 123\n },\n \"country\": \"<string>\"\n }\n },\n \"cstPisCofins\": \"<string>\",\n \"simplesNacionalAnnex\": \"<string>\",\n \"location\": {\n \"code\": 123,\n \"name\": \"<string>\"\n },\n \"ibsCbs\": {\n \"cst\": 123,\n \"classification\": 123,\n \"operationIndicatorCode\": \"<string>\",\n \"isPersonalUse\": true,\n \"property\": {\n \"fiscalPropertyTaxNumber\": \"<string>\",\n \"cibCode\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"code\": 123\n },\n \"country\": \"<string>\"\n },\n \"location\": {\n \"code\": 123,\n \"name\": \"<string>\"\n }\n }\n },\n \"national\": {\n \"municipalBenefit\": {\n \"identification\": \"<string>\"\n },\n \"construction\": {\n \"fiscalPropertyTaxNumber\": \"<string>\",\n \"constructionCode\": \"<string>\",\n \"cibCode\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"code\": 123\n },\n \"country\": \"<string>\"\n }\n },\n \"event\": {\n \"name\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"identifier\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"code\": 123\n },\n \"country\": \"<string>\"\n }\n },\n \"suspensionProcessNumber\": \"<string>\"\n },\n \"approximateTaxes\": {\n \"municipalRate\": 123,\n \"stateRate\": 123,\n \"federalRate\": 123,\n \"simplesNacionalRate\": 123,\n \"source\": \"<string>\"\n },\n \"foreignTrade\": {\n \"amount\": 123,\n \"currencyCode\": \"<string>\",\n \"supportMechanismForServiceProvider\": \"<string>\",\n \"supportMechanismForBorrower\": \"<string>\",\n \"sendInvoiceToMdic\": true\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.spedy.com.br/v1/service-invoices")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"description\": \"<string>\",\n \"total\": {\n \"invoiceAmount\": 123,\n \"netAmount\": 123,\n \"issBaseTax\": 123,\n \"irRate\": 123,\n \"csllRate\": 123,\n \"pisRate\": 123,\n \"cofinsRate\": 123,\n \"inssRate\": 123,\n \"issRate\": 123,\n \"issAmount\": 123,\n \"discountUnconditionedAmount\": 123,\n \"discountConditionedAmount\": 123,\n \"irAmount\": 123,\n \"pisCofinsBaseTax\": 123,\n \"pisAmount\": 123,\n \"cofinsAmount\": 123,\n \"inssAmount\": 123,\n \"csllAmount\": 123,\n \"othersAmount\": 123,\n \"deductionsAmount\": 123,\n \"irWithheld\": true,\n \"issWithheld\": true,\n \"cofinsWithheld\": true,\n \"inssWithheld\": true,\n \"csllWithheld\": true,\n \"pisWithheld\": true,\n \"ibsStateRate\": 123,\n \"ibsStateRedRate\": 123,\n \"ibsCityRate\": 123,\n \"ibsCityRedRate\": 123,\n \"cbsRate\": 123,\n \"cbsRedRate\": 123,\n \"ibsCbsBaseTax\": 123,\n \"ibsStateAmount\": 123,\n \"ibsCityAmount\": 123,\n \"ibsAmount\": 123,\n \"cbsAmount\": 123,\n \"receivedAmount\": 123\n },\n \"integrationId\": \"<string>\",\n \"effectiveDate\": \"2023-11-07T05:31:56Z\",\n \"receiver\": {\n \"name\": \"<string>\",\n \"federalTaxNumber\": \"<string>\",\n \"stateTaxNumber\": \"<string>\",\n \"suframaTaxNumber\": \"<string>\",\n \"cityTaxNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"code\": 123\n },\n \"country\": \"<string>\"\n }\n },\n \"number\": 123,\n \"additionalInformation\": \"<string>\",\n \"sendEmailToCustomer\": true,\n \"issue\": true,\n \"batchNumber\": 123,\n \"rpsNumber\": 123,\n \"rpsSeries\": \"<string>\",\n \"cnaeCode\": \"<string>\",\n \"nbsCode\": \"<string>\",\n \"federalServiceCode\": \"<string>\",\n \"nationalTaxationCode\": \"<string>\",\n \"cityServiceCode\": \"<string>\",\n \"intermediary\": {\n \"sellerRegistrationId\": \"<string>\",\n \"name\": \"<string>\",\n \"federalTaxNumber\": \"<string>\",\n \"cityTaxNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"code\": 123\n },\n \"country\": \"<string>\"\n }\n },\n \"cstPisCofins\": \"<string>\",\n \"simplesNacionalAnnex\": \"<string>\",\n \"location\": {\n \"code\": 123,\n \"name\": \"<string>\"\n },\n \"ibsCbs\": {\n \"cst\": 123,\n \"classification\": 123,\n \"operationIndicatorCode\": \"<string>\",\n \"isPersonalUse\": true,\n \"property\": {\n \"fiscalPropertyTaxNumber\": \"<string>\",\n \"cibCode\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"code\": 123\n },\n \"country\": \"<string>\"\n },\n \"location\": {\n \"code\": 123,\n \"name\": \"<string>\"\n }\n }\n },\n \"national\": {\n \"municipalBenefit\": {\n \"identification\": \"<string>\"\n },\n \"construction\": {\n \"fiscalPropertyTaxNumber\": \"<string>\",\n \"constructionCode\": \"<string>\",\n \"cibCode\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"code\": 123\n },\n \"country\": \"<string>\"\n }\n },\n \"event\": {\n \"name\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"identifier\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"code\": 123\n },\n \"country\": \"<string>\"\n }\n },\n \"suspensionProcessNumber\": \"<string>\"\n },\n \"approximateTaxes\": {\n \"municipalRate\": 123,\n \"stateRate\": 123,\n \"federalRate\": 123,\n \"simplesNacionalRate\": 123,\n \"source\": \"<string>\"\n },\n \"foreignTrade\": {\n \"amount\": 123,\n \"currencyCode\": \"<string>\",\n \"supportMechanismForServiceProvider\": \"<string>\",\n \"supportMechanismForBorrower\": \"<string>\",\n \"sendInvoiceToMdic\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spedy.com.br/v1/service-invoices")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"description\": \"<string>\",\n \"total\": {\n \"invoiceAmount\": 123,\n \"netAmount\": 123,\n \"issBaseTax\": 123,\n \"irRate\": 123,\n \"csllRate\": 123,\n \"pisRate\": 123,\n \"cofinsRate\": 123,\n \"inssRate\": 123,\n \"issRate\": 123,\n \"issAmount\": 123,\n \"discountUnconditionedAmount\": 123,\n \"discountConditionedAmount\": 123,\n \"irAmount\": 123,\n \"pisCofinsBaseTax\": 123,\n \"pisAmount\": 123,\n \"cofinsAmount\": 123,\n \"inssAmount\": 123,\n \"csllAmount\": 123,\n \"othersAmount\": 123,\n \"deductionsAmount\": 123,\n \"irWithheld\": true,\n \"issWithheld\": true,\n \"cofinsWithheld\": true,\n \"inssWithheld\": true,\n \"csllWithheld\": true,\n \"pisWithheld\": true,\n \"ibsStateRate\": 123,\n \"ibsStateRedRate\": 123,\n \"ibsCityRate\": 123,\n \"ibsCityRedRate\": 123,\n \"cbsRate\": 123,\n \"cbsRedRate\": 123,\n \"ibsCbsBaseTax\": 123,\n \"ibsStateAmount\": 123,\n \"ibsCityAmount\": 123,\n \"ibsAmount\": 123,\n \"cbsAmount\": 123,\n \"receivedAmount\": 123\n },\n \"integrationId\": \"<string>\",\n \"effectiveDate\": \"2023-11-07T05:31:56Z\",\n \"receiver\": {\n \"name\": \"<string>\",\n \"federalTaxNumber\": \"<string>\",\n \"stateTaxNumber\": \"<string>\",\n \"suframaTaxNumber\": \"<string>\",\n \"cityTaxNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"code\": 123\n },\n \"country\": \"<string>\"\n }\n },\n \"number\": 123,\n \"additionalInformation\": \"<string>\",\n \"sendEmailToCustomer\": true,\n \"issue\": true,\n \"batchNumber\": 123,\n \"rpsNumber\": 123,\n \"rpsSeries\": \"<string>\",\n \"cnaeCode\": \"<string>\",\n \"nbsCode\": \"<string>\",\n \"federalServiceCode\": \"<string>\",\n \"nationalTaxationCode\": \"<string>\",\n \"cityServiceCode\": \"<string>\",\n \"intermediary\": {\n \"sellerRegistrationId\": \"<string>\",\n \"name\": \"<string>\",\n \"federalTaxNumber\": \"<string>\",\n \"cityTaxNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"code\": 123\n },\n \"country\": \"<string>\"\n }\n },\n \"cstPisCofins\": \"<string>\",\n \"simplesNacionalAnnex\": \"<string>\",\n \"location\": {\n \"code\": 123,\n \"name\": \"<string>\"\n },\n \"ibsCbs\": {\n \"cst\": 123,\n \"classification\": 123,\n \"operationIndicatorCode\": \"<string>\",\n \"isPersonalUse\": true,\n \"property\": {\n \"fiscalPropertyTaxNumber\": \"<string>\",\n \"cibCode\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"code\": 123\n },\n \"country\": \"<string>\"\n },\n \"location\": {\n \"code\": 123,\n \"name\": \"<string>\"\n }\n }\n },\n \"national\": {\n \"municipalBenefit\": {\n \"identification\": \"<string>\"\n },\n \"construction\": {\n \"fiscalPropertyTaxNumber\": \"<string>\",\n \"constructionCode\": \"<string>\",\n \"cibCode\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"code\": 123\n },\n \"country\": \"<string>\"\n }\n },\n \"event\": {\n \"name\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"identifier\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"code\": 123\n },\n \"country\": \"<string>\"\n }\n },\n \"suspensionProcessNumber\": \"<string>\"\n },\n \"approximateTaxes\": {\n \"municipalRate\": 123,\n \"stateRate\": 123,\n \"federalRate\": 123,\n \"simplesNacionalRate\": 123,\n \"source\": \"<string>\"\n },\n \"foreignTrade\": {\n \"amount\": 123,\n \"currencyCode\": \"<string>\",\n \"supportMechanismForServiceProvider\": \"<string>\",\n \"supportMechanismForBorrower\": \"<string>\",\n \"sendInvoiceToMdic\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"integrationId": "<string>",
"status": "created",
"model": "productInvoice",
"environmentType": "production",
"issuedOn": "2023-11-07T05:31:56Z",
"effectiveDate": "2023-11-07T05:31:56Z",
"receiver": {
"name": "<string>",
"federalTaxNumber": "<string>",
"stateTaxNumber": "<string>",
"suframaTaxNumber": "<string>",
"cityTaxNumber": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"name": "<string>",
"state": "<string>",
"code": 123
},
"country": "<string>"
}
},
"company": {
"name": "<string>",
"legalName": "<string>",
"federalTaxNumber": "<string>",
"stateTaxNumber": "<string>",
"cityTaxNumber": "<string>"
},
"order": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"date": "2023-11-07T05:31:56Z",
"transactionId": "<string>"
},
"authorization": {
"date": "2023-11-07T05:31:56Z",
"protocol": "<string>",
"digestValue": "<string>"
},
"cancellation": {
"date": "2023-11-07T05:31:56Z",
"protocol": "<string>",
"justification": "<string>"
},
"amount": 123,
"number": 123,
"processingDetail": {
"status": "processing",
"message": "<string>",
"code": "<string>",
"on": "2023-11-07T05:31:56Z"
},
"isFromApi": true,
"description": "<string>",
"totals": {
"invoiceAmount": 123,
"netAmount": 123,
"issBaseTax": 123,
"irRate": 123,
"csllRate": 123,
"pisRate": 123,
"cofinsRate": 123,
"inssRate": 123,
"issRate": 123,
"issAmount": 123,
"discountUnconditionedAmount": 123,
"discountConditionedAmount": 123,
"irAmount": 123,
"pisCofinsBaseTax": 123,
"pisAmount": 123,
"cofinsAmount": 123,
"inssAmount": 123,
"csllAmount": 123,
"othersAmount": 123,
"deductionsAmount": 123,
"irWithheld": true,
"issWithheld": true,
"cofinsWithheld": true,
"inssWithheld": true,
"csllWithheld": true,
"pisWithheld": true,
"ibsStateRate": 123,
"ibsStateRedRate": 123,
"ibsCityRate": 123,
"ibsCityRedRate": 123,
"cbsRate": 123,
"cbsRedRate": 123,
"ibsCbsBaseTax": 123,
"ibsStateAmount": 123,
"ibsCityAmount": 123,
"ibsAmount": 123,
"cbsAmount": 123,
"receivedAmount": 123
},
"rps": {
"number": 123,
"series": "<string>"
},
"location": {
"code": 123,
"name": "<string>",
"state": "ro"
},
"ibsCbs": {
"cst": 123,
"classification": 123,
"operationIndicatorCode": "<string>",
"isPersonalUse": true,
"operationType": "supplyWithSubsequentPayment",
"governmentEntityType": "union",
"property": {
"fiscalPropertyTaxNumber": "<string>",
"cibCode": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"name": "<string>",
"state": "<string>",
"code": 123
},
"country": "<string>"
},
"location": {
"code": 123,
"name": "<string>",
"state": "ro"
}
}
},
"nbsCode": "<string>",
"nationalTaxationCode": "<string>",
"batchNumber": 123,
"approximateTaxes": {
"federalAmount": 123,
"federalRate": 123,
"municipalRate": 123,
"municipalAmount": 123,
"stateAmount": 123,
"stateRate": 123,
"amount": 123,
"rate": 123,
"version": "<string>",
"source": "<string>",
"mode": "disabled"
},
"foreignTrade": {
"amount": 123,
"currencyCode": "<string>",
"serviceProvisionMode": "unknown",
"relationshipBetweenParties": "withoutLink",
"supportMechanismForServiceProvider": "<string>",
"supportMechanismForBorrower": "<string>",
"relationshipBetweenOperationAndTemporaryMovement": "unknown",
"sendInvoiceToMdic": true
}
}Authorizations
Authorization By X-Api-Key inside request's header
Body
application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Discriminação dos serviços
Minimum string length:
1Totais da NFS-e.
Alíquotas e percentuais de redução são informados em percentual:
- Alíquota:
3significa 3% — e não0.03 - Redução:
60significa redução de 60% — e não0.6
Show child attributes
Show child attributes
Identificador único da nota fiscal no sistema do cliente (máx. 36 caracteres).
Maximum string length:
36Data de competência.
Opcional: se omitida, é usada a data e hora em que a emissão é solicitada.
Cliente / Tomador
Show child attributes
Show child attributes
Número da NFS-e.
Só é enviado à prefeitura quando o provedor da cidade não usa RPS/DPS (provider.options.rps falso em «Cidades integradas»). Na maioria dos municípios, inclusive no Ambiente Nacional, o número é gerado pela prefeitura a partir do RPS/DPS.
Informações adicionais
Enviar e-mail para o cliente / tomador
Define se a nota é emitida ao ser criada. Padrão true.
true: a nota é criada e enfileirada para emissão (statusenqueued).false: a nota fica como rascunho (statuscreated), sem consumir numeração nem transmitir — permite gerar a pré-visualização do PDF. Para emitir depois, use «Reemitir nota fiscal».
Número do lote.
Opcional: se omitido, é usado o próximo número de lote configurado na empresa.
Número do RPS ou da DPS no Ambiente Nacional.
Opcional: se omitido, é usado o próximo número configurado na empresa.
Série do RPS ou da DPS no Ambiente Nacional.
Opcional: se omitida, é usada a série configurada na empresa.
Código CNAE
Código NBS
Código do Item da Lista de Serviço (LC 116/03)
Código de Tributação Nacional
Código do serviço no munícipio
Natureza de operação.
Opcional: se omitida, é usada a da regra de tributação da empresa.
Valores possíveis:
- taxationInMunicipality: Tributado no Município / Exigível / Operação tributável
- taxationOutsideMunicipality: Tributado em outro município / Não incidência
- exemption: Isento
- immune: Imune
- suspendedByCourt: Suspenso por Decisão Judicial
- suspendedByAdministrativeProcedure: Suspenso por Decisão Administrativa
- exportation: Exportação
- nonIncidence: Não incidência
Available options:
taxationInMunicipality, taxationOutsideMunicipality, exemption, immune, suspendedByCourt, suspendedByAdministrativeProcedure, exportation, nonIncidence Intermediário do serviço.
Usado em provedores que utilizam o Layout Nacional ou em provedores específicos. Consulte provider.options.supportsIntermediary em «Cidades integradas» para saber se o provedor suporta.
Show child attributes
Show child attributes
Código de Situação Tributária (CST) de PIS/COFINS.
Informe quando a nota destaca PIS e COFINS. Usado apenas em provedores que utilizam o Layout Nacional.
Opcional: se omitido, é usado o CST do grupo de tributação, quando configurado.
Informe o código de dois dígitos (ex.: 01):
00: Nenhum01: Operação Tributável com Alíquota Básica02: Operação Tributável com Alíquota Diferenciada03: Operação Tributável com Alíquota por Unidade de Medida de Produto04: Operação Tributável monofásica - Revenda a Alíquota Zero05: Operação Tributável por Substituição Tributária06: Operação Tributável a Alíquota Zero07: Operação Isenta da Contribuição08: Operação sem Incidência da Contribuição09: Operação com Suspensão da Contribuição
Tabela completa em Regimes e códigos fiscais.
Anexo do Simples Nacional.
Obrigatório somente para os provedores Conam e Webfisco. Valores aceitos: I, II, III, IV, V.
Cidade de prestação do serviço.
Opcional: se omitida, é usada a cidade do endereço do evento, quando informado, ou a da empresa. Se a regra de tributação da empresa definir a prestação no município do cliente, é usada a cidade do cliente.
Show child attributes
Show child attributes
Município de incidência do serviço.
Opcional: se omitido, é usado companyMunicipality.
Valores possíveis:
- companyMunicipality: No município da empresa
- customerMunicipality: No município do cliente
- serviceProvisionMunicipality: No município de prestação do serviço
Available options:
companyMunicipality, customerMunicipality, serviceProvisionMunicipality Grupo de tributação do Imposto de Bens e Serviços - IBS e da Contribuição de Bens e Serviços - CBS
Show child attributes
Show child attributes
Informações do Padrão Nacional
Show child attributes
Show child attributes
Tributos aproximados da Lei da Transparência (Lei 12.741/2012), acrescentados ao final da discriminação do serviço.
Opcional: se omitido, é usada a configuração de tributos aproximados da empresa. Quando informado, as alíquotas enviadas são usadas como estão, em percentual: 3 significa 3% — e não 0.03.
Show child attributes
Show child attributes
Dados de comércio exterior da operação, para quando o tomador ou o intermediário é estrangeiro. Enviados à prefeitura apenas quando o provedor de NFS-e do município aceita essas informações, como no padrão nacional.
Opcional: cada campo omitido é preenchido pelo grupo de tributação da empresa, se estiverem configurados para operações com o exterior.
Show child attributes
Show child attributes
Response
OK
ID da NF
ID de integração
Status
Valores possíveis:
- created: Criada — aguarda emissão explícita via issue ou gatilho automático (ex: afterPayment)
- enqueued: Enfileirada para processamento junto à SEFAZ ou Prefeitura
- received: Recebido
- authorized: Autorizado
- inContingent: Em contingência
- rejected: Rejeitado
- canceled: Cancelado
- denied: Denegado
- removed: Removido
- disabled: Inutilizado
Available options:
created, enqueued, received, authorized, inContingent, rejected, canceled, denied, removed, disabled Modelo
Valores possíveis:
- productInvoice: NF-e
- consumerInvoice: NFC-e
- serviceInvoice: NFS-e
Available options:
productInvoice, consumerInvoice, serviceInvoice Ambiente
Valores possíveis:
- production: Produção
- development: Homologação
- simulation:
Available options:
production, development, simulation Data e hora em que a emissão foi solicitada
Data de competência
Cliente
Show child attributes
Show child attributes
Empresa
Show child attributes
Show child attributes
Dados da venda
Show child attributes
Show child attributes
Dados da autorização
Show child attributes
Show child attributes
Dados do cancelamento
Show child attributes
Show child attributes
Valor total da NF
Número
Detalhes do processamento
Show child attributes
Show child attributes
Emitida via API pública
Totais da NFS-e.
Alíquotas e percentuais de redução são informados em percentual:
- Alíquota:
3significa 3% — e não0.03 - Redução:
60significa redução de 60% — e não0.6
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Dados de comércio exterior da NFS-e.
Cada campo informado substitui o valor da regra fiscal da empresa; os campos omitidos continuam vindo da regra, que só se aplica quando o tomador ou o intermediário é estrangeiro.
Show child attributes
Show child attributes