Get your tax issuer

curl --request GET \
  --url https://api.accounting.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/tax-issuer

const options = {method: 'GET'};

fetch('https://api.accounting.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/tax-issuer', 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-issuer",
  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.accounting.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/tax-issuer"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.accounting.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/tax-issuer")

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

{
  "id": "9b2f4c1e-7a3d-4e8b-b6f0-2d5c8a1e3f47",
  "realm": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
  "organization": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
  "tradingName": "Acme Tecnologia",
  "legalName": "Acme Tecnologia Ltda",
  "document": "12345678000195",
  "email": "fiscal@acme.com.br",
  "status": "ACTIVE",
  "hasLogotype": true,
  "address": {
    "city": "Uberlândia",
    "neighborhood": "Centro",
    "number": "1000",
    "state": "MG",
    "street": "Avenida Getúlio Vargas",
    "postalCode": "38400-000",
    "complement": "Sala 12",
    "stateCode": 31,
    "cityCode": 3170206
  },
  "homologationProperties": {
    "id": "7c1e5a90-3b2d-4f68-8a14-d9e0b6c2f375",
    "specialTaxCode": "1",
    "municipalServiceCode": "0107",
    "serviceListItem": "1.07",
    "cnae": 6201501,
    "issTax": 2.5,
    "serviceDescription": "Licenciamento de software como serviço (SaaS)",
    "hasCulturalIncentive": false,
    "isSimplesNacional": true,
    "nfeSequencialCode": 1,
    "nfeSeries": "1",
    "nfeSequencialBatch": 1,
    "hasCertificate": true,
    "environment": "TEST",
    "taxConfiguration": {
      "nbsCode": "115090000",
      "nationalTaxCode": "010701",
      "taxClassification": "000001",
      "operationIndicatorCode": "100301"
    }
  },
  "productionProperties": {
    "id": "a4d8e2f1-6b3c-4e9a-8f05-1c7b9d2e6a30",
    "specialTaxCode": "1",
    "municipalServiceCode": "0107",
    "serviceListItem": "1.07",
    "cnae": 6201501,
    "issTax": 2.5,
    "serviceDescription": "Licenciamento de software como serviço (SaaS)",
    "hasCulturalIncentive": false,
    "isSimplesNacional": true,
    "nfeSequencialCode": 1,
    "nfeSeries": "1",
    "nfeSequencialBatch": 1,
    "hasCertificate": true,
    "environment": "LIVE",
    "taxConfiguration": {
      "nbsCode": "115090000",
      "nationalTaxCode": "010701",
      "taxClassification": "000001",
      "operationIndicatorCode": "100301"
    }
  },
  "municipalDocument": "123456",
  "stateDocument": "654321",
  "phoneNumber": "+5534984325252",
  "mainActivity": "Desenvolvimento de programas de computador sob encomenda"
}

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "TAX_ISSUER_NOT_FOUND",
  "origin": "ACCOUNTING",
  "message": "Tax issuer not found"
}

{
  "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": "organizationId",
      "message": "Invalid UUID",
      "code": "ORGANIZATIONID_UUID"
    }
  ]
}

GET

realms

{realmId}

organizations

{organizationId}

tax-issuer

Get your tax issuer

curl --request GET \
  --url https://api.accounting.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/tax-issuer

const options = {method: 'GET'};

fetch('https://api.accounting.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/tax-issuer', 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-issuer",
  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.accounting.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/tax-issuer"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.accounting.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/tax-issuer")

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

{
  "id": "9b2f4c1e-7a3d-4e8b-b6f0-2d5c8a1e3f47",
  "realm": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
  "organization": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
  "tradingName": "Acme Tecnologia",
  "legalName": "Acme Tecnologia Ltda",
  "document": "12345678000195",
  "email": "fiscal@acme.com.br",
  "status": "ACTIVE",
  "hasLogotype": true,
  "address": {
    "city": "Uberlândia",
    "neighborhood": "Centro",
    "number": "1000",
    "state": "MG",
    "street": "Avenida Getúlio Vargas",
    "postalCode": "38400-000",
    "complement": "Sala 12",
    "stateCode": 31,
    "cityCode": 3170206
  },
  "homologationProperties": {
    "id": "7c1e5a90-3b2d-4f68-8a14-d9e0b6c2f375",
    "specialTaxCode": "1",
    "municipalServiceCode": "0107",
    "serviceListItem": "1.07",
    "cnae": 6201501,
    "issTax": 2.5,
    "serviceDescription": "Licenciamento de software como serviço (SaaS)",
    "hasCulturalIncentive": false,
    "isSimplesNacional": true,
    "nfeSequencialCode": 1,
    "nfeSeries": "1",
    "nfeSequencialBatch": 1,
    "hasCertificate": true,
    "environment": "TEST",
    "taxConfiguration": {
      "nbsCode": "115090000",
      "nationalTaxCode": "010701",
      "taxClassification": "000001",
      "operationIndicatorCode": "100301"
    }
  },
  "productionProperties": {
    "id": "a4d8e2f1-6b3c-4e9a-8f05-1c7b9d2e6a30",
    "specialTaxCode": "1",
    "municipalServiceCode": "0107",
    "serviceListItem": "1.07",
    "cnae": 6201501,
    "issTax": 2.5,
    "serviceDescription": "Licenciamento de software como serviço (SaaS)",
    "hasCulturalIncentive": false,
    "isSimplesNacional": true,
    "nfeSequencialCode": 1,
    "nfeSeries": "1",
    "nfeSequencialBatch": 1,
    "hasCertificate": true,
    "environment": "LIVE",
    "taxConfiguration": {
      "nbsCode": "115090000",
      "nationalTaxCode": "010701",
      "taxClassification": "000001",
      "operationIndicatorCode": "100301"
    }
  },
  "municipalDocument": "123456",
  "stateDocument": "654321",
  "phoneNumber": "+5534984325252",
  "mainActivity": "Desenvolvimento de programas de computador sob encomenda"
}

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "TAX_ISSUER_NOT_FOUND",
  "origin": "ACCOUNTING",
  "message": "Tax issuer not found"
}

{
  "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": "organizationId",
      "message": "Invalid UUID",
      "code": "ORGANIZATIONID_UUID"
    }
  ]
}

The tax issuer is the registration of your organization that issues its service invoices (NFSe). The response carries the organization’s registration data (name, CNPJ, address, taken from Portão 3), the TEST (homologation) and LIVE (production) configurations, and whether a digital certificate and a logotype have been uploaded. Use its id as {taxIssuer} in the upload routes. Only an active tax issuer is returned: one you deactivated, or that never finished its creation, is answered as not found.

Path Parameters

realmId

string<uuid>

required

ID of your realm.

Format: UUID

organizationId

string<uuid>

required

ID of the organization.

Format: UUID

Response

Successful response

The tax issuer of an organization: who issues its NFSe, and how, in the test and live environments.

string<uuid>

required

ID of the tax issuer. Use it as {taxIssuer} in the upload routes.

Example:

"9b2f4c1e-7a3d-4e8b-b6f0-2d5c8a1e3f47"

realm

string<uuid>

required

ID of your realm.

Example:

"f495ff0c-ab54-4f99-8e92-ca8682e4de9b"

organization

string<uuid>

required

ID of the organization.

Example:

"c4bd3f21-dfbd-44e8-8055-68ba15bed410"

tradingName

string

required

Trade name of the organization.

Example:

"Acme Tecnologia"

legalName

string

required

Legal name of the organization.

Example:

"Acme Tecnologia Ltda"

document

string

required

CNPJ of the organization, digits only.

Example:

"12345678000195"

string

required

E-mail of the organization.

Example:

"fiscal@acme.com.br"

status

enum<string>

required

Status of the tax issuer. Only an ACTIVE issuer is returned.

Available options:

ACTIVE,

INACTIVE,

ERROR

Example:

"ACTIVE"

hasLogotype

boolean

required

Whether a logotype has been uploaded.

Example:

true

address

object

required

Registered address of the organization.

Show child attributes

homologationProperties

object

required

Configuration of the test (homologation) environment: documents issued here have no fiscal value.

Show child attributes

productionProperties

object

required

Configuration of the live (production) environment: documents issued here are legally valid.

Show child attributes

municipalDocument

string

Municipal registration (inscrição municipal) of the organization.

Example:

"123456"

stateDocument

string

State registration (inscrição estadual) of the organization.

Example:

"654321"

phoneNumber

string

Phone number of the organization, in international format.

Example:

"+5534984325252"

mainActivity

string

Main business activity of the organization.

Example:

"Desenvolvimento de programas de computador sob encomenda"

Overview

Identity

Banking

Billing

Accounting

Registry

Platform

Notification

Rule Engine

Scheduling

Travel

Vehicles

Attachments

Get your tax issuer

Path Parameters

Response