REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience

Update an account contact

patch

/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountContact/{AccountContactId}

Request

Path Parameters

AccountContactId(required): integer(int64)

The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
PartyNumber(required): string

The unique alternate identifier for the account party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number. Inactive records can't be updated.

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

Root Schema : schema

Type: object

Show Source

AccountPartyId: integer (int64)

Title: Account Party ID

The primary key identifier of the object in this relationship. Either one of ObjectPartyId, ObjectPartyNumber, and combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.
AccountPartyNumber: string

Title: Account Party Number

Maximum Length: 30

The public unique identification number for the object party of the relationship. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.
AccountSourceSystem: string

Title: Account Source System

The name of external source system for the object party in the relationship, which are defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.
AccountSourceSystemReferenceValue: string

Title: Account Source System Reference

The identifier for the object party in the relationship from external source system. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.
Comments: string

Title: Comments

Maximum Length: 2000

The comments of the user.
ContactNumber: string

Title: Contact Number

Maximum Length: 30

The user-defined identification number for this contact.
ContactPartyNumber: string

Title: Contact Party Number

Maximum Length: 30

The public key identifier for the subject party of the relationship. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.
ContactSourceSystem: string

Title: Contact Source System

The name of external source system for the subject party in the relationship, which are defined by an administrator as part of system setup. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.
ContactSourceSystemReferenceValue: string

Title: Contact Source System Reference

The identifier for the subject party in the relationship from external source system. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.
DecisionMakerFlag: boolean

Title: Decision Maker

Maximum Length: 1

Default Value: false

Indicates whether this contact is a decision maker. The values are Y for a decision maker, N for someone who's not the decision maker.
Department: string

Title: Department

Maximum Length: 60

The free form text used to name the department for the contact.
DepartmentCode: string

Title: Department Code

Maximum Length: 30

The value of the department code for the contact.
InfluenceLevelCode: string

Title: Influence Level

Maximum Length: 30

The contact's level of influence in the buying process.
JobTitle: string

Title: Job Title

Maximum Length: 100

The free form text for job title for the contact associated to an account.
JobTitleCode: string

Title: Job Title Code

Maximum Length: 30

The value of the code for the job title of the contact person.
PreferredContactFlag: boolean

Title: Preferred Contact

Maximum Length: 10

Default Value: false

Indicates whether this contact person is primary contact for the customer. Accepted values are Y and N. Default value is N.
PrimaryCustomerFlag: boolean

Title: Primary Customer

Maximum Length: 10

Default Value: false

Indicates whether this customer is primary customer for the contact. Accepted values are Y and N. Default value is N.
ReferenceUseFlag: boolean

Title: Reference

Maximum Length: 1

Default Value: false

Indicates if this contact can be used as a reference. The values are Y for a contact who will act as a reference, N for a contact who can't act as a reference.
RelationshipSourceSystem: string

Title: Relationship Source System

The name of external source system for the relationship, which is defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.
RelationshipSourceSystemReferenceValue: string

Title: Relationship Source System Reference

The identifier for the relationship with the external source system.
SalesAffinityCode: string

Title: Affinity

Maximum Length: 30

The contact's affinity for the deploying organization.
SalesAffinityComments: string

Title: Affinity Comments

Maximum Length: 2000

The comments describing the contact's affinity for the deploying organization.
SalesBuyingRoleCode: string

Title: Buying Role

Maximum Length: 30

The contact's role in the buying process.
Status: string

Maximum Length: 1

Default Value: A

Indicates whether this is an active or inactive relationship. The values are A for active, I for inactive. This is an internal column and you're not expected to pass in a value. A list of valid values is defined in the lookup HZ_STATUS. You can review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. Default value is A.

{
    "type":"object",
    "properties":{
        "ReferenceUseFlag":{
            "title":"Reference",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if this contact can be used as a reference. The values are Y for a contact who will act as a reference, N for a contact who can't act as a reference.",
            "nullable":true,
            "default":false
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":"100",
            "type":"string",
            "description":"The free form text for job title for the contact associated to an account.",
            "nullable":true
        },
        "AccountPartyNumber":{
            "title":"Account Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identification number for the object party of the relationship. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.",
            "nullable":false
        },
        "AccountSourceSystem":{
            "title":"Account Source System",
            "type":"string",
            "description":"The name of external source system for the object party in the relationship, which are defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AccountSourceSystemStr"
                ]
            }
        },
        "Department":{
            "title":"Department",
            "maxLength":"60",
            "type":"string",
            "description":"The free form text used to name the department for the contact.",
            "nullable":true
        },
        "PreferredContactFlag":{
            "title":"Preferred Contact",
            "maxLength":"10",
            "type":"boolean",
            "description":"Indicates whether this contact person is primary contact for the customer. Accepted values are Y and N. Default value is N.",
            "nullable":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PreferredContactPersonId"
                ]
            }
        },
        "ContactNumber":{
            "title":"Contact Number",
            "maxLength":"30",
            "type":"string",
            "description":"The user-defined identification number for this contact.",
            "nullable":true
        },
        "AccountPartyId":{
            "title":"Account Party ID",
            "type":"integer",
            "description":"The primary key identifier of the object in this relationship. Either one of ObjectPartyId, ObjectPartyNumber, and combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DepartmentCode":{
            "title":"Department Code",
            "maxLength":"30",
            "type":"string",
            "description":"The value of the department code for the contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Status":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether this is an active or inactive relationship. The values are A for active, I for inactive. This is an internal column and you're not expected to pass in a value. A list of valid values is defined in the lookup HZ_STATUS. You can review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. Default value is A.",
            "nullable":false,
            "default":"A"
        },
        "DecisionMakerFlag":{
            "title":"Decision Maker",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this contact is a decision maker. The values are Y for a decision maker, N for someone who's not the decision maker.",
            "nullable":true,
            "default":false
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The comments of the user.",
            "nullable":true
        },
        "SalesAffinityComments":{
            "title":"Affinity Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The comments describing the contact's affinity for the deploying organization.",
            "nullable":true
        },
        "ContactSourceSystem":{
            "title":"Contact Source System",
            "type":"string",
            "description":"The name of external source system for the subject party in the relationship, which are defined by an administrator as part of system setup. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ContactSourceSystemStr"
                ]
            }
        },
        "RelationshipSourceSystemReferenceValue":{
            "title":"Relationship Source System Reference",
            "type":"string",
            "description":"The identifier for the relationship with the external source system.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "RelationshipSourceSystemStr"
                ]
            }
        },
        "ContactSourceSystemReferenceValue":{
            "title":"Contact Source System Reference",
            "type":"string",
            "description":"The identifier for the subject party in the relationship from external source system. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ContactSourceSystemStr"
                ]
            }
        },
        "PrimaryCustomerFlag":{
            "title":"Primary Customer",
            "maxLength":"10",
            "type":"boolean",
            "description":"Indicates whether this customer is primary customer for the contact. Accepted values are Y and N. Default value is N.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "SalesBuyingRoleCode":{
            "title":"Buying Role",
            "maxLength":"30",
            "type":"string",
            "description":"The contact's role in the buying process.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ContactPartyNumber":{
            "title":"Contact Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public key identifier for the subject party of the relationship. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.",
            "nullable":false
        },
        "RelationshipSourceSystem":{
            "title":"Relationship Source System",
            "type":"string",
            "description":"The name of external source system for the relationship, which is defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "RelationshipSourceSystemStr"
                ]
            }
        },
        "JobTitleCode":{
            "title":"Job Title Code",
            "maxLength":"30",
            "type":"string",
            "description":"The value of the code for the job title of the contact person.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InfluenceLevelCode":{
            "title":"Influence Level",
            "maxLength":"30",
            "type":"string",
            "description":"The contact's level of influence in the buying process.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SalesAffinityCode":{
            "title":"Affinity",
            "maxLength":"30",
            "type":"string",
            "description":"The contact's affinity for the deploying organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AccountSourceSystemReferenceValue":{
            "title":"Account Source System Reference",
            "type":"string",
            "description":"The identifier for the object party in the relationship from external source system. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AccountSourceSystemStr"
                ]
            }
        }
    }
}

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 : accounts-AccountContact-item-response

Type: object

Show Source

AccountContactId: integer (int64)

Title: Account Contact ID

Read Only: true

The unique identifier of the account contact.
AccountPartyId: integer (int64)

Title: Account Party ID

The primary key identifier of the object in this relationship. Either one of ObjectPartyId, ObjectPartyNumber, and combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.
AccountPartyNumber: string

Title: Account Party Number

Maximum Length: 30

The public unique identification number for the object party of the relationship. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.
AccountSourceSystem: string

Title: Account Source System

The name of external source system for the object party in the relationship, which are defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.
AccountSourceSystemReferenceValue: string

Title: Account Source System Reference

The identifier for the object party in the relationship from external source system. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.
Comments: string

Title: Comments

Maximum Length: 2000

The comments of the user.
ContactFirstName: string

Title: First Name

Read Only: true

Maximum Length: 150

The first name of the contact record.
ContactLastName: string

Title: Last Name

Read Only: true

Maximum Length: 150

The last name of the contact record.
ContactLastUpdateDate: string (date-time)

Title: Contact Last Update Date

Read Only: true

The date when the contact record was last updated.
ContactName: string

Title: Name

Read Only: true

Maximum Length: 360

The name of the contact.
ContactNumber: string

Title: Contact Number

Maximum Length: 30

The user-defined identification number for this contact.
ContactPartyId: integer (int64)

Title: Contact Party ID

The primary key identifier of the subject in this relationship. Either one of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.
ContactPartyNumber: string

Title: Contact Party Number

Maximum Length: 30

The public key identifier for the subject party of the relationship. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.
ContactSourceSystem: string

Title: Contact Source System

The name of external source system for the subject party in the relationship, which are defined by an administrator as part of system setup. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.
ContactSourceSystemReferenceValue: string

Title: Contact Source System Reference

The identifier for the subject party in the relationship from external source system. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 64

The user who created the row.
CreatedByModule: string

Title: Created by Application

Maximum Length: 30

Default Value: HZ_WS

The application module that created the record. It's 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. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

The date and time when the row was created.
DecisionMakerFlag: boolean

Title: Decision Maker

Maximum Length: 1

Default Value: false

Indicates whether this contact is a decision maker. The values are Y for a decision maker, N for someone who's not the decision maker.
Department: string

Title: Department

Maximum Length: 60

The free form text used to name the department for the contact.
DepartmentCode: string

Title: Department Code

Maximum Length: 30

The value of the department code for the contact.
DoCallFlag: boolean

Title: OK to Call

Read Only: true

Maximum Length: 10

Default Value: false

Indicates whether the user can call the contact of an account. The accepted values are True and False or Y and N. Default is False or N.
DoEmailFlag: boolean

Title: OK to Email

Read Only: true

Maximum Length: 10

Default Value: false

Indicates whether the user can email the contact of an account. The accepted values are True and False or Y and N. Default is False or N.
DoNotCallFlag: boolean

Title: Do Not Call

Read Only: true

Maximum Length: 255

Default Value: false

Indicates whether you can call the account contact. The accepted values are True and False or Y and N. Default is False or N.
DoNotEmailFlag: boolean

Title: Do Not Email

Read Only: true

Maximum Length: 255

Default Value: false

Indicates whether you can email the account contact. The accepted values are True and False or Y and N. Default is False or N.
EmailAddress: string

Title: Primary Email

Read Only: true

Maximum Length: 320

The e-mail address of the contact person for the account.
EmailVerificationDate: string (date)

Title: Email Verification Date

Read Only: true

The date of the verification for the email.
EmailVerificationStatus: string

Title: Email Verification Status

Read Only: true

The status of the verification for email. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID, ORA_INVALID and ORA_PARTIALLY_VALID. Default value is blank which indicates that values are not verified.
FormattedAddress: string

Title: Address

Read Only: true

The formatted address of the contact.
FormattedPhoneNumber: string

Title: Phone Number

Read Only: true

The primary formatted phone number for the contact person.
InfluenceLevelCode: string

Title: Influence Level

Maximum Length: 30

The contact's level of influence in the buying process.
JobTitle: string

Title: Job Title

Maximum Length: 100

The free form text for job title for the contact associated to an account.
JobTitleCode: string

Title: Job Title Code

Maximum Length: 30

The value of the code for the job title of the contact person.
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 of the user who last updated the row.
links: array Links

Title: Links

The link relations associated with the resource instance.
PersonBuyingRole: string

Title: Buying Role

Read Only: true

Maximum Length: 30

Describes a contact's role in a buying relationship. Sample values are key decision maker, supporting decision maker.
PersonJobTitle: string

Title: Contact Job Title

Read Only: true

Maximum Length: 100

The title of the contact's job with deploying organization.
PersonSalesAffinityCode: string

Title: Affinity

Read Only: true

Maximum Length: 30

The contact's affinity for the deploying organization.
PhoneVerificationDate: string (date)

Title: Phone Verification Date

Read Only: true

The date of the verification for phone.
PhoneVerificationStatus: string

Title: Phone Verification Status

Read Only: true

The status of the verification for phone. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID and ORA_INVALID. Default value is blank which indicates that values are not verified.
PreferredContactFlag: boolean

Title: Preferred Contact

Maximum Length: 10

Default Value: false

Indicates whether this contact person is primary contact for the customer. Accepted values are Y and N. Default value is N.
PreferredContactMethod: string

Title: Preferred Contact Method

Read Only: true

The person's or organization's preferred contact method.
PrimaryCustomerFlag: boolean

Title: Primary Customer

Maximum Length: 10

Default Value: false

Indicates whether this customer is primary customer for the contact. Accepted values are Y and N. Default value is N.
ReferenceUseFlag: boolean

Title: Reference

Maximum Length: 1

Default Value: false

Indicates if this contact can be used as a reference. The values are Y for a contact who will act as a reference, N for a contact who can't act as a reference.
RelationshipId: integer (int64)

Title: Relationship Id

Read Only: true

The unique identifier of the relationship associated with account contact record.
RelationshipRecId: integer (int64)

Title: Relationship Record ID

Finds an account contact with the relationship record identifier.
RelationshipSourceSystem: string

Title: Relationship Source System

The name of external source system for the relationship, which is defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.
RelationshipSourceSystemReferenceValue: string

Title: Relationship Source System Reference

The identifier for the relationship with the external source system.
SalesAffinityCode: string

Title: Affinity

Maximum Length: 30

The contact's affinity for the deploying organization.
SalesAffinityComments: string

Title: Affinity Comments

Maximum Length: 2000

The comments describing the contact's affinity for the deploying organization.
SalesBuyingRoleCode: string

Title: Buying Role

Maximum Length: 30

The contact's role in the buying process.
Status: string

Maximum Length: 1

Default Value: A

Indicates whether this is an active or inactive relationship. The values are A for active, I for inactive. This is an internal column and you're not expected to pass in a value. A list of valid values is defined in the lookup HZ_STATUS. You can review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. Default value is A.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferenceUseFlag":{
            "title":"Reference",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if this contact can be used as a reference. The values are Y for a contact who will act as a reference, N for a contact who can't act as a reference.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "DoCallFlag":{
            "title":"OK to Call",
            "maxLength":"10",
            "type":"boolean",
            "description":"Indicates whether the user can call the contact of an account. The accepted values are True and False or Y and N. Default is False or N.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "PersonSalesAffinityCode":{
            "title":"Affinity",
            "maxLength":"30",
            "type":"string",
            "description":"The contact's affinity for the deploying organization.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AccountSourceSystem":{
            "title":"Account Source System",
            "type":"string",
            "description":"The name of external source system for the object party in the relationship, which are defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AccountSourceSystemStr"
                ]
            },
            "x-queryable":true
        },
        "Department":{
            "title":"Department",
            "maxLength":"60",
            "type":"string",
            "description":"The free form text used to name the department for the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredContactFlag":{
            "title":"Preferred Contact",
            "maxLength":"10",
            "type":"boolean",
            "description":"Indicates whether this contact person is primary contact for the customer. Accepted values are Y and N. Default value is N.",
            "nullable":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PreferredContactPersonId"
                ]
            }
        },
        "ContactNumber":{
            "title":"Contact Number",
            "maxLength":"30",
            "type":"string",
            "description":"The user-defined identification number for this contact.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AccountPartyId":{
            "title":"Account Party ID",
            "type":"integer",
            "description":"The primary key identifier of the object in this relationship. Either one of ObjectPartyId, ObjectPartyNumber, and combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FormattedPhoneNumber":{
            "title":"Phone Number",
            "type":"string",
            "description":"The primary formatted phone number for the contact person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EmailVerificationStatus":{
            "title":"Email Verification Status",
            "type":"string",
            "description":"The status of the verification for email. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID, ORA_INVALID and ORA_PARTIALLY_VALID. Default value is blank which indicates that values are not verified.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactPartyId":{
            "title":"Contact Party ID",
            "type":"integer",
            "description":"The primary key identifier of the subject in this relationship. Either one of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedByModule":{
            "title":"Created by Application",
            "maxLength":"30",
            "type":"string",
            "description":"The application module that created the record. It's 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. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":true
        },
        "PreferredContactMethod":{
            "title":"Preferred Contact Method",
            "type":"string",
            "description":"The person's or organization's preferred contact method.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether this is an active or inactive relationship. The values are A for active, I for inactive. This is an internal column and you're not expected to pass in a value. A list of valid values is defined in the lookup HZ_STATUS. You can review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. Default value is A.",
            "nullable":false,
            "default":"A",
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactLastUpdateDate":{
            "title":"Contact Last Update Date",
            "type":"string",
            "description":"The date when the contact record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesAffinityComments":{
            "title":"Affinity Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The comments describing the contact's affinity for the deploying organization.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactSourceSystem":{
            "title":"Contact Source System",
            "type":"string",
            "description":"The name of external source system for the subject party in the relationship, which are defined by an administrator as part of system setup. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ContactSourceSystemStr"
                ]
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted address of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RelationshipRecId":{
            "title":"Relationship Record ID",
            "type":"integer",
            "description":"Finds an account contact with the relationship record identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PersonBuyingRole":{
            "title":"Buying Role",
            "maxLength":"30",
            "type":"string",
            "description":"Describes a contact's role in a buying relationship. Sample values are key decision maker, supporting decision maker.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PrimaryCustomerFlag":{
            "title":"Primary Customer",
            "maxLength":"10",
            "type":"boolean",
            "description":"Indicates whether this customer is primary customer for the contact. Accepted values are Y and N. Default value is N.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "EmailAddress":{
            "title":"Primary Email",
            "maxLength":"320",
            "type":"string",
            "description":"The e-mail address of the contact person for the account.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "ContactLastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the contact record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "PhoneVerificationStatus":{
            "title":"Phone Verification Status",
            "type":"string",
            "description":"The status of the verification for phone. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID and ORA_INVALID. Default value is blank which indicates that values are not verified.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactPartyNumber":{
            "title":"Contact Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public key identifier for the subject party of the relationship. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "RelationshipSourceSystem":{
            "title":"Relationship Source System",
            "type":"string",
            "description":"The name of external source system for the relationship, which is defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "RelationshipSourceSystemStr"
                ]
            },
            "x-queryable":true
        },
        "EmailVerificationDate":{
            "title":"Email Verification Date",
            "type":"string",
            "description":"The date of the verification for the email.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonJobTitle":{
            "title":"Contact Job Title",
            "maxLength":"100",
            "type":"string",
            "description":"The title of the contact's job with deploying organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountSourceSystemReferenceValue":{
            "title":"Account Source System Reference",
            "type":"string",
            "description":"The identifier for the object party in the relationship from external source system. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AccountSourceSystemStr"
                ]
            },
            "x-queryable":true
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":"100",
            "type":"string",
            "description":"The free form text for job title for the contact associated to an account.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountPartyNumber":{
            "title":"Account Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identification number for the object party of the relationship. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "DoNotCallFlag":{
            "title":"Do Not Call",
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates whether you can call the account contact. The accepted values are True and False or Y and N. Default is False or N.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "ContactFirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the contact record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "DoEmailFlag":{
            "title":"OK to Email",
            "maxLength":"10",
            "type":"boolean",
            "description":"Indicates whether the user can email the contact of an account. The accepted values are True and False or Y and N. Default is False or N.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "DepartmentCode":{
            "title":"Department Code",
            "maxLength":"30",
            "type":"string",
            "description":"The value of the department code for the contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DecisionMakerFlag":{
            "title":"Decision Maker",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this contact is a decision maker. The values are Y for a decision maker, N for someone who's not the decision maker.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The comments of the user.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountContactId":{
            "title":"Account Contact ID",
            "type":"integer",
            "description":"The unique identifier of the account contact.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RelationshipSourceSystemReferenceValue":{
            "title":"Relationship Source System Reference",
            "type":"string",
            "description":"The identifier for the relationship with the external source system.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "RelationshipSourceSystemStr"
                ]
            },
            "x-queryable":true
        },
        "ContactSourceSystemReferenceValue":{
            "title":"Contact Source System Reference",
            "type":"string",
            "description":"The identifier for the subject party in the relationship from external source system. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ContactSourceSystemStr"
                ]
            },
            "x-queryable":true
        },
        "SalesBuyingRoleCode":{
            "title":"Buying Role",
            "maxLength":"30",
            "type":"string",
            "description":"The contact's role in the buying process.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RelationshipId":{
            "title":"Relationship Id",
            "type":"integer",
            "description":"The unique identifier of the relationship associated with account contact record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "JobTitleCode":{
            "title":"Job Title Code",
            "maxLength":"30",
            "type":"string",
            "description":"The value of the code for the job title of the contact person.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DoNotEmailFlag":{
            "title":"Do Not Email",
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates whether you can email the account contact. The accepted values are True and False or Y and N. Default is False or N.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "InfluenceLevelCode":{
            "title":"Influence Level",
            "maxLength":"30",
            "type":"string",
            "description":"The contact's level of influence in the buying process.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PhoneVerificationDate":{
            "title":"Phone Verification Date",
            "type":"string",
            "description":"The date of the verification for phone.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesAffinityCode":{
            "title":"Affinity",
            "maxLength":"30",
            "type":"string",
            "description":"The contact's affinity for the deploying organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

changeIndicator: string

Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

DepartmentCodeVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

finder: LookupTypeFinder%3BLookupType%3DDEPARTMENT_TYPE