Skip to main content

Manually add a deposit beneficiary

There was a bug with the FundDistribution component and adhoc invoices that resulted in no deposit beneficiary being configured for deposit top up invoices. See

Common Steps​

  1. Open Insomnia
  2. Login with your user account (support user access required)
  3. Switch to the agency in question using Switch Agency API endpoint /user/login_to_agency

Steps for manually adding/updating a deposit beneficiary on an invoice on the invoicing service (not sent)​

  1. Follow the common steps above
  2. Fetch the invoice entity in questions using the GET Invoice Entity endpoint.
  3. Copy response and paste it into the Update Invoice request
  4. Remove unecessary fields id , tags and map customer object to customerTag and customer fields.

Example:

"customer": {
  "partyId": "35531ed2-8304-4386-afc9-100a39d0f514",
  "customerTag": "Tenant",
  "name": "Waltor Mellon"
},

Should be:

  "customer": "35531ed2-8304-4386-afc9-100a39d0f514",
  "customerTag": "Tenant"
  1. Follow 2. sub-steps below to format the deposit beneficiary object and update the beneficiaries field in the Update Invoice request payload
  2. Double check and submit request

Steps for manually adding/updating a beneficiary on an invoice on the recon service (sent)​

  1. Follow common steps above
  2. Use the payload below on the Update Invoice Beneficiaries API endpoint reconciliations/invoices/{{ invoiceId }}/beneficiaries
    1. Ensure you have the right invoiceID in the URL
    2. Add the agencyId into the partyId field value. Can be found in the payload from step 3
    3. Check if the agency is vat registered and update the vat field accordingly
    4. Check if it's a reOS managed deposit or not and update the transfer field. reOS managed = true, not reOS managed = false
    5. Update the amount to match the invoice amount
[
  {
  "type": "DepositBeneficiary",
  "value": {
    "partyId": "___",
    "reference": "Transfer to managed deposit account on reOS",
    "beneficiaryTag": "TenantDepositAccount",
    "amount": 0,
    "vat": false|false,
    "transfer": true|false
  }
 }
]