Partner / Create

post

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

Create new partner

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

businessName

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.

notifications

object

name

string

required

Company name of the Partner

regNo

string | null

vatNo

string | null

address

string | null

postcode

string | null

city

string | null

country

string | null

enum

region

string | null

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

state

enum

When the selected country is one of US, AU, CA, UM or RO

When the country is US.

contactDetails

object | null

monthlyPlatformFee

number | null

receiptsPrefix

string | null

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

receiptsStartingNumber

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.

invoiceNumberPrefix

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.

startingInvoiceNumber

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

externalId

string | null

Third party identifier of the partner

bankDetails

object

operatorId

integer | null

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

Responses

Language

Credentials

URL

Loading…

Response

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

application/json

201Partner created successfully

401Access token is missing or invalid

403You do not have permission to perform the action

422The payload you provided is invalid

429Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*