Contact

Return all contact types for an AccountRight company file

Date Released: Oct 3rd 2013 Date Updated: Mar 19th 2014
URLSupports
/{cf_uri}/Contact GET |  PUT |  POST |  DELETE

The elements list below details information for Contact. 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 contact identifier in the form of a guid.
  • CompanyNameString (50)
  • Company name of the contact.
  • LastNameString (50)
  • Last name for an individual contact
  • FirstNameString (20)
  • First name for an individual contact
  • IsIndividualBoolean
  • True indicates the contact represents an individual.
    False indicates the contact represents a company contact.
  • DisplayIDString (15)
  • Contact card id. { 'DisplayID': 'CUS00001' }
  • IsActiveBoolean
  • True indicates the contact is active.
    False indicates the 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 (10)
    • 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 this 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.
    • 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.
    • 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.
    • 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.
    • 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.
    • ValueString (30)
    • Custom field text entry populated for CustomField3.
  • CurrentBalanceDecimal (13.6)
  • Contact balance.
  • TypeString (8)
  • Card type of the contact record, can be either Customer, Supplier, Employee or Personal.
  • LastModifiedDateTime
  • Extracts the last modification date for the contact resource.
  • PhotoURIString
  • 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.


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

Example json GET response

  • {
    • "UID" : "2cdead51-beba-458e-88c9-a4ca9de5c388",
    • "LastName" : "Grimes",
    • "FirstName" : "Frank",
    • "IsIndividual" : true,
    • "DisplayID" : "CUS00011",
    • "IsActive" : true,
    • "Addresses" : [
      • {
        • "Location" : 1,
        • "Street" : "55 Maple Street",
        • "City" : "Melbourne",
        • "State" : "VIC",
        • "PostCode" : "3000",
        • "Country" : "Australia",
        • "Phone1" : "03 8897 9411",
        • "Phone2" : "03 8897 2722",
        • "Phone3" : "03 8897 7356",
        • "Fax" : "03 8897 4278",
        • "Website" : "www.myob.com.au",
        • "ContactName" : "Clint",
        • "Salutation" : "Mr."
        • }
      • ],
    • "Notes" : "Description for Frank Grimes",
    • "Identifiers" : [
      • {
        • "Label" : "AZZ",
        • "Value" : "A"
        • }
      • ],
    • "CustomList1" : null,
    • "CustomList2" : null,
    • "CustomList3" : null,
    • "CustomField1" : {
      • "Label" : "Custom Field No. 1",
      • "Value" : "Queensland"
      • },
    • "CustomField2" : {
      • "Label" : "Custom Field No. 2",
      • "Value" : "Sydney"
      • },
    • "CustomField3" : {
      • "Label" : "Custom Field No. 3",
      • "Value" : "Tasmania"
      • },
    • "CurrentBalance" : 0,
    • "Type" : "Customer",
    • "LastModified" : "2014-03-19T05:04:32.993",
    • "PhotoURI" : "{cf_uri}/Contact/Customer/2cdead51-beba-458e-88c9-a4ca9de5c388",
    • "RowVersion" : "682911070058184704"
    • }
  • Hypermedia in the AccountRight Live API

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

    Read more about Hypermedia in the AccountRight Live API in our best practice guide.