Update a customer cross reference record
patch
/fscmRestApi/resources/11.13.18.05/publicSectorRecordCustomerReferences/{TrxnCustXrefKey}
Request
Path Parameters
-
TrxnCustXrefKey(required): integer(int64)
Numeric identifier of the record.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
Address1: string
Title:
First Address LineMaximum Length:240The first line of the address. -
Address2: string
Title:
Second Address LineMaximum Length:240The second line of the address. -
Address3: string
Title:
Third Address LineMaximum Length:240The third line of the address. -
Address4: string
Title:
Fourth Address LineMaximum Length:240The fourth line of the address. -
AgencyId: integer
(int32)
Title:
Agency IDDefault Value:1Identifier of the agency. -
BillToFlag: string
Title:
Bill-To MarkMaximum Length:1Indicates whether the address is a bill to address. -
CallingMode: string
Maximum Length:
80Indicates the calling mode for programmatic use. -
City: string
Title:
CityMaximum Length:60The city of the address. -
Classification: string
Title:
ClassificationMaximum Length:3The customer type. -
ContactAddress1: string
Title:
First Address LineMaximum Length:240The first line of the contact address. -
ContactAddress2: string
Title:
Second Address LineMaximum Length:240The second line of the contact address. -
ContactAddress3: string
Title:
Third Address LineMaximum Length:240The third line of the contact address. -
ContactAddress4: string
Title:
Fourth Address LineMaximum Length:240The fourth line of the contact address. -
ContactCity: string
Title:
CityMaximum Length:60City of the contact address. -
ContactCountry: string
Title:
CountryMaximum Length:3Country of the contact address. -
ContactCounty: string
Title:
CountyMaximum Length:60County of the contact address. -
ContactEmailAddress: string
Title:
Email AddressMaximum Length:150The email address of the customer contact. -
ContactEmailAddress1: string
Title:
Email AddressMaximum Length:150Email address of the contact. -
ContactFirstName: string
Maximum Length:
150First Name of the contact. -
ContactId: integer
(int64)
Title:
Contact IDIdentifier of the contact. -
ContactLastName: string
Maximum Length:
150Last Name of the contact. -
ContactMiddleName: string
Maximum Length:
60Middle Name of the contact. -
ContactNameSuffix: string
Maximum Length:
30Name suffix of the contact. -
ContactPartyId: integer
(int64)
Identifier of the contact.
-
ContactPersonTitle: string
Maximum Length:
60Title of the contact. -
ContactPhoneAreaCode: string
Title:
Phone Area CodeMaximum Length:10The phone area code of the contact. -
ContactPhoneCountryCode: string
Title:
Phone Country CodeMaximum Length:10The phone country code of contact. -
ContactPhoneExtension: string
Title:
Phone ExtensionMaximum Length:20The phone number extension of the contact. -
ContactPhoneNumber: string
Title:
Phone NumberMaximum Length:40The phone number of the contact. -
ContactPhoneType: string
Title:
Phone TypeMaximum Length:30The phone number of the contact. -
ContactPostalCode: string
Title:
Postal CodeMaximum Length:60Postal code of the contact address. -
ContactPostalPlus4Code: string
Title:
Postal Plus4 CodeMaximum Length:10Additional postal code of the contact address. -
ContactProvince: string
Maximum Length:
60Province of the contact address. -
ContactRawPhoneNumber: string
Title:
Raw Phone NumberMaximum Length:60The area code of the unformatted version of the phone for the contact. -
ContactState: string
Title:
StateMaximum Length:60State of the contact address. -
ContactTypeCd: string
Title:
Contact Type CodeMaximum Length:30The contact type of the billing account. -
Country: string
Title:
CountryMaximum Length:3The country of the address. -
County: string
Title:
CountyMaximum Length:60The country of the address. -
CustAccountId: integer
(int64)
Title:
Customer Account IDIdentifier of the customer account. -
CustAccountName: string
Title:
Account NameMaximum Length:240Name of the customer. -
CustAccountNumber: string
Title:
Customer Account NumberMaximum Length:30The customer account number. -
CustAcctChoice: string
Title:
Customer Account ChoiceMaximum Length:30The customer account choice. -
CustAcctSiteId: integer
(int64)
Title:
Customer Account Site IDIdentifier of the customer account site. -
CustAcctVerificationStatus: string
Title:
Customer Account Verification StatusMaximum Length:30The status of the customer account cross reference record. -
CustPartyId: integer
(int64)
Title:
Party IDIdentifier of the customer party. -
CustPartyNumber: string
Title:
Party NumberMaximum Length:30The customer party number. -
CustPartyTypeCd: string
Title:
Party Type CodeMaximum Length:30Code associated with the customer party. -
CustSiteUseId: integer
(int64)
Title:
Site Use IDIdentifier of the customer site use. -
DunsNumberC: string
Title:
D-U-N-S NumberMaximum Length:30A global business information and insights provider. -
DuplicateCheckDoneFlag: string
Title:
Duplicate Check MarkMaximum Length:1Indicates whether duplicate check was done. -
DuplicateCheckOption: string
Title:
Duplicate Check OptionMaximum Length:30Indicates whether duplicate check should be done. -
EstablishedDate: string
(date)
Title:
Established DateThe establishment date of the customer. -
InvoiceSystemCd: string
Title:
Invoice System CodeMaximum Length:30Identifies the receivables application associated with invoices. -
JgzzFiscalCode: string
Title:
Taxpayer IdentifierMaximum Length:20The tax attribute. -
LnpRecordId: string
Title:
Record IDMaximum Length:50The application identifier. -
LnpRecordKey: integer
(int64)
Title:
Record KeyThe key for the submitted application. -
LocationId: integer
(int64)
Title:
Location IDUnique identifier of the customer location. -
MatchFoundFlag: string
Title:
Match Found FlagMaximum Length:1Indicates whether duplicate match was found. -
MigratedDataFlag: string
Title:
Migrated Data CheckMaximum Length:3Indicates whether the record is migrated. -
NameSuffix: string
Title:
Name SuffixMaximum Length:30The suffix of the customer with person type. -
PartyFirstName: string
Title:
Party First NameMaximum Length:150The first name of the customer person type. -
PartyLastName: string
Title:
Party Last NameMaximum Length:150The last name of the customer with person type. -
PartyMiddleName: string
Title:
Party Middle NameMaximum Length:60The middle name of the customer with person type. -
PartyName: string
Title:
Party NameMaximum Length:360Name of the customer party. -
PartySiteId: integer
(int64)
Identifier of the party site.
-
PartySiteName: string
Title:
Party Site NameMaximum Length:240Name of the party site. -
PersonTitle: string
Title:
Person TitleMaximum Length:60The title of the customer with person type. -
PostalCode: string
Title:
Postal CodeMaximum Length:60The postal code of the address. -
PostalPlus4Code: string
Title:
Postal Plus4 CodeMaximum Length:10The postal code plus of the address. -
ProfileClassName: string
Maximum Length:
30Name of the customer profile class. -
Province: string
Title:
ProvinceMaximum Length:60The province of the address. -
RecordTypeId: string
Title:
Record Type IDMaximum Length:50The identifier of the record type. -
SameBusEntityFlag: string
Title:
Same as business entityMaximum Length:1Indicates that billing party is same as the business entity. -
SameMailAddressFlag: string
Title:
Same as business mailing addressMaximum Length:1Indicates that billing address is same as the business location address. -
SetName: string
Title:
Set NameMaximum Length:80Reference set name associated with the billing site. -
State: string
Title:
StateMaximum Length:60The state of the address. -
StatusFlag: string
Title:
StatusMaximum Length:1The status of the billing account. -
TerminationDate: string
(date)
Title:
Termination DateThe termination date of the customer. -
TrxnCustXrefPuid: string
Maximum Length:
480Customer reference public identifier on the cross reference table.
Response
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 : publicSectorRecordCustomerReferences-item-response
Type:
Show Source
object-
Address1: string
Title:
First Address LineMaximum Length:240The first line of the address. -
Address2: string
Title:
Second Address LineMaximum Length:240The second line of the address. -
Address3: string
Title:
Third Address LineMaximum Length:240The third line of the address. -
Address4: string
Title:
Fourth Address LineMaximum Length:240The fourth line of the address. -
AgencyId: integer
(int32)
Title:
Agency IDDefault Value:1Identifier of the agency. -
BillToFlag: string
Title:
Bill-To MarkMaximum Length:1Indicates whether the address is a bill to address. -
CallingMode: string
Maximum Length:
80Indicates the calling mode for programmatic use. -
City: string
Title:
CityMaximum Length:60The city of the address. -
Classification: string
Title:
ClassificationMaximum Length:3The customer type. -
ContactAddress1: string
Title:
First Address LineMaximum Length:240The first line of the contact address. -
ContactAddress2: string
Title:
Second Address LineMaximum Length:240The second line of the contact address. -
ContactAddress3: string
Title:
Third Address LineMaximum Length:240The third line of the contact address. -
ContactAddress4: string
Title:
Fourth Address LineMaximum Length:240The fourth line of the contact address. -
ContactCity: string
Title:
CityMaximum Length:60City of the contact address. -
ContactCountry: string
Title:
CountryMaximum Length:3Country of the contact address. -
ContactCounty: string
Title:
CountyMaximum Length:60County of the contact address. -
ContactEmailAddress: string
Title:
Email AddressMaximum Length:150The email address of the customer contact. -
ContactEmailAddress1: string
Title:
Email AddressMaximum Length:150Email address of the contact. -
ContactFirstName: string
Maximum Length:
150First Name of the contact. -
ContactId: integer
(int64)
Title:
Contact IDIdentifier of the contact. -
ContactLastName: string
Maximum Length:
150Last Name of the contact. -
ContactMiddleName: string
Maximum Length:
60Middle Name of the contact. -
ContactNameSuffix: string
Maximum Length:
30Name suffix of the contact. -
ContactPartyId: integer
(int64)
Identifier of the contact.
-
ContactPersonTitle: string
Maximum Length:
60Title of the contact. -
ContactPhoneAreaCode: string
Title:
Phone Area CodeMaximum Length:10The phone area code of the contact. -
ContactPhoneCountryCode: string
Title:
Phone Country CodeMaximum Length:10The phone country code of contact. -
ContactPhoneExtension: string
Title:
Phone ExtensionMaximum Length:20The phone number extension of the contact. -
ContactPhoneNumber: string
Title:
Phone NumberMaximum Length:40The phone number of the contact. -
ContactPhoneType: string
Title:
Phone TypeMaximum Length:30The phone number of the contact. -
ContactPostalCode: string
Title:
Postal CodeMaximum Length:60Postal code of the contact address. -
ContactPostalPlus4Code: string
Title:
Postal Plus4 CodeMaximum Length:10Additional postal code of the contact address. -
ContactProvince: string
Maximum Length:
60Province of the contact address. -
ContactRawPhoneNumber: string
Title:
Raw Phone NumberMaximum Length:60The area code of the unformatted version of the phone for the contact. -
ContactState: string
Title:
StateMaximum Length:60State of the contact address. -
ContactTypeCd: string
Title:
Contact Type CodeMaximum Length:30The contact type of the billing account. -
Country: string
Title:
CountryMaximum Length:3The country of the address. -
County: string
Title:
CountyMaximum Length:60The country of the address. -
CustAccountId: integer
(int64)
Title:
Customer Account IDIdentifier of the customer account. -
CustAccountName: string
Title:
Account NameMaximum Length:240Name of the customer. -
CustAccountNumber: string
Title:
Customer Account NumberMaximum Length:30The customer account number. -
CustAcctChoice: string
Title:
Customer Account ChoiceMaximum Length:30The customer account choice. -
CustAcctSiteId: integer
(int64)
Title:
Customer Account Site IDIdentifier of the customer account site. -
CustAcctVerificationStatus: string
Title:
Customer Account Verification StatusMaximum Length:30The status of the customer account cross reference record. -
CustPartyId: integer
(int64)
Title:
Party IDIdentifier of the customer party. -
CustPartyNumber: string
Title:
Party NumberMaximum Length:30The customer party number. -
CustPartyTypeCd: string
Title:
Party Type CodeMaximum Length:30Code associated with the customer party. -
CustSiteUseId: integer
(int64)
Title:
Site Use IDIdentifier of the customer site use. -
DunsNumberC: string
Title:
D-U-N-S NumberMaximum Length:30A global business information and insights provider. -
DuplicateCheckDoneFlag: string
Title:
Duplicate Check MarkMaximum Length:1Indicates whether duplicate check was done. -
DuplicateCheckOption: string
Title:
Duplicate Check OptionMaximum Length:30Indicates whether duplicate check should be done. -
EstablishedDate: string
(date)
Title:
Established DateThe establishment date of the customer. -
InvoiceSystemCd: string
Title:
Invoice System CodeMaximum Length:30Identifies the receivables application associated with invoices. -
JgzzFiscalCode: string
Title:
Taxpayer IdentifierMaximum Length:20The tax attribute. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LnpRecordId: string
Title:
Record IDMaximum Length:50The application identifier. -
LnpRecordKey: integer
(int64)
Title:
Record KeyThe key for the submitted application. -
LocationId: integer
(int64)
Title:
Location IDUnique identifier of the customer location. -
MatchFoundFlag: string
Title:
Match Found FlagMaximum Length:1Indicates whether duplicate match was found. -
MigratedDataFlag: string
Title:
Migrated Data CheckMaximum Length:3Indicates whether the record is migrated. -
NameSuffix: string
Title:
Name SuffixMaximum Length:30The suffix of the customer with person type. -
PartyFirstName: string
Title:
Party First NameMaximum Length:150The first name of the customer person type. -
PartyLastName: string
Title:
Party Last NameMaximum Length:150The last name of the customer with person type. -
PartyMiddleName: string
Title:
Party Middle NameMaximum Length:60The middle name of the customer with person type. -
PartyName: string
Title:
Party NameMaximum Length:360Name of the customer party. -
PartySiteId: integer
(int64)
Identifier of the party site.
-
PartySiteName: string
Title:
Party Site NameMaximum Length:240Name of the party site. -
PersonTitle: string
Title:
Person TitleMaximum Length:60The title of the customer with person type. -
PostalCode: string
Title:
Postal CodeMaximum Length:60The postal code of the address. -
PostalPlus4Code: string
Title:
Postal Plus4 CodeMaximum Length:10The postal code plus of the address. -
ProfileClassName: string
Maximum Length:
30Name of the customer profile class. -
Province: string
Title:
ProvinceMaximum Length:60The province of the address. -
RecordTypeId: string
Title:
Record Type IDMaximum Length:50The identifier of the record type. -
SameBusEntityFlag: string
Title:
Same as business entityMaximum Length:1Indicates that billing party is same as the business entity. -
SameMailAddressFlag: string
Title:
Same as business mailing addressMaximum Length:1Indicates that billing address is same as the business location address. -
SetName: string
Title:
Set NameMaximum Length:80Reference set name associated with the billing site. -
State: string
Title:
StateMaximum Length:60The state of the address. -
StatusFlag: string
Title:
StatusMaximum Length:1The status of the billing account. -
TerminationDate: string
(date)
Title:
Termination DateThe termination date of the customer. -
TrxnCustXrefId: string
Maximum Length:
50Alpha numeric identifier of the record. -
TrxnCustXrefKey: integer
(int64)
Numeric identifier of the record.
-
TrxnCustXrefPuid: string
Maximum Length:
480Customer reference public identifier on the cross reference table.
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.