Merge pull request #1731 from Sensedia/ORB-2933

feat(Invoice Financings): ORB-2933 - PA110 - Alterar mandatoriedade de campos
Sensedia · Jul 10, 2023 · bad7cd1 · bad7cd1
2 parents 9c6cf64 + e278fd7
commit bad7cd1
Show file tree

Hide file tree

Showing 6 changed files with 120 additions and 54 deletions.
diff --git a/dictionary/invoiceFinancingsGetContractsContractIdPayments_v2.csv b/dictionary/invoiceFinancingsGetContractsContractIdPayments_v2.csv
@@ -5,21 +5,31 @@
 /data/releases;releases;Lista dos pagamentos realizados no período.;Lista;;Obrigatório;;;0;N;"";Não permitido;array;;
 /data/releases/paymentId;paymentId;Identificador de pagamento de responsabilidade de cada Instituição transmissora.;Texto;100;Opcional;[\w\W\s]*;;0;1;"";Não permitido;string;Parcela regular;
 /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.;Texto;100;Condicional;[\w\W\s]*;;0;1;" Informação de envio obrigatório quando isOverParcelPayment tiver o valor FALSE.
+/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.
+";Texto;100;Condicional;[\w\W\s]*;;0;1;" Informação de envio obrigatório quando isOverParcelPayment tiver o valor FALSE.
 ";Não permitido;string;15;
 /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.";Texto;3;Obrigatório;^(\w{3}){1}$;;1;1;"";Não permitido;string;BRL;
+Todos os valores monetários informados estão representados com a moeda vigente do Brasil.
+";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.";Texto;20;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.;Objeto;;Condicional;;;0;1;" Informação deve ser enviada caso ela exista.
+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/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;[\w\W\s]+;;1;1;"";Não permitido;string;Excesso em Conta;2
-/data/releases/overParcel/fees/feeCode;feeCode;Sigla identificadora da tarifa pactuada.;Texto;140;Obrigatório;[\w\W\s]+;;1;1;"";Não permitido;string;EXCESSO_CONTA;2
+/data/releases/overParcel/fees/feeName;feeName;"Denominação da Tarifa pactuada.
+";Texto;140;Obrigatório;[\w\W\s]+;;1;1;"";Não permitido;string;Excesso em Conta;2
+/data/releases/overParcel/fees/feeCode;feeCode;"Sigla identificadora da tarifa pactuada.
+";Texto;140;Obrigatório;[\w\W\s]+;;1;1;"";Não permitido;string;EXCESSO_CONTA;2
 /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.";Texto;20;Obrigatório;^\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0400;4
+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/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 
@@ -28,6 +38,9 @@ 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.;Texto;140;Condicional;[\w\W\s]*;;0;1;" Obrigatório quando chargeType for igual 'OUTROS'.
+/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'.
+";Texto;140;Condicional;[\w\W\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;20;Obrigatório;^\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0400;4
diff --git a/dictionary/invoiceFinancingsGetContractsContractIdScheduledInstalments_v2.csv b/dictionary/invoiceFinancingsGetContractsContractIdScheduledInstalments_v2.csv
@@ -5,20 +5,27 @@ 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.;Número;;Condicional;;;0;1;" Obrigatoriamente deve ser preenchido caso o typeNumberOfInstalments seja diferente de SEM_PRAZO_TOTAL.
+/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.
+";Número;;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 
+/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.;Número;;Condicional;;;0;1;" Obrigatoriamente deve ser preenchido caso o typeContractRemaining seja diferente de SEM_PRAZO_REMANESCENTE.
+/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.
+";Número;;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;;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;;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;;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. Expresso em valor monetário com no mínimo 2 casas e no máximo 4 casas decimais.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/balloonPayments/amount/amount;amount;"";Texto;20;Obrigatório;^\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0400;4
+/data/balloonPayments/amount/amount;amount;;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;
diff --git a/dictionary/invoiceFinancingsGetContractsContractIdWarranties_v2.csv b/dictionary/invoiceFinancingsGetContractsContractIdWarranties_v2.csv
@@ -1,6 +1,6 @@
 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 às garantias que avalizam a operação de direitos creditórios descontados contratada;Lista;;Obrigatório;;;0;N;"";Não permitido;array;;
-/data/currency;currency;Moeda referente ao valor da garantia, segundo modelo ISO-4217. p.ex. 'BRL'. Todos os valores monetários informados estão representados com a moeda vigente do Brasil;Texto;3;Opcional;^(\w{3}){1}$;;0;1;"";Não permitido;string;BRL;
+/data/currency;currency;Moeda referente ao valor da garantia, segundo modelo ISO-4217. p.ex. 'BRL'. Todos os valores monetários informados estão representados com a moeda vigente do Brasil;Texto;3;Obrigatório;^(\w{3}){1}$;;1;1;"";Não permitido;string;BRL;
 /data/warrantyType;warrantyType;Denominação/Identificação do tipo da garantia que avaliza a Modalidade da Operação de Crédito contratada  (Doc 3040, Anexo 12);Texto;;Obrigatório;;"CESSAO_DIREITOS_CREDITORIOS 
 CAUCAO 
 PENHOR 
@@ -14,7 +14,8 @@ BENS_ARRENDADOS
 GARANTIAS_INTERNACIONAIS 
 OPERACOES_GARANTIDAS_OUTRAS_ENTIDADES 
 ACORDOS_COMPENSACAO";1;1;"";Não permitido;string;CESSAO_DIREITOS_CREDITORIOS;
-/data/warrantySubType;warrantySubType;Denominação/Identificação do sub tipo da garantia que avaliza a Modalidade da Operação de Crédito contratada (Doc 3040, Anexo 12).;Texto;;Obrigatório;;"ACOES_DEBENTURES 
+/data/warrantySubType;warrantySubType;"Denominação/Identificação do sub tipo da garantia que avaliza a Modalidade da Operação de Crédito contratada (Doc 3040, Anexo 12).
+";Texto;;Obrigatório;;"ACOES_DEBENTURES 
 ACORDOS_COMPENSACAO_LIQUIDACAO_OBRIGACOES 
 APLICACOES_FINANCEIRAS_RENDA_FIXA 
 APLICACOES_FINANCEIRAS_RENDA_VARIAVEL 
@@ -67,4 +68,5 @@ SEM_SUB_TIPO_GARANTIA
 TRIBUTOS_RECEITAS_ORCAMENTARIAS 
 VEICULOS 
 VEICULOS_AUTOMOTORES";1;1;"";Não permitido;string;NOTAS_PROMISSORIAS_OUTROS_DIREITOS_CREDITO;
-/data/warrantyAmount;warrantyAmount;Valor original da garantia. Expresso em valor monetário com no mínimo 2 casas e no máximo 4 casas decimais.;Texto;20;Opcional;^\d{1,15}\.\d{2,4}$;;0;1;"";Não permitido;string;1000.0400;4
+/data/warrantyAmount;warrantyAmount;"Valor original da garantia. 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