Update an address
patch
/crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}
Request
Path Parameters
-
AddressNumber(required): string
The alternate unique identifier for the address. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated. Prefix defined as in profile option ZCA_PUID_PREFIX concatenated with an internally generated unique sequence number.
-
PartyNumber(required): string
The unique primary identifier for the household party. The profile option HZ_GENERATE_PARTY_NUMBER controls whether the attribute value can be system generated or user-provided during create. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task.
Header Parameters
-
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.
Supported Media Types
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : schema
Type:
Show Source
object
-
AddrElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
The additional address element to support flexible address format. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line for address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line for address. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third line for address. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth line for address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
Phonetic or Kana representation of the Kanji address lines (used in Japan). -
AddressLocale: array
Address Locales
Title:
Address Locales
The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language. -
AddressPurpose: array
Address Purposes
Title:
Address Purposes
The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address. -
AddressType: string
Title:
Type
The address type. -
Building: string
Title:
Building
Maximum Length:240
Specific building name or number at a given address. -
CalculateFormattedAddress: boolean
The indicator to process formatted address of the party record.
-
City: string
Title:
City
Maximum Length:60
The city element of address. -
ClliCode: string
Title:
CLLI Code
Maximum Length:60
The Common Language Location Identifier (CLLI) code of the address. The code is used within the North American to specify the location of the address. -
Comments: string
Title:
Comments
Maximum Length:2000
The user-provided comments for the address. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict for the address record. This number is used by mobile or portable applications that consume the web service. -
CorpCurrencyCode: string
Title:
Corporate Currency
Maximum Length:15
The corporate currency code associated with the address. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
Country: string
Title:
Country
Maximum Length:2
The country code of the address. Review the list of country codes using the Manage Geographies task. -
County: string
Title:
County
Maximum Length:60
The county element of address. -
CreatedByModule: string
Default Value:
HZ_WS
The application module that created this organization record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
CreatedByModule1: string
Title:
Created by Application
Maximum Length:30
The module that created the record. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the address. A list of valid values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code related to the address. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
DateValidated: string
(date)
Title:
Validated Date
The date when the address was last validated. -
Description: string
Title:
Description
Maximum Length:2000
An extensive description of the location. -
DoNotMailFlag: boolean
Title:
Contact Preferences
Default Value:false
Indicates whether the address should not be used for mailing. If the value is Y, then the address should not be used to mail to the contact. The default value is N. If this attribute is not explicitly mentioned in the payload while creating an address, then the value of this attribute is set to null. -
DoNotValidateFlag: boolean
Title:
Don't Validate
Maximum Length:1
Indicates that a particular location is not eligible for address validation regardless of the current Validation Status Code. -
DunsNumberC: string
Title:
D-U-N-S Number
Maximum Length:30
The D-U-N-S number of the business location. -
EffectiveDate: string
(date)
The date when the address becomes active.
-
EndDateActive: string
(date)
Title:
End Date
The date after which this address is rendered inactive. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The specific floor number at a given address or in a particular building when building number is provided. -
HouseType: string
Title:
House Type
Maximum Length:30
The type of the building in the address. A list of valid values are defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
Latitude: number
Title:
Latitude
The latitude information for the address. This is used for spatial proximity and containment purposes. -
LocationDirections: string
Title:
Location Directions
Maximum Length:640
The directions to the location. -
LocationId: integer
(int64)
Title:
Location ID
The unique identifier for this location. -
Longitude: number
Title:
Longitude
The longitude information for the address. This is used for spatial proximity and containment purposes. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
A user-defined code to indicate a mail drop point within their organization. -
ObjectVersionNumber: integer
(int32)
The number used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
ObjectVersionNumber1: integer
(int32)
The number used to implement optimistic locking for address record. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
PartyId: integer
(int64)
Title:
Party ID
The unique identifier of the account, contact or household to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the account, contact or household record with which the address is associated. -
PartyNumber: string
Title:
Party Number
The unique identifier for the party (account, contact, or household), to which the address is associated. One of PartyId, PartyNumber, or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact, or household record with which the address is associated. The profile option HZ_GENERATE_PARTY_NUMBER controls whether the attribute value can be system-generated or user-provided during create. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. -
PartySiteName: string
Title:
Site Name
Maximum Length:240
User-defined name for the address. -
PartySourceSystem: string
Title:
Party Source System
The name of external source system of the account, contact or household with which the address is associated. Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. -
PartySourceSystemReferenceValue: string
Title:
Party Source System Reference Value
The unique identifier from external source system for the account, contact or household with which the address is associated. Part of alternate key (along with PartySourceSystem). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code as defined by the formal countrywide postal system. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
The four-digit extension to the United States Postal ZIP code. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates whether this is the primary address of the associated object. If the value is True, then this is the primary address. The default value is False. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to null. -
Province: string
Title:
Province
Maximum Length:60
The province element of address. -
SourceSystem: string
The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SourceSystemReferenceValue: string
The unique identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
State: string
Title:
State
Maximum Length:60
The state element of address. -
Status: string
Title:
Status
Maximum Length:1
Default Value:A
An internal application-determined flag indicating status of the address. Status codes are defined by the lookup HZ_STATUS. -
ValidatedFlag: boolean
Title:
Validated
Maximum Length:1
Default Value:false
Indicates if the location was validated. If the value is True, then the location is validated. The default value is false. The value is internally set by system during address cleansing. -
ValidationStatusCode: string
Title:
Validation Status
Maximum Length:30
The code indicating the status of the validation. Internally set by system during address cleansing.
Nested Schema : Address Locales
Type:
array
Title:
Address Locales
The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.
Show Source
Nested Schema : Address Purposes
Type:
array
Title:
Address Purposes
The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AddrElementAttribute1: string
Title:
Address Element Attribute 1
Maximum Length:150
The additional address element 1 to support flexible address format in local language. -
AddrElementAttribute2: string
Title:
Address Element Attribute 2
Maximum Length:150
The additional address element 2 to support flexible address format in local language. -
AddrElementAttribute3: string
Title:
Address Element Attribute 3
Maximum Length:150
The additional address element 3 to support flexible address format in local language. -
AddrElementAttribute4: string
Title:
Address Element Attribute 4
Maximum Length:150
The additional address element 4 to support flexible address format in local language. -
AddrElementAttribute5: string
Title:
Address Element Attribute 5
Maximum Length:150
The additional address element 5 to support flexible address format in local language. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line of the address in the local language. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line of the address in the local language. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third line of the address in the local language. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth line of the address in the local language. -
Building: string
Title:
Building
Maximum Length:240
The specific building name or number at a given address in local language. -
City: string
Title:
City
Maximum Length:60
The specific name of the city in local language. -
County: string
Title:
County
Maximum Length:60
The specific name of the county in local language. -
FloorNumber: string
Title:
Floor
Maximum Length:240
The specific floor number at a given address or a particular building when building number is provided in local language. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the locale. A postal code, known in various countries as a post code, postcode, or ZIP code, is a series of letters or digits appended to a postal address for the purpose of sorting mail in local language. -
PostalPlus4code: string
Title:
Postal Code Extension
Maximum Length:20
The four digit extension to the United States Postal ZIP code in local language. -
Province: string
Title:
Province
Maximum Length:60
The name of the province in local language. -
SiteSourceSystem: string
The name of external source system for the parent address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SiteSourceSystemReferenceValue: string
The unique identifier for the parent address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
State: string
Title:
State
Maximum Length:60
The name of the State in the local language. -
TransliterationLanguage: string
Title:
Transliteration Language
Maximum Length:4
Transliteration Language helps people pronounce words and names in foreign languages. It is validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values are US,NL, DK.
Nested Schema : households-Address-AddressPurpose-item-patch-request
Type:
Show Source
object
-
Comments: string
Title:
Comments
Maximum Length:2000
The user comments for the address purpose. -
CreatedByModule: string
Maximum Length:
30
Default Value:HZ_WS
The application module that created this address purpose record. The default value for CreatedByModule is HZ_WS for all Web service based creation. A list of accepted values is defined in the lookup type HZ_CREATED_BY_MODULES. You can review and update the value for this attribute using the Setup and Maintenance task work area, Manage Trading Community Common Lookups task. -
DeleteFlag: boolean
Indicates whether the address purpose is to be deleted. If the value is True, then the address purpose will be deleted. The default value is NULL. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to null.
-
EndDate: string
(date)
Title:
To Date
The date on which the address purpose is no longer valid. -
PrimaryPerType: string
Title:
Primary
Maximum Length:1
Default Value:N
Indicates if this is the primary use for the site. Y stands for the primary site and N stands for all other sites. -
SiteSourceSystem: string
The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SiteSourceSystemReferenceValue: string
The unique identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SourceSystem: string
The name of external source system for the address purpose denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address purpose.
-
SourceSystemReferenceValue: string
The unique identifier for the address purpose from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
Status: string
Title:
Status
Maximum Length:1
Default Value:A
Indicates whether the address purpose is still valid for the associated address record. The value A indicates active and I indicates inactive.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : households-Address-item-response
Type:
Show Source
object
-
AddrElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
The additional address element to support flexible address format. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line for address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line for address. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third line for address. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth line for address. -
AddressId: integer
(int64)
Read Only:
true
Address internal unique identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
Phonetic or Kana representation of the Kanji address lines (used in Japan). -
AddressLocale: array
Address Locales
Title:
Address Locales
The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language. -
AddressNumber: string
Title:
Site Number
Maximum Length:30
The alternate unique identifier for the address. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated. Prefix defined as in profile option ZCA_PUID_PREFIX concatenated with an internally generated unique sequence number. -
AddressPurpose: array
Address Purposes
Title:
Address Purposes
The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address. -
AddressType: string
Title:
Type
The address type. -
Building: string
Title:
Building
Maximum Length:240
Specific building name or number at a given address. -
CalculateFormattedAddress: boolean
The indicator to process formatted address of the party record.
-
City: string
Title:
City
Maximum Length:60
The city element of address. -
ClliCode: string
Title:
CLLI Code
Maximum Length:60
The Common Language Location Identifier (CLLI) code of the address. The code is used within the North American to specify the location of the address. -
Comments: string
Title:
Comments
Maximum Length:2000
The user-provided comments for the address. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict for the address record. This number is used by mobile or portable applications that consume the web service. -
CorpCurrencyCode: string
Title:
Corporate Currency
Maximum Length:15
The corporate currency code associated with the address. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
Country: string
Title:
Country
Maximum Length:2
The country code of the address. Review the list of country codes using the Manage Geographies task. -
County: string
Title:
County
Maximum Length:60
The county element of address. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreatedByModule: string
Default Value:
HZ_WS
The application module that created this organization record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
CreatedByModule1: string
Title:
Created by Application
Maximum Length:30
The module that created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the address. A list of valid values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code related to the address. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
DateValidated: string
(date)
Title:
Validated Date
The date when the address was last validated. -
Description: string
Title:
Description
Maximum Length:2000
An extensive description of the location. -
DoNotMailFlag: boolean
Title:
Contact Preferences
Default Value:false
Indicates whether the address should not be used for mailing. If the value is Y, then the address should not be used to mail to the contact. The default value is N. If this attribute is not explicitly mentioned in the payload while creating an address, then the value of this attribute is set to null. -
DoNotValidateFlag: boolean
Title:
Don't Validate
Maximum Length:1
Indicates that a particular location is not eligible for address validation regardless of the current Validation Status Code. -
DunsNumberC: string
Title:
D-U-N-S Number
Maximum Length:30
The D-U-N-S number of the business location. -
EffectiveDate: string
(date)
The date when the address becomes active.
-
EndDateActive: string
(date)
Title:
End Date
The date after which this address is rendered inactive. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The specific floor number at a given address or in a particular building when building number is provided. -
FormattedAddress: string
Title:
Address
Read Only:true
The formatted address information. -
FormattedAddress1: string
Title:
Formatted Address 1
Read Only:true
The formatted version of the address. -
FormattedMultilineAddress: string
Title:
Address
Read Only:true
The formatted multiple line address information. -
FormattedMultilineAddress1: string
Title:
Address
Read Only:true
The formatted multiline version of the address. -
HouseType: string
Title:
House Type
Maximum Length:30
The type of the building in the address. A list of valid values are defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of the user who last updated the record. -
Latitude: number
Title:
Latitude
The latitude information for the address. This is used for spatial proximity and containment purposes. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationDirections: string
Title:
Location Directions
Maximum Length:640
The directions to the location. -
LocationId: integer
(int64)
Title:
Location ID
The unique identifier for this location. -
Longitude: number
Title:
Longitude
The longitude information for the address. This is used for spatial proximity and containment purposes. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
A user-defined code to indicate a mail drop point within their organization. -
ObjectVersionNumber: integer
(int32)
The number used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
ObjectVersionNumber1: integer
(int32)
The number used to implement optimistic locking for address record. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
PartyId: integer
(int64)
Title:
Party ID
The unique identifier of the account, contact or household to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the account, contact or household record with which the address is associated. -
PartyNumber: string
Title:
Party Number
The unique identifier for the party (account, contact, or household), to which the address is associated. One of PartyId, PartyNumber, or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact, or household record with which the address is associated. The profile option HZ_GENERATE_PARTY_NUMBER controls whether the attribute value can be system-generated or user-provided during create. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. -
PartySiteName: string
Title:
Site Name
Maximum Length:240
User-defined name for the address. -
PartySourceSystem: string
Title:
Party Source System
The name of external source system of the account, contact or household with which the address is associated. Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. -
PartySourceSystemReferenceValue: string
Title:
Party Source System Reference Value
The unique identifier from external source system for the account, contact or household with which the address is associated. Part of alternate key (along with PartySourceSystem). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code as defined by the formal countrywide postal system. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
The four-digit extension to the United States Postal ZIP code. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates whether this is the primary address of the associated object. If the value is True, then this is the primary address. The default value is False. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to null. -
Province: string
Title:
Province
Maximum Length:60
The province element of address. -
SourceSystem: string
The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SourceSystemReferenceValue: string
The unique identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SSROwnerTableName: string
Read Only:
true
Maximum Length:255
The name of the table that holds the address record data and is referenced to manage source system reference. -
SSRPartyOwnerTableName: string
Read Only:
true
Maximum Length:255
Default Value:HZ_PARTIES
The name of the table that holds the party record data and is referenced to manage source system reference. -
StartDateActive: string
(date)
Title:
Start Date
The date from which this address is active. This value is defaulted to the current system date if not provided during create. -
State: string
Title:
State
Maximum Length:60
The state element of address. -
Status: string
Title:
Status
Maximum Length:1
Default Value:A
An internal application-determined flag indicating status of the address. Status codes are defined by the lookup HZ_STATUS. -
ValidatedFlag: boolean
Title:
Validated
Maximum Length:1
Default Value:false
Indicates if the location was validated. If the value is True, then the location is validated. The default value is false. The value is internally set by system during address cleansing. -
ValidationStartDate: string
(date)
Read Only:
true
The date on which the validation starts. This attribute is internally set by the system during address cleansing. -
ValidationStatusCode: string
Title:
Validation Status
Maximum Length:30
The code indicating the status of the validation. Internally set by system during address cleansing.
Nested Schema : Address Locales
Type:
array
Title:
Address Locales
The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.
Show Source
Nested Schema : Address Purposes
Type:
array
Title:
Address Purposes
The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : households-Address-AddressLocale-item-response
Type:
Show Source
object
-
AddrElementAttribute1: string
Title:
Address Element Attribute 1
Maximum Length:150
The additional address element 1 to support flexible address format in local language. -
AddrElementAttribute2: string
Title:
Address Element Attribute 2
Maximum Length:150
The additional address element 2 to support flexible address format in local language. -
AddrElementAttribute3: string
Title:
Address Element Attribute 3
Maximum Length:150
The additional address element 3 to support flexible address format in local language. -
AddrElementAttribute4: string
Title:
Address Element Attribute 4
Maximum Length:150
The additional address element 4 to support flexible address format in local language. -
AddrElementAttribute5: string
Title:
Address Element Attribute 5
Maximum Length:150
The additional address element 5 to support flexible address format in local language. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line of the address in the local language. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line of the address in the local language. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third line of the address in the local language. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth line of the address in the local language. -
AddressNumber: string
Title:
Site Number
Read Only:true
Maximum Length:30
The unique address identifier that is internally generated during create. One of the following keys is used to identify the address purpose record during update: AddressId, AddressNumber, or SourceSystem and SourceSystemReferenceValue. -
Building: string
Title:
Building
Maximum Length:240
The specific building name or number at a given address in local language. -
City: string
Title:
City
Maximum Length:60
The specific name of the city in local language. -
Country: string
Title:
Country
Read Only:true
Maximum Length:2
The specific name of the country in local language. -
County: string
Title:
County
Maximum Length:60
The specific name of the county in local language. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the address locale record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the address locale record was created. -
FloorNumber: string
Title:
Floor
Maximum Length:240
The specific floor number at a given address or a particular building when building number is provided in local language. -
FormattedAddress: string
Read Only:
true
The formatted read only version of the locale address. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the address locale was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the address locale record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the address locale record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationId: integer
(int64)
The unique identifier of the location record.
-
LocationLocaleId: integer
(int64)
Read Only:
true
The unique identifier of the location locale record. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the locale. A postal code, known in various countries as a post code, postcode, or ZIP code, is a series of letters or digits appended to a postal address for the purpose of sorting mail in local language. -
PostalPlus4code: string
Title:
Postal Code Extension
Maximum Length:20
The four digit extension to the United States Postal ZIP code in local language. -
Province: string
Title:
Province
Maximum Length:60
The name of the province in local language. -
SiteSourceSystem: string
The name of external source system for the parent address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SiteSourceSystemReferenceValue: string
The unique identifier for the parent address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
State: string
Title:
State
Maximum Length:60
The name of the State in the local language. -
TransliterationLanguage: string
Title:
Transliteration Language
Maximum Length:4
Transliteration Language helps people pronounce words and names in foreign languages. It is validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values are US,NL, DK.
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.
Nested Schema : households-Address-AddressPurpose-item-response
Type:
Show Source
object
-
AddressId: integer
(int64)
The unique address identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address purpose record during update.
-
AddressNumber: string
Title:
Site Number
Read Only:true
Maximum Length:30
The unique address identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address purpose record during update. -
AddressPurposeId: integer
(int64)
Read Only:
true
The unique identifier of the address purpose. -
Comments: string
Title:
Comments
Maximum Length:2000
The user comments for the address purpose. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the address purpose record. -
CreatedByModule: string
Maximum Length:
30
Default Value:HZ_WS
The application module that created this address purpose record. The default value for CreatedByModule is HZ_WS for all Web service based creation. A list of accepted values is defined in the lookup type HZ_CREATED_BY_MODULES. You can review and update the value for this attribute using the Setup and Maintenance task work area, Manage Trading Community Common Lookups task. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the address purpose record was created. -
DeleteFlag: boolean
Indicates whether the address purpose is to be deleted. If the value is True, then the address purpose will be deleted. The default value is NULL. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to null.
-
EndDate: string
(date)
Title:
To Date
The date on which the address purpose is no longer valid. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the address purpose was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the address purpose record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the address purpose record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrimaryPerType: string
Title:
Primary
Maximum Length:1
Default Value:N
Indicates if this is the primary use for the site. Y stands for the primary site and N stands for all other sites. -
Purpose: string
Title:
Purpose
Maximum Length:30
The purpose of the address. A list of valid values is defined in the lookup PARTY_SITE_USE_CODE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
SiteSourceSystem: string
The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SiteSourceSystemReferenceValue: string
The unique identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SourceSystem: string
The name of external source system for the address purpose denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address purpose.
-
SourceSystemReferenceValue: string
The unique identifier for the address purpose from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
StartDate: string
(date)
Title:
From Date
The date from which the address purpose is valid. -
Status: string
Title:
Status
Maximum Length:1
Default Value:A
Indicates whether the address purpose is still valid for the associated address record. The value A indicates active and I indicates inactive.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- AddressLocale
-
Parameters:
- AddressNumber:
$request.path.AddressNumber
- PartyNumber:
$request.path.PartyNumber
The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language. - AddressNumber:
- AddressPurpose
-
Parameters:
- AddressNumber:
$request.path.AddressNumber
- PartyNumber:
$request.path.PartyNumber
The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address. - AddressNumber:
- CountriesLOV
-
Parameters:
- finder:
ObsoleteEnabledFlagFinder%3BBindEnabledFlag%3DY%2CBindObsoleteFlag%3DN
The list of values for the country code of the address, such as US and UK.
The following properties are defined on the LOV link relation:- Source Attribute: Country; Target Attribute: TerritoryCode
- Display Attribute: TerritoryShortName
- finder:
- FuseTypeLookupVA
-
Parameters:
- finder:
LookupTypeTagFinder%3BBindLookupType%3DPARTY_SITE_USE_CODE%2CBindTag%3DSALES_CLOUD
The following properties are defined on the LOV link relation:- Source Attribute: AddressType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- HouseTypeLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_HOUSE_TYPE
The list of values for the building type, such as houseboat or trailer.
The following properties are defined on the LOV link relation:- Source Attribute: HouseType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: