Explore the Brightpearl API data model

See how the various Brightpearl endpoints relate to each other, using our handy Entity Relationship Diagram

Try our interactive ERD Or, browse below

Pulling data from the Brightpearl API is only the first part of your reporting. You also need to understand the relationships between different endpoints - something that APIs typically fail to convey.

At SyncHub, we not only sync your Brightpearl API endpoints down into a reportable format, we also describe their relationships (e.g. in terms of foreign keys) so that you can quickly get a grasp of your data and how it fits together. This page is intended as technical documentation of these relationships.

Endpoints

AccountingPeriod

Documentation: https://api-docs.brightpearl.com/accounting/accounting-period/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
StartDate datetime - -
EndDate datetime - -
ClosedByUserID int Contact → ContactID -
ClosedDate datetime - -

Brand

Documentation: https://api-docs.brightpearl.com/product/brand/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Description string - -

ChannelBrand

Documentation: https://api-docs.brightpearl.com/product/channel-brand/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
ChannelBrandID int - -
AddressBookID int - -
CompanyName string - -
CompanyNumber string - -
Telephone string - -
EmailAddress string - -
AccountingEmailAddress string - -
BankAccountNumber string - -
BankSortCode string - -
BankSwift string - -
VatNumber string - -
BankName string - -

Collection

Documentation: https://api-docs.brightpearl.com/product/collection/search.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
CollectionName string - -
BrandID int Brand → ID -
PrimaryKeyName string - -
CreatedOn datetime - -
UpdatedOn datetime - -

Company

Documentation: https://api-docs.brightpearl.com/contact/company/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
CreatedOn datetime - -
UpdatedOn datetime - -

ContactGroup

Documentation: https://api-docs.brightpearl.com/contact/contact-group/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
CreatedBy long - -
CreatedOn datetime - -
IsReadOnly boolean - -

ContactGroupMember

Column Type Relates to Notes
RemoteID string - -
ContactGroupRemoteID string ContactGroup → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ContactGroupID long ContactGroup → ID -
ContactID int Contact → ContactID -

Contact

Documentation: https://api-docs.brightpearl.com/contact/contact/index.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ContactID int - -
FirstName string - -
LastName string - -
TradeStatus string - -
CreatedByid int Contact → ContactID -
CompanyID int Company → ID -
IsPrimaryContact boolean - -
IsSupplier boolean - -
IsStaff boolean - -
PrimaryEmail string - -
SecondaryEmail string - -
TertiaryEmail string - -
PrimaryPhone string - -
SecondaryPhone string - -
MobilePhone string - -
PrimaryWebsite string - -
CurrentAssignmentStaffOwnerContactID int Contact → ContactID -
CurrentAssignmentDepartmentID int - -
IsReceiveEmailNewsletter boolean - -
CurrentAssignmentLeadSourceID int LeadSource → ID -
CurrentAssignmentContactGroupID int - -
CurrentAssignmentAccountReference string - -
CreditLimit decimal - -
CreditTermDays decimal - -
CurrencyID int Currency → ID -
DiscountPercentage decimal - -
PriceListID int - -
TaxCodeID int TaxCode → ID -
NominalCode string - -
TaxNumber string - -
DefaultAddressID int PostalAddress → AddressID -
DeliveryAddressID int PostalAddress → AddressID -
BillingAddressID int PostalAddress → AddressID -
CurrentContactStatus string - -
CreatedOn datetime - -
UpdatedOn datetime - -

ContactCustomField

Documentation: https://api-docs.brightpearl.com/contact/custom-field-meta-data/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Code string - -
CustomFieldType string - -
Required boolean - -

ContactTag

Documentation: https://api-docs.brightpearl.com/contact/custom-field-meta-data/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
TagID int - -
TagName string - -
TagParentID int ContactTag → TagID -
TagColor string - -

Currency

Documentation: https://api-docs.brightpearl.com/accounting/currency/search.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
PrimaryKeyName string - -
Title string - -
Code string - -
Symbol string - -
ExchangeRate decimal - -
IsDefault boolean - -
ExchangeRateVarianceNominalCode string - -
CreatedOn datetime - -
UpdatedOn datetime - -

CustomerPayment

Documentation: https://api-docs.brightpearl.com/accounting/customer-payment/search.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
PrimaryKeyName string - -
TransactionRef string - -
TransactionCode string - -
PaymentMethodCode string - -
PaymentType string - -
OrderID int Order → ID -
CurrencyID int Currency → ID -
AmountAuthorized decimal - -
AmountPaid decimal - -
Expires datetime - -
PaymentDate datetime - -
JournalID int Journal → ID -
CreatedOn datetime - -
UpdatedOn datetime - -

GoodsMovement

Documentation: https://api-docs.brightpearl.com/warehouse/goods-movement/search.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
GoodsMovementID int - -
ProductID int Product → ID -
SalesOrderRowID long OrderRow → OrderRowID -
PurchaseOrderRowID int -
  • 30 Jan 2024 Foreign Key - Refers to `PurchaseOrderRow` (PurchaseOrder not implemented).
Quantity int - -
DestinationLocationID int WarehouseLocation → ID -
WarehouseID int Warehouse → ID -
GoodsNoteID int OrderGoodsNote → GoodsNoteID -
ProductValue string - -
CurrencyCode string - -
IsCleared boolean - -
IsQuarantine boolean - -
BatchID int - -
GoodsNoteTypeCode string - -
CreatedOn datetime - -
UpdatedOn datetime - -

OrderGoodsNote

Documentation: https://api-docs.brightpearl.com/warehouse/goods-in-note/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
GoodsNoteID int - -
OrderID int Order → ID -
Transfer boolean - -
GoodsNoteStatus string - -
ReceivedOn datetime - -
CreatedBy int - -

OrderGoodsOutNote

Documentation: https://api-docs.brightpearl.com/warehouse/goods-out-note/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
GoodsOutNoteID long - -
OrderID int Order → ID -
WarehouseID int Warehouse → ID -
TargetWarehouseID int Warehouse → ID -
Transfer boolean - -
Priority boolean - -
Shipped boolean - -
Packed boolean - -
Picked boolean - -
Printed boolean - -
PickedOn datetime - -
PackedOn datetime - -
ShippedOn datetime - -
PrintedOn datetime - -
PickedByID int Contact → ContactID -
PackedByID int Contact → ContactID -
ShippedByID int Contact → ContactID -
PrintedByID int Contact → ContactID -
ShippingReference string - -
ShippingBoxes int - -
ShippingMethodID int ShippingMethod → ID -
ShippingWeight decimal - -
ReleaseDate datetime - -
CreatedOn datetime - -
CreatedBy int Contact → ContactID -
StockTransferID int StockTransfer → StockTransferID -
Sequence int - -
LabelUri string - -
LastEventVersion string - -

Journal

Documentation: https://api-docs.brightpearl.com/accounting/journal/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Description string - -
ContactID int Contact → ContactID -
JournalTypeCode string - -
TaxDate datetime - -
DueDate datetime - -
CreatedOn datetime - -
ExchangeRate decimal - -
CurrencyID int Currency → ID -
CreatedByContactID int Contact → ContactID -
TaxReconciliationDate datetime - -
TaxReconciliationTaxPeriodID int - -

LeadSource

Documentation: https://api-docs.brightpearl.com/contact/lead-source/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
IsActive boolean - -
OwnerID int - -
ParentID int LeadSource → ID -

NominalCode

Documentation: https://api-docs.brightpearl.com/accounting/nominal-code/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Code string - -
TypeID int - -
Bank boolean - -
Expense boolean - -
Discount boolean - -
Editable boolean - -
Active boolean - -
TaxCode int TaxCode → ID -
ChartMapCode string - -
Reconcile boolean - -

Order

Documentation: https://api-docs.brightpearl.com/order/order/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Version int - -
Acknowledged boolean -
  • 21 Jun 2021 The docs do not define this column, but JSON examples give it as an integer (always zero). From the PUT method though, we are 99% sure it can be interpreted as a true/false boolean
OrderTypeCode string OrderType → Code -
Reference string - -
OrderPaymentStatus string - -
StockStatusCode string OrderStockStatus → Code -
AllocationStatusCode string - -
ShippingStatusCode string OrderShippingStatus → Code -
PriceModeCode string - -
CreatedOn datetime - -
UpdatedOn datetime - -
PlacedOn datetime - -
ClosedOn datetime - -
IsDropship boolean - -
OrderStatusID int OrderStatus → StatusID -
SupplierContactID int Contact → ContactID -
BillingContactID int Contact → ContactID -
DeliveryAddressFullName string - -
DeliveryCompanyName string - -
DeliveryAddressLine1 string - -
DeliveryAddressLine2 string - -
DeliveryAddressLine3 string - -
DeliveryAddressLine4 string - -
DeliveryPostalCode string - -
DeliveryCountry string - -
DeliveryCountryIsoCode string - -
DeliveryCountryIsoCode3 string - -
DeliveryTelephone string - -
DeliveryMobileTelephone string - -
DeliveryEmail string - -
BillingAddressFullName string - -
BillingCompanyName string - -
BillingAddressLine1 string - -
BillingAddressLine2 string - -
BillingAddressLine3 string - -
BillingAddressLine4 string - -
BillingPostalCode string - -
BillingCountry string - -
BillingCountryIsoCode string - -
BillingCountryIsoCode3 string - -
BillingTelephone string - -
BillingMobileTelephone string - -
BillingEmail string - -
SupplierAddressFullName string - -
SupplierCompanyName string - -
SupplierAddressLine1 string - -
SupplierAddressLine2 string - -
SupplierAddressLine3 string - -
SupplierAddressLine4 string - -
SupplierPostalCode string - -
SupplierCountry string - -
SupplierCountryIsoCode string - -
SupplierCountryIsoCode3 string - -
SupplierTelephone string - -
SupplierMobileTelephone string - -
SupplierEmail string - -
DeliveryDate datetime - -
ShippingMethodID int ShippingMethod → ID -
ParentOrderID int Order → ID -
CreatedByID int Contact → ContactID -
WarehouseID int Warehouse → ID -
CurrentStaffOwnerContactID int - -
CurrentProjectID int - -
CurrentChannelID int ProductChannel → ID -
CurrentLeadSourceID int LeadSource → ID -
CurrentTeamID int - -
Net decimal - -
TaxAmount decimal - -
BaseNet decimal - -
BaseTaxAmount decimal - -
BaseTotal decimal - -
Total decimal - -
AccountingCurrencyCode string - -
OrderCurrencyCode string - -
ExchangeRate decimal - -
FixedExchangeRate boolean - -

OrderCustomField

Documentation: https://api-docs.brightpearl.com/order/customfield-metadata/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Code string - -
CustomFieldType string -
  • 29 May 2021 Can be one of TEXT, TEXTAREA, YESNO, INTEGER, DATE, or SELECT
Required boolean - -

OrderStatus

Documentation: https://api-docs.brightpearl.com/order/order-status/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
StatusID int - -
SortOrder int - -
RemindAfterDays int - -
OrderTypeCode string - -
Color string - -
EmailContent string - -
State string - -
Disabled boolean - -
Visible boolean - -
BatchProcess boolean - -

OrderStockStatus

Documentation: https://api-docs.brightpearl.com/order/order-stock-status/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Description string - -
Code string - -

OrderShippingStatus

Documentation: https://api-docs.brightpearl.com/order/order-shipping-status/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Description string - -
Code string - -

OrderType

Documentation: https://api-docs.brightpearl.com/order/order-type/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Description string - -
Code string - -

Payment

Documentation: https://api-docs.brightpearl.com/accounting/sale-payment-total/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
OrderID int Order → ID
  • 18 Mar 2022 Even if multiple payments are provided, this endpoint will just roll up a single payment/order
PaymentCurrency string - -
AmountPaid decimal - -
AmountAuthorized decimal - -
AmountCaptured decimal - -

PaymentMethod

Documentation: https://api-docs.brightpearl.com/accounting/payment-method/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
IsActive boolean - -
Code string - -
InstalledIntegrationID int ProductChannel → ID -

PostalAddress

Column Type Relates to Notes
RemoteID string - -
ContactRemoteID string Contact → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
AddressID int - -
ContactID int Contact → ContactID -
AddressLine1 string - -
AddressLine2 string - -
AddressLine3 string - -
AddressLine4 string - -
PostalCode string - -
CountryIsoCode string - -
CountryIsoCode2 string - -
CountryID int - -

PriceList

Documentation: https://api-docs.brightpearl.com/product/price-list/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Code string - -
CurrencyID int Currency → ID -
PriceListTypeCode string - -
Gross boolean - -

ProductSeason

Column Type Relates to Notes
RemoteID string - -
ProductRemoteID string Product → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProductID int Product → ID -
SeasonID int Season → ID -

ProductProductCategory

Column Type Relates to Notes
RemoteID string - -
ProductRemoteID string Product → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CategoryID int ProductCategory → ID -
ProductID int Product → ID -

Product

Documentation: https://api-docs.brightpearl.com/product/product/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
DefaultProductName string -
  • 9 Jul 2021 The product names may vary across different sales channels. Here, we take the name from the default 'Brightpearl' channel
BrandID int Brand → ID -
CollectionID int Collection → ID -
PrimarySupplierID int Contact → ContactID -
ProductGroupID long ProductGroup → ProductGroupID
  • 21 Jun 2021 Product groups do not have a 'list' endpoint, and must be obtained one-by-one. As far as we can tell, they are created dynamically to group product varations together. Of interest is that in these cases, the 'name' value of the productGroup is empty. This provides further evidence that this property is purely technical/workaround.
Version long - -
Status string - -
ProductTypeID int ProductType → ID -
NominalCodeStock string - -
NominalCodePurchases string - -
NominalCodeSales string - -
Featured boolean - -
CreatedOn datetime - -
UpdatedOn datetime - -
StockTracked boolean - -
WeightMagnitude decimal - -
StockLength decimal - -
StockWidth decimal - -
StockHeight decimal - -
StockVolume decimal - -
Sku string - -
Isbn string - -
Mpn string - -
Ean string - -
Upc string - -
Barcode string - -
TaxCodeID int TaxCode → ID -
TaxCodeCode string - -
IsBundle boolean - -
ReportingCategoryID int - -
ReportingSubCategoryID int - -
ReportingSeasonID int - -

ProductWarehouseAvailability

Documentation: https://api-docs.brightpearl.com/warehouse/product-availability/get.html

Column Type Relates to Notes
RemoteID string - -
ProductAvailabilityRemoteID string ProductAvailability → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
WarehouseID int Warehouse → ID -
ProductID int ProductAvailability → ProductID -
InStock decimal - -
OnHand decimal - -
Allocated decimal - -
InTransit decimal - -
OnOrderTotal decimal - -
OnOrderShipped decimal - -

ProductAvailability

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProductID int Product → ID -

ProductCategory

Documentation: https://api-docs.brightpearl.com/product/brightpearl-category/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
ParentID int ProductCategory → ID -
Active boolean - -
CreatedOn datetime - -
CreatedByID int - -
UpdatedOn datetime - -
UpdatedByID int - -
DescriptionLanguageCode string - -
DescriptionText string - -
DescriptionFormat string - -

ProductChannel

Documentation: https://api-docs.brightpearl.com/product/channel/index.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
ChannelTypeID int - -
DefaultWarehouseID int - -
ContactGroupID int - -
DefaultPriceListID int PriceList → ID -
ChannelBrandID int ChannelBrand → ChannelBrandID -
ShowInChannelMenu boolean - -
InstalledIntegrationID int - -
ConfigSetID int - -
ProviderCode string - -
IntegrationTypeCode string - -
Active boolean - -

ProductCustomField

Documentation: https://api-docs.brightpearl.com/product/product-custom-field/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Code string - -
CustomFieldType string - -
Required boolean - -

ProductSupplier

Documentation: https://api-docs.brightpearl.com/product/product-supplier/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProductID int Product → ID -
ContactID int Contact → ContactID -

ProductType

Documentation: https://api-docs.brightpearl.com/product/product-type/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -

ProductVariation

Documentation: https://api-docs.brightpearl.com/product/option/search.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -

Project

Documentation: https://api-docs.brightpearl.com/contact/project/index.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
ProjectID long - -

Season

Documentation: https://api-docs.brightpearl.com/product/season/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Description string - -
DateFrom datetime - -
DateTo datetime - -

ShippingMethod

Documentation: https://api-docs.brightpearl.com/warehouse/shipping-method/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Code string - -
Breaks string -
  • 21 Jul 2022 CSV of breakpoints (e.g. '1000, 2000, 3000'
MethodType string - -
AdditionalInformationRequired string - -
Carrier string - -
Countries string - -

StockTransfer

Documentation: https://api-docs.brightpearl.com/warehouse/stock-transfer/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
StockTransferID int - -
CreatedOn datetime - -
SourceWarehouseID int Warehouse → ID -
TargetWarehouseID int Warehouse → ID -
GoodsOutNoteID long OrderGoodsOutNote → GoodsOutNoteID -
Reference string - -
CreatedBy int Contact → ContactID -

SupplierPayment

Documentation: https://api-docs.brightpearl.com/accounting/supplier-payment/search.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
PrimaryKeyName string - -
TransactionRef string - -
PaymentMethodCode string - -
PaymentType string - -
OrderID int Order → ID -
CurrencyID int Currency → ID -
AmountPaid decimal - -
PaymentDate datetime - -
JournalID int Journal → ID -
CreatedOn datetime - -
UpdatedOn datetime - -

TaxCode

Documentation: https://api-docs.brightpearl.com/accounting/tax-code/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Description string - -
Code string - -

WarehouseLocation

Column Type Relates to Notes
RemoteID string - -
WarehouseRemoteID string Warehouse → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
ZoneID int - -
WarehouseID int Warehouse → ID -
GroupingA string - -
GroupingB string - -
GroupingC string - -
GroupingD string - -
FullName string - -
Barcode string - -

Warehouse

Documentation: https://api-docs.brightpearl.com/warehouse/warehouse/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
TypeCode string - -
TypeDescription string - -
LogisticsName string -
  • 21 Jun 2021 Only provided when Warehouse type is 'Third party logistics'
ClickAndCollectEnabled boolean - -
CollectionSlaValue int - -
CollectionSlaTimeUnits string - -
WeeklyOperatingPeriodTimeZone string - -
WeeklyOperatingPeriodDay1OpeningHours string - -
WeeklyOperatingPeriodDay1ClosingHours string - -
WeeklyOperatingPeriodDay2OpeningHours string - -
WeeklyOperatingPeriodDay2ClosingHours string - -
WeeklyOperatingPeriodDay3OpeningHours string - -
WeeklyOperatingPeriodDay3ClosingHours string - -
WeeklyOperatingPeriodDay4OpeningHours string - -
WeeklyOperatingPeriodDay4ClosingHours string - -
WeeklyOperatingPeriodDay5OpeningHours string - -
WeeklyOperatingPeriodDay5ClosingHours string - -
WeeklyOperatingPeriodDay6OpeningHours string - -
WeeklyOperatingPeriodDay6ClosingHours string - -
WeeklyOperatingPeriodDay7OpeningHours string - -
WeeklyOperatingPeriodDay7ClosingHours string - -

ContactTagValue

Column Type Relates to Notes
RemoteID string - -
ContactRemoteID string Contact → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ContactID int Contact → ContactID -
ContactTagID int ContactTag → TagID -

ContactCustomFieldValue

Column Type Relates to Notes
RemoteID string - -
ContactRemoteID string Contact → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ContactID int Contact → ContactID -
ContactCustomFieldCode string ContactCustomField → Code -
ContactCustomFieldOptionID int ContactCustomFieldOption → ID
  • 4 Jun 2021 The id field is only populated for select-list field types
Value string - -

ContactCustomFieldOption

Column Type Relates to Notes
RemoteID string - -
ContactCustomFieldRemoteID string ContactCustomField → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
CustomFieldID int ContactCustomField → ID -
Value string - -

OrderGoodsNoteMovement

Column Type Relates to Notes
RemoteID string - -
OrderGoodsNoteRemoteID string OrderGoodsNote → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
GoodsNoteID int OrderGoodsNote → GoodsNoteID -
MovementLineNumber int - -
Currency string - -
Value decimal - -
ProductID int Product → ID -
SalesOrderRowID long OrderRow → OrderRowID -
PurchaseOrderRowID int - -
Quantity decimal - -
WarehouseID int Warehouse → ID -
DestinationLocationID int WarehouseLocation → ID -
BatchGoodsNoteID int - -
Cleared boolean - -
ValueConfirmed boolean - -
Allocated boolean - -
Quarantine boolean - -
CreatedOn datetime - -
CreatedBy int - -
UpdatedOn datetime - -
UpdatedBy int - -

OrderGoodsOutNoteRow

Column Type Relates to Notes
RemoteID string - -
OrderGoodsOutNoteRemoteID string OrderGoodsOutNote → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
OrderGoodsOutNoteID string OrderGoodsOutNote → RemoteID -
Iterator long - -
OrderRowID long - -
ProductID int Product → ID -
Quantity decimal - -
LocationID long WarehouseLocation → ID -
UserBatchReference string - -

OrderGoodsOutNoteEvent

Column Type Relates to Notes
RemoteID string - -
OrderGoodsOutNoteRemoteID string OrderGoodsOutNote → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
OrderGoodsOutNoteID string OrderGoodsOutNote → RemoteID -
Iterator int - -
Occured datetime - -
EventOwnerID int - -
EventCode string - -

JournalCredit

Column Type Relates to Notes
RemoteID string - -
JournalRemoteID string Journal → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
JournalID int Journal → ID -
LineNumber int - -
AssignmentChannelID int ProductChannel → ID -
AssignmentProjectID long Project → ProjectID -
AssignmentLeadSourceID long - -
NominalCode string - -
OrderID int Order → ID -
InvoiceReference string - -
TaxCode string - -
TransactionAmount decimal - -

JournalDebit

Column Type Relates to Notes
RemoteID string - -
JournalRemoteID string Journal → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
JournalID int Journal → ID -
LineNumber int - -
AssignmentChannelID int ProductChannel → ID -
AssignmentProjectID long Project → ProjectID -
AssignmentLeadSourceID long - -
NominalCode string - -
OrderID int Order → ID -
InvoiceReference string - -
TaxCode string - -
TransactionAmount decimal - -

OrderCustomFieldValue

Documentation: https://api-docs.brightpearl.com/order/order-customfields/get.html

Column Type Relates to Notes
RemoteID string - -
OrderRemoteID string Order → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
OrderID int Order → ID -
OrderCustomFieldCode string OrderCustomField → Code -
OrderCustomFieldOptionID int OrderCustomFieldOption → ID
  • 4 Jun 2021 The id field is only populated for select-list field types
Value string - -

OrderInvoice

Column Type Relates to Notes
RemoteID string - -
OrderRemoteID string Order → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
OrderID int Order → ID -
InvoiceReference string - -
TaxDate datetime - -
DueDate datetime - -

OrderLandedCostEstimate

Documentation: https://api-docs.brightpearl.com/order/landed%20cost%20estimate/get.html

Column Type Relates to Notes
RemoteID string - -
OrderRemoteID string Order → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
OrderID int Order → ID -
OrderRowID long OrderRow → OrderRowID -
UnitAdjustmentOriginalCurrency decimal - -
UnitAdjustmentBaseCurrency decimal - -
PayableSupplierID int Contact → ContactID -
Reference string - -
NominalCode string - -
CurrencyID int Currency → ID -
PoRowQty decimal - -
ExchangeRate decimal - -

OrderRow

Column Type Relates to Notes
RemoteID string - -
OrderRemoteID string Order → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
OrderRowID long - -
OrderID int Order → ID -
OrderRowSequence string - -
ProductID int Product → ID -
ProductName string - -
NominalCode string - -
DiscountPercentage decimal - -
BundleChild boolean - -
BundleParent boolean - -
ParentOrderRowID long OrderRow → OrderRowID -
Qty decimal - -
UnitPrice decimal - -
CostValue decimal - -
NetValue decimal - -
TaxValue decimal - -
TaxRate decimal - -
TaxCode string - -
Currency string - -

OrderCustomFieldOption

Column Type Relates to Notes
RemoteID string - -
OrderCustomFieldRemoteID string OrderCustomField → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Value string - -
CustomFieldID int OrderCustomField → ID -

PaymentMethodBankAccount

Column Type Relates to Notes
RemoteID string - -
PaymentMethodRemoteID string PaymentMethod → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
PaymentMethodID int PaymentMethod → ID -
BankAccountNominalCode string - -
CurrencyIsoCode string - -

ProductVariationValue

Column Type Relates to Notes
RemoteID string - -
ProductRemoteID string Product → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProductID int Product → ID -
OptionID int ProductVariation → ID -
OptionValueID int ProductVariationOption → OptionValueID -

ProductCustomFieldValue

Column Type Relates to Notes
RemoteID string - -
ProductRemoteID string Product → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProductID int Product → ID -
ProductCustomFieldCode string ProductCustomField → Code -
ProductCustomFieldOptionID int ProductCustomFieldOption → ID -
Value string - -

ProductBundledProduct

Column Type Relates to Notes
RemoteID string - -
ProductRemoteID string Product → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ParentProductID int Product → ID -
BundledProductID int Product → ID -

ProductGroup

Column Type Relates to Notes
RemoteID string - -
ProductRemoteID string Product → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProductGroupID long - -
CreatedBy long - -
CreatedOn datetime - -
DisplayAsGrid boolean - -

ProductWarehouse

Column Type Relates to Notes
RemoteID string - -
ProductRemoteID string Product → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProductID int Product → ID -
WarehouseID long - -
DefaultLocationID int WarehouseLocation → ID -
OverflowLocationID int WarehouseLocation → ID -
ReorderLevel int - -
ReorderQuantity int - -
MappedChildKeyPropertyName string - -

ProductWarehouseLocationAvailability

Column Type Relates to Notes
RemoteID string - -
ProductWarehouseAvailabilityRemoteID string ProductWarehouseAvailability → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
LocationID int WarehouseLocation → ID -
InStock decimal - -
OnHand decimal - -
Allocated decimal - -
InTransit decimal - -
OnOrderTotal decimal - -
OnOrderShipped decimal - -

ProductChannelWarehouse

Column Type Relates to Notes
RemoteID string - -
ProductChannelRemoteID string ProductChannel → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
WarehouseID int Warehouse → ID -
ProductChannelID int ProductChannel → ID -

ProductCustomFieldOption

Column Type Relates to Notes
RemoteID string - -
ProductCustomFieldRemoteID string ProductCustomField → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
CustomFieldID int ProductCustomField → ID -
Value string - -

ProductPrice

Documentation: https://api-docs.brightpearl.com/product/product-price/get.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProductID int Product → ID -
PriceListID int PriceList → ID -
Sku string - -
QuantityBreak int - -
UnitPriceExTax decimal - -

ProductTypeAssociatedVariation

Column Type Relates to Notes
RemoteID string - -
ProductTypeRemoteID string ProductType → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProductVariationID int ProductVariation → ID -
ProductTypeID int ProductType → ID -

ProductVariationOption

Column Type Relates to Notes
RemoteID string - -
ProductVariationRemoteID string ProductVariation → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
OptionValueID int - -
OptionValueName string - -
SortOrder int - -
ProductVariationID int ProductVariation → ID -

ShippingMethodBreak

Column Type Relates to Notes
RemoteID string - -
ShippingMethodRemoteID string ShippingMethod → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ShippingMethodID int ShippingMethod → ID -
Break decimal - -

ShippingMethodCountry

Column Type Relates to Notes
RemoteID string - -
ShippingMethodRemoteID string ShippingMethod → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ShippingMethodID int ShippingMethod → ID -
CountryCode string - -

OrderReservation

Documentation: https://api-docs.brightpearl.com/warehouse/reservation/get.html

Column Type Relates to Notes
RemoteID string - -
OrderRemoteID string Order → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProductID int Product → ID -
Quantity decimal - -
OrderRowID long - -
OrderID int Order → ID -
WarehouseID int Warehouse → ID -

OrderRowProductVariation

Column Type Relates to Notes
RemoteID string - -
OrderRowRemoteID string OrderRow → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
OrderRowID long OrderRow → OrderRowID -
VariationName string -
  • 19 Jun 2022 We can't enforce a foreign key here, as the name may potentially change in Brightpearl. However ostensibly it points to the ProductVariation.Name field
Value string - -

Need more?

SyncHub lives and breathes APIs and data. Keep exploring using the links below.

Connect your own Brightpearl data Querying Brightpearl using regular SQL