Create a new Quote

post

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

Get an immediate approval or rejection by Aria, for an order in purchase or invoice stage.

🪄 Quotes are decided and returned instantly: When accepted, one or more offers are returned. An offer then has to be selected by you or your users and linked to the Loan..

Path Params

companyId

string

required

Defaults to me

Body Params

items

array of objects

required

List of items (goods, services, or fees) purchased by the buyer (Debtor).

items*

externalId

string

required

length ≥ 1

Identifier from your system that represents the related order, purchase, or invoice. A 409 error is returned if you attempt to create a Quote using an externalId that already exists on a Quote that is not CANCELED.

cancelIfExists

boolean

When set to true, any existing Quote with the same externalId will be automatically cancelled and replaced by the new one. This prevents 409 errors when recreating Quotes with the same externalId.

sandboxPresets

object

Sandbox-only field. Allows you to override/force preset values used to generate Quote offers in sandbox environments. Ignored in production.

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

201Quote successfully created

400Invalid companyId and/or body

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

409Conflict (e.g trying to create a new quote with an externalId that is already set on a Quote that is not canceled)