...
| API | Método | Rota | Documentação |
|---|---|---|---|
Cooperado - Extrato de Competências: Medico/ExtratoCompetencias | GET | /Medico/v1/ExtratoCompetencias | |
Cooperado - Extrato: Medico/Extrato | GET | /Medico/v1/Extrato | |
Cooperado - INSS: Medico/INSS | GET | /Medico/v1/INSS | |
Cooperado - Competências do INSS: Medico/INSSCompetencias | GET | /Medico/v1/INSSCompetencias | |
Cooperado - INSS em PDF: Medico/INSSPDF | GET | /Medico/v1/INSSPDF | |
Cooperado - Imposto de Renda Pessoa Física: Medico/IRPF | GET | /Medico/v1/IRPF | |
Cooperado - Imposto de Renda Pessoa Física Ano Base: Medico/IRPFAnoBase | GET | /Medico/v1/IRPFAnoBase | |
Cooperado - Imposto de Renda Pessoa Física PDF: Medico/IRPFPDF | GET | /Medico/v1/IRPFPDF | |
| Cooperado - Produção Médica: Medico/Producao | GET | /Medico/v1/Producao |
Algumas dessas APIs esperam receber alguns parâmetros via header ou via query parameters.As APIS aqui listadas recebem por parâmetro as informações pertinentes a rotina, todas elas recebem via Query Parameters
| API | Parâmetro | Tipo Parâmetro | Tipo de dados | Formato | Obrigatório? | ||||
|---|---|---|---|---|---|---|---|---|---|
| AutorizacoesPeriodoExtratodtInicio | X-Matricula | Query Parameter | string | dd/mm/aaaa | Sim | AutorizacoesPeriodo | 99999999 | Sim | |
| Extrato | competencia | Query Parameter | string | 99/9999 | Sim | ||||
| INSS | X-Matricula | Query Parameter | string | 99999999 | Sim | ||||
| INSS | competencia | Query Parameter | string | 99/9999 | Sim | ||||
| INSS PDF | X-Matricula | Query Parameter | string | 99999999 | Sim | ||||
| INSS PDF | competencia | dtFimQuery Parameter | stringstring | dd99/ | mm/aaaa9999 | Sim | |||
| DemonstrativoCoparticipacaoIRPFperiodoId | X-Matricula | Query Parameter | string | *99999999 | Sim | ||||
| IRPF | ano | Query Parameter | integerstring | 9999 | Sim | ||||
| IRPF PDF | X-Matricula | Query Parameter | string | 99999999 | Sim | ||||
| IRPF PDF | ano | SegundaViaBoleto | tituloId | Query Parameter | string | *9999 | Sim | ||
| Produção Médica | X-Matricula | Extrato | periodoId | Query Parameter | string | *99999999 | Sim |
* O formato desses valores é definido pelo retorno das APIs PeriodosDemonstrativoCoparticipacao e Títulos, que retornam os IDs utilizados para alimentar esses parâmetros.
Além desses parâmetros, todas as APIs exigem que seja informado ao menos um dos cabeçalhos abaixo no header da requisição:
| Produção Médica | dtInicio | Query Parameter | date | 99/99/9999 | Sim |
| Produção Médica | dtFim | Query Parameter | date | 99/99/9999 | Sim |
| Aviso | ||
|---|---|---|
| ||
Retorno: Status 200, "DebugMessage": "1 - Necessario informar a carteira ou CPF do beneficiario;\\n;" → Faltou adicionar o header X-CPF ou X-Carteira com o formato String Retorno: Status: 400, "detailMessage": "Method not found" → Pode ocorrer pois não foi especificado o formato do header X-CPF ou X-Carteira Retorno: Status 404 → Revisar a URL que está sendo chamada. |
...
