Get a bill-to location
get
/fscmRestApi/resources/11.13.18.05/contractBillToLocations/{contractBillToLocationsUniqID}
Request
Path Parameters
-
contractBillToLocationsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Bill to Locations resource and used to uniquely identify an instance of Bill to Locations. The client should not generate the hash key value. Instead, the client should query on the Bill to Locations collection resource in order to navigate to a specific instance of Bill to Locations to get the hash key.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context: string
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version: string
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : contractBillToLocations-item-response
Type:
Show Source
object-
AcLocationCode: string
Title:
Alternate Character LocationRead Only:trueMaximum Length:60The code of the bill-to location. -
ActiveStatus: string
Title:
StatusRead Only:trueMaximum Length:30The active status of the bill-to location. -
AddInformation11: string
Read Only:
trueMaximum Length:150Additional information 11 of the bill-to location. -
AddInformation12: string
Read Only:
trueMaximum Length:150Additional information 12 of the bill-to location. -
AddInformation13: string
Read Only:
trueMaximum Length:150Additional information 13 of the bill-to location. -
AddInformation14: string
Read Only:
trueMaximum Length:150Additional information 14 of the bill-to location. -
AddInformation15: string
Read Only:
trueMaximum Length:150Additional information 15 of the bill-to location. -
AddInformation16: string
Read Only:
trueMaximum Length:150Additional information 16 of the bill-to location. -
AddInformation17: string
Read Only:
trueMaximum Length:150Additional information 17 of the bill-to location. -
AddInformation18: string
Read Only:
trueMaximum Length:150Additional information 18 of the bill-to location. -
AddInformation19: string
Read Only:
trueMaximum Length:150Additional information 19 of the bill-to location. -
AddInformation20: string
Read Only:
trueMaximum Length:150Additional information 20 of the bill-to location. -
AddressId: integer
(int64)
Title:
Address IDRead Only:trueThe unique address identifier of the bill-to location. -
AddressLine1: string
Title:
Address Line 1Read Only:trueMaximum Length:240Address line 1 of the bill-to location. -
AddressLine2: string
Title:
Address Line 2Read Only:trueMaximum Length:240Address line 2 of the bill-to location. -
AddressLine3: string
Title:
Address Line 3Read Only:trueMaximum Length:240Address line 3 of the bill-to location. -
AddressLine4: string
Title:
Address Line 4Read Only:trueMaximum Length:240Address line 4 of the bill-to location. -
Attribute1: string
Title:
Attribute 1Read Only:trueMaximum Length:150Attribute 1 of the bill-to location. -
Attribute10: string
Title:
Attribute 10Read Only:trueMaximum Length:150Attribute 10 of the bill-to location. -
Attribute11: string
Title:
Attribute 11Read Only:trueMaximum Length:150Attribute 11 of the bill-to location. -
Attribute12: string
Title:
Attribute 12Read Only:trueMaximum Length:150Attribute 12 of the bill-to location. -
Attribute13: string
Title:
Attribute 13Read Only:trueMaximum Length:150Attribute 13 of the bill-to location. -
Attribute14: string
Title:
Attribute 14Read Only:trueMaximum Length:150Attribute 14 of the bill-to location. -
Attribute15: string
Title:
Attribute 15Read Only:trueMaximum Length:150Attribute 15 of the bill-to location. -
Attribute16: string
Title:
Attribute 16Read Only:trueMaximum Length:150Attribute 16 of the bill-to location. -
Attribute17: string
Title:
Attribute 17Read Only:trueMaximum Length:150Attribute 17 of the bill-to location. -
Attribute18: string
Title:
Attribute 18Read Only:trueMaximum Length:150Attribute 18 of the bill-to location. -
Attribute19: string
Title:
Attribute 19Read Only:trueMaximum Length:150Attribute 19 of the bill-to location. -
Attribute2: string
Title:
Attribute 2Read Only:trueMaximum Length:150Attribute 2 of the bill-to location. -
Attribute20: string
Title:
Attribute 20Read Only:trueMaximum Length:150Attribute 20 of the bill-to location. -
Attribute21: string
Title:
Attribute 21Read Only:trueMaximum Length:150Attribute 21 of the bill-to location. -
Attribute22: string
Title:
Attribute 22Read Only:trueMaximum Length:150Attribute 22 of the bill-to location. -
Attribute23: string
Title:
Attribute 23Read Only:trueMaximum Length:150Attribute 23 of the bill-to location. -
Attribute24: string
Title:
Attribute 24Read Only:trueMaximum Length:150Attribute 24 of the bill-to location. -
Attribute25: string
Title:
Attribute 25Read Only:trueMaximum Length:150Attribute 25 of the bill-to location. -
Attribute26: string
Title:
Attribute 26Read Only:trueMaximum Length:150Attribute 26 of the bill-to location. -
Attribute27: string
Title:
Attribute 27Read Only:trueMaximum Length:150Attribute 27 of the bill-to location. -
Attribute28: string
Title:
Attribute 28Read Only:trueMaximum Length:150Attribute 28 of the bill-to location. -
Attribute29: string
Title:
Attribute 29Read Only:trueMaximum Length:150Attribute 29 of the bill-to location. -
Attribute3: string
Title:
Attribute 3Read Only:trueMaximum Length:150Attribute 3 of the bill-to location. -
Attribute30: string
Title:
Attribute 30Read Only:trueMaximum Length:150Attribute 30 of the bill-to location. -
Attribute4: string
Title:
Attribute 4Read Only:trueMaximum Length:150Attribute 4 of the bill-to location. -
Attribute5: string
Title:
Attribute 5Read Only:trueMaximum Length:150Attribute 5 of the bill-to location. -
Attribute6: string
Title:
Attribute 6Read Only:trueMaximum Length:150Attribute 6 of the bill-to location. -
Attribute7: string
Title:
Attribute 7Read Only:trueMaximum Length:150Attribute 7 of the bill-to location. -
Attribute8: string
Title:
Attribute 8Read Only:trueMaximum Length:150Attribute 8 of the bill-to location. -
Attribute9: string
Title:
Attribute 9Read Only:trueMaximum Length:150Attribute 9 of the bill-to location. -
AttributeCategory: string
Title:
Attribute ContextRead Only:trueMaximum Length:30Attribute category of the bill-to location. -
AttributeDate1: string
(date)
Title:
Attribute Date 1Read Only:trueDate attribute 1 of the bill-to location. -
AttributeDate10: string
(date)
Title:
Attribute Date 10Read Only:trueDate attribute 10 of the bill-to location. -
AttributeDate11: string
(date)
Title:
Attribute Date 11Read Only:trueDate attribute 11 of the bill-to location. -
AttributeDate12: string
(date)
Title:
Attribute Date 12Read Only:trueDate attribute 12 of the bill-to location. -
AttributeDate13: string
(date)
Title:
Attribute Date 13Read Only:trueDate attribute 13 of the bill-to location. -
AttributeDate14: string
(date)
Title:
Attribute Date 14Read Only:trueDate attribute 14 of the bill-to location. -
AttributeDate15: string
(date)
Title:
Attribute Date 15Read Only:trueDate attribute 15 of the bill-to location. -
AttributeDate2: string
(date)
Title:
Attribute Date 2Read Only:trueDate attribute 2 of the bill-to location. -
AttributeDate3: string
(date)
Title:
Attribute Date 3Read Only:trueDate attribute 3 of the bill-to location. -
AttributeDate4: string
(date)
Title:
Attribute Date 4Read Only:trueDate attribute 4 of the bill-to location. -
AttributeDate5: string
(date)
Title:
Attribute Date 5Read Only:trueDate attribute 5 of the bill-to location. -
AttributeDate6: string
(date)
Title:
Attribute Date 6Read Only:trueDate attribute 6 of the bill-to location. -
AttributeDate7: string
(date)
Title:
Attribute Date 7Read Only:trueDate attribute 7 of the bill-to location. -
AttributeDate8: string
(date)
Title:
Attribute Date 8Read Only:trueDate attribute 8 of the bill-to location. -
AttributeDate9: string
(date)
Title:
Attribute Date 9Read Only:trueDate attribute 9 of the bill-to location. -
AttributeNumber1: number
Title:
Attribute Number 1Read Only:trueNumber attribute 1 of the bill-to location. -
AttributeNumber10: number
Title:
Attribute Number 10Read Only:trueNumber attribute 10 of the bill-to location. -
AttributeNumber11: number
Title:
Attribute Number 11Read Only:trueNumber attribute 11 of the bill-to location. -
AttributeNumber12: number
Title:
Attribute Number 12Read Only:trueNumber attribute 12 of the bill-to location. -
AttributeNumber13: number
Title:
Attribute Number 13Read Only:trueNumber attribute 13 of the bill-to location. -
AttributeNumber14: number
Title:
Attribute Number 14Read Only:trueNumber attribute 14 of the bill-to location. -
AttributeNumber15: number
Title:
Attribute Number 15Read Only:trueNumber attribute 15 of the bill-to location. -
AttributeNumber16: number
Title:
Attribute Number 16Read Only:trueNumber attribute 16 of the bill-to location. -
AttributeNumber17: number
Title:
Attribute Number 17Read Only:trueNumber attribute 17 of the bill-to location. -
AttributeNumber18: number
Title:
Attribute Number 18Read Only:trueNumber attribute 18 of the bill-to location. -
AttributeNumber19: number
Title:
Attribute Number 19Read Only:trueNumber attribute 19 of the bill-to location. -
AttributeNumber2: number
Title:
Attribute Number 2Read Only:trueNumber attribute 2 of the bill-to location. -
AttributeNumber20: number
Title:
Attribute Number 20Read Only:trueNumber attribute 20 of the bill-to location. -
AttributeNumber3: number
Title:
Attribute Number 3Read Only:trueNumber attribute 3 of the bill-to location. -
AttributeNumber4: number
Title:
Attribute Number 4Read Only:trueNumber attribute 4 of the bill-to location. -
AttributeNumber5: number
Title:
Attribute Number 5Read Only:trueNumber attribute 5 of the bill-to location. -
AttributeNumber6: number
Title:
Attribute Number 6Read Only:trueNumber attribute 6 of the bill-to location. -
AttributeNumber7: number
Title:
Attribute Number 7Read Only:trueNumber attribute 7 of the bill-to location. -
AttributeNumber8: number
Title:
Attribute Number 8Read Only:trueNumber attribute 8 of the bill-to location. -
AttributeNumber9: number
Title:
Attribute Number 9Read Only:trueNumber attribute 9 of the bill-to location. -
BillToSiteFlag: string
Title:
Bill-to SiteRead Only:trueMaximum Length:30The bill-to site indicator of the bill-to location. -
Building: string
Title:
BuildingRead Only:trueMaximum Length:240The building of the bill-to location. -
BusinessGroupId: integer
(int64)
Title:
Business Group IDRead Only:trueThe unique identifier of the business group of the bill-to location. -
Country: string
Title:
CountryRead Only:trueMaximum Length:60The country of the bill-to location. -
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the bill-to location. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the bill-to location was created. -
DerivedLocale: string
Title:
Full LocationRead Only:trueMaximum Length:240The derived locale of the bill-to location. -
Description: string
Title:
DescriptionRead Only:trueMaximum Length:240The description of the bill-to location. -
Description1: string
Title:
Language NameRead Only:trueMaximum Length:255The description 1 of the bill-to location. -
Description2: string
Title:
Location Set DescriptionRead Only:trueMaximum Length:2000The description 2 of the bill-to location. -
DesignatedReceiverId: integer
(int64)
Title:
Designated ReceiverRead Only:trueThe designated receiver identifier of the bill-to location. -
EffectiveEndDate: string
(date)
Title:
Effective End DateRead Only:trueThe effective end date of the bill-to location. -
EffectiveEndDate2: string
(date)
Title:
Effective End DateRead Only:trueThe effective end date 2 of the bill-to location. -
EffectiveStartDate: string
(date)
Title:
Effective Start DateRead Only:trueThe effective start date of the bill-to location. -
EffectiveStartDate2: string
(date)
Title:
Effective Start DateRead Only:trueThe effective start date 2 of the bill-to location. -
EmailAddress: string
Title:
EmailRead Only:trueMaximum Length:240The email address of the bill-to location. -
EmployeeLocationFlag: string
Title:
Employee LocationRead Only:trueMaximum Length:1The employee location indicator of the bill-to location. -
FaxAreaCode2: string
Title:
Fax Area CodeRead Only:trueMaximum Length:60The fax area code 2 of the bill-to location. -
FaxCountryCode2: string
Title:
Fax Country CodeRead Only:trueMaximum Length:30The fax country code 2 of the bill-to location. -
FaxExtension2: string
Title:
Fax ExtensionRead Only:trueMaximum Length:60The fax extension 2 of the bill-to location. -
FaxSubscriberNum2: string
Title:
Local FaxRead Only:trueMaximum Length:60The fax subscriber number 2 of the bill-to location. -
FloorNumber: string
Title:
Floor NumberRead Only:trueMaximum Length:40The floor number of the bill-to location. -
FormattedFaxPhoneNumber: string
Read Only:
trueThe formatted fax phone number of the bill-to location. -
FormattedMainPhoneNumber: string
Read Only:
trueThe formatted main phone number of the bill-to location. -
FormattedMultiLineAddress: string
Title:
AddressRead Only:trueThe formatted multiline address of the bill-to location. -
FormattedOtherPhoneNumber: string
Read Only:
trueThe formatted other phone number of the bill-to location. -
GeoHierarchyNodeId: string
Read Only:
trueMaximum Length:32The geography hierarchy node identifier of the bill-to location. -
GeoHierarchyNodeValue: string
Title:
Geographic HierarchyRead Only:trueMaximum Length:100The geography hierarchy node value of the bill-to location. -
Geometry: object
Geometry
Read Only:
trueThe geometry of the bill-to location. -
InternalLocationCode: string
Title:
CodeRead Only:trueMaximum Length:150The internal location code of the bill-to location. -
InventoryOrganizationCode: string
Read Only:
trueMaximum Length:18The inventory organization code of the bill-to location. -
InventoryOrganizationId: integer
(int64)
Title:
Inventory OrganizationRead Only:trueThe inventory organization identifier of the bill-to location. -
InventoryOrganizationName: string
Title:
OrganizationRead Only:trueMaximum Length:240The inventory organization name of the bill-to location. -
Language: string
Title:
Official LanguageRead Only:trueMaximum Length:4The language of the bill-to location. -
LanguageCode: string
Title:
Language CodeRead Only:trueMaximum Length:4The language code of the bill-to location. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the bill-to location was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the bill-to location. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login of the user who last updated the bill-to location. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocationAddress: string
Title:
AddressRead Only:trueThe address of the bill-to location. -
LocationCode: string
Title:
Location CodeRead Only:trueMaximum Length:60The code of the bill-to location. -
LocationId: integer
(int64)
Read Only:
trueThe unique identifier of the bill-to location. -
LocationImageUrl: string
Title:
Image URLRead Only:trueMaximum Length:1000The image URL of the bill-to location. -
LocationName: string
Title:
Display NameRead Only:trueMaximum Length:240The name of the bill-to location. -
LocInformation13: string
Title:
Information 13Read Only:trueMaximum Length:150The location information 13 of the bill-to location. -
LocInformation14: string
Title:
Information 14Read Only:trueMaximum Length:150The location information 14 of the bill-to location. -
LocInformation15: string
Title:
Information 15Read Only:trueMaximum Length:150The location information 15 of the bill-to location. -
LocInformation16: string
Title:
Information 16Read Only:trueMaximum Length:150The location information 16 of the bill-to location. -
LocInformation17: string
Title:
Information 17Read Only:trueMaximum Length:150The location information 17 of the bill-to location. -
LocInformation18: string
Title:
Information 18Read Only:trueMaximum Length:150The location information 18 of the bill-to location. -
LocInformation19: string
Title:
Information 19Read Only:trueMaximum Length:150The location information 19 of the bill-to location. -
LocInformation20: string
Title:
Information 20Read Only:trueMaximum Length:150The location information 20 of the bill-to location. -
LocInformation21: string
Title:
Information 21Read Only:trueMaximum Length:150The location information 21 of the bill-to location. -
LocInformation22: string
Title:
Information 22Read Only:trueMaximum Length:150The location information 22 of the bill-to location. -
LocLatitude: number
Read Only:
trueThe latitude of the bill-to location. -
LocLongitude: number
Read Only:
trueThe longitude of the bill-to location. -
LongPostalCode: string
Title:
Long Postal CodeRead Only:trueMaximum Length:30The long postal code of the bill-to location. -
MainphoneAreaCode1: string
Title:
Main Phone Area CodeRead Only:trueMaximum Length:60The main phone area code 1 of the bill-to location. -
MainphoneCountryCode1: string
Title:
Main Phone Country CodeRead Only:trueMaximum Length:30The main phone country code 1 of the bill-to location. -
MainphoneExtension1: string
Title:
Main Phone ExtensionRead Only:trueMaximum Length:60The main phone extension 1 of the bill-to location. -
MainphoneSubscriberNum1: string
Title:
Main Local PhoneRead Only:trueMaximum Length:60The main phone subscriber number 1 of the bill-to location. -
ObjectVersionNumber: integer
(int32)
Read Only:
trueThe object version number of the bill-to location. -
ObjectVersionNumber1: integer
(int32)
Read Only:
trueThe object version number 1 of the bill-to location. -
OfficeSiteFlag: string
Title:
Office SiteRead Only:trueMaximum Length:30The office site indicator of the bill-to location. -
OfficialLanguageCode: string
Title:
Official LanguageRead Only:trueMaximum Length:30The official language code of the bill-to location. -
OrganizationId: integer
(int64)
Title:
Inventory OrganizationRead Only:trueThe organization identifier of the bill-to location. -
OrganizationId1: integer
(int64)
Read Only:
trueThe organization identifier 1 of the bill-to location. -
OtherphoneAreaCode3: string
Title:
Area CodeRead Only:trueMaximum Length:60The other phone area code 3 of the bill-to location. -
OtherphoneCountryCode3: string
Title:
Other Phone Country CodeRead Only:trueMaximum Length:30The other phone country code 3 of the bill-to location. -
OtherphoneExtension3: string
Title:
Other Phone ExtensionRead Only:trueMaximum Length:60The other phone extension 3 of the bill-to location. -
OtherphoneSubscriberNum3: string
Title:
Other Local PhoneRead Only:trueMaximum Length:60The other phone subscriber number 3 of the bill-to location. -
PostalCode: string
Title:
Postal CodeRead Only:trueMaximum Length:30The postal code of the bill-to location. -
ReceivingSiteFlag: string
Title:
Receiving SiteRead Only:trueMaximum Length:30The receiving site indicator of the bill-to location. -
Region1: string
Title:
CountyRead Only:trueMaximum Length:120The region 1 of the bill-to location. -
Region2: string
Title:
StateRead Only:trueMaximum Length:120The region 2 of the bill-to location. -
Region3: string
Title:
ProvinceRead Only:trueMaximum Length:120The region 3 of the bill-to location. -
SetCode: string
Title:
Location Set CodeRead Only:trueMaximum Length:30The set code of the bill-to location. -
SetId: integer
(int64)
Title:
SetRead Only:trueThe set identifier of the bill-to location. -
SetId1: integer
(int64)
Read Only:
trueThe set identifier 1 of the bill-to location. -
SetName: string
Title:
Location Set NameRead Only:trueMaximum Length:80The set name of the bill-to location. -
ShipToLocationId: integer
(int64)
Title:
Ship-to LocationRead Only:trueThe ship-to location of the bill-to location. -
ShipToSiteFlag: string
Title:
Ship-to SiteRead Only:trueMaximum Length:30The ship-to site indicator of the bill-to location. -
Style: string
Title:
Address StyleRead Only:trueMaximum Length:60The style of the bill-to location. -
SysEffectiveDate: string
(date)
The system effective date of the bill-to location.
-
TelephoneNumber1: string
Title:
Main PhoneRead Only:trueMaximum Length:240The phone number 1 of the bill-to location. -
TelephoneNumber2: string
Title:
FaxRead Only:trueMaximum Length:240The phone number 2 of the bill-to location. -
TelephoneNumber3: string
Title:
Other PhoneRead Only:trueMaximum Length:240The phone number 3 of the bill-to location. -
TimezoneCode: string
Title:
Time Zone CodeRead Only:trueMaximum Length:50The time zone code of the bill-to location. -
TownOrCity: string
Title:
Town or CityRead Only:trueMaximum Length:30The town or city of the bill-to location.
Nested Schema : Geometry
Type:
objectRead Only:
trueThe geometry of the bill-to location.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.