To Aqui - Sandbox

O modelo bem

id uuid

Identificador do bem.

patrimonio_number integer

Número de patrimônio (sequencial por escola).

status string

ativo, em_manutencao, emprestado ou baixado.

condition string

Estado de conservação: novo, bom, regular, ruim ou inservivel.

category / location object|null

Categoria e localização.

custodian object|null

Funcionário responsável pela guarda.

acquisition_date / acquisition_value date / number

Data e valor de aquisição.

O modelo bem

{
  "id": "01a0014b-d493-73cf-81a3-ba2c871aaf4d",
  "patrimonio_number": 1,
  "name": "Notebook Dell Latitude",
  "description": "Notebook do laboratório de informática",
  "serial_number": "SN-23984623984",
  "status": "ativo",
  "status_label": "Ativo",
  "condition": "bom",
  "condition_label": "Bom",
  "category": {
    "id": "01a000e8-32cb-720a-898c-7db33152bb28",
    "name": "Computadores e Equip. de Informática"
  },
  "location": {
    "id": "01a000e8-4410-7a2b-9c3d-2e1f0a9b8c7d",
    "name": "Laboratório de Informática"
  },
  "supplier": {
    "id": "01a0a9a0-52f8-73d2-9003-85196c24ae97",
    "name": "Distribuidora Demonstração"
  },
  "custodian": {
    "id": "019e6e4b-3235-727f-b423-89694ac61dea",
    "name": "Alana Salgado"
  },
  "acquisition_date": "2025-09-30",
  "acquisition_value": 4500,
  "invoice_number": "000981",
  "active": true,
  "created_at": "2025-10-01T08:00:00-03:00",
  "updated_at": "2026-03-11T15:40:00-03:00"
}

GET /v1/partners/school/{cnpj}/patrimonio/assets/all

Listar bens

Bens patrimoniais da escola, ordenados pelo número de patrimônio. Paginado (25 por página).

Parâmetros de rota

cnpj string obrigatório

CNPJ da escola (14 dígitos, sem formatação).

Filtros (query string)

search string opcional

Parte do nome, ou o número de patrimônio / número de série exato.

status string opcional

ativo, em_manutencao, emprestado ou baixado.

condition string opcional

novo, bom, regular, ruim ou inservivel.

category_id uuid opcional

Somente uma categoria.

location_id uuid opcional

Somente uma localização.

Códigos de resposta

200

Sucesso.

401

Credenciais inválidas (X-Partner, X-Client ou X-Authorization).

403

Cliente fora do plano Gestão Escolar (ERP_REQUIRED) ou módulo exclusivo de escolas privadas (PRIVATE_CLIENT_REQUIRED).

404

Escola ou recurso não encontrado.

422

Parâmetros inválidos — veja errors.

Requisição GET

GET /v1/partners/school/{cnpj}/patrimonio/assets/all

curl https://toakiescola.com.br/api/v1/partners/school/{cnpj}/patrimonio/assets/all \
  -H "X-Authorization: {api_token}" \
  -H "X-Partner: {partner_token}" \
  -H "X-Client: {client_slug}"

$response = $client->get('https://toakiescola.com.br/api/v1/partners/school/{cnpj}/patrimonio/assets/all', [
    'headers' => $headers, // X-Authorization, X-Partner, X-Client
]);

const res = await fetch('https://toakiescola.com.br/api/v1/partners/school/{cnpj}/patrimonio/assets/all', {
    method: 'GET',
    headers: { /* X-Authorization, X-Partner, X-Client */ 'Content-Type': 'application/json' },
});

Resposta

{
  "data": [
    {
      "id": "01a0014b-d493-73cf-81a3-ba2c871aaf4d",
      "patrimonio_number": 1,
      "name": "Notebook Dell Latitude",
      "description": "Notebook do laboratório de informática",
      "serial_number": "SN-23984623984",
      "status": "ativo",
      "status_label": "Ativo",
      "condition": "bom",
      "condition_label": "Bom",
      "category": {
        "id": "01a000e8-32cb-720a-898c-7db33152bb28",
        "name": "Computadores e Equip. de Informática"
      },
      "location": {
        "id": "01a000e8-4410-7a2b-9c3d-2e1f0a9b8c7d",
        "name": "Laboratório de Informática"
      },
      "supplier": {
        "id": "01a0a9a0-52f8-73d2-9003-85196c24ae97",
        "name": "Distribuidora Demonstração"
      },
      "custodian": {
        "id": "019e6e4b-3235-727f-b423-89694ac61dea",
        "name": "Alana Salgado"
      },
      "acquisition_date": "2025-09-30",
      "acquisition_value": 4500,
      "invoice_number": "000981",
      "active": true,
      "created_at": "2025-10-01T08:00:00-03:00",
      "updated_at": "2026-03-11T15:40:00-03:00"
    }
  ],
  "links": { /* first, prev, next */ },
  "meta": { "current_page": 1, "per_page": 25 }
}

{
  "success": false,
  "message": "Escola não encontrada."
}

GET /v1/partners/school/{cnpj}/patrimonio/asset/{id}

Obter bem

Um bem patrimonial.

Parâmetros de rota

cnpj string obrigatório

CNPJ da escola (14 dígitos, sem formatação).

id uuid obrigatório

UUID do bem.

Códigos de resposta

200

Sucesso.

401

Credenciais inválidas (X-Partner, X-Client ou X-Authorization).

403

Cliente fora do plano Gestão Escolar (ERP_REQUIRED) ou módulo exclusivo de escolas privadas (PRIVATE_CLIENT_REQUIRED).

404

Escola ou recurso não encontrado.

Requisição GET

GET /v1/partners/school/{cnpj}/patrimonio/asset/{id}

curl https://toakiescola.com.br/api/v1/partners/school/{cnpj}/patrimonio/asset/{id} \
  -H "X-Authorization: {api_token}" \
  -H "X-Partner: {partner_token}" \
  -H "X-Client: {client_slug}"

$response = $client->get('https://toakiescola.com.br/api/v1/partners/school/{cnpj}/patrimonio/asset/{id}', [
    'headers' => $headers, // X-Authorization, X-Partner, X-Client
]);

const res = await fetch('https://toakiescola.com.br/api/v1/partners/school/{cnpj}/patrimonio/asset/{id}', {
    method: 'GET',
    headers: { /* X-Authorization, X-Partner, X-Client */ 'Content-Type': 'application/json' },
});

Resposta

{
  "data": {
    "id": "01a0014b-d493-73cf-81a3-ba2c871aaf4d",
    "patrimonio_number": 1,
    "name": "Notebook Dell Latitude",
    "description": "Notebook do laboratório de informática",
    "serial_number": "SN-23984623984",
    "status": "ativo",
    "status_label": "Ativo",
    "condition": "bom",
    "condition_label": "Bom",
    "category": {
      "id": "01a000e8-32cb-720a-898c-7db33152bb28",
      "name": "Computadores e Equip. de Informática"
    },
    "location": {
      "id": "01a000e8-4410-7a2b-9c3d-2e1f0a9b8c7d",
      "name": "Laboratório de Informática"
    },
    "supplier": {
      "id": "01a0a9a0-52f8-73d2-9003-85196c24ae97",
      "name": "Distribuidora Demonstração"
    },
    "custodian": {
      "id": "019e6e4b-3235-727f-b423-89694ac61dea",
      "name": "Alana Salgado"
    },
    "acquisition_date": "2025-09-30",
    "acquisition_value": 4500,
    "invoice_number": "000981",
    "active": true,
    "created_at": "2025-10-01T08:00:00-03:00",
    "updated_at": "2026-03-11T15:40:00-03:00"
  }
}

{
  "success": false,
  "message": "Escola não encontrada."
}

GET /v1/partners/school/{cnpj}/patrimonio/categories/all

Listar categorias

Categorias de bens com vida útil, taxa de depreciação anual e a quantidade de bens. Não paginado.

Parâmetros de rota

cnpj string obrigatório

CNPJ da escola (14 dígitos, sem formatação).

Códigos de resposta

200

Sucesso.

401

Credenciais inválidas (X-Partner, X-Client ou X-Authorization).

403

Cliente fora do plano Gestão Escolar (ERP_REQUIRED) ou módulo exclusivo de escolas privadas (PRIVATE_CLIENT_REQUIRED).

404

Escola ou recurso não encontrado.

Requisição GET

GET /v1/partners/school/{cnpj}/patrimonio/categories/all

curl https://toakiescola.com.br/api/v1/partners/school/{cnpj}/patrimonio/categories/all \
  -H "X-Authorization: {api_token}" \
  -H "X-Partner: {partner_token}" \
  -H "X-Client: {client_slug}"

$response = $client->get('https://toakiescola.com.br/api/v1/partners/school/{cnpj}/patrimonio/categories/all', [
    'headers' => $headers, // X-Authorization, X-Partner, X-Client
]);

const res = await fetch('https://toakiescola.com.br/api/v1/partners/school/{cnpj}/patrimonio/categories/all', {
    method: 'GET',
    headers: { /* X-Authorization, X-Partner, X-Client */ 'Content-Type': 'application/json' },
});

Resposta

{
  "data": [
    {
      "id": "01a000e8-32cb-720a-898c-7db33152bb28",
      "name": "Computadores e Equip. de Informática",
      "description": null,
      "useful_life_years": 5,
      "depreciation_rate_annual": 20,
      "active": true,
      "assets_count": 14
    }
  ]
}

{
  "success": false,
  "message": "Escola não encontrada."
}

GET /v1/partners/school/{cnpj}/patrimonio/locations/all

Listar localizações

Locais onde os bens ficam (salas, laboratórios, depósitos) e a quantidade de bens em cada um. Não paginado.

Parâmetros de rota

cnpj string obrigatório

CNPJ da escola (14 dígitos, sem formatação).

Códigos de resposta

200

Sucesso.

401

Credenciais inválidas (X-Partner, X-Client ou X-Authorization).

403

Cliente fora do plano Gestão Escolar (ERP_REQUIRED) ou módulo exclusivo de escolas privadas (PRIVATE_CLIENT_REQUIRED).

404

Escola ou recurso não encontrado.

Requisição GET

GET /v1/partners/school/{cnpj}/patrimonio/locations/all

curl https://toakiescola.com.br/api/v1/partners/school/{cnpj}/patrimonio/locations/all \
  -H "X-Authorization: {api_token}" \
  -H "X-Partner: {partner_token}" \
  -H "X-Client: {client_slug}"

$response = $client->get('https://toakiescola.com.br/api/v1/partners/school/{cnpj}/patrimonio/locations/all', [
    'headers' => $headers, // X-Authorization, X-Partner, X-Client
]);

const res = await fetch('https://toakiescola.com.br/api/v1/partners/school/{cnpj}/patrimonio/locations/all', {
    method: 'GET',
    headers: { /* X-Authorization, X-Partner, X-Client */ 'Content-Type': 'application/json' },
});

Resposta

{
  "data": [
    {
      "id": "01a000e8-4410-7a2b-9c3d-2e1f0a9b8c7d",
      "name": "Laboratório de Informática",
      "description": "Bloco B, 2º andar",
      "active": true,
      "assets_count": 22
    }
  ]
}

{
  "success": false,
  "message": "Escola não encontrada."
}

Patrimônio

O modelo bem

Listar bens

Parâmetros de rota

Filtros (query string)

Códigos de resposta

Obter bem

Parâmetros de rota

Códigos de resposta

Listar categorias

Parâmetros de rota

Códigos de resposta

Listar localizações

Parâmetros de rota

Códigos de resposta