Skip to main content
GET
List all companies for the current tenant

Response

Response

200 - application/json

Return all companies.

name
string
required

Company Name

Example:

"Acme Corp"

document
string
required

CNPJ or CPF

Example:

"12345678000199"

status
enum<string>
required

Company Status

Available options:
ACTIVE,
DISABLED,
BLOCKED,
SUSPENDED
Example:

"ACTIVE"

settings
object
required

Configuration Settings

Example:
taxRegime
enum<string>
required

Tax Regime

Available options:
SIMPLES_NACIONAL,
LUCRO_PRESUMIDO,
LUCRO_REAL
Example:

"SIMPLES_NACIONAL"

costMethod
enum<string>
required

Cost Method

Available options:
REPLACEMENT,
WEIGHTED_AVERAGE
Example:

"WEIGHTED_AVERAGE"

email
string

Contact Email

Example:

"contact@acme.com"

address
object

Address Object