{"openapi":"3.0.1","info":{"title":"Financeiro","description":"\n# Introdução\n\nBem-vindo à documentação da API. Este documento fornece as informações necessárias para que os desenvolvedores utilizem os recursos do **SWA.JACAD**, sejam eles baseados em servidor ou no lado do cliente.\n\nA API Financeiro permite acessar dados e funcionalidades do **SWA.JACAD** usando código em vez da interface do usuário.\n\nPor exemplo, você pode usar a API para:\n- Emitir Boletos.\n\n\n\n### Quadro de Relacionamentos -JACAD\n<iframe style=\"border:none\" width=\"100%\" height=\"450\" src=\"https://whimsical.com/embed/JSZHN7TY25PZogto4GiP1D\"></iframe>\n \n## Segurança\n\nA API REST do JACAD utiliza o protocolo HTTPS para  uma  comunicação  criptografada, além  disso, todas as solicitações  na API são  obrigadas a informar  um  **token de  acesso** (Access Token) para  garantir a .\n\n### Obtendo  uma  Chave  de API\n\nPara  obter  um Token de  Acesso é necessário  se  autenticar  com  uma  **Chave  de API**. Você  pode  obter  sua  Chave  de API no painel  de  administração  da  plataforma SWA.JACAD.\n\nUma  Chave  de API tem o seguinte  formato:\n\n```json\n5837fa342c8a14c50c2d7c9a73369dce\n```\n\nUma  chave  de API deve  ser  definido  na  plataforma SWA.JACAD para  autenticação  na API.\n\nNavegue  até:`Integrações` > `API de  Integrações` > `Tokens de  Acesso` > `Cadastro  de Token de  Acesso`.\n\n1. Clique em  **Inserir**.\n2. Selecione  um  usuário.\n3. Insira a data de  vigência do token ou  marque a flag para  não  validar  datas.\n4. Clique em  salvar  para  gerar  automaticamente  um Token.\n\n**Nota:** É necessário  possuir  privilégios  de  administrador  para  obter  uma  chave  de API.\n\n![SWA.JACAD Desktop](/gerando-token.png \"Gerando Token de  acesso\")\n\n\n### Aviso\n\nTokens de API podem  representar  um  risco  de  segurança  para  sua  organização  se  usados  por  uma  pessoa  não  autorizada. Certifique-se  de  mantê-los  seguros, exclua as chaves  antigas e substitua-as em  seu  sistema  se  suspeitar  de  alguma  violação  de  segurança.\n\n> Você  pode  entrar  em  contato  conosco  para  obter  suporte  adicional.\n\n## Rate Limit\n\nTokens de requisição são uma abordagem eficiente para gerenciar o acesso a recursos, impedindo abusos e assegurando uma distribuição equitativa. No seu sistema, há dois principais filtros de controle de tokens:\n\n### Bloqueio Técnico:\n\n- **Quantidade Inicial:** 10 tokens por IP.\n- **Taxa de Recarga:** 1 token por segundo.\n- **Restrição:** Cada IP pode fazer 10 requisições por segundo. Após atingir esse limite, é necessário aguardar até que novos tokens sejam disponibilizados.\n\n### Filtro de Negócio:\n\n- **Quantidade Inicial:** Definida pelo usuário (por exemplo, 1000 tokens).\n- **Taxa de Recarga:** Recarregado a cada 1 hora.\n- **Restrição Adicional:** Se todos os tokens forem usados antes do período de uma hora, a recarga só ocorre após o término desse período, contado a partir do momento da última recarga. Por exemplo, se 1000 tokens forem usados em 55 minutos, a próxima recarga só ocorrerá 5 minutos após a última recarga.\n\nEste sistema oferece um equilíbrio entre acesso rápido (Bloqueio Técnico) e controle de uso a longo prazo (Filtro de Negócio), garantindo uma distribuição justa e evitando abusos.\n\n\n### Configuração do Controle de Requisições:\n\nNavegue  até:`Preferências` > `Segurança` > `Políticas de Segurança`.\n\nEm nossa plataforma, oferecemos total controle sobre como gerenciar suas requisições. Aqui está um guia simples para configurar o Filtro de Negócio:\n\n#### 1. Habilitar Controle de Requisições:\n\n- Para começar, marque a caixa de seleção \"Habilitar Controle de Requisições\". Isso permite que você personalize a quantidade máxima de requisições.\n\n- [ ] Habilitar Controle de Requisições\n\n#### 2. Definir Quantidade Máxima (Padrão: 1000 por Hora):\n- Abaixo da opção habilitar, você encontrará um campo para inserir a quantidade desejada de tokens. O valor padrão é 1000 por hora.\n\nAo marcar a opção e inserir sua preferência, você tem o poder de moldar como deseja que o Filtro de Negócio funcione para você.\n\nLembre-se: Se não desejar modificar, a configuração padrão de 1000 por hora permanecerá em vigor.\n\n![SWA.JACAD Desktop](/configurando-token.png \"Configurando entrada maxima de tokens\")\n\n\n## Jacad API Rest\n\nA API utiliza  os  princípios  das APIs REST, permitindo  que  os  desenvolvedores  realizem  consultas  na  plataforma SWA.JACAD utilizando o protocolo HTTP.\n\nUse uma  solicitação  **GET**  para  recuperar  informações, um  **POST**  para  criar  ou  atualizar e um  **DELETE**  para remover uma  informação.\n\n### Bearer Token (JWT)\n\nTodas as solicitações  de API requerem  um token de autorização para  validar a autenticidade e indicar  ao  sistema  quais  módulos, operações e recursos o usuário  pode  acessar. \n\nO Token JWT deve ser informado no cabeçalho (header) da solicitação como no formato abaixo:\n\n```json\nAuthorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\n```\n\n**Nota:** O token JWT é obtido  após  realizar a autenticação  na API.\n\n\n\n\n### Respostas  de  Erros\n\nA API usa  códigos  de status HTTP padrão  para  indicar o sucesso  ou a falha  como  acontece  com  qualquer  resposta  de API, seu  cliente  deve  estar  preparado  para  lidar  com  erros  de  resposta. Normalmente, o corpo  da  resposta  será JSON no seguinte  formato:\n\n```json\n{\n\t\"timestamp\": \"2023-09-19T16:23:53-0300\",\n\t\"message\": \"Failed to convert property 'anoConsolidacao'\",\n\t\"details\": \"/api/v4/resource\",\n\t\"errorCode\": {\n\t\t\"code\": \"VFLD01\",\n\t\t\"desc\": \"Valor informado  inválido\"\n\t},\n\t\"validationErrors\": [\n\t\t{\n\t\t\t\"field\": \"anoConsolidacao\",\n\t\t\t\"rejectedValue\": \"2022-ASDF\",\n\t\t\t\"message\": \"Failed to convert property 'anoConsolidacao'\"\n\t\t}\n\t]\n}\n\n```\n\n### Código  de Status\n\n| CÓDIGO | DESCRIÇÃO | NOTA |\n| ------ | ------ | ------ |\n| 200 | OK | A requisição  foi  bem  sucedida. |\n| 201 | Created | Os  dados  foram  gravados  com  sucesso no sistema |\n| 400 | Bad Request | A solicitação  não  pôde  ser  compreendida  pelo  servidor. Os  parâmetros  recebidos  podem  não  ser  válidos |\n| 401 | Unauthorized | As credenciais  fornecidas, se  houver, não  são  suficientes  para  acessar o recurso |\n| 403 | Forbidden | As credenciais  fornecidas  não  possui  permissão  para  acessar o recurso. |\n| 404 | Not Found | A informação  requerida  não  foi  encontrada |\n| 422 | Unprocessable Entity | Não  foi  possível  processar a informação  devido a restrições  de  uso. |\n| 500 | Server Error | Erro  inesperado, ocorreu  algum  erro  interno no servidor |\n| 429 | Too Many Requests | Limite de requisições |","termsOfService":"https://www.swa.com.br/termo-de-uso/","contact":{"name":"Suporte","url":"https://ajuda.jacad.com.br","email":"suporte@swa.com.br"},"version":"v3.1.60.213"},"servers":[{"url":"https://fce-developer.jacad.com.br","description":"Generated server url"}],"security":[{"Access Token":[]}],"tags":[{"name":"Autenticação"}],"paths":{"/api/v2/financeiro/planos-de-contas/{idPlanoConta}":{"put":{"tags":["Plano de Contas V2"],"summary":"Edição de plano de contas","operationId":"update","parameters":[{"name":"idPlanoConta","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanoContaDtoReq"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanoContaDtoRes"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.139+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.139+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.139+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.139+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.139+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v2/financeiro/centros-de-custos/{idCentroCusto}":{"put":{"tags":["Centros de Custos V2"],"summary":"Edição de centro de custos","operationId":"update_1","parameters":[{"name":"idCentroCusto","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CentroCustoDtoReq"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CentroCustoDtoRes"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.145+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.145+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.145+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.145+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.145+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/planos-de-contas/{idPlanoConta}":{"put":{"tags":["Plano de Contas"],"summary":"Edição de plano de contas","operationId":"update_2","parameters":[{"name":"idPlanoConta","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanoContaDtoReq"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanoContaDtoRes"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.151+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.151+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.151+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.151+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.151+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/centros-de-custos/{idCentroCusto}":{"put":{"tags":["Centros de Custos"],"summary":"Edição de centro de custos","operationId":"update_3","parameters":[{"name":"idCentroCusto","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CentroCustoDtoReq"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CentroCustoDtoRes"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.154+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.154+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.154+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.154+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.154+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v2/financeiro/planos-de-contas":{"get":{"tags":["Plano de Contas V2"],"summary":"Consulta de Planos de Contas","description":"Retorna todos os planos de contas ativos da instituição","operationId":"list","parameters":[{"name":"search","in":"query","description":"Like sobre o campo 'código e descrição'","required":false,"schema":{"type":"string"}},{"name":"idPlanoConta","in":"query","description":"ID do plano de contas","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"operacao","in":"query","description":"Operação","required":false,"schema":{"type":"string","enum":["SOMA","SUBTRAI"]},"example":"SOMA"},{"name":"tipoConta","in":"query","description":"Tipo da conta (ANALITICA = A OU SINTETICA = S)","required":false,"schema":{"type":"string","enum":["A","S"]},"example":"A"},{"name":"natureza","in":"query","description":"Natureza Plano Conta","required":false,"schema":{"type":"string","enum":["ATIVO","PASSIVO","PATRIMONIO","RECEITA","DESPESA"]},"example":"ATIVO"},{"name":"status","in":"query","description":"Status","required":false,"schema":{"type":"string"},"example":"ATIVO,INATIVO"},{"name":"dataAlteracaoInicio","in":"query","description":"Data alteração início","required":false,"schema":{"type":"string","format":"date-time"},"example":"2024-01-30"},{"name":"horaAlteracaoInicio","in":"query","description":"Hora alteração início (Requer a Data alteração início)","required":false,"schema":{"type":"string","format":"date-time"},"example":"00:00:00"},{"name":"dataAlteracaoFim","in":"query","description":"Data alteração fim","required":false,"schema":{"type":"string","format":"date-time"},"example":"2024-01-30"},{"name":"horaAlteracaoFim","in":"query","description":"Hora alteração fim (Requer a Data alteração fim)","required":false,"schema":{"type":"string","format":"date-time"},"example":"23:59:59"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 5000)","required":true,"schema":{"maximum":5000,"type":"integer","format":"int32"},"example":5000},{"name":"idCursor","in":"query","description":"Código primário da consulta, começa com 0, utilizado para páginação","required":false,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationPlanoContaDtoResPageCursor"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.296+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.296+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.296+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.296+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.296+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}},"post":{"tags":["Plano de Contas V2"],"summary":"Cadastro de plano de contas","operationId":"create","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanoContaDtoReq"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanoContaDtoRes"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.159+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.159+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.159+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.159+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.159+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v2/financeiro/centros-de-custos":{"get":{"tags":["Centros de Custos V2"],"summary":"Consulta de Centros de Custos","description":"Retorna todos os centros de custos da instituição","operationId":"list_6","parameters":[{"name":"idCentroCusto","in":"query","description":"ID do centro de custos","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"tipo","in":"query","description":"Tipo ","required":false,"schema":{"type":"string","enum":["S","A"]},"example":"A"},{"name":"search","in":"query","description":"Realiza busca por: Nome do Centro de Custo","required":false,"schema":{"type":"string"},"example":"Foo Bar"},{"name":"status","in":"query","description":"Status","required":false,"schema":{"type":"string"},"example":"ATIVO,INATIVO"},{"name":"dataAlteracaoInicio","in":"query","description":"Data alteração início","required":false,"schema":{"type":"string","format":"date-time"},"example":"2024-01-30"},{"name":"horaAlteracaoInicio","in":"query","description":"Hora alteração início (Requer a Data alteração início)","required":false,"schema":{"type":"string","format":"date-time"},"example":"00:00:00"},{"name":"dataAlteracaoFim","in":"query","description":"Data alteração fim","required":false,"schema":{"type":"string","format":"date-time"},"example":"2024-01-30"},{"name":"horaAlteracaoFim","in":"query","description":"Hora alteração fim (Requer a Data alteração fim)","required":false,"schema":{"type":"string","format":"date-time"},"example":"23:59:59"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 5000)","required":true,"schema":{"maximum":5000,"type":"integer","format":"int32"},"example":5000},{"name":"idCursor","in":"query","description":"Código primário da consulta, começa com 0, utilizado para páginação","required":false,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationCentroCustoDtoResPageCursor"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.387+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.387+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.387+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.387+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.387+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}},"post":{"tags":["Centros de Custos V2"],"summary":"Cadastro de centro de custos","operationId":"create_1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CentroCustoDtoReq"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CentroCustoDtoRes"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.161+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.161+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.161+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.161+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.161+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/transacoes/recebimentos/salvar":{"post":{"tags":["Transações Recebimentos"],"summary":"Cadastrar transação recebimento","description":"Efetua o cadastro de uma transação recebimento","operationId":"cadastrarRecebimento","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransacaoRecebimentoDtoReq"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransacaoRecebimentoDtoRes"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.178+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.178+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.178+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.178+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.178+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/transacoes/recebimentos/baixas/diversa":{"post":{"tags":["Transações Recebimentos"],"summary":"Cadastrar baixa diversa em transação","operationId":"cadastrarBaixaDiversa","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransacaoBaixaDtoReq"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TransacaoBaixaDtoRes"}}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.182+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.182+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.182+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.182+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.182+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/transacoes/recebimentos/baixas/cancelar":{"post":{"tags":["Transações Recebimentos"],"summary":"Cancelar baixa","operationId":"cancelarBaixa","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelarTransacaoBaixaDtoReq"}}},"required":true},"responses":{"200":{"description":"OK"},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.183+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.183+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.183+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.183+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.183+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/transacoes/recebimentos/baixas/cancelamento":{"post":{"tags":["Transações Recebimentos"],"summary":"Cadastrar baixa por cancelamento em transação","operationId":"cadastrarBaixaCancelamento","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransacaoBaixaDtoReq"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TransacaoBaixaDtoRes"}}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.186+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.186+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.186+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.186+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.186+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/transacoes/contas-receber":{"post":{"tags":["Transações"],"summary":"Contas a Receber","description":"Permite o cadastro de contas a receber.","operationId":"criarContaReceber","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransacaoAcademicoContaReceberDtoReq"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransacaoAcademicoRest"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.205+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.205+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.205+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.205+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.205+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/transacoes/contas-pagar":{"post":{"tags":["Transações"],"summary":"Contas a Pagar","description":"Permite o cadastro de contas a pagar.","operationId":"criarContaPagar","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransacaoContaAPagarDtoReq"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransacaoAcademicoRest"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.221+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.221+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.221+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.221+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.221+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/swa-pay/pix":{"get":{"tags":["Pix Gateway"],"summary":"Consulta de Pix Gateway","description":"Retorna todos os gateways de pix ativos","operationId":"list_8","parameters":[{"name":"idPixGateway","in":"query","description":"ID do gateway de pix","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"gateway","in":"query","description":"Gateways","required":false,"schema":{"type":"string","enum":["SHIPAY","BANCO_BRASIL","ASAAS","BOLETO_ITAU"]},"example":"SHIPAY"},{"name":"search","in":"query","description":"Realiza busca por: Descrição","required":false,"schema":{"type":"string"},"example":"Foo Bar"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationPixGatewayDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.423+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.423+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.423+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.423+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.423+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}},"post":{"tags":["Pix Gateway"],"summary":"Gerar PIX","description":"Gera um registro de PIX para uma transação informada","operationId":"gerarPix","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GerarPixDtoReq"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagamentoPixTransacaoDtoRes"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.226+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.226+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.226+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.226+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.226+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/retencoes":{"get":{"tags":["Retenções Financeiras"],"summary":"Consulta de retenções financeiras","operationId":"list_9","parameters":[{"name":"search","in":"query","description":"Like sobre o campo 'nome pagador e mensagem'","required":false,"schema":{"type":"string"}},{"name":"idPagador","in":"query","description":"Código do pagador (perfil)","required":false,"schema":{"type":"integer","format":"int32"},"example":12345},{"name":"idRetencao","in":"query","description":"Código da retenção","required":false,"schema":{"type":"integer","format":"int32"},"example":678},{"name":"status","in":"query","description":"Status da retenção (ATIVO ou LIBERADO)","required":false,"schema":{"type":"string"},"example":"ATIVO"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationRetencaoFinanceiraDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.428+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.428+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.428+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.428+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.428+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}},"post":{"tags":["Retenções Financeiras"],"summary":"Cadastro de retenção financeira","operationId":"create_2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetencaoFinanceiraDtoReq"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetencaoFinanceiraDtoRes"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.228+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.228+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.228+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.228+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.228+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/planos-de-contas":{"get":{"tags":["Plano de Contas"],"summary":"Consulta de Planos de Contas","description":"Retorna todos os planos de contas ativos da instituição","operationId":"list_11","parameters":[{"name":"search","in":"query","description":"Like sobre o campo 'código e descrição'","required":false,"schema":{"type":"string"}},{"name":"idPlanoConta","in":"query","description":"ID do plano de contas","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"operacao","in":"query","description":"Operação","required":false,"schema":{"type":"string","enum":["SOMA","SUBTRAI"]},"example":"SOMA"},{"name":"tipoConta","in":"query","description":"Tipo da conta (ANALITICA = A OU SINTETICA = S)","required":false,"schema":{"type":"string","enum":["A","S"]},"example":"A"},{"name":"natureza","in":"query","description":"Natureza Plano Conta","required":false,"schema":{"type":"string","enum":["ATIVO","PASSIVO","PATRIMONIO","RECEITA","DESPESA"]},"example":"ATIVO"},{"name":"status","in":"query","description":"Status","required":false,"schema":{"type":"string"},"example":"ATIVO,INATIVO"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationPlanoContaDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.495+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.495+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.495+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.495+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.495+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}},"post":{"tags":["Plano de Contas"],"summary":"Cadastro de plano de contas","operationId":"create_3","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanoContaDtoReq"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanoContaDtoRes"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.233+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.233+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.233+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.233+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.233+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/centros-de-custos":{"get":{"tags":["Centros de Custos"],"summary":"Consulta de Centros de Custos","description":"Retorna todos os centros de custos da instituição","operationId":"list_22","parameters":[{"name":"idCentroCusto","in":"query","description":"ID do centro de custos","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"tipo","in":"query","description":"Tipo ","required":false,"schema":{"type":"string","enum":["S","A"]},"example":"A"},{"name":"search","in":"query","description":"Realiza busca por: Nome do Centro de Custo","required":false,"schema":{"type":"string"},"example":"Foo Bar"},{"name":"status","in":"query","description":"Status","required":false,"schema":{"type":"string"},"example":"ATIVO,INATIVO"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationCentroCustoDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.651+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.651+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.651+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.651+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.651+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}},"post":{"tags":["Centros de Custos"],"summary":"Cadastro de centro de custos","operationId":"create_4","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CentroCustoDtoReq"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CentroCustoDtoRes"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.235+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.235+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.235+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.235+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.235+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/cartao-credito-gateways/pagar":{"post":{"tags":["Financeiro - Cartão de Crédito"],"summary":"Realiza um pagamento por cartão de crédito","description":"Processa o pagamento de uma ou mais transações financeiras utilizando um cartão de crédito.","operationId":"pagarComCartao","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagamentoCartaoDtoReq"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PagamentoCartaoDtoRes"}}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.241+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.241+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.241+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.241+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.241+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/auth/token":{"post":{"tags":["Autenticação"],"summary":"Realiza a autenticação via token","description":"Autentica o usuário a partir de um token de acesso a API cadastrado através do sistema acadêmico (desktop)","operationId":"token","parameters":[{"name":"token","in":"header","required":true,"schema":{"maximum":40,"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserInfo"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.275+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.275+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.275+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.275+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.275+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}},"security":[]}},"/api/v1/financeiro/retencoes/{idRetencao}":{"patch":{"tags":["Retenções Financeiras"],"summary":"Inativação da retenção financeira","operationId":"inativar","parameters":[{"name":"idRetencao","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetencaoFinanceiraDtoRes"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.277+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.277+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.277+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.277+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.277+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/boletos/{idBoleto}/renovar":{"patch":{"tags":["Boletos"],"summary":"Renovar vencimento","description":"Renova  os dados atualizados de um boleto bancário informado","operationId":"renovarBoleto","parameters":[{"name":"idBoleto","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenovarBoletoDtoReq"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BoletoRest"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.286+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.286+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.286+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.286+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.286+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v2/financeiro/consolidacao/receitas":{"get":{"tags":["Consolidação Financeira V2"],"summary":"Consulta de transações de receita consolidadas","description":"Retornar todas as transações de receita associadas aos filtros informados.<br/>Para a consulta funcionar é preciso adicionar a data início e término do vencimento, da competência ou da alteração, ou o mês e ano da consolidação.","operationId":"list_1","parameters":[{"name":"idContrato","in":"query","description":"ID do Contrato","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"dataCompetenciaInicio","in":"query","description":"Data Início da Competência","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-01"},{"name":"dataCompetenciaTermino","in":"query","description":"Data Término da Competência","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-30"},{"name":"dataVencimentoInicio","in":"query","description":"Data Início do Vencimento","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-01"},{"name":"dataVencimentoTermino","in":"query","description":"Data Término do Vencimento","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-30"},{"name":"mesConsolidacao","in":"query","description":"Mês do período consolidado","required":false,"schema":{"type":"integer","format":"int32"},"example":6},{"name":"anoConsolidacao","in":"query","description":"Ano do período consolidado","required":false,"schema":{"type":"integer","format":"int32"},"example":2022},{"name":"idOrg","in":"query","description":"ID da Organização","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"situacao","in":"query","description":"Situação da transação","required":false,"schema":{"type":"string","enum":["ABERTO","RECEBIDO","CANCELADO","NAO_ENCONTRADO"]},"example":"ABERTA"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 5000)","required":true,"schema":{"maximum":5000,"type":"integer","format":"int32"},"example":5000},{"name":"idCursor","in":"query","description":"Código primário da consulta, começa com 0, utilizado para páginação","required":false,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationTransacaoAcademicoDtoResPageCursor"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.328+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.328+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.328+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.328+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.328+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v2/financeiro/consolidacao/recebimentos":{"get":{"tags":["Consolidação Financeira V2"],"summary":"Consulta de recebimentos consolidados","description":"Retorna todos os recebimentos associados à um período de consolidação fechado (consolidado).<br>Para a consulta funcionar é preciso adicionar a data início e término da liquidação, ou o mês e ano da consolidação.","operationId":"list_2","parameters":[{"name":"dataLiquidacaoInicio","in":"query","description":"Data Início da Liquidação","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-01"},{"name":"dataLiquidacaoTermino","in":"query","description":"Data Término da Liquidação","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-30"},{"name":"mesConsolidacao","in":"query","description":"Mês do período consolidado","required":false,"schema":{"type":"integer","format":"int32"},"example":6},{"name":"anoConsolidacao","in":"query","description":"Ano do período consolidado","required":false,"schema":{"type":"integer","format":"int32"},"example":2022},{"name":"idOrg","in":"query","description":"ID da Organização","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idTransacao","in":"query","description":"ID da transação","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idPagador","in":"query","description":"ID do pagador","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 5000)","required":true,"schema":{"maximum":5000,"type":"integer","format":"int32"},"example":5000},{"name":"idCursor","in":"query","description":"Código primário da consulta, começa com 0, utilizado para páginação","required":false,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationTransacaoRecebimentoDtoResPageCursor"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.338+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.338+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.338+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.338+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.338+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v2/financeiro/consolidacao/nfse":{"get":{"tags":["Consolidação Financeira V2"],"summary":"Consulta de NFS-e autorizadas","description":"Retorna todas as NFS-e associadas as transações com base nos filtros informados.<br>Para a consulta funcionar é preciso adicionar a data início e término da emissão ou da competência.","operationId":"list_3","parameters":[{"name":"dataEmissaoInicio","in":"query","description":"Data Início da Emissão","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-01"},{"name":"dataEmissaoTermino","in":"query","description":"Data Término da Emissão","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-30"},{"name":"dataCompetenciaInicio","in":"query","description":"Data Início da Competência","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-01"},{"name":"dataCompetenciaTermino","in":"query","description":"Data Término da Competência","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-30"},{"name":"idOrg","in":"query","description":"ID da Organização","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"somenteTransacoesConsolidadas","in":"query","description":"Trazer apenas NFS-e que estiverem consolidadas","required":false,"schema":{"type":"boolean"},"example":true},{"name":"nfseStatus","in":"query","description":"Status da NFS-e","required":false,"schema":{"type":"string"},"example":"AUTORIZADA"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 5000)","required":true,"schema":{"maximum":5000,"type":"integer","format":"int32"},"example":5000},{"name":"idCursor","in":"query","description":"Código primário da consulta, começa com 0, utilizado para páginação","required":false,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationTransacaoNfseDtoResPageCursor"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.348+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.348+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.348+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.348+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.348+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v2/financeiro/consolidacao/despesas":{"get":{"tags":["Consolidação Financeira V2"],"summary":"Consulta de transações de despesas consolidadas","description":"Retornar todas as transações de despesas associadas aos filtros informados.<br/>Para a consulta funcionar é preciso adicionar a data início e término do vencimento, da competência ou da alteração, ou o mês e ano da consolidação.","operationId":"list_4","parameters":[{"name":"dataCompetenciaInicio","in":"query","description":"Data Início da Competência","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-01"},{"name":"dataCompetenciaTermino","in":"query","description":"Data Término da Competência","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-30"},{"name":"dataVencimentoInicio","in":"query","description":"Data Início do Vencimento","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-01"},{"name":"dataVencimentoTermino","in":"query","description":"Data Término do Vencimento","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-30"},{"name":"mesConsolidacao","in":"query","description":"Mês do período consolidado","required":false,"schema":{"type":"integer","format":"int32"},"example":6},{"name":"anoConsolidacao","in":"query","description":"Ano do período consolidado","required":false,"schema":{"type":"integer","format":"int32"},"example":2022},{"name":"idOrg","in":"query","description":"ID da Organização","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"situacao","in":"query","description":"Situação da transação","required":false,"schema":{"type":"string","enum":["ABERTO","RECEBIDO","CANCELADO","NAO_ENCONTRADO"]},"example":"ABERTA"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 5000)","required":true,"schema":{"maximum":5000,"type":"integer","format":"int32"},"example":5000},{"name":"idCursor","in":"query","description":"Código primário da consulta, começa com 0, utilizado para páginação","required":false,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationTransacaoAcademicoDtoResPageCursor"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.372+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.372+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.372+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.372+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.372+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v2/financeiro/consolidacao/baixas":{"get":{"tags":["Consolidação Financeira V2"],"summary":"Consulta de baixas consolidadas","description":"Retorna todas as baixas associadas aos filtros informados.<br>Para a consulta funcionar é preciso adicionar a data início e término da baixa, ou o mês e ano da consolidação.","operationId":"list_5","parameters":[{"name":"dataBaixaInicio","in":"query","description":"Data Início da Baixa","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-01"},{"name":"dataBaixaTermino","in":"query","description":"Data Término da Baixa","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-30"},{"name":"mesConsolidacao","in":"query","description":"Mês do período consolidado","required":false,"schema":{"type":"integer","format":"int32"},"example":6},{"name":"anoConsolidacao","in":"query","description":"Ano do período consolidado","required":false,"schema":{"type":"integer","format":"int32"},"example":2022},{"name":"idOrg","in":"query","description":"ID da Organização","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"tipoBaixa","in":"query","description":"Tipo da Baixa","required":false,"schema":{"type":"string","enum":["CANCELAMENTO","ACORDO","BXD"]},"example":"ACORDO"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 5000)","required":true,"schema":{"maximum":5000,"type":"integer","format":"int32"},"example":5000},{"name":"idCursor","in":"query","description":"Código primário da consulta, começa com 0, utilizado para páginação","required":false,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationTransacaoBaixaDtoResPageCursor"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.381+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.381+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.381+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.381+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.381+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/vendedores":{"get":{"tags":["Vendedores"],"summary":"Consulta de vendedores","description":"Retorna todos os vendedores da instituição","operationId":"list_7","parameters":[{"name":"search","in":"query","description":"Like a ser aplicado nos campos (Nome, CPF e função)","required":false,"schema":{"type":"string"}},{"name":"idFuncao","in":"query","description":"ID da função","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"cpf","in":"query","description":"CPF do Vendedor","required":false,"schema":{"type":"string"},"example":99999999999},{"name":"status","in":"query","description":"Status do Vendedor","required":false,"schema":{"type":"string","enum":["ATIVO","INATIVO"]},"example":"ATIVO"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationVendedorDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.395+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.395+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.395+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.395+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.395+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/transacoes/{idTransacao}":{"get":{"tags":["Transações"],"summary":"Consulta de transação pelo código da transação","description":"Retorna a transação que está associada ao código informado.","operationId":"findById","parameters":[{"name":"idTransacao","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransacaoAcademicoDtoRes"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.416+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.416+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.416+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.416+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.416+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/recebimentos/tipo":{"get":{"tags":["Tipos de Recebimento"],"summary":"Consulta de Tipos de Recebimento","description":"Retorna todos os tipos de recebimento da instituição.","operationId":"list_10","parameters":[{"name":"idTipoRecebimento","in":"query","description":"Código do tipo de recebimento","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"tipoRecebimento","in":"query","description":"Tipo de recebimento","required":false,"schema":{"type":"string","enum":["DINHEIRO","CHEQUE","CARTAO"]},"example":"DINHEIRO"},{"name":"status","in":"query","description":"Status do tipo de recebimento","required":false,"schema":{"type":"string","enum":["ATIVO","INATIVO"]},"example":"ATIVO"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationTipoRecebimentoDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.435+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.435+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.435+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.435+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.435+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/planos-pagamento":{"get":{"tags":["Planos de Pagamentos"],"summary":"Consulta planos de pagamentos","description":"Retorna todos os planos de pagamento ATIVOS cadastrados numa organização","operationId":"consultaPlanoPagamento","parameters":[{"name":"idOrg","in":"query","description":"ID da Organização","required":true,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"idCurso","in":"query","description":"ID da Matriz","required":false,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"idUnidadeFisica","in":"query","description":"ID do Câmpus/Polo","required":false,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"idTurma","in":"query","description":"ID da Turma","required":false,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"idPlanoPagamento","in":"query","description":"ID do Plano de Pagamento","required":false,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"isApenasAssociadoTurma","in":"query","description":"Com turmas associadas","required":false,"schema":{"type":"boolean"},"example":0},{"name":"isApenasAssociadoCurso","in":"query","description":"Com matrizes associadas","required":false,"schema":{"type":"boolean"},"example":0}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PlanoPagamentoRest"}}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.453+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.453+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.453+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.453+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.453+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/planos-pagamento/{idPlanoPagamento}/unidades-fisicas":{"get":{"tags":["Planos de Pagamentos"],"summary":"Câmpus/Polo","description":"Retorna todos os Câmpus/Polo atendidos por um plano de pagamento informado.","operationId":"planoPagamentoUnidadesFisicasConsulta","parameters":[{"name":"idPlanoPagamento","in":"path","description":"ID do Plano de Pagamento","required":true,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationUnidadeFisicaPlanoPagamentoRestPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.462+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.462+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.462+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.462+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.462+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/planos-pagamento/{idPlanoPagamento}/turmas":{"get":{"tags":["Planos de Pagamentos"],"summary":"Turmas","description":"Retorna todas as turmas atendidas por um plano de pagamento informado.","operationId":"planoPagamentoTurmasConsulta","parameters":[{"name":"idPlanoPagamento","in":"path","description":"ID do Plano de Pagamento","required":true,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationTurmaRestPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.470+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.470+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.470+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.470+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.470+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/planos-pagamento/{idPlanoPagamento}/matrizes":{"get":{"tags":["Planos de Pagamentos"],"summary":"Matrizes","description":"Retorna todas as matrizes atendidas por um plano de pagamento informado.","operationId":"planoPagamentoMatrizesConsulta","parameters":[{"name":"idPlanoPagamento","in":"path","description":"ID do Plano de Pagamento","required":true,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationCursoRestPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.476+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.476+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.476+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.476+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.476+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/planos-pagamento/{idCursoBase}/tabela-precos":{"get":{"tags":["Tabela de Preço"],"summary":"Tabela de Preço - Valor do Curso","description":"Retorna os valores de um curso base informado na tabela de preços vigente, ou mais recente caso informado as datas de início e término.","operationId":"consultaTabela","parameters":[{"name":"idUnidadeFisica","in":"query","description":"ID do Câmpus/Polo","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"dataVigenciaInicio","in":"query","description":"Data de vigência inicial","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-01"},{"name":"dataVigenciaTermino","in":"query","description":"Data de vigência término","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-07-01"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idCursoBase","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TabelaPrecoCursoWrapper"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.483+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.483+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.483+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.483+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.483+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/planos-pagamento/{idCursoBase}/tabela-precos-completa":{"get":{"tags":["Tabela de Preço"],"summary":"Tabela de Preço - Tabela Completa","description":"Retorna os cursos e os seus respectivos valores e descontos máximos por unidades físicas (polos).","operationId":"consultaPrecoTabelaCompleta","parameters":[{"name":"idUnidadeFisica","in":"query","description":"ID do Câmpus/Polo","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"dataVigenciaInicio","in":"query","description":"Data de vigência inicial","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-01"},{"name":"dataVigenciaTermino","in":"query","description":"Data de vigência término","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-07-01"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idCursoBase","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationTabelaPrecoDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.488+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.488+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.488+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.488+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.488+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/cupons-de-desconto":{"get":{"tags":["Cupons de Desconto"],"summary":"Consulta de cupons de desconto","description":"Lista todos os cupons de desconto ativos da instituição","operationId":"list_12","parameters":[{"name":"search","in":"query","description":"Like a ser aplicado no campo 'código do cupom'","required":false,"schema":{"type":"string"}},{"name":"idCupomDesconto","in":"query","description":"ID do cupom de desconto","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idConvenio","in":"query","description":"ID do convênio","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idPeriodoLetivo","in":"query","description":"ID do período letivo","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"tipo","in":"query","description":"Tipo do Cupom de Desconto","required":false,"schema":{"type":"string","enum":["PERCENTUAL","VALOR"]},"example":"PERCENTUAL"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationCupomDescontoDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.501+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.501+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.501+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.501+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.501+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/convenios":{"get":{"tags":["Convênios"],"summary":"Consulta dos convênios","description":"Lista todos os convênios da instituição","operationId":"list_13","parameters":[{"name":"search","in":"query","description":"Like a ser aplicado nos campos 'nome convênio e empresa'","required":false,"schema":{"type":"string"}},{"name":"idConvenio","in":"query","description":"ID do  convênio","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idEmpresa","in":"query","description":"ID da empresa do convênio","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"status","in":"query","description":"Status Convênio","required":false,"schema":{"type":"string","enum":["ATIVO","INATIVO"]},"example":"ATIVO"},{"name":"dataVigenciaInicio","in":"query","description":"Data de vigência inicial","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-01"},{"name":"dataVigenciaTermino","in":"query","description":"Data de vigência final","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-07-01"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationConvenioDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.509+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.509+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.509+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.509+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.509+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/convenios/alunos":{"get":{"tags":["Convênios"],"summary":"Consulta dos convênios dos alunos","description":"Lista todos os convênios dos alunos para cada organização","operationId":"list_14","parameters":[{"name":"search","in":"query","description":"Like a ser aplicado nos campos 'nome convênio, nome aluno, empresa'","required":false,"schema":{"type":"string"}},{"name":"idConvenio","in":"query","description":"ID do convênio","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idEmpresa","in":"query","description":"ID da empresa do convênio","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"status","in":"query","description":"Status Convênio Pagador","required":false,"schema":{"type":"string","enum":["ATIVO","INATIVO"]},"example":"ATIVO"},{"name":"dataVigenciaInicio","in":"query","description":"Data de vigência inicial","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-01"},{"name":"dataVigenciaTermino","in":"query","description":"Data de vigência final","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-07-01"},{"name":"idOrg","in":"query","description":"ID da organização","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idAluno","in":"query","description":"ID do aluno","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idPeriodoLetivo","in":"query","description":"ID do período letivo (de aplicação)","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idCursoBase","in":"query","description":"ID do curso base (de aplicação)","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idMatriz","in":"query","description":"ID da matriz (de aplicação)","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"dataContratacaoInicio","in":"query","description":"Data de contratação inicial","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-05-01"},{"name":"dataContratacaoFim","in":"query","description":"Data de contratação final","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-07-01"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationConvenioPagadorDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.519+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.519+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.519+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.519+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.519+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/contratos-matricula":{"get":{"tags":["Contratos de Matrículas"],"summary":"Consulta de Contratos de matrículas","description":"Retorna os contratos de matrícula para os filtros informados.","operationId":"list_15","parameters":[{"name":"idOrg","in":"query","description":"ID da Organização","required":true,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"idPeriodoLetivo","in":"query","description":"ID do período letivo","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idTurma","in":"query","description":"ID da turma","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idMatriz","in":"query","description":"ID da matriz","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idCursoBase","in":"query","description":"ID do curso base","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idAluno","in":"query","description":"ID do aluno","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idPerfil","in":"query","description":"ID do perfil","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idPlanoPagamento","in":"query","description":"ID do plano de pagamento","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idUnidadeFisica","in":"query","description":"ID do Câmpus/Polo","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idContrato","in":"query","description":"ID do contrato","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"status","in":"query","description":"Status do contrato","required":false,"schema":{"type":"string","enum":["PENDENTE","ENTREGUE","CANCELADO"]},"example":"PENDENTE"},{"name":"statusMatricula","in":"query","description":"Status da matrícula","required":false,"schema":{"type":"string","enum":["ATIVA","AGUARDANDO","APROVADO","APROVADO_PARCIALMENTE","CANCELADA","DESISTENTE","INFREQUENTE","REENQUADRADA","REMANEJADA","REPROVADO","TRANCADA","TRANSFERIDA"]},"example":"ATIVA"},{"name":"dataVigenciaInicio","in":"query","description":"Data vigência início(YYYY-MM-DD)","required":false,"schema":{"type":"string","format":"date-time"},"example":"2023-09-26"},{"name":"dataVigenciaTermino","in":"query","description":"Data vigência termino(YYYY-MM-DD)","required":false,"schema":{"type":"string","format":"date-time"},"example":"2023-09-26"},{"name":"vinculoContrato","in":"query","description":"Vínculo com contrato","required":false,"schema":{"type":"string","enum":["COM_MATRICULA","SEM_MATRICULA"]},"example":"COM_MATRICULA"},{"name":"search","in":"query","description":"Realiza busca por: Nome do Aluno","required":false,"schema":{"type":"string"},"example":"Foo Bar"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationContratoMatriculaDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.532+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.532+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.532+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.532+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.532+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/contratos-matricula/{idContrato}/registra-aceite":{"get":{"tags":["Contratos de Matrículas"],"summary":"Contrato de Matrícula - Aceite de contrato","description":"Retorna o contrato registrado do aluno.","operationId":"registrarAceite","parameters":[{"name":"idContrato","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"ipAceite","in":"query","required":false,"schema":{"type":"string"}},{"name":"nomeNavegador","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.533+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.533+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.533+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.533+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.533+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/contratos-matricula/{idContrato}/parcelas":{"get":{"tags":["Contratos de Matrículas"],"summary":"Consulta as parcelas de um contrato","description":"Retorna uma lista de todas as parcelas definidas para um contrato.","operationId":"consultarParcelas","parameters":[{"name":"idContrato","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TransacaoDtoRes"}}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.535+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.535+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.535+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.535+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.535+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/contratos-matricula/{idContrato}/download":{"get":{"tags":["Contratos de Matrículas"],"summary":"Contrato de Matrícula - Download do Contrato","description":"Retorna o PDF do contrato de matrícula do aluno.","operationId":"downloadContrato","parameters":[{"name":"idContrato","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.536+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.536+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.536+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.536+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.536+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/contratos-matricula/renderizar":{"get":{"tags":["Contratos de Matrículas"],"summary":"Renderiza um contrato em PDF e Imagens","description":"Busca um contrato de matrícula e retorna um objeto complexo contendo os bytes do arquivo PDF e uma lista de todas as páginas do contrato, cada uma convertida para uma imagem em formato Base64.","operationId":"renderizarContrato","parameters":[{"name":"dtoReq","in":"query","required":true,"schema":{"$ref":"#/components/schemas/RenderContratoDtoReq"}}],"responses":{"200":{"description":"Operação bem-sucedida","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportObjectWrapper"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.541+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.541+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.541+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.541+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.541+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/contratos-matricula/demonstrativo-contrato":{"get":{"tags":["Contratos de Matrículas"],"summary":"Contrato de Matrícula - Demonstrativo de Contrato","description":"Retorna uma lista das parcelas previstas para o contrato.","operationId":"consultarContratoParcelas","parameters":[{"name":"idPlanoPagamento","in":"query","description":"Código do Plano de Pagamento","required":true,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idTurma","in":"query","description":"Código da Turma","required":true,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idCursoBase","in":"query","description":"Código do Curso","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idCurso","in":"query","description":"Código da Matriz","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idCampusPolo","in":"query","description":"Código do Campus/Polo","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"diaPreferencialVencimento","in":"query","description":"Dia preferencial de vencimento","required":false,"schema":{"type":"integer","format":"int32"},"example":10},{"name":"idCupomDesconto","in":"query","description":"ID/Código do cupom de desconto","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"dataVencPrimeiraParc","in":"query","description":"Data de vencimento da primeira parcela","required":false,"schema":{"type":"string","format":"date-time"},"example":"2000-12-31"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContratoParcelaDtoRes"}}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.547+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.547+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.547+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.548+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.548+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/contas-bancarias":{"get":{"tags":["Contas Bancárias"],"summary":"Consulta de Contas Bancárias","description":"Retorna todas as contas bancárias da instituição","operationId":"list_16","parameters":[{"name":"idAgenciaConta","in":"query","description":"ID da conta bancária","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"tipoConta","in":"query","description":"Tipo Conta","required":false,"schema":{"type":"string","enum":["CONTA_BANCARIA","CAIXA","INVESTIMENTO"]},"example":"CAIXA"},{"name":"status","in":"query","description":"Status","required":false,"schema":{"type":"string","enum":["ATIVO","INATIVO"]},"example":"ATIVO"},{"name":"operacao","in":"query","description":"Operação","required":false,"schema":{"type":"string","enum":["PAGAMENTO","TRANSFERENCIA","VISUALIZACAO_CAIXA","RECEBIMENTO"]},"example":"VISUALIZACAO_CAIXA"},{"name":"search","in":"query","description":"Realiza busca por: Nome da Agência","required":false,"schema":{"type":"string"},"example":"Foo Bar"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationAgenciaContaDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.555+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.555+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.555+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.555+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.555+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/consolidacao/receitas":{"get":{"tags":["Consolidação Financeira"],"summary":"Consulta de transações de receita consolidadas","description":"Retornar todas as transações de receita associadas aos filtros informados.<br/>Para a consulta funcionar é preciso adicionar a data início e término do vencimento, da competência ou da alteração, ou o mês e ano da consolidação.","operationId":"list_17","parameters":[{"name":"idContrato","in":"query","description":"ID do Contrato","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"dataCompetenciaInicio","in":"query","description":"Data Início da Competência","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-01"},{"name":"dataCompetenciaTermino","in":"query","description":"Data Término da Competência","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-30"},{"name":"dataVencimentoInicio","in":"query","description":"Data Início do Vencimento","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-01"},{"name":"dataVencimentoTermino","in":"query","description":"Data Término do Vencimento","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-30"},{"name":"mesConsolidacao","in":"query","description":"Mês do período consolidado","required":false,"schema":{"type":"integer","format":"int32"},"example":6},{"name":"anoConsolidacao","in":"query","description":"Ano do período consolidado","required":false,"schema":{"type":"integer","format":"int32"},"example":2022},{"name":"idOrg","in":"query","description":"ID da Organização","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"situacao","in":"query","description":"Situação da transação","required":false,"schema":{"type":"string","enum":["ABERTO","RECEBIDO","CANCELADO","NAO_ENCONTRADO"]},"example":"ABERTA"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationTransacaoAcademicoDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.585+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.585+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.585+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.585+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.585+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/consolidacao/recebimentos":{"get":{"tags":["Consolidação Financeira"],"summary":"Consulta de recebimentos consolidados","description":"Retorna todos os recebimentos associados à um período de consolidação fechado (consolidado).<br>Para a consulta funcionar é preciso adicionar a data início e término da liquidação, ou o mês e ano da consolidação.","operationId":"list_18","parameters":[{"name":"dataLiquidacaoInicio","in":"query","description":"Data Início da Liquidação","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-01"},{"name":"dataLiquidacaoTermino","in":"query","description":"Data Término da Liquidação","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-30"},{"name":"mesConsolidacao","in":"query","description":"Mês do período consolidado","required":false,"schema":{"type":"integer","format":"int32"},"example":6},{"name":"anoConsolidacao","in":"query","description":"Ano do período consolidado","required":false,"schema":{"type":"integer","format":"int32"},"example":2022},{"name":"idOrg","in":"query","description":"ID da Organização","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idTransacao","in":"query","description":"ID da transação","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idPagador","in":"query","description":"ID do pagador","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationTransacaoRecebimentoDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.598+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.598+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.598+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.598+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.598+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/consolidacao/nfse":{"get":{"tags":["Consolidação Financeira"],"summary":"Consulta de NFS-e autorizadas","description":"Retorna todas as NFS-e associadas as transações com base nos filtros informados.<br>Para a consulta funcionar é preciso adicionar a data início e término da emissão ou da competência.","operationId":"list_19","parameters":[{"name":"dataEmissaoInicio","in":"query","description":"Data Início da Emissão","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-01"},{"name":"dataEmissaoTermino","in":"query","description":"Data Término da Emissão","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-30"},{"name":"dataCompetenciaInicio","in":"query","description":"Data Início da Competência","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-01"},{"name":"dataCompetenciaTermino","in":"query","description":"Data Término da Competência","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-30"},{"name":"idOrg","in":"query","description":"ID da Organização","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"somenteTransacoesConsolidadas","in":"query","description":"Trazer apenas NFS-e que estiverem consolidadas","required":false,"schema":{"type":"boolean"},"example":true},{"name":"nfseStatus","in":"query","description":"Status da NFS-e","required":false,"schema":{"type":"string"},"example":"AUTORIZADA"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationTransacaoNfseDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.608+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.608+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.608+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.608+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.608+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/consolidacao/despesas":{"get":{"tags":["Consolidação Financeira"],"summary":"Consulta de transações de despesas consolidadas","description":"Retornar todas as transações de despesas associadas aos filtros informados.<br/>Para a consulta funcionar é preciso adicionar a data início e término do vencimento, da competência ou da alteração, ou o mês e ano da consolidação.","operationId":"list_20","parameters":[{"name":"dataCompetenciaInicio","in":"query","description":"Data Início da Competência","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-01"},{"name":"dataCompetenciaTermino","in":"query","description":"Data Término da Competência","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-30"},{"name":"dataVencimentoInicio","in":"query","description":"Data Início do Vencimento","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-01"},{"name":"dataVencimentoTermino","in":"query","description":"Data Término do Vencimento","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-30"},{"name":"mesConsolidacao","in":"query","description":"Mês do período consolidado","required":false,"schema":{"type":"integer","format":"int32"},"example":6},{"name":"anoConsolidacao","in":"query","description":"Ano do período consolidado","required":false,"schema":{"type":"integer","format":"int32"},"example":2022},{"name":"idOrg","in":"query","description":"ID da Organização","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"situacao","in":"query","description":"Situação da transação","required":false,"schema":{"type":"string","enum":["ABERTO","RECEBIDO","CANCELADO","NAO_ENCONTRADO"]},"example":"ABERTA"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationTransacaoAcademicoDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.634+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.634+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.634+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.634+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.634+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/consolidacao/baixas":{"get":{"tags":["Consolidação Financeira"],"summary":"Consulta de baixas consolidadas","description":"Retorna todas as baixas associadas aos filtros informados.<br>Para a consulta funcionar é preciso adicionar a data início e término da baixa, ou o mês e ano da consolidação.","operationId":"list_21","parameters":[{"name":"dataBaixaInicio","in":"query","description":"Data Início da Baixa","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-01"},{"name":"dataBaixaTermino","in":"query","description":"Data Término da Baixa","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-06-30"},{"name":"mesConsolidacao","in":"query","description":"Mês do período consolidado","required":false,"schema":{"type":"integer","format":"int32"},"example":6},{"name":"anoConsolidacao","in":"query","description":"Ano do período consolidado","required":false,"schema":{"type":"integer","format":"int32"},"example":2022},{"name":"idOrg","in":"query","description":"ID da Organização","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"tipoBaixa","in":"query","description":"Tipo da Baixa","required":false,"schema":{"type":"string","enum":["CANCELAMENTO","ACORDO","BXD"]},"example":"ACORDO"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationTransacaoBaixaDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.643+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.643+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.643+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.643+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.643+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/cartao-credito-gateways":{"get":{"tags":["Financeiro - Cartão de Crédito"],"summary":"Consulta de gateways de cartão de crédito","description":"Retorna uma lista de todos os gateways de pagamento por cartão de crédito que estão ativos.","operationId":"listarGateways","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CartaoCreditoGatewayDtoRes"}}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.653+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.653+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.653+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.653+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.653+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/cartao-credito-gateways/cartoes":{"get":{"tags":["Financeiro - Cartão de Crédito"],"summary":"Consulta de cartões de crédito","description":"Retorna os cartões de crédito ativos, filtrados por organização e gateway.","operationId":"listarCartoes","parameters":[{"name":"idOrg","in":"query","description":"ID da organizacao","required":true,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idCartaoCreditoGateway","in":"query","description":"ID do gateway de cartao de credito","required":false,"schema":{"type":"integer","format":"int32"},"example":10},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CartaoCreditoDtoRes"}}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.657+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.657+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.657+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.657+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.657+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/caixa/saldomovimentacao":{"get":{"tags":["Caixa"],"summary":"Consulta de Saldo por Movimentacao","description":"Retorna uma lista com o saldo por movimentação a partir de uma conta bancaria e data do caixa.</br>Obrigatório preencher todos os parametros para que a consulta funcione.","operationId":"list_23","parameters":[{"name":"idAgenciaConta","in":"query","description":"Código Conta Bancaria","required":true,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"dataFechamento","in":"query","description":"Data Fechamento Caixa","required":true,"schema":{"type":"string","format":"date-time"},"example":"2025-01-31"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationCaixaSaldoMovimentacaoDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.663+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.663+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.663+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.663+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.663+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/caixa/historico":{"get":{"tags":["Caixa"],"summary":"Consulta Lista de Histórico de Fechamento de Contas","description":"Retornar a lista do histórico de fechamento de contas associadas aos filtros informados.</br>Para a consulta funcionar é preciso informar os parametros.","operationId":"list_24","parameters":[{"name":"dataOperacao","in":"query","description":"Data da Abertura/Fechamento","required":false,"schema":{"type":"string","format":"date-time"},"example":"yyyy-MM-dd"},{"name":"codigoContaBancaria","in":"query","description":"Codigo da Conta Bancaria","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"operacao","in":"query","description":"Operação da conta","required":false,"schema":{"type":"string","enum":["ABERTURA","FECHAMENTO"]},"example":"ABERTURA"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationCaixaHistoricoDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.673+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.673+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.673+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.673+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.673+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/boletos":{"get":{"tags":["Boletos"],"summary":"Consulta de Boletos","description":"Retorna os dados básicos dos boletos bancários no sistema","operationId":"list_25","parameters":[{"name":"idOrg","in":"query","description":"ID da Organização","required":false,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"idBoleto","in":"query","description":"Código do Boleto","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"nossoNumero","in":"query","description":"Nosso Número","required":false,"schema":{"type":"string"},"example":"00000000"},{"name":"status","in":"query","description":"Status do Boleto","required":false,"schema":{"type":"string","enum":["ABERTO","RECEBIDO","CANCELADO","NAO_ENCONTRADO"]},"example":"ABERTO"},{"name":"idPagador","in":"query","description":"Código do Pagador","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idMetodoRecebimento","in":"query","description":"Código do Método de Recebimento","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idAgencia","in":"query","description":"Código da Agência","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idAgenciaConta","in":"query","description":"Código de Conta da Agência","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"search","in":"query","description":"Realiza busca por: Nome do Pagador","required":false,"schema":{"type":"string"},"example":"Foo Bar"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationBoletoDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.685+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.685+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.685+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.685+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.685+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/boletos/{idBoleto}":{"get":{"tags":["Boletos"],"summary":"Dados Boleto Atualizado","description":"Retorna os dados atualizados (calculados) de um boleto bancário em ABERTO","operationId":"gerarBoleto","parameters":[{"name":"idBoleto","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BoletoRest"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.693+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.693+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.693+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.693+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.693+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/boletos/{idBoleto}/link":{"get":{"tags":["Boletos"],"summary":"Obter link compartilhável","description":"Retorna o link para compartilhamento do boleto bancário informado.","operationId":"doObterLink","parameters":[{"name":"idBoleto","in":"path","description":"ID do boleto bancário","required":true,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idTransacao","in":"query","description":"ID da transação","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkBoletoRest"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.699+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.699+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.699+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.699+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.699+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/boletos/{idBoleto}/linha-digitavel":{"get":{"tags":["Boletos"],"summary":"Obter linha digitável","description":"Retorna a linha digitável do boleto bancário informado.","operationId":"doObterLinhaDigital","parameters":[{"name":"idBoleto","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BoletoLinhaDigitavelDtoRes"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.699+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.699+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.699+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.699+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.699+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/boletos/{idBoleto}/download":{"get":{"tags":["Boletos"],"summary":"Download do PDF do boleto","description":"Retorna o arquivo PDF do boleto bancário informado.","operationId":"doImprimirRelatorioDemonstrativoCobranca","parameters":[{"name":"idBoleto","in":"path","description":"ID do boleto bancário","required":true,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idTransacao","in":"query","description":"ID da transação","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.700+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.701+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.701+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.701+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.701+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/acordos/{idAcordoFinanceiro}/documentos/termo-renegociacao-titulos":{"get":{"tags":["Cobrança"],"summary":"Termo de renegociação de títulos","description":"Retorna o documento em formato PDF do termo de renegociação de títulos de um acordo financeiro informado.","operationId":"gerarTermoRenegociacaoTitulos","parameters":[{"name":"idAcordoFinanceiro","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.702+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.702+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.702+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.702+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.702+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/acordos/{idAcordoFinanceiro}/documentos/instrumento-confissao-divida":{"get":{"tags":["Cobrança"],"summary":"Instrumento de confissão de dívida","description":"Retorna o documento em formato PDF do instrumento de confissão de dívida de um acordo financeiro informado.","operationId":"gerarInstrumentoConfissaoDivida","parameters":[{"name":"idAcordoFinanceiro","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.702+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.702+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.702+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.702+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.702+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/financeiro/acordos/tipo":{"get":{"tags":["Cobrança"],"summary":"Consulta de Tipos de Acordos Financeiros","description":"Retorna todos os tipos de acordos financeiros da instituição.","operationId":"list_26","parameters":[{"name":"idTipoAcordoFinanceiro","in":"query","description":"Código do tipo de acordo financeiro","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"idOrg","in":"query","description":"Código da organização","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"searchTerm","in":"query","description":"Campo para busca aberta nos campos descrição e organização","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Status do tipo acordo","required":false,"schema":{"type":"string","enum":["ATIVO","INATIVO"]},"example":"ATIVO"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationTipoAcordoFinanceiroDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.718+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.718+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.718+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.718+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:36:33.718+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}}},"components":{"schemas":{"PlanoContaDtoReq":{"required":["codigo","descricao","natureza","operacao","status","tipoConta"],"type":"object","properties":{"descricao":{"maxLength":1000,"minLength":0,"type":"string"},"codigo":{"maxLength":100,"minLength":0,"type":"string"},"operacao":{"maxLength":100,"minLength":0,"pattern":"SOMA|SUBTRAI","type":"string"},"tipoConta":{"pattern":"A|S","type":"string"},"status":{"pattern":"ATIVO|INATIVO","type":"string"},"natureza":{"maxLength":10,"minLength":0,"pattern":"ATIVO|PASSIVO|PATRIMONIO|RECEITA|DESPESA","type":"string"},"idGrupoContas":{"type":"integer","format":"int32"},"idGrupoContabil":{"type":"integer","format":"int32"},"redutora":{"type":"integer","format":"int32"},"baixaCancelamento":{"type":"integer","description":"Opção para permitir baixas de cancelamento","format":"int32","example":0},"baixaDiversa":{"type":"integer","description":"Opção para permitir baixas diversas","format":"int32","example":0},"baixaConvenio":{"type":"integer","description":"Opção para permitir baixas de convênio","format":"int32","example":0},"indice":{"maxLength":100,"minLength":0,"type":"string"},"contaResultado":{"maxLength":20,"minLength":0,"type":"string"},"contaAtivo":{"maxLength":20,"minLength":0,"type":"string"},"contaPassivo":{"maxLength":20,"minLength":0,"type":"string"},"contaAdiantamento":{"maxLength":20,"minLength":0,"type":"string"}}},"PlanoContaDtoRes":{"type":"object","properties":{"idPlanoConta":{"type":"integer","format":"int32"},"descricao":{"type":"string"},"codigo":{"type":"string"},"indice":{"type":"string"},"operacao":{"type":"string"},"tipoConta":{"type":"string"},"natureza":{"type":"string"},"idCliente":{"type":"integer","format":"int32"},"idPlanoContaPassivo":{"type":"integer","format":"int32"},"idPlanoContaAtivo":{"type":"integer","format":"int32"},"idPlanoContaAdiantamento":{"type":"integer","format":"int32"},"baixaCancelamento":{"type":"integer","format":"int32"},"baixaDiversa":{"type":"integer","format":"int32"},"baixaConvenio":{"type":"integer","format":"int32"},"contaResultado":{"type":"string"},"contaAtivo":{"type":"string"},"contaPassivo":{"type":"string"},"contaAdiantamento":{"type":"string"},"status":{"type":"string"},"idUsuarioCriacao":{"type":"integer","format":"int32"},"idUsuarioAlteracao":{"type":"integer","format":"int32"},"dataCriacao":{"type":"string","format":"date-time"},"dataAlteracao":{"type":"string","format":"date-time"}}},"CentroCustoDtoReq":{"required":["codigo","descricao","status","tipo"],"type":"object","properties":{"descricao":{"maxLength":1000,"minLength":0,"type":"string"},"codigo":{"maxLength":600,"minLength":0,"type":"string"},"indice":{"maxLength":100,"minLength":0,"type":"string"},"status":{"pattern":"ATIVO|INATIVO","type":"string"},"tipo":{"pattern":"A|S","type":"string"}}},"CentroCustoDtoRes":{"type":"object","properties":{"idCentroCusto":{"type":"integer","format":"int32"},"descricao":{"type":"string"},"status":{"type":"string"},"codigo":{"type":"string"},"indice":{"type":"string"},"tipo":{"type":"string"},"nivel":{"type":"integer","format":"int32"},"idCliente":{"type":"integer","format":"int32"},"idUsuarioCriacao":{"type":"integer","format":"int32"},"idUsuarioAlteracao":{"type":"integer","format":"int32"},"dataCriacao":{"type":"string","format":"date-time"},"dataAlteracao":{"type":"string","format":"date-time"}}},"TransacaoDescontoDtoReq":{"required":["descricao","tipo","valor"],"type":"object","properties":{"valor":{"type":"number","description":"Valor do Desconto","format":"double","example":10.0},"descricao":{"type":"string","description":"Descrição do Desconto","example":"string"},"tipo":{"type":"string","description":"Tipo de Desconto","example":"VALOR","enum":["VALOR","PORCENTAGEM"]}},"description":"Descontos no recebimento"},"TransacaoEncargoDtoReq":{"required":["descricao","periodo","tipo","valor"],"type":"object","properties":{"valor":{"type":"number","description":"Valor do Encargo","format":"double","example":10.0},"descricao":{"type":"string","description":"Descrição do Encargo","example":"string"},"tipo":{"type":"string","description":"Tipo de Encargo","example":"VALOR","enum":["VALOR","PORCENTAGEM"]},"periodo":{"type":"string","description":"Período do Encargo","example":"UNICO","enum":["UNICO","VISTA"]}},"description":"Encargos no recebimento"},"TransacaoRecebimentoDtoReq":{"required":["idTipoRecebimento","idTransacao","valorRecebimento"],"type":"object","properties":{"idTransacao":{"type":"integer","description":"Código da transação para ser recebida","format":"int32"},"valorRecebimento":{"type":"number","description":"Valor total de recebimento (deve ser maior que zero)","format":"double","example":1.0},"dataRecebimento":{"type":"string","description":"Data/hora de recebimento","example":"2019-08-24T14:15:22Z"},"idAgenciaConta":{"type":"integer","description":"Código da conta bancária (AgenciaConta) do recebimento.","format":"int32","example":1},"idTipoRecebimento":{"type":"integer","description":"Código do tipo de recebimento.","format":"int32","example":1},"descontos":{"type":"array","description":"Descontos no recebimento","items":{"$ref":"#/components/schemas/TransacaoDescontoDtoReq"}},"encargos":{"type":"array","description":"Encargos no recebimento","items":{"$ref":"#/components/schemas/TransacaoEncargoDtoReq"}},"observacaoRecebimento":{"type":"string","description":"Observação do recebimento","example":"string"},"idBoleto":{"type":"integer","description":"Código do boleto bancário para sinalizar recebimento por boleto","format":"int32","example":1},"tipoTratamentoSobra":{"type":"string","description":"Tipo de Tratamento da sobra","example":"CREDITAR","enum":["ABATER","CREDITAR"]}}},"TransacaoPagamentoCartaoGatewayRest":{"type":"object","properties":{"idPagamentoCartao":{"type":"integer","format":"int32"},"numeroParcelas":{"type":"integer","format":"int32"},"valorPagamento":{"type":"number","format":"double"},"dataPagamento":{"type":"string","format":"date-time"},"status":{"type":"string"},"numeroComprovante":{"type":"string"}}},"TransacaoPagamentoCartaoRest":{"type":"object","properties":{"numeroParcela":{"type":"string"},"valorParcela":{"type":"number","format":"double"},"valorPago":{"type":"number","format":"double"},"valorTaxa":{"type":"number","format":"double"},"valorPrevisto":{"type":"number","format":"double"},"dataConciliacao":{"type":"string","format":"date-time"},"situacao":{"type":"string"},"idRecebimentoCartao":{"type":"integer","format":"int32"},"idRecebimentoCartaoParcela":{"type":"integer","format":"int32"},"codigo":{"type":"string"}}},"TransacaoRecebimentoDtoRes":{"type":"object","properties":{"idTransacaoRecebimento":{"type":"integer","format":"int32"},"idTransacao":{"type":"integer","format":"int32"},"idTipoRecebimento":{"type":"integer","format":"int32"},"idAgenciaConta":{"type":"integer","format":"int32"},"idCheque":{"type":"integer","format":"int32"},"idUsuarioRecebimento":{"type":"integer","format":"int32"},"idBoletoRecebimento":{"type":"integer","format":"int32"},"idRecebimentoCartao":{"type":"integer","format":"int32"},"dataRecebimento":{"type":"string","format":"date-time"},"dataDeposito":{"type":"string","format":"date-time"},"dataLiquidacao":{"type":"string","format":"date-time"},"valorRecebido":{"type":"number","format":"double"},"valorDescontos":{"type":"number","format":"double"},"valorEncargos":{"type":"number","format":"double"},"observacao":{"type":"string"},"status":{"type":"string"},"idUsuarioCancelamento":{"type":"integer","format":"int32"},"dataCancelamento":{"type":"string","format":"date-time"},"usuarioCancelamento":{"type":"string"},"tipoRecebimento":{"type":"string"},"conta":{"type":"string"},"numeroConta":{"type":"string"},"dvConta":{"type":"string"},"usuarioRecebimento":{"type":"string"},"motivo":{"type":"string"},"transacaoPagadorNome":{"type":"string"},"transacaoRespNome":{"type":"string"},"transacaoDataVencimento":{"type":"string","format":"date-time"},"transacaoValorOriginal":{"type":"number","format":"double"},"transacaoValor":{"type":"number","format":"double"},"recebimentosCartaoGateway":{"type":"array","items":{"$ref":"#/components/schemas/TransacaoPagamentoCartaoGatewayRest"}},"recebimentosCartao":{"type":"array","items":{"$ref":"#/components/schemas/TransacaoPagamentoCartaoRest"}},"idOrg":{"type":"integer","format":"int32"},"orgDescricao":{"type":"string"},"dataCriacao":{"type":"string","format":"date-time"},"dataAlteracao":{"type":"string","format":"date-time"}}},"TransacaoBaixaDtoReq":{"required":["dataBaixa","idPlanoContaBaixa","idTransacao","motivo"],"type":"object","properties":{"idTransacao":{"type":"integer","format":"int32"},"motivo":{"type":"string"},"dataBaixa":{"type":"string","format":"date-time"},"idPlanoContaBaixa":{"type":"integer","format":"int32"}}},"TransacaoBaixaDtoRes":{"type":"object","properties":{"idTransacaoBaixa":{"type":"integer","format":"int32"},"idTransacao":{"type":"integer","format":"int32"},"idPlanoConta":{"type":"integer","format":"int32"},"tipoBaixa":{"type":"string"},"idUsuarioBaixa":{"type":"integer","format":"int32"},"dataBaixa":{"type":"string","format":"date-time"},"dataOperacao":{"type":"string","format":"date-time"},"valorBaixa":{"type":"number","format":"double"},"valorEncargos":{"type":"number","format":"double"},"valorDescontos":{"type":"number","format":"double"},"observacao":{"type":"string"},"status":{"type":"string"},"idUsuarioCancelamento":{"type":"integer","format":"int32"},"dataCancelamento":{"type":"string","format":"date-time"},"motivoCancelamento":{"type":"string"},"usuarioCancelamento":{"type":"string"},"planoConta":{"type":"string"},"planoContaOp":{"type":"string"},"usuarioBaixa":{"type":"string"},"transacaoPagadorNome":{"type":"string"},"transacaoRespNome":{"type":"string"},"transacaoDataVencimento":{"type":"string","format":"date-time"},"transacaoValorOriginal":{"type":"number","format":"double"},"transacaoValor":{"type":"number","format":"double"},"idOrg":{"type":"integer","format":"int32"},"orgDescricao":{"type":"string"}}},"CancelarTransacaoBaixaDtoReq":{"type":"object","properties":{"idTransacao":{"type":"integer","description":"Código da transação","format":"int32","example":150},"idTransacaoBaixa":{"type":"integer","description":"Código da baixa da transação","format":"int32","example":150},"motivo":{"type":"string","description":"Descrição do cancelamento","example":"Descrição do cancelamento"}}},"TransacaoAcademicoContaReceberDtoReq":{"required":["dataVencimento","descricao","idCentroCusto","idOrg","idPerfil","idPlanoConta","valor"],"type":"object","properties":{"idOrg":{"type":"integer","description":"ID da Organização","format":"int32","example":1},"idPerfil":{"type":"integer","description":"ID do Perfil","format":"int32","example":1},"idMatricula":{"type":"integer","description":"ID da Matrícula (Para gerar transação relacionada à matrícula)","format":"int32","example":1},"descricao":{"type":"string","description":"Descrição da conta a receber","example":"descrição"},"valor":{"type":"number","description":"Valor da conta a receber (deve ser maior que zero)","format":"double","example":1.0},"dataVencimento":{"type":"string","description":"Data de vencimento da conta a receber(YYYY-MM-DD)","format":"date-time"},"idPlanoConta":{"type":"integer","description":"ID do Plano de Contas da conta a receber","format":"int32","example":1},"idCentroCusto":{"type":"integer","description":"ID do Centro de Custo da conta a receber","format":"int32","example":1},"origem":{"type":"string","description":"Origem da transação","example":"ACORDO","enum":["ACORDO","CHEQUE","CONVENIO_RETROATIVO","CREDITO","EVENTO_INSCRICAO","IMPORTACAO","INSCRICAO_VESTIBULAR","MENSALIDADE","OUTROS","PARCELA","REEMBOLSAR","REEMBOLSO","REEMBOLSO_CONVENIO","REMATRICULA","UNIFICACAO"]}}},"TransacaoAcademicoRest":{"type":"object","properties":{"idTransacao":{"type":"integer","format":"int32"},"transacaoIdReferencia":{"type":"integer","format":"int32"},"transacaoTipoReferencia":{"type":"string"},"transacaoDataVencimento":{"type":"string","format":"date-time"},"transacaoDataCompetencia":{"type":"string","format":"date-time"},"transacaoDataEmissao":{"type":"string","format":"date-time"},"transacaoValorOriginal":{"type":"number","format":"double"},"transacaoValor":{"type":"number","format":"double"},"gettransacaoAcademicoItens":{"type":"array","items":{"$ref":"#/components/schemas/TransacaoItemRest"}},"transacaoConveniosValor":{"type":"number","format":"double"},"transacaoConvenios":{"type":"string"},"transacaoPlanosContas":{"type":"string"},"transacaoPlanosContasIds":{"type":"string"},"transacaoSituacao":{"type":"string"},"transacaoParcela":{"type":"string"},"transacaoIdBoleto":{"type":"integer","format":"int32"},"transacaoBoletoStatus":{"type":"string"},"transacaoBoletoNossoNumero":{"type":"string"},"transacaoBoletoNossoNumeroDigitoVerificador":{"type":"string"},"transacaoBoletoLiberadoWeb":{"type":"integer","format":"int32"},"transacaoOrigem":{"type":"string"},"transacaoRecebimentosCartao":{"type":"string"},"pagadorNome":{"type":"string"},"pagadorCpfCnpj":{"type":"string"},"pagadorPassaporte":{"type":"string"},"pagadorTipoPessoa":{"type":"string"},"pagadorRg":{"type":"string"},"pagadorInscricaoEstadual":{"type":"string"},"pagadorDataNascimento":{"type":"string","format":"date-time"},"pagadorIdPagador":{"type":"integer","format":"int32"},"pagadorLogradouro":{"type":"string"},"pagadorBairro":{"type":"string"},"pagadorLogradouroNumero":{"type":"string"},"pagadorCep":{"type":"string"},"pagadorLogradouroComplemento":{"type":"string"},"pagadorLogradouroCidade":{"type":"string"},"pagadorLogradouroUf":{"type":"string"},"pagadorLogradouroCidadeCodIbge":{"type":"string"},"pagadorEmail":{"type":"string"},"pagadorTelefone":{"type":"string"},"pagadorTelefoneComercial":{"type":"string"},"pagadorCelular":{"type":"string"},"respNome":{"type":"string"},"respCpfCnpj":{"type":"string"},"respPassaporte":{"type":"string"},"respTipoPessoa":{"type":"string"},"respRg":{"type":"string"},"respInscricaoEstadual":{"type":"string"},"respDataNascimento":{"type":"string","format":"date-time"},"respIdPagador":{"type":"integer","format":"int32"},"respLogradouro":{"type":"string"},"respBairro":{"type":"string"},"respLogradouroNumero":{"type":"string"},"respCep":{"type":"string"},"respLogradouroComplemento":{"type":"string"},"respLogradouroCidade":{"type":"string"},"respLogradouroUf":{"type":"string"},"respLogradouroCidadeCodIbge":{"type":"string"},"respEmail":{"type":"string"},"respTelefone":{"type":"string"},"respTelefoneComercial":{"type":"string"},"respCelular":{"type":"string"},"alunoIdAluno":{"type":"integer","format":"int32"},"alunoRa":{"type":"string"},"curso":{"type":"string"},"cursoIdCurso":{"type":"integer","format":"int32"},"matriz":{"type":"string"},"matrizIdMatriz":{"type":"integer","format":"int32"},"turma":{"type":"string"},"turmaNomeReduzido":{"type":"string"},"turmaNomePeriodoCurso":{"type":"string"},"turmaIdTurma":{"type":"integer","format":"int32"},"periodoLetivo":{"type":"string"},"periodoLetivoIdPeriodoLetivo":{"type":"integer","format":"int32"},"matriculaIdContrato":{"type":"integer","format":"int32"},"matriculaIdMatricula":{"type":"integer","format":"int32"},"matriculaIdAlunoCursoIngresso":{"type":"integer","format":"int32"},"matriculaStatus":{"type":"string"},"matriculaPlanoPagamento":{"type":"string"},"matriculaIdPlanoPagamento":{"type":"integer","format":"int32"},"matriculaDataMatricula":{"type":"string","format":"date-time"},"matriculaCursoIngressoUnidadeFisicaNome":{"type":"string"},"matriculaCursoIngressoUnidadeFisicaCodigo":{"type":"integer","format":"int32"},"idOrg":{"type":"integer","format":"int32"},"orgDescricao":{"type":"string"},"dataCriacao":{"type":"string","format":"date-time"},"dataAlteracao":{"type":"string","format":"date-time"},"ignorarLog":{"type":"boolean"}}},"TransacaoCentroCustoRest":{"type":"object","properties":{"idCentroCusto":{"type":"integer","format":"int32"},"codigoCentroCusto":{"type":"string"},"descricaoCentroCusto":{"type":"string"}}},"TransacaoItemRest":{"type":"object","properties":{"idPlanoConta":{"type":"integer","format":"int32"},"codigoPlanoConta":{"type":"string"},"descricaoPlanoConta":{"type":"string"},"idTransacaoItem":{"type":"integer","format":"int32"},"descricaoTransacaoItem":{"type":"string"},"valorTransacaoItem":{"type":"number","format":"double"},"tipoConta":{"type":"string"},"centrosDeCusto":{"type":"array","items":{"$ref":"#/components/schemas/TransacaoCentroCustoRest"}}}},"TransacaoContaAPagarDtoReq":{"required":["dataCompetencia","dataVencimento","descricao","idCentroCusto","idOrg","idPerfilPagador","idPlanoConta","transacaoParcela","valor"],"type":"object","properties":{"descricao":{"type":"string"},"idPlanoConta":{"type":"integer","format":"int32"},"idCentroCusto":{"type":"integer","format":"int32"},"idPerfilPagador":{"type":"integer","format":"int32"},"dataVencimento":{"type":"string","format":"date-time"},"dataCompetencia":{"type":"string","format":"date-time"},"transacaoParcela":{"type":"integer","format":"int32"},"valor":{"type":"number","format":"double"},"idOrg":{"type":"integer","format":"int32"}}},"GerarPixDtoReq":{"required":["idPixGateway","idTransacao"],"type":"object","properties":{"idTransacao":{"type":"integer","format":"int32"},"idPixGateway":{"type":"integer","format":"int32"}}},"PagamentoPixTransacaoDtoRes":{"type":"object","properties":{"idPagamentoPixTransacao":{"type":"integer","format":"int32"},"idTransacao":{"type":"integer","format":"int32"},"idTransacaoRecebimento":{"type":"integer","format":"int32"},"idPixGateway":{"type":"integer","format":"int32"},"idTransacaoTaxa":{"type":"integer","format":"int32"},"taxaProcessada":{"type":"integer","format":"int32"},"valorTarifa":{"type":"number","format":"double"},"statusPedido":{"type":"string"},"status":{"type":"string"},"valor":{"type":"number","format":"double"},"dataRecebimento":{"type":"string","format":"date-time"},"order_id":{"type":"string"},"orderRef":{"type":"string"},"asaasCobrancaId":{"type":"string"},"asaasCobrancaInvoiceNumber":{"type":"string"},"asaasCustomerId":{"type":"string"},"qrCode":{"type":"string"},"qrCodeText":{"type":"string"},"verificadoIntegradora":{"type":"integer","format":"int32"},"obsIntegracao":{"type":"string"},"parcela":{"type":"string"},"dataVencimento":{"type":"string","format":"date-time"},"situacao":{"type":"string"},"idPagador":{"type":"integer","format":"int32"},"tipoReferencia":{"type":"string"},"idReferencia":{"type":"integer","format":"int32"},"pagador":{"type":"string"},"idOrg":{"type":"integer","format":"int32"},"gateway":{"type":"string"},"descricaoGateway":{"type":"string"},"recebimentoStatus":{"type":"string"}}},"RetencaoFinanceiraDtoReq":{"required":["idOrg","idPagador","mensagem"],"type":"object","properties":{"idPagador":{"type":"integer","format":"int32"},"idOrg":{"type":"integer","format":"int32"},"idAluno":{"type":"integer","format":"int32"},"idTransacao":{"type":"integer","format":"int32"},"mensagem":{"maxLength":65535,"minLength":0,"type":"string"},"dataLimite":{"type":"string","format":"date-time"}}},"RetencaoFinanceiraDtoRes":{"type":"object","properties":{"idRetencao":{"type":"integer","format":"int32"},"idAluno":{"type":"integer","format":"int32"},"mensagem":{"type":"string"},"dataCadastro":{"type":"string","format":"date-time"},"dataLimite":{"type":"string","format":"date-time"},"tipoRetencao":{"type":"string"},"status":{"type":"string"},"get_idPagador":{"type":"integer","format":"int32"},"get_nomePagador":{"type":"string"}}},"CartaoCreditoDto":{"required":["bandeira","codigoSeguranca","cpfTitular","nomeTitular","numero","vencimento"],"type":"object","properties":{"nomeTitular":{"type":"string"},"cpfTitular":{"type":"string"},"numero":{"type":"string"},"bandeira":{"type":"string"},"vencimento":{"pattern":"^(0[1-9]|1[0-2])\\/([0-9]{4})$","type":"string"},"codigoSeguranca":{"maxLength":4,"minLength":3,"type":"string"}}},"PagamentoCartaoDtoReq":{"required":["idCartaoCreditoGateway","idsTransacoes"],"type":"object","properties":{"idCartaoCreditoGateway":{"type":"integer","format":"int32"},"idCartaoCredito":{"type":"integer","format":"int32"},"idsTransacoes":{"type":"array","items":{"type":"integer","format":"int32"}},"cartao":{"$ref":"#/components/schemas/CartaoCreditoDto"},"ativarRecorrencia":{"type":"boolean"}}},"PagamentoCartaoDtoRes":{"type":"object","properties":{"idPagamentoCartao":{"type":"integer","format":"int32"},"status":{"type":"string"},"valorPago":{"type":"number","format":"double"},"numeroParcelas":{"type":"integer","format":"int32"},"mensagemRetorno":{"type":"string"},"identificadorUnico":{"type":"string"},"idsTransacoesProcessadas":{"type":"array","items":{"type":"integer","format":"int32"}}}},"GrantedAuthority":{"type":"object","properties":{"authority":{"type":"string"}}},"IUsuario":{"type":"object"},"Org":{"type":"object","properties":{"id_org":{"type":"integer","format":"int32"},"id_usuario_criacao":{"type":"integer","format":"int32"},"id_usuario_alteracao":{"type":"integer","format":"int32"},"data_criacao":{"type":"string","format":"date-time"},"data_alteracao":{"type":"string","format":"date-time"},"buscaIndexada":{"type":"boolean"},"idOrg":{"type":"integer","format":"int32"},"idCliente":{"type":"integer","format":"int32"},"descricao":{"type":"string"},"imagem":{"type":"string"},"nomeFantasia":{"type":"string"},"nomeComercial":{"type":"string"},"nomeComplementar":{"type":"string"},"nomePortalDiplomado":{"type":"string"},"nomeReduzido":{"type":"string"},"endereco":{"type":"string"},"cnpj":{"type":"string"},"inscricao":{"type":"string"},"enderecoFone":{"type":"string"},"pracaPagamento":{"type":"string"},"cep":{"type":"string"},"cidade":{"type":"string"},"inscricaoMunicipal":{"type":"string"},"diretorGeral":{"type":"string","deprecated":true},"cssPortais":{"type":"string"},"secretariaAcademica":{"type":"string","deprecated":true},"idPerfilDiretor":{"type":"integer","format":"int32"},"portariaDiretor":{"type":"string"},"get_nomeDiretor":{"type":"string"},"get_sexoDiretor":{"type":"string"},"idPerfilSecretariaAcademica":{"type":"integer","format":"int32"},"portariaSecretariaAcademica":{"type":"string"},"get_nomeSecretariaAcademica":{"type":"string"},"get_sexoSecretariaAcademica":{"type":"string"},"portariaCredenciamento":{"type":"string"},"website":{"type":"string"},"idCidadeNRE":{"type":"integer","format":"int32"},"idPerfilDiretorAcademico":{"type":"integer","format":"int32"},"get_nomeDiretorAcademico":{"type":"string"},"portariaDiretorAcademico":{"type":"string"},"email":{"type":"string"},"idPerfilResponsavelFinanceiro":{"type":"integer","format":"int32"},"get_nomeResponsavelFinanceiro":{"type":"string"},"get_sexoResponsavelFinanceiro":{"type":"string"},"numero":{"type":"string"},"logradouro":{"type":"string"},"bairro":{"type":"string"},"idPerfilViceDiretor":{"type":"integer","format":"int32"},"get_nomePerfilViceDiretor":{"type":"string"},"nomePortal":{"type":"string"},"idPerfilResposavelCertificacao":{"type":"integer","format":"int32"},"get_nomePerfilResposavelCertificacao":{"type":"string"},"portariaCertificacao":{"type":"string"},"status":{"type":"string"},"idEmpresa":{"type":"integer","format":"int32"},"codigoInep":{"type":"string"},"idPerfilRespLivroRegistro":{"type":"integer","format":"int32"},"get_nomePerfilRespLivroRegistro":{"type":"string"},"getiDouNumeroMatriculaRespLivReg":{"type":"string"},"modeloNegocio":{"type":"string"},"idPerfilSecretariaDiplomaDigital":{"type":"integer","format":"int32"},"portariaSecretariaDiplomaDigital":{"type":"string"},"idPerfilDiretorDiploma":{"type":"integer","format":"int32"},"portariaDiretorDiploma":{"type":"string"},"funcaoDiretorDiploma":{"type":"string"},"idPerfilSecretariaDiploma":{"type":"integer","format":"int32"},"portariaSecretariaDiploma":{"type":"string"},"funcaoSecretariaDiploma":{"type":"string"},"get_descricaoCliente":{"type":"string"},"newObjectInCache":{"type":"boolean"},"usuario":{"$ref":"#/components/schemas/IUsuario"},"ignorarLog":{"type":"boolean"}}},"TableEmailTag":{"type":"object","properties":{"tag":{"type":"string"},"descricao":{"type":"string"}}},"UserInfo":{"type":"object","properties":{"login":{"type":"string"},"token":{"type":"string"},"expiresIn":{"type":"integer","format":"int64"},"deviceDetails":{"type":"string"},"idUsuario":{"type":"integer","format":"int32"},"status":{"type":"string"},"idOrg":{"type":"integer","format":"int32"},"idCliente":{"type":"integer","format":"int32"},"idGrupoUsuario":{"type":"integer","format":"int32"},"moduloID":{"type":"string"},"tipoGrupoUsuario":{"type":"string"},"nomeComercial":{"type":"string"},"descOrg":{"type":"string"},"modeloNegocio":{"type":"string"},"grupoUsuario":{"type":"string"},"usuarioDirector":{"type":"string"},"modulos":{"type":"array","items":{"type":"string"}},"orgs":{"type":"array","items":{"$ref":"#/components/schemas/Org"}},"usuario":{"$ref":"#/components/schemas/UsuarioPortal"},"org":{"$ref":"#/components/schemas/Org"}}},"UsuarioPortal":{"type":"object","properties":{"id_org":{"type":"integer","format":"int32"},"id_usuario_criacao":{"type":"integer","format":"int32"},"id_usuario_alteracao":{"type":"integer","format":"int32"},"data_criacao":{"type":"string","format":"date-time"},"data_alteracao":{"type":"string","format":"date-time"},"buscaIndexada":{"type":"boolean"},"idUsuario":{"type":"integer","format":"int32"},"idGrupoUsuario":{"type":"integer","format":"int32"},"nome":{"type":"string"},"forcarAlterarSenha":{"type":"integer","format":"int32"},"senha":{"type":"string"},"descricao":{"type":"string"},"token":{"type":"string"},"status":{"type":"string"},"lookAndFeel":{"type":"string"},"skinBordas":{"type":"integer","format":"int32"},"flagAcessoTodasContas":{"type":"integer","format":"int32"},"usuarioWebService":{"type":"integer","format":"int32"},"idIntegracao":{"type":"integer","format":"int32"},"isUsuarioPolo":{"type":"integer","format":"int32"},"dataUltimaAlteracaoSenha":{"type":"string","format":"date-time"},"papelPolo":{"type":"string"},"get_nomeGrupoUsuario":{"type":"string"},"get_tipoGrupoUsuario":{"type":"string"},"idFuncionario":{"type":"integer","format":"int32"},"get_funcionario":{"type":"string"},"get_emailEmpresa":{"type":"string"},"get_senhaEmailEmpresa":{"type":"string"},"get_idSetor":{"type":"integer","format":"int32"},"get_idPerfil":{"type":"integer","format":"int32"},"get_nomePerfil":{"type":"string"},"get_idCliente":{"type":"integer","format":"int32"},"idUnidadeFisica":{"type":"integer","format":"int32","deprecated":true},"get_nomeUnidadeFisica":{"type":"string"},"desabilitarAcessoLogarComoNosPortais":{"type":"integer","format":"int32"},"usuarioGlobalConfiguracao":{"type":"integer","format":"int32"},"usuarioRemoto":{"$ref":"#/components/schemas/UsuarioSuporteBean"},"idCliente":{"type":"integer","format":"int32"},"email":{"type":"string"},"emailStatus":{"type":"string"},"emailMotivoInvalido":{"type":"string"},"emailCodigoConfirmacao":{"type":"string"},"celular":{"type":"string"},"orgs":{"type":"array","items":{"$ref":"#/components/schemas/Org"}},"permissoes":{"type":"array","items":{"$ref":"#/components/schemas/GrantedAuthority"}},"props":{"type":"object","additionalProperties":{"type":"object"}},"enabled":{"type":"boolean"},"firstName":{"type":"string"},"lastName":{"type":"string"},"accountNonExpired":{"type":"boolean"},"accountNonLocked":{"type":"boolean"},"credentialsNonExpired":{"type":"boolean"},"emailDestinatario":{"type":"string"},"emailIdPerfil":{"type":"integer","format":"int32"},"emailNomeDestinatario":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"username":{"type":"string"},"password":{"type":"string"},"authorities":{"type":"array","items":{"$ref":"#/components/schemas/GrantedAuthority"}},"coreTagsPessoaFisica":{"type":"array","items":{"$ref":"#/components/schemas/TableEmailTag"}},"newObjectInCache":{"type":"boolean"},"usuario":{"$ref":"#/components/schemas/IUsuario"},"ignorarLog":{"type":"boolean"}}},"UsuarioSuporteBean":{"type":"object","properties":{"idUsuarioDirector":{"type":"integer","format":"int32"},"nome":{"type":"string"},"authToken":{"type":"string"},"dataLoginRemoto":{"type":"string","format":"date-time"}}},"RenovarBoletoDtoReq":{"required":["idTransacao"],"type":"object","properties":{"idTransacao":{"type":"integer","format":"int32"},"diasProrrogacaoVencimento":{"type":"integer","format":"int32"},"dataVencimento":{"type":"string","format":"date-time"},"isAplicarEncargosNaRenovacao":{"type":"boolean"}}},"BoletoContentRest":{"type":"object","properties":{"dataVencimento":{"type":"string"},"nomeSacado":{"type":"string"},"cpfSacado":{"type":"string"},"cnpjSacado":{"type":"string"},"enderecoSacado":{"type":"string"},"cepSacado":{"type":"string"},"bairroSacado":{"type":"string"},"cidadeSacado":{"type":"string"},"ufSacado":{"type":"string"},"curso":{"type":"string"},"motivoTransacao":{"type":"string"},"tipoReferenciaTransacao":{"type":"string"},"infoComplementar2":{"type":"string"},"instrucao1":{"type":"string"},"instrucao2":{"type":"string"},"instrucao3":{"type":"string"},"instrucao4":{"type":"string"},"instrucao5":{"type":"string"},"noDocumento":{"type":"string"},"dataDocumento":{"type":"string"},"especieDocumento":{"type":"string"},"aceite":{"type":"string"},"dataProcessamento":{"type":"string"},"carteiraFormatted":{"type":"string"},"valorBoletoFormatted":{"type":"string"},"cedente":{"type":"string"},"codigoCedente":{"type":"string"},"localPagamento":{"type":"string"},"bancoFormatted":{"type":"string"},"agenciaCedenteFormatted":{"type":"string"},"nossoNumeroFormatted":{"type":"string"},"linhaDigitavelFormatted":{"type":"string"},"codigoBarras":{"type":"string"},"unidadeCedente":{"type":"string"},"enderecoCedente":{"type":"string"},"ufEnderecoCedente":{"type":"string"},"cepEnderecoCedente":{"type":"string"},"cnpjCedente":{"type":"string"},"localPagamento2":{"type":"string"},"idBoleto":{"type":"integer","format":"int32"},"ignorarLog":{"type":"boolean"}}},"BoletoRest":{"type":"object","properties":{"idBoleto":{"type":"integer","format":"int32"},"nossoNumero":{"type":"string"},"status":{"type":"string"},"idPagador":{"type":"integer","format":"int32"},"pagadorNome":{"type":"string"},"idMetodoRecebimento":{"type":"integer","format":"int32"},"idAgencia":{"type":"integer","format":"int32"},"idAgenciaConta":{"type":"integer","format":"int32"},"metodoRecebimento":{"type":"string"},"agencia":{"type":"string"},"conta":{"type":"string"},"codigoCedente":{"type":"string"},"cedente":{"type":"string"},"carteira":{"type":"string"},"unidadeCedente":{"type":"string"},"content":{"$ref":"#/components/schemas/BoletoContentRest"},"idOrg":{"type":"integer","format":"int32"},"orgDescricao":{"type":"string"},"ignorarLog":{"type":"boolean"}}},"PageCursor":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"idCursor":{"type":"integer","format":"int32"},"idCursorProximo":{"type":"integer","format":"int32"}}},"PaginationPlanoContaDtoResPageCursor":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/PageCursor"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/PlanoContaDtoRes"}}}},"PaginationTransacaoAcademicoDtoResPageCursor":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/PageCursor"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/TransacaoAcademicoDtoRes"}}}},"TransacaoAcademicoDtoRes":{"type":"object","properties":{"idTransacao":{"type":"integer","format":"int32"},"transacaoIdReferencia":{"type":"integer","format":"int32"},"transacaoTipoReferencia":{"type":"string"},"transacaoDataVencimento":{"type":"string","format":"date-time"},"transacaoDataCompetencia":{"type":"string","format":"date-time"},"transacaoDataEmissao":{"type":"string","format":"date-time"},"transacaoValorOriginal":{"type":"number","format":"double"},"transacaoValor":{"type":"number","format":"double"},"transacaoConveniosValor":{"type":"number","format":"double"},"transacaoPlanosContas":{"type":"string"},"transacaoPlanosContasIds":{"type":"string"},"transacaoSituacao":{"type":"string"},"transacaoParcela":{"type":"string"},"transacaoIdBoleto":{"type":"integer","format":"int32"},"transacaoBoletoStatus":{"type":"string"},"transacaoBoletoNossoNumero":{"type":"string"},"transacaoBoletoNossoNumeroDigitoVerificador":{"type":"string"},"transacaoBoletoLiberadoWeb":{"type":"integer","format":"int32"},"transacaoOrigem":{"type":"string"},"transacaoRecebimentosCartao":{"type":"string"},"pagadorNome":{"type":"string"},"pagadorCpfCnpj":{"type":"string"},"pagadorPassaporte":{"type":"string"},"pagadorTipoPessoa":{"type":"string"},"pagadorRg":{"type":"string"},"pagadorInscricaoEstadual":{"type":"string"},"pagadorDataNascimento":{"type":"string","format":"date-time"},"pagadorIdPagador":{"type":"integer","format":"int32"},"pagadorLogradouro":{"type":"string"},"pagadorBairro":{"type":"string"},"pagadorLogradouroNumero":{"type":"string"},"pagadorCep":{"type":"string"},"pagadorLogradouroComplemento":{"type":"string"},"pagadorLogradouroCidade":{"type":"string"},"pagadorLogradouroUf":{"type":"string"},"pagadorLogradouroCidadeCodIbge":{"type":"string"},"pagadorEmail":{"type":"string"},"pagadorTelefone":{"type":"string"},"pagadorTelefoneComercial":{"type":"string"},"pagadorCelular":{"type":"string"},"respNome":{"type":"string"},"respCpfCnpj":{"type":"string"},"respPassaporte":{"type":"string"},"respTipoPessoa":{"type":"string"},"respRg":{"type":"string"},"respInscricaoEstadual":{"type":"string"},"respDataNascimento":{"type":"string","format":"date-time"},"respIdPagador":{"type":"integer","format":"int32"},"respLogradouro":{"type":"string"},"respBairro":{"type":"string"},"respLogradouroNumero":{"type":"string"},"respCep":{"type":"string"},"respLogradouroComplemento":{"type":"string"},"respLogradouroCidade":{"type":"string"},"respLogradouroUf":{"type":"string"},"respLogradouroCidadeCodIbge":{"type":"string"},"respEmail":{"type":"string"},"respTelefone":{"type":"string"},"respTelefoneComercial":{"type":"string"},"respCelular":{"type":"string"},"alunoIdAluno":{"type":"integer","format":"int32"},"alunoRa":{"type":"string"},"curso":{"type":"string"},"cursoIdCurso":{"type":"integer","format":"int32"},"matriz":{"type":"string"},"matrizIdMatriz":{"type":"integer","format":"int32"},"turma":{"type":"string"},"turmaNomeReduzido":{"type":"string"},"turmaNomePeriodoCurso":{"type":"string"},"turmaIdTurma":{"type":"integer","format":"int32"},"periodoLetivo":{"type":"string"},"periodoLetivoIdPeriodoLetivo":{"type":"integer","format":"int32"},"matriculaIdContrato":{"type":"integer","format":"int32"},"matriculaIdMatricula":{"type":"integer","format":"int32"},"matriculaIdAlunoCursoIngresso":{"type":"integer","format":"int32"},"matriculaStatus":{"type":"string"},"matriculaPlanoPagamento":{"type":"string"},"matriculaIdPlanoPagamento":{"type":"integer","format":"int32"},"matriculaDataMatricula":{"type":"string","format":"date-time"},"matriculaCursoIngressoUnidadeFisicaNome":{"type":"string"},"matriculaCursoIngressoUnidadeFisicaCodigo":{"type":"integer","format":"int32"},"idOrg":{"type":"integer","format":"int32"},"orgDescricao":{"type":"string"},"itens":{"type":"array","items":{"$ref":"#/components/schemas/TransacaoItemRest"}},"convenios":{"type":"array","items":{"$ref":"#/components/schemas/TransacaoConvenioAplicadoRest"}},"recebimentosCartao":{"type":"array","items":{"$ref":"#/components/schemas/TransacaoPagamentoCartaoGatewayRest"}},"dataCriacao":{"type":"string","format":"date-time"},"dataAlteracao":{"type":"string","format":"date-time"}}},"TransacaoConvenioAplicadoRest":{"type":"object","properties":{"idConvenio":{"type":"integer","format":"int32"},"descricao":{"type":"string"},"valor":{"type":"number","format":"double"},"tipo":{"type":"string"},"perdeAposVencimento":{"type":"integer","format":"int32"}}},"PaginationTransacaoRecebimentoDtoResPageCursor":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/PageCursor"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/TransacaoRecebimentoDtoRes"}}}},"PaginationTransacaoNfseDtoResPageCursor":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/PageCursor"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/TransacaoNfseDtoRes"}}}},"TransacaoNfseDtoRes":{"type":"object","properties":{"idNotaFiscalTransacao":{"type":"integer","format":"int32"},"idNotaFiscal":{"type":"integer","format":"int32"},"idTransacao":{"type":"integer","format":"int32"},"idUsuarioEmissao":{"type":"integer","format":"int32"},"nfseStatus":{"type":"string"},"discriminacaoServico":{"type":"string"},"numero":{"type":"string"},"codigoAutenticidade":{"type":"string"},"lote":{"type":"string"},"idLote":{"type":"string"},"idRps":{"type":"string"},"numeroRps":{"type":"string"},"dataCompetencia":{"type":"string","format":"date-time"},"dataEmissao":{"type":"string","format":"date-time"},"dataAutorizacao":{"type":"string","format":"date-time"},"idNotaFiscalServico":{"type":"integer","format":"int32"},"aliquotaIss":{"type":"number","format":"double"},"aliquota":{"type":"number","format":"double"},"baseCalculoFatorDeducao":{"type":"number","format":"double"},"baseCalculoPercentualReducao":{"type":"number","format":"double"},"valorServicos":{"type":"number","format":"double"},"valorDeducoes":{"type":"number","format":"double"},"valorBaseCalculo":{"type":"number","format":"double"},"valorDescontoIncondicionado":{"type":"number","format":"double"},"valorDescontoCondicionado":{"type":"number","format":"double"},"valorIss":{"type":"number","format":"double"},"valorIssRetido":{"type":"number","format":"double"},"valorEncagosRecebidosTransacao":{"type":"number","format":"double"},"valorDescontosConcedidosTransacao":{"type":"number","format":"double"},"idPerfilTomador":{"type":"integer","format":"int32"},"usuarioEmissao":{"type":"string"},"tomadorNome":{"type":"string"},"tomadorTipoPessoa":{"type":"string"},"tomadorCpfCnpj":{"type":"string"},"transacaoPagadorNome":{"type":"string"},"transacaoRespNome":{"type":"string"},"transacaoDataVencimento":{"type":"string","format":"date-time"},"transacaoValorOriginal":{"type":"number","format":"double"},"transacaoValor":{"type":"number","format":"double"},"idOrg":{"type":"integer","format":"int32"},"orgDescricao":{"type":"string"},"servicoDescricao":{"type":"string"},"servicoCodigoItemListaServico":{"type":"string"},"servicoCodigoSubItemListaServico":{"type":"string"},"servicoCodigoCnae":{"type":"string"},"servicoCodigoTributacaoMunicipio":{"type":"string"},"servicoTipoTributacao":{"type":"integer","format":"int32"},"servicoIssRetido":{"type":"integer","format":"int32"},"servicoExigibilidadeIss":{"type":"integer","format":"int32"},"servicoNaturezaTributacao":{"type":"integer","format":"int32"}}},"PaginationTransacaoBaixaDtoResPageCursor":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/PageCursor"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/TransacaoBaixaDtoRes"}}}},"PaginationCentroCustoDtoResPageCursor":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/PageCursor"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/CentroCustoDtoRes"}}}},"Page":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"currentPage":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"},"ignoreFetching":{"type":"boolean"}}},"PaginationVendedorDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/VendedorDtoRes"}}}},"VendedorDtoRes":{"type":"object","properties":{"idVendedor":{"type":"integer","format":"int32"},"idPerfil":{"type":"integer","format":"int32"},"idFuncao":{"type":"integer","format":"int32"},"status":{"type":"string"},"nome":{"type":"string"},"cpf":{"type":"string"},"email":{"type":"string"},"fone":{"type":"string"},"celular":{"type":"string"},"funcao":{"type":"string"},"numeroBanco":{"type":"string"},"numeroAgencia":{"type":"string"},"numeroConta":{"type":"string"},"codigoVendedor":{"type":"string"}}},"PaginationPixGatewayDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/PixGatewayDtoRes"}}}},"PixGatewayDtoRes":{"type":"object","properties":{"idPixGateway":{"type":"integer","format":"int32"},"gateway":{"type":"string"},"descricao":{"type":"string"}}},"PaginationRetencaoFinanceiraDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/RetencaoFinanceiraDtoRes"}}}},"PaginationTipoRecebimentoDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/TipoRecebimentoDtoRes"}}}},"TipoRecebimentoDtoRes":{"type":"object","properties":{"idTipoRecebimento":{"type":"integer","format":"int32"},"descricao":{"type":"string"},"status":{"type":"string"},"tipoRecebimento":{"type":"string"},"tipoCredito":{"type":"string"},"taxa":{"type":"number","format":"double"},"maximoParcelas":{"type":"integer","format":"int32"},"nrParcelasAdicionaisInadimplencia":{"type":"integer","format":"int32"},"diasCarencia":{"type":"integer","format":"int32"},"diaRecebimento":{"type":"integer","format":"int32"},"diaPagamento":{"type":"integer","format":"int32"},"diaFechamentoFatura":{"type":"integer","format":"int32"},"idAgenciaConta":{"type":"integer","format":"int32"},"idCliente":{"type":"integer","format":"int32"},"isCartao":{"type":"integer","format":"int32"},"get_agenciaConta":{"type":"string"}}},"PlanoPagamentoParcelaRest":{"type":"object","properties":{"idPlanoPagamentoParcela":{"type":"integer","format":"int32"},"idPlanoPagamento":{"type":"integer","format":"int32"},"parcela":{"type":"string"},"dataVencimento":{"type":"string","format":"date-time"},"valor":{"type":"number","format":"double"},"aplicarDescontos":{"type":"integer","format":"int32"},"aplicarConvenios":{"type":"integer","format":"int32"},"gerar":{"type":"integer","format":"int32"},"vectoVariavelNrDias":{"type":"integer","format":"int32"},"ignorarCalculoContrato":{"type":"integer","format":"int32"},"grupo":{"type":"string"},"ignorarLog":{"type":"boolean"}}},"PlanoPagamentoRest":{"type":"object","properties":{"idPlanoPagamento":{"type":"integer","format":"int32"},"descricao":{"type":"string"},"status":{"type":"string"},"observacao":{"type":"string"},"bloquearEdicaoServicos":{"type":"integer","format":"int32"},"permitirInformarDataPrimeiraParcela":{"type":"integer","format":"int32"},"recalcularParcelasComBaseNaPrimeiraParcela":{"type":"integer","format":"int32"},"validarFlagGerarNasParcelas":{"type":"integer","format":"int32"},"ajusteDatasParcelasDinamica":{"type":"integer","format":"int32"},"usaDiasPreferenciaisVencimento":{"type":"integer","format":"int32"},"utilizarDescontoMaximoTabelaPreco":{"type":"integer","format":"int32"},"utilizarValorTabelaPreco":{"type":"integer","format":"int32"},"vigenciaContratoTempo":{"type":"integer","format":"int32"},"vigenciaContratoTipoInicio":{"type":"string"},"permitirProrrogacaoContrato":{"type":"integer","format":"int32"},"idOrg":{"type":"integer","format":"int32"},"orgDescricao":{"type":"string"},"servicos":{"type":"array","items":{"$ref":"#/components/schemas/PlanoPagamentoServicoRest"}},"parcelas":{"type":"array","items":{"$ref":"#/components/schemas/PlanoPagamentoParcelaRest"}},"turma":{"$ref":"#/components/schemas/TurmaRest"},"ignorarLog":{"type":"boolean"}}},"PlanoPagamentoServicoRest":{"type":"object","properties":{"idPlanoPagamentoServico":{"type":"integer","format":"int32"},"idPlanoPagamento":{"type":"integer","format":"int32"},"idServico":{"type":"integer","format":"int32"},"diaInicio":{"type":"integer","format":"int32"},"mesInicio":{"type":"integer","format":"int32"},"anoInicio":{"type":"integer","format":"int32"},"numeroParcelas":{"type":"integer","format":"int32"},"servicoAdicional":{"type":"integer","format":"int32"},"valor":{"type":"number","format":"double"},"taxa":{"type":"integer","format":"int32"},"contrato":{"type":"integer","format":"int32"},"separar":{"type":"integer","format":"int32"},"calculadoContrato":{"type":"integer","format":"int32"},"grupo":{"type":"string"},"servicoDescricao":{"type":"string"},"servicoPlanoContaDescricao":{"type":"string"},"servicoPlanoContaCodigo":{"type":"string"},"ignorarLog":{"type":"boolean"}}},"TurmaRest":{"type":"object","properties":{"idTurma":{"type":"integer","format":"int32"},"turmaNome":{"type":"string"},"turmaNomeRed":{"type":"string"},"turmaDescricao":{"type":"string"},"turmaIdUnidadeFisica":{"type":"integer","format":"int32"},"turmaUnidadeFisica":{"type":"string"},"turmaIdPeriodoLetivo":{"type":"integer","format":"int32"},"turmaPeriodoLetivo":{"type":"string"},"turmaPeriodoLetivoSituacao":{"type":"string"},"turmaPeriodoLetivoDataInicio":{"type":"string","format":"date-time"},"turmaPeriodoLetivoDataTermino":{"type":"string","format":"date-time"},"turmaIdMatriz":{"type":"integer","format":"int32"},"turmaMatriz":{"type":"string"},"turmaIdCurso":{"type":"integer","format":"int32"},"turmaCurso":{"type":"string"},"turmaIdTurmaDestino":{"type":"integer","format":"int32"},"turmaTurmaDestinoNome":{"type":"string"},"turmaTurmaDestinoNomeRed":{"type":"string"},"turmaTurmaDestinoPeriodoLetivo":{"type":"string"},"turmaPeriodoItem":{"type":"string"},"turmaTurno":{"type":"string"},"turmaIdInep":{"type":"integer","format":"int32"},"turmaMediaMin":{"type":"number","format":"double"},"turmaMediaNormal":{"type":"number","format":"double"},"turmaFrequencia":{"type":"number","format":"double"},"turmaRecMedMin":{"type":"number","format":"double"},"turmaMedNormal":{"type":"number","format":"double"},"turmaNotaMenor":{"type":"number","format":"double"},"turmaNotaMaior":{"type":"number","format":"double"},"turmaIdTurmaBase":{"type":"integer","format":"int32"},"turmaTurmaBase":{"type":"string"},"turmaStatus":{"type":"string"},"turmaDataInicio":{"type":"string","format":"date-time"},"turmaDataFim":{"type":"string","format":"date-time"},"turmaDataAbonoFalta":{"type":"string","format":"date-time"},"turmaDataFechamentoDiarioClasse":{"type":"string","format":"date-time"},"turmaValorTotal":{"type":"number","format":"double"},"turmaObservacao":{"type":"string"},"turmaQtdeDisciplina":{"type":"integer","format":"int32"},"idOrg":{"type":"integer","format":"int32"},"orgDescricao":{"type":"string"},"turmaIdMetodoRecebimento":{"type":"integer","format":"int32"},"turmaMetodoRecebimento":{"type":"string"},"habilitadoVenda":{"type":"integer","format":"int32"},"turmaCalendarioRotativoSegunda":{"type":"integer","format":"int32"},"turmaCalendarioRotativoTerca":{"type":"integer","format":"int32"},"turmaCalendarioRotativoQuarta":{"type":"integer","format":"int32"},"turmaCalendarioRotativoQuinta":{"type":"integer","format":"int32"},"turmaCalendarioRotativoSexta":{"type":"integer","format":"int32"},"turmaCalendarioRotativoSabado":{"type":"integer","format":"int32"},"turmaCalendarioRotativoDomingo":{"type":"integer","format":"int32"},"turmaCalendarioRotativoTurmaFechada":{"type":"integer","format":"int32"},"disponivelParaMatriculaOnline":{"type":"integer","format":"int32"},"disponivelParaMatriculaOnlineProcessoSeletivo":{"type":"integer","format":"int32"},"ignorarLog":{"type":"boolean"}}},"PaginationUnidadeFisicaPlanoPagamentoRestPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/UnidadeFisicaPlanoPagamentoRest"}}}},"UnidadeFisicaPlanoPagamentoRest":{"type":"object","properties":{"idUnidadeFisica":{"type":"integer","format":"int32"},"nome":{"type":"string"},"nomeImpressao":{"type":"string"},"sigla":{"type":"string"},"logradouro":{"type":"string"},"numero":{"type":"string"},"bairro":{"type":"string"},"cep":{"type":"string"},"email":{"type":"string"},"cnpj":{"type":"string"},"fones":{"type":"string"},"idCidade":{"type":"integer","format":"int32"},"idEstado":{"type":"integer","format":"int32"},"status":{"type":"string"},"dataAtivacao":{"type":"string","format":"date-time"},"dataInativacao":{"type":"string","format":"date-time"},"codigoInep":{"type":"integer","format":"int32"},"nomeCidade":{"type":"string"},"siglaEstado":{"type":"string"},"nomeEstado":{"type":"string"},"responsavelNome":{"type":"string"},"responsavelTelefone":{"type":"string"},"responsavelCelular":{"type":"string"},"responsavelEmail":{"type":"string"},"idPerfilResponsavel":{"type":"integer","format":"int32"},"naoApresentarNoFormularioAtendimento":{"type":"integer","format":"int32"},"naoApresentarNaRematriculaWeb":{"type":"integer","format":"int32"},"naoApresentarGestaoDePolos":{"type":"integer","format":"int32"},"naoApresentarProcessoSeletivo":{"type":"integer","format":"int32"},"naoApresentarECourse":{"type":"integer","format":"int32"},"complemento":{"type":"string"},"tipoUnidade":{"type":"string"},"observacaoHorarioAtendimento":{"type":"string"},"ignorarLog":{"type":"boolean"}}},"PaginationTurmaRestPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/TurmaRest"}}}},"CursoRest":{"type":"object","properties":{"idCurso":{"type":"integer","format":"int32"},"idCursoBase":{"type":"integer","format":"int32"},"nome":{"type":"string"},"nomeRed":{"type":"string"},"prazoConclusao":{"type":"integer","format":"int32"},"enfase":{"type":"string"},"modalidade":{"type":"string"},"horasAtividade":{"type":"integer","format":"int32"},"tipoAtividade":{"type":"string"},"mediaMin":{"type":"number","format":"double"},"mediaNormal":{"type":"number","format":"double"},"frequencia":{"type":"number","format":"double"},"recMedMin":{"type":"number","format":"double"},"recMedNormal":{"type":"number","format":"double"},"notaMenor":{"type":"number","format":"double"},"notaMaior":{"type":"number","format":"double"},"cargaHoraria":{"type":"string"},"cargaHorariaTeorica":{"type":"string"},"cargaHorariaPratica":{"type":"string"},"cargaHorariaEstagio":{"type":"string"},"prazoEm":{"type":"string"},"podeTrancarPrimeiroPeriodo":{"type":"integer","format":"int32"},"prazoMaximoConclusao":{"type":"integer","format":"int32"},"habilidadesCompetencias":{"type":"string"},"creditosExigidos":{"type":"number","format":"double"},"idInep":{"type":"integer","format":"int32"},"idEixoTecnologico":{"type":"integer","format":"int32"},"eixoTecnologicoDescricao":{"type":"string"},"descricao":{"type":"string"},"tema":{"type":"string"},"tipoCalculoFrequencia":{"type":"string"},"periodicidade":{"type":"string"},"status":{"type":"string"},"naoApresentarParaUsuarioPolo":{"type":"integer","format":"int32"},"cargaHorariaTcc":{"type":"string"},"idProfessorCoordenador":{"type":"integer","format":"int32"},"professorCoordenadorNome":{"type":"string"},"qtdeMaximaVagas":{"type":"integer","format":"int32"},"grauGraduacao":{"type":"string"},"idGrauGraduacao":{"type":"integer","format":"int32"},"idOrg":{"type":"integer","format":"int32"},"orgDescricao":{"type":"string"},"ignorarLog":{"type":"boolean"}}},"PaginationCursoRestPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/CursoRest"}}}},"TabelaPrecoCursoWrapper":{"type":"object","properties":{"idTabelaPreco":{"type":"integer","format":"int32"},"descricao":{"type":"string"},"valor":{"type":"number","format":"double"},"valorMatutino":{"type":"number","format":"double"},"valorVespertino":{"type":"number","format":"double"},"valorNoturno":{"type":"number","format":"double"},"valorIntegral":{"type":"number","format":"double"},"valorEad":{"type":"number","format":"double"},"descontoMaximo":{"type":"number","format":"double"},"descontoFixo":{"type":"number","format":"double"},"dataInicio":{"type":"string","format":"date-time"},"dataTermino":{"type":"string","format":"date-time"},"ignorarLog":{"type":"boolean"}}},"PaginationTabelaPrecoDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/TabelaPrecoDtoRes"}}}},"TabelaPrecoCursoRest":{"type":"object","properties":{"idCursoBase":{"type":"integer","format":"int32"},"descontoMaximo":{"type":"number","format":"double"},"valor":{"type":"number","format":"double"},"cursoBaseNomeParaImpressao":{"type":"string"},"idOrg":{"type":"integer","format":"int32"},"orgDescricao":{"type":"string"},"unidades":{"type":"array","items":{"$ref":"#/components/schemas/TabelaPrecoCursoUnidadeRest"}},"ignorarLog":{"type":"boolean"}}},"TabelaPrecoCursoUnidadeRest":{"type":"object","properties":{"idUnidadeFisica":{"type":"integer","format":"int32"},"idCursoBase":{"type":"integer","format":"int32"},"descontoMaximo":{"type":"number","format":"double"},"valor":{"type":"number","format":"double"},"unidadeFisica":{"type":"string"},"ignorarLog":{"type":"boolean"}}},"TabelaPrecoDtoRes":{"type":"object","properties":{"idTabelaPreco":{"type":"integer","format":"int32"},"descricao":{"type":"string"},"dataInicio":{"type":"string","format":"date-time"},"dataTermino":{"type":"string","format":"date-time"},"status":{"type":"string"},"cursos":{"type":"array","items":{"$ref":"#/components/schemas/TabelaPrecoCursoRest"}}}},"PaginationPlanoContaDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/PlanoContaDtoRes"}}}},"CupomDescontoDtoRes":{"type":"object","properties":{"idCupomDesconto":{"type":"integer","format":"int32"},"codigoCupom":{"type":"string"},"qtdMaxima":{"type":"integer","format":"int32"},"qtdUtilizada":{"type":"integer","format":"int32"},"status":{"type":"string"},"valor":{"type":"number","format":"double"},"tipo":{"type":"string"},"idConvenio":{"type":"integer","format":"int32"},"convenio":{"type":"string"},"idPeriodoLetivo":{"type":"integer","format":"int32"},"periodoLetivo":{"type":"string"}}},"PaginationCupomDescontoDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/CupomDescontoDtoRes"}}}},"ConvenioDtoRes":{"type":"object","properties":{"idConvenio":{"type":"integer","format":"int32"},"idPlanoConta":{"type":"integer","format":"int32"},"descricao":{"type":"string"},"status":{"type":"string"},"perdeAposVencimento":{"type":"integer","format":"int32"},"calculoSobValorOriginal":{"type":"integer","format":"int32"},"tipo":{"type":"string"},"valor":{"type":"number","format":"double"},"idEmpresa":{"type":"integer","format":"int32"},"tipoLimiteValidade":{"type":"string"},"diaLimite":{"type":"integer","format":"int32"},"tipoVencimento":{"type":"string"},"tipoFinanciamento":{"type":"string"},"apresentaDescricaoInstrucaoBancaria":{"type":"integer","format":"int32"},"instrucaoBancaria":{"type":"string"},"deduzirValorOriginal":{"type":"integer","format":"int32"},"considerarSabadosComoDiaUtil":{"type":"integer","format":"int32"},"aplicarSobReembolsoConvenio":{"type":"integer","format":"int32"},"dataVigenciaInicio":{"type":"string","format":"date-time"},"dataVigenciaTermino":{"type":"string","format":"date-time"},"naoParticipaCenso":{"type":"integer","format":"int32"},"descontoIrmao":{"type":"integer","format":"int32"},"programaFinanciamentoCodigo":{"type":"integer","format":"int32"},"programaFinanciamentoDescricao":{"type":"string"},"planoContaDescricao":{"type":"string"},"planoContaCodigo":{"type":"string"},"convenioEmpresaNome":{"type":"string"},"convenioEmpresaCnpj":{"type":"string"}}},"PaginationConvenioDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/ConvenioDtoRes"}}}},"ConvenioPagadorDtoRes":{"type":"object","properties":{"idConvenioPagador":{"type":"integer","format":"int32"},"alunoIdAluno":{"type":"integer","format":"int32"},"alunoRa":{"type":"string"},"alunoNome":{"type":"string"},"idConvenio":{"type":"integer","format":"int32"},"convenioDescricao":{"type":"string"},"convenioTipoFinanciamento":{"type":"string"},"convenioIdEmpresa":{"type":"integer","format":"int32"},"convenioEmpresaNome":{"type":"string"},"convenioEmpresaCnpj":{"type":"string"},"ordem":{"type":"integer","format":"int32"},"valor":{"type":"number","format":"double"},"tipoCalculo":{"type":"string"},"dataInicio":{"type":"string","format":"date-time"},"dataFim":{"type":"string","format":"date-time"},"dataContratacaoConvenio":{"type":"string","format":"date-time"},"observacao":{"type":"string"},"status":{"type":"string"},"naoAplicarResponsavel":{"type":"integer","format":"int32"},"perdeAposVencimento":{"type":"integer","format":"int32"},"deduzirValorOriginal":{"type":"integer","format":"int32"},"idAlunoCursoIngresso":{"type":"integer","format":"int32"},"cursoIngressoMatriz":{"type":"string"},"cursoIngressoIdMatriz":{"type":"integer","format":"int32"},"idPeriodoLetivo":{"type":"integer","format":"int32"},"periodoLetivoDescricao":{"type":"string"},"idCursoBase":{"type":"integer","format":"int32"},"nomeCursoBase":{"type":"string"},"idOrg":{"type":"integer","format":"int32"},"orgDescricao":{"type":"string"}}},"PaginationConvenioPagadorDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/ConvenioPagadorDtoRes"}}}},"ContratoMatriculaDtoRes":{"type":"object","properties":{"idContrato":{"type":"integer","format":"int32"},"idPerfil":{"type":"integer","format":"int32"},"idAluno":{"type":"integer","format":"int32"},"idCurso":{"type":"integer","format":"int32"},"idCursoBase":{"type":"integer","format":"int32"},"idPeriodoLetivo":{"type":"integer","format":"int32"},"idTabelaPreco":{"type":"integer","format":"int32"},"idPlanoPagamento":{"type":"integer","format":"int32"},"status":{"type":"string"},"alunoNome":{"type":"string"},"alunoRa":{"type":"string"},"idMatricula":{"type":"integer","format":"int32"},"statusMatricula":{"type":"string"},"idTurma":{"type":"integer","format":"int32"},"turmaNome":{"type":"string"},"tabelaPreco":{"type":"string"},"idUnidadeFisica":{"type":"integer","format":"int32"},"planoPagamento":{"type":"string"},"unidadeFisica":{"type":"string"},"descontoConcedido":{"type":"number","format":"double"},"diaPreferencialVencimento":{"type":"integer","format":"int32"},"dataVigenciaInicio":{"type":"string","format":"date-time"},"dataVigenciaTermino":{"type":"string","format":"date-time"},"dataContrato":{"type":"string","format":"date-time"},"dataAceiteContrato":{"type":"string","format":"date-time"},"ipAceiteContrato":{"type":"string"},"idOrg":{"type":"integer","format":"int32"},"orgDescricao":{"type":"string"},"parcelas":{"type":"array","items":{"$ref":"#/components/schemas/ContratoMatriculaParcelaRest"}}}},"ContratoMatriculaParcelaRest":{"type":"object","properties":{"idContratoParcela":{"type":"integer","format":"int32"},"idContrato":{"type":"integer","format":"int32"},"parcela":{"type":"string"},"dataVencimento":{"type":"string","format":"date-time"},"valor":{"type":"number","format":"double"},"aplicarDescontos":{"type":"integer","format":"int32"},"aplicarConvenios":{"type":"integer","format":"int32"},"isParcelaAdicional":{"type":"integer","format":"int32"},"grupo":{"type":"string"},"ignorarCalculoContrato":{"type":"integer","format":"int32"},"gerar":{"type":"integer","format":"int32"},"ignorarLog":{"type":"boolean"}}},"PaginationContratoMatriculaDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/ContratoMatriculaDtoRes"}}}},"TransacaoDtoRes":{"type":"object","properties":{"idTransacao":{"type":"integer","format":"int32"},"valor":{"type":"number","format":"double"},"valorPago":{"type":"number","format":"double"},"situacao":{"type":"string"},"dataVencimento":{"type":"string","format":"date-time"},"dataPagamento":{"type":"string","format":"date-time"}}},"RenderContratoDtoReq":{"required":["formato","idContratoMatricula"],"type":"object","properties":{"idContratoMatricula":{"type":"integer","format":"int32"},"formato":{"pattern":"PDF|IMAGEM","type":"string"}}},"DocumentPdfImage":{"type":"object","properties":{"pages":{"type":"array","items":{"$ref":"#/components/schemas/DocumentPdfImagePage"}}}},"DocumentPdfImagePage":{"type":"object","properties":{"height":{"type":"integer","format":"int32"},"width":{"type":"integer","format":"int32"},"imageBase64":{"type":"string"}}},"ReportObjectWrapper":{"type":"object","properties":{"identificador":{"type":"string"},"fileContent":{"type":"array","items":{"type":"string","format":"byte"}},"fileName":{"type":"string"},"pdfImage":{"$ref":"#/components/schemas/DocumentPdfImage"}}},"ContratoParcelaDtoRes":{"type":"object","properties":{"idPlanoPagamentoParcela":{"type":"integer","format":"int32"},"parcela":{"type":"string"},"valorLiquido":{"type":"number","format":"double"},"valorConvenios":{"type":"number","format":"double"},"valorDescontos":{"type":"number","format":"double"},"grupo":{"type":"string"},"dataVencimento":{"type":"string","format":"date-time"},"dataCompetencia":{"type":"string","format":"date-time"}}},"AgenciaContaDtoRes":{"type":"object","properties":{"idAgenciaConta":{"type":"integer","format":"int32"},"nome":{"type":"string"},"numero":{"type":"string"},"dvConta":{"type":"string"},"tipoConta":{"type":"string"},"sequencialArquivoRemessa":{"type":"string"},"consolidado":{"type":"integer","format":"int32"},"bancoNumero":{"type":"string"},"bancoNome":{"type":"string"},"bancoCodigo":{"type":"integer","format":"int32"},"agenciaNumero":{"type":"string"},"agenciaDv":{"type":"string"},"agenciaNome":{"type":"string"},"agenciaCodigo":{"type":"integer","format":"int32"},"status":{"type":"string"}}},"PaginationAgenciaContaDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/AgenciaContaDtoRes"}}}},"PaginationTransacaoAcademicoDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/TransacaoAcademicoDtoRes"}}}},"PaginationTransacaoRecebimentoDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/TransacaoRecebimentoDtoRes"}}}},"PaginationTransacaoNfseDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/TransacaoNfseDtoRes"}}}},"PaginationTransacaoBaixaDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/TransacaoBaixaDtoRes"}}}},"PaginationCentroCustoDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/CentroCustoDtoRes"}}}},"CartaoCreditoGatewayDtoRes":{"type":"object","properties":{"idCartaoCreditoGateway":{"type":"integer","format":"int32"},"descricao":{"type":"string"},"adquirente":{"type":"string"}}},"CartaoCreditoDtoRes":{"type":"object","properties":{"idCartaoCredito":{"type":"integer","format":"int32"},"idPerfil":{"type":"integer","format":"int32"},"nomePerfil":{"type":"string"},"descricaoVisualCartao":{"type":"string"}}},"CaixaSaldoMovimentacaoDtoRes":{"type":"object","properties":{"idAgenciaConta":{"type":"integer","format":"int32"},"tipoMovimentacao":{"type":"string"},"valorEntradas":{"type":"number","format":"double"},"valorSaidas":{"type":"number","format":"double"},"valor":{"type":"number","format":"double"}}},"PaginationCaixaSaldoMovimentacaoDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/CaixaSaldoMovimentacaoDtoRes"}}}},"CaixaHistoricoDtoRes":{"type":"object","properties":{"idCaixaContaHistorico":{"type":"integer","format":"int32"},"idAgenciaConta":{"type":"integer","format":"int32"},"idUsuario":{"type":"integer","format":"int32"},"nomeUsuario":{"type":"string"},"descricaoConta":{"type":"string"},"dataCaixa":{"type":"string","format":"date-time"},"operacao":{"type":"string"},"saldoAnterior":{"type":"number","format":"double"},"depositos":{"type":"number","format":"double"},"entradas":{"type":"number","format":"double"},"saidas":{"type":"number","format":"double"},"saques":{"type":"number","format":"double"},"saldo":{"type":"number","format":"double"},"chequeSaldoAnterior":{"type":"number","format":"double"},"chequeDepositos":{"type":"number","format":"double"},"chequeEntradas":{"type":"number","format":"double"},"chequeSaques":{"type":"number","format":"double"},"chequeSaidas":{"type":"number","format":"double"},"chequeSaldoFinal":{"type":"number","format":"double"},"cartaoSaldoAnterior":{"type":"number","format":"double"},"cartaoDepositos":{"type":"number","format":"double"},"cartaoEntradas":{"type":"number","format":"double"},"cartaoSaques":{"type":"number","format":"double"},"cartaoSaidas":{"type":"number","format":"double"},"cartaoSaldoFinal":{"type":"number","format":"double"},"totalSaldoAnterior":{"type":"number","format":"double"},"totalDepositos":{"type":"number","format":"double"},"totalEntradas":{"type":"number","format":"double"},"totalSaques":{"type":"number","format":"double"},"totalSaidas":{"type":"number","format":"double"},"totalSaldoFinal":{"type":"number","format":"double"}}},"PaginationCaixaHistoricoDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/CaixaHistoricoDtoRes"}}}},"BoletoDtoRes":{"type":"object","properties":{"idBoleto":{"type":"integer","format":"int32"},"nossoNumero":{"type":"string"},"status":{"type":"string"},"idPagador":{"type":"integer","format":"int32"},"pagadorNome":{"type":"string"},"idMetodoRecebimento":{"type":"integer","format":"int32"},"idAgencia":{"type":"integer","format":"int32"},"idAgenciaConta":{"type":"integer","format":"int32"},"metodoRecebimento":{"type":"string"},"agencia":{"type":"string"},"conta":{"type":"string"},"codigoCedente":{"type":"string"},"cedente":{"type":"string"},"carteira":{"type":"string"},"unidadeCedente":{"type":"string"},"content":{"$ref":"#/components/schemas/BoletoContentRest"},"idOrg":{"type":"integer","format":"int32"},"orgDescricao":{"type":"string"}}},"PaginationBoletoDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/BoletoDtoRes"}}}},"LinkBoletoRest":{"type":"object","properties":{"url":{"type":"string"},"ignorarLog":{"type":"boolean"}}},"BoletoLinhaDigitavelDtoRes":{"type":"object","properties":{"linhaDigitavel":{"type":"string"}}},"PaginationTipoAcordoFinanceiroDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/TipoAcordoFinanceiroDtoRes"}}}},"TipoAcordoFinanceiroDtoRes":{"type":"object","properties":{"idTipoAcordoFinanceiro":{"type":"integer","format":"int32"},"descricao":{"type":"string"},"status":{"type":"string"},"get_org":{"type":"string"},"get_idOrg":{"type":"integer","format":"int32"}}}},"securitySchemes":{"Access Token":{"type":"apiKey","name":"Authorization","in":"header"}}}}