Create a new receivable

post

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

Receivables refer to money owed to the beneficiary (user) by the debtor for goods or services that have been delivered or used but not yet paid for. You should only create receivables before requesting a Loan if an Invoice has not be issued yet. You’ll be able to link Receivables to your Invoice later.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

companyId

string

required

Defaults to me

Body Params

debtorId

uuid

required

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

required

Receivable Amount excluding tax.

totalAmountIncludingTaxes

number

required

Receivable Amount including tax.

currency

string

enum

required

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

required

Identifier representing the debtor being invoiced

reference

string

required

Unique reference of your choice that defines the Receivable.

expectedInvoiceDate

date-time

required

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

expectedInvoicePaymentTerm

number

required

≥ 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

required

Allowed:

proofIds

array of uuids

length ≤ 20

Ids of proofs created beforehand, linked to the new Receivable. At least one proof is required, through proofIds or through attachments, otherwise creation is rejected with PROOF_REQUIRED. Create each proof first through POST /companies/{companyId}/proofs with no targets. Cannot be combined with the deprecated attachments in the same call. Accepted on creation only: afterwards use the proof endpoints.

proofIds

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 created or updated receivable

400Invalid payload. CONFLICTING_EVIDENCE_CARRIERS if the body carries both attachments and proofIds. Also returned when one of the proofIds is archived.

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

404One of the proofIds does not exist or belongs to another company.

409Conflict (i.e creating a receivable linked to Loans in a wrong status). DUPLICATE_PROOF if one of the proofIds carries a file that another active proof already links to the new object.

422PROOF_REQUIRED if no proof was provided, through proofIds or through the deprecated attachments. INVALID_PROOF_TYPE if a proof carries a type that is not legal on a Receivable.