Campos customizáveis

Os campos customizáveis podem ser usados para facilitar a operação e o processamento do cliente.

O campo referência (reference) é um campo encontrado em diversos EndPoints na API e representa uma chave de seu sistema associada ao objeto a ser enviado.

Seu preenchimento não é obrigatório. No entanto, a referência pode facilitar a conciliação e outros processamentos do cliente.

Os campos de referência aceitam até 100 dígitos alfanuméricos e podem ser adicionadas diversas informações de referência, não podendo, entretanto, serem excluídas.

Exemplo de utilização da referência

{
  "processReference":"PR_550",
  "receivables":[
    {
     "reference":"UR_455",
     "dueDate":"2020-02-02",
     "originalAssetHolderDocumentType":"CPF,CNPJ",
     "originalAssetHolder":"99999999999999",
     "paymentScheme":"VCC",
     "amount":5000000,
     "prePaidAmount": 0,
     "bankAccount":{
       "branch":"1144",
       "account":"13341",
       "accountDigit":"X5",
       "accountType":"CC",
       "ispb":"34100000",
       "documentType":"CPF,CNPJ",
       "documentNumber":"99999999999999"
     },
     "settlements":[
        {
          "reference":"L_1875",
          "assetHolderDocumentType":"CPF,CNPJ",
          "assetHolder":"99999999999999",
          "settlementDate":"2021-11-01",
          "settlementObligationDate":"2021-11-01",
          "amount":10000,
          "bankAccount":{
            "branch":"4322",
            "account":"00211",
            "accountDigit":"X4",
            "accountType":"CC,CD,CG,CI,PG",
            "ispb":"34100000",
            "documentType":"CPF,CNPJ",
            "documentNumber":"00000000000000"
          }
        }
     ]
    }
  ]
}

No exemplo acima, temos um registro de uma Agenda, contendo um recebível e uma liquidação com os seguintes identificadores hipotéticos:

  • UR_455 é o identificador de seu sistema para a Unidade de Recebíveis.
  • L_1875 é o identificador de seu sistema para a Liquidação.

api.nonprod.taginfraestrutura.com.br/receivable/reference/UR_455

Para fins de conciliação, utilizando os dados anteriores, você poderia realizar uma Consulta de Agenda por Referência conforme exemplo abaixo:

Sendo assim, utilizando a referência UR_455, o resultado esperado seria:

{
  "receivables":[
    {
      "key":"29e17daca8b1bad85d97599c95a61721",
      "reference":"UR_455",
      "dueDate":"2021-01-01",
      "paymentScheme":"VCC",
      "debtor":"0101010101",
      "originalAssetHolderDocumentType":"CPF,CNPJ",
      "originalAssetHolder":"1212121212",
      "amount":800,
      "prePaidAmount":0,
      "createdAt":"2020-09-23T13:14:04.0555155Z",
      "lastUpdated":"2020-09-23T13:14:04.0555155Z",
      "settlementObligations":[
        {
          "key":"29e17daca8b1bad85d97599c95a61721",
          "totalAmount":800,
          "settledAmount":100,
          "balanceAmount":700,
          "committedAmount":200,
          "uncommittedAmount":500,
          "expectedSettlementDate":"2021-01-01",
          "assetHolderDocumentType":"CPF,CNPJ",
          "assetHolder":"1212121212",
          "lastUpdated":"2020-09-23T13:14:04.055",
          "settlements":[
            {
              "key":"f03c2e1a-3116-44c0-8edd-b56f",
              "reference":"f03c2e1a-3116-44c0-8ed",
              "assetHolderDocumentType":"CPF,CNPJ",
              "assetHolder":"99999999999",
              "amount":100,
              "settlementDate":"2021-01-01",
              "bankAccount":
              {
                "branch":"4322",
                "account":"00211",
                "accountDigit":"X4",
                "accountType":"CC,CD,CG,CI,PG,PP",
                "ispb":"34100000",
                "documentType":"CPF,CNPJ",
                "documentNumber":"00000000000000"
              },
              "lastUpdated":"2020-09-23T13:14:04.05",
              "isReject":true,false,
            }
          ],
          "contractObligations":[
          {
            "key":"f03c2e1a-3116-44c0-8edb5",
            "reference":"f03c2e1a-3116-44c0-8edd-6f",
            "contractHolderDocumentType":"CPF,CNPJ",
            "contractHolder":"99999999999",
            "effectPriority":1,
            "contractType":"warranty",
            "warrantyType":"fiduciary",
            "divisionMethod":"fixed",
            "effectStrategy":"overall, specific",
            "effectAmount":200,
            "committedEffectAmount":200,
            "bankAccount":{
              "branch":"4322",
              "account":"00211",
              "accountDigit":"X4",
              "accountType":"CC,CD,CG,CI,PG,PP",
              "ispb":"34100000",
              "documentType":"CPF,CNPJ",
              "documentNumber":"00000000000000"
            },
            "lastUpdated":"2020-09-23T13:14:04.0555"
          }
        ]
       }
     ]
    }
  ],
  "extractionReferenceDate":"2021-01-01",
  "recipient":"00000000000",
  "recipientDocumentType":"CPF,CNPJ",
  "processKey":"8865a756-6588-4116-a406-59248",
  "createdAt":"2020-09-23T13:14:04.0555155Z"
}

Caso tenha dúvidas, ou gostaria de mais detalhes em como otimizar seu uso, contate nossa equipe de suporte.