Changelog - Direitos Creditórios Descontados - 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 Invoice-financings

 

Campo

O que foi feito?

data

Adicionado 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 mandatoriedade
Alterado maxLength
Removida restrição
Alterado exemplo

calculation

Removido maxLength

CET

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

contractAmount

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

contractedFees/feeAmount

Alterada mandatoriedade
Adicionada restrição
Alterado maxLength
Adicionado minLength
Alterado exemplo
Alterado para string
Alterado pattern
Removido Nullable

contractedFees/feeCharge

Removido maxLength

contractedFees/feeChargeType

Removido maxLength

contractedFees/feeName

Alterado pattern
Adicionado minLength
Alterada descrição

contractedFees/feeCode

Alterado pattern
Adicionado minLength
Alterada descrição

contractedFees/feeRate

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

contractedFinanceCharges/chargeAdditionalInfo

Alterada mandatoriedade
Adicionado maxLength
Alterada descrição

contractedFinanceCharges/chargeRate

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

contractedFinanceCharges/chargeType

Removido maxLength

contractNumber

Adicionado pattern

currency

Alterada mandatoriedade

disbursementDates

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

dueDate

Alterada mandatoriedade
Alterado maxLength
Adicionado minLength

firstInstalmentDueDate

Alterada mandatoriedade
Adicionado minLength
Alterada descrição

instalmentPeriodicity

Removido maxLength

instalmentPeriodicityAdditionalInfo

Alterada mandatoriedade
Removido restrição

interestRates

Adicionado minItems
Adicionada descrição

interestRates/additionalInfo

Alterada mandatoriedade
Adicionada restrição

interestRates/calculation

Removido maxLength

interestRates/interestRateType

Removido maxLength

interestRates/postFixedRate

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

interestRates/preFixedRate

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

interestRates/referentialRateIndexerType

Removido maxLength

interestRates/referentialRateIndexerSubType

Removido maxLength

interestRates/taxPeriodicity

Removido maxLength

interestRates/taxType

Removido maxLength

ipocCode

Adicionado minLength
Adicionado pattern

productType

Removido maxLength

productSubType

Removido maxLength

settlementDate

Alterada mandatoriedade
Alterado pattern

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

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

warrantyType

Removido maxLength
Removido o seguinte itens no enum:
SEM_TIPO_GARANTIA

warrantySubType

Removido maxLength
Adicionado os seguintes itens no enum: ACORDOS_COMPENSACAO_LIQUIDACAO_OBRIGACOES, PROAGRO, SEM_SUB_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 minItems
Removido Nullable

balloonPayments/amount

Convertido em objeto com os atributos amount e currency
Alterada descrição

balloonPayments/amount/currency

Movido para dentro do objeto balloonPayments/amount

balloonPayments/dueDate

Alterada mandatoriedade
Adicionado minLength

contractRemainingNumber

Alterada mandatoriedade
Adicionada restrição
Removido maxLength
Adicionado maximum
Adicionada descrição
Removido Nullable

dueInstalments

Removido Nullable
Removido maxLength
Adicionado maximum

paidInstalments

Removido Nullable
Removido maxLength
Adicionado maximum

pastDueInstalments

Removido Nullable
Removido maxLength
Adicionado maximum

totalNumberOfInstalments

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

typeContractRemaining

Removido maxLength

typeNumberOfInstalments

Removido maxLength

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?

contractOutstandingBalance

Alterado para string
Alterado pattern
Alterado minLength
Alterado exemplo

paidInstalments

Removido maxLength
Adicionado maximum
Nullable removido
Alterada mandatoriedade

releases

Adicionado minItems

releases/overParcel

Alterada mandatoriedade
Adicionada restrição

releases/overParcel/charges/

Adicionado minItems

releases/overParcel/charges/chargeAdditionalInfo

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

releases/overParcel/charges/chargeAmount

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

releases/overParcel/charges/chargeType

Removido maxLength
Alterada descrição

releases/overParcel/fees

Adicionado minItems

releases/overParcel/fees/feeAmount

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

releases/overParcel/fees/feeCode

Adicionado minLength
Alterado pattern

releases/overParcel/fees/feeName

Adicionado minLength
Alterado pattern

releases/paidAmount

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

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