Referência

Centros de custo

Listar e criar centros de custo.

URL Base

https://api.iopoint.com.br/api

Endpoints

GET/customer/v2/cost-centerListar centros de custo
POST/customer/v2/cost-centerCriar centro de custo

Listar centros de custo

GET/customer/v2/cost-center

Retorna a lista de centros de custo ativos da empresa. Centros de custo inativos não aparecem.

Query parameters

Nome	Tipo	Obrig.	Descrição
include_branches	boolean	não	Quando `1`, agrega a matriz e todas as filiais do grupo econômico na resposta. Só leitura.
company_national_registry	string	não	CNPJ (apenas dígitos) de uma empresa do grupo para restringir o escopo a ela. Use os CNPJs retornados em `GET /economic-group`. Fora do grupo acessível retorna `company_not_found` (404).

Exemplos

Request

curl -X GET "https://api.iopoint.com.br/api/customer/v2/cost-center" \
  -H "apiIopointToken: SEU_TOKEN_AQUI"

Response200

{
  "data": [
    {
      "id": 1,
      "name": "Matriz - SP"
    },
    {
      "id": 2,
      "name": "Filial - RJ"
    }
  ]
}

Respostas

200

{
  "data": [
    {
      "id": 1,
      "name": "Matriz - SP"
    },
    {
      "id": 2,
      "name": "Filial - RJ"
    }
  ]
}

Request

curl -X GET "https://api.iopoint.com.br/api/customer/v2/cost-center" \
  -H "apiIopointToken: SEU_TOKEN_AQUI"

Response200

{
  "data": [
    {
      "id": 1,
      "name": "Matriz - SP"
    },
    {
      "id": 2,
      "name": "Filial - RJ"
    }
  ]
}

Criar centro de custo

POST/customer/v2/cost-center

Cria um novo centro de custo para a empresa autenticada. O centro de custo é sempre criado como ativo — não há opção de criar inativo via API.

Body (application/json)

Nome	Tipo	Obrig.	Descrição
name	string	sim	Nome do centro de custo.

Erros possíveis

Status	Código	Quando ocorre
422	invalid_request_payload	Campo `name` não informado ou vazio.

Exemplos

Request

curl -X POST "https://api.iopoint.com.br/api/customer/v2/cost-center" \
  -H "apiIopointToken: SEU_TOKEN_AQUI" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Filial - MG"
}'

Response201

{
  "data": {
    "id": 7
  }
}

Respostas

201

{
  "data": {
    "id": 7
  }
}

Request

curl -X POST "https://api.iopoint.com.br/api/customer/v2/cost-center" \
  -H "apiIopointToken: SEU_TOKEN_AQUI" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Filial - MG"
}'

Response201

{
  "data": {
    "id": 7
  }
}