Neste local, estão mapeados os atributos que compõem as "Consultas de posição". O dicionário de dados tem como objetivo orientar o uso cada campo, seu preenchimento, obrigatoriedade e exemplificar seu conteúdo.
| Atributo | Informativo | Definição | Presente em | Conteúdo (Exemplo) |
|---|---|---|---|---|
| key | uuid | Chave única de identificação do ativo | Consultas de posição de recebíveis | 0eea9195-77e0-476f -8d99-4ecc0057bf1d |
| uniqueId | uuid | Chave única interna de controle | Consultas de posição de recebíveis | 0eea9195-77e0-476f -8d99-4ecc0057bf1d |
| expectedSettlementDate | data | Data prevista de liquidação do ativo | Consultas de posição de recebíveis | 2023-12-31 |
| reference | texto | Campo opcional para controle do participante | Consultas de posição de recebíveis | string |
| totalAmount | numérico | Valor constituído total do ativo, sem descontar eventuais liquidações. Os últimos dois dígitos do campo representam os centavos. | Consultas de posição de recebíveis | 100000 |
| balanceAmount | numérico | Valor total a pagar pela instituição credenciadora. Os últimos dois dígitos do campo representam os centavos. | Consultas de posição de recebíveis | 100000 |
| committedAmount | numérico | Valor total pendente de constituição do ativo para aplicação de todo ou parte do efeito do contrato. Os últimos dois dígitos do campo representam os centavos. | Consultas de posição de recebíveis | 100000 |
| uncommittedAmount | numérico | Valor total disponível do ativo, não negociado e não liquidado; saldo livre. Os últimos dois dígitos do campo representam os centavos. | Consultas de posição de recebíveis | 100000 |
| settledAmount | numérico | Valor total liquidado do ativo. Os últimos dois dígitos do campo representam os centavos. | Consultas de posição de recebíveis | 100000 |
| assetHolder | numérico | Número do CPF ou CNPJ do Titular do ativo | Consultas de posição de recebíveis | 99999999999999 |
| assetHolderDocumentType | texto | Tipo do documento (CPF ou CNPJ) | Consultas de posição de recebíveis | CNPJ |
| paymentScheme | texto | Sigla do Arranjo de Pagamento | Consultas de posição de recebíveis | VCC |
| debtor | numérico | Número do CNPJ da credenciadora | Consultas de posição de recebíveis | 88888888888888 |
| lastUpdated | datahora | Data da última atualização do ativo | Consultas de posição de recebíveis | 2023-12-31T18:58:48.4794377Z |
| settlementObligations | - | Grupo de obrigações de liquidação do ativo | Consultas de posição de recebíveis | - |
| key | uuid | Chave única de identificação da obrigação de liquidação | Consultas de posição de recebíveis | 0eea9195-77e0-476f -8d99-4ecc0057bf1d |
| totalAmount | numérico | Valor constituído total da obrigação de liquidação, sem descontar eventuais liquidações. Os últimos dois dígitos do campo representam os centavos. | Consultas de posição de recebíveis | 100000 |
| settledAmount | numérico | Valor total liquidado da obrigação de liquidação. Os últimos dois dígitos do campo representam os centavos. | Consultas de posição de recebíveis | 100000 |
| balanceAmount | numérico | Valor total a ser liquidado. Os últimos dois dígitos do campo representam os centavos. | Consultas de posição de recebíveis | 100000 |
| committedAmount | numérico | Valor total pendente de constituição da obrigação de liquidação para aplicação de todo ou parte do efeito do contrato. Os últimos dois dígitos do campo representam os centavos. | Consultas de posição de recebíveis | 100000 |
| uncommittedAmount | numérico | Valor total disponível da obrigação de liquidação, não negociado e não liquidado; saldo livre. Os últimos dois dígitos do campo representam os centavos. | Consultas de posição de recebíveis | 100000 |
| dueDate | data | Data de vencimento original da obrigação de liquidação | Consultas de posição de recebíveis | 2023-12-31 |
| expectedSettlementDate | data | Data prevista de liquidação da obrigação de liquidação | Consultas de posição de recebíveis | 2023-12-31 |
| originalAssetHolder | numérico | Número do CPF ou CNPJ do Originador da obrigação de liquidação | Consultas de posição de recebíveis | 88888888888888 |
| originalAssetHolderDocumentType | texto | Tipo do documento (CPF ou CNPJ) | Consultas de posição de recebíveis | CNPJ |
| assetHolder | numérico | Número do CPF ou CNPJ do beneficiário da obrigação de liquidação | Consultas de posição de recebíveis | 88888888888888 |
| assetHolderDocumentType | texto | Tipo do documento (CPF ou CNPJ) | Consultas de posição de recebíveis | CNPJ |
| obligationType | texto | Indicador de obrigação de liquidação comprometida por contrato. Se o campo estiver preenchido com “committed”, a obrigação está comprometida por contrato; se estiver preenchido com “free”, a obrigação está livre | Consultas de posição de recebíveis | committed |
| lastUpdated | datahora | Data da última atualização da obrigação de liquidação | Consultas de posição de recebíveis | 2023-12-31T18:58:48.4794377Z |
| advancements | - | Grupo de informações sobre eventuais antecipações efetuadas na obrigação de liquidação | Consultas de posição de recebíveis | - |
| key | uuid | Chave única de identificação da antecipação | Consultas de posição de recebíveis | 0eea9195-77e0-476f -8d99-4ecc0057bf1d |
| settlementObligationId | numérico | Identificação da obrigação de liquidação à qual a antecipação está associada | Consultas de posição de recebíveis | 0 |
| settlementObligationDate | data | Data para a qual a obrigação de liquidação foi antecipada | Consultas de posição de recebíveis | 2023-12-31 |
| advancedAmount | numérico | Valor antecipado da obrigação de liquidação. Os últimos dois dígitos do campo representam os centavos. | Consultas de posição de recebíveis | 100000 |
| id | numérico | Identificação da antecipação realizada na obrigação de liquidação | Consultas de posição de recebíveis | 0 |
| uniqueId | uuid | Chave única interna de controle | Consultas de posição de recebíveis | 0eea9195-77e0-476f -8d99-4ecc0057bf1d |
| createdAt | datahora | Data de criação da antecipação | Consultas de posição de recebíveis | 2023-12-31T18:58:48.4794377Z |
| updatedAt | datahora | Data de última atualização da antecipação | Consultas de posição de recebíveis | 2023-12-31T18:58:48.4794377Z |
| settlements | - | Grupo de informações sobre eventuais liquidações efetuadas na obrigação de liquidação | Consultas de posição de recebíveis | - |
| key | uuid | Chave única de identificação da liquidação | Consultas de posição de recebíveis | 0eea9195-77e0-476f -8d99-4ecc0057bf1d |
| reference | texto | Campo opcional para controle do participante | Consultas de posição de recebíveis | string |
| assetHolder | numérico | Número do CPF ou CNPJ do Titular para quem a obrigação de liquidação foi liquidada | Consultas de posição de recebíveis | 88888888888888 |
| assetHolderDocumentType | texto | Tipo do documento (CPF ou CNPJ) | Consultas de posição de recebíveis | CNPJ |
| amount | numérico | Valor liquidado da obrigação de liquidação. Os últimos dois dígitos do campo representam os centavos. | Consultas de posição de recebíveis | 100000 |
| settlementDate | data | Data efetiva da liquidação da obrigação de liquidação | Consultas de posição de recebíveis | 2023-12-31 |
| bankAccount | - | Grupo de informações sobre o domicílio bancário para o qual a obrigação de liquidação foi liquidada | Consultas de posição de recebíveis | - |
| branch | numérico | Número da agência | Consultas de posição de recebíveis | 0000 |
| account | numérico | Número da conta bancária | Consultas de posição de recebíveis | 22222222 |
| accountDigit | numérico | Dígito verificador da conta bancária | Consultas de posição de recebíveis | 3 |
| accountType | texto | Tipo da conta bancária | Consultas de posição de recebíveis | CC |
| ispb | alfanumérico | Identificador da Instituição Financeira | Consultas de posição de recebíveis | 44444444 |
| documentType | texto | Tipo do documento (CPF ou CNPJ) | Consultas de posição de recebíveis | CNPJ |
| documentNumber | numérico | Número do CPF ou CNPJ do beneficiário da conta bancária | Consultas de posição de recebíveis | 55555555555555 |
| lastUpdated | datahora | Data de última atualização da antecipação | Consultas de posição de recebíveis | 2023-12-31T18:58:48.4794377Z |
| isRejected | texto | Identificador do estado da liquidação. Se o campo estiver preenchido com “true”, a obrigação não foi liquidada; se estiver preenchido com “false”, a obrigação foi liquidada com sucesso | Consultas de posição de recebíveis | false |
| contractObligations | - | Grupo de informações sobre eventuais contratos incidentes na obrigação de liquidação | Consultas de posição de recebíveis | - |
| key | uuid | Chave única de identificação do contrato | Consultas de posição de recebíveis | 0eea9195-77e0-476f -8d99-4ecc0057bf1d |
| reference | texto | Campo opcional para controle do participante | Consultas de posição de recebíveis | string |
| contractHolderDocumentType | texto | Tipo do documento (CPF ou CNPJ) | Consultas de posição de recebíveis | CNPJ |
| contractHolder | numérico | Número do CPF ou CNPJ do beneficiário do contrato | Consultas de posição de recebíveis | 66666666666666 |
| effectPriority | numérico | Ordem de prioridade do contrato para liquidação da obrigação de liquidação. Quanto menor o número, maior a prioridade | Consultas de posição de recebíveis | 1 |
| tradeRepository | numérico | Número do CNPJ da Registradora em que foi registrada a obrigação de liquidação afetada pelo contrato | Consultas de posição de recebíveis | 11111111111111 |
| contractType | texto | Tipo de contrato. Possibilidades: ownershipAssignment (cessão) ou warranty (garantia) | Consultas de posição de recebíveis | ownershipAssignment |
| warrantyType | texto | Tipo de ônus do contrato. Possibilidades: fiduciary (cessão fiduciária) ou pledge (penhor) | Consultas de posição de recebíveis | fiduciary |
| divisionMethod | texto | Regra de divisão do contrato. Possibilidades: percentage (porcentagem) ou fixedAmount (valor fixo). | Consultas de posição de recebíveis | fixedAmount |
| effectStrategy | texto | Tipo de estratégia adotada para a criação do contrato. Possibilidade: “specific“ (contrato afeta relações específicas) | Consultas de posição de recebíveis | specific |
| effectAmount | numérico | Valor comprometido conforme a regra de divisão do contrato (em porcentagem quando percentage; em valor monetário quando fixedAmount). Os últimos dois dígitos do campo representam os centavos. | Consultas de posição de recebíveis | 100000 |
| percentageValue | numérico | Porcentagem de valor da obrigação de liquidação comprometido pelo contrato. Só será preenchido caso divisionMethod = "percentage". Os últimos dois dígitos do campo representam as duas casas decimais. | Consultas de posição de recebíveis | 10000 |
| isCanceled | texto | Identificador do estado do contrato. Se o campo estiver preenchido com “true”, o contrato está inativo; se estiver preenchido com “false”, o contrato está ativo | Consultas de posição de recebíveis | false |
| committedEffectAmount | numérico | Valor da obrigação de liquidação efetivamente comprometido pelo contrato. Os últimos dois dígitos do campo representam os centavos. | Consultas de posição de recebíveis | 100000 |
| bankAccount | - | Grupo de informações sobre o domicílio bancário para o qual a obrigação de liquidação foi liquidada | Consultas de posição de recebíveis | - |
| branch | numérico | Número da agência | Consultas de posição de recebíveis | 0000 |
| account | numérico | Número da conta bancária | Consultas de posição de recebíveis | 22222222 |
| accountDigit | numérico | Dígito verificador da conta bancária | Consultas de posição de recebíveis | 3 |
| accountType | texto | Tipo da conta bancária | Consultas de posição de recebíveis | CC |
| ispb | alfanumérico | Identificador da Instituição Financeira | Consultas de posição de recebíveis | 44444444 |
| documentType | texto | Tipo do documento (CPF ou CNPJ) | Consultas de posição de recebíveis | CNPJ |
| documentNumber | numérico | Número do CPF ou CNPJ do beneficiário da conta bancária | Consultas de posição de recebíveis | 55555555555555 |
| createdAt | datahora | Data da criação do contrato | Consultas de posição de recebíveis | 2023-12-31T18:58:48.4794377Z |
| lastUpdated | datahora | Data de última atualização do contrato | Consultas de posição de recebíveis | 2023-12-31T18:58:48.4794377Z |
