Back to top

Acadweb API: Módulo Financeiro

Nota: A váriável {cliente-sigla} no final da URL base deve ser substituída pelo seu cliente sigla.

Autenticação e Autorização

Token de Autorização

O token de autorização será utilizado em todas as outras rotas e pode ser obtido a partir do nome do usuário e senha recebidos.

Para autenticação nas rotas /tokens deverá ser enviado o cabeçalho Authorization Basic, que é formado por um Base64 da contatenação do seu “usuário”, “:” e “senha”.

Exemplo de geração de um token básico em NODE JS

const usuario = 'qualinfo';
const senha = 'abc123';
const token = new Buffer(`${usuario}:${senha}`).toString('base64');
console.log(token) // Saída: cXVhbGluZm86YWJjMTIz

Exemplo de geração de um token básico em PHP

<?php
    $usuario = 'qualinfo';
    $senha = 'abc123';
    $token = base64_encode("{$usuario}:{$senha}");

    echo $token; # Saída: cXVhbGluZm86YWJjMTIz

Criação de Token
POST/tokens

Gera um novo token de autorização. Um vez que o token foi gerado ele não será mais exibido. Então é necessário salvá-lo.

Example URI

POST https://api.acadweb.com.br/{cliente-sigla}/tokens
Request  Sucesso
HideShow
Headers
Content-Type: application/json
Authorization: Basic cXVhbGluZm86YWJjMTIz
Body
{
  "nome": "Token principal"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "nome": {
      "type": "string"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "token": "1|EjhP0T0PdKh07Z5q0AsbhfCChvrZv2jLQtkC2XbV"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "O id do token"
    },
    "token": {
      "type": "string",
      "description": "O token"
    }
  },
  "required": [
    "id",
    "token"
  ]
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
    "mensagem": "Usuário ou senha inválido",
}

Listagem de Tokens
GET/tokens

Lista todos os token do usuário.

Example URI

GET https://api.acadweb.com.br/{cliente-sigla}/tokens
Request  Sucesso
HideShow
Headers
Authorization: Basic cXVhbGluZm86YWJjMTIz
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 1,
    "nome": "Token principal"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "number",
        "description": "O id do token"
      },
      "nome": {
        "type": "string",
        "description": "O decrição do token fornecida na criação"
      }
    },
    "required": [
      "id",
      "nome"
    ]
  }
}

Revogação de Token
DELETE/tokens/{id}

Revoga um token

Example URI

DELETE https://api.acadweb.com.br/{cliente-sigla}/tokens/1
URI Parameters
HideShow
id
number (required) Example: 1

O id do token

Request  Sucesso
HideShow
Headers
Authorization: Basic cXVhbGluZm86YWJjMTIz
Response  204
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
    "mensagem": "O id informado é inválido",
}

Aluno

Autenticação Aluno

Autenticação Aluno
POST/alunos/autenticacao

Obtém informações de um aluno a partir de suas credenciais

Example URI

POST https://api.acadweb.com.br/{cliente-sigla}/alunos/autenticacao
Request  Sucesso
HideShow
Headers
Content-Type: application/json
Body
{
  "login": "QLFO123456",
  "senha": "123456"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "login": {
      "type": "string",
      "description": "O email ou matricula do aluno"
    },
    "senha": {
      "type": "string",
      "description": "A senha do aluno"
    }
  },
  "required": [
    "login",
    "senha"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "aluno_id": "ADM200026",
  "aluno_nome": "Fernando Figueiredo",
  "aluno_nome_social": "Olivia Figueiredo",
  "aluno_mae": "Clarice Mariana Vitória",
  "aluno_pai": "Lorenzo Guilherme Cláudio Figueiredo",
  "aluno_endereco": "Rua Calêndula",
  "aluno_endereco_cep": "69099524",
  "aluno_endereco_bairro": "Bairro Novo",
  "aluno_endereco_cidade": "Recife",
  "aluno_endereco_uf": "PE",
  "aluno_sexo": "F",
  "aluno_data_nascimento": "2000-02-09",
  "aluno_uf_nascimento": "PE",
  "aluno_naturalidade": "Recife",
  "aluno_nacionalidade": "Brasileira",
  "aluno_tipo_sanguineo": "O+",
  "aluno_raca_id": 3,
  "aluno_raca_descricao": "Parda",
  "aluno_rg": "398059949",
  "aluno_rg_orgao": "SDS PE",
  "aluno_rg_data_expedicao": "2002-02-09",
  "aluno_cpf": "67175535708",
  "aluno_titulo_eleitoral": "175410650884",
  "aluno_titulo_zona": "006",
  "aluno_titulo_secao": "0324",
  "aluno_reservista": "153109",
  "aluno_reservista_categoria": "Dispensado do serviço militar",
  "aluno_telefone_residencial": "8138660962",
  "aluno_telefone_celular": "81991147250",
  "aluno_telefone_comercial": "81991147250",
  "aluno_telefone_fax": "8138660962",
  "aluno_email": "exemplo@email.com.br",
  "aluno_emancipado": "S",
  "aluno_grau_instrucao_id": "03",
  "aluno_grau_instrucao_descricao": "Ensino Médio",
  "aluno_profissao_id": "027",
  "aluno_profissoa_descricao": "Estudante",
  "aluno_religiao_id": "01",
  "aluno_religiao_descricao": "Agnistico",
  "aluno_instituicao_2grau_id": "001",
  "aluno_instituicao_2grau_descricao": "Escola Qualinfo",
  "credor_nome": "Kauê Noah Yago Porto",
  "credor_cpf": "03716471003",
  "credor_endereco": "Rua Pedro Jusselino de Aquino",
  "credor_endereco_cep": "58052370",
  "credor_endereco_bairro": "Jardim Universitário",
  "credor_endereco_cidade": "Recife",
  "credor_endereco_uf": "PE",
  "credor_telefone_residencial": "8129463856",
  "credor_telefone_celular": "81999849284",
  "credor_telefone_comercial": "81999849284",
  "credor_telefone_fax": "8129463856",
  "ativo": "I",
  "cursos": [
    {
      "turma_id": "ADM01",
      "curso_id": "00003",
      "curso_descricao": "Técnico em Administração",
      "situacao_id": "MT",
      "situacao_descricao": "Matriculado"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "aluno_id": {
      "type": "string",
      "description": "O código de identificação do aluno"
    },
    "aluno_nome": {
      "type": "string",
      "description": "O nome do aluno"
    },
    "aluno_nome_social": {
      "type": "string",
      "description": "O nome social do aluno"
    },
    "aluno_mae": {
      "type": "string",
      "description": "O nome da mãe do aluno"
    },
    "aluno_pai": {
      "type": "string",
      "description": "O nome do pai do aluno"
    },
    "aluno_endereco": {
      "type": "string",
      "description": "O endereço do aluno"
    },
    "aluno_endereco_cep": {
      "type": "string",
      "description": "O número do CEP onde o aluno mora"
    },
    "aluno_endereco_bairro": {
      "type": "string",
      "description": "O bairro onde o aluno mora"
    },
    "aluno_endereco_cidade": {
      "type": "string",
      "description": "A cidade onde o aluno mora"
    },
    "aluno_endereco_uf": {
      "type": "string",
      "description": "A unidade federativa onde o aluno mora"
    },
    "aluno_sexo": {
      "type": "string",
      "description": "O sexo do aluno F - Feminino ou M - Masculino"
    },
    "aluno_data_nascimento": {
      "type": "string",
      "description": "A data de nascimento do aluno no formato YYYY-MM-DD"
    },
    "aluno_uf_nascimento": {
      "type": "string",
      "description": "A unidade federativa onde o aluno nasceu"
    },
    "aluno_naturalidade": {
      "type": "string",
      "description": "A cidade onde o aluno nasceu"
    },
    "aluno_nacionalidade": {
      "type": "string",
      "description": "A nacionalidade do aluno"
    },
    "aluno_tipo_sanguineo": {
      "type": "string",
      "description": "O tipo sanguínio do aluno"
    },
    "aluno_raca_id": {
      "type": "number",
      "description": "O código de identificação da raça do aluno\n\n 1 - Branca, 2 - Preta, 3 - Parda, 4 - Amarela, 5 - Indígena, 6 - Não Informado"
    },
    "aluno_raca_descricao": {
      "type": "string",
      "description": "A descrição da raça do aluno"
    },
    "aluno_rg": {
      "type": "string",
      "description": "O número do RG do aluno"
    },
    "aluno_rg_orgao": {
      "type": "string",
      "description": "O orgaão expeditor do RG do aluno"
    },
    "aluno_rg_data_expedicao": {
      "type": "string",
      "description": "A data de expedição do RG do aluno no formato YYYY-MM-DD"
    },
    "aluno_cpf": {
      "type": "string",
      "description": "O número de CPF do aluno"
    },
    "aluno_titulo_eleitoral": {
      "type": "string",
      "description": "O número do título de eleitor do aluno"
    },
    "aluno_titulo_zona": {
      "type": "string",
      "description": "A zona eleitoral do aluno"
    },
    "aluno_titulo_secao": {
      "type": "string",
      "description": "A seção da zona eleitoral do aluno"
    },
    "aluno_reservista": {
      "type": "string",
      "description": "O número da reservista do aluno"
    },
    "aluno_reservista_categoria": {
      "type": "string",
      "description": "A categoria da reservista do aluno"
    },
    "aluno_telefone_residencial": {
      "type": "string",
      "description": "O número de telefone residencial do aluno"
    },
    "aluno_telefone_celular": {
      "type": "string",
      "description": "O número de telefone celular do aluno"
    },
    "aluno_telefone_comercial": {
      "type": "string",
      "description": "O número de telefone comercial do aluno"
    },
    "aluno_telefone_fax": {
      "type": "string",
      "description": "O número de fax do aluno"
    },
    "aluno_email": {
      "type": "string",
      "description": "O endereço de e-mail do aluno"
    },
    "aluno_emancipado": {
      "type": "string",
      "description": "Se o aluno é emancipado S - Sim, N - Não"
    },
    "aluno_grau_instrucao_id": {
      "type": "string",
      "description": "O código de identificação do grau de instrução do aluno"
    },
    "aluno_grau_instrucao_descricao": {
      "type": "string",
      "description": "Uma descrição para o grau de instrução do aluno"
    },
    "aluno_profissao_id": {
      "type": "string",
      "description": "O código de identificação para a ocupação do aluno"
    },
    "aluno_profissoa_descricao": {
      "type": "string",
      "description": "Uma descrição para a ocupação do aluno"
    },
    "aluno_religiao_id": {
      "type": "string",
      "description": "O código de identificação para a religição do aluno"
    },
    "aluno_religiao_descricao": {
      "type": "string",
      "description": "Uma descrição para a religião do aluno"
    },
    "aluno_instituicao_2grau_id": {
      "type": "string",
      "description": "O código de identificação para a instituição onde o aluno finalizou o 2º Grau"
    },
    "aluno_instituicao_2grau_descricao": {
      "type": "string",
      "description": "O nome da instituição onde o aluno finalizou o 2º Grau"
    },
    "credor_nome": {
      "type": "string",
      "description": "O nome do creador"
    },
    "credor_cpf": {
      "type": "string",
      "description": "O número de CPF do creador"
    },
    "credor_endereco": {
      "type": "string",
      "description": "O endereço do creador"
    },
    "credor_endereco_cep": {
      "type": "string",
      "description": "O número do CEP do creador"
    },
    "credor_endereco_bairro": {
      "type": "string",
      "description": "O nome do bairro do creador"
    },
    "credor_endereco_cidade": {
      "type": "string",
      "description": "O nome da cidade do creador"
    },
    "credor_endereco_uf": {
      "type": "string",
      "description": "A unidade federativa do creador"
    },
    "credor_telefone_residencial": {
      "type": "string",
      "description": "O número de telefone residencial do creador"
    },
    "credor_telefone_celular": {
      "type": "string",
      "description": "O número de telefone celular do creador"
    },
    "credor_telefone_comercial": {
      "type": "string",
      "description": "O número de telefone comercial do creador"
    },
    "credor_telefone_fax": {
      "type": "string",
      "description": "O número de FAX do creador"
    },
    "ativo": {
      "type": "string",
      "description": "A - Ativo I -Inativo"
    },
    "cursos": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "turma_id": {
            "type": "string",
            "description": "N (string, optional) - O código de identificação da turma do aluno"
          },
          "curso_id": {
            "type": "string",
            "description": "O código de identificação do curso do aluno"
          },
          "curso_descricao": {
            "type": "string",
            "description": "Uma descrição para o curso do aluno"
          },
          "situacao_id": {
            "type": "string",
            "description": "O código de identificação da situação do aluno"
          },
          "situacao_descricao": {
            "type": "string",
            "description": "A descrição da situação do aluno"
          }
        },
        "required": [
          "situacao_id",
          "situacao_descricao"
        ]
      }
    }
  },
  "required": [
    "aluno_id",
    "aluno_nome",
    "aluno_mae",
    "cursos"
  ],
  "additionalProperties": false
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
    "mensagem": "Login do aluno ou senha inválido",
}

Listagem de Alunos

Listagem de Alunos
GET/alunos{?dataInicial}{?dataFinal}{?pagina}{?quantidade}{?matricula}{?ativo}

Lista os alunos

Example URI

GET https://api.acadweb.com.br/{cliente-sigla}/alunos?dataInicial=2023-04-19 06:36:00?dataFinal=2023-04-24 06:36:00?pagina=1?quantidade=10?matricula=QLFO123456?ativo=A ou I
URI Parameters
HideShow
dataInicial
string (optional) Example: 2023-04-19 06:36:00

A data inicial para se obter os alunos no formato YYYY-MM-DD HH:mm:ss

dataFinal
string (optional) Example: 2023-04-24 06:36:00

A data final para se obter os alunos no formato YYYY-MM-DD HH:mm:ss

pagina
number (optional) Default: 1 Example: 1

A página da paginação dos alunos

quantidade
number (optional) Default: 100 Example: 10

A quantidade de itens da página. Se a quantidade de itens for 0 e as datas inicial e final forem iguais, todos os registros desse dia serão retornados.

matricula
string (optional) Example: QLFO123456

Filtra por matricula do aluno

ativo
string (optional) Example: A ou I

Filtra por alunos (A) ativos ou (I) inativos

Request  Sucesso
HideShow
Headers
Authorization: Bearer 1|EjhP0T0PdKh07Z5q0AsbhfCChvrZv2jLQtkC2XbV
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "aluno_id": "ADM200026",
    "aluno_nome": "Fernando Figueiredo",
    "aluno_nome_social": "Olivia Figueiredo",
    "aluno_mae": "Clarice Mariana Vitória",
    "aluno_pai": "Lorenzo Guilherme Cláudio Figueiredo",
    "aluno_endereco": "Rua Calêndula",
    "aluno_endereco_cep": "69099524",
    "aluno_endereco_bairro": "Bairro Novo",
    "aluno_endereco_cidade": "Recife",
    "aluno_endereco_uf": "PE",
    "aluno_sexo": "F",
    "aluno_data_nascimento": "2000-02-09",
    "aluno_uf_nascimento": "PE",
    "aluno_naturalidade": "Recife",
    "aluno_nacionalidade": "Brasileira",
    "aluno_tipo_sanguineo": "O+",
    "aluno_raca_id": 3,
    "aluno_raca_descricao": "Parda",
    "aluno_rg": "398059949",
    "aluno_rg_orgao": "SDS PE",
    "aluno_rg_data_expedicao": "2002-02-09",
    "aluno_cpf": "67175535708",
    "aluno_titulo_eleitoral": "175410650884",
    "aluno_titulo_zona": "006",
    "aluno_titulo_secao": "0324",
    "aluno_reservista": "153109",
    "aluno_reservista_categoria": "Dispensado do serviço militar",
    "aluno_telefone_residencial": "8138660962",
    "aluno_telefone_celular": "81991147250",
    "aluno_telefone_comercial": "81991147250",
    "aluno_telefone_fax": "8138660962",
    "aluno_email": "exemplo@email.com.br",
    "aluno_emancipado": "S",
    "aluno_grau_instrucao_id": "03",
    "aluno_grau_instrucao_descricao": "Ensino Médio",
    "aluno_profissao_id": "027",
    "aluno_profissoa_descricao": "Estudante",
    "aluno_religiao_id": "01",
    "aluno_religiao_descricao": "Agnistico",
    "aluno_instituicao_2grau_id": "001",
    "aluno_instituicao_2grau_descricao": "Escola Qualinfo",
    "credor_nome": "Kauê Noah Yago Porto",
    "credor_cpf": "03716471003",
    "credor_endereco": "Rua Pedro Jusselino de Aquino",
    "credor_endereco_cep": "58052370",
    "credor_endereco_bairro": "Jardim Universitário",
    "credor_endereco_cidade": "Recife",
    "credor_endereco_uf": "PE",
    "credor_telefone_residencial": "8129463856",
    "credor_telefone_celular": "81999849284",
    "credor_telefone_comercial": "81999849284",
    "credor_telefone_fax": "8129463856",
    "ativo": "I",
    "cursos": [
      {
        "turma_id": "ADM01",
        "curso_id": "00003",
        "curso_descricao": "Técnico em Administração",
        "situacao_id": "MT",
        "situacao_descricao": "Matriculado"
      }
    ]
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "aluno_id": {
        "type": "string",
        "description": "O código de identificação do aluno"
      },
      "aluno_nome": {
        "type": "string",
        "description": "O nome do aluno"
      },
      "aluno_nome_social": {
        "type": "string",
        "description": "O nome social do aluno"
      },
      "aluno_mae": {
        "type": "string",
        "description": "O nome da mãe do aluno"
      },
      "aluno_pai": {
        "type": "string",
        "description": "O nome do pai do aluno"
      },
      "aluno_endereco": {
        "type": "string",
        "description": "O endereço do aluno"
      },
      "aluno_endereco_cep": {
        "type": "string",
        "description": "O número do CEP onde o aluno mora"
      },
      "aluno_endereco_bairro": {
        "type": "string",
        "description": "O bairro onde o aluno mora"
      },
      "aluno_endereco_cidade": {
        "type": "string",
        "description": "A cidade onde o aluno mora"
      },
      "aluno_endereco_uf": {
        "type": "string",
        "description": "A unidade federativa onde o aluno mora"
      },
      "aluno_sexo": {
        "type": "string",
        "description": "O sexo do aluno F - Feminino ou M - Masculino"
      },
      "aluno_data_nascimento": {
        "type": "string",
        "description": "A data de nascimento do aluno no formato YYYY-MM-DD"
      },
      "aluno_uf_nascimento": {
        "type": "string",
        "description": "A unidade federativa onde o aluno nasceu"
      },
      "aluno_naturalidade": {
        "type": "string",
        "description": "A cidade onde o aluno nasceu"
      },
      "aluno_nacionalidade": {
        "type": "string",
        "description": "A nacionalidade do aluno"
      },
      "aluno_tipo_sanguineo": {
        "type": "string",
        "description": "O tipo sanguínio do aluno"
      },
      "aluno_raca_id": {
        "type": "number",
        "description": "O código de identificação da raça do aluno\n\n 1 - Branca, 2 - Preta, 3 - Parda, 4 - Amarela, 5 - Indígena, 6 - Não Informado"
      },
      "aluno_raca_descricao": {
        "type": "string",
        "description": "A descrição da raça do aluno"
      },
      "aluno_rg": {
        "type": "string",
        "description": "O número do RG do aluno"
      },
      "aluno_rg_orgao": {
        "type": "string",
        "description": "O orgaão expeditor do RG do aluno"
      },
      "aluno_rg_data_expedicao": {
        "type": "string",
        "description": "A data de expedição do RG do aluno no formato YYYY-MM-DD"
      },
      "aluno_cpf": {
        "type": "string",
        "description": "O número de CPF do aluno"
      },
      "aluno_titulo_eleitoral": {
        "type": "string",
        "description": "O número do título de eleitor do aluno"
      },
      "aluno_titulo_zona": {
        "type": "string",
        "description": "A zona eleitoral do aluno"
      },
      "aluno_titulo_secao": {
        "type": "string",
        "description": "A seção da zona eleitoral do aluno"
      },
      "aluno_reservista": {
        "type": "string",
        "description": "O número da reservista do aluno"
      },
      "aluno_reservista_categoria": {
        "type": "string",
        "description": "A categoria da reservista do aluno"
      },
      "aluno_telefone_residencial": {
        "type": "string",
        "description": "O número de telefone residencial do aluno"
      },
      "aluno_telefone_celular": {
        "type": "string",
        "description": "O número de telefone celular do aluno"
      },
      "aluno_telefone_comercial": {
        "type": "string",
        "description": "O número de telefone comercial do aluno"
      },
      "aluno_telefone_fax": {
        "type": "string",
        "description": "O número de fax do aluno"
      },
      "aluno_email": {
        "type": "string",
        "description": "O endereço de e-mail do aluno"
      },
      "aluno_emancipado": {
        "type": "string",
        "description": "Se o aluno é emancipado S - Sim, N - Não"
      },
      "aluno_grau_instrucao_id": {
        "type": "string",
        "description": "O código de identificação do grau de instrução do aluno"
      },
      "aluno_grau_instrucao_descricao": {
        "type": "string",
        "description": "Uma descrição para o grau de instrução do aluno"
      },
      "aluno_profissao_id": {
        "type": "string",
        "description": "O código de identificação para a ocupação do aluno"
      },
      "aluno_profissoa_descricao": {
        "type": "string",
        "description": "Uma descrição para a ocupação do aluno"
      },
      "aluno_religiao_id": {
        "type": "string",
        "description": "O código de identificação para a religição do aluno"
      },
      "aluno_religiao_descricao": {
        "type": "string",
        "description": "Uma descrição para a religião do aluno"
      },
      "aluno_instituicao_2grau_id": {
        "type": "string",
        "description": "O código de identificação para a instituição onde o aluno finalizou o 2º Grau"
      },
      "aluno_instituicao_2grau_descricao": {
        "type": "string",
        "description": "O nome da instituição onde o aluno finalizou o 2º Grau"
      },
      "credor_nome": {
        "type": "string",
        "description": "O nome do creador"
      },
      "credor_cpf": {
        "type": "string",
        "description": "O número de CPF do creador"
      },
      "credor_endereco": {
        "type": "string",
        "description": "O endereço do creador"
      },
      "credor_endereco_cep": {
        "type": "string",
        "description": "O número do CEP do creador"
      },
      "credor_endereco_bairro": {
        "type": "string",
        "description": "O nome do bairro do creador"
      },
      "credor_endereco_cidade": {
        "type": "string",
        "description": "O nome da cidade do creador"
      },
      "credor_endereco_uf": {
        "type": "string",
        "description": "A unidade federativa do creador"
      },
      "credor_telefone_residencial": {
        "type": "string",
        "description": "O número de telefone residencial do creador"
      },
      "credor_telefone_celular": {
        "type": "string",
        "description": "O número de telefone celular do creador"
      },
      "credor_telefone_comercial": {
        "type": "string",
        "description": "O número de telefone comercial do creador"
      },
      "credor_telefone_fax": {
        "type": "string",
        "description": "O número de FAX do creador"
      },
      "ativo": {
        "type": "string",
        "description": "A - Ativo I -Inativo"
      },
      "cursos": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "turma_id": {
              "type": "string",
              "description": "N (string, optional) - O código de identificação da turma do aluno"
            },
            "curso_id": {
              "type": "string",
              "description": "O código de identificação do curso do aluno"
            },
            "curso_descricao": {
              "type": "string",
              "description": "Uma descrição para o curso do aluno"
            },
            "situacao_id": {
              "type": "string",
              "description": "O código de identificação da situação do aluno"
            },
            "situacao_descricao": {
              "type": "string",
              "description": "A descrição da situação do aluno"
            }
          },
          "required": [
            "situacao_id",
            "situacao_descricao"
          ]
        }
      }
    },
    "required": [
      "aluno_id",
      "aluno_nome",
      "aluno_mae"
    ]
  }
}

Turma

Listagem de Turmas

Listagem de Turmas
GET/turmas{?dataInicial}{?dataFinal}{?pagina}{?quantidade}{?turma_id}

Lista os turmas

Example URI

GET https://api.acadweb.com.br/{cliente-sigla}/turmas?dataInicial=2023-04-19 06:36:00?dataFinal=2023-04-24 06:36:00?pagina=1?quantidade=10?turma_id=ADM9555
URI Parameters
HideShow
dataInicial
string (optional) Example: 2023-04-19 06:36:00

A data inicial para se obter as turmas no formato YYYY-MM-DD HH:mm:ss

dataFinal
string (optional) Example: 2023-04-24 06:36:00

A data final para se obter as turmas no formato YYYY-MM-DD HH:mm:ss

pagina
number (optional) Default: 1 Example: 1

A página da paginação das turmas

quantidade
number (optional) Default: 100 Example: 10

A quantidade de itens da página. Se a quantidade de itens for 0 e as datas inicial e final forem iguais, todos os registros desse dia serão retornados.

turma_id
string (optional) Example: ADM9555

Filtra por código da turma

Request  Sucesso
HideShow
Headers
Authorization: Bearer 1|EjhP0T0PdKh07Z5q0AsbhfCChvrZv2jLQtkC2XbV
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "turma_id": "ADM9555",
    "turma_descricao": "Turma ADM 2023",
    "turma_abertura": "2023-04-25",
    "turma_encerramento": "2023-07-25"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "turma_id": {
        "type": "string",
        "description": "Código de identificação da turma"
      },
      "turma_descricao": {
        "type": "string",
        "description": "Uma descrição para a Turma"
      },
      "turma_abertura": {
        "type": "string",
        "description": "Data de abertura da turma no formato YYYY-MM-DD"
      },
      "turma_encerramento": {
        "type": "string",
        "description": "Data de encerramento da turma no formato YYYY-MM-DD"
      }
    },
    "required": [
      "turma_id"
    ]
  }
}

Títulos a Receber

Listagem de Títulos

Listagem de Títulos
GET/financeiro/titulos{?dataInicial}{?dataFinal}{?pagina}{?quantidade}{?vencimentoInicial}{?vencimentoFinal}{?situacao}{?matricula}{?titulo}

Lista os Títulos

Example URI

GET https://api.acadweb.com.br/{cliente-sigla}/financeiro/titulos?dataInicial=2023-04-19 06:36:00?dataFinal=2023-04-24 06:36:00?pagina=1?quantidade=10?vencimentoInicial=2023-04-11?vencimentoFinal=2023-04-24?situacao=A?matricula=QLFO123456?titulo=0103
URI Parameters
HideShow
dataInicial
string (optional) Example: 2023-04-19 06:36:00

A data inicial para se obter os títulos no formato YYYY-MM-DD HH:mm:ss

dataFinal
string (optional) Example: 2023-04-24 06:36:00

A data final para se obter os títulos no formato YYYY-MM-DD HH:mm:ss

pagina
number (optional) Default: 1 Example: 1

A página da paginação dos títulos

quantidade
number (optional) Default: 100 Example: 10

A quantidade de itens da página. Se a quantidade de itens for 0 e as datas inicial e final forem iguais, todos os registros desse dia serão retornados.

vencimentoInicial
string (optional) Example: 2023-04-11

A data de vencimento inicial para se obter os títulos no formato YYYY-MM-DD

vencimentoFinal
string (optional) Example: 2023-04-24

A data de vencimento final para se obter os títulos no formato YYYY-MM-DD

situacao
string (optional) Example: A

Filtra pela situação do título.

matricula
string (optional) Example: QLFO123456

Filtra por matricula do aluno

titulo
string (optional) Example: 0103

Filtra pelo id do titulo

Request  Sucesso
HideShow
Headers
Authorization: Bearer 1|EjhP0T0PdKh07Z5q0AsbhfCChvrZv2jLQtkC2XbV
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "titulo_id": 176720,
    "taxa_id": "10587",
    "taxa_descricao": "PARCELA-RFC",
    "taxa_categoria": "00002",
    "taxa_categoria_descricao": "Parcela",
    "titulo_vencimento": "2023-04-24",
    "titulo_valor": 591.34,
    "titulo_mes_ref": "01",
    "titulo_ano_ref": "2023",
    "titulo_situacao": "B",
    "titulo_observacao": "Aluno indicou o amigo",
    "titulo_tipo": "Crédito",
    "aluno_id": "ADM220028",
    "aluno_nome": "Fulano de Tal",
    "curso_id": "00003",
    "curriculo_id": "ADM20111",
    "turma_id": "ADM03-N",
    "data_atualizacao": "2023-04-25",
    "beneficios": [
      {
        "titulo_id": 1,
        "beneficio_id": "10",
        "beneficio_incidencia": "I",
        "beneficio_incidencia_grupo": "0",
        "beneficio_tipo_grupo": "G",
        "beneficio_descricao": "DESCONTO AUTORIZADO",
        "beneficio_valor": "63.0000",
        "beneficio_dia_incidencia_inicial": "01",
        "beneficio_dia_incidencia_final": "32",
        "beneficio_tipo_valor": "P",
        "data_atualizacao": "2018-08-13 00:00:00.000"
      }
    ]
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "titulo_id": {
        "type": "number",
        "description": "O código de identificação do título"
      },
      "taxa_id": {
        "type": "string",
        "description": "O código de identificação da taxa"
      },
      "taxa_descricao": {
        "type": "string",
        "description": "Descrição da taxa"
      },
      "taxa_categoria": {
        "type": "string",
        "description": "Código de identificação da categoria da taxa, indica se a taxa está dentro de alguma categoria\n(ex: mensalidade, matrículas, material didático-)"
      },
      "taxa_categoria_descricao": {
        "type": "string",
        "description": "Descrição da categoria da taxa"
      },
      "titulo_vencimento": {
        "type": "string",
        "description": "A data de vencimento do título no formato YYYY-MM-DD"
      },
      "titulo_valor": {
        "type": "number",
        "description": "O valor do título com até 4 casas decimais"
      },
      "titulo_mes_ref": {
        "type": "string",
        "description": "Mês de referência do título"
      },
      "titulo_ano_ref": {
        "type": "string",
        "description": "Ano de referência do título"
      },
      "titulo_situacao": {
        "type": "string",
        "description": "Situação do título: A - Em aberto, B - Baixado, X - Cancelado, C - Acordado"
      },
      "titulo_observacao": {
        "type": "string",
        "description": "Observação cadastrada no título"
      },
      "titulo_tipo": {
        "type": "string",
        "description": "O tipo do título"
      },
      "aluno_id": {
        "type": "string",
        "description": "A matrícula do aluno"
      },
      "aluno_nome": {
        "type": "string",
        "description": "O nome do aluno"
      },
      "curso_id": {
        "type": "string",
        "description": "O código de identificação do curso"
      },
      "curriculo_id": {
        "type": "string",
        "description": "Um código do currículo do curso"
      },
      "turma_id": {
        "type": "string",
        "description": "Código de idetificação da turma"
      },
      "data_atualizacao": {
        "type": "string",
        "description": "A data da última atualização no formato YYYY-MM-DD"
      },
      "beneficios": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "titulo_id": {
              "type": "number",
              "description": "ID do título"
            },
            "beneficio_id": {
              "type": "string",
              "description": "ID do benefício"
            },
            "beneficio_incidencia": {
              "type": "string",
              "description": "Incidência do benefício"
            },
            "beneficio_incidencia_grupo": {
              "type": "string",
              "description": "Grupo de incidência do benefício"
            },
            "beneficio_tipo_grupo": {
              "type": "string",
              "description": "Tipo de grupo do benefício"
            },
            "beneficio_descricao": {
              "type": "string",
              "description": "Descrição do benefício"
            },
            "beneficio_valor": {
              "type": "string",
              "description": "Valor do benefício"
            },
            "beneficio_dia_incidencia_inicial": {
              "type": "string",
              "description": "Dia de incidência inicial do benefício"
            },
            "beneficio_dia_incidencia_final": {
              "type": "string",
              "description": "Dia de incidência final do benefício"
            },
            "beneficio_tipo_valor": {
              "type": "string",
              "description": "Tipo de valor do benefício"
            },
            "data_atualizacao": {
              "type": "string",
              "description": "Data de atualização"
            }
          },
          "required": [
            "titulo_id",
            "beneficio_id",
            "beneficio_incidencia",
            "beneficio_incidencia_grupo",
            "beneficio_descricao",
            "beneficio_valor",
            "beneficio_dia_incidencia_inicial",
            "beneficio_dia_incidencia_final",
            "beneficio_tipo_valor",
            "data_atualizacao"
          ]
        }
      }
    },
    "required": [
      "titulo_id",
      "taxa_id",
      "taxa_descricao",
      "taxa_categoria",
      "taxa_categoria_descricao",
      "titulo_vencimento",
      "titulo_valor",
      "titulo_mes_ref",
      "titulo_ano_ref",
      "titulo_situacao",
      "aluno_id",
      "aluno_nome",
      "curso_id",
      "curriculo_id",
      "turma_id",
      "data_atualizacao"
    ]
  }
}

Listagem de Pagamentos

Listagem de Pagamentos
GET/financeiro/baixas{?dataInicial}{?dataFinal}{?pagina}{?quantidade}{?pagamentoInicial}{?pagamentoFinal}{?matricula}{?titulo}{?pagamento}{?localPagamento}

Lista os Pagamentos dos Títulos

Example URI

GET https://api.acadweb.com.br/{cliente-sigla}/financeiro/baixas?dataInicial=2023-04-19 06:36:00?dataFinal=2023-04-24 06:36:00?pagina=1?quantidade=10?pagamentoInicial=2023-04-11?pagamentoFinal=2023-04-24?matricula=QLFO123456?titulo=0103?pagamento=00001?localPagamento=01
URI Parameters
HideShow
dataInicial
string (optional) Example: 2023-04-19 06:36:00

A data inicial para se obter as baixas no formato YYYY-MM-DD HH:mm:ss

dataFinal
string (optional) Example: 2023-04-24 06:36:00

A data final para se obter as baixas no formato YYYY-MM-DD HH:mm:ss

pagina
number (optional) Default: 1 Example: 1

A página da paginação das baixas

quantidade
number (optional) Default: 100 Example: 10

A quantidade de itens da página. Se a quantidade de itens for 0 e as datas inicial e final forem iguais, todos os registros desse dia serão retornados.

pagamentoInicial
string (optional) Example: 2023-04-11

A data de pagamento inicial para se obter as baixas no formato YYYY-MM-DD

pagamentoFinal
string (optional) Example: 2023-04-24

A data de pagamento final para se obter as baixas no formato YYYY-MM-DD

matricula
string (optional) Example: QLFO123456

Filtra por matricula do aluno

titulo
string (optional) Example: 0103

Filtra pelo id do titulo

pagamento
string (optional) Example: 00001

Filtra pelo id da baixa

localPagamento
string (optional) Example: 01

Filtra pelo id do local de pagamento

Request  Sucesso
HideShow
Headers
Authorization: Bearer 1|EjhP0T0PdKh07Z5q0AsbhfCChvrZv2jLQtkC2XbV
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "aluno_id": "ADM000001",
    "titulo_id": 22459,
    "baixa_id": 12614,
    "baixa_valor": 276.5,
    "baixa_data": "2023-03-04",
    "baixa_juros": 0,
    "baixa_multa": 0,
    "baixa_desconto": 118.5,
    "baixa_outros_acrescimos": 0,
    "baixa_observacao": "Baixa com sucesso",
    "baixa_estorno_data": "2023-04-24",
    "baixa_estorno_observacao": "Pagamento duplicado",
    "local_pagamento_id": "01",
    "local_pagamento_descricao": "Tesouraria",
    "data_atualizacao": "2023-04-25",
    "formas_de_pagamento": [
      {
        "baixa_classificacao_id": 1,
        "forma_pagamento_valor": 276.5,
        "forma_pagamento_autorizacao": "0000",
        "forma_pagamento_nsu": "PE-2023-07-20-10-00-00-123456",
        "forma_pagamento_data_credito": "2001-01-01",
        "forma_pagamento_id": "01",
        "forma_pagamento_descricao": "Master Crédito",
        "data_atualizacao": "2023-04-25"
      }
    ]
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "aluno_id": {
        "type": "string",
        "description": "A matrícula do aluno"
      },
      "titulo_id": {
        "type": "number",
        "description": "O código de identificação do título"
      },
      "baixa_id": {
        "type": "number",
        "description": "O código de identificação da baixa"
      },
      "baixa_valor": {
        "type": "number",
        "description": "O valor da baixa"
      },
      "baixa_data": {
        "type": "string",
        "description": "A data que foi data a baixa no formato YYYY-MM-DD"
      },
      "baixa_juros": {
        "type": "number",
        "description": "O Juros da baixa com até 4 casas decimais"
      },
      "baixa_multa": {
        "type": "number",
        "description": "A multa da baixa com até 4 casas decimais"
      },
      "baixa_desconto": {
        "type": "number",
        "description": "O desconto da baixa com até 4 casas decimais"
      },
      "baixa_outros_acrescimos": {
        "type": "number",
        "description": "Algum acrecimo que a taxa sofreu com até 4 casas decimais"
      },
      "baixa_observacao": {
        "type": "string",
        "description": "Uma observação para a baixa"
      },
      "baixa_estorno_data": {
        "type": "string",
        "description": "A data que a baixa foi estornada no formato  YYYY-MM-DD"
      },
      "baixa_estorno_observacao": {
        "type": "string",
        "description": "Uma observação ao estorno da baixa"
      },
      "local_pagamento_id": {
        "type": "string",
        "description": "O código de identificação do local de pagamento"
      },
      "local_pagamento_descricao": {
        "type": "string",
        "description": "A descrição do local de pagamento"
      },
      "data_atualizacao": {
        "type": "string",
        "description": "A data da última atualização no formato YYYY-MM-DD"
      },
      "formas_de_pagamento": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "baixa_classificacao_id": {
              "type": "number",
              "description": "O código de identificação da classificação da baixa"
            },
            "forma_pagamento_valor": {
              "type": "number",
              "description": "O valor de pagamento da baixa"
            },
            "forma_pagamento_autorizacao": {
              "type": "string",
              "description": "Número de autorização"
            },
            "forma_pagamento_nsu": {
              "type": "string",
              "description": "Número sequencial único"
            },
            "forma_pagamento_data_credito": {
              "type": "string",
              "description": "Dia que foi efetuado o pagamento"
            },
            "forma_pagamento_id": {
              "type": "string",
              "description": "O código de identificação do método de pagamento"
            },
            "forma_pagamento_descricao": {
              "type": "string"
            },
            "data_atualizacao": {
              "type": "string",
              "description": "A data da última atualização no formato YYYY-MM-DD"
            }
          },
          "required": [
            "baixa_classificacao_id",
            "forma_pagamento_valor",
            "forma_pagamento_autorizacao",
            "forma_pagamento_nsu",
            "forma_pagamento_data_credito",
            "forma_pagamento_id",
            "data_atualizacao"
          ]
        }
      }
    },
    "required": [
      "aluno_id",
      "titulo_id",
      "baixa_id",
      "baixa_valor",
      "baixa_data",
      "local_pagamento_id",
      "data_atualizacao"
    ]
  }
}

Listagem de Acordos

Listagem de Acordos
GET/financeiro/acordos{?dataInicial}{?dataFinal}{?pagina}{?quantidade}

Lista os Acordos

Example URI

GET https://api.acadweb.com.br/{cliente-sigla}/financeiro/acordos?dataInicial=2023-04-19 06:36:00?dataFinal=2023-04-24 06:36:00?pagina=1?quantidade=10
URI Parameters
HideShow
dataInicial
string (optional) Example: 2023-04-19 06:36:00

A data inicial do intervalo de busca baseado na data de atualização de acordo com o formato YYYY-MM-DD HH:mm:ss

dataFinal
string (optional) Example: 2023-04-24 06:36:00

A data final do intervalo de busca baseado na data de atualização de acordo com o formato YYYY-MM-DD HH:mm:ss

pagina
number (optional) Default: 1 Example: 1

A página da paginação das baixas

quantidade
number (optional) Default: 100 Example: 10

A quantidade de itens da página. Se a quantidade de itens for 0 e as datas inicial e final forem iguais, todos os registros desse dia serão retornados.

Request  Sucesso
HideShow
Headers
Authorization: Bearer 1|EjhP0T0PdKh07Z5q0AsbhfCChvrZv2jLQtkC2XbV
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "aluno_id": "ELT176720",
    "acordo_id": 321,
    "acordo_data": "2023-04-24",
    "acordo_numero_parcelas": "2",
    "acordo_juros": "5,446.10",
    "acordo_multa": "446.00",
    "acordo_desconto": "253.20",
    "acordo_outros_acrescimos": "4654.20",
    "acordo_outros_descontos": "852.10",
    "data_atualizacao": "2023-04-25",
    "parecelas": [
      {
        "parcela_titulo_id": 999555,
        "parcela_titulo_vencimento": "2023-04-25",
        "parcela_titulo_valor": "1,020.01",
        "parcela_titulo_tipo": "E|S"
      }
    ]
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "aluno_id": {
        "type": "string",
        "description": "A matrícula do aluno"
      },
      "acordo_id": {
        "type": "number",
        "description": "O código de identificação do acordo"
      },
      "acordo_data": {
        "type": "string",
        "description": "A data do acordo no formato YYYY-MM-DD"
      },
      "acordo_numero_parcelas": {
        "type": "string",
        "description": "Número de parcelas do acordo"
      },
      "acordo_juros": {
        "type": "string",
        "description": "Juros gerados no acordo com até duas casas decimais"
      },
      "acordo_multa": {
        "type": "string",
        "description": "Multa gerada no acordo com até duas casas decimais"
      },
      "acordo_desconto": {
        "type": "string",
        "description": "Valor do desconto do acordo com até duas casas decimais"
      },
      "acordo_outros_acrescimos": {
        "type": "string",
        "description": "Valor de acrescimo do acordo com até duas casas decimais"
      },
      "acordo_outros_descontos": {
        "type": "string",
        "description": "Valor de outros descontos do acordo com até duas casas decimais"
      },
      "data_atualizacao": {
        "type": "string",
        "description": "A data da última atualização no formato YYYY-MM-DD"
      },
      "parecelas": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "parcela_titulo_id": {
              "type": "number",
              "description": "Número de identificação da parcela"
            },
            "parcela_titulo_vencimento": {
              "type": "string",
              "description": "A data da última atualização no formato YYYY-MM-DD"
            },
            "parcela_titulo_valor": {
              "type": "string",
              "description": "Valor da parcela com até duas casas decimais"
            },
            "parcela_titulo_tipo": {
              "type": "string",
              "description": "E = Entrada (são os títulos que deram origem ao acordo) - S = Saída (são os títulos gerados pelo acordo)"
            }
          },
          "required": [
            "parcela_titulo_id",
            "parcela_titulo_vencimento",
            "parcela_titulo_tipo"
          ]
        }
      }
    },
    "required": [
      "aluno_id",
      "acordo_id",
      "acordo_data",
      "acordo_numero_parcelas",
      "acordo_desconto",
      "acordo_outros_acrescimos",
      "acordo_outros_descontos",
      "data_atualizacao"
    ]
  }
}

Listagem de Beneficios

Listagem de Beneficios
GET/financeiro/beneficios{?dataInicial}{?dataFinal}{?pagina}{?quantidade}{?titulo}{?beneficio}

Lista os Beneficios

Example URI

GET https://api.acadweb.com.br/{cliente-sigla}/financeiro/beneficios?dataInicial=2023-04-19 06:36:00?dataFinal=2023-04-24 06:36:00?pagina=1?quantidade=10?titulo=0103?beneficio=10
URI Parameters
HideShow
dataInicial
string (optional) Example: 2023-04-19 06:36:00

A data inicial do intervalo de busca baseado na data de atualização do beneficio com o formato YYYY-MM-DD HH:mm:ss

dataFinal
string (optional) Example: 2023-04-24 06:36:00

A data final do intervalo de busca baseado na data de atualização do beneficio com o formato YYYY-MM-DD HH:mm:ss

pagina
number (optional) Default: 1 Example: 1

A página da paginação do beneficio

quantidade
number (optional) Default: 100 Example: 10

A quantidade de itens da página. Se a quantidade de itens for 0 e as datas inicial e final forem iguais, todos os registros desse dia serão retornados.

titulo
string (optional) Example: 0103

Filtra pelo id do titulo

beneficio
string (optional) Example: 10

Filtra pelo id do beneficio

Request  Sucesso
HideShow
Headers
Authorization: Bearer 1|EjhP0T0PdKh07Z5q0AsbhfCChvrZv2jLQtkC2XbV
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "titulo_id": 1,
    "beneficio_id": "10",
    "beneficio_incidencia": "I",
    "beneficio_incidencia_grupo": "0",
    "beneficio_tipo_grupo": "G",
    "beneficio_descricao": "DESCONTO AUTORIZADO",
    "beneficio_valor": "63.0000",
    "beneficio_dia_incidencia_inicial": "01",
    "beneficio_dia_incidencia_final": "32",
    "beneficio_tipo_valor": "P",
    "data_atualizacao": "2018-08-13 00:00:00.000",
    "titulo": [
      {
        "titulo_id": 176720,
        "taxa_id": "10587",
        "taxa_descricao": "PARCELA-RFC",
        "taxa_categoria": "00002",
        "taxa_categoria_descricao": "Parcela",
        "titulo_vencimento": "2023-04-24",
        "titulo_valor": 591.34,
        "titulo_mes_ref": "01",
        "titulo_ano_ref": "2023",
        "titulo_situacao": "B",
        "titulo_observacao": "Aluno indicou o amigo",
        "titulo_tipo": "Crédito",
        "aluno_id": "ADM220028",
        "aluno_nome": "Fulano de Tal",
        "curso_id": "00003",
        "curriculo_id": "ADM20111",
        "turma_id": "ADM03-N",
        "data_atualizacao": "2023-04-25"
      }
    ]
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "titulo_id": {
        "type": "number",
        "description": "ID do título"
      },
      "beneficio_id": {
        "type": "string",
        "description": "ID do benefício"
      },
      "beneficio_incidencia": {
        "type": "string",
        "description": "Incidência do benefício"
      },
      "beneficio_incidencia_grupo": {
        "type": "string",
        "description": "Grupo de incidência do benefício"
      },
      "beneficio_tipo_grupo": {
        "type": "string",
        "description": "Tipo de grupo do benefício"
      },
      "beneficio_descricao": {
        "type": "string",
        "description": "Descrição do benefício"
      },
      "beneficio_valor": {
        "type": "string",
        "description": "Valor do benefício"
      },
      "beneficio_dia_incidencia_inicial": {
        "type": "string",
        "description": "Dia de incidência inicial do benefício"
      },
      "beneficio_dia_incidencia_final": {
        "type": "string",
        "description": "Dia de incidência final do benefício"
      },
      "beneficio_tipo_valor": {
        "type": "string",
        "description": "Tipo de valor do benefício"
      },
      "data_atualizacao": {
        "type": "string",
        "description": "Data de atualização"
      },
      "titulo": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "titulo_id": {
              "type": "number",
              "description": "O código de identificação do título"
            },
            "taxa_id": {
              "type": "string",
              "description": "O código de identificação da taxa"
            },
            "taxa_descricao": {
              "type": "string",
              "description": "Descrição da taxa"
            },
            "taxa_categoria": {
              "type": "string",
              "description": "Código de identificação da categoria da taxa, indica se a taxa está dentro de alguma categoria\n(ex: mensalidade, matrículas, material didático-)"
            },
            "taxa_categoria_descricao": {
              "type": "string",
              "description": "Descrição da categoria da taxa"
            },
            "titulo_vencimento": {
              "type": "string",
              "description": "A data de vencimento do título no formato YYYY-MM-DD"
            },
            "titulo_valor": {
              "type": "number",
              "description": "O valor do título com até 4 casas decimais"
            },
            "titulo_mes_ref": {
              "type": "string",
              "description": "Mês de referência do título"
            },
            "titulo_ano_ref": {
              "type": "string",
              "description": "Ano de referência do título"
            },
            "titulo_situacao": {
              "type": "string",
              "description": "Situação do título: A - Em aberto, B - Baixado, X - Cancelado, C - Acordado"
            },
            "titulo_observacao": {
              "type": "string",
              "description": "Observação cadastrada no título"
            },
            "titulo_tipo": {
              "type": "string",
              "description": "O tipo do título"
            },
            "aluno_id": {
              "type": "string",
              "description": "A matrícula do aluno"
            },
            "aluno_nome": {
              "type": "string",
              "description": "O nome do aluno"
            },
            "curso_id": {
              "type": "string",
              "description": "O código de identificação do curso"
            },
            "curriculo_id": {
              "type": "string",
              "description": "Um código do currículo do curso"
            },
            "turma_id": {
              "type": "string",
              "description": "Código de idetificação da turma"
            },
            "data_atualizacao": {
              "type": "string",
              "description": "A data da última atualização no formato YYYY-MM-DD"
            }
          },
          "required": [
            "titulo_id",
            "taxa_id",
            "taxa_descricao",
            "taxa_categoria",
            "taxa_categoria_descricao",
            "titulo_vencimento",
            "titulo_valor",
            "titulo_mes_ref",
            "titulo_ano_ref",
            "titulo_situacao",
            "aluno_id",
            "aluno_nome",
            "curso_id",
            "curriculo_id",
            "turma_id",
            "data_atualizacao"
          ]
        }
      }
    },
    "required": [
      "titulo_id",
      "beneficio_id",
      "beneficio_incidencia",
      "beneficio_incidencia_grupo",
      "beneficio_descricao",
      "beneficio_valor",
      "beneficio_dia_incidencia_inicial",
      "beneficio_dia_incidencia_final",
      "beneficio_tipo_valor",
      "data_atualizacao"
    ]
  }
}

Listagem de Formas de Pagamentos

Listagem de Formas de Pagamentos
GET/financeiro/formas-pagamento{?dataInicial}{?dataFinal}{?pagina}{?quantidade}{?nsu}{?aut}{?formaPagamento}

Lista as Formas de Pagamentos

Example URI

GET https://api.acadweb.com.br/{cliente-sigla}/financeiro/formas-pagamento?dataInicial=2023-04-19 06:36:00?dataFinal=2023-04-24 06:36:00?pagina=1?quantidade=10?nsu=PE-2023-07-20-10-00-00-123456?aut=9999999?formaPagamento=01
URI Parameters
HideShow
dataInicial
string (optional) Example: 2023-04-19 06:36:00

A data inicial do intervalo de busca baseado na data de atualização de formas de pagamento com o formato YYYY-MM-DD HH:mm:ss

dataFinal
string (optional) Example: 2023-04-24 06:36:00

A data final do intervalo de busca baseado na data de atualização de formas de pagamento com o formato YYYY-MM-DD HH:mm:ss

pagina
number (optional) Default: 1 Example: 1

A página da paginação da forma de pagamento

quantidade
number (optional) Default: 100 Example: 10

A quantidade de itens da página. Se a quantidade de itens for 0 e as datas inicial e final forem iguais, todos os registros desse dia serão retornados.

pagamento
string (optional) Example: 1

Filtra pelo id da baixa

formaPagamento
string (optional) Example: 01

Filtra pelo id da forma de pagamento

nsu
string (optional) Example: PE-2023-07-20-10-00-00-123456

Filtra pelo NSU da forma de pagamento

aut
string (optional) Example: 9999999

Filtra pelo número de autorização da forma de pagamento

Request  Sucesso
HideShow
Headers
Authorization: Bearer 1|EjhP0T0PdKh07Z5q0AsbhfCChvrZv2jLQtkC2XbV
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "baixa_id": 1,
    "baixa_classificacao_id": "1",
    "forma_pagamento_valor": ".0000",
    "forma_pagamento_autorizacao": "0000",
    "forma_pagamento_nsu": "PE-2023-07-20-10-00-00-123456",
    "forma_pagamento_data_credito": "2001-01-01",
    "forma_pagamento_id": "01",
    "forma_pagamento_descricao": "Dinheiro",
    "data_atualizacao": "2018-08-13 00:00:00.000",
    "baixa": [
      {
        "aluno_id": "ADM000001",
        "titulo_id": 22459,
        "baixa_id": 12614,
        "baixa_valor": 276.5,
        "baixa_data": "2023-03-04",
        "baixa_juros": 0,
        "baixa_multa": 0,
        "baixa_desconto": 118.5,
        "baixa_outros_acrescimos": 0,
        "baixa_observacao": "Baixa com sucesso",
        "baixa_estorno_data": "2023-04-24",
        "baixa_estorno_observacao": "Pagamento duplicado",
        "local_pagamento_id": "01",
        "local_pagamento_descricao": "Tesouraria",
        "data_atualizacao": "2023-04-25"
      }
    ]
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "baixa_id": {
        "type": "number",
        "description": "ID da baixa"
      },
      "baixa_classificacao_id": {
        "type": "string",
        "description": "ID da classificação da baixa"
      },
      "forma_pagamento_valor": {
        "type": "string",
        "description": "Valor da forma de pagamento"
      },
      "forma_pagamento_autorizacao": {
        "type": "string",
        "description": "Número de autorização"
      },
      "forma_pagamento_nsu": {
        "type": "string",
        "description": "Número sequencial único"
      },
      "forma_pagamento_data_credito": {
        "type": "string",
        "description": "Dia que foi efetuado o pagamento"
      },
      "forma_pagamento_id": {
        "type": "string",
        "description": "ID da forma de pagamento"
      },
      "forma_pagamento_descricao": {
        "type": "string",
        "description": "Descrição da forma de pagamento"
      },
      "data_atualizacao": {
        "type": "string",
        "description": "Data de atualização"
      },
      "baixa": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "aluno_id": {
              "type": "string",
              "description": "A matrícula do aluno"
            },
            "titulo_id": {
              "type": "number",
              "description": "O código de identificação do título"
            },
            "baixa_id": {
              "type": "number",
              "description": "O código de identificação da baixa"
            },
            "baixa_valor": {
              "type": "number",
              "description": "O valor da baixa"
            },
            "baixa_data": {
              "type": "string",
              "description": "A data que foi data a baixa no formato YYYY-MM-DD"
            },
            "baixa_juros": {
              "type": "number",
              "description": "O Juros da baixa com até 4 casas decimais"
            },
            "baixa_multa": {
              "type": "number",
              "description": "A multa da baixa com até 4 casas decimais"
            },
            "baixa_desconto": {
              "type": "number",
              "description": "O desconto da baixa com até 4 casas decimais"
            },
            "baixa_outros_acrescimos": {
              "type": "number",
              "description": "Algum acrecimo que a taxa sofreu com até 4 casas decimais"
            },
            "baixa_observacao": {
              "type": "string",
              "description": "Uma observação para a baixa"
            },
            "baixa_estorno_data": {
              "type": "string",
              "description": "A data que a baixa foi estornada no formato  YYYY-MM-DD"
            },
            "baixa_estorno_observacao": {
              "type": "string",
              "description": "Uma observação ao estorno da baixa"
            },
            "local_pagamento_id": {
              "type": "string",
              "description": "O código de identificação do local de pagamento"
            },
            "local_pagamento_descricao": {
              "type": "string",
              "description": "A descrição do local de pagamento"
            },
            "data_atualizacao": {
              "type": "string",
              "description": "A data da última atualização no formato YYYY-MM-DD"
            }
          },
          "required": [
            "aluno_id",
            "titulo_id",
            "baixa_id",
            "baixa_valor",
            "baixa_data",
            "local_pagamento_id",
            "data_atualizacao"
          ]
        }
      }
    },
    "required": [
      "baixa_id",
      "baixa_classificacao_id",
      "forma_pagamento_valor",
      "forma_pagamento_autorizacao",
      "forma_pagamento_nsu",
      "forma_pagamento_data_credito",
      "forma_pagamento_id",
      "forma_pagamento_descricao",
      "data_atualizacao"
    ]
  }
}

Listagem de Caixas em Grupos

Listagem de Caixas em Grupos
GET/financeiro/caixas-grupos{?pagina}{?quantidade}{?dataAberturaInicial}{?dataAberturaFinal}{?dataFechamentoInicial}{?dataFechamentoFinal}{?grupo}{?apenasUltimos}

Lista os Caixas em Grupos

Example URI

GET https://api.acadweb.com.br/{cliente-sigla}/financeiro/caixas-grupos?pagina=1?quantidade=10?dataAberturaInicial=2024-08-09?dataAberturaFinal=2024-08-09?dataFechamentoInicial=2024-08-09?dataFechamentoFinal=2024-08-09?grupo=001?apenasUltimos=1
URI Parameters
HideShow
pagina
number (optional) Default: 1 Example: 1

A página da paginação da forma de pagamento

quantidade
number (optional) Default: 100 Example: 10

A quantidade de itens da página. Se a quantidade de itens for 0 e as datas inicial e final forem iguais, todos os registros desse dia serão retornados.

dataAberturaInicial
string (optional) Example: 2024-08-09

A data inicial do intervalo de busca baseado na data de abertura do caixas em grupos com o formato YYYY-MM-DD

dataAberturaFinal
string (optional) Example: 2024-08-09

A data final do intervalo de busca baseado na data de abertura do caixas em grupos com o formato YYYY-MM-DD

dataFechamentoInicial
string (optional) Example: 2024-08-09

A data inicial do intervalo de busca baseado na data de fechamento do caixas em grupos com o formato YYYY-MM-DD

dataFechamentoFinal
string (optional) Example: 2024-08-09

A data final do intervalo de busca baseado na data de fechamento do caixas em grupos com o formato YYYY-MM-DD

grupo
string (optional) Example: 001

Filtra pelo código do grupo

apenasUltimos
number (optional) Default: 1 Example: 1

Se true (1) retorna apenas os últimos caixas de cada grupo

Request  Sucesso
HideShow
Headers
Authorization: Bearer 1|EjhP0T0PdKh07Z5q0AsbhfCChvrZv2jLQtkC2XbV
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "caixa_grupo_caixa_codigo": 599,
    "caixa_grupo_codigo": "001",
    "caixa_grupo_abertura_data": "2001-01-01",
    "caixa_grupo_abertura_hora": "02:00",
    "caixa_grupo_fechamento_data": "2001-01-01",
    "caixa_grupo_fechamento_hora": "02:00"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "caixa_grupo_caixa_codigo": {
        "type": "number",
        "description": "ID do caixa"
      },
      "caixa_grupo_codigo": {
        "type": "string",
        "description": "ID do grupo do caixa"
      },
      "caixa_grupo_abertura_data": {
        "type": "string",
        "description": "Data de abertura do caixa"
      },
      "caixa_grupo_abertura_hora": {
        "type": "string",
        "description": "Hora de abertura do caixa"
      },
      "caixa_grupo_fechamento_data": {
        "type": "string",
        "description": "Data de fechamento do caixa"
      },
      "caixa_grupo_fechamento_hora": {
        "type": "string",
        "description": "Hora de fechamento do caixa"
      }
    },
    "required": [
      "caixa_grupo_caixa_codigo",
      "caixa_grupo_codigo",
      "caixa_grupo_abertura_data",
      "caixa_grupo_abertura_hora",
      "caixa_grupo_fechamento_data",
      "caixa_grupo_fechamento_hora"
    ]
  }
}

Títulos a Pagar

Listagem de Fornecedores

Listagem de Fornecedores
GET/financeiro/clientes/fornecedores{?dataInicial}{?dataFinal}{?pagina}{?quantidade}{?fornecedor}{?fornecedor_tipo}

Lista os Clientes Fornecedores

Example URI

GET https://api.acadweb.com.br/{cliente-sigla}/financeiro/clientes/fornecedores?dataInicial=2023-04-19 06:36:00?dataFinal=2023-04-24 06:36:00?pagina=1?quantidade=10?fornecedor=00001?fornecedor_tipo=RECEB
URI Parameters
HideShow
dataInicial
string (optional) Example: 2023-04-19 06:36:00

A data inicial do intervalo de busca baseado na data de atualização de cliente fornecedor com o formato YYYY-MM-DD HH:mm:ss

dataFinal
string (optional) Example: 2023-04-24 06:36:00

A data final do intervalo de busca baseado na data de atualização de cliente fornecedor com o formato YYYY-MM-DD HH:mm:ss

pagina
number (optional) Default: 1 Example: 1

A página da paginação dos fornecedoores

quantidade
number (optional) Default: 100 Example: 10

A quantidade de itens da página. Se a quantidade de itens for 0 e as datas inicial e final forem iguais, todos os registros desse dia serão retornados.

fornecedor
string (optional) Example: 00001

Filtra pelo id do fornecedor

fornecedor_tipo
string (optional) Default: RECEB Example: RECEB

Filtra pelo tipo do fornecedor

  • Opções
    • BIBLI BIBLIOTECA
    • CONTA CONTAS
    • CURSO ALUNO
    • EMPRE EMPRESAS
    • ESCOL ESCOLAS
    • EVENT EVENTO
    • FORNE FORNECEDOR
    • FUNCI FUNCIONARIOS
    • PROFE PROFESSORES
    • RECEB CLIENTES
    • VESTB VESTIBULAR
Request  Sucesso
HideShow
Headers
Authorization: Bearer 1|EjhP0T0PdKh07Z5q0AsbhfCChvrZv2jLQtkC2XbV
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "fornecedor_tipo": "RECEB",
    "fornecedor_id": "1",
    "fornecedor_nome": "BASIC CAMISAS",
    "fornecedor_nomefantasia": "null",
    "fornecedor_endereco": "null",
    "fornecedor_bairro": "null",
    "fornecedor_cidade": "null",
    "fornecedor_uf": "null",
    "fornecedor_cep": "null",
    "fornecedor_isncmunicipal": "null",
    "fornecedor_inscestadual": "null",
    "fornecedor_fone1": "null",
    "fornecedor_fone2": "null",
    "fornecedor_fax": "null",
    "fornecedor_celular": "null",
    "fornecedor_contato": "null",
    "fornecedor_cpfcnpj": "null",
    "fornecedor_email": "null",
    "fornecedor_homepage": "null",
    "fornecedor_ativo": "null",
    "data_atualizacao": "2023-04-14 00:00:00.000"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "fornecedor_tipo": {
        "type": "string",
        "description": "Tipo do fornecedor"
      },
      "fornecedor_id": {
        "type": "string",
        "description": "ID do fornecedor"
      },
      "fornecedor_nome": {
        "type": "string",
        "description": "Nome do fornecedor"
      },
      "fornecedor_nomefantasia": {
        "type": "string",
        "description": "Nome fantasia do fornecedor"
      },
      "fornecedor_endereco": {
        "type": "string",
        "description": "Endereço do fornecedor"
      },
      "fornecedor_bairro": {
        "type": "string",
        "description": "Bairro do fornecedor"
      },
      "fornecedor_cidade": {
        "type": "string",
        "description": "Cidade do fornecedor"
      },
      "fornecedor_uf": {
        "type": "string",
        "description": "UF do fornecedor"
      },
      "fornecedor_cep": {
        "type": "string",
        "description": "CEP do fornecedor"
      },
      "fornecedor_isncmunicipal": {
        "type": "string",
        "description": "Inscrição municipal do fornecedor"
      },
      "fornecedor_inscestadual": {
        "type": "string",
        "description": "Inscrição estadual do fornecedor"
      },
      "fornecedor_fone1": {
        "type": "string",
        "description": "Telefone 1 do fornecedor"
      },
      "fornecedor_fone2": {
        "type": "string",
        "description": "Telefone 2 do fornecedor"
      },
      "fornecedor_fax": {
        "type": "string",
        "description": "Fax do fornecedor"
      },
      "fornecedor_celular": {
        "type": "string",
        "description": "Celular do fornecedor"
      },
      "fornecedor_contato": {
        "type": "string",
        "description": "Contato do fornecedor"
      },
      "fornecedor_cpfcnpj": {
        "type": "string",
        "description": "CPF/CNPJ do fornecedor"
      },
      "fornecedor_email": {
        "type": "string",
        "description": "Email do fornecedor"
      },
      "fornecedor_homepage": {
        "type": "string",
        "description": "Homepage do fornecedor"
      },
      "fornecedor_ativo": {
        "type": "string",
        "description": "Ativo do fornecedor"
      },
      "data_atualizacao": {
        "type": "string",
        "description": "Data de atualização"
      }
    },
    "required": [
      "fornecedor_tipo",
      "fornecedor_id",
      "data_atualizacao"
    ]
  }
}

Listagem de Títulos

Listagem de Títulos
GET/financeiro/clientes/titulos-pagar{?dataInicial}{?dataFinal}{?pagina}{?quantidade}{?vencimentoInicial}{?vencimentoFinal}{?situacao}{?fornecedor}{?fornecedor_tipo}{?titulo}

Lista os Títulos

Example URI

GET https://api.acadweb.com.br/{cliente-sigla}/financeiro/clientes/titulos-pagar?dataInicial=2023-04-19 06:36:00?dataFinal=2023-04-24 06:36:00?pagina=1?quantidade=10?vencimentoInicial=2023-04-19?vencimentoFinal=2023-04-24?situacao=A?fornecedor=00001?fornecedor_tipo=RECEB?titulo=00001
URI Parameters
HideShow
dataInicial
string (optional) Example: 2023-04-19 06:36:00

A data inicial do intervalo de busca baseado na data de atualização de títulos a pagar com o formato YYYY-MM-DD HH:mm:ss

dataFinal
string (optional) Example: 2023-04-24 06:36:00

A data final do intervalo de busca baseado na data de atualização de títulos a pagar com o formato YYYY-MM-DD HH:mm:ss

pagina
number (optional) Default: 1 Example: 1

A página da paginação dos títulos

quantidade
number (optional) Default: 100 Example: 10

A quantidade de itens da página. Se a quantidade de itens for 0 e as datas inicial e final forem iguais, todos os registros desse dia serão retornados.

vencimentoInicial
string (optional) Example: 2023-04-19

A data de vencimento Inicial para se obter os títulos no formato YYYY-MM-DD

vencimentoFinal
string (optional) Example: 2023-04-24

A data de vencimento final para se obter os títulos no formato YYYY-MM-DD

situacao
string (optional) Example: A

Filtra pela situação do título.

fornecedor
string (optional) Example: 00001

Filtra pelo id do fornecedor

fornecedor_tipo
string (optional) Default: RECEB Example: RECEB

Filtra pelo tipo do fornecedor

  • Opções
    • BIBLI BIBLIOTECA
    • CONTA CONTAS
    • CURSO ALUNO
    • EMPRE EMPRESAS
    • ESCOL ESCOLAS
    • EVENT EVENTO
    • FORNE FORNECEDOR
    • FUNCI FUNCIONARIOS
    • PROFE PROFESSORES
    • RECEB CLIENTES
    • VESTB VESTIBULAR
titulo
string (optional) Example: 00001

Filtra pelo id do titulo

Request  Sucesso
HideShow
Headers
Authorization: Bearer 1|EjhP0T0PdKh07Z5q0AsbhfCChvrZv2jLQtkC2XbV
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "fornecedor_id": "00013",
    "fornecedor_tipo": "RECEB",
    "fornecedor_nome": "PBF Gráfica e Textil",
    "titulo_id": 169034,
    "taxa_id": "20058",
    "taxa_descricao": "FARDAMENTO ALUNOS",
    "taxa_categoria": "null",
    "taxa_categoria_descricao": "null",
    "titulo_vencimento": "2018-08-24",
    "titulo_valor": "2053.3300",
    "titulo_mes_ref": "08",
    "titulo_ano_ref": "2018",
    "titulo_situacao": "B",
    "titulo_observacao": "Compra fardamento 3",
    "curso_id": "null",
    "curriculo_id": "null",
    "turma_id": "null",
    "data_atualizacao": "2001-01-01 00:00:00.000",
    "fornecedor": [
      {
        "fornecedor_tipo": "RECEB",
        "fornecedor_id": "1",
        "fornecedor_nome": "BASIC CAMISAS",
        "fornecedor_nomefantasia": "null",
        "fornecedor_endereco": "null",
        "fornecedor_bairro": "null",
        "fornecedor_cidade": "null",
        "fornecedor_uf": "null",
        "fornecedor_cep": "null",
        "fornecedor_isncmunicipal": "null",
        "fornecedor_inscestadual": "null",
        "fornecedor_fone1": "null",
        "fornecedor_fone2": "null",
        "fornecedor_fax": "null",
        "fornecedor_celular": "null",
        "fornecedor_contato": "null",
        "fornecedor_cpfcnpj": "null",
        "fornecedor_email": "null",
        "fornecedor_homepage": "null",
        "fornecedor_ativo": "null",
        "data_atualizacao": "2023-04-14 00:00:00.000"
      }
    ]
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "fornecedor_id": {
        "type": "string",
        "description": "ID do fornecedor"
      },
      "fornecedor_tipo": {
        "type": "string",
        "description": "Tipo do fornecedor"
      },
      "fornecedor_nome": {
        "type": "string",
        "description": "Nome do fornecedor"
      },
      "titulo_id": {
        "type": "number",
        "description": "ID do título"
      },
      "taxa_id": {
        "type": "string",
        "description": "ID da taxa"
      },
      "taxa_descricao": {
        "type": "string",
        "description": "Descrição da taxa"
      },
      "taxa_categoria": {
        "type": "string",
        "description": "Categoria da taxa"
      },
      "taxa_categoria_descricao": {
        "type": "string",
        "description": "Descrição da categoria da taxa"
      },
      "titulo_vencimento": {
        "type": "string",
        "description": "Vencimento do título"
      },
      "titulo_valor": {
        "type": "string",
        "description": "Valor do título"
      },
      "titulo_mes_ref": {
        "type": "string",
        "description": "Mês de referência do título"
      },
      "titulo_ano_ref": {
        "type": "string",
        "description": "Ano de referência do título"
      },
      "titulo_situacao": {
        "type": "string",
        "description": "Situação do título"
      },
      "titulo_observacao": {
        "type": "string",
        "description": "Observação do título"
      },
      "curso_id": {
        "type": "string",
        "description": "ID do curso"
      },
      "curriculo_id": {
        "type": "string",
        "description": "ID do currículo"
      },
      "turma_id": {
        "type": "string",
        "description": "ID da turma"
      },
      "data_atualizacao": {
        "type": "string",
        "description": "Data de atualização"
      },
      "fornecedor": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "fornecedor_tipo": {
              "type": "string",
              "description": "Tipo do fornecedor"
            },
            "fornecedor_id": {
              "type": "string",
              "description": "ID do fornecedor"
            },
            "fornecedor_nome": {
              "type": "string",
              "description": "Nome do fornecedor"
            },
            "fornecedor_nomefantasia": {
              "type": "string",
              "description": "Nome fantasia do fornecedor"
            },
            "fornecedor_endereco": {
              "type": "string",
              "description": "Endereço do fornecedor"
            },
            "fornecedor_bairro": {
              "type": "string",
              "description": "Bairro do fornecedor"
            },
            "fornecedor_cidade": {
              "type": "string",
              "description": "Cidade do fornecedor"
            },
            "fornecedor_uf": {
              "type": "string",
              "description": "UF do fornecedor"
            },
            "fornecedor_cep": {
              "type": "string",
              "description": "CEP do fornecedor"
            },
            "fornecedor_isncmunicipal": {
              "type": "string",
              "description": "Inscrição municipal do fornecedor"
            },
            "fornecedor_inscestadual": {
              "type": "string",
              "description": "Inscrição estadual do fornecedor"
            },
            "fornecedor_fone1": {
              "type": "string",
              "description": "Telefone 1 do fornecedor"
            },
            "fornecedor_fone2": {
              "type": "string",
              "description": "Telefone 2 do fornecedor"
            },
            "fornecedor_fax": {
              "type": "string",
              "description": "Fax do fornecedor"
            },
            "fornecedor_celular": {
              "type": "string",
              "description": "Celular do fornecedor"
            },
            "fornecedor_contato": {
              "type": "string",
              "description": "Contato do fornecedor"
            },
            "fornecedor_cpfcnpj": {
              "type": "string",
              "description": "CPF/CNPJ do fornecedor"
            },
            "fornecedor_email": {
              "type": "string",
              "description": "Email do fornecedor"
            },
            "fornecedor_homepage": {
              "type": "string",
              "description": "Homepage do fornecedor"
            },
            "fornecedor_ativo": {
              "type": "string",
              "description": "Ativo do fornecedor"
            },
            "data_atualizacao": {
              "type": "string",
              "description": "Data de atualização"
            }
          },
          "required": [
            "fornecedor_tipo",
            "fornecedor_id",
            "data_atualizacao"
          ]
        }
      }
    },
    "required": [
      "fornecedor_id",
      "fornecedor_tipo",
      "fornecedor_nome",
      "titulo_id",
      "taxa_id",
      "taxa_descricao",
      "titulo_vencimento",
      "titulo_valor",
      "titulo_mes_ref",
      "titulo_ano_ref",
      "titulo_situacao",
      "titulo_observacao",
      "data_atualizacao"
    ]
  }
}

Listagem de Pagamentos

Listagem de Pagamentos
GET/financeiro/clientes/titulos-pagar-baixa{?dataInicial}{?dataFinal}{?pagina}{?quantidade}{?pagamentoInicial}{?pagamentoFinal}{?fornecedor}{?fornecedor_tipo}{?titulo}{?localPagamento}

Lista os Pagamentos

Example URI

GET https://api.acadweb.com.br/{cliente-sigla}/financeiro/clientes/titulos-pagar-baixa?dataInicial=2023-04-19 06:36:00?dataFinal=2023-04-24 06:36:00?pagina=1?quantidade=10?pagamentoInicial=2023-04-19?pagamentoFinal=2023-04-24?fornecedor=00001?fornecedor_tipo=RECEB?titulo=154654?localPagamento=01
URI Parameters
HideShow
dataInicial
string (optional) Example: 2023-04-19 06:36:00

A data inicial do intervalo de busca baseado na data de atualização de títulos a pagar baixa com o formato YYYY-MM-DD HH:mm:ss

dataFinal
string (optional) Example: 2023-04-24 06:36:00

A data final do intervalo de busca baseado na data de atualização de títulos a pagar baixa com o formato YYYY-MM-DD HH:mm:ss

pagina
number (optional) Default: 1 Example: 1

A página da paginação das baixas

quantidade
number (optional) Default: 100 Example: 10

A quantidade de itens da página. Se a quantidade de itens for 0 e as datas inicial e final forem iguais, todos os registros desse dia serão retornados.

pagamentoInicial
string (optional) Example: 2023-04-19

A data de pagamento Inicial para se obter os títulos no formato YYYY-MM-DD

pagamentoFinal
string (optional) Example: 2023-04-24

A data de pagamento final para se obter os títulos no formato YYYY-MM-DD

fornecedor
string (optional) Example: 00001

Filtra pelo id do fornecedor

fornecedor_tipo
string (optional) Default: RECEB Example: RECEB

Filtra pelo tipo do fornecedor

  • Opções
    • BIBLI BIBLIOTECA
    • CONTA CONTAS
    • CURSO ALUNO
    • EMPRE EMPRESAS
    • ESCOL ESCOLAS
    • EVENT EVENTO
    • FORNE FORNECEDOR
    • FUNCI FUNCIONARIOS
    • PROFE PROFESSORES
    • RECEB CLIENTES
    • VESTB VESTIBULAR
titulo
string (optional) Example: 154654

Filtra pelo id do titulo

pagamento
string (optional) Example: 00001

Filtra pelo id da baixa

localPagamento
string (optional) Example: 01

Filtra pelo id do local de pagamento

Request  Sucesso
HideShow
Headers
Authorization: Bearer 1|EjhP0T0PdKh07Z5q0AsbhfCChvrZv2jLQtkC2XbV
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "fornecedor_id": "00013",
    "fornecedor_tipo": "RECEB",
    "titulo_id": 169034,
    "baixa_id": "51099",
    "baixa_valor": "2053.3300",
    "baixa_data": "2018-08-24",
    "baixa_juros": ".0000",
    "baixa_multa": ".0000",
    "baixa_desconto": ".0000",
    "baixa_outros_acrescimos": ".0000",
    "baixa_observacao": "null",
    "baixa_estorno_data": "null",
    "baixa_estorno_observacao": "null",
    "local_pagamento_id": "02",
    "local_pagamento_descricao": "Santander",
    "data_atualizacao": "2001-01-01 00:00:00.000"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "fornecedor_id": {
        "type": "string",
        "description": "ID do fornecedor"
      },
      "fornecedor_tipo": {
        "type": "string",
        "description": "Tipo do fornecedor"
      },
      "titulo_id": {
        "type": "number",
        "description": "ID do título"
      },
      "baixa_id": {
        "type": "string",
        "description": "ID da baixa"
      },
      "baixa_valor": {
        "type": "string",
        "description": "Valor da baixa"
      },
      "baixa_data": {
        "type": "string",
        "description": "Data da baixa"
      },
      "baixa_juros": {
        "type": "string",
        "description": "Juros da baixa"
      },
      "baixa_multa": {
        "type": "string",
        "description": "Multa da baixa"
      },
      "baixa_desconto": {
        "type": "string",
        "description": "Desconto da baixa"
      },
      "baixa_outros_acrescimos": {
        "type": "string",
        "description": "Outros acréscimos da baixa"
      },
      "baixa_observacao": {
        "type": "string",
        "description": "Observação da baixa"
      },
      "baixa_estorno_data": {
        "type": "string",
        "description": "Data de estorno da baixa"
      },
      "baixa_estorno_observacao": {
        "type": "string",
        "description": "Observação do estorno da baixa"
      },
      "local_pagamento_id": {
        "type": "string",
        "description": "ID do local de pagamento"
      },
      "local_pagamento_descricao": {
        "type": "string",
        "description": "Descrição do local de pagamento"
      },
      "data_atualizacao": {
        "type": "string",
        "description": "Data de atualização"
      }
    },
    "required": [
      "fornecedor_id",
      "fornecedor_tipo",
      "titulo_id",
      "baixa_id",
      "baixa_valor",
      "baixa_data",
      "baixa_juros",
      "baixa_multa",
      "baixa_desconto",
      "baixa_outros_acrescimos",
      "local_pagamento_id",
      "local_pagamento_descricao",
      "data_atualizacao"
    ]
  }
}

Listagem de Formas de Pagamento

Listagem de Formas de Pagamento
GET/financeiro/clientes/titulos-pagar-baixa-forma-pagamento{?dataInicial}{?dataFinal}{?pagina}{?quantidade}{?formaPagamento}

Lista as Formas de Pagamento

Example URI

GET https://api.acadweb.com.br/{cliente-sigla}/financeiro/clientes/titulos-pagar-baixa-forma-pagamento?dataInicial=2023-04-19 06:36:00?dataFinal=2023-04-24 06:36:00?pagina=1?quantidade=10?formaPagamento=01
URI Parameters
HideShow
dataInicial
string (optional) Example: 2023-04-19 06:36:00

A data inicial do intervalo de busca baseado na data de atualização de títulos a pagar baixa com forma de pagamento com o formato YYYY-MM-DD HH:mm:ss

dataFinal
string (optional) Example: 2023-04-24 06:36:00

A data final do intervalo de busca baseado na data de atualização de títulos a pagar baixa com forma de pagamento com o formato YYYY-MM-DD HH:mm:ss

pagina
number (optional) Default: 1 Example: 1

A página da paginação das baixas

quantidade
number (optional) Default: 100 Example: 10

A quantidade de itens da página. Se a quantidade de itens for 0 e as datas inicial e final forem iguais, todos os registros desse dia serão retornados.

pagamento
string (optional) Example: 00001

Filtra pelo id da baixa

formaPagamento
string (optional) Example: 01

Filtra pelo id da forma de pagamento

Request  Sucesso
HideShow
Headers
Authorization: Bearer 1|EjhP0T0PdKh07Z5q0AsbhfCChvrZv2jLQtkC2XbV
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "baixa_id": 51099,
    "baixa_classificacao_id": "1",
    "forma_pagamento_valor": "2053.3300",
    "forma_pagamento_autorizacao": "0000",
    "forma_pagamento_nsu": "PE-2023-07-20-10-00-00-123456",
    "forma_pagamento_data_credito": "2001-01-01",
    "forma_pagamento_id": "01",
    "forma_pagamento_descricao": "Dinheiro",
    "data_atualizacao": "2001-01-01 00:00:00.000"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "baixa_id": {
        "type": "number",
        "description": "ID da baixa"
      },
      "baixa_classificacao_id": {
        "type": "string",
        "description": "ID da classificação da baixa"
      },
      "forma_pagamento_valor": {
        "type": "string",
        "description": "Valor da forma de pagamento"
      },
      "forma_pagamento_autorizacao": {
        "type": "string",
        "description": "Número de autorização"
      },
      "forma_pagamento_nsu": {
        "type": "string",
        "description": "Número sequencial único"
      },
      "forma_pagamento_data_credito": {
        "type": "string",
        "description": "Dia que foi efetuado o pagamento"
      },
      "forma_pagamento_id": {
        "type": "string",
        "description": "ID da forma de pagamento"
      },
      "forma_pagamento_descricao": {
        "type": "string",
        "description": "Descrição da forma de pagamento"
      },
      "data_atualizacao": {
        "type": "string",
        "description": "Data de atualização"
      }
    },
    "required": [
      "baixa_id",
      "baixa_classificacao_id",
      "forma_pagamento_valor",
      "forma_pagamento_autorizacao",
      "forma_pagamento_nsu",
      "forma_pagamento_data_credito",
      "forma_pagamento_id",
      "forma_pagamento_descricao",
      "data_atualizacao"
    ]
  }
}

Generated by aglio on 20 Dec 2024