Create a new receivable

post

https://api.sandbox.helloaria.eu/companies/{companyId}/receivables

Receivables refer to money owed to the beneficiary (user) by the debtor for goods or services that have been delivered or used but not yet paid for. You should only create receivables before requesting a Loan if an Invoice has not be issued yet. You’ll be able to link Receivables to your Invoice later.

Path Params

companyId

string

required

Defaults to me

Body Params

debtorId

uuid

required

Unique ID assigned to a Debtor.

attachments

array of objects

Attachments that provide evidence of the receivable's status, such as pro-forma invoices, delivery certificates, or other relevant documents. The file needs to be uploaded with the upload file endpoint first.

attachments

totalAmountExcludingTaxes

number

required

Receivable Amount excluding tax.

totalAmountIncludingTaxes

number

required

Receivable Amount including tax.

currency

string

enum

required

Allowed:

deliveredAt

date-time

Date on which the service or good has been delivered, after which the receivable can be considered as UNBILLED

receivableOwner

string

enum

Indicates the ultimate owner of the Receivable who is responsible for assigning the debt. The owner can either be your company or the beneficiary of the Loan. Please use this field only when you encounter different use cases.

Allowed:

debtorIdentifier

object

required

Business identifier of the client being invoiced.

reference

string

required

Unique reference of your choice that defines the Receivable.

expectedInvoiceDate

date-time

required

The date on which you expect the invoice to be issued. Must be written in ISO 8601 format.

expectedInvoicePaymentTerm

string

required

Payment terms that will be indicated on the Invoice. You can find available durations with a GET /company call. To be set if you have these information early on but did not create the Invoice yet.

expectedInvoicePaymentTermType

string

enum

required

Allowed:

Headers

x-end-user-ip

string

IP of the end-user doing the action resulting in the API call.

Responses

Language

Credentials

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Successfully created or updated receivable

400Invalid payload

403Not permitted (e.g trying to create a receivable for a company other than yours)

409Conflict (i.e creating a receivable linked to Loans in a wrong status)