Issue a tax document
curl --request POST \
--url https://api.accounting.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/tax-document \
--header 'Content-Type: application/json' \
--data '
{
"environment": "TEST",
"competenceDate": "2026-10-01T00:00:00.000Z",
"taxDocumentCustomer": {
"type": "COMPANY",
"name": "Acme Tecnologia Ltda",
"email": "financeiro@acme.com.br",
"federalDocument": "12345678000195",
"addressState": "MG",
"addressCity": "Uberlândia",
"addressStreet": "Avenida João Naves de Ávila",
"addressNumber": "2121",
"addressNeighbourhood": "Santa Mônica",
"addressPostalCode": "38408100",
"municipalDocument": "123456",
"stateDocument": "123456789",
"phone": "+5534991234567",
"addressComplement": "Sala 101"
},
"type": "NFSE",
"operationNature": "Prestação de Serviços",
"deductions": 0,
"discounts": 0,
"totalValue": 1500.5,
"observation": "Referente ao contrato 1234",
"externalId": "6f1b7c52-8a4e-4d3f-9c21-b0e5a7d84c19",
"externalParentId": "INVOICE"
}
'import requests
url = "https://api.accounting.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/tax-document"
payload = {
"environment": "TEST",
"competenceDate": "2026-10-01T00:00:00.000Z",
"taxDocumentCustomer": {
"type": "COMPANY",
"name": "Acme Tecnologia Ltda",
"email": "financeiro@acme.com.br",
"federalDocument": "12345678000195",
"addressState": "MG",
"addressCity": "Uberlândia",
"addressStreet": "Avenida João Naves de Ávila",
"addressNumber": "2121",
"addressNeighbourhood": "Santa Mônica",
"addressPostalCode": "38408100",
"municipalDocument": "123456",
"stateDocument": "123456789",
"phone": "+5534991234567",
"addressComplement": "Sala 101"
},
"type": "NFSE",
"operationNature": "Prestação de Serviços",
"deductions": 0,
"discounts": 0,
"totalValue": 1500.5,
"observation": "Referente ao contrato 1234",
"externalId": "6f1b7c52-8a4e-4d3f-9c21-b0e5a7d84c19",
"externalParentId": "INVOICE"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
environment: 'TEST',
competenceDate: '2026-10-01T00:00:00.000Z',
taxDocumentCustomer: {
type: 'COMPANY',
name: 'Acme Tecnologia Ltda',
email: 'financeiro@acme.com.br',
federalDocument: '12345678000195',
addressState: 'MG',
addressCity: 'Uberlândia',
addressStreet: 'Avenida João Naves de Ávila',
addressNumber: '2121',
addressNeighbourhood: 'Santa Mônica',
addressPostalCode: '38408100',
municipalDocument: '123456',
stateDocument: '123456789',
phone: '+5534991234567',
addressComplement: 'Sala 101'
},
type: 'NFSE',
operationNature: 'Prestação de Serviços',
deductions: 0,
discounts: 0,
totalValue: 1500.5,
observation: 'Referente ao contrato 1234',
externalId: '6f1b7c52-8a4e-4d3f-9c21-b0e5a7d84c19',
externalParentId: 'INVOICE'
})
};
fetch('https://api.accounting.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/tax-document', 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.accounting.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/tax-document",
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([
'environment' => 'TEST',
'competenceDate' => '2026-10-01T00:00:00.000Z',
'taxDocumentCustomer' => [
'type' => 'COMPANY',
'name' => 'Acme Tecnologia Ltda',
'email' => 'financeiro@acme.com.br',
'federalDocument' => '12345678000195',
'addressState' => 'MG',
'addressCity' => 'Uberlândia',
'addressStreet' => 'Avenida João Naves de Ávila',
'addressNumber' => '2121',
'addressNeighbourhood' => 'Santa Mônica',
'addressPostalCode' => '38408100',
'municipalDocument' => '123456',
'stateDocument' => '123456789',
'phone' => '+5534991234567',
'addressComplement' => 'Sala 101'
],
'type' => 'NFSE',
'operationNature' => 'Prestação de Serviços',
'deductions' => 0,
'discounts' => 0,
'totalValue' => 1500.5,
'observation' => 'Referente ao contrato 1234',
'externalId' => '6f1b7c52-8a4e-4d3f-9c21-b0e5a7d84c19',
'externalParentId' => 'INVOICE'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.accounting.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/tax-document"
payload := strings.NewReader("{\n \"environment\": \"TEST\",\n \"competenceDate\": \"2026-10-01T00:00:00.000Z\",\n \"taxDocumentCustomer\": {\n \"type\": \"COMPANY\",\n \"name\": \"Acme Tecnologia Ltda\",\n \"email\": \"financeiro@acme.com.br\",\n \"federalDocument\": \"12345678000195\",\n \"addressState\": \"MG\",\n \"addressCity\": \"Uberlândia\",\n \"addressStreet\": \"Avenida João Naves de Ávila\",\n \"addressNumber\": \"2121\",\n \"addressNeighbourhood\": \"Santa Mônica\",\n \"addressPostalCode\": \"38408100\",\n \"municipalDocument\": \"123456\",\n \"stateDocument\": \"123456789\",\n \"phone\": \"+5534991234567\",\n \"addressComplement\": \"Sala 101\"\n },\n \"type\": \"NFSE\",\n \"operationNature\": \"Prestação de Serviços\",\n \"deductions\": 0,\n \"discounts\": 0,\n \"totalValue\": 1500.5,\n \"observation\": \"Referente ao contrato 1234\",\n \"externalId\": \"6f1b7c52-8a4e-4d3f-9c21-b0e5a7d84c19\",\n \"externalParentId\": \"INVOICE\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/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.accounting.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/tax-document")
.header("Content-Type", "application/json")
.body("{\n \"environment\": \"TEST\",\n \"competenceDate\": \"2026-10-01T00:00:00.000Z\",\n \"taxDocumentCustomer\": {\n \"type\": \"COMPANY\",\n \"name\": \"Acme Tecnologia Ltda\",\n \"email\": \"financeiro@acme.com.br\",\n \"federalDocument\": \"12345678000195\",\n \"addressState\": \"MG\",\n \"addressCity\": \"Uberlândia\",\n \"addressStreet\": \"Avenida João Naves de Ávila\",\n \"addressNumber\": \"2121\",\n \"addressNeighbourhood\": \"Santa Mônica\",\n \"addressPostalCode\": \"38408100\",\n \"municipalDocument\": \"123456\",\n \"stateDocument\": \"123456789\",\n \"phone\": \"+5534991234567\",\n \"addressComplement\": \"Sala 101\"\n },\n \"type\": \"NFSE\",\n \"operationNature\": \"Prestação de Serviços\",\n \"deductions\": 0,\n \"discounts\": 0,\n \"totalValue\": 1500.5,\n \"observation\": \"Referente ao contrato 1234\",\n \"externalId\": \"6f1b7c52-8a4e-4d3f-9c21-b0e5a7d84c19\",\n \"externalParentId\": \"INVOICE\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.accounting.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/tax-document")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"environment\": \"TEST\",\n \"competenceDate\": \"2026-10-01T00:00:00.000Z\",\n \"taxDocumentCustomer\": {\n \"type\": \"COMPANY\",\n \"name\": \"Acme Tecnologia Ltda\",\n \"email\": \"financeiro@acme.com.br\",\n \"federalDocument\": \"12345678000195\",\n \"addressState\": \"MG\",\n \"addressCity\": \"Uberlândia\",\n \"addressStreet\": \"Avenida João Naves de Ávila\",\n \"addressNumber\": \"2121\",\n \"addressNeighbourhood\": \"Santa Mônica\",\n \"addressPostalCode\": \"38408100\",\n \"municipalDocument\": \"123456\",\n \"stateDocument\": \"123456789\",\n \"phone\": \"+5534991234567\",\n \"addressComplement\": \"Sala 101\"\n },\n \"type\": \"NFSE\",\n \"operationNature\": \"Prestação de Serviços\",\n \"deductions\": 0,\n \"discounts\": 0,\n \"totalValue\": 1500.5,\n \"observation\": \"Referente ao contrato 1234\",\n \"externalId\": \"6f1b7c52-8a4e-4d3f-9c21-b0e5a7d84c19\",\n \"externalParentId\": \"INVOICE\"\n}"
response = http.request(request)
puts response.read_body{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "TAX_ISSUER_PROVIDER_ID_NOT_FOUND",
"origin": "ACCOUNTING",
"message": "Tax issuer provider id not exists"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "TAX_ISSUER_NOT_FOUND",
"origin": "ACCOUNTING",
"message": "Tax issuer not found"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "TAX_DOCUMENT_ALREADY_ISSUED",
"origin": "ACCOUNTING",
"message": "A tax document was already issued for this externalId"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BAD_REQUEST",
"origin": "ACCOUNTING",
"message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
"fields": [
{
"field": "environment",
"message": "Invalid option: expected one of \"LIVE\"|\"TEST\"",
"code": "ENVIRONMENT_ONE_OF",
"values": [
"LIVE",
"TEST"
]
}
]
}Issue a tax document
Issues a tax document (NFSe) for your organization.
POST
/
realms
/
{realmId}
/
organizations
/
{organizationId}
/
tax-document
Issue a tax document
curl --request POST \
--url https://api.accounting.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/tax-document \
--header 'Content-Type: application/json' \
--data '
{
"environment": "TEST",
"competenceDate": "2026-10-01T00:00:00.000Z",
"taxDocumentCustomer": {
"type": "COMPANY",
"name": "Acme Tecnologia Ltda",
"email": "financeiro@acme.com.br",
"federalDocument": "12345678000195",
"addressState": "MG",
"addressCity": "Uberlândia",
"addressStreet": "Avenida João Naves de Ávila",
"addressNumber": "2121",
"addressNeighbourhood": "Santa Mônica",
"addressPostalCode": "38408100",
"municipalDocument": "123456",
"stateDocument": "123456789",
"phone": "+5534991234567",
"addressComplement": "Sala 101"
},
"type": "NFSE",
"operationNature": "Prestação de Serviços",
"deductions": 0,
"discounts": 0,
"totalValue": 1500.5,
"observation": "Referente ao contrato 1234",
"externalId": "6f1b7c52-8a4e-4d3f-9c21-b0e5a7d84c19",
"externalParentId": "INVOICE"
}
'import requests
url = "https://api.accounting.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/tax-document"
payload = {
"environment": "TEST",
"competenceDate": "2026-10-01T00:00:00.000Z",
"taxDocumentCustomer": {
"type": "COMPANY",
"name": "Acme Tecnologia Ltda",
"email": "financeiro@acme.com.br",
"federalDocument": "12345678000195",
"addressState": "MG",
"addressCity": "Uberlândia",
"addressStreet": "Avenida João Naves de Ávila",
"addressNumber": "2121",
"addressNeighbourhood": "Santa Mônica",
"addressPostalCode": "38408100",
"municipalDocument": "123456",
"stateDocument": "123456789",
"phone": "+5534991234567",
"addressComplement": "Sala 101"
},
"type": "NFSE",
"operationNature": "Prestação de Serviços",
"deductions": 0,
"discounts": 0,
"totalValue": 1500.5,
"observation": "Referente ao contrato 1234",
"externalId": "6f1b7c52-8a4e-4d3f-9c21-b0e5a7d84c19",
"externalParentId": "INVOICE"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
environment: 'TEST',
competenceDate: '2026-10-01T00:00:00.000Z',
taxDocumentCustomer: {
type: 'COMPANY',
name: 'Acme Tecnologia Ltda',
email: 'financeiro@acme.com.br',
federalDocument: '12345678000195',
addressState: 'MG',
addressCity: 'Uberlândia',
addressStreet: 'Avenida João Naves de Ávila',
addressNumber: '2121',
addressNeighbourhood: 'Santa Mônica',
addressPostalCode: '38408100',
municipalDocument: '123456',
stateDocument: '123456789',
phone: '+5534991234567',
addressComplement: 'Sala 101'
},
type: 'NFSE',
operationNature: 'Prestação de Serviços',
deductions: 0,
discounts: 0,
totalValue: 1500.5,
observation: 'Referente ao contrato 1234',
externalId: '6f1b7c52-8a4e-4d3f-9c21-b0e5a7d84c19',
externalParentId: 'INVOICE'
})
};
fetch('https://api.accounting.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/tax-document', 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.accounting.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/tax-document",
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([
'environment' => 'TEST',
'competenceDate' => '2026-10-01T00:00:00.000Z',
'taxDocumentCustomer' => [
'type' => 'COMPANY',
'name' => 'Acme Tecnologia Ltda',
'email' => 'financeiro@acme.com.br',
'federalDocument' => '12345678000195',
'addressState' => 'MG',
'addressCity' => 'Uberlândia',
'addressStreet' => 'Avenida João Naves de Ávila',
'addressNumber' => '2121',
'addressNeighbourhood' => 'Santa Mônica',
'addressPostalCode' => '38408100',
'municipalDocument' => '123456',
'stateDocument' => '123456789',
'phone' => '+5534991234567',
'addressComplement' => 'Sala 101'
],
'type' => 'NFSE',
'operationNature' => 'Prestação de Serviços',
'deductions' => 0,
'discounts' => 0,
'totalValue' => 1500.5,
'observation' => 'Referente ao contrato 1234',
'externalId' => '6f1b7c52-8a4e-4d3f-9c21-b0e5a7d84c19',
'externalParentId' => 'INVOICE'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.accounting.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/tax-document"
payload := strings.NewReader("{\n \"environment\": \"TEST\",\n \"competenceDate\": \"2026-10-01T00:00:00.000Z\",\n \"taxDocumentCustomer\": {\n \"type\": \"COMPANY\",\n \"name\": \"Acme Tecnologia Ltda\",\n \"email\": \"financeiro@acme.com.br\",\n \"federalDocument\": \"12345678000195\",\n \"addressState\": \"MG\",\n \"addressCity\": \"Uberlândia\",\n \"addressStreet\": \"Avenida João Naves de Ávila\",\n \"addressNumber\": \"2121\",\n \"addressNeighbourhood\": \"Santa Mônica\",\n \"addressPostalCode\": \"38408100\",\n \"municipalDocument\": \"123456\",\n \"stateDocument\": \"123456789\",\n \"phone\": \"+5534991234567\",\n \"addressComplement\": \"Sala 101\"\n },\n \"type\": \"NFSE\",\n \"operationNature\": \"Prestação de Serviços\",\n \"deductions\": 0,\n \"discounts\": 0,\n \"totalValue\": 1500.5,\n \"observation\": \"Referente ao contrato 1234\",\n \"externalId\": \"6f1b7c52-8a4e-4d3f-9c21-b0e5a7d84c19\",\n \"externalParentId\": \"INVOICE\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/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.accounting.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/tax-document")
.header("Content-Type", "application/json")
.body("{\n \"environment\": \"TEST\",\n \"competenceDate\": \"2026-10-01T00:00:00.000Z\",\n \"taxDocumentCustomer\": {\n \"type\": \"COMPANY\",\n \"name\": \"Acme Tecnologia Ltda\",\n \"email\": \"financeiro@acme.com.br\",\n \"federalDocument\": \"12345678000195\",\n \"addressState\": \"MG\",\n \"addressCity\": \"Uberlândia\",\n \"addressStreet\": \"Avenida João Naves de Ávila\",\n \"addressNumber\": \"2121\",\n \"addressNeighbourhood\": \"Santa Mônica\",\n \"addressPostalCode\": \"38408100\",\n \"municipalDocument\": \"123456\",\n \"stateDocument\": \"123456789\",\n \"phone\": \"+5534991234567\",\n \"addressComplement\": \"Sala 101\"\n },\n \"type\": \"NFSE\",\n \"operationNature\": \"Prestação de Serviços\",\n \"deductions\": 0,\n \"discounts\": 0,\n \"totalValue\": 1500.5,\n \"observation\": \"Referente ao contrato 1234\",\n \"externalId\": \"6f1b7c52-8a4e-4d3f-9c21-b0e5a7d84c19\",\n \"externalParentId\": \"INVOICE\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.accounting.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/tax-document")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"environment\": \"TEST\",\n \"competenceDate\": \"2026-10-01T00:00:00.000Z\",\n \"taxDocumentCustomer\": {\n \"type\": \"COMPANY\",\n \"name\": \"Acme Tecnologia Ltda\",\n \"email\": \"financeiro@acme.com.br\",\n \"federalDocument\": \"12345678000195\",\n \"addressState\": \"MG\",\n \"addressCity\": \"Uberlândia\",\n \"addressStreet\": \"Avenida João Naves de Ávila\",\n \"addressNumber\": \"2121\",\n \"addressNeighbourhood\": \"Santa Mônica\",\n \"addressPostalCode\": \"38408100\",\n \"municipalDocument\": \"123456\",\n \"stateDocument\": \"123456789\",\n \"phone\": \"+5534991234567\",\n \"addressComplement\": \"Sala 101\"\n },\n \"type\": \"NFSE\",\n \"operationNature\": \"Prestação de Serviços\",\n \"deductions\": 0,\n \"discounts\": 0,\n \"totalValue\": 1500.5,\n \"observation\": \"Referente ao contrato 1234\",\n \"externalId\": \"6f1b7c52-8a4e-4d3f-9c21-b0e5a7d84c19\",\n \"externalParentId\": \"INVOICE\"\n}"
response = http.request(request)
puts response.read_body{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "TAX_ISSUER_PROVIDER_ID_NOT_FOUND",
"origin": "ACCOUNTING",
"message": "Tax issuer provider id not exists"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "TAX_ISSUER_NOT_FOUND",
"origin": "ACCOUNTING",
"message": "Tax issuer not found"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "TAX_DOCUMENT_ALREADY_ISSUED",
"origin": "ACCOUNTING",
"message": "A tax document was already issued for this externalId"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BAD_REQUEST",
"origin": "ACCOUNTING",
"message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
"fields": [
{
"field": "environment",
"message": "Invalid option: expected one of \"LIVE\"|\"TEST\"",
"code": "ENVIRONMENT_ONE_OF",
"values": [
"LIVE",
"TEST"
]
}
]
}Issuance is asynchronous. The request answers
204 as soon as the tax provider has accepted the document, which is created with the status WAITINGFORAUTHORIZATION and later moves to AUTHORIZED or DENIED. Find it in List tax documents: each item carries the externalId you sent, and you can download its PDF and XML with Download a tax document once it is AUTHORIZED.
Send externalId together with externalParentId (both or neither) to make the request safe to retry: while a document with that externalId exists and is not DENIED or CANCELED, issuing another one answers 409 TAX_DOCUMENT_ALREADY_ISSUED. Treat that answer as “already issued”, not as a failure. After a DENIED or CANCELED document you can issue again with the same externalId.
The service code, CNAE and LC 116 item you omit are taken from the configuration of your tax issuer for the environment you choose. The NFSe is issued for totalValue with the ISS rate registered for your tax issuer; issRate, deductions, discounts, the place of service and the tax amounts you send are recorded with the document. Use TEST to issue homologation documents, which have no fiscal value. Every amount is in reais.
If the tax provider rejects the request, the error is returned with the provider’s error code and a status of 400, 409, 422 or 502.Path Parameters
ID of your realm.
Format: UUID
ID of the organization that issues the tax document.
Format: UUID
Body
application/json
LIVE issues a real document. TEST issues a homologation document, which has no fiscal value. It also selects which configuration of your tax issuer fills in what you omit.
Available options:
LIVE, TEST Example:
"TEST"
Competence date of the document: the date the service refers to. An ISO 8601 date or date-time.
Example:
"2026-10-01T00:00:00.000Z"
The customer (service taker) of the document.
Show child attributes
Show child attributes
Type of the document. NFSE is the only type, and the default.
Available options:
NFSE Example:
"NFSE"
Nature of the operation. It is stored with the document, but it is not printed on it.
Example:
"Prestação de Serviços"
Deductions, in reais (150.5 is R$ 150.50). Recorded with the document; the NFSe is issued for totalValue.
Example:
0
Discounts, in reais (150.5 is R$ 150.50). Recorded with the document; the NFSe is issued for totalValue.
Example:
0
Total value of the document, in reais (1500.5 is R$ 1,500.50).
Example:
1500.5
Free text printed on the document.
Example:
"Referente ao contrato 1234"
Your own ID for what this document bills (an invoice, for example), a UUID v4. Send it together with externalParentId. While a document with this externalId exists and is not DENIED or CANCELED, issuing another one answers 409 TAX_DOCUMENT_ALREADY_ISSUED, so you can safely retry a request whose answer you lost. Each tax document you list carries it back as externalId.
Format: UUID (version 4)
Example:
"6f1b7c52-8a4e-4d3f-9c21-b0e5a7d84c19"
What externalId refers to: INVOICE or INVOICE_STATEMENT. Required when you send externalId, and not accepted without it.
Available options:
INVOICE, INVOICE_STATEMENT Example:
"INVOICE"
The service the document bills. Send it: the state, the city, the description and the municipal description of the service have no default. The optional fields below fall back to your tax issuer's configuration for the environment.
Show child attributes
Show child attributes
Response
No Content. The operation succeeded and the response has no body.