Treeunfe API home pagelight logo
  1. Guides
  2. Records

Records belong to the organization that owns the x-api-key. They all follow the same route pattern:

ActionCustomersProductsCarriers
CreatePOST /customersPOST /productsPOST /carriers
ListGET /customersGET /productsGET /carriers
GetGET /customers/{id}GET /products/{id}GET /carriers/{id}
UpdatePUT /customers/{id}PUT /products/{id}PUT /carriers/{id}
DeleteDELETE /customers/{id}DELETE /products/{id}DELETE /carriers/{id}

When updating (PUT), send only the fields that changed.

​
Customers

What to send depends on the customer’s document.

​
Scenario 01 — Registering by CNPJ

With a CNPJ (company tax ID), the minimal payload is enough. The API looks up the other data, such as the company name and address, by the CNPJ.

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

For an ICMS taxpayer, also send the IE (state registration).

​
Scenario 02 — Registering by CPF

With a CPF (individual tax ID), there is no lookup: the API stores the address and the other fields exactly as sent.

  • Send the full payload, with the name, indIEDest, and address.
  • If the CPF is sent alone, or a required field is missing, the customer is not created. The API returns an error listing the missing fields.

Full payload model:

{
  "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"
  }
}

See every field in Create customer.

In the customer record, indIEDest is text (e.g. NAO_CONTRIBUINTE, “not a taxpayer”). In the NF-e payload, the same field is numeric (9).

​
Products

{
  "cProd": "6654",
  "xProd": "PLACA DE IDENTIFICACAO",
  "NCM": "83100000",
  "cEAN": "SEM GTIN",
  "uCom": "UN",
  "orig": 0,
  "vUnCom": 0
}
FieldDescription
cProdThe product’s internal code.
NCMNCM code (Mercosur product classification) with 8 digits.
cEANGTIN, or SEM GTIN (“no GTIN”).
origOrigin of the goods (0 to 8, from the NF-e table).

​
Carriers

{
  "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
}

For carriers, the address fields sit at the root of the object, not inside address.