To Aqui - Sandbox

O modelo contrato

id uuid

Identificador do contrato.

status string

DRAFT, SENT, ACCEPTED, ACTIVE, CANCELED ou FINISHED.

student / responsible object

Aluno e responsável financeiro (id, name, cpf).

enrollment object|null

Matrícula vinculada (preenchida após a efetivação).

classroom / school_year object|null

Turma e ano letivo do contrato.

annual_amount number

Valor anual contratado.

enrollment_fee number

Taxa de matrícula.

installments_count / due_day integer

Número de parcelas e dia de vencimento.

signing_stage string|null

Etapa da assinatura eletrônica.

autopay_enabled boolean

Se a família ativou o débito automático no cartão.

O modelo contrato

{
  "id": "01a0aabb-5fd3-73ae-abd9-e27a886aadea",
  "status": "ACTIVE",
  "status_label": "Ativo",
  "student": {
    "id": "01a0aab3-550d-7077-aad1-a6d67b1452d8",
    "name": "Ana Beatriz Costa"
  },
  "responsible": {
    "id": "019e6e4b-5106-7232-8bd1-370c6df31d1c",
    "name": "Mariana Costa",
    "cpf": "86727354051"
  },
  "enrollment": {
    "id": "01a0aac0-1b2c-7d3e-8f40-5a6b7c8d9e0f",
    "number": "20260007",
    "status": "ENROLLED"
  },
  "classroom": {
    "id": "019e6e4b-50b0-719c-8bd6-f1b30e763489",
    "name": "5º Ano A"
  },
  "school_year": {
    "id": "019e6e4b-30ff-7140-89ff-810f32d19a18",
    "name": "2026"
  },
  "annual_amount": 12000,
  "enrollment_fee": 500,
  "installments_count": 12,
  "due_day": 10,
  "default_billing_type": "BOLETO",
  "signing_stage": "COMPLETED",
  "responsible_signed_at": "2026-01-12T10:21:00-03:00",
  "school_signed_at": "2026-01-12T14:02:00-03:00",
  "accepted_at": "2026-01-12T14:02:00-03:00",
  "autopay_enabled": false,
  "created_at": "2026-01-10T09:00:00-03:00",
  "updated_at": "2026-01-12T14:02:00-03:00"
}

O modelo conta a receber

id uuid

Identificador da cobrança.

source string

Origem: CONTRACT, CONTRACT_ADDENDUM, ENROLLMENT_FEE, AGREEMENT, MANUAL, FINE_INTEREST, LIBRARY_FINE, WALLET_TOPUP ou OTHER.

status string

PENDING, PAID, PARTIAL, OVERDUE, CANCELED, RENEGOTIATED ou REFUNDED.

is_overdue boolean

Vencida — inclui as pendentes com vencimento anterior a hoje.

competence string

Mês de referência (AAAA-MM).

gross_amount … net_amount number

Bruto, desconto, bolsa, multa, juros e líquido a pagar.

paid_amount / refunded_amount number

Valor pago e estornado.

billing_type / payment_method string|null

Forma de cobrança prevista e forma efetiva de pagamento.

invoice_url / bank_slip_url / boleto_line / pix_payload string|null

Links e códigos para pagamento, quando emitidos.

paid_at / canceled_at datetime|null

Data de pagamento ou cancelamento.

O modelo conta a receber

{
  "id": "019f2b45-764c-73b9-9805-3c888ba6dd09",
  "title": null,
  "source": "CONTRACT",
  "source_label": "Mensalidade (Contrato)",
  "status": "PENDING",
  "status_label": "Pendente",
  "is_overdue": false,
  "contract_id": "01a0aabb-5fd3-73ae-abd9-e27a886aadea",
  "student": {
    "id": "01a0aab3-550d-7077-aad1-a6d67b1452d8",
    "name": "Ana Beatriz Costa"
  },
  "responsible": {
    "id": "019e6e4b-5106-7232-8bd1-370c6df31d1c",
    "name": "Mariana Costa",
    "cpf": "86727354051"
  },
  "category": {
    "id": "a219edf4-7172-4592-8cde-9338e0a3dc8f",
    "name": "Mensalidades"
  },
  "competence": "2026-10",
  "installment_number": 10,
  "due_date": "2026-10-10",
  "gross_amount": 1000,
  "discount_amount": 50,
  "scholarship_amount": 0,
  "fine_amount": 0,
  "interest_amount": 0,
  "net_amount": 950,
  "paid_amount": 0,
  "refunded_amount": 0,
  "billing_type": "BOLETO",
  "payment_method": null,
  "invoice_url": "https://www.asaas.com/i/ht037ouscaho25xu",
  "bank_slip_url": "https://www.asaas.com/b/pdf/ht037ouscaho25xu",
  "boleto_line": "00190000090123456789012345678901234567890000095000",
  "pix_payload": null,
  "paid_at": null,
  "canceled_at": null,
  "created_at": "2026-01-12T14:02:00-03:00",
  "updated_at": "2026-01-12T14:02:00-03:00"
}

O modelo conta a pagar

id uuid

Identificador da despesa.

type string|null

FIXED, VARIABLE, EVENTUAL, TAX, PAYROLL ou SUPPLIER.

status string

PENDING, SCHEDULED, PAID, OVERDUE ou CANCELED.

supplier object|null

Fornecedor (id, name, document_number).

due_date / paid_at date

Vencimento e data de pagamento.

amount / paid_amount number

Valor e valor pago.

is_recurring / recurrence boolean / string

Despesa recorrente e sua periodicidade.

O modelo conta a pagar

{
  "id": "019efab9-d29e-7324-a4c1-2ad3f9ce082b",
  "description": "Conta de energia elétrica",
  "nature": "EXPENSE",
  "type": "FIXED",
  "status": "PENDING",
  "status_label": "Pendente",
  "supplier": {
    "id": "01a0a9a0-52f8-73d2-9003-85196c24ae97",
    "name": "Companhia de Energia",
    "document_number": "33050196000188"
  },
  "payee_name": "Companhia de Energia",
  "category": {
    "id": "a219edf4-72b8-4256-9525-1808cac3539a",
    "name": "Água e Energia"
  },
  "competence": "2026-10",
  "due_date": "2026-10-15",
  "amount": 1850.4,
  "paid_amount": 0,
  "payment_method": null,
  "paid_at": null,
  "approved_at": null,
  "is_recurring": true,
  "recurrence": "MONTHLY",
  "created_at": "2026-09-20T11:00:00-03:00",
  "updated_at": "2026-09-20T11:00:00-03:00"
}

GET /v1/partners/school/{cnpj}/finance/contracts/all

Listar contratos

Contratos de matrícula da escola, do mais recente para o mais antigo. 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)

status string opcional

DRAFT, SENT, ACCEPTED, ACTIVE, CANCELED ou FINISHED.

school_year_id uuid opcional

Somente contratos do ano letivo informado.

enrollment_number string opcional

Número de matrícula do aluno.

responsible_cpf string opcional

CPF do responsável financeiro (com ou sem máscara).

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}/finance/contracts/all

curl https://toakiescola.com.br/api/v1/partners/school/{cnpj}/finance/contracts/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}/finance/contracts/all', [
    'headers' => $headers, // X-Authorization, X-Partner, X-Client
]);

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

Resposta

{
  "data": [
    {
      "id": "01a0aabb-5fd3-73ae-abd9-e27a886aadea",
      "status": "ACTIVE",
      "status_label": "Ativo",
      "student": {
        "id": "01a0aab3-550d-7077-aad1-a6d67b1452d8",
        "name": "Ana Beatriz Costa"
      },
      "responsible": {
        "id": "019e6e4b-5106-7232-8bd1-370c6df31d1c",
        "name": "Mariana Costa",
        "cpf": "86727354051"
      },
      "enrollment": {
        "id": "01a0aac0-1b2c-7d3e-8f40-5a6b7c8d9e0f",
        "number": "20260007",
        "status": "ENROLLED"
      },
      "classroom": {
        "id": "019e6e4b-50b0-719c-8bd6-f1b30e763489",
        "name": "5º Ano A"
      },
      "school_year": {
        "id": "019e6e4b-30ff-7140-89ff-810f32d19a18",
        "name": "2026"
      },
      "annual_amount": 12000,
      "enrollment_fee": 500,
      "installments_count": 12,
      "due_day": 10,
      "default_billing_type": "BOLETO",
      "signing_stage": "COMPLETED",
      "responsible_signed_at": "2026-01-12T10:21:00-03:00",
      "school_signed_at": "2026-01-12T14:02:00-03:00",
      "accepted_at": "2026-01-12T14:02:00-03:00",
      "autopay_enabled": false,
      "created_at": "2026-01-10T09:00:00-03:00",
      "updated_at": "2026-01-12T14:02: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}/finance/contract/{id}

Obter contrato

Um contrato com o resumo das suas parcelas (canceladas e renegociadas não entram na conta).

Parâmetros de rota

cnpj string obrigatório

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

id uuid obrigatório

UUID do contrato.

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}/finance/contract/{id}

curl https://toakiescola.com.br/api/v1/partners/school/{cnpj}/finance/contract/{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}/finance/contract/{id}', [
    'headers' => $headers, // X-Authorization, X-Partner, X-Client
]);

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

Resposta

{
  "data": {
    "id": "01a0aabb-5fd3-73ae-abd9-e27a886aadea",
    "status": "ACTIVE",
    "status_label": "Ativo",
    "student": {
      "id": "01a0aab3-550d-7077-aad1-a6d67b1452d8",
      "name": "Ana Beatriz Costa"
    },
    "responsible": {
      "id": "019e6e4b-5106-7232-8bd1-370c6df31d1c",
      "name": "Mariana Costa",
      "cpf": "86727354051"
    },
    "enrollment": {
      "id": "01a0aac0-1b2c-7d3e-8f40-5a6b7c8d9e0f",
      "number": "20260007",
      "status": "ENROLLED"
    },
    "classroom": {
      "id": "019e6e4b-50b0-719c-8bd6-f1b30e763489",
      "name": "5º Ano A"
    },
    "school_year": {
      "id": "019e6e4b-30ff-7140-89ff-810f32d19a18",
      "name": "2026"
    },
    "annual_amount": 12000,
    "enrollment_fee": 500,
    "installments_count": 12,
    "due_day": 10,
    "default_billing_type": "BOLETO",
    "signing_stage": "COMPLETED",
    "responsible_signed_at": "2026-01-12T10:21:00-03:00",
    "school_signed_at": "2026-01-12T14:02:00-03:00",
    "accepted_at": "2026-01-12T14:02:00-03:00",
    "autopay_enabled": false,
    "created_at": "2026-01-10T09:00:00-03:00",
    "updated_at": "2026-01-12T14:02:00-03:00",
    "receivables_summary": {
      "count": 12,
      "paid_count": 9,
      "open_count": 3,
      "overdue_count": 1,
      "total_amount": 11400,
      "paid_amount": 8550
    }
  }
}

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

GET /v1/partners/school/{cnpj}/finance/receivables/all

Listar contas a receber

Mensalidades, taxas e demais cobranças da escola, ordenadas pelo vencimento. 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)

status string opcional

PENDING, PAID, PARTIAL, OVERDUE, CANCELED, RENEGOTIATED ou REFUNDED.

overdue boolean opcional

1 para somente as vencidas — inclui as pendentes com vencimento anterior a hoje.

due_from date opcional

Vencimento a partir de (AAAA-MM-DD).

due_to date opcional

Vencimento até (AAAA-MM-DD).

competence string opcional

Competência no formato AAAA-MM.

contract_id uuid opcional

Somente as parcelas de um contrato.

enrollment_number string opcional

Número de matrícula do aluno.

responsible_cpf string opcional

CPF do responsável financeiro.

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}/finance/receivables/all

curl https://toakiescola.com.br/api/v1/partners/school/{cnpj}/finance/receivables/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}/finance/receivables/all', [
    'headers' => $headers, // X-Authorization, X-Partner, X-Client
]);

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

Resposta

{
  "data": [
    {
      "id": "019f2b45-764c-73b9-9805-3c888ba6dd09",
      "title": null,
      "source": "CONTRACT",
      "source_label": "Mensalidade (Contrato)",
      "status": "PENDING",
      "status_label": "Pendente",
      "is_overdue": false,
      "contract_id": "01a0aabb-5fd3-73ae-abd9-e27a886aadea",
      "student": {
        "id": "01a0aab3-550d-7077-aad1-a6d67b1452d8",
        "name": "Ana Beatriz Costa"
      },
      "responsible": {
        "id": "019e6e4b-5106-7232-8bd1-370c6df31d1c",
        "name": "Mariana Costa",
        "cpf": "86727354051"
      },
      "category": {
        "id": "a219edf4-7172-4592-8cde-9338e0a3dc8f",
        "name": "Mensalidades"
      },
      "competence": "2026-10",
      "installment_number": 10,
      "due_date": "2026-10-10",
      "gross_amount": 1000,
      "discount_amount": 50,
      "scholarship_amount": 0,
      "fine_amount": 0,
      "interest_amount": 0,
      "net_amount": 950,
      "paid_amount": 0,
      "refunded_amount": 0,
      "billing_type": "BOLETO",
      "payment_method": null,
      "invoice_url": "https://www.asaas.com/i/ht037ouscaho25xu",
      "bank_slip_url": "https://www.asaas.com/b/pdf/ht037ouscaho25xu",
      "boleto_line": "00190000090123456789012345678901234567890000095000",
      "pix_payload": null,
      "paid_at": null,
      "canceled_at": null,
      "created_at": "2026-01-12T14:02:00-03:00",
      "updated_at": "2026-01-12T14:02: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}/finance/receivable/{id}

Obter conta a receber

Uma cobrança com os seus itens (quando foi lançada com itens).

Parâmetros de rota

cnpj string obrigatório

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

id uuid obrigatório

UUID da conta a receber.

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}/finance/receivable/{id}

curl https://toakiescola.com.br/api/v1/partners/school/{cnpj}/finance/receivable/{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}/finance/receivable/{id}', [
    'headers' => $headers, // X-Authorization, X-Partner, X-Client
]);

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

Resposta

{
  "data": {
    "id": "019f2b45-764c-73b9-9805-3c888ba6dd09",
    "title": null,
    "source": "CONTRACT",
    "source_label": "Mensalidade (Contrato)",
    "status": "PENDING",
    "status_label": "Pendente",
    "is_overdue": false,
    "contract_id": "01a0aabb-5fd3-73ae-abd9-e27a886aadea",
    "student": {
      "id": "01a0aab3-550d-7077-aad1-a6d67b1452d8",
      "name": "Ana Beatriz Costa"
    },
    "responsible": {
      "id": "019e6e4b-5106-7232-8bd1-370c6df31d1c",
      "name": "Mariana Costa",
      "cpf": "86727354051"
    },
    "category": {
      "id": "a219edf4-7172-4592-8cde-9338e0a3dc8f",
      "name": "Mensalidades"
    },
    "competence": "2026-10",
    "installment_number": 10,
    "due_date": "2026-10-10",
    "gross_amount": 1000,
    "discount_amount": 50,
    "scholarship_amount": 0,
    "fine_amount": 0,
    "interest_amount": 0,
    "net_amount": 950,
    "paid_amount": 0,
    "refunded_amount": 0,
    "billing_type": "BOLETO",
    "payment_method": null,
    "invoice_url": "https://www.asaas.com/i/ht037ouscaho25xu",
    "bank_slip_url": "https://www.asaas.com/b/pdf/ht037ouscaho25xu",
    "boleto_line": "00190000090123456789012345678901234567890000095000",
    "pix_payload": null,
    "paid_at": null,
    "canceled_at": null,
    "created_at": "2026-01-12T14:02:00-03:00",
    "updated_at": "2026-01-12T14:02:00-03:00",
    "items": [
      {
        "description": "Mensalidade outubro",
        "quantity": 1,
        "unit_amount": 1000,
        "total_amount": 1000
      }
    ]
  }
}

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

GET /v1/partners/school/{cnpj}/finance/payables/all

Listar contas a pagar

Despesas da escola ordenadas pelo vencimento. 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)

status string opcional

PENDING, SCHEDULED, PAID, OVERDUE ou CANCELED.

due_from date opcional

Vencimento a partir de (AAAA-MM-DD).

due_to date opcional

Vencimento até (AAAA-MM-DD).

supplier_id uuid opcional

Somente as contas de um fornecedor.

category_id uuid opcional

Somente as contas de uma categoria financeira.

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}/finance/payables/all

curl https://toakiescola.com.br/api/v1/partners/school/{cnpj}/finance/payables/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}/finance/payables/all', [
    'headers' => $headers, // X-Authorization, X-Partner, X-Client
]);

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

Resposta

{
  "data": [
    {
      "id": "019efab9-d29e-7324-a4c1-2ad3f9ce082b",
      "description": "Conta de energia elétrica",
      "nature": "EXPENSE",
      "type": "FIXED",
      "status": "PENDING",
      "status_label": "Pendente",
      "supplier": {
        "id": "01a0a9a0-52f8-73d2-9003-85196c24ae97",
        "name": "Companhia de Energia",
        "document_number": "33050196000188"
      },
      "payee_name": "Companhia de Energia",
      "category": {
        "id": "a219edf4-72b8-4256-9525-1808cac3539a",
        "name": "Água e Energia"
      },
      "competence": "2026-10",
      "due_date": "2026-10-15",
      "amount": 1850.4,
      "paid_amount": 0,
      "payment_method": null,
      "paid_at": null,
      "approved_at": null,
      "is_recurring": true,
      "recurrence": "MONTHLY",
      "created_at": "2026-09-20T11:00:00-03:00",
      "updated_at": "2026-09-20T11:00: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}/finance/payable/{id}

Obter conta a pagar

Uma despesa.

Parâmetros de rota

cnpj string obrigatório

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

id uuid obrigatório

UUID da conta a pagar.

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}/finance/payable/{id}

curl https://toakiescola.com.br/api/v1/partners/school/{cnpj}/finance/payable/{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}/finance/payable/{id}', [
    'headers' => $headers, // X-Authorization, X-Partner, X-Client
]);

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

Resposta

{
  "data": {
    "id": "019efab9-d29e-7324-a4c1-2ad3f9ce082b",
    "description": "Conta de energia elétrica",
    "nature": "EXPENSE",
    "type": "FIXED",
    "status": "PENDING",
    "status_label": "Pendente",
    "supplier": {
      "id": "01a0a9a0-52f8-73d2-9003-85196c24ae97",
      "name": "Companhia de Energia",
      "document_number": "33050196000188"
    },
    "payee_name": "Companhia de Energia",
    "category": {
      "id": "a219edf4-72b8-4256-9525-1808cac3539a",
      "name": "Água e Energia"
    },
    "competence": "2026-10",
    "due_date": "2026-10-15",
    "amount": 1850.4,
    "paid_amount": 0,
    "payment_method": null,
    "paid_at": null,
    "approved_at": null,
    "is_recurring": true,
    "recurrence": "MONTHLY",
    "created_at": "2026-09-20T11:00:00-03:00",
    "updated_at": "2026-09-20T11:00:00-03:00"
  }
}

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

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

Listar categorias financeiras

Plano de categorias ativas do cliente (compartilhado por todas as escolas). Não paginado.

Parâmetros de rota

cnpj string obrigatório

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

Filtros (query string)

nature string opcional

REVENUE (receita) ou EXPENSE (despesa).

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}/finance/categories/all

curl https://toakiescola.com.br/api/v1/partners/school/{cnpj}/finance/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}/finance/categories/all', [
    'headers' => $headers, // X-Authorization, X-Partner, X-Client
]);

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

Resposta

{
  "data": [
    {
      "id": "a219edf4-72b8-4256-9525-1808cac3539a",
      "parent_id": null,
      "name": "Água e Energia",
      "nature": "EXPENSE",
      "dre_group": "DESPESA_ADMINISTRATIVA"
    }
  ]
}

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

GET /v1/partners/school/{cnpj}/finance/accounts/all

Listar contas financeiras

Contas bancárias, caixas e cartões ativos da escola, com o saldo do livro-caixa (saldo inicial + entradas − saídas). Agência e número da conta nunca são expostos. 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}/finance/accounts/all

curl https://toakiescola.com.br/api/v1/partners/school/{cnpj}/finance/accounts/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}/finance/accounts/all', [
    'headers' => $headers, // X-Authorization, X-Partner, X-Client
]);

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

Resposta

{
  "data": [
    {
      "id": "019f8c8c-7e22-7138-9fbf-2da13d265f15",
      "name": "Itaú Conta Corrente Principal",
      "type": "CHECKING",
      "bank_code": "341",
      "bank_name": "Itaú Unibanco",
      "card_brand": null,
      "card_last4": null,
      "balance": 15230.75
    }
  ]
}

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

GET /v1/partners/school/{cnpj}/finance/summary

Resumo do período

Totais de um período — por padrão, o mês corrente. billed considera as cobranças com vencimento no período (exceto canceladas e renegociadas); received_amount soma o que foi pago no período; overdue é a posição de hoje, independente do período.

Parâmetros de rota

cnpj string obrigatório

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

Filtros (query string)

from date opcional

Início do período (AAAA-MM-DD). Informe junto com to.

to date opcional

Fim do período (AAAA-MM-DD).

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}/finance/summary

curl https://toakiescola.com.br/api/v1/partners/school/{cnpj}/finance/summary \
  -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}/finance/summary', [
    'headers' => $headers, // X-Authorization, X-Partner, X-Client
]);

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

Resposta

{
  "data": {
    "period": {
      "from": "2026-10-01",
      "to": "2026-10-31"
    },
    "receivables": {
      "billed_count": 312,
      "billed_amount": 296400,
      "received_amount": 214350.5,
      "open_amount": 82049.5,
      "overdue_count": 41,
      "overdue_amount": 38920
    },
    "payables": {
      "due_count": 27,
      "due_amount": 148210.3,
      "paid_amount": 96120,
      "overdue_count": 2
    }
  }
}

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

Financeiro

O modelo contrato

O modelo conta a receber

O modelo conta a pagar

Listar contratos

Parâmetros de rota

Filtros (query string)

Códigos de resposta

Obter contrato

Parâmetros de rota

Códigos de resposta

Listar contas a receber

Parâmetros de rota

Filtros (query string)

Códigos de resposta

Obter conta a receber

Parâmetros de rota

Códigos de resposta

Listar contas a pagar

Parâmetros de rota

Filtros (query string)

Códigos de resposta

Obter conta a pagar

Parâmetros de rota

Códigos de resposta

Listar categorias financeiras

Parâmetros de rota

Filtros (query string)

Códigos de resposta

Listar contas financeiras

Parâmetros de rota

Códigos de resposta

Resumo do período

Parâmetros de rota

Filtros (query string)

Códigos de resposta