Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat(Loans): Divisão das versões 2.4.0 e 2.5.0-beta.1 #711

Merged
merged 4 commits into from
Jan 15, 2025
Merged

Feat(Loans): Divisão das versões 2.4.0 e 2.5.0-beta.1 #711

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
51c3b76
feat(Loans): geração de dicionario de dados
FelipeBaumgartel Jan 13, 2025
74f52a0
Merge pull request #4646 from Sensedia/dicionario-loans
GabrielLLR Jan 13, 2025
1100541
Fix Loans
GabrielLLR Jan 15, 2025
32887ef
Merge pull request #4660 from Sensedia/fixloans
GabrielLLR Jan 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 42 additions & 32 deletions dictionary/loansGetContractsContractIdPayments_v2.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,39 +1,49 @@
Xpath,Nome,Definição,Tipo de Dado,Tamanho,Mandatoriedade,Formato,Domínio,Mínimo de Ocorrências,Máximo de Ocorrências,Restrições,Nulidade,Tipo de Dado Json,Exemplo,Tamanho mínimo
/contracts/{contractId}/payments/data/paidInstalments,,Quantidade total de parcelas pagas do contrato referente à Modalidade de Crédito informada.,number,,Opcional,,,,,,Não permitido,number,73,
/contracts/{contractId}/payments/data/contractOutstandingBalance,,Valor necessário para o cliente liquidar a dívida.,string,20,Opcional,double,,,,,Não permitido,string,1000.0400,4
/contracts/{contractId}/payments/data/releases/paymentId,,Código ou identificador único prestado pela instituição para representar o pagamento individual.,string,100,Opcional,,,,,,Não permitido,string,XlthLXpBLVowLTldW2EtekEtWjAtOVwtXXswLDk5fSQ,1
/contracts/{contractId}/payments/data/releases/isOverParcelPayment,,Identifica se é um pagamento pactuado (false) ou avulso (true).,boolean,,Opcional,,,,,,Não permitido,boolean,true,
/contracts/{contractId}/payments/data/releases/instalmentId,,"Identificador de parcela, de responsabilidade de cada Instituição transmissora.
Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Formato;Domínio;Mínimo de Ocorrências;Máximo de Ocorrências;Restrições;Nulidade;Tipo de Dado Json;Exemplo;Tamanho mínimo
/data;data;Conjunto de informações referentes aos pagamentos realizados de uma operação de crédito de empréstimos.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/paidInstalments;paidInstalments;Quantidade total de parcelas pagas do contrato referente à Modalidade de Crédito informada.;Número;2147483647;Opcional;;;0;1;"";Não permitido;number;73;
/data/contractOutstandingBalance;contractOutstandingBalance;Valor necessário para o cliente liquidar a dívida.;Texto;20;Obrigatório;^\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0400;4
/data/releases;releases;Lista dos pagamentos realizados no período;Lista;;Obrigatório;;;0;N;"";Não permitido;array;;
/data/releases/paymentId;paymentId;Código ou identificador único prestado pela instituição para representar o pagamento individual.;Texto;100;Obrigatório;^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$;;1;1;"";Não permitido;string;XlthLXpBLVowLTldW2EtekEtWjAtOVwtXXswLDk5fSQ;1
/data/releases/isOverParcelPayment;isOverParcelPayment;Identifica se é um pagamento pactuado (false) ou avulso (true).;Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;true;
/data/releases/instalmentId;instalmentId;"Identificador de parcela, de responsabilidade de cada Instituição transmissora.
[Restrição] Informação de envio obrigatório quando isOverParcelPayment tiver o valor FALSE.
",string,100,Opcional,,,,,,Não permitido,string,WGx0aExYcEJMVm93TFRsZFcyRXRla0V0V2pBdE9Wd3RYWH,1
/contracts/{contractId}/payments/data/releases/paidDate,,"Data efetiva do pagamento referente ao contrato da modalidade de crédito consultada, conforme especificação RFC-3339. p.ex. 2014-03-19",string,10,Opcional,date,,,,,Não permitido,string,2021-05-21,
/contracts/{contractId}/payments/data/releases/currency,,"Moeda referente ao valor monetário informado, segundo modelo ISO-4217. p.ex. 'BRL'.
";Texto;100;Condicional;^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$;;0;1;" Informação de envio obrigatório quando isOverParcelPayment tiver o valor FALSE.
";Não permitido;string;WGx0aExYcEJMVm93TFRsZFcyRXRla0V0V2pBdE9Wd3RYWH;1
/data/releases/paidDate;paidDate;Data efetiva do pagamento referente ao contrato da modalidade de crédito consultada, conforme especificação RFC-3339. p.ex. 2014-03-19;Data;10;Obrigatório;^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$;;1;1;"";Não permitido;string;2021-05-21;
/data/releases/currency;currency;"Moeda referente ao valor monetário informado, segundo modelo ISO-4217. p.ex. 'BRL'.
Todos os valores monetários informados estão representados com a moeda vigente do Brasil.
",string,3,Opcional,,,,,,Não permitido,string,BRL,
/contracts/{contractId}/payments/data/releases/paidAmount,,"Valor do pagamento referente ao contrato da modalidade de crédito consultada.
";Texto;3;Obrigatório;^(\w{3}){1}$;;1;1;"";Não permitido;string;BRL;
/data/releases/paidAmount;paidAmount;"Valor do pagamento referente ao contrato da modalidade de crédito consultada.
Expresso em valor monetário com no mínimo 2 casas e no máximo 4 casas decimais.
",string,21,Opcional,double,,,,,Não permitido,string,1000.0400,4
/contracts/{contractId}/payments/data/releases/overParcel/fees/feeName,,"Denominação da Tarifa pactuada.
",string,140,Opcional,,,,,,Não permitido,string,Reavaliação periódica do bem,
/contracts/{contractId}/payments/data/releases/overParcel/fees/feeCode,,"Sigla identificadora da tarifa pactuada.
",string,140,Opcional,,,,,,Não permitido,string,aval_bem,
/contracts/{contractId}/payments/data/releases/overParcel/fees/feeAmount,,"Valor monetário da tarifa pactuada no contrato.
";Texto;21;Obrigatório;^-?\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0400;4
/data/releases/overParcel;overParcel;"Objeto das tarifas e encargos que foram pagos fora da parcela.

[Restrição] Informação deve ser enviada caso ela exista.
";Objeto;;Condicional;;;0;1;" Informação deve ser enviada caso ela exista.
";Não permitido;object;;
/data/releases/overParcel/fees;fees;Lista das tarifas que foram pagas fora da parcela, só para pagamento avulso.;Lista;;Obrigatório;;;0;N;"";Não permitido;array;;
/data/releases/overParcel/fees/feeName;feeName;"Denominação da Tarifa pactuada.
";Texto;140;Obrigatório;^(?!\s)[\w\W\s]*[^\s]$;;1;1;"";Não permitido;string;Reavaliação periódica do bem;
/data/releases/overParcel/fees/feeCode;feeCode;"Sigla identificadora da tarifa pactuada.
";Texto;140;Obrigatório;^(?!\s)[\w\W\s]*[^\s]$;;1;1;"";Não permitido;string;aval_bem;
/data/releases/overParcel/fees/feeAmount;feeAmount;"Valor monetário da tarifa pactuada no contrato.

Expresso em valor monetário com no mínimo 2 casas e no máximo 4 casas decimais.
",string,21,Opcional,,,,,,Não permitido,string,100000.0400,4
/contracts/{contractId}/payments/data/releases/overParcel/charges/chargeType,,Tipo de encargo pactuado no contrato.,string,,Opcional,,"JUROS_REMUNERATORIOS_POR_ATRASO, MULTA_ATRASO_PAGAMENTO, JUROS_MORA_ATRASO, IOF_CONTRATACAO, IOF_POR_ATRASO, SEM_ENCARGO, OUTROS",,,,Não permitido,string,JUROS_REMUNERATORIOS_POR_ATRASO,
/contracts/{contractId}/payments/data/releases/overParcel/charges/chargeAdditionalInfo,,"Campo livre para preenchimento das informações adicionais referente ao encargo.
";Texto;21;Obrigatório;^-?\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;100000.0400;4
/data/releases/overParcel/charges;charges;Lista dos encargos que foram pagos fora da parcela.;Lista;;Obrigatório;;;0;N;"";Não permitido;array;;
/data/releases/overParcel/charges/chargeType;chargeType;Tipo de encargo pactuado no contrato.;Texto;;Obrigatório;;"JUROS_REMUNERATORIOS_POR_ATRASO
MULTA_ATRASO_PAGAMENTO
JUROS_MORA_ATRASO
IOF_CONTRATACAO
IOF_POR_ATRASO
SEM_ENCARGO
OUTROS";1;1;"";Não permitido;string;JUROS_REMUNERATORIOS_POR_ATRASO;
/data/releases/overParcel/charges/chargeAdditionalInfo;chargeAdditionalInfo;"Campo livre para preenchimento das informações adicionais referente ao encargo.

[Restrição] Obrigatório quando chargeType for igual 'OUTROS'.
",string,140,Opcional,,,,,,Não permitido,string,Informações adicionais,
/contracts/{contractId}/payments/data/releases/overParcel/charges/chargeAmount,,Valor do pagamento do encargo pago fora da parcela. Expresso em valor monetário com no mínimo 2 casas e no máximo 4 casas decimais.,string,21,Opcional,double,,,,,Não permitido,string,1000.0400,4
/contracts/{contractId}/payments/data/lastUpdatedcontractOutstandingBalanceDateTime,,"Data e hora da última atualização do valor do campo contractOutstandingBalance, conforme especificação RFC-3339, formato UTC. [Restrição] O envio do campo será obrigatório para CPC (campo “productSubTypeCategory” preenchido com CREDITO_PESSOAL_CLEAN).
",string,20,Opcional,date-time,,,,,Não permitido,string,2021-05-21T08:30:00Z,20
/contracts/{contractId}/payments/links/self,,URI completo que gerou a resposta atual.,string,2000,Opcional,url,,,,,Não permitido,string,https://api.banco.com.br/open-banking/api/v1/resource,
/contracts/{contractId}/payments/links/first,,URI da primeira página que originou essa lista de resultados. Restrição - Obrigatório quando não for a primeira página da resposta,string,2000,Opcional,url,,,,,Não permitido,string,https://api.banco.com.br/open-banking/api/v1/resource,
/contracts/{contractId}/payments/links/prev,,URI da página anterior dessa lista de resultados. Restrição - Obrigatório quando não for a primeira página da resposta,string,2000,Opcional,url,,,,,Não permitido,string,https://api.banco.com.br/open-banking/api/v1/resource,
/contracts/{contractId}/payments/links/next,,URI da próxima página dessa lista de resultados. Restrição - Obrigatório quando não for a última página da resposta,string,2000,Opcional,url,,,,,Não permitido,string,https://api.banco.com.br/open-banking/api/v1/resource,
/contracts/{contractId}/payments/links/last,,URI da última página dessa lista de resultados. Restrição - Obrigatório quando não for a última página da resposta,string,2000,Opcional,url,,,,,Não permitido,string,https://api.banco.com.br/open-banking/api/v1/resource,
/contracts/{contractId}/payments/meta/totalRecords,,Número total de registros no resultado,integer,,Opcional,int32,,,,,Não permitido,integer,1,
/contracts/{contractId}/payments/meta/totalPages,,Número total de páginas no resultado,integer,,Opcional,int32,,,,,Não permitido,integer,1,
/contracts/{contractId}/payments/meta/requestDateTime,,"Data e hora da consulta, conforme especificação RFC-3339, formato UTC.",string,20,Opcional,date-time,,,,,Não permitido,string,2021-05-21T08:30:00Z,
";Texto;140;Condicional;^(?!\s)[\w\W\s]*[^\s]$;;0;1;" Obrigatório quando chargeType for igual 'OUTROS'.
";Não permitido;string;Informações adicionais;
/data/releases/overParcel/charges/chargeAmount;chargeAmount;Valor do pagamento do encargo pago fora da parcela. Expresso em valor monetário com no mínimo 2 casas e no máximo 4 casas decimais.;Texto;21;Obrigatório;^-?\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0400;4
/data/lastUpdatedcontractOutstandingBalanceDateTime;lastUpdatedcontractOutstandingBalanceDateTime;"Data e hora da última atualização do valor do campo contractOutstandingBalance, conforme especificação RFC-3339, formato UTC. [Restrição] O envio do campo será obrigatório para CPC (campo “productSubTypeCategory” preenchido com CREDITO_PESSOAL_CLEAN).
";Date Hora;20;Condicional;;;0;1;" O envio do campo será obrigatório para CPC (campo “productSubTypeCategory” preenchido com CREDITO_PESSOAL_CLEAN).
";Não permitido;string;2021-05-21T08:30:00Z;20
51 changes: 28 additions & 23 deletions dictionary/loansGetContractsContractIdScheduledInstalments_v2.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,32 @@
Xpath,Nome,Definição,Tipo de Dado,Tamanho,Mandatoriedade,Formato,Domínio,Mínimo de Ocorrências,Máximo de Ocorrências,Restrições,Nulidade,Tipo de Dado Json,Exemplo,Tamanho mínimo
/contracts/{contractId}/scheduled-instalments/data/typeNumberOfInstalments,,Tipo de prazo total do contrato referente à modalidade de crédito informada.,string,,Opcional,,"DIA, SEMANA, MES, ANO, SEM_PRAZO_TOTAL",,,,Não permitido,string,MES,
/contracts/{contractId}/scheduled-instalments/data/totalNumberOfInstalments,,"Prazo Total segundo o tipo (dia, semana, mês, ano) referente à Modalidade de Crédito informada.
Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Formato;Domínio;Mínimo de Ocorrências;Máximo de Ocorrências;Restrições;Nulidade;Tipo de Dado Json;Exemplo;Tamanho mínimo
/data;data;Conjunto de informações referentes ao prazo remanescente e às parcelas de uma operação de crédito de empréstimos;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/typeNumberOfInstalments;typeNumberOfInstalments;Tipo de prazo total do contrato referente à modalidade de crédito informada.;Texto;;Obrigatório;;"DIA
SEMANA
MES
ANO
SEM_PRAZO_TOTAL";1;1;"";Não permitido;string;MES;
/data/totalNumberOfInstalments;totalNumberOfInstalments;"Prazo Total segundo o tipo (dia, semana, mês, ano) referente à Modalidade de Crédito informada.

[Restrição] Obrigatoriamente deve ser preenchido caso o typeNumberOfInstalments seja diferente de SEM_PRAZO_TOTAL.
",number,,Opcional,,,,,,Não permitido,number,130632,
/contracts/{contractId}/scheduled-instalments/data/typeContractRemaining,,"Tipo de prazo remanescente do contrato referente à modalidade de crédito informada.
",string,,Opcional,,"DIA, SEMANA, MES, ANO, SEM_PRAZO_REMANESCENTE",,,,Não permitido,string,,
/contracts/{contractId}/scheduled-instalments/data/contractRemainingNumber,,"Prazo Remanescente segundo o tipo (dia, semana, mês, ano) referente à Modalidade de Crédito informada.
";Número;999999999;Condicional;;;0;1;" Obrigatoriamente deve ser preenchido caso o typeNumberOfInstalments seja diferente de SEM_PRAZO_TOTAL.
";Não permitido;number;130632;
/data/typeContractRemaining;typeContractRemaining;"Tipo de prazo remanescente do contrato referente à modalidade de crédito informada.
";Texto;;Obrigatório;;"DIA
SEMANA
MES
ANO
SEM_PRAZO_REMANESCENTE";1;1;"";Não permitido;string;;
/data/contractRemainingNumber;contractRemainingNumber;"Prazo Remanescente segundo o tipo (dia, semana, mês, ano) referente à Modalidade de Crédito informada.

[Restrição] Obrigatoriamente deve ser preenchido caso o typeContractRemaining seja diferente de SEM_PRAZO_REMANESCENTE.
",number,,Opcional,,,,,,Não permitido,number,14600,
/contracts/{contractId}/scheduled-instalments/data/paidInstalments,,"Quantidade de prestações pagas. (No caso de modalidades que não possuam parcelas, o número de prestações é igual a zero)",number,,Opcional,,,,,,Não permitido,number,73,
/contracts/{contractId}/scheduled-instalments/data/dueInstalments,,"Quantidade de prestações a vencer.(No caso de modalidades que não possuam parcelas, o número de prestações é igual a zero)",number,,Opcional,,,,,,Não permitido,number,57,
/contracts/{contractId}/scheduled-instalments/data/pastDueInstalments,,"Quantidade de prestações vencidas. (No caso de modalidades que não possuam parcelas, o número de prestações é igual a zero)",number,,Opcional,,,,,,Não permitido,number,73,
/contracts/{contractId}/scheduled-instalments/data/balloonPayments/dueDate,,"'Data de vencimento da parcela não regular a vencer do contrato da modalidade de crédito consultada, conforme especificação RFC-3339. p.ex. 2014-03-19'
",string,10,Opcional,date,,,,,Não permitido,string,2021-05-21,2
/contracts/{contractId}/scheduled-instalments/data/balloonPayments/amount/amount,,Valor monetário da parcela não regular a vencer. Expresso em valor monetário com no mínimo 2 casas e no máximo 4 casas decimais.,string,20,Opcional,double,,,,,Não permitido,string,1000.0400,4
/contracts/{contractId}/scheduled-instalments/data/balloonPayments/amount/currency,,"Moeda referente ao valor monetário, seguindo o modelo ISO-4217.",string,3,Opcional,,,,,,Não permitido,string,BRL,
/contracts/{contractId}/scheduled-instalments/links/self,,URI completo que gerou a resposta atual.,string,2000,Opcional,url,,,,,Não permitido,string,https://api.banco.com.br/open-banking/api/v1/resource,
/contracts/{contractId}/scheduled-instalments/links/first,,URI da primeira página que originou essa lista de resultados. Restrição - Obrigatório quando não for a primeira página da resposta,string,2000,Opcional,url,,,,,Não permitido,string,https://api.banco.com.br/open-banking/api/v1/resource,
/contracts/{contractId}/scheduled-instalments/links/prev,,URI da página anterior dessa lista de resultados. Restrição - Obrigatório quando não for a primeira página da resposta,string,2000,Opcional,url,,,,,Não permitido,string,https://api.banco.com.br/open-banking/api/v1/resource,
/contracts/{contractId}/scheduled-instalments/links/next,,URI da próxima página dessa lista de resultados. Restrição - Obrigatório quando não for a última página da resposta,string,2000,Opcional,url,,,,,Não permitido,string,https://api.banco.com.br/open-banking/api/v1/resource,
/contracts/{contractId}/scheduled-instalments/links/last,,URI da última página dessa lista de resultados. Restrição - Obrigatório quando não for a última página da resposta,string,2000,Opcional,url,,,,,Não permitido,string,https://api.banco.com.br/open-banking/api/v1/resource,
/contracts/{contractId}/scheduled-instalments/meta/totalRecords,,Número total de registros no resultado,integer,,Opcional,int32,,,,,Não permitido,integer,1,
/contracts/{contractId}/scheduled-instalments/meta/totalPages,,Número total de páginas no resultado,integer,,Opcional,int32,,,,,Não permitido,integer,1,
/contracts/{contractId}/scheduled-instalments/meta/requestDateTime,,"Data e hora da consulta, conforme especificação RFC-3339, formato UTC.",string,20,Opcional,date-time,,,,,Não permitido,string,2021-05-21T08:30:00Z,
";Número;999999999;Condicional;;;0;1;" Obrigatoriamente deve ser preenchido caso o typeContractRemaining seja diferente de SEM_PRAZO_REMANESCENTE.
";Não permitido;number;14600;
/data/paidInstalments;paidInstalments;Quantidade de prestações pagas. (No caso de modalidades que não possuam parcelas, o número de prestações é igual a zero);Número;999999;Obrigatório;;;1;1;"";Não permitido;number;73;
/data/dueInstalments;dueInstalments;Quantidade de prestações a vencer.(No caso de modalidades que não possuam parcelas, o número de prestações é igual a zero);Número;999999;Obrigatório;;;1;1;"";Não permitido;number;57;
/data/pastDueInstalments;pastDueInstalments;Quantidade de prestações vencidas. (No caso de modalidades que não possuam parcelas, o número de prestações é igual a zero);Número;999999;Obrigatório;;;1;1;"";Não permitido;number;73;
/data/balloonPayments;balloonPayments;Lista que traz as datas de vencimento e valor das parcelas não regulares do contrato da modalidade de crédito consultada;Lista;;Opcional;;;1;N;"";Não permitido;array;;
/data/balloonPayments/dueDate;dueDate;"'Data de vencimento da parcela não regular a vencer do contrato da modalidade de crédito consultada, conforme especificação RFC-3339. p.ex. 2014-03-19'
";Data;10;Obrigatório;^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$;;1;1;"";Não permitido;string;2021-05-21;2
/data/balloonPayments/amount;amount;Valor monetário da parcela não regular a vencer.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/balloonPayments/amount/amount;amount;Valor monetário da parcela não regular a vencer. Expresso em valor monetário com no mínimo 2 casas e no máximo 4 casas decimais.;Texto;20;Obrigatório;^\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0400;4
/data/balloonPayments/amount/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL;
Loading
Loading