Treeunfe API NF-e B2C home pagelight logo
  1. Guias
  2. Cadastros

Os cadastros pertencem à empresa dona da x-api-key. Todos seguem o mesmo padrão de rotas:

AçãoClientesProdutosTransportadoras
CriarPOST /customersPOST /productsPOST /carriers
ListarGET /customersGET /productsGET /carriers
BuscarGET /customers/{id}GET /products/{id}GET /carriers/{id}
AtualizarPUT /customers/{id}PUT /products/{id}PUT /carriers/{id}
ExcluirDELETE /customers/{id}DELETE /products/{id}DELETE /carriers/{id}

Na atualização (PUT), envie só os campos que mudaram.

​
Clientes

O que enviar depende do documento do cliente.

​
Cenário 01 — Cadastro por CNPJ

Com CNPJ, basta o payload mínimo. A API busca os demais dados, como razão social e endereço, pelo CNPJ.

{
  "CNPJCPF": "48291537000184",
  "indIEDest": "CONTRIBUINTE_ICMS",
  "IE": "9081345241"
}

Para contribuinte do ICMS, envie também a IE.

​
Cenário 02 — Cadastro por CPF

Com CPF, não há consulta à base: a API grava o endereço e os demais campos como foram enviados.

  • Envie o payload completo, com nome, indIEDest e endereço.
  • Se o CPF vier sozinho, ou faltar algum campo obrigatório, o cliente não é cadastrado. A API devolve um erro listando os campos que faltam.

Modelo do payload completo:

{
  "CNPJCPF": "12345678909",
  "xNome": "CLIENTE QA CONTRIBUINTE ICMS LTDA",
  "xFant": "QA CONTRIBUINTE",
  "indIEDest": "CONTRIBUINTE_ICMS",
  "IE": "9081345241",
  "email": "qa-contribuinte@example.com",
  "address": {
    "xLgr": "RUA DE TESTE QA",
    "nro": "100",
    "xCpl": "SALA 1",
    "xBairro": "CENTRO",
    "cMun": 4115200,
    "xMun": "MARINGA",
    "UF": "PR",
    "CEP": "87013000",
    "cPais": 1058,
    "xPais": "BRASIL",
    "fone": "4430000000"
  }
}

Veja todos os campos em Cadastrar cliente.

No cadastro de cliente, indIEDest é um texto (ex.: NAO_CONTRIBUINTE). No payload da NF-e, o mesmo campo é numérico (9).

​
Produtos

{
  "cProd": "6654",
  "xProd": "PLACA DE IDENTIFICACAO",
  "NCM": "83100000",
  "cEAN": "SEM GTIN",
  "uCom": "UN",
  "orig": 0,
  "vUnCom": 0
}
CampoDescrição
cProdCódigo interno do produto.
NCMNCM com 8 dígitos.
cEANGTIN, ou SEM GTIN.
origOrigem da mercadoria (0 a 8, tabela da NF-e).

​
Transportadoras

{
  "CNPJCPF": "12345678000195",
  "xNome": "TRANSPORTADORA EXEMPLO LTDA",
  "xFant": "TRANSPORTES EXEMPLO",
  "IE": "112347339",
  "fone": "+556499999999",
  "CEP": "76600000",
  "xLgr": "Rua Exemplo",
  "nro": "138",
  "xBairro": "Centro",
  "xMun": "Goiânia",
  "UF": "GO",
  "cMun": 5208707
}

Na transportadora, os campos de endereço ficam na raiz do objeto, e não dentro de address.