API Reference

Edit an Invoice

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

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

Path Params
string
required
Defaults to me
string
required
Body Params
uuid

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).

uuid

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

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
number

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

number

Invoice Amount excluding tax.

string
enum
Allowed:
date-time

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

string

Unique invoice number

string
enum

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.

Allowed:
string

Name of the client being invoiced.

debtorIdentifier
object

Identifier representing the debtor being invoiced

contacts
array of objects

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

contacts
debtorMetadata
object

We may ask you to provide specific properties in this field to enable automation on our side. The specific format and properties will be determined during your onboarding process and can be retrieved via a GET request to /company (metadataJsonSchema).

string
enum
Allowed:
number

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
Headers
string

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

Responses

Updated 11 months ago

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