- Começando
- Primeiros passos
Começando
Primeiros passos
Crie uma organization, gere a API Key e emita a primeira NF-e em homologação.
Este guia leva você da criação do cliente até a primeira NF-e autorizada em homologação.
Você precisa de uma x-enterprise-key da sua conta Enterprise. Se ainda não tem, fale com o suporte.
Crie a organization com API Key
Cadastre o cliente e já gere uma chave de homologação no mesmo request.
curl -X POST https://api.treeunfe.com.br/api/v1/enterprise/organizations \
-H "Content-Type: application/json" \
-H "x-enterprise-key: SUA_ENTERPRISE_KEY" \
-d '{
"CNPJCPF": "12345678000195",
"xNome": "CLIENTE EXEMPLO LTDA",
"xFant": "CLIENTE EXEMPLO",
"email": "fiscal@cliente-exemplo.com.br",
"fone": "44999990000",
"IE": "9071311225",
"address": {
"xLgr": "Avenida Exemplo", "nro": "5145", "xBairro": "Zona 07",
"cMun": 4115200, "xMun": "MARINGA", "UF": "PR", "CEP": "87020035"
},
"generateApiKey": true,
"apiKeyOptions": {
"name": "chave-homologacao",
"scopes": "nfe:emit,nfe:read",
"tpAmb": "HOMOLOGACAO",
"expirationPreset": "1y"
}
}'
A resposta traz organization.id e apiKey.rawKey.
O rawKey só aparece nesta resposta. Guarde-o num cofre de segredos antes de seguir.
Envie o certificado digital
A organization precisa de um certificado A1 para assinar as notas.
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"
Peça ao cliente para preencher a configuração fiscal
Gere um link e envie ao cliente. Nele, ele preenche as configurações de NF-e da empresa.
curl -X POST https://api.treeunfe.com.br/api/v1/bff/enterprise-group/organizations/ORGANIZATION_ID/fiscal-config-invites \
-H "x-enterprise-key: SUA_ENTERPRISE_KEY"
Emita a NF-e
Envie a nota com a chave de homologação e calculateTaxes: true para a Treeunfe calcular os tributos. O payload completo está em Emissão de NF-e.
curl -X POST https://api.treeunfe.com.br/api/v1/nfe \
-H "Content-Type: application/json" \
-H "x-api-key: RAW_KEY_DA_ORGANIZATION" \
-d @nfe.json
Se a nota for autorizada, a resposta tem outcome: "SUCCESS", a chaveAcesso e o protocolo.