Histórico da Página
Swagger
Informações |
---|
Esta API está em desenvolvimento, o documento irá ser atualizado para refletir os endpoints desenvolvidos |
Especificação atualizada de API Rating em padrão Swagger (ultima atualização 29/08):
View file | ||||
---|---|---|---|---|
|
Para visualizar a documentação acessar a URL https://editor-next.swagger.io/, importar o arquivo no menu File>Import File.
Informações |
---|
Todos os endpoint tem limites de itens a serem enviados por chamada. Descrito melhor em RT - Rating - API Assíncrona |
Comandada - Cálculo provisões
Endpoint: /calculo-provisao/{cd_emp}/{dt_mov} (YYYYMM)
QueryString: ?tipo_comandada=(O|C|G)
Método: POST
Content Type: application/json
Corpo
Bloco de código | ||
---|---|---|
| ||
[{ // CAMPO CONDICIONAL - Somente tipo_comandada = O - Contrato "cdIpoc": "136524165s4dfsdfs685g7s", // CAMPO CONDICIONAL - Somente tipo_comandada = C - Cliente "cnpjCliente": "98787744000100", // CAMPO CONDICIONAL - Somente tipo_comandada = G - Grupo "siglaGrupoEconomico": "string", "estagio": "st", // Estágio - Valores (1|2|3) "carteiraProvisao": "st", //Carteira Provisão - Valores (C1|C2|C3|C4|C5) "ativoProblematico": "s", // Ativo Prob "tratamentoRisco": "s", // Tratamento Risco "percentualPd": 0, // (0.1% = 0.001 / 1% = 0.01 / 100% = 1.00) "percentualLgd": 0, // (0.1% = 0.001 / 1% = 0.01 / 100% = 1.00) "valorPerdaEsperada": 0, "valorPerdaIncorrida": 0, "valorPerdaAdicional": 0, "categoriaContabil": "st" }, .... // Demais elementos ] |
Retornos
202 - Aceito: Processamento assíncrono Iniciado
Content Type: text/plain
Corpo (GUID de requisição). Exemplo
Bloco de código |
---|
3fa9ff31-812d-47ab-836a-00641e990f7c |
40X - Erro: Requisição
Content Type: application/json
Corpo:
Bloco de código | ||
---|---|---|
| ||
{ "status": 0, "error": "string", "message": "string" } |
500 - Erro Interno
Content Type: application/json
Corpo:
Bloco de código | ||
---|---|---|
| ||
{ "status": 0, "error": "string", "message": "string" } |
Motivo Perda
Endpoint: /motivo-perda/{cd_emp}/{dt_mov} (YYYYMM)
Método: POST
Content Type: application/json
Corpo:
Bloco de código | ||
---|---|---|
| ||
[ { "siglaInterface": "CF", "codigoMotivoPerda": "01", "valorMotivoPerda": 0, "ipoc": "136524165s4dfsdfs685g7s" } ] |
Retornos
202 - Aceito: Processamento assíncrono Iniciado
Content Type: text/plain
Corpo (GUID de requisição). Exemplo
Bloco de código |
---|
3fa9ff31-812d-47ab-836a-00641e990f7c |
40X - Erro: Requisição
Content Type: application/json
Corpo:
Bloco de código | ||
---|---|---|
| ||
{ "status": 0, "error": "string", "message": "string" } |
500 - Erro Interno
Content Type: application/json
Corpo:
Bloco de código | ||
---|---|---|
| ||
{ "status": 0, "error": "string", "message": "string" } |
Motivo Alocação
Endpoint: /motivo-alocacao/{cd_emp}/{dt_mov} (YYYYMM)
Método: POST
Content Type: application/json
Corpo:
Bloco de código | ||
---|---|---|
| ||
[ { "siglaInterface": "CF", "codigoMotivoAlocacao": "stri", "dataBaseAlocacao": "string", "codigoIpoc": "136524165s4dfsdfs685g7s", "descricaoOrigem": "string" } ] |
Retornos
202 - Aceito: Processamento assíncrono Iniciado
Content Type: text/plain
Corpo (GUID de requisição). Exemplo
Bloco de código |
---|
3fa9ff31-812d-47ab-836a-00641e990f7c |
40X - Erro: Requisição
Content Type: application/json
Corpo:
Bloco de código | ||
---|---|---|
| ||
{ "status": 0, "error": "string", "message": "string" } |
500 - Erro Interno
Content Type: application/json
Corpo:
Bloco de código | ||
---|---|---|
| ||
{ "status": 0, "error": "string", "message": "string" } |
Nota |
---|
O endpoint de garantia ainda está em desenvolvimento e está previsto para uma próxima entrega |
Garantia
Endpoint: /garantia/{cd_emp}/{dt_mov} (YYYYMM)
Método: POST (Inclusão de registros) / PUT (Complemento de registros)
Content Type: application/json
Corpo
Bloco de código | ||
---|---|---|
| ||
[{ "siglaInterface": "CF", // Sigla da interface geradora do arquivo NCRCF "numSequenciaGarantia": 1, // Número sequencial de garantia por operação "numSequenciaRegistro": 1, // Número sequencial de garantia por documento "codigoUnidadeOperacao": "1", // Código de unidade da operação "numCic": "00000432145678", // Número do CPF ou CNPJ do cliente "tipoPessoa": "F", // Indicador do tipo de pessoa - Valores ('F' ou 'J') "codigoTipoPessoa": "10000", // Código Tipo de pessoa "codigoTipoControlador": "01", // Código do tipo de controlador "codigoCliente": "1", // Código identificador do cliente "siglaModalidadeOperacao": "DSAGRFIP", // Sigla de modalidade da operação "numIdentificadorContrato": "2023000686", // Número de identificador do contrato "numAdesaoLiberacao": "000", // Número da Adesão ou liberação da operação "siglaIndicadorOperacao": "REAIS", // Sigla de indicador da operação "codigoTaxaReferencial": "00", // Código da taxa de referencial "codigoVariacaoCambial": "000", // Código da Variacão Cambial "codigoFaixaValorOperacao": "000", // Código da Faixa de Valor da Operacão "codigoTipoGarantia": "423", // Código do tipo da garantia "valorGarantia": "000", // Valor da Garantia "dataUltimaAvaliacaoGarantia": "00000000", // Data da ultima avaliação da garantia "codigoTipoPessoaGarantia": "1", // Código do tipo de pessoa por garantia "numCicGarantia": "00000908262132", // Número Cic da garantia "identificadorSituacao": null, // Caracter identificador da situação da validação "valorPercentualGarantia": "10000", // Valor de Percentual da Garantia "valorGarantiaRealizada": "00000000000000000", // Valor da garantia realizada "idCessaoParcial": "000", // Identificador da cessao parcial "codigoCarteiraGarantia": "000", // Código de carteira da garantia "ipoc": "136524165s4dfsdfs685g7s" // Código IPOC da operação }, .... // Demais elementos ] |
Retornos
202 - Aceito: Processamento assíncrono Iniciado
Content Type: text/plain
Corpo (GUID de requisição). Exemplo
Bloco de código |
---|
3fa9ff31-812d-47ab-836a-00641e990f7c |
40X - Erro: Requisição
Content Type: application/json
Corpo:
Bloco de código | ||
---|---|---|
| ||
{ "status": 0, "error": "string", "message": "string" } |
500 - Erro Interno
Content Type: application/json
Corpo:
Bloco de código | ||
---|---|---|
| ||
{ "status": 0, "error": "string", "message": "string" } |