Você está vendo a versão antiga da página. Ver a versão atual.
Comparar com o atual
Ver Histórico da Página
Versão 1
Atual »
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 Unarranged-accounts-overdraft
GET /contracts
Campo | O que foi feito? |
data | Alterado minItems |
contractId | Alterado pattern
Adicionado minLength |
brandName | Alterada descrição |
companyCnpj | Alterado pattern |
productType | 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 |
GET /contracts/{contractId}
Campo | O que foi feito? |
amortizationScheduled | Removido maxLength |
amortizationScheduledAdditionalInfo | Alterado maxLength
Alterado exemplo
Alterada descrição |
contractNumber | Adicionado pattern
Adicionado minLength |
ipocCode | Adicionado minLength
Adicionado pattern
Alterada descrição |
productName | Alterada descrição |
productType | Removido maxLength |
disbursementDates | Alterado nome para o plural
Alterado para lista
Alterada descrição |
settlementDate | Alterada mandatoriedade
Removido restrição
Alterado pattern |
instalmentPeriodicity | Removido maxLength |
instalmentPeriodicityAdditionalInfo | Alterada descrição |
contractAmount | Alterada mandatoriedade
Atualizada descrição
Alterado para string
Removido format
Alterado maxLength
Alterado minLength
Alterado exemplo
Removido nullable |
currency | Alterada mandatoriedade |
dueDate | Alterada mandatoriedade
Adicionado minLength |
firstInstalmentDueDate | Alterada mandatoriedade
Adicionado minLength |
CET | Adicionado pattern
Alterado maxLength
Adicionado minLength
Alterada mandatoriedade
Alterado para string
Alterada descrição
Removido nullable
Adicionado format
Alterado exemplo |
interestRates | Adicionado minItems
Adicionada descrição |
interestRates/taxType | Removido maxLength |
interestRates/interestRateType | Removido maxLength |
interestRates/taxPeriodicity | Removido maxLength |
interestRates/calculation | Removido maxLength |
interestRates/referentialRateIndexerType | Removido maxLength |
interestRates/referentialRateIndexerSubType | Removido maxLength |
interestRates/preFixedRate | Alterado para string
Alterado maxLength
Alterado minLength
Alterado exemplo
Adicionado format
Alterada descrição
Removido nullable |
interestRates/postFixedRate | Alterado para string
Alterado maxLength
Alterado minLength
Alterado exemplo
Adicionado format
Alterada descrição |
interestRates/additionalInfo | Alterada mandatoriedade Adicionada restrição |
contractedFees/feeChargeType | Removido maxLength |
contractedFees/feeCharge | Removido maxLength |
contractedFees/feeAmount | Alterada mandatoriedade
Adicionada restrição
Alterado para string
Alterada descrição
Alterado pattern
Removido nullable
Alterado exemplo
Adicionado minLength |
contractedFees/feeRate | Alterado para string
Alterado pattern
Alterado maxLength
Alterado minLength
Alterado exemplo
Atualizada descrição
Alterada mandatoriedade
Removido nullable |
contractedFinanceCharges/chargeType | Removido maxLength |
contractedFinanceCharges/chargeAdditionalInfo | Alterada mandatoriedade Adicionada restrição |
contractedFinanceCharges/chargeRate | Alterado tipo para: string com format double
Adicionado pattern
Alterado maxLength
Adicionado minLength
Alterado exemplo
Atualizada descrição |
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 |
GET /contracts/{contractId}/warranties
Campo | O que foi feito? |
data | Adicionado minItems |
currency | Alterada mandatoriedade |
warrantyType | Removido maxLength
Removido opção SEM_TIPO_GARANTIA do enum |
warrantySubType | Removido maxLength
Adicionadas as opções no enum: ACORDOS_COMPENSACAO_LIQUIDACAO_OBRIGACOES. PROAGRO, SEM_SUB_TIPO_GARANTIA |
warrantyAmount | Alterado maxLength
Alterado minLength
Alterada descrição
Alterada mandatoriedade
Alterado para string
Removido format
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 |
GET /contracts/{contractId}/sheduled-instalments
Campo | O que foi feito? |
typeNumberOfInstalments | Removido maxLength |
totalNumberOfInstalments | Removido maxLength
Adicionado maximum
Removido nullable
Alterada mandatoriedade
Adicionada restrição |
typeContractRemaining | Removido maxLength |
contractRemainingNumber | Removido maxLength
Adicionado maximum
Adicionada restrição
Alterada mandatoriedade
Removido nullable
Alterado exemplo |
paidInstalments | Removido maxLength
Adicionado maximum
Removido nullable |
dueInstalments | Removido maxLength
Adicionado maximum
Removido nullable |
pastDueInstalments | Removido maxLength
Adicionado maximum
Removido nullable |
balloonPayments | Adicionado minItems
Removido nullable
Alterada mandatoriedade |
balloonPayments/dueDate | Alterada mandatoriedade |
balloonPayments/amount | Convertido em objeto com os atributos amount e currency
Alterada descrição |
balloonPayments/currency | Removido campo deste nível |
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 |
GET /contracts/{contractId}/payments
Campo | O que foi feito? |
paidInstalments | Removido maxLength
Adicionado maximum
Removido nullable
Alterada mandatoriedade |
contractOutstandingBalance | Alterado minLength
Alterado maxLength
Alterado para string
Removido format
Alterado exemplo |
releases | Adicionado mimItems |
releases/paidAmount | Alterado para string
Alterado maxLength
Alterado minLength
Alterada descrição
Removido format
Alterado exemplo |
releases/overParcel | Alterada mandatoriedade
Adicionada restrição |
releases/overParcel/fees | Adicionado mimItems |
releases/overParcel/fees/feeCode | Alterada descrição |
releases/overParcel/fees/feeAmount | Removido Restrição
Alterado maxLength
Alterado minLength
Alterada descrição
Alterado para string
Removido format
Removido nullable
Alterado exemplo |
releases/overParcel/charges/ | Adicionado mimItems |
releases/overParcel/charges/chargeType | Removido maxLength |
releases/overParcel/charges/chargeAdditionalInfo | Alterada mandatoriedade |
releases/overParcel/charges/chargeAmount | Removido nullable
Alterada descrição
Alterado para string
Alterado maxLength
Alterado minLength
Removido format
Alterado exemplo |
releases/paymentId | Alterado pattern
Adicionado minLength |
releases/instalmentId | Alterado pattern
Adicionado minLength |
Header | Adicionado o 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 |