ESTE É UM CONTEÚDO EM DESENVOLVIMENTO E NÃO DEVE SER CONSIDERADO COMO VERSÃO FINAL!
Clique aqui para maiores informações

Changelog - Empréstimos - v2.0.0

Descrição macro das alterações aplicadas às APIs de Dados Cadastrais e Transacionais em relação aos payloads:

  • Nenhum campo poderá receber o valor NA. Seguem regras de acordo com os casos:

    • Obrigatórios: foram revistas as mandatoriedades a fim de atender as regras de negócios de cada um dos produtos;

    • Opcionais: para estes casos basta não enviar o campo;

    • Condicionais: se comportam como opcionais, exceto quando o cenário se encaixar na restrição incluída na descrição;

    • Enums: Retiradas as opções com valor NAO_APLICA e similares;

    • Removidos todos os atributos Nullable dos campos, que foram analisados obedecendo critérios de mandatoriedade e cenários de negócio.

  • Com o objetivo de normalizar o formato dos dados entre as pontas, foram acrescentados patterns em todos os campos elegíveis.

  • Foram normalizados os atributos dos campos de acordo com o seu tipo de dado.

  • Todas as ocorrências de campos additionalInfo foram alteradas para opcional ou condicional de acordo com suas características de negócio. Para os campos condicionais foram acrescentadas restrições de cenário de uso.

  • Foram alterados todos os campos numéricos do tipo double para string com format double, com isso garantimos que exista um formato de dados padrão, tornando possível que todas as casas, considerando suas peculiaridades sistêmicas, consigam realizar o tráfego das informações.

  • Revista a mandatoriedade dos arrays, considerando os seguintes cenários:

    • Obrigatórios, passam a receber minItems: 0. Considerando que caso as informações não existam, o array precisa ser enviado vazio. Nesse cenário atendemos ao conjunto de informações relativas a um produto, onde um cenário específico não pode ser atendido mesmo existindo como característica do produto, é como quem está enviando dizer “não tenho essa informação para este produto”.

    • Opcionais e condicionais, passam a receber minItems: 1. Caso não exista a informação basta não enviar o array, existindo, deve ser preenchido pelo menos 1.

  • Inserção e remoção de campos atendendo às especificidades de cada produto (API).

  • Removidos os campos totalPages e totalRecords dos exemplos de response codes de exceção.

  • Adicionados novos response codes.

API Loans

 

Campo

O que foi feito?

data

Adicionando minItems

contractId

Alterado pattern
Adicionado minLength

brandName

Alterada descrição

companyCnpj

Alterado pattern

productType

Removido maxLength

productSubType

Removido maxLength

ipocCode

Adicionado minLength
Adicionado pattern

Swagger

Alterado texto em Orientações Gerais

Header

Adicionado campo pagination-key

Propriedade de extensibilidade

Removida a explicitude do additionalProperties

Response code

Alterado response Default

Response code

Adicionado status code 422

Response code

Adicionado status code 423

Response code

Adicionado status code 529

 

Campo

O que foi feito?

amortizationScheduled

Removido maxLength

amortizationScheduledAdditionalInfo

Alterada descrição
Alterado exemplo
Alterado maxLength
Alterada mandatoriedade

cnpjConsignee

Alterada descrição
Adicionado Restrição
Alterado pattern
Alterada mandatoriedade

instalmentPeriodicity

Removido maxLength

instalmentPeriodicityAdditionalInfo

Alterada mandatoriedade
Alterada descrição

productType

Removido maxLength

productSubType

Removido maxLength

contractAmount

Alterado para string
Alterada descrição
Alterado exemplo
Alterado minLength
Removido nullable
Alterado pattern
Alterada mandatoriedade

settlementDate

Alterado pattern
Alterada descrição
Alterada mandatoriedade

currency

Alterada mandatoriedade

dueDate

Alterada mandatoriedade
Adicionado minLength
Alterada descrição

firstInstalmentDueDate

Alterada descrição
Alterada mandatoriedade

CET

Alterado para string com format double
Alterada descrição
Alterado exemplo
Alterado maxLength
Adicionado minLength
Removido nullable
Adicionado pattern
Alterada mandatoriedade

contractNumber

Alterado pattern
Adicionado minLength

ipocCode

Adicionado minLength
Adicionado pattern

disbursementDates

Alterado nome para o plural
Alterado para lista
Alterada descrição

interestRates

Adicionado minItems
Adicionada descrição

interestRates/calculation

Removido maxLength

interestRates/preFixedRate

Alterado para string com fotmat double
Alterada descrição
Alterado exemplo
Alterado maxLength
Adicionado minLength
Removido nullable
Adicionado pattern

interestRates/postFixedRate

Alterado para string com fotmat double
Alterada descrição
Alterado exemplo
Alterado maxLength
Adicionado minLength
Removido nullable
Adicionado pattern

interestRates/taxPeriodicity

Removido maxLength

interestRates/taxType

Removido maxLength

interestRates/interestRateType

Removido maxLength

interestRates/additionalInfo

Alterada mandatoriedade
Adicionada restrição

interestRates/referentialRateIndexerType

Removido maxLength

interestRates/referentialRateIndexerSubType

Removido maxLength

contractedFees/feeAmount

Alterado para string com fotmat double
Adicionada restrição
Alterado exemplo
Adicionado minLength
Removido nullable
Alterado pattern
Alterada mandatoriedade

contractedFees/feeRate

Alterado para string
Alterada descrição
Alterado exemplo
Alterado maxLength
Adicionado minLength
Removido nullable
Adicionado pattern
Alterada mandatoriedade

contractedFees/feeCharge

Removido maxLength

contractedFees/feeChargeType

Removido maxLength

contractedFees

Alterada descrição

contractedFinanceCharges/chargeRate

Alterado para string com fotmat double
Alterada descrição
Alterado exemplo
Alterado maxLength
Adicionado minLength
Adicionado pattern

contractedFinanceCharges/chargeType

Removido maxLength

contractedFinanceCharges/chargeAdditionalInfo

Alterada descrição
Adicionado maxLength
Alterada mandatoriedade
Alterado pattern

Header

Adicionado campo pagination-key

Propriedade de extensibilidade

Removida a explicitude do additionalProperties

Response code

Alterado Response Default

Response code

Adicionado status code 422

Response code

Adicionado status code 423

Response code

Adicionado status code 529

 

Campo

O que foi feito?

data

Adicionado minItems

warrantyAmount

Alterado para string com format double
Adicionado minLength
Alterado pattern
Alterada a descrição
Alterada mandatoriedade

warrantySubType

Removido maxLength
Adicionadas as opções:
ACORDOS_COMPENSACAO_LIQUIDACAO_OBRIGACOES”,
”PROAGRO”, e
“SEM_SUB_TIPO_GARANTIA”

warrantyType

Removido maxLength
Removida a opção doenum: “SEM_TIPO_GARANTIA”

currency

Alterada mandatoriedade

Header

Adicionado campo pagination-key

Propriedade de extensibilidade

Removida a explicitude do additionalProperties

Response code

Alterado Response Default

Response code

Adicionado status code 422

Response code

Adicionado status code 423

Response code

Adicionado status code 529

 

Campo

O que foi feito?

balloonPayments

Alterada mandatoriedade
Alterado mimItems
Removido nullable

balloonPayments/amount

Convertido em objeto com os atributos amount e currency

balloonPayments/amount/amount

Atualizada a descrição

balloonPayments/dueDate

Adicionado minLength
Removida mandatoriedade

contractRemainingNumber

Removido nullable
Removido maxLength
Adicionado maximum
Alterada mandatoriedade
Adicionada restrição

dueInstalments

Removido nullable
Removido maxLength
Maximum adicionado

paidInstalments

Removido nullable
Removido maxLength
Adicionado maximum

pastDueInstalments

Removido nullable
Removido maxLength
Maximum adicionado

totalNumberOfInstalments

Removido nullable
Removido maxLength
Adicionado maximum
Alterada mandatoriedade
Adicionada restrição

typeContractRemaining

Removido maxLength

typeNumberOfInstalments

Removido maxLength

pagination-key

Adicionado o campo no header.

Propriedade de extensibilidade

Removida a explicitude do additionalProperties

Response code

Alterado Response Default

Response code

Adicionado status code 422

Response code

Adicionado status code 423

Response code

Adicionado status code 529

 

Campo

O que foi feito?

chargeType

Removido maxLength

contractOutstandingBalance

Alterado para string com format double
Alterado exemplo
Alterado minLength
Alterado pattern

paidInstalments

Removido maxLength
Adicionado maximum
Removido nullable
Alterada mandatoriedade

releases

Adicionado minItems

releases/instalmentId

Alterado pattern
Adicionado minLength

releases/overParcel

Adicionada restrição
Alterada mandatoriedade

releases/overParcel/charges

Adicionado minItems

releases/overParcel/charges/chargeAdditionalInfo

Alterada mandatoriedade

releases/overParcel/charges/chargeAmount

Alterado para string com format double
Alterado exemplo
Alterado minLength
Removido nullable
Alterado pattern
Alterada descrição

releases/overParcel/charges/chargeType

Removido maxLength

releases/overParcel/fees

Adicionado minItems

releases/overParcel/fees/feeAmount

Alterado para string
Alterado format
Alterado exemplo
Alterado maxLength
Alterado minLength
Removido nullable
Alterada descrição

releases/paidAmount

Alterado para string
Alterada descrição
Alterado exemplo
Alterado minLength
Alterado pattern

releases/overParcel/fees/feeCode

Alterada descrição

releases/overParcel/fees/feeName

Alterada descrição

releases/paymentId

Alterado pattern
Adicionado minLength

Propriedade de extensibilidade

Removida a explicitude do additionalProperties

Header

Adicionado campo pagination-key

Response code

Alterado Response Default

Response code

Adicionado status code 422

Response code

Adicionado status code 423

Response code

Adicionado status code 529

ESTE É UM CONTEÚDO EM DESENVOLVIMENTO E NÃO DEVE SER CONSIDERADO COMO VERSÃO FINAL!
Clique aqui para maiores informações