Edit an Invoice

patch

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

Note: Only works when all linked Loans are in CREATED state. proofIds is not accepted here, it is a creation-only field: once the object exists, evidence is added through POST /companies/{companyId}/proofs and linked through POST /companies/{companyId}/proofs/{proofId}/link. The deprecated attachments field is still accepted and still replaces the list, see the field description for how it maps onto proofs.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

companyId

string

required

Defaults to me

invoiceId

string

required

Body Params

debtorId

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

creditLimitId

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

length ≥ 0

deprecated

Deprecated, use proofIds on creation or the proof endpoints instead. Lists the non-archived proofs linked to this Invoice with source: COMPANY. On PATCH the list you send replaces the current one: a new file becomes a proof of type: INVOICE, a dropped one is archived. Omit the field and nothing changes. See the Proof guide.

attachments

totalAmountIncludingTaxes

number

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

totalAmountExcludingTaxes

number

Invoice Amount excluding tax.

currency

string

enum

Allowed:

invoiceDate

date-time

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

invoiceNumber

string

Unique invoice number

invoiceOwner

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:

debtorName

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

paymentTermType

string

enum

Allowed:

repaymentPeriod

number

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

Headers

x-end-user-ip

string

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

Responses

Language

Credentials

URL

Loading…

Response

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

application/json

201Successfully edited Invoice

400Invalid payload, including any attempt to set proofIds on an existing object

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

404Invoice not found