Skip to main content
API Family:Default
Version:25.200.001
Screen ID:AR303020

Properties

Select a row for its DAC field and description
PropertyTypeData Type
ActiveBooleanValueboolean
DAC Field:PX.Objects.CR.Location.IsActive
Description:This field indicates whether the location is active. The default value is true.
AddressOverrideBooleanValueboolean
DAC Field:PX.Objects.CR.Location.OverrideAddress
Description:If set to "true", indicates that the address overrides the default Address record, which is referenced by DefAddressID.
CalendarStringValuestring
DAC Field:PX.Objects.CR.Location.CCalendarID
Description:The type of the work calendar in the customer location. Corresponds to the value of the CSCalendar.CalendarID field.
ContactOverrideBooleanValueboolean
DAC Field:PX.Objects.CR.Location.OverrideContact
Description:If set to "true", indicates that the address overrides the default Contact record, which is referenced by DefContactID.
CreatedDateTimeDateTimeValueDateTime
DAC Field:PX.Objects.CR.Location.CreatedDateTime
Description:No description available
CustomerStringValuestring
DAC Field:PX.Objects.CR.Location.BAccountID
Description:The identifier of the BAccount record that is specified in the document to which the location belongs. The value of this field corresponds to the value of the BAccount.BAccountID field.
DefaultBooleanValueboolean
DAC Field:PX.Objects.CR.Location.IsDefault
Description:This field indicates whether the location is default for the corresponding business account. The field value is true when this location is the default location of the corresponding business account, and false otherwise.
DefaultProjectStringValuestring
DAC Field:PX.Objects.CR.Location.CDefProjectID
Description:The identifier of the default project of the customer location. The value of this field corresponds to the value of the PMProject.ContractID field.
EntityUsageTypeStringValuestring
DAC Field:PX.Objects.CR.Location.CAvalaraCustomerUsageType
Description:The customer's entity type for reporting purposes. This field is used if the system is integrated with External Tax Calculation and the External Tax Calculation Integration feature is enabled. The field can have one of the values listed in the TXAvalaraCustomerUsageType.ListAttribute class. The default value is TXAvalaraCustomerUsageType.Default.
FedExGroundCollectBooleanValueboolean
DAC Field:PX.Objects.CR.Location.CGroundCollect
Description:This field indicates whether the FedEx Ground Collect program is available in this location. The default value is false.
FOBPointStringValuestring
DAC Field:PX.Objects.CR.Location.CFOBPointID
Description:The customer's FOB (free on board) shipping point. The value of this field corresponds to the value of the FOBPoint.FOBPointID field.
InsuranceBooleanValueboolean
DAC Field:PX.Objects.CR.Location.CInsurance
Description:This field indicates whether the delivery insurance is available in this location. The default value is false.
LastModifiedDateTimeDateTimeValueDateTime
DAC Field:PX.Objects.CR.Location.LastModifiedDateTime
Description:No description available
LeadTimeDaysShortValueshort
DAC Field:PX.Objects.CR.Location.CLeadTime
Description:The amount of lead days (the time in days from the moment when the production was finished to the moment when the customer's order was delivered).
LocationContactContactContact
DAC Field:Not mapped to a DAC field
Description:No description available
LocationIDStringValuestring
DAC Field:PX.Objects.CR.Location.LocationCD
Description:The human-readable identifier of the location that is specified by the user when they create a location. This field is a natural key as opposed to the LocationID surrogate key.
LocationNameStringValuestring
DAC Field:PX.Objects.CR.Location.Descr
Description:The name of the location.
OrderPriorityShortValueshort
DAC Field:PX.Objects.CR.Location.COrderPriority
Description:The order priority of the customer's location.
PriceClassStringValuestring
DAC Field:PX.Objects.CR.Location.CPriceClassID
Description:The price class of the customer. The value of this field corresponds to the value of the ARPriceClass.PriceClassID field.
ResidentialDeliveryBooleanValueboolean
DAC Field:PX.Objects.CR.Location.CResedential
Description:This field indicates whether the residential delivery is available in this location. The default value is false.
RoleAssignmentsListBCRoleAssignment
DAC Field:Not mapped to a DAC field
Description:No description available
SaturdayDeliveryBooleanValueboolean
DAC Field:PX.Objects.CR.Location.CSaturdayDelivery
Description:This field indicates whether the Saturday delivery is available in this location. The default value is false.
ShippingBranchStringValuestring
DAC Field:PX.Objects.CR.Location.CBranchID
Description:The identifier of the default branch of the customer location. The value of this field corresponds to the value of the Branch.BranchID field.
ShippingRuleStringValuestring
DAC Field:PX.Objects.CR.Location.CShipComplete
Description:The shipping rule of the customer location. The field can have one of the values listed in the SOShipComplete.ListAttribute class. The default value is SOShipComplete.CancelRemainder.
ShippingTermsStringValuestring
DAC Field:PX.Objects.CR.Location.CShipTermsID
Description:The customer's shipping terms. The value of this field corresponds to the value of the ShipTerms.ShipTermsID field.
ShippingZoneStringValuestring
DAC Field:PX.Objects.CR.Location.CShipZoneID
Description:The customer's shipping zone. The value of this field corresponds to the value of the ShippingZone.ZoneID field.
ShipViaStringValuestring
DAC Field:PX.Objects.CR.Location.CCarrierID
Description:The shipping carrier for the vendor location. The value of this field corresponds to the Carrier.carrierID field.
StatusStringValuestring
DAC Field:PX.Objects.CR.Location.Status
Description:The current status of the location. The field can have one of the values listed in the LocationStatus.ListAttribute class. The default value is LocationStatus.Active.
TaxExemptionNbrStringValuestring
DAC Field:PX.Objects.CR.Location.CAvalaraExemptionNumber
Description:The Avalara Exemption number of the customer location.
TaxRegistrationIDStringValuestring
DAC Field:PX.Objects.CR.Location.TaxRegistrationID
Description:The registration ID of the company in the state tax authority.
TaxZoneStringValuestring
DAC Field:PX.Objects.CR.Location.CTaxZoneID
Description:The customer's tax zone. The value of this field corresponds to the value of the TaxZone.TaxZoneID field.
WarehouseStringValuestring
DAC Field:PX.Objects.CR.Location.CSiteID
Description:The warehouse identifier of the customer location. The value of this field corresponds to the value of the INSite.SiteID field.
NoteIDGuidValueGuid
DAC Field:PX.Objects.CR.Location.NoteID
Description:No description available
ExtRefNbrStringValuestring
DAC Field:PX.Objects.CR.Location.ExtRefNbr
Description:The external reference number

Minimum Payload

Derived from static analysis of the 2025.2 source; runtime configuration may require additional fields.

1 required field
{
  "LocationID": {
    "value": "string"
  }
}

For every property this entity accepts, see the properties table.

Optional Children

None of these child collections is required — a payload without them is valid. If you do include one, these are the fields each row of it needs; keys the parent record supplies are named separately and must not be sent.

  • LocationContacta nested Contactrequired if you include one:DisplayName

Available in Versions