Account Configuration GET

URI

https://{DATACENTER}.brightpearl.com/public-api/{ACCOUNT}
/integration-service/account-configuration

Refer to our documentation on URI syntax for more information on how to construct URIs.

Description

Retrieves the account configuration for a Brightpearl account as a map of key/value pairs. These values include items such as the base currency code (as a three digit ISO code).

Additional information

Some properties have a series of possible values which are not self-evident, and are listed below:

  • taxSchemeCode
    • VAT
    • SALES TAX
  • orderRowSortingStrategy - which row property is used to determine the sorting order of rows in the back-office UI.
    • productSku
    • productName
    • price
    • rowId - also known as 'time added', as row IDs are incremental.
    • rowSequence - also known as 'drag and drop', as the sequence can be modified in the back-office by dragging the rows.

Example

Retrieve the account configuration

Request URI

/account-configuration

Response

{
	"response": {
		"configuration": {
			"roundingCorrectionsNominalCode": "2299",
			"invoicedOrderStatusId": "4",
			"newSalesOrderStatusId": "3",
			"chargesNominalCode": "6500",
			"defaultProductTypeId": "1",
			"salesNominalCode": "4225",
			"costOfSalesEnabled": "1",
			"timeZone": "Europe/London",
			"taxSchemeCode": "SALES TAX",
			"productSeasonsEnabled": "0",
			"newPurchaseOrderStatusId": "6",
			"productWeightUnit": "GRAM",
			"purchaseNominalCode": "5030",
			"shippingNominalCode": "4300",
			"autoAssignOrder": "1",
			"newSalesCreditStatusId": "10",
			"multipleWarehouseEnabled": "1",
			"paypalBankAccountCode": "1240",
			"defaultCostPriceListId": "1",
			"writeOffNoteNominalCode": "5060",
			"discountNominalCode": "4310",
			"baseCurrencyCode": "USD",
			"cancelledOrderStatusId": "5",
			"poStatusAcknowledged": "7",
			"defaultCurrencyCode": "1",
			"defaultTaxRateId": "3",
			"newPurchaseCreditStatusId": "12",
			"productLengthUnit": "CENTIMETER",
			"originalRetailPriceListId": "4",
			"originalWholesalePriceListId": "8",
			"currentSeasonId": "2",
			"accountVersion": "4.85.0",
			"advancedFulfilmentEnabled": "1",
			"defaultEmailForAccounts": "1",
			"orderRowSortingStrategy": "rowSequence"
		}
	}
}