Personal

Return, update, create and delete a personal contact.

Date Released: Aug 2013 Date Updated: Dec 2020
URLSupports

/{cf_uri}/Contact/Personal

/{cf_uri}/Contact/Personal{contact_uid}/Photo

GET |  PUT |  POST |  DELETE

GET |  PUT |  POST |  DELETE

Please note: The /{cf_uri}/Contact/Personal/{contact_uid}/Photo endpoint is only available when using AccountRight.
Please note: While accessibility via the API is available to both AccountRight and new Essentials files. Not all features will be displayed in Product for new Essentials

The elements list below details information for Personal. To view the descriptions for the elements you can either hover any attribute to reveal details or click here to show all details inline.

Items shown with are required when posting or puting data
Items shown with are read-only elements

Attribute Details

  • UIDGuid (36)
  • Unique personal contact identifier in the form of a guid.
    ONLY required for updating an existing contact
    NOT required when creating a new contact.
  • CompanyNameString (50)
  • Company name of the personal contact.
    ONLY required when creating a company contact with IsIndividual set to false.
  • LastNameString (50)
  • Last name for an individual contact
  • FirstNameString (20)
  • First name for an individual contact
  • IsIndividualBoolean
  • True indicates the personal contact represents an individual.
    False indicates the personal contact represents a company.
  • DisplayIDString (15)
  • Personal contact card id. { 'DisplayID': 'PER00001' }
  • IsActiveBoolean
  • True indicates the personal contact is active.
    False indicates the personal contact is inactive.
  • Addresses []
  • The following set of information pulls through details for a contact address
    • Location Integer
    • One contact can have up to five address records.
    • Street String (255)
    • Full content of Address field.
    • City String (255)
    • City of address record.
    • State String (255)
    • State of address record.
    • PostCode String (11)
    • Postcode of address record.
    • Country String (255)
    • Country of location for address record.
    • Phone1 String (21)
    • Phone number 1 of address record.
    • Phone2 String (21)
    • Phone number 2 of address record.
    • Phone3 String (21)
    • Phone number 3 of address record.
    • Fax String (21)
    • Fax number of address record.
    • Email String (255)
    • Email contact of address record.
    • Website String (255)
    • World wide web address for contact.
    • ContactName String (25)
    • Contact Name on address record.
    • Salutation String (15)
    • Salutation text for address record.
  • NotesString (255)
  • Notes for the personal contact.
  • Identifiers []
  • The following set of information pulls through details for a contact identifier
    • Label String (30)
    • Name attached to the identification alphabet letter.
    • Value String
    • Identifiers convert bits to actual letters, one of the 26 letters in the alphabet can be used.
  • CustomList1
  • The following set of information pulls through details for a contact custom list
    • LabelString (30)
    • Name of CustomList1 applicable to the custom list text, labels can be edited within the AccountRight interface ONLY.
      For example CustomList # 1 could be changed to Melbourne, click here for more information on how to edit labels
    • ValueString (30)
    • Custom list text entry populated for CustomList1.
  • CustomList2
  • The following set of information pulls through details for a contact custom list
    • LabelString (30)
    • Name of CustomList2 applicable to the custom list text, labels can be edited within the AccountRight interface ONLY.
      For example CustomList # 2 could be changed to Sydney, click here for more information on how to edit labels
    • ValueString (30)
    • Custom list text entry populated for CustomList2.
  • CustomList3
  • The following set of information pulls through details for a contact custom list
    • LabelString (30)
    • Name of CustomList3 applicable to the custom list text, labels can be edited within the AccountRight interface ONLY.
      For example CustomList # 3 could be changed to Tasmania, click here for more information on how to edit labels
    • ValueString (30)
    • Custom list text entry populated for CustomList3.
  • CustomField1
  • The following set of information pulls through details for a contact custom field
    • LabelString (30)
    • Name of CustomField1 applicable to the custom field text, labels can be edited within the AccountRight interface ONLY.
      For example CustomField # 1 could be changed to South Australia, click here for more information on how to edit labels
    • ValueString (30)
    • Custom field text entry populated for CustomField1.
  • CustomField2
  • The following set of information pulls through details for a contact custom field
    • LabelString (30)
    • Name of CustomField2 applicable to the custom field text, labels can be edited, for example CustomField # 2 could be changed to Queensland
    • ValueString (30)
    • Custom field text entry populated for CustomField2.
  • CustomField3
  • The following set of information pulls through details for a contact custom field
    • LabelString (30)
    • Name of CustomField3 applicable to the custom field text, labels can be edited within the AccountRight interface ONLY.
      For example CustomField # 3 could be changed to ACT, click here for more information on how to edit labels
    • ValueString (30)
    • Custom field text entry populated for CustomField3.
  • CurrentBalanceDecimal (13.6)
  • Personal contact balance.
  • LastModifiedDateTime
  • Extracts the last modification date for the contact resource.
  • PhotoURIString
  • This is an AccountRight only field. Uniform resource identifier associated with a photo image.
  • URIString
  • Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
  • RowVersionString
  • Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.
    ONLY required for updating an existing contact
    NOT required when creating a new contact.


Paging: default page size is set to 400 with a maximum of 5000 results (contacts only).

Example json GET response

  • {
    • "UID" : "0a30ff19-e8d7-4699-8efc-e05b6ff67190",
    • "LastName" : "Wilson",
    • "FirstName" : "Penny",
    • "IsIndividual" : true,
    • "DisplayID" : "PER00001",
    • "IsActive" : true,
    • "Addresses" : [
      • {
        • "Location" : 1,
        • "Street" : "199 Zander Avenue",
        • "City" : "Melbourne",
        • "State" : "VIC",
        • "PostCode" : "3000",
        • "Country" : "Australia",
        • "Phone1" : "03 8897 9459",
        • "Phone2" : "03 8897 2756",
        • "Phone3" : "03 8897 7349",
        • "Fax" : "03 8897 4547",
        • "Website" : "www.myob.com.au",
        • "ContactName" : "David",
        • "Salutation" : "Hello"
        • }
      • ],
    • "Notes" : "Description for Penny",
    • "Identifiers" : [
      • {
        • "Label" : "AZZ",
        • "Value" : "D"
        • }
      • ],
    • "CustomList1" : null,
    • "CustomList2" : null,
    • "CustomList3" : null,
    • "CustomField1" : {
      • "Label" : "Custom Field No. 1",
      • "Value" : "Melbourne"
      • },
    • "CustomField2" : {
      • "Label" : "Custom Field No. 2",
      • "Value" : "Sydney"
      • },
    • "CustomField3" : {
      • "Label" : "Custom Field No. 3",
      • "Value" : "Tasmania"
      • },
    • "CurrentBalance" : 0,
    • "LastModified" : "2014-03-19T05:04:32.993",
    • "PhotoURI" : "{cf_uri}/Contact/Personal/0a30ff19-e8d7-4699-8efc-e05b6ff67190/Photo",
    • "URI" : "{cf_uri}/Contact/Personal/0a30ff19-e8d7-4699-8efc-e05b6ff67190",
    • "RowVersion" : "5302707086252048001"
    • }
Hypermedia in the MYOB Business API

The {cf_uri} is provided by the Company File endpoint.

Read more about Hypermedia in the MYOB Business API in our best practice guide.