Jump to

• Request
• Response
• Examples

Get all partner contacts

get

/crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts

Request

Path Parameters

• CompanyNumber(required): string
  The alternate key identifier of the partner's company.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • CompanyNumberAndContactPartyNumberRF: Finds a partner contact by partner company number and party number.
    Finder Variables:
    • PartnerCompanyNumber; string; The unique identifier of the partner company.
    • PartyNumber; string; The unique identifier for the partner contact party. Can be system-generated or user-provided during create, based on the profile option HZ_GENERATE_PARTY_NUMBER.
  • CompanyNumberAndPartyNumberAltKey: Finds a partner contact by the company number or the party number.
    Finder Variables:
    • PartnerCompanyNumber; string.
  • ContactPartyNumberRF: Finds a partner contact by the party number.
    Finder Variables:
    • PartyNumber; string; The unique primary public identifier for the partner contact party.
  • PartyNumberAltKey: Finds a partner contact by the party number.
    Finder Variables:
  • PrimaryKey: Finds a partner contact by the party number.
    Finder Variables:
    • PartyId; integer; The ID field associated with a Partner Contact
  • SourceSystemReferenceAltKey: Finds a partner contact by source system reference value.
    Finder Variables:
    • SourceSystem; string; The name of the external source system of the partner contact.
    • SourceSystemReferenceValue; string; The identifier of the partner contact record from external source system.
  • SourceSystemReferenceRF: Finds a partner contact by source system and source system reference value.
    Finder Variables:
    • BindSourceSystem; string; The name of the external source system of the partner contact.
    • BindSourceSystemReferenceValue; string; The identifier of the partner contact record from external source system.
    • BindSystemDate; string; This is an internal attribute and should not be used.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AcademicTitle; string; The part of the person???s title that denotes the academic qualification, such as Dr. Jane Smith.
  • AddrElementAttribute1; string; An additional address element to support flexible address format.
  • AddrElementAttribute2; string; An additional address element to support flexible address format.
  • AddrElementAttribute3; string; An additional address element to support flexible address format.
  • AddrElementAttribute4; string; An additional address element to support flexible address format.
  • AddrElementAttribute5; string; An additional address element to support flexible address format.
  • AddressLineFour; string; The fourth line for address of the contact.
  • AddressLineOne; string; The first line for address.
  • AddressLineThree; string; The third line for address.
  • AddressLineTwo; string; The second line for address.
  • Building; string; The building name or number in the address of the contact.
  • CertificationLevel; string; The certification level of a contact. A list of accepted values is defined in the lookup HZ_PARTY_CERT_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • CertificationReasonCode; string; The code indicating the reason for the contact's current certification level assignment. A list of accepted values is defined using the lookup HZ_PARTY_CERT_REASON. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • City; string; The city element of the address.
  • Comments; string; The textual comments about a contact.
  • ContactName; string; The derived name of the contact.
  • Country; string; The country code of the address. Review the list of country codes using the Manage Geographies task.
  • CountryName; string; The name for the country of the partner company.
  • County; string; The county of the address.
  • CreateUserAccountFlag; boolean; Indicates whether the user account should be created. This should not be used currently.
  • CreatedBy; string; The user who created the record.
  • CreationDate; string; The date and time the record was created.
  • DateOfBirth; string; The date when the person was born.
  • DateOfDeath; string; The date when the person died.
  • DeceasedFlag; boolean; Indicates whether the person is deceased or not. If the value is True, then the person is deceased. The default value is False.
  • DeclaredEthnicity; string; The declared ethnicity of the person.
  • Department; string; The free form text used to name the department for the contact.
  • DepartmentCode; string; The code indicating the department of the contact. A list of accepted values is defined in the lookup DEPARTMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
  • DoNotCallFlag; boolean; Indicates if the user can call the person or not. If the value is True, then the user must not call the person. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task.
  • DoNotContactFlag; boolean; Indicates if the user can contact the person by phone, Email, or snail mail. If the value is True, then the user must not contact the person. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task.
  • DoNotEmailFlag; boolean; Indicates if the user can email the person or not. If the value is True, then the user must not contact the person by email. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task.
  • DoNotMailFlag; boolean; Indicates if the user can send mail to the person or not. If the value is True, then the user must not contact the person by mail. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task.
  • EmailAddress; string; The e-mail address of the partner contact.
  • FavoriteContactFlag; boolean; Indicates whether the person is a key contact. If the value is True, then person is a key contact. The default value is False. You can't use this attribute as a finder, because this is a transient field. The response will return an error if you use this attribute as a finder.
  • FirstName; string; The first name of the person.
  • FloorNumber; string; The floor number of the address.
  • Gender; string; The gender of the person, such as male, female, and unknown. A list of accepted values is defined in the lookup HZ_GENDER. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
  • Initials; string; The initials of the contact???s name.
  • JobTitle; string; The job title of the primary contact.
  • JobTitleCode; string; The code indicating the job title.
  • LastName; string; The last name of the person.
  • LastNamePrefix; string; The prefix for the last name of a person, such as De, Van. For example, if a person???s name is Hans De Vries, then the last name prefix De is captured using this attribute.
  • LastUpdateDate; string; The date on which the record was last updated.
  • LastUpdateLogin; string; The login details of the user who last updated the record.
  • LastUpdatedBy; string; The user who last updated the record.
  • Latitude; number; The latitude information for the address of the contact. The latitude information for the location is used for spatial proximity and containment purposes.
  • Longitude; number; The longitude information for the address of the contact. The longitude information for the location is used for spatial proximity and containment purposes.
  • Mailstop; string; The user-defined code that indicates a mail drop point within the organization.
  • MaritalStatus; string; The marital status of the person. A list of accepted values is defined in the lookup MARITAL_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
  • MaritalStatusEffectiveDate; string; The date when the person's marital status was changed.
  • MiddleName; string; The middle name of the person.
  • MobileAreaCode; string; The area code for partner contact's mobile phone.
  • MobileCountryCode; string; The international country code for a partner contact???s mobile phone number, such as 33 for France.
  • MobileExtension; string; The additional number used after initial connection to an internal telephone system.
  • MobileNumber; string; The mobile phone number of partner contact formatted in the local format. The number should not include area code, country code, or extension.
  • NameSuffix; string; The place in a family structure. For example, in "Tom Jones III", the "III" is the suffix.
  • NamedFlag; boolean; Indicates whether a sales account is a named sales account. If the value is True, then the sales account is a named sales account. The default value is False.
  • PartnerCompanyNumber; string; The unique identifier of the partner company.
  • PartnerName; string; The name of the partner associated with the contact.
  • PartnerPartyId; integer; The unique identifier of the party associated with the partner.
  • PartyId; integer; The unique identifier of the partner contact party generated by the system during creation.
  • PartyNumber; string; The unique identifier for the partner contact party. Can be system-generated or user-provided during create, based on the profile option HZ_GENERATE_PARTY_NUMBER.
  • PersonPreNameAdjunct; string; The title or the salutary introduction for a contact, such as Mr., Herr, and so on.
  • PlaceOfBirth; string; The place where the person was born, such as city or country.
  • PostalCode; string; The postal code as defined by the formal countrywide postal system.
  • PostalPlus4Code; string; The four-digit extension to the United States Postal ZIP code for the address.
  • PreferredContactMethod; string; The preferred method to contact the person. A list of accepted values is defined in the lookup HZ_PREFERRED_CONTACT_METHOD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Point Lookups task.
  • PreferredFunctionalCurrency; string; The preferred currency of the contact. A list of accepted values is defined using the Setup and Maintenance work area, Manage Currencies task.
  • PreviousLastName; string; The previous last name or surname of the person.
  • PrimaryAddressId; integer; The unique identifier for the address that is generated internally during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update.
  • PrimaryContactPartyId; integer; The party identifier of the primary contact of the partner.
  • Province; string; The province of the address.
  • RawMobileNumber; string; The raw mobile phone number in the contact point.
  • RawWorkPhoneNumber; string; The raw work phone number in the contact point.
  • RentOrOwnIndicator; string; Indicates if this contact owns or rents his or her residence. A list of valid values for rent, own, and lease is defined in the lookup OWN_RENT_IND. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
  • RoleName; string; The name of the resource role for partner contact.
  • SalesAffinityCode; string; The code indicating the affinity of a contact to the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_AFFINITY_CODE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
  • SalesBuyingRoleCode; string; The code indicating the role played by a contact in the buying process, for example, decision maker or supporting role. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_BUY_ROLE_CODE. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
  • Salutation; string; The phrase used to address a contact party in any correspondence.
  • SecondLastName; string; The second last name for a person. A list of accepted values is defined in the lookup HZ_PERSON_PROFILES. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
  • State; string; The state element of the address.
  • Title; string; A professional or family title, such as Don or The Right Honorable.
  • Type; string; The contact party type that defines whether the contact is a sales account, a prospect, a contact or any other user-defined party type. The default value is ZCA_CUSTOMER. A list of accepted values is defined in the lookup ZCA_CONTACT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
  • UserAccountRequestStatus; string; Status and error description, if any, for create user account LDAP request.
  • Username; string; The user name of the account for the partner contact. This should not be used currently.
  • WorkPhoneAreaCode; string; The area code for the partner contact's work phone.
  • WorkPhoneCountryCode; string; The international country code for a partner contact???s work phone number, such as 33 for France.
  • WorkPhoneExtension; string; The additional number used after initial connection to an internal telephone system.
  • WorkPhoneNumber; string; The work phone number of a partner contact formatted in the local format without the area code, country code, or extension.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

Back to Top

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.

Body ()

Root Schema : partners-contacts

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/partners-contacts-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object partners-contacts-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/partners-contacts-item-response"
    }
}

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 : partners-contacts-item-response

Type: object

Show Source

• AcademicTitle: string
  Title: Academic Title

  Maximum Length: 30

  The part of the person???s title that denotes the academic qualification, such as Dr. Jane Smith.
• AddrElementAttribute1: string
  Title: Additional Address Element 1

  Maximum Length: 150

  An additional address element to support flexible address format.
• AddrElementAttribute2: string
  Title: Additional Address Element 2

  Maximum Length: 150

  An additional address element to support flexible address format.
• AddrElementAttribute3: string
  Title: Additional Address Element 3

  Maximum Length: 150

  An additional address element to support flexible address format.
• AddrElementAttribute4: string
  Title: Additional Address Element 4

  Maximum Length: 150

  An additional address element to support flexible address format.
• AddrElementAttribute5: string
  Title: Additional Address Element 5

  Maximum Length: 150

  An additional address element to support flexible address format.
• AddressLineFour: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth line for address of the contact.
• AddressLineOne: string
  Title: Address Line 1

  Maximum Length: 240

  The first line for address.
• AddressLineThree: string
  Title: Address Line 3

  Maximum Length: 240

  The third line for address.
• AddressLineTwo: string
  Title: Address Line 2

  Maximum Length: 240

  The second line for address.
• AddressType: string
  Title: Address Type

  The lookup code for the type of address, such as billing address, shipping address etc.
• attachments: array Attachments
  Title: Attachments

  An attachments resource is used to view, create, modify or delete the partner's attachments.
• Building: string
  Title: Building

  Maximum Length: 240

  The building name or number in the address of the contact.
• CertificationLevel: string
  Title: Certification Level

  Maximum Length: 30

  The certification level of a contact. A list of accepted values is defined in the lookup HZ_PARTY_CERT_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• CertificationReasonCode: string
  Title: Certification Reason

  Maximum Length: 30

  The code indicating the reason for the contact's current certification level assignment. A list of accepted values is defined using the lookup HZ_PARTY_CERT_REASON. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• City: string
  Title: City

  Maximum Length: 60

  The city element of the address.
• Comments: string
  Title: Comments

  Maximum Length: 2000

  The textual comments about a contact.
• ContactName: string
  Title: Name

  Maximum Length: 450

  The derived name of the contact.
• Country: string
  Title: Country

  Maximum Length: 2

  The country code of the address. Review the list of country codes using the Manage Geographies task.
• CountryName: string
  Read Only: true

  The name for the country of the partner company.
• County: string
  Title: County

  Maximum Length: 60

  The county of the address.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreateUserAccountFlag: boolean
  Indicates whether the user account should be created. This should not be used currently.
• CreationDate: string (date-time)
  Read Only: true

  The date and time the record was created.
• DateOfBirth: string (date)
  Title: Date of Birth

  The date when the person was born.
• DateOfDeath: string (date)
  Title: Date of Death

  The date when the person died.
• DeceasedFlag: boolean
  Title: Person Deceased

  Maximum Length: 1

  Indicates whether the person is deceased or not. If the value is True, then the person is deceased. The default value is False.
• DeclaredEthnicity: string
  Title: Declared Ethnicity

  Maximum Length: 60

  The declared ethnicity of the person.
• 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 code indicating the department of the contact. A list of accepted values is defined in the lookup DEPARTMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
• DoNotCallFlag: boolean
  Title: Do Not Call

  Maximum Length: 1

  Indicates if the user can call the person or not. If the value is True, then the user must not call the person. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task.
• DoNotContactFlag: boolean
  Title: Do Not Contact

  Maximum Length: 1

  Indicates if the user can contact the person by phone, Email, or snail mail. If the value is True, then the user must not contact the person. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task.
• DoNotEmailFlag: boolean
  Title: Do Not Email

  Maximum Length: 1

  Indicates if the user can email the person or not. If the value is True, then the user must not contact the person by email. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task.
• DoNotMailFlag: boolean
  Title: Do Not Mail

  Maximum Length: 1

  Indicates if the user can send mail to the person or not. If the value is True, then the user must not contact the person by mail. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task.
• EmailAddress: string
  Title: Email

  Maximum Length: 320

  The e-mail address of the partner contact.
• FavoriteContactFlag: boolean
  Title: Favorite

  Maximum Length: 10

  Default Value: false

  Indicates whether the person is a key contact. If the value is True, then person is a key contact. The default value is False. You can't use this attribute as a finder, because this is a transient field. The response will return an error if you use this attribute as a finder.
• FirstName: string
  Title: First Name

  Maximum Length: 150

  The first name of the person.
• FloorNumber: string
  Title: Floor

  Maximum Length: 40

  The floor number of the address.
• FormattedAddress: string
  Title: Primary Address

  Read Only: true

  The formatted address of the partner contact.
• FormattedMobileNumber: string
  Title: Phone Number

  Read Only: true

  The formatted mobile phone number information.
• FormattedWorkPhoneNumber: string
  Title: Phone Number

  Read Only: true

  The formatted work phone number information.
• Gender: string
  Title: Gender

  Maximum Length: 30

  The gender of the person, such as male, female, and unknown. A list of accepted values is defined in the lookup HZ_GENDER. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
• HeadOfHierarchyFlag: boolean
  Title: Head of Hierarchy

  Maximum Length: 255

  Indicates whether this partner contact is a root resource of Partner or not. The value 'Y' indicates that this partner contact is a root resource of the partner.
• Initials: string
  Title: Initials

  Maximum Length: 20

  The initials of the contact???s name.
• IsAccountContactFlag: boolean
  Default Value: false

  Indicates whether an existing contact from an account would be converted to partner contact. The value 'Y' indicates that the party id of the existing account contact would be used for the partner contact if the related account is already a partner.
• isSelfRegistration: string
  Title: Self-Registered

  Indicates whether the partner registration approval process will be invoked or not. If the value is Y, then the process will be invoked.
• JobTitle: string
  Title: Job Title

  Maximum Length: 100

  The job title of the primary contact.
• JobTitleCode: string
  Title: Job Title Code

  Maximum Length: 30

  The code indicating the job title.
• LastName: string
  Title: Last Name

  Maximum Length: 150

  The last name of the person.
• LastNamePrefix: string
  Title: Last Name Prefix

  Maximum Length: 30

  The prefix for the last name of a person, such as De, Van. For example, if a person???s name is Hans De Vries, then the last name prefix De is captured using this attribute.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date on which the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  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 of the contact. The latitude information for the location is used for spatial proximity and containment purposes.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Longitude: number
  Title: Longitude

  The longitude information for the address of the contact. The longitude information for the location is used for spatial proximity and containment purposes.
• Mailstop: string
  Title: Mail Stop

  Maximum Length: 60

  The user-defined code that indicates a mail drop point within the organization.
• ManagerName: string
  Title: Manager

  Read Only: true

  Maximum Length: 255

  The name of the manager of partner contact.
• ManagerPartyId: integer
  Title: Manager

  The unique identifier of the manager party of the partner contact.
• ManagerPartyNumber: string
  Maximum Length: 30

  The party number of the manager of the partner contact.
• MaritalStatus: string
  Title: Marital Status

  Maximum Length: 30

  The marital status of the person. A list of accepted values is defined in the lookup MARITAL_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
• MaritalStatusEffectiveDate: string (date)
  Title: Marital Status Effective Date

  The date when the person's marital status was changed.
• MiddleName: string
  Title: Middle Name

  Maximum Length: 60

  The middle name of the person.
• MobileAreaCode: string
  Title: Area Code

  Maximum Length: 20

  The area code for partner contact's mobile phone.
• MobileCountryCode: string
  Title: Phone Country Code

  Maximum Length: 10

  The international country code for a partner contact???s mobile phone number, such as 33 for France.
• MobileExtension: string
  Title: Extension

  Maximum Length: 20

  The additional number used after initial connection to an internal telephone system.
• MobileNumber: string
  Title: Phone

  Maximum Length: 40

  The mobile phone number of partner contact formatted in the local format. The number should not include area code, country code, or extension.
• NamedFlag: boolean
  Title: Named Contact

  Maximum Length: 1

  Default Value: false

  Indicates whether a sales account is a named sales account. If the value is True, then the sales account is a named sales account. The default value is False.
• NameSuffix: string
  Title: Suffix

  Maximum Length: 30

  The place in a family structure. For example, in "Tom Jones III", the "III" is the suffix.
• PartnerCompanyNumber: string
  Title: Partner Number

  Maximum Length: 30

  The unique identifier of the partner company.
• PartnerName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The name of the partner associated with the contact.
• PartnerPartyId: integer (int64)
  The unique identifier of the party associated with the partner.
• PartyId: integer (int64)
  The unique identifier of the partner contact party generated by the system during creation.
• PartyNumber: string
  Title: Registry ID

  Maximum Length: 30

  The unique identifier for the partner contact party. Can be system-generated or user-provided during create, based on the profile option HZ_GENERATE_PARTY_NUMBER.
• PersonPreNameAdjunct: string
  Title: Prefix

  Maximum Length: 30

  The title or the salutary introduction for a contact, such as Mr., Herr, and so on.
• PlaceOfBirth: string
  Title: Place of Birth

  Maximum Length: 60

  The place where the person was born, such as city or country.
• 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 for the address.
• PreferredContactMethod: string
  Title: Preferred Contact Method

  Maximum Length: 30

  The preferred method to contact the person. A list of accepted values is defined in the lookup HZ_PREFERRED_CONTACT_METHOD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Point Lookups task.
• PreferredFunctionalCurrency: string
  Title: Preferred Functional Currency

  Maximum Length: 15

  The preferred currency of the contact. A list of accepted values is defined using the Setup and Maintenance work area, Manage Currencies task.
• PreviousLastName: string
  Title: Previous Last Name

  Maximum Length: 150

  The previous last name or surname of the person.
• PrimaryAddressId: integer (int64)
  The unique identifier for the address that is generated internally during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update.
• PrimaryContactPartyId: integer (int64)
  Read Only: true

  The party identifier of the primary contact of the partner.
• PrimaryFlag: boolean
  Title: Primary Contact Indicator

  Maximum Length: 255

  Indicates whether this partner contact is primary contact of partner or not. If the value is True, then this partner contact is a primary contact.
• Province: string
  Title: Province

  Maximum Length: 60

  The province of the address.
• RawMobileNumber: string
  Title: Phone

  Maximum Length: 60

  The raw mobile phone number in the contact point.
• RawWorkPhoneNumber: string
  Title: Phone

  Maximum Length: 60

  The raw work phone number in the contact point.
• RentOrOwnIndicator: string
  Title: Rent or Own Indicator

  Maximum Length: 30

  Indicates if this contact owns or rents his or her residence. A list of valid values for rent, own, and lease is defined in the lookup OWN_RENT_IND. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
• RoleCode: string
  Maximum Length: 30

  The role code of the partner contact.
• RoleId: integer (int64)
  Title: Role

  The unique identifier of the resource role of the partner contact.
• RoleName: string
  Title: Role

  Read Only: true

  Maximum Length: 255

  The name of the resource role for partner contact.
• SalesAffinityCode: string
  Title: Affinity

  Maximum Length: 30

  The code indicating the affinity of a contact to the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_AFFINITY_CODE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
• SalesBuyingRoleCode: string
  Title: Buying Role

  Maximum Length: 30

  The code indicating the role played by a contact in the buying process, for example, decision maker or supporting role. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_BUY_ROLE_CODE. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
• Salutation: string
  Title: Salutation

  Maximum Length: 60

  The phrase used to address a contact party in any correspondence.
• SecondLastName: string
  Title: Second Last Name

  Maximum Length: 150

  The second last name for a person. A list of accepted values is defined in the lookup HZ_PERSON_PROFILES. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
• SourceSystem: string
  The name of the external source system.
• SourceSystemReferenceValue: string
  The identifier of the record from external source system.
• State: string
  Title: State

  Maximum Length: 60

  The state element of the address.
• Title: string
  Title: Title

  Maximum Length: 60

  A professional or family title, such as Don or The Right Honorable.
• Type: string
  Title: Type

  Maximum Length: 30

  The contact party type that defines whether the contact is a sales account, a prospect, a contact or any other user-defined party type. The default value is ZCA_CUSTOMER. A list of accepted values is defined in the lookup ZCA_CONTACT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
• UpdateFlag: boolean
  Read Only: true

  Indicates whether the partner contact object can be updated by the current user or not. If the value is True, then the partner contact object can be updated.
• UserAccountRequestStatus: string
  Title: User Account Request Status

  Read Only: true

  Status and error description, if any, for create user account LDAP request.
• userdetails: array User Account Details
  Title: User Account Details

  The user account details resource is used to view, create, update, and delete the user account details of a partner contact.
• Username: string
  The user name of the account for the partner contact. This should not be used currently.
• WorkPhoneAreaCode: string
  Title: Area Code

  Maximum Length: 20

  The area code for the partner contact's work phone.
• WorkPhoneCountryCode: string
  Title: Phone Country Code

  Maximum Length: 10

  The international country code for a partner contact???s work phone number, such as 33 for France.
• WorkPhoneExtension: string
  Title: Extension

  Maximum Length: 20

  The additional number used after initial connection to an internal telephone system.
• WorkPhoneNumber: string
  Title: Phone

  Maximum Length: 40

  The work phone number of a partner contact formatted in the local format without the area code, country code, or extension.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressLineOne":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "ManagerName":{
            "title":"Manager",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the manager of partner contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NamedFlag":{
            "title":"Named Contact",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a sales account is a named sales account. If the value is True, then the sales account is a named sales account. The default value is False.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "operators":[
                    "=",
                    "<>"
                ]
            },
            "x-queryable":true
        },
        "Gender":{
            "title":"Gender",
            "maxLength":"30",
            "type":"string",
            "description":"The gender of the person, such as male, female, and unknown. A list of accepted values is defined in the lookup HZ_GENDER. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FavoriteContactFlag":{
            "title":"Favorite",
            "maxLength":"10",
            "type":"boolean",
            "description":"Indicates whether the person is a key contact. If the value is True, then person is a key contact. The default value is False. You can't use this attribute as a finder, because this is a transient field. The response will return an error if you use this attribute as a finder.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "MobileExtension":{
            "title":"Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The additional number used after initial connection to an internal telephone system.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneExtension",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Extension"
            },
            "x-queryable":true
        },
        "PrimaryAddressId":{
            "type":"integer",
            "description":"The unique identifier for the address that is generated internally during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "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
        },
        "Mailstop":{
            "title":"Mail Stop",
            "maxLength":"60",
            "type":"string",
            "description":"The user-defined code that indicates a mail drop point within the organization.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PartySiteId"
                ]
            },
            "x-queryable":true
        },
        "AddressLineTwo":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "PrimaryContactPartyId":{
            "type":"integer",
            "description":"The party identifier of the primary contact of the partner.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PreferredContactMethod":{
            "title":"Preferred Contact Method",
            "maxLength":"30",
            "type":"string",
            "description":"The preferred method to contact the person. A list of accepted values is defined in the lookup HZ_PREFERRED_CONTACT_METHOD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Point Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DateOfBirth":{
            "title":"Date of Birth",
            "type":"string",
            "description":"The date when the person was born.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RawMobileNumber":{
            "title":"Phone",
            "maxLength":"60",
            "type":"string",
            "description":"The raw mobile phone number in the contact point.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PreviousLastName":{
            "title":"Previous Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The previous last name or surname of the person.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonPreviousLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Previous Last Name"
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Primary Address",
            "type":"string",
            "description":"The formatted address of the partner contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PersonCountry",
                    "PersonIdenAddrLocationId",
                    "PersonPersonalAddressFlag"
                ]
            }
        },
        "PartnerName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the partner associated with the contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CertificationLevel":{
            "title":"Certification Level",
            "maxLength":"30",
            "type":"string",
            "description":"The certification level of a contact. A list of accepted values is defined in the lookup HZ_PARTY_CERT_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Initials":{
            "title":"Initials",
            "maxLength":"20",
            "type":"string",
            "description":"The initials of the contact???s name.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonInitials",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Initials"
            },
            "x-queryable":true
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The longitude information for the address of the contact. The longitude information for the location is used for spatial proximity and containment purposes.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The e-mail address of the partner contact.",
            "nullable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "MobileAreaCode":{
            "title":"Area Code",
            "maxLength":"20",
            "type":"string",
            "description":"The area code for partner contact's mobile phone.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code"
            },
            "x-queryable":true
        },
        "AcademicTitle":{
            "title":"Academic Title",
            "maxLength":"30",
            "type":"string",
            "description":"The part of the person???s title that denotes the academic qualification, such as Dr. Jane Smith.",
            "nullable":true,
            "x-queryable":true
        },
        "RentOrOwnIndicator":{
            "title":"Rent or Own Indicator",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if this contact owns or rents his or her residence. A list of valid values for rent, own, and lease is defined in the lookup OWN_RENT_IND. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DeclaredEthnicity":{
            "title":"Declared Ethnicity",
            "maxLength":"60",
            "type":"string",
            "description":"The declared ethnicity of the person.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.DeclaredEthnicity",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Declared Ethnicity"
            },
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country code of the address. Review the list of country codes using the Manage Geographies task.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login details of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Building":{
            "title":"Building",
            "maxLength":"240",
            "type":"string",
            "description":"The building name or number in the address of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":"40",
            "type":"string",
            "description":"The floor number of the address.",
            "nullable":true,
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"An attachments resource is used to view, create, modify or delete the partner's attachments.",
            "items":{
                "$ref":"#/components/schemas/partners-contacts-attachments-item-response"
            }
        },
        "CertificationReasonCode":{
            "title":"Certification Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the reason for the contact's current certification level assignment. A list of accepted values is defined using the lookup HZ_PARTY_CERT_REASON. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CountryName":{
            "type":"string",
            "description":"The name for the country of the partner company.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "Country"
                ]
            },
            "x-queryable":true
        },
        "ManagerPartyId":{
            "title":"Manager",
            "type":"integer",
            "description":"The unique identifier of the manager party of the partner contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "WorkPhoneAreaCode":{
            "title":"Area Code",
            "maxLength":"20",
            "type":"string",
            "description":"The area code for the partner contact's work phone.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code"
            },
            "x-queryable":true
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":"100",
            "type":"string",
            "description":"The job title of the primary contact.",
            "nullable":true,
            "x-queryable":true
        },
        "Salutation":{
            "title":"Salutation",
            "maxLength":"60",
            "type":"string",
            "description":"The phrase used to address a contact party in any correspondence.",
            "nullable":true,
            "x-queryable":true
        },
        "RoleCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The role code of the partner contact.",
            "nullable":true,
            "x-queryable":false
        },
        "PlaceOfBirth":{
            "title":"Place of Birth",
            "maxLength":"60",
            "type":"string",
            "description":"The place where the person was born, such as city or country.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PlaceOfBirth",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Place of Birth"
            },
            "x-queryable":true
        },
        "DateOfDeath":{
            "title":"Date of Death",
            "type":"string",
            "description":"The date when the person died.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the person.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "AddressLineFour":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line for address of the contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "RoleId":{
            "title":"Role",
            "type":"integer",
            "description":"The unique identifier of the resource role of the partner contact.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"22"
            }
        },
        "SalesBuyingRoleCode":{
            "title":"Buying Role",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the role played by a contact in the buying process, for example, decision maker or supporting role. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_BUY_ROLE_CODE. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SecondLastName":{
            "title":"Second Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The second last name for a person. A list of accepted values is defined in the lookup HZ_PERSON_PROFILES. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonSecondLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Second Last Name"
            },
            "x-queryable":true
        },
        "Type":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The contact party type that defines whether the contact is a sales account, a prospect, a contact or any other user-defined party type. The default value is ZCA_CUSTOMER. A list of accepted values is defined in the lookup ZCA_CONTACT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>"
                ]
            },
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the partner contact party generated by the system during creation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ManagerPartyNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The party number of the manager of the partner contact.",
            "nullable":true,
            "x-queryable":false
        },
        "isSelfRegistration":{
            "title":"Self-Registered",
            "type":"string",
            "description":"Indicates whether the partner registration approval process will be invoked or not. If the value is Y, then the process will be invoked.",
            "nullable":true,
            "x-queryable":false
        },
        "PartnerCompanyNumber":{
            "title":"Partner Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the partner company.",
            "nullable":false,
            "x-queryable":true
        },
        "AddressType":{
            "title":"Address Type",
            "type":"string",
            "description":"The lookup code for the type of address, such as billing address, shipping address etc.",
            "nullable":true,
            "x-queryable":false
        },
        "ContactName":{
            "title":"Name",
            "maxLength":"450",
            "type":"string",
            "description":"The derived name of the contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of the external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date on which the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HeadOfHierarchyFlag":{
            "title":"Head of Hierarchy",
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates whether this partner contact is a root resource of Partner or not. The value 'Y' indicates that this partner contact is a root resource of the partner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "RoleId",
                    "PartyId",
                    "PartnerStatus",
                    "TreeCode"
                ]
            }
        },
        "MobileCountryCode":{
            "title":"Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The international country code for a partner contact???s mobile phone number, such as 33 for France.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The latitude information for the address of the contact. The latitude information for the location is used for spatial proximity and containment purposes.",
            "nullable":true,
            "x-queryable":true
        },
        "FormattedWorkPhoneNumber":{
            "title":"Phone Number",
            "type":"string",
            "description":"The formatted work phone number information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "WorkPhoneAreaCode",
                    "WorkPhoneCountryCode",
                    "WorkPhoneExtension",
                    "WorkPhoneLineType",
                    "WorkPhoneNumber"
                ]
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NameSuffix":{
            "title":"Suffix",
            "maxLength":"30",
            "type":"string",
            "description":"The place in a family structure. For example, in \"Tom Jones III\", the \"III\" is the suffix.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonNameSuffix",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Suffix"
            },
            "x-queryable":true
        },
        "DoNotMailFlag":{
            "title":"Do Not Mail",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the user can send mail to the person or not. If the value is True, then the user must not contact the person by mail. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WorkPhoneExtension":{
            "title":"Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The additional number used after initial connection to an internal telephone system.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneExtension",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Extension"
            },
            "x-queryable":true
        },
        "FormattedMobileNumber":{
            "title":"Phone Number",
            "type":"string",
            "description":"The formatted mobile phone number information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "MobileAreaCode",
                    "MobileCountryCode",
                    "MobileExtension",
                    "MobilePhoneLineType",
                    "MobileNumber"
                ]
            }
        },
        "PartnerPartyId":{
            "type":"integer",
            "description":"The unique identifier of the party associated with the partner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "AddrElementAttribute5":{
            "title":"Additional Address Element 5",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredFunctionalCurrency":{
            "title":"Preferred Functional Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The preferred currency of the contact. A list of accepted values is defined using the Setup and Maintenance work area, Manage Currencies task.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city element of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            },
            "x-queryable":true
        },
        "DeceasedFlag":{
            "title":"Person Deceased",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the person is deceased or not. If the value is True, then the person is deceased. The default value is False.",
            "nullable":false,
            "x-queryable":true
        },
        "AddrElementAttribute1":{
            "title":"Additional Address Element 1",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute2":{
            "title":"Additional Address Element 2",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute3":{
            "title":"Additional Address Element 3",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            },
            "x-queryable":true
        },
        "AddrElementAttribute4":{
            "title":"Additional Address Element 4",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "MaritalStatus":{
            "title":"Marital Status",
            "maxLength":"30",
            "type":"string",
            "description":"The marital status of the person. A list of accepted values is defined in the lookup MARITAL_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RoleName":{
            "title":"Role",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the resource role for partner contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Code Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The four-digit extension to the United States Postal ZIP code for the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            },
            "x-queryable":true
        },
        "userdetails":{
            "title":"User Account Details",
            "type":"array",
            "description":"The user account details resource is used to view, create, update, and delete the user account details of a partner contact.",
            "items":{
                "$ref":"#/components/schemas/partners-contacts-userdetails-item-response"
            },
            "x-cardinality":"1"
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state element of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            },
            "x-queryable":true
        },
        "LastNamePrefix":{
            "title":"Last Name Prefix",
            "maxLength":"30",
            "type":"string",
            "description":"The prefix for the last name of a person, such as De, Van. For example, if a person???s name is Hans De Vries, then the last name prefix De is captured using this attribute.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastNamePrefix",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name Prefix"
            },
            "x-queryable":true
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the person.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary Contact Indicator",
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates whether this partner contact is primary contact of partner or not. If the value is True, then this partner contact is a primary contact.",
            "nullable":true,
            "x-queryable":false
        },
        "WorkPhoneNumber":{
            "title":"Phone",
            "maxLength":"40",
            "type":"string",
            "description":"The work phone number of a partner contact formatted in the local format without the area code, country code, or extension.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone"
            },
            "x-queryable":true
        },
        "MaritalStatusEffectiveDate":{
            "title":"Marital Status Effective Date",
            "type":"string",
            "description":"The date when the person's marital status was changed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code as defined by the formal countrywide postal system.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            },
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the partner contact object can be updated by the current user or not. If the value is True, then the partner contact object can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DoNotCallFlag":{
            "title":"Do Not Call",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the user can call the person or not. If the value is True, then the user must not call the person. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UserAccountRequestStatus":{
            "title":"User Account Request Status",
            "type":"string",
            "description":"Status and error description, if any, for create user account LDAP request.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "RoleId"
                ]
            },
            "x-queryable":true
        },
        "RawWorkPhoneNumber":{
            "title":"Phone",
            "maxLength":"60",
            "type":"string",
            "description":"The raw work phone number in the contact point.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressLineThree":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "CreateUserAccountFlag":{
            "type":"boolean",
            "description":"Indicates whether the user account should be created. This should not be used currently.",
            "nullable":true,
            "x-queryable":true
        },
        "IsAccountContactFlag":{
            "type":"boolean",
            "description":"Indicates whether an existing contact from an account would be converted to partner contact. The value 'Y' indicates that the party id of the existing account contact would be used for the partner contact if the related account is already a partner.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "WorkPhoneCountryCode":{
            "title":"Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The international country code for a partner contact???s work phone number, such as 33 for France.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PersonPreNameAdjunct":{
            "title":"Prefix",
            "maxLength":"30",
            "type":"string",
            "description":"The title or the salutary introduction for a contact, such as Mr., Herr, and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DepartmentCode":{
            "title":"Department Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the department of the contact. A list of accepted values is defined in the lookup DEPARTMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The textual comments about a contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.Comments",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Comments"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "maxLength":"60",
            "type":"string",
            "description":"A professional or family title, such as Don or The Right Honorable.",
            "nullable":true,
            "x-queryable":true
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"The middle name of the person.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            },
            "x-queryable":true
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The identifier of the record from external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyNumber":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the partner contact party. Can be system-generated or user-provided during create, based on the profile option HZ_GENERATE_PARTY_NUMBER.",
            "nullable":false,
            "x-queryable":true
        },
        "MobileNumber":{
            "title":"Phone",
            "maxLength":"40",
            "type":"string",
            "description":"The mobile phone number of partner contact formatted in the local format. The number should not include area code, country code, or extension.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone"
            },
            "x-queryable":true
        },
        "DoNotContactFlag":{
            "title":"Do Not Contact",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the user can contact the person by phone, Email, or snail mail. If the value is True, then the user must not contact the person. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Username":{
            "type":"string",
            "description":"The user name of the account for the partner contact. This should not be used currently.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "RoleId"
                ]
            },
            "x-queryable":true
        },
        "JobTitleCode":{
            "title":"Job Title Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the job title.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DoNotEmailFlag":{
            "title":"Do Not Email",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the user can email the person or not. If the value is True, then the user must not contact the person by email. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SalesAffinityCode":{
            "title":"Affinity",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the affinity of a contact to the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_AFFINITY_CODE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

An attachments resource is used to view, create, modify or delete the partner's attachments.

Show Source

• Array of: object partners-contacts-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"An attachments resource is used to view, create, modify or delete the partner's attachments.",
    "items":{
        "$ref":"#/components/schemas/partners-contacts-attachments-item-response"
    }
}

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 : User Account Details

Type: array

Title: User Account Details

The user account details resource is used to view, create, update, and delete the user account details of a partner contact.

Show Source

• Array of: object partners-contacts-userdetails-item-response

{
    "title":"User Account Details",
    "type":"array",
    "description":"The user account details resource is used to view, create, update, and delete the user account details of a partner contact.",
    "items":{
        "$ref":"#/components/schemas/partners-contacts-userdetails-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : partners-contacts-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  The unique identifier used for tracking the uploaded files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attachment.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The name of the category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the attachment.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name of the person who uploaded the image.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the attachment record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  The code indicating the data type of the attachment.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The unique identifier of the attached document.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  The current version number of the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The code indicating the type of error, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The date when the contents in the attachment expire.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URL of the attachment.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name of the person who last updated the image.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The length of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name of the attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of the attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login associated with the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the attachment record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name of the person who uploaded the image.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The length of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The current version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"The login associated with the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the data type of the attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name of the person who last updated the image.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date when the contents in the attachment expire.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The code indicating the type of error, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"The unique identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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."
        }
    }
}

Nested Schema : partners-contacts-userdetails-item-response

Type: object

Show Source

• ErrorDescription: string
  Read Only: true

  The error description, if any, for creation of the user account.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• UserAccountStatus: string
  Title: User Account Request Status

  Read Only: true

  The status of the user account of the partner contact.
• Username: string
  Title: User Name

  The name of the user account of the partner contact.

{
    "type":"object",
    "properties":{
        "ErrorDescription":{
            "type":"string",
            "description":"The error description, if any, for creation of the user account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UserAccountStatus":{
            "title":"User Account Request Status",
            "type":"string",
            "description":"The status of the user account of the partner contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Username":{
            "title":"User Name",
            "type":"string",
            "description":"The name of the user account of the partner contact.",
            "nullable":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"
    }
}

Back to Top

Examples

cURL Command

The following example shows how to get all partner contacts by submitting get request on the REST resource using cURL.

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
 "OrganizationName":"Stry22.",
 "AddressLineOne":"2280 Quimby Road",
 "Country":"US",
"contacts":[{
"FirstName":"dd_pc_fn",
"LastName":"dd_pc_ln",
"EmailAddress":"[e-mail]"
}]} 

Back to Top