Nesta local, esta mapeado os atributos que compõe os "Conciliação", o dicionário de dados tem como objetivo, orientar o uso cada campo, seu preenchimento, obrigatoriedade e um exemplo de seu conteúdo.
| Atributo | Informativo | Definição | Presente em |
Conteúdo (Exemplo) |
|---|---|---|---|---|
| compact | Indicador booleano opcional | Opção de compactar os arquivos que serão recebidos via notificação. | Conciliação | true |
| createdAt | Data no formato yyyy-mm-dd, apresenta também horário da criação | Data de criação da conciliação | Notificação - Conciliação | 2020-03-10 T12:51:35.000Z |
| errors | Lista de strings de erros da requisição | Lista de erros da requisição | Conciliação - Consulta - Confirmação | error message |
| eventType | String 'reconciliation' indicando o tipo de evento da notificação | Identificador do tipo de evento da notificação | Notificação | reconciliation |
| extractionReferenceDate | Data no formato yyyy-mm-dd, apresenta também horário da criação | Data de referencia recebida na solicitação e que foi usada para a extração da conciliação | Conciliação - Notificação - Consulta - Confirmação | 2020-03-10 T12:51:35.000Z |
| lastUpdated | Data no formato yyyy-mm-dd, apresenta também horário da criação | Data de atualização da conciliação | Notificação - Consulta - Confirmação | 2020-03-10 T12:51:35.000Z |
| Message | Campo opcional que pode vir preenchido caso ocorra erro | Mensagem de erro, caso o processamento seja negado. | Notificação - Conciliação | error message |
| page | Conteúdo somente números sem formatação | Página consultada | Consulta | 1 |
| pages | Objeto com informações de paginação | Informações de paginação | Consulta | {"page": 1, "perPage": 100, "totalPages": 25} |
| perPage | Conteúdo somente números sem formatação | Número indicativo de quantas urls por página | Consulta | 100 |
| totalPages | Conteúdo somente números sem formatação | Total de páginas | Consulta | 25 |
| processKey | Conteúdo de valor único em formato alfanumérico, com dados separados por hífen | Chave da solicitação de processamento | Notificação - Conciliação | eaf-ed17-4a84-92e0 -7a39dc4561ec |
| processPercentage | Conteúdo somente números sem formatação | Porcentagem que já foi executada do processo de geração de arquivos de conciliação | Notificação - Conciliação | 85.32 |
| recipient | Conteúdo somente números sem formatação | Número de Documento do Participante recebedor da notificação | Notificação - Consulta | 888888 88888888 |
| recipientDocumentType | String 'CNPJ' ou 'CPF' indicando o tipo de documento | Tipo de Documento do Participante recebedor da notificação | Notificação - Consulta | 2020-03-10 T12:51:35.000Z |
| reconciliation Date |
Data no formato yyyy-mm-dd | Data de referência para ser usada na extração da conciliação | Conciliação | 2020-07-02 |
| reconciliation Key |
Conteúdo de valor único em formato alfanumérico, com dados separados por hífen | Chave única da conciliação | Notificação - Conciliação - Consulta - Confirmação | 56614efa-5026-4c6c -93ad-3b4 |
| reconciliation Status |
Estado do processamento da conciliação | Estado da conciliação | Notificação - Conciliação - Consulta - Confirmação | pending |
| urls | Lista de URL do Bucket para download do arquivo da conciliação | Link de um repositório na Web. | Notificação - Conciliação | https://api. receivable staging. taginfraestrutura .com.br/ reconciliation/ file/56614efa- 5026 -4c6c-93ad- 3b406729effb |
