Get a billing party contact data
get
/fscmRestApi/resources/11.13.18.05/publicSectorBillingPartyContacts/{PartyId}
Request
Path Parameters
-
PartyId(required): integer(int64)
The unique identifier of a party in the database.
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 : publicSectorBillingPartyContacts-item-response
Type:
Show Source
object
-
Address1: string
Read Only:
true
Maximum Length:240
The first line of the contact address. -
Address2: string
Read Only:
true
Maximum Length:240
The second line of the contact address. -
Address3: string
Read Only:
true
Maximum Length:240
The third line of the contact address. -
Address4: string
Read Only:
true
Maximum Length:240
The fourth line of the contact address. -
AsContactClass: string
Read Only:
true
Maximum Length:7
The contact class of the billing contact. -
AsRoleStatus: string
Read Only:
true
Maximum Length:1
The status of the customer account role. -
City: string
Read Only:
true
Maximum Length:60
The city for the contact address. -
ContactPersonId: integer
(int64)
Read Only:
true
The identifier based on party and relationship. -
Country: string
Read Only:
true
Maximum Length:2
The country of the contact address. -
County: string
Read Only:
true
Maximum Length:60
The county of the contact address. -
CustAccountId: integer
(int64)
Read Only:
true
The identifier generated for the billing account. -
CustAccountRoleId: integer
(int64)
Read Only:
true
The identifier of the customer account role. -
CustAcctSiteId: integer
(int64)
Read Only:
true
The identifier generated for the billing account site. -
EmailAddress: string
Read Only:
true
Maximum Length:320
The email address of the customer contact. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrgContactId: integer
(int64)
Read Only:
true
Identifier generated for the contact. -
OrgContactNumbner: string
Read Only:
true
Maximum Length:30
The number of the organization contact. -
PartyId: integer
(int64)
Read Only:
true
The unique identifier of a party in the database. -
PartyName: string
Read Only:
true
Maximum Length:360
The descriptive name or identifier of the party and is used to provide additional context beyond the unique identifier for the customer. -
PartyNumber: string
Read Only:
true
Maximum Length:30
The unique identifier of a party. -
PartyType: string
Read Only:
true
Maximum Length:30
The attribute or classification of organization or person type assigned to the party involved while creating a customer. -
PersonFirstName: string
Read Only:
true
Maximum Length:150
The first name of the customer person type. -
PersonLastName: string
Read Only:
true
Maximum Length:150
The last name of the customer with the person type. -
PersonMiddleName: string
Read Only:
true
Maximum Length:60
The middle name of the customer with person type. -
PersonNameSuffix: string
Read Only:
true
Maximum Length:30
The suffix of the customer with the person type. -
PersonTitle: string
Read Only:
true
Maximum Length:60
The title of the customer with the person type. -
PhoneAreaCode: string
Read Only:
true
Maximum Length:20
The phone area code of the contact. -
PhoneCountryCode: string
Read Only:
true
Maximum Length:10
The phone country code of the contact. -
PhoneExtension: string
Read Only:
true
Maximum Length:20
The phone number extension of the contact. -
PhoneLineType: string
Read Only:
true
Maximum Length:30
The phone type of the contact. -
PhoneNumber: string
Read Only:
true
Maximum Length:40
The phone number of the contact. -
PostalCode: string
Read Only:
true
Maximum Length:60
The postal code of the contact address. -
PrimaryFlag: string
Read Only:
true
Maximum Length:1
Indicates the primary contact. -
Province: string
Read Only:
true
Maximum Length:60
The province of the contact address. -
RawPhoneNumber: string
Read Only:
true
Maximum Length:60
The area code of the unformatted version of the phone for the contact. -
RelationshipId: integer
(int64)
Read Only:
true
Identifier of the relationship between the person and the account. -
RoleType: string
Read Only:
true
Maximum Length:30
The type of the customer role. -
State: string
Read Only:
true
Maximum Length:60
The state for the contact address.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed 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.