Create a new account

post

https://example.com/integration-tenants/api/v1/accounts

Creates a new account in the system. Please note that AccountName and AccountNumber is required. If you have more than one company configured, you need to specify which one to use.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

companyId

int32 | null

accountPriceListDiscountId

int32 | null

accountExtraFeeScheduleDiscountId

int32 | null

serviceLevelPriceListDiscounts

array of objects | null

serviceLevelPriceListDiscounts

serviceLevelExtraFeeScheduleDiscounts

array of objects | null

serviceLevelExtraFeeScheduleDiscounts

accountName

string

required

length between 1 and 256

accountNumber

string

required

length between 1 and 256

holidayCalendarId

int32 | null

contactName

string | null

contactPhone

string | null

contactFax

string | null

contactEmail

string | null

contactLanguage

string | null

address

object

addressLocation

object

notes

string | null

csrDefaultNote

string | null

selfServeDefaultNote

string | null

otherInfo1

string | null

otherInfo2

string | null

otherInfo3

string | null

externalId

string | null

attributeIds

array of strings | null

attributeIds

serviceLevelScheduleId

int32 | null

priceListId

int32 | null

driverPayRatePriceListId

int32 | null

driverPayRateExtraFeeScheduleId

int32 | null

driverPayRateFuelSurchargeScheduleId

int32 | null

fuelSurchargeScheduleId

int32 | null

extraFeeScheduleId

int32 | null

exceptionCodeScheduleId

int32 | null

taxScheduleId

string | null

profileId

string | null

mobileCreateOrderProfileId

string | null

accountSelfServeProfileId

string | null

notificationTemplateId

int32 | null

useNotificationTemplatePerServiceLevel

boolean | null

notificationTemplatePerServiceLevel

array of objects | null

notificationTemplatePerServiceLevel

driversPayoutOption

int32

enum

[0 - 'None', 1 - 'ByOrder']

Allowed:

parcelTypeScheduleId

int32 | null

isDriverOrderCreationEnabled

boolean

isDriverOrderCreationWithoutQRCodeEnabled

boolean

defaultOrderCreationServiceLevelId

string | null

defaultOrderCreationUserId

string | null

packageValidationOption

int32

enum

[0 - 'NoValidation', 1 - 'PickupOnly', 2 - 'DeliveryOnly', 3 - 'PickupAndDelivery']

Allowed:

packageValidationOverrideOption

int32

enum

[0 - 'None', 1 - 'OnOrder', 2 - 'OnOrderTemplate', 3 - 'OnOrderAndOrderTemplate']

Allowed:

allowPartialOrdersToBePickedUpOrDelivered

boolean

allowAddingItemsOnPickupOrDelivery

boolean

skipGroupedOrdersWithNoItemsScanned

boolean

allowValidationWithoutBarcode

boolean

scanField

int32

enum

[0 - 'All', 1 - 'OrderId', 2 - 'ReferenceNumber1', 3 - 'ReferenceNumber2', 4 - 'ReferenceNumber3', 5 - 'None', 6 - 'Generated']

Allowed:

useCustomBarcodeFormat

boolean | null

customBarcodeTemplate

string | null

supportedBarcodeFormats

array of strings | null

supportedBarcodeFormats

additionalInvoiceTemplateIds

array of strings | null

additionalInvoiceTemplateIds

proofOfDeliveryReportTemplateId

string | null

proofOfDeliveryReportGeneratedByDefault

boolean | null

termId

int32 | null

overrideCreditLimit

boolean | null

creditLimitOverrideAmount

double | null

billingCycleId

int32

required

billingMethodOption

int32

enum

[0 - 'ByAccount', 1 - 'CreditCard']

Allowed:

creditCardSetup

int32

enum

[0 - 'ByAccount', 1 - 'ByUser']

Allowed:

separateInvoiceBy

int32

enum

[0 - 'None', 1 - 'Order', 2 - 'ReferenceNumber1', 3 - 'ReferenceNumber2', 4 - 'ReferenceNumber3', 5 - 'User']

Allowed:

applyCreditCardPreAuthorizationHold

boolean | null

creditCardPreAuthorizationFactor

double | null

1 to 100

creditCardPreAuthorizationMaximumAmount

double | null

0 to 999999

verifyOrdersBeforeInvoicingManualTotalPriceUpdate

boolean | null

verifyOrdersBeforeInvoicingTotalPriceIncrease

boolean | null

verifyOrdersBeforeInvoicingTotalPriceDecrease

boolean | null

verifyOrdersBeforeSettlementManualCommissionUpdate

boolean | null

verifyOrdersBeforeSettlementCommissionIncrease

boolean | null

verifyOrdersBeforeSettlementCommissionDecrease

boolean | null

verifyOrdersBeforeInvoicingOptions

int32

enum

[0 - 'Off', 1 - 'AllOrders', 2 - 'On']

Allowed:

verifyOrdersBeforeSettlementOptions

int32

enum

[0 - 'Off', 1 - 'AllOrders', 2 - 'On']

Allowed:

invoiceTemplateId

string | null

transactionAppliedMethod

int32

enum

[0 - 'Invoice', 1 - 'Order']

Allowed:

invoiceDeliveryMethod

int32

enum

[0 - 'Print', 1 - 'Email', 2 - 'EmailAndPrint', 3 - 'Electronic']

Allowed:

invoiceEmailCCs

string | null

mainContactWillReceiveInvoices

boolean | null

mainContactWillReceiveOrderNotifications

boolean | null

sendZeroDollarInvoices

boolean

invoiceGenerationDateOption

int32

enum

[0 - 'DeliveryDate', 1 - 'ReadyAtDate']

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

500

An error occurred when trying to create the account

200Account created.

400Account has missing/invalid values