Configuracoes & Lookup

Consulte dados de configuracao e lookup da empresa. Todos os endpoints deste modulo sao somente leitura.

Centros de Custo

Listar Centros de Custo

GET /external/v1/cost-centers

Retorna uma lista paginada de centros de custo.

Query Parameters:

Parametro	Tipo	Obrigatorio	Descricao
page	number	Nao	Pagina atual (default: 1)
limit	number	Nao	Itens por pagina (default: 20, max: 100)

Exemplo de requisicao:

curl -X GET "https://api.tesselys.com.br/external/v1/cost-centers?limit=20" \
  -H "Authorization: Bearer {accessToken}" \
  -H "x-company-token: {companyToken}"

Resposta (200):

{
  "data": [
    {
      "id": "clxcc01a2b3c4d5e6f7g8h9i0",
      "name": "Departamento Comercial",
      "code": "CC-001",
      "description": "Centro de custo do departamento comercial",
      "isActive": true,
      "createdAt": "2026-01-05T10:00:00.000Z"
    },
    {
      "id": "clxcc02b3c4d5e6f7g8h9i0j1",
      "name": "Departamento de Tecnologia",
      "code": "CC-002",
      "description": "Centro de custo do departamento de TI",
      "isActive": true,
      "createdAt": "2026-01-05T10:00:00.000Z"
    },
    {
      "id": "clxcc03c4d5e6f7g8h9i0j1k2",
      "name": "Administrativo",
      "code": "CC-003",
      "description": "Centro de custo administrativo geral",
      "isActive": true,
      "createdAt": "2026-01-05T10:00:00.000Z"
    }
  ],
  "meta": {
    "total": 3,
    "page": 1,
    "limit": 20,
    "totalPages": 1
  }
}

Buscar Centro de Custo por ID

GET /external/v1/cost-centers/:id

Exemplo de requisicao:

curl -X GET "https://api.tesselys.com.br/external/v1/cost-centers/clxcc01a2b3c4d5e6f7g8h9i0" \
  -H "Authorization: Bearer {accessToken}" \
  -H "x-company-token: {companyToken}"

Resposta (200):

{
  "id": "clxcc01a2b3c4d5e6f7g8h9i0",
  "name": "Departamento Comercial",
  "code": "CC-001",
  "description": "Centro de custo do departamento comercial",
  "isActive": true,
  "createdAt": "2026-01-05T10:00:00.000Z"
}

Unidades de Negocio

Listar Unidades de Negocio

GET /external/v1/business-units

Retorna uma lista paginada de unidades de negocio.

Query Parameters:

Parametro	Tipo	Obrigatorio	Descricao
page	number	Nao	Pagina atual (default: 1)
limit	number	Nao	Itens por pagina (default: 20, max: 100)

Exemplo de requisicao:

curl -X GET "https://api.tesselys.com.br/external/v1/business-units?limit=20" \
  -H "Authorization: Bearer {accessToken}" \
  -H "x-company-token: {companyToken}"

Resposta (200):

{
  "data": [
    {
      "id": "clxbu01a2b3c4d5e6f7g8h9i0",
      "name": "Filial Sao Paulo",
      "description": "Unidade de negocio da filial de Sao Paulo",
      "isActive": true,
      "createdAt": "2026-01-03T08:00:00.000Z"
    },
    {
      "id": "clxbu02b3c4d5e6f7g8h9i0j1",
      "name": "Filial Rio de Janeiro",
      "description": "Unidade de negocio da filial do Rio de Janeiro",
      "isActive": true,
      "createdAt": "2026-01-03T08:00:00.000Z"
    }
  ],
  "meta": {
    "total": 2,
    "page": 1,
    "limit": 20,
    "totalPages": 1
  }
}

Buscar Unidade de Negocio por ID

GET /external/v1/business-units/:id

Exemplo de requisicao:

curl -X GET "https://api.tesselys.com.br/external/v1/business-units/clxbu01a2b3c4d5e6f7g8h9i0" \
  -H "Authorization: Bearer {accessToken}" \
  -H "x-company-token: {companyToken}"

Resposta (200):

{
  "id": "clxbu01a2b3c4d5e6f7g8h9i0",
  "name": "Filial Sao Paulo",
  "description": "Unidade de negocio da filial de Sao Paulo",
  "isActive": true,
  "createdAt": "2026-01-03T08:00:00.000Z"
}

Campos Customizados

Listar Campos Customizados

GET /external/v1/custom-fields

Retorna uma lista paginada de campos customizados configurados pela empresa.

Query Parameters:

Parametro	Tipo	Obrigatorio	Descricao
page	number	Nao	Pagina atual (default: 1)
limit	number	Nao	Itens por pagina (default: 20, max: 100)
entityType	string	Nao	Tipo da entidade: PERSON, DEAL, PROJECT, FINANCIAL_ENTRY, TICKET

Exemplo de requisicao:

curl -X GET "https://api.tesselys.com.br/external/v1/custom-fields?entityType=PERSON&limit=20" \
  -H "Authorization: Bearer {accessToken}" \
  -H "x-company-token: {companyToken}"

Resposta (200):

{
  "data": [
    {
      "id": "clxcf01a2b3c4d5e6f7g8h9i0",
      "name": "segmento_mercado",
      "label": "Segmento de Mercado",
      "fieldType": "SELECT",
      "entityType": "PERSON",
      "options": [
        "Tecnologia",
        "Saude",
        "Educacao",
        "Varejo",
        "Industria"
      ],
      "isRequired": false,
      "isActive": true,
      "createdAt": "2026-02-10T14:00:00.000Z"
    },
    {
      "id": "clxcf02b3c4d5e6f7g8h9i0j1",
      "name": "numero_funcionarios",
      "label": "Numero de Funcionarios",
      "fieldType": "NUMBER",
      "entityType": "PERSON",
      "options": null,
      "isRequired": false,
      "isActive": true,
      "createdAt": "2026-02-10T14:00:00.000Z"
    },
    {
      "id": "clxcf03c4d5e6f7g8h9i0j1k2",
      "name": "data_fundacao",
      "label": "Data de Fundacao",
      "fieldType": "DATE",
      "entityType": "PERSON",
      "options": null,
      "isRequired": false,
      "isActive": true,
      "createdAt": "2026-02-10T14:00:00.000Z"
    }
  ],
  "meta": {
    "total": 3,
    "page": 1,
    "limit": 20,
    "totalPages": 1
  }
}

Buscar Campo Customizado por ID

GET /external/v1/custom-fields/:id

Exemplo de requisicao:

curl -X GET "https://api.tesselys.com.br/external/v1/custom-fields/clxcf01a2b3c4d5e6f7g8h9i0" \
  -H "Authorization: Bearer {accessToken}" \
  -H "x-company-token: {companyToken}"

Resposta (200):

{
  "id": "clxcf01a2b3c4d5e6f7g8h9i0",
  "name": "segmento_mercado",
  "label": "Segmento de Mercado",
  "fieldType": "SELECT",
  "entityType": "PERSON",
  "options": [
    "Tecnologia",
    "Saude",
    "Educacao",
    "Varejo",
    "Industria"
  ],
  "isRequired": false,
  "isActive": true,
  "createdAt": "2026-02-10T14:00:00.000Z"
}

Valores de Enum

entityType

Valor	Descricao
PERSON	Pessoa (cliente, fornecedor, etc.)
DEAL	Negociacao
PROJECT	Projeto
FINANCIAL_ENTRY	Lancamento financeiro
TICKET	Ticket de suporte

fieldType

Valor	Descricao
TEXT	Campo de texto livre
NUMBER	Campo numerico
DATE	Campo de data
SELECT	Selecao unica (ver campo options)
MULTISELECT	Selecao multipla (ver campo options)
BOOLEAN	Campo verdadeiro/falso