List municipal configurations

Endpoint used to query which tax information the municipality requires for invoice issuance.

This request should be the first step of the fiscal integration, since not all municipalities require the same data. The response informs which fields must later be filled in the endpoint for creating or updating fiscal information.

The query considers the city registered in the account's CNPJ.

Returned information

The response may include the following fields:

  • authenticationType - Indicates which authentication method is required by the municipality for invoice issuance.

Possible values are:

  • CERTIFICATE - The municipality requires a digital certificate.

  • TOKEN - The municipality requires an access token.

  • USER_AND_PASSWORD - The municipality requires username and password.

  • supportsCancellation - Indicates whether the municipality allows automatic invoice cancellation through integration.

  • usesSpecialTaxRegimes - Indicates whether the municipality requires a special tax regime to be sent. When this field is true, the value must be sent in the specialTaxRegime attribute when creating or updating fiscal information.

  • usesServiceListItem - Indicates whether the municipality requires the service list item. When this field is true, the value must be sent in serviceListItem.

  • specialTaxRegimesList - List of special tax regimes accepted by the municipality. Each item usually contains:

    • label - Display name of the regime.
    • value - Identifier that must be sent to the API.
  • municipalInscriptionHelp - Support text with guidance on the expected format for the municipal registration.

  • specialTaxRegimeHelp - Support text about filling in the special tax regime.

  • serviceListItemHelp - Support text about the service list item.

  • digitalCertificatedHelp - Support text about the digital certificate.

  • accessTokenHelp - Support text about the token required by the municipality.

  • municipalServiceCodeHelp - Support text about the format of the municipal service code.

🚧

Attention

Each municipality has its own rules for invoice issuance.

  • Some municipalities require authentication through a digital certificate, while others use token or username and password.
  • Fields such as specialTaxRegime and serviceListItem may be mandatory depending on the returned configuration.
  • It is always recommended to query this endpoint before configuring or updating the account's fiscal information.

Importance of the query

This endpoint is important because it prevents configuration attempts using incorrect, invalid, or unnecessary fields.

Using this query beforehand reduces failures in the fiscal issuance process and ensures that the integration sends only the information required by the corresponding municipality.

Responses

403

Forbidden. Occurs when the request body is filled, GET method calls must have an empty body.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json