Dicionário de Campos do Payload

account: Número da conta bancária do cliente sem o dígito verificador - Somente números sem formatação, ex: 00121;
accountDigit: Dígito verificador da conta bancária do cliente - Sem formatação, ex: X3;
accountType: Tipo da conta - Valores válidos: CC,CD,CG,CI, PG,PP;
amount: Valor constituído total, líquido, a pagar pela Instituição Credenciadora ou Subcredenciadora - Somente números sem formatação. Os valores em centavos devem ser multiplicados por 100, ex: Para R$10,00, enviar 1000;
assetHolder: Número do documento federal do titular/beneficiário da SO - CNPJ/CPF válido, informar somente números sem formatação;
assetHolderDocumentType: Tipo de Documento - CNPJ/CPF válido, informar somente números sem formatação;
balanceAmount: Somente números sem formatação. Os valores em centavos devem ser multiplicados por 100, ex: Para R$10,00, enviar 1000;
balanceAmount: Saldo a liquidar, diferença entre o Valor total e o Valor liquidado;
bankAccount: Dados bancários do beneficiário da liquidação;
beneficiary: Beneficiário - CNPJ/CPF válido, informar somente números sem formatação;
branch: Número da agência do cliente - Somente números sem formatação, ex: 3232;
commercialEstablishments: Estabelecimento Comercial - CNPJ/CPF válido, informar somente números sem formatação;
commitmentDueDate: Data de término de vigência do contrato; Formato AAAA-MM-DD;
committedAmount: Valor comprometido com contrato mas que ainda não foi aplicado efeito por falta de saldo. Somente números sem formatação. Os valores em centavos devem ser multiplicados por 100, ex: Para R$10,00, enviar 1000;
committedEffectAmount: Valor executado, efetivamente comprometido pelo contrato - Somente números sem formatação. Os valores em centavos devem ser multiplicados por 100, ex: Para R$10,00, enviar 1000;
contractHolder: Número do documento federal do beneficiário do Contrato - CNPJ/CPF válido, informar somente números sem formatação;
contractHolderDocumentType: Tipo do documento do beneficiário do Contrato - CNPJ/CPF válido, informar somente números sem formatação;
contractKey: Chave do Contrato - Chave do tipo GUID;
contractObligations: Obrigações de contratos (CO, Averbação, Contrato);
contractType: Tipo de contrato - Opções Válidas: ownershipAssignment, warranty;
createdAt: Data da criação - Formato AAAA-MM-DD;
debtor: Instituição Credenciadora ou Subcredenciadora, responsável pela agenda - CNPJ/CPF válido, informar somente números sem formatação;
divisionMethod: Regra de divisão do Contrato - Opções válidas: percentage, fixedAmount;
documentNumber: Número de Documento - CNPJ/CPF válido, informar somente números sem formatação;
documentType: Tipo do Documento - Opções Válidas: CPF ou CNPJ;
dueDate: Data de vencimento original da UR - Data no formato AAAA-MM-DDT00:00:00+00:00, ex: 2020-02-02T18:58:48.4794377Z;
effectAmount: Valor comprometido conforme o Método de aplicação do Contrato - Somente números sem formatação. Os valores em centavos devem ser multiplicados por 100, ex: Para R$10,00, enviar 1000;
effectPriority: Prioridade do contrato, utilizada na Liquidação da UR. O menor número tem a maior prioridade - Somente Números sem formatação;
effectStrategy: Tipo de estratégia adotada para a averbação - Opções Válidas: specific, custom, overall;
effectType: Tipo de Contrato - Opções Válidas: warranty, ownershipAssignment, contractualBurden e pawn;
errors: Campo informando quais tipos de erros;
eventType: Informação do tipo do evento;
expectedSettlementDate: Data de liquidação da SO esperada pelo arranjo de pagamento ou com efeitos de antecipação - Formato AAAA-MM-DDT00:00:00+00:00, ex: 2020-02-02T18:58:48.4794377Z;
extractionReferenceDate: Data da extração - Formato AAAA/MM/DD;
hasErros: Campo informando ocorrência positiva ou negativa de erros - Opções válidas: True ou False;
identifier: Identificador da transação;
isCanceled: Flag de contrato ativo ou inativo - Opções válidas: True ou False;
isRejected: Flag de verificação à rejeição - Opções válidas: True ou False;
key: Chave única de identificação - Formato em GUID;
lastUpdated: Data da última atualização - Formato AAAA-MM-DDT00:00:00+00:00, ex: 2020-02-02T18:58:48.4794377Z;
notificationRecipient: Documento do Beneficiário da Notificação - CNPJ/CPF válido, informar somente números sem formatação;
notificationRecipientDocumentType: Tipo do documento do Beneficiário da Notificação - valores válidos: "CNPJ, CPF";
notificationDate: Data da criação da notificação - Data no formato AAAA/MM/DD;
obligationType: Indicador se a SO está comprometida por contrato - Opções Válidas: Committed e Free;
operationExpectedSettlementDate: Data prevista de liquidação da operação de Antecipação - Data no formato AAAA/MM/DD;
operationValue: Valor da operação de Antecipação - Somente números sem formatação. Os valores em centavos devem ser multiplicados por 100, ex: Para R$10,00, enviar 1000;
originalAssetHolder: Número do documento federal do titular originador da UR - CNPJ/CPF válido, informar somente números sem formatação;
originalAssetHolderDocumentType: Tipo de documento do originador - Opções Válidas: CPF ou CNPJ;
paymentScheme: Sigla conforme Tabela de Arranjo de Pagamento
percentageValue: Porcentagem de valor da UR comprometido com o contrato. Só será preenchido quando a Regra de Divisão divisionMethod for percentage - O valor da porcentagem deve ser multiplicado por 100, ex: Para 10%, enviar 1000;
prePaidAmount: Valor constituído total, líquido, a pagar pela Instituição Credenciadora ou Subcredenciadora que já foi liquidado para uma UR previamente de seu registro - Somente números sem formatação. Os valores em centavos devem ser multiplicados por 100, ex: Para R$10,00, enviar 1000;
processDate: Data de processamento da Conciliação - Data no formato AAAA/MM/DD;
processKey: Chave de Processamento - Formato em GUID;
processReference: Chave externa do processamento do lote - Tamanho máximo 100 caracteres
reasonDetails: Campo de texto informando o motivo da rejeição - Campo de Preenchimento;
receivables: Unidade de Recebível (UR);
recipient: Documento do Consultante - CNPJ/CPF válido, informar somente números sem formatação;
recipientDocumentType: Tipo do documento do consultante - CNPJ/CPF válido, informar somente números sem formatação;
reconciliationDate: Data desejada para realizar a Conciliação - Data no formato AAAA-MM-DD;
reference: Chave única externa, Tamanho máximo 100 caracteres
settledAmount: Valor liquidado - Somente números sem formatação. Os valores em centavos devem ser multiplicados por 100, ex: Para R$10,00, enviar 1000;
settlementDate: Efetiva Data da liquidação - Data no formato AAAA-MM-DDT00:00:00+00:00, ex: 2020-02-02T18:58:48.4794377Z;
settlementObligationDate: Data Válida para Obrigação de Liquidação - Data no formato AAAA-MM-DD;
settlementObligations: Obrigações de liquidação da UR;
settlements: Liquidações realizadas na UR;
totalAmount: Valor constituído, total, líquido deste ativo financeiro - Somente números sem formatação. Os valores em centavos devem ser multiplicados por 100, ex: Para R$10,00, enviar 1000;
tradeRepository: Número do documento federal da Registradora em que o contrato foi registrado - Somente números sem formatação. Os valores em centavos devem ser multiplicados por 100, ex: Para R$10,00, enviar 1000;
uncommittedAmount: Valor disponível, valor não negociado e não liquidado, que está disponível para Antecipação Pós-Contratada e Averbação de UR - Somente números sem formatação. Os valores em centavos devem ser multiplicados por 100, ex: Para R$10,00, enviar 1000;
value: Somente números sem formatação. Os valores em centavos devem ser multiplicados por 100, ex: Para R$10,00, enviar 1000;
warrantyType: Tipo de garantia do Contrato - Opções válidas: fiduciary, pledge.