Create or update Debtor

post

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

Creating a Debtor is a first optional step before creating an invoice linked to this debtor. All contacts will be stored on the debtor when using this endpoint. ⚠️ Creating a Debtor that already exists will overwrite previous contacts.

Path Params

companyId

string

required

Defaults to me

Body Params

identifier

object

required

Business identifier of the client being invoiced.

name

string

required

Example: Acme Corporation

address

object

Address of the Debtor's main office. Since this information will be used for scoring, kindly ensure the details are accurate. Required for German Debtors.

country

string

enum

required

Country code (ISO-3166-Alpha2). Must be written in uppercase.

contacts

array of objects

required

List of contact information, for financial recovery purposes.

contacts*

Headers

x-end-user-ip

string

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

Responses

Language

Credentials

URL

Response

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

application/json

200Debtor updated successfully

201Debtor created successfully

400Invalid payload