- Guias
- Cadastro de organizations
Guias
Cadastro de organizations
Crie, edite e inative as empresas emitentes da sua conta Enterprise.
Uma organization é uma empresa emitente da sua conta Enterprise. Todas as rotas desta página usam a chave Enterprise.
Criar
POST /enterprise/organizations
{
"CNPJCPF": "12345678000195",
"xNome": "Cliente Exemplo LTDA",
"xFant": "Cliente Exemplo",
"email": "fiscal@cliente-exemplo.com.br",
"fone": "+5511999887755",
"IE": "123456789",
"address": {
"xLgr": "Rua das Palmeiras",
"nro": "456",
"xBairro": "Centro",
"cMun": 3550308,
"xMun": "São Paulo",
"UF": "SP",
"CEP": "01002000"
},
"generateApiKey": false
}
| Campo | Descrição |
|---|---|
CNPJCPF | CNPJ ou CPF, só números. Não pode ser alterado depois. |
xNome / xFant | Razão social e nome fantasia. |
email, fone, IE | Contato e inscrição estadual. |
address | Endereço. cMun é o código IBGE do município (7 dígitos). |
generateApiKey | true gera uma API Key junto. Exige apiKeyOptions (veja as opções). |
A resposta (201) traz organization e, se pedido, apiKey. Guarde o organization.id: ele é usado nas outras rotas.
Editar
PATCH /enterprise/organizations/{organizationId}
Envie só os campos que mudaram:
{ "xNome": "Cliente Exemplo LTDA - Matriz" }
Campos aceitos: xNome, xFant, email, fone, IE, address e isActive.
O body é estrito. Qualquer campo fora dessa lista retorna 400. Enviar CNPJCPF, mesmo com o valor atual, retorna 400 CNPJ não pode ser alterado.
Inativar
{ "isActive": false }
Com a organization inativa, todas as API Keys dela recebem 403 Organization is inactive. Envie isActive: true para reativar.
Configuração fiscal
Antes de emitir, a organization precisa das configurações de NF-e preenchidas. Gere um link e envie ao cliente:
| Ação | Endpoint |
|---|---|
| Criar link | POST /bff/enterprise-group/organizations/{organizationId}/fiscal-config-invites |
| Listar links | GET /bff/enterprise-group/organizations/{organizationId}/fiscal-config-invites |
Certificado digital
A organization também precisa de um certificado A1 (.pfx). Estas rotas usam a x-api-key da organization:
| Ação | Endpoint |
|---|---|
| Enviar | POST /certificates/upload (multipart/form-data com file e password) |
| Consultar o atual | GET /certificates/current |
| Excluir | DELETE /certificates/{certificateId} |
curl -X POST https://api.treeunfe.com.br/api/v1/certificates/upload \
-H "x-api-key: RAW_KEY_DA_ORGANIZATION" \
-F "file=@certificado.pfx" \
-F "password=SENHA_DO_CERTIFICADO"