Edit a receivable

patch

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

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

receivableId

string

required

Body Params

debtorId

uuid

Unique ID assigned to a Debtor.

attachments

array of objects

deprecated

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

attachments

totalAmountExcludingTaxes

number

Receivable Amount excluding tax.

totalAmountIncludingTaxes

number

Receivable Amount including tax.

currency

string

enum

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

Identifier representing the debtor being invoiced

reference

string

Unique reference of your choice that defines the Receivable.

expectedInvoiceDate

date

The date on which you expect the invoice to be issued, as a calendar date in ISO 8601 format (YYYY-MM-DD).

expectedInvoicePaymentTerm

number

≥ 0

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

expectedInvoicePaymentTermType

string

enum

Allowed:

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 receivable

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

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

404receivable not found

409Conflict (i.e updating a receivable linked to Loans in a wrong status). PROOF_REQUIRED if the attachments you sent would leave the Receivable with no proof at all, attachments: [] included. PROOF_LOCKED if a Loan on this Receivable is in any status other than CREATED.