API Reference
Start typing to search…

List Invoices

get https://api.sandbox.helloaria.eu/companies//invoices
Log in to see full request history
Path Params
string
required
Defaults to me
Query Params
string

Available filters: id, createdAt, companyId, invoiceDate, invoiceNumber, receivableId, dueDate, repaymentPeriod, totalAmountExcludingTaxes, totalAmountIncludingTaxes, currency, debtorName, debtorIdentifier.value, debtorIdentifier.type.

string

Available sorting options: id, createdAt.

string

Number of items (page size) when using forward pagination. Check out guides for more infos.

string

Opaque cursor when using forward pagination. Check out guides for more infos.

string

Number of items (page size) when using backward pagination. Check out guides for more infos.

string

Opaque cursor when using backward pagination. Check out guides for more infos.

Responses

Response body
array of objects
object
string
required

Opaque identifier

date-time
required

Creation date in ISO 8601 UTC format

date-time
required

Last update date in ISO 8601 UTC format

string

Unique ID assigned to a Debtor. When registering an Invoice for a German Debtor, you must provide one of the following: debtorId (Debtor associated to a Debtor's address), creditLimitId (Credit limit associated to a Debtor's address).

string

Unique ID assigned to a Credit limit. When registering an Invoice for a German Debtor, you must provide one of the following: debtorId (Debtor associated to a Debtor's address), creditLimitId (Credit limit associated to a Debtor's address).

receivableIds
array of strings

List of receivables to be linked to this Invoice, before or after requesting a Loan.

receivableIds
attachments
array of objects
required

Mandatory sales invoice uploaded with the Upload file endpoint. If you also work with purchase invoices, you may upload them in the Loan endpoint.

attachments*
object
string
uri
required
labels
object
Has additional fields
number
required

Invoice Amount including tax. May differ from the amount in the Loan.

number
required

Invoice Amount excluding tax.

string
required

EUR GBP USD

date-time
required

Date on which the invoice is generated, in ISO 8601 UTC format.

string
required

Unique invoice number

string

Indicates the ultimate owner of the Invoice 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.

user company

string
required

Name of the client being invoiced.

debtorIdentifier
object
required

Identifier representing the debtor being invoiced

contacts
array of objects
required

Only required if no contact has been provided on the Debtor previously.

contacts*
object
string
required
string
string
string
required

Please use the international format, starting with +, i.e +33612345678.

string

Job of role of the person to contact.

debtorMetadata
object

Contains details about the Debtor to facilitate quicker payments to your suppliers. The specific format and properties will be determined during your onboarding process and can be retrieved via a GET request to /company (metadataJsonSchema).

Has additional fields
string

net eom eomf

number
required

Actual payment terms written on the invoice. You can find available durations with a GET /company call. Choose one of the contracted terms, agreed with Aria.

metadata
object
Has additional fields
string
required
length ≥ 1
date-time
required

Date by which the invoice and its loans must have been repaid. Must be written in ISO 8601 format.

string
required

Status of the Invoice. Will stay OPEN if no Loan has been linked to this invoice or has been paid yet

OPEN REPAID CANCELED PAST_DUE

string
date-time

Date at which the Invoice was validated through your system.

date-time

Date at which the Invoice was validated by Aria.

Updated over 1 year ago

Did this page help you?
Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago

Did this page help you?