Assignment notice

Definition

When Aria finances an invoice, the receivable is assigned to Aria and its financing partners, and the debtor must be told which receivables were assigned. A sentence printed once on the PDF to inform Debtors work but you could issue the PDF before Aria decides on the Loan, and a refused Loan would make the sentence false.

An assignment notice solves this with a permanent link that you print on the invoice. The link opens an Aria page that shows, for that invoice only, which receivables were acquired. The page reads the current status of the Loans each time it opens, so a decision taken after you issued the PDF will always show on the page.

You can put a notice on every invoice you issue, financed or not, thanks to this link.

Integration flow

1. Create a notice before you generate the invoice PDF, with Create an assignment notice. The response holds the notice id and its url.
2. Print the url on the invoice, next to the mention that Aria gives you. You can add a QR code that points to the same URL.
3. Send the invoice to the debtor.
4. Create the Invoice in Aria with assignmentNoticeId set to the notice id, with Create a new Invoice.
5. Request the Loans.

If you created the Invoice without assignmentNoticeId, bind the notice later with Bind an assignment notice to an Invoice. This works whatever the status of the Loans of the Invoice.

If you do not issue the invoice PDF yourself, create the notice and give its URL to the seller. The seller adds it to the invoice before you upload the invoice to Aria.

📘

Bind the notice before you request a Loan

As long as the notice is not bound, the page says that no receivable on the document was acquired.

// POST /companies/me/assignment-notices
// Idempotency-Key: 0b8f6c1e-2d4a-4f3b-9c7e-5a1d2e3f4b6c
{}

// 201
{
  "id": "6f1c2d3e-4b5a-4c6d-8e7f-9a0b1c2d3e4f",
  "url": "https://portal.helloaria.eu/assignment-notices/3kP9xQaB7cD2eF4gH6iJ8k",
  "invoiceId": null
}

// POST /companies/me/invoices
{
  "invoiceNumber": "F-2026-0042",
  "assignmentNoticeId": "6f1c2d3e-4b5a-4c6d-8e7f-9a0b1c2d3e4f",
  ...
}

Reading the notice

The Invoice carries the bound notice in assignmentNotice, on Get an Invoice, List Invoices and Create a new Invoice:

{
  "assignmentNotice": {
    "id": "6f1c2d3e-4b5a-4c6d-8e7f-9a0b1c2d3e4f",
    "url": "https://portal.helloaria.eu/assignment-notices/3kP9xQaB7cD2eF4gH6iJ8k"
  }
}

• assignmentNotice is null when no notice is bound to the Invoice.
• Use id to check which notice is bound. Do not parse url, and do not build it yourself.
• The url of a notice never changes and never expires.

The invoice.created, invoice.updated and invoice.deleted webhooks carry the same assignmentNotice object:

• A bind at Invoice creation sends invoice.created with the notice.
• A later bind sends invoice.updated with the notice.
• invoice.deleted always carries null, because the delete unbinds the notice first.

Rules

• An Invoice has at most one notice, and a notice is bound to at most one Invoice.
• Binding again the notice that is already bound to the Invoice changes nothing.
• A bound notice cannot be moved to another Invoice through the API.
• Deleting an Invoice unbinds its notice. The link keeps working and says that no receivable on the document was acquired. You can bind the notice again, to the Invoice you create again or to another Invoice of the same company.
• A notice is never deleted.

What the debtor sees

The page shows one invoice and nothing else:

• the invoice number and its total amounts, excluding and including taxes;
• one line per Loan of the invoice, with its amount and its status: acquired, or not decided yet.

A Loan is acquired from the moment Aria accepts it, and stays acquired after payment and repayment. Refused and canceled Loans are not shown. The page shows no name, no contact and no bank details of the seller or the debtor.