curl --request GET \
--url https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/nfse-configsimport requests
url = "https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/nfse-configs"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/nfse-configs', 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.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/nfse-configs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/nfse-configs"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/nfse-configs")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/nfse-configs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"event": "INVOICE_PAID",
"issWithheldAtSource": false,
"environment": "LIVE",
"createdAt": "2026-08-07T19:45:17.204Z",
"competence": "PAID_AT",
"observation": "Serviços prestados conforme contrato.",
"operationNature": "Prestação de Serviços"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "INSUFFICIENT_PERMISSIONS",
"origin": "BILLING",
"message": "insufficient permissions"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "NFSE_CONFIG_NOT_FOUND",
"origin": "BILLING",
"message": "NFSE_CONFIG not found"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BAD_REQUEST",
"origin": "BILLING",
"message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
"fields": [
{
"field": "organizationId",
"message": "Invalid UUID",
"code": "ORGANIZATIONID_UUID"
}
]
}Get the NFSe configuration
Returns the organization’s NFSe configuration: which billing event issues its service invoices (NFSe) automatically, and how they are filled in.
curl --request GET \
--url https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/nfse-configsimport requests
url = "https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/nfse-configs"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/nfse-configs', 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.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/nfse-configs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/nfse-configs"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/nfse-configs")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/nfse-configs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"event": "INVOICE_PAID",
"issWithheldAtSource": false,
"environment": "LIVE",
"createdAt": "2026-08-07T19:45:17.204Z",
"competence": "PAID_AT",
"observation": "Serviços prestados conforme contrato.",
"operationNature": "Prestação de Serviços"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "INSUFFICIENT_PERMISSIONS",
"origin": "BILLING",
"message": "insufficient permissions"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "NFSE_CONFIG_NOT_FOUND",
"origin": "BILLING",
"message": "NFSE_CONFIG not found"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BAD_REQUEST",
"origin": "BILLING",
"message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
"fields": [
{
"field": "organizationId",
"message": "Invalid UUID",
"code": "ORGANIZATIONID_UUID"
}
]
}Path Parameters
ID of your realm.
Format: UUID
ID of the organization the NFSe configuration belongs to.
Format: UUID
Response
Successful response
The organization's NFSe configuration.
Which billing event issues an NFSe: INVOICE_CLOSED (one per invoice, when it closes), INVOICE_PAID (one per invoice, when it is paid) or PAYMENT_RECEIVED (one per payment settled on an invoice).
INVOICE_PAID, INVOICE_CLOSED, PAYMENT_RECEIVED "INVOICE_PAID"
Whether the customer withholds the ISS at source.
false
LIVE for real NFSe, TEST for homologation documents with no fiscal value.
TEST, LIVE "LIVE"
When the configuration was created.
"2026-08-07T19:45:17.204Z"
Which date becomes the competence date of each NFSe: EVENT_DATE, CREATED_AT, CLOSED_AT, DUE_AT, PAID_AT or EFFECTIVE_AT. Absent on a configuration created before this field existed: its NFSe take the day the invoice was last updated.
EVENT_DATE, CREATED_AT, CLOSED_AT, DUE_AT, PAID_AT, EFFECTIVE_AT "PAID_AT"
Free text printed on every NFSe. Absent on a configuration created before this field existed, which prints none.
"Serviços prestados conforme contrato."
Nature of the operation, stored with every NFSe but not printed on it. Absent on a configuration created before this field existed, which stores Prestação de Serviços.
"Prestação de Serviços"