API Reference

Edit a receivable

patch
https://api.sandbox.helloaria.eu/companies//receivables/

Note: Only works when all linked Loans are in CREATED state.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Defaults to me
string
required
Body Params
uuid

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
number

Receivable Amount excluding tax.

number

Receivable Amount including tax.

string
enum
Allowed:
date-time

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

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

Identifier representing the debtor being invoiced

string

Unique reference of your choice that defines the Receivable.

date-time

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

string

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.

string
enum
Allowed:
Headers
string

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

Responses

Updated 11 months ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago