API Reference
Start typing to search…

Edit company

patch https://api.sandbox.helloaria.eu/companies/
Log in to see full request history
Path Params
string
required
Defaults to me
Body Params
string

Name of the company

identifier
object

Identifier of the company

address
object
Responses

Response body
object
string
required

Opaque identifier

date-time
required

Creation date in ISO 8601 UTC format

date-time
required

Last update date in ISO 8601 UTC format

string
required

Name of the company

identifier
object
required

Identifier of the company

string
required

bn bsn cben chrn cif cofis crn cro cuit duns ein hr kvk idno nif nipc nit nrt orgnr pan rea run siren siret ste tin trn uen utr vat-number

string
required

Actual identifier depending on the selected type

string
required

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

AF AL DZ AS AD AO AI AQ AG AR AM AW AU AT AZ BS BH BD BB BY BE BZ BJ BM BT BO BA BW BV BR IO BN BG BF BI KH CM CA CV KY CF TD CL CN CX CC CO KM CG CD CK CR CI HR CU CY CZ DK DJ DM DO EC EG SV GQ ER EE ET FK FO FJ FI FR GF PF TF GA GM GE DE GH GI GR GL GD GP GU GT GN GW GY HT HM VA HN HK HU IS IN ID IR IQ IE IL IT JM JP JO KZ KE KI KP KR KW KG LA LV LB LS LR LY LI LT LU MO MG MW MY MV ML MT MH MQ MR MU YT MX FM MD MC MN MS MA MZ MM NA NR NP NL NC NZ NI NE NG NU NF MP MK NO OM PK PW PS PA PG PY PE PH PN PL PT PR QA RE RO RU RW SH KN LC PM VC WS SM ST SA SN SC SL SG SK SI SB SO ZA GS ES LK SD SR SJ SZ SE CH SY TW TJ TZ TH TL TG TK TO TT TN TR TM TC TV UG UA AE GB US UM UY UZ VU VE VN VG VI WF EH YE ZM ZW AX BQ CW GG IM JE ME BL MF RS SX SS XK

address
object
string
required

Primary address line

string

Optional secondary address line

string
required

City (i.e Paris)

string

Region or state

string
required

Postal code (i.e 75013)

string
required

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

AF AL DZ AS AD AO AI AQ AG AR AM AW AU AT AZ BS BH BD BB BY BE BZ BJ BM BT BO BA BW BV BR IO BN BG BF BI KH CM CA CV KY CF TD CL CN CX CC CO KM CG CD CK CR CI HR CU CY CZ DK DJ DM DO EC EG SV GQ ER EE ET FK FO FJ FI FR GF PF TF GA GM GE DE GH GI GR GL GD GP GU GT GN GW GY HT HM VA HN HK HU IS IN ID IR IQ IE IL IT JM JP JO KZ KE KI KP KR KW KG LA LV LB LS LR LY LI LT LU MO MG MW MY MV ML MT MH MQ MR MU YT MX FM MD MC MN MS MA MZ MM NA NR NP NL NC NZ NI NE NG NU NF MP MK NO OM PK PW PS PA PG PY PE PH PN PL PT PR QA RE RO RU RW SH KN LC PM VC WS SM ST SA SN SC SL SG SK SI SB SO ZA GS ES LK SD SR SJ SZ SE CH SY TW TJ TZ TH TL TG TK TO TT TN TR TM TC TV UG UA AE GB US UM UY UZ VU VE VN VG VI WF EH YE ZM ZW AX BQ CW GG IM JE ME BL MF RS SX SS XK

string
deprecated

SIREN of the company

string

base64-encoded logo

config
object
required
boolean
required
Defaults to false

Is true if you are the user's (beneficiary) direct client, and thereby the debtor.

boolean
required

Is true if contract has to be sent to users (beneficiaries)

boolean

Is true if Quotes feature has been activated for your Company.

boolean
Defaults to false

Is true if Guarantor feature has been activated for your Company.

currencyConfigs
array of objects
required
currencyConfigs*
object
string
required

EUR GBP USD

repaymentDestinations
array
required
repaymentDestinations*

PaymentDestination used for all loans

string

Prefilled Loan.payoutLabel template

repaymentPeriodOptions
array of numbers
deprecated

Available repaymentPeriods (in days) you have to set when creating an Invoice.

repaymentPeriodOptions
paymentTermOptions
object
string

aria company

string

user company

string

beneficiary company

metadataJsonSchema
object

Defines the schema for the debtorMetadata field when creating an Invoice.

Has additional fields
string
deprecated

Prefilled label template

repaymentPeriodOptions
array of numbers
deprecated

Available repaymentPeriods you have to set when creating an Invoice

repaymentPeriodOptions
boolean
deprecated

IBAN used to force payment to a single bank account.

boolean
deprecated
string
deprecated

DEPRECATED: IBAN to use to repay Aria (only for EUR)

string
deprecated

DEPRECATED: BIC to use to repay Aria (only for EUR)

string
deprecated

DEPRECATED: alias for refundIBAN

Updated over 1 year ago

Did this page help you?
Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago

Did this page help you?