HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference
Terms of Use

Partner / Create

post
https://{tenantUrl}/public-api/resources/partners/v2.0

Create new partner

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

At least one of name or translatedName must be provided. Supplying both is rejected with a 422 response. When translatedName is used it must carry an en entry.

string

The Partner's business name is used when showing the name of the Partner to EV drivers and admin users. If not provided, the name will be used instead.

reimbursement
object

Home-charging reimbursement settings of the Partner.

Submitting this object while the home-charging reimbursement feature is disabled for the operator is rejected with a 422 response.

notifications
object
string
deprecated

This property is deprecated. Use translatedName instead.

The value is written to the English (en) locale only. Cannot be provided together with translatedName.

Company name of the Partner

translatedName
array of objects

Company name of the Partner per locale. Whenever this field is submitted — on both create and update — the array must contain an en entry. Only locales configured for the tenant are accepted.

Submitting this field replaces the whole locale set for the name: locales absent from the array are cleared. Omit the field to leave every existing locale untouched. An empty array is rejected on both create and update — the name cannot be cleared.

Cannot be provided together with the deprecated name.

translatedName
string | null
string | null
string | null
deprecated

This property is deprecated. Use translatedAddress instead.

The value is written to the English (en) locale only. Cannot be provided together with translatedAddress.

translatedAddress
array of objects

Address of the Partner per locale. Only locales configured for the tenant are accepted.

Submitting this field replaces the whole locale set for the address: locales absent from the array are cleared. Omit the field to leave every existing locale untouched; submit an empty array to clear them all.

Cannot be provided together with the deprecated address.

translatedAddress
string | null
string | null
deprecated

This property is deprecated. Use translatedCity instead.

The value is written to the English (en) locale only. Cannot be provided together with translatedCity.

translatedCity
array of objects

City of the Partner per locale. Only locales configured for the tenant are accepted.

Submitting this field replaces the whole locale set for the city: locales absent from the array are cleared. Omit the field to leave every existing locale untouched; submit an empty array to clear them all.

Cannot be provided together with the deprecated city.

translatedCity
string | null
enum
string | null
deprecated

This property is deprecated. Use translatedRegion instead, when the Partner's country does not support states. When the country is one of US, AU, CA, UM or RO, state applies instead of both region and translatedRegion.

The value is written to the English (en) locale only. Cannot be provided together with translatedRegion.

When country is not in US, AU, CA, UM or RO, you can provide the region

translatedRegion
array of objects

Region of the Partner per locale. Only locales configured for the tenant are accepted.

Submitting this field replaces the whole locale set for the region: locales absent from the array are cleared. Omit the field to leave every existing locale untouched; submit an empty array to clear them all.

Rejected when the Partner's country supports states (US, AU, CA, UM, RO) — state applies instead and is not translatable. Cannot be provided together with the deprecated region.

translatedRegion
enum

State/province code for countries with predefined states (US, AU, CA, UM, RO).

This is a controlled code, not a translation: it is the same string in every language, has no translated sibling, and is not affected by the locale of any other field on this resource.

When the country is US.

contactDetails
object | null
number | null
string | null

Prefix used for the Partner's receipt numbering. Takes effect only when options.supplierOnReceipts is true.

string | null
^\d+(\.\d+)?$

Starting number for the Partner's receipt numbering. Numeric string; leading zeros are preserved. Takes effect only when options.supplierOnReceipts is true.

string | null

Prefix used for the Partner's invoice numbering. Must be globally unique across all partner invoice prefixes, invoice integration prefixes, and previously-issued invoice prefixes. Takes effect only when options.supplierOnInvoices is true.

string | null
^\d+$

Starting number for the Partner's invoice numbering. Non-negative numeric string; leading zeros are preserved. Takes effect only when options.supplierOnInvoices is true.

options
object
corporateBilling
object
string | null

Third party identifier of the partner

bankDetails
object
integer | null

The operator ID for this resource.
Required for global admin tokens.
Optional for operator-scoped tokens (defaults to token's operator).

Responses

Updated 3 months ago

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

Updated 3 months ago

Did this page help you?