API Reference

Register a CreditLimit

post
https://api.sandbox.helloaria.eu/companies//credit-limits

This endpoint allows you to ask the credit Aria is willing to finance for a given client.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Defaults to me
Body Params
uuid

Unique ID assigned to a Debtor. When registering a Credit limit for a German Debtor, you must provide one of the following: debtorId (Debtor associated to a Debtor's address) or debtorAddress.

number
> 0

Amount you want Aria to finance. To fill if you have an idea of the overall envelope amount or if you want to challenge an amount that was already decided by Aria.

string
enum
required
Allowed:
debtorIdentifier
object
required

Business identifier of the client being invoiced. Use either this field or debtorId. In any case, we suggest first creating a Debtor prior to creating a credit-limit and making use of the debtorId field.

debtorAddress
object

Address of the Debtor's main office. When registering a Credit limit for a German Debtor, you must provide one of the following: debtorId (Debtor associated to a Debtor's address) or debtorAddress.

string
required

Company name of the Debtor. Only required if has not been set on the Debtor previously.

string
enum

Defines what creditLimit.allocation you want to target when asking for a Credit limit revision. We recommand you to use this field only if you know how Credit limit segments work.

Allowed:
string

Use this field to provide any additional information or context about the buyer that you believe may influence the credit limit decision. This could include specific circumstances, financial considerations, or any other relevant details that support your request.

attachments
array of objects

Use this field to provide any additional documents about the buyer that you believe may influence the credit limit decision. The file needs to be uploaded with the upload file endpoint first.

attachments
Headers
string

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

Responses

Updated 11 months ago

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

Updated 11 months ago