Endpoints
ContactCustomField
Documentation: https://api-docs.brightpearl.com/contact/custom-field-meta-data/get.html
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
ID |
int |
-
|
-
|
Name |
string |
-
|
-
|
Code |
string |
-
|
|
CustomFieldType |
string |
-
|
|
Required |
boolean |
-
|
-
|
ContactCustomFieldOption
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
ContactCustomFieldRemoteID |
string |
ContactCustomField → RemoteID
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
ID |
int |
-
|
-
|
CustomFieldID |
int |
ContactCustomField → ID
|
-
|
Value |
string |
-
|
-
|
Contact
Documentation: https://api-docs.brightpearl.com/contact/contact/index.html
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
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 |
-
|
-
|
CurrentAssignmentStaffOwnerContactID |
int |
Contact → ContactID
|
-
|
CurrentAssignmentDepartmentID |
int |
-
|
-
|
CurrentAssignmentLeadSourceID |
int |
-
|
-
|
CurrentAssignmentContactGroupID |
int |
-
|
-
|
CurrentAssignmentAccountReference |
string |
-
|
-
|
CreditLimit |
decimal |
-
|
-
|
CreditTermDays |
decimal |
-
|
-
|
CurrencyID |
int |
-
|
-
|
DiscountPercentage |
decimal |
-
|
-
|
PriceListID |
int |
-
|
-
|
TaxCodeID |
int |
-
|
-
|
NominalCode |
string |
-
|
-
|
TaxNumber |
string |
-
|
-
|
DefaultAddressID |
int |
PostalAddress → AddressID
|
-
|
DeliveryAddressID |
int |
PostalAddress → AddressID
|
-
|
BillingAddressID |
int |
PostalAddress → AddressID
|
-
|
CurrentContactStatus |
string |
-
|
-
|
CreatedOn |
datetime |
-
|
-
|
UpdatedOn |
datetime |
-
|
-
|
ContactCustomFieldValue
ContactTag
Documentation: https://api-docs.brightpearl.com/contact/custom-field-meta-data/get.html
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
TagID |
int |
-
|
-
|
TagName |
string |
-
|
-
|
TagParentID |
int |
ContactTag → TagID
|
-
|
TagColor |
string |
-
|
-
|
ContactTagValue
Product
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
ID |
int |
-
|
-
|
DefaultProductName |
string |
-
|
|
BrandID |
int |
Brand → ID
|
-
|
CollectionID |
int |
-
|
-
|
PrimarySupplierID |
int |
Contact → ContactID
|
-
|
ProductGroupID |
int |
-
|
|
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 |
-
|
-
|
TaxCodeCode |
string |
-
|
-
|
IsBundle |
boolean |
-
|
-
|
ReportingCategoryID |
int |
-
|
-
|
ReportingSubCategoryID |
int |
-
|
-
|
ReportingSeasonID |
int |
-
|
-
|
InStockTotal |
decimal |
-
|
-
|
OnHandTotal |
decimal |
-
|
-
|
AllocatedTotal |
decimal |
-
|
-
|
InTransitTotal |
decimal |
-
|
-
|
OnOrderTotal |
decimal |
-
|
-
|
OnOrderShipped |
decimal |
-
|
-
|
Brand
Documentation: https://api-docs.brightpearl.com/product/brand/get.html
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
ID |
int |
-
|
-
|
Name |
string |
-
|
-
|
Description |
string |
-
|
-
|
ProductCategory
Documentation: https://api-docs.brightpearl.com/product/brightpearl-category/get.html
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
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 |
-
|
-
|
Order
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
ID |
int |
-
|
-
|
Version |
int |
-
|
-
|
Acknowledged |
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 |
-
|
-
|
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 |
-
|
-
|
CurrentTeamID |
int |
-
|
-
|
Net |
decimal |
-
|
-
|
TaxAmount |
decimal |
-
|
-
|
BaseNet |
decimal |
-
|
-
|
BaseTaxAmount |
decimal |
-
|
-
|
BaseTotal |
decimal |
-
|
-
|
Total |
decimal |
-
|
-
|
AccountingCurrencyCode |
string |
-
|
-
|
OrderCurrencyCode |
string |
-
|
-
|
ExchangeRate |
decimal |
-
|
-
|
FixedExchangeRate |
boolean |
-
|
-
|
OrderRow
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
OrderRemoteID |
string |
Order → RemoteID
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
OrderRowID |
int |
-
|
-
|
OrderID |
int |
Order → ID
|
-
|
OrderRowSequence |
string |
-
|
-
|
ProductID |
int |
Product → ID
|
-
|
ProductName |
string |
-
|
-
|
NominalCode |
string |
-
|
-
|
DiscountPercentage |
decimal |
-
|
-
|
BundleChild |
boolean |
-
|
-
|
BundleParent |
boolean |
-
|
-
|
ParentOrderRowID |
int |
OrderRow → OrderRowID
|
-
|
Qty |
decimal |
-
|
-
|
UnitPrice |
decimal |
-
|
-
|
CostValue |
decimal |
-
|
-
|
NetValue |
decimal |
-
|
-
|
TaxValue |
decimal |
-
|
-
|
TaxRate |
decimal |
-
|
-
|
TaxCode |
string |
-
|
-
|
Currency |
string |
-
|
-
|
OrderShippingStatus
Documentation: https://api-docs.brightpearl.com/order/order-shipping-status/get.html
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
ID |
int |
-
|
-
|
Description |
string |
-
|
-
|
Code |
string |
-
|
-
|
OrderStatus
Documentation: https://api-docs.brightpearl.com/order/order-status/get.html
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
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 |
-
|
-
|
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 |
-
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
ID |
int |
-
|
-
|
Description |
string |
-
|
-
|
Code |
string |
-
|
-
|
ProductSupplier
Documentation: https://api-docs.brightpearl.com/product/product-supplier/get.html
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
ProductRemoteID |
string |
Product → RemoteID
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
ProductID |
int |
Product → ID
|
-
|
ContactID |
int |
Contact → ContactID
|
-
|
Warehouse
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
ID |
int |
-
|
-
|
Name |
string |
-
|
-
|
TypeCode |
string |
-
|
-
|
TypeDescription |
string |
-
|
-
|
LogisticsName |
string |
-
|
|
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 |
-
|
-
|
ProductWarehouseAvailability
Documentation: https://api-docs.brightpearl.com/warehouse/product-availability/get.html
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
ProductRemoteID |
string |
Product → RemoteID
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
WarehouseID |
int |
Warehouse → ID
|
-
|
ProductID |
int |
Product → ID
|
-
|
InStock |
decimal |
-
|
-
|
OnHand |
decimal |
-
|
-
|
Allocated |
decimal |
-
|
-
|
InTransit |
decimal |
-
|
-
|
OnOrderTotal |
decimal |
-
|
-
|
OnOrderShipped |
decimal |
-
|
-
|
ProductWarehouseLocationAvailability
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
ProductWarehouseAvailabilityRemoteID |
string |
ProductWarehouseAvailability → RemoteID
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
LocationID |
int |
WarehouseLocation → ID
|
-
|
InStock |
decimal |
-
|
-
|
OnHand |
decimal |
-
|
-
|
Allocated |
decimal |
-
|
-
|
InTransit |
decimal |
-
|
-
|
OnOrderTotal |
decimal |
-
|
-
|
OnOrderShipped |
decimal |
-
|
-
|
WarehouseLocation
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
WarehouseRemoteID |
string |
Warehouse → RemoteID
|
-
|
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 |
-
|
-
|
ProductCustomField
Documentation: https://api-docs.brightpearl.com/product/product-custom-field/get.html
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
ID |
int |
-
|
-
|
Name |
string |
-
|
-
|
Code |
string |
-
|
|
CustomFieldType |
string |
-
|
|
Required |
boolean |
-
|
-
|
ProductCustomFieldOption
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
ProductCustomFieldRemoteID |
string |
ProductCustomField → RemoteID
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
ID |
int |
-
|
-
|
CustomFieldID |
int |
ProductCustomField → ID
|
-
|
Value |
string |
-
|
-
|
ProductCustomFieldValue
ProductVariation
Documentation: https://api-docs.brightpearl.com/product/option/search.html
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
ID |
int |
-
|
-
|
Name |
string |
-
|
-
|
ProductVariationOption
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
ProductVariationRemoteID |
string |
ProductVariation → RemoteID
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
OptionValueID |
int |
-
|
-
|
OptionValueName |
string |
-
|
-
|
SortOrder |
int |
-
|
-
|
ProductVariationID |
int |
ProductVariation → ID
|
-
|
ProductVariationValue
ProductProductCategory
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
ProductRemoteID |
string |
Product → RemoteID
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
CategoryID |
int |
ProductCategory → ID
|
-
|
ProductID |
int |
Product → ID
|
-
|
ProductPrice
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
ProductRemoteID |
string |
Product → RemoteID
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
ProductID |
int |
Product → ID
|
-
|
PriceListID |
int |
PriceList → ID
|
-
|
Sku |
string |
-
|
-
|
QuantityBreak |
int |
-
|
-
|
UnitPriceExTax |
decimal |
-
|
-
|
PriceList
Documentation: https://api-docs.brightpearl.com/product/price-list/get.html
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
ID |
int |
-
|
-
|
Name |
string |
-
|
-
|
Code |
string |
-
|
-
|
CurrencyCode |
string |
-
|
-
|
CurrencySymbol |
string |
-
|
-
|
CurrencyID |
int |
-
|
-
|
PriceListTypeCode |
string |
-
|
-
|
Gross |
boolean |
-
|
-
|
Season
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
ID |
int |
-
|
-
|
Name |
string |
-
|
-
|
Description |
string |
-
|
-
|
DateFrom |
datetime |
-
|
-
|
DateTo |
datetime |
-
|
-
|
ProductSeason
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
ProductRemoteID |
string |
Product → RemoteID
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
ProductID |
int |
Product → ID
|
-
|
SeasonID |
int |
Season → ID
|
-
|
Payment
Documentation: https://api-docs.brightpearl.com/accounting/sale-payment-total/get.html
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
|
OrderRemoteID |
string |
Order → RemoteID
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
OrderID |
int |
Order → ID
|
-
|
PaymentCurrency |
string |
-
|
-
|
AmountPaid |
decimal |
-
|
-
|
AmountAuthorized |
decimal |
-
|
-
|
AmountCaptured |
decimal |
-
|
-
|
ProductChannel
Documentation: https://api-docs.brightpearl.com/product/channel/index.html
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
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 |
-
|
-
|
ChannelBrand
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
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 |
-
|
-
|
ProductChannelWarehouse
ProductType
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
ID |
int |
-
|
-
|
Name |
string |
-
|
-
|
ProductTypeAssociatedVariation
OrderRowProductVariation
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
OrderRowRemoteID |
string |
OrderRow → RemoteID
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
OrderRowID |
int |
OrderRow → OrderRowID
|
-
|
VariationName |
string |
-
|
|
Value |
string |
-
|
-
|
OrderGoodsNote
Documentation: https://api-docs.brightpearl.com/warehouse/goods-in-note/get.html
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
OrderRemoteID |
string |
Order → RemoteID
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
GoodsNoteID |
int |
-
|
-
|
OrderID |
int |
Order → ID
|
-
|
Transfer |
boolean |
-
|
-
|
GoodsNoteStatus |
string |
-
|
-
|
OrderGoodsNoteMovement
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
OrderGoodsNoteRemoteID |
string |
OrderGoodsNote → RemoteID
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
GoodsNoteID |
int |
OrderGoodsNote → GoodsNoteID
|
-
|
MovementLineNumber |
int |
-
|
-
|
Currency |
string |
-
|
-
|
Value |
decimal |
-
|
-
|
ProductID |
int |
Product → ID
|
-
|
SalesOrderRowID |
int |
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 |
-
|
-
|
OrderLandedCostEstimate
Documentation: https://api-docs.brightpearl.com/order/landed%20cost%20estimate/get.html
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
OrderRemoteID |
string |
Order → RemoteID
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
ID |
int |
-
|
-
|
OrderID |
int |
Order → ID
|
-
|
OrderRowID |
int |
OrderRow → OrderRowID
|
-
|
UnitAdjustmentOriginalCurrency |
decimal |
-
|
-
|
UnitAdjustmentBaseCurrency |
decimal |
-
|
-
|
PayableSupplierID |
int |
Contact → ContactID
|
-
|
Reference |
string |
-
|
-
|
NominalCode |
string |
-
|
-
|
CurrencyID |
int |
-
|
-
|
PoRowQty |
decimal |
-
|
-
|
ExchangeRate |
decimal |
-
|
-
|
ShippingMethod
Documentation: https://api-docs.brightpearl.com/warehouse/shipping-method/get.html
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
ID |
int |
-
|
-
|
Name |
string |
-
|
-
|
Code |
string |
-
|
-
|
Breaks |
string |
-
|
|
MethodType |
string |
-
|
-
|
AdditionalInformationRequired |
string |
-
|
-
|
Carrier |
string |
-
|
-
|
Countries |
string |
-
|
|
ShippingMethodBreak
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
ShippingMethodRemoteID |
string |
ShippingMethod → RemoteID
|
-
|
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
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
ShippingMethodID |
int |
ShippingMethod → ID
|
-
|
CountryCode |
string |
-
|
-
|
OrderInvoice
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
OrderRemoteID |
string |
Order → RemoteID
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
OrderID |
int |
Order → ID
|
-
|
InvoiceReference |
string |
-
|
-
|
TaxDate |
datetime |
-
|
-
|
DueDate |
datetime |
-
|
-
|
Company
Documentation: https://api-docs.brightpearl.com/contact/company/get.html
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
ID |
int |
-
|
-
|
Name |
string |
-
|
-
|
CreatedOn |
datetime |
-
|
-
|
UpdatedOn |
datetime |
-
|
-
|
PostalAddress
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
ContactRemoteID |
string |
Contact → RemoteID
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
AddressID |
int |
-
|
-
|
ContactID |
int |
-
|
-
|
AddressLine1 |
string |
-
|
-
|
AddressLine2 |
string |
-
|
-
|
AddressLine3 |
string |
-
|
-
|
AddressLine4 |
string |
-
|
-
|
PostalCode |
string |
-
|
-
|
CountryIsoCode |
string |
-
|
-
|
CountryIsoCode2 |
string |
-
|
-
|
CountryID |
int |
-
|
-
|
OrderCustomField
Documentation: https://api-docs.brightpearl.com/order/customfield-metadata/get.html
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
ID |
int |
-
|
-
|
Name |
string |
-
|
-
|
Code |
string |
-
|
-
|
CustomFieldType |
string |
-
|
|
Required |
boolean |
-
|
-
|
OrderCustomFieldOption
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
OrderCustomFieldRemoteID |
string |
OrderCustomField → RemoteID
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
ID |
int |
-
|
-
|
Value |
string |
-
|
-
|
CustomFieldID |
int |
OrderCustomField → ID
|
-
|
OrderCustomFieldValue
OrderReservation
Documentation: https://api-docs.brightpearl.com/warehouse/reservation/get.html
Column |
Type |
Relates to |
Notes |
RemoteID |
string |
-
|
-
|
OrderRemoteID |
string |
Order → RemoteID
|
-
|
MirrorRemoteID |
int |
-
|
-
|
IsDeleted |
boolean |
-
|
-
|
WhenCreated |
datetime |
-
|
-
|
WhenModified |
datetime |
-
|
-
|
ProductID |
int |
Product → ID
|
-
|
Quantity |
decimal |
-
|
-
|
OrderRowID |
int |
-
|
-
|
OrderID |
int |
Order → ID
|
-
|
WarehouseID |
int |
Warehouse → ID
|
-
|