Customer

Return, update, create and delete a customer contact.

Date Released: Aug 2013 Date Updated: Jan 2022
URLSupports

/{cf_uri}/Contact/Customer

/{cf_uri}/Contact/Customer/{contact_uid}/Photo

GET |  PUT |  POST |  DELETE

GET |  PUT |  POST |  DELETE

Please note: The /{cf_uri}/Contact/Customer/{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 Customer. 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 customer 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 customer contact.
    ONLY required when creating a company contact with IsIndividual set to false.
  • LastNameString (30)
  • Last name for an individual contact.
  • FirstNameString (20)
  • First name for an individual contact.
  • IsIndividualBoolean
  • True indicates the customer contact represents an individual.
    False indicates the customer contact represents a company.
  • DisplayIDString (15)
  • Customer contact card id. { 'DisplayID': 'CUS000001' }
  • IsActiveBoolean
  • True indicates the customer contact is active.
    False indicates the customer 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 customer contact.
  • Identifiers []
  • This is an AccountRight only field.The following set of information pulls through details for a contact identifier
    • Label String (30)
    • This is an AccountRight only field. Name attached to the identification alphabet letter.
    • Value String
    • This is an AccountRight only field. Identifiers convert bits to actual letters, one of the 26 letters in the alphabet can be used.
  • CustomList1
  • This is an AccountRight only field. The following set of information pulls through details for a contact custom list
    • LabelString (30)
    • This is an AccountRight only field. 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)
    • This is an AccountRight only field. Custom list text entry populated for CustomList1.
  • CustomList2
  • This is an AccountRight only field .The following set of information pulls through details for a contact custom list
    • LabelString (30)
    • This is an AccountRight only field. 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)
    • This is an AccountRight only field. Custom list text entry populated for CustomList2.
  • CustomList3
  • This is an AccountRight only field. The following set of information pulls through details for a contact custom list
    • LabelString (30)
    • This is an AccountRight only field. 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)
    • This is an AccountRight only field. Custom list text entry populated for CustomList3.
  • CustomField1
  • This is an AccountRight only field. The following set of information pulls through details for a contact custom field
    • LabelString (30)
    • This is an AccountRight only field. 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)
    • This is an AccountRight only field. Custom field text entry populated for CustomField1.
  • CustomField2
  • This is an AccountRight only field. The following set of information pulls through details for a contact custom field
    • LabelString (30)
    • This is an AccountRight only field. Name of CustomField2 applicable to the custom field text, labels can be edited, for example CustomField # 2 could be changed to Queensland
    • ValueString (30)
    • This is an AccountRight only field. Custom field text entry populated for CustomField2.
  • CustomField3
  • This is an AccountRight only field. The following set of information pulls through details for a contact custom field
    • LabelString (30)
    • This is an AccountRight only field. 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)
    • This is an AccountRight only field. Custom field text entry populated for CustomField3.
  • CurrentBalanceDecimal (13.6)
  • Customer contact balance.
  • SellingDetails
  • The following set of information pulls through default customer selling details.
    • SaleLayoutSaleLayoutType
    • Sale Type of the record containing the full default Sale Layout definition:
      NoDefault
      Service
      Item
      Professional
      TimeBilling
      Miscellaneous
    • PrintedFormString (255)
    • Named form selected as default printed form.
    • InvoiceDeliveryString (255)
    • Default invoice delivery status assigned.
    • ItemPriceLevelString
    • Item price level, can consist of the following:
      Level A
      Level B
      Level C
      Level D
      Level E
      Level F
    • IncomeAccount
    • The following set of information pulls through details for an income account.
      • UIDGuid (36)
      • Foreign Key: Unique identifier for the income account in the form of a guid.
      • NameString (30)
      • Name of the income account
      • DisplayIDString (6)
      • Income account code format includes separator ie 4-1100
      • URIString
      • Uniform resource identifier associated with the income account object.
    • ReceiptMemoString (255)
    • Default receipt memo.
    • SalesPerson
    • The following set of information pulls through details for the an employee contact.
      • UIDGuid (36)
      • Foreign Key: Unique employee contact identifier in the form of a guid.
      • NameString (30)
      • Selected employee contact name.
      • DisplayIDString (15)
      • Employee contact Card ID, can also be used as a unique employee contact identifier.
      • URIString
      • Uniform resource identifier associated with the employee contact object.
    • SaleCommentString (255)
    • Default selected sale comment.
    • ShippingMethodString (255)
    • Shipping method text.
    • HourlyBillingRateDecimal (10.6)
    • The customers hourly billing rate.
    • ABNString (14)
    • ONLY APPLICABLE FOR AU REGION.
      ABN Number (Must be 11 digits and formatted as XX XXX XXX XXX). { 'ABN': '45 676 343 223' }
    • ABNBranchString (11)
    • ONLY APPLICABLE FOR AU REGION.
      ABN branch number.
    • TaxCode
    • The following set of information pulls through the details for the TaxCodes
      • UID GUID (36)
      • Foreign Key: Unique tax code identifier in the form of a guid
      • Code String (3)
      • 3 digit code assigned to the tax code.
      • URI String
      • Uniform resource identifier associated with the Tax code object
    • FreightTaxCode
    • The following set of information pulls through the details for freight Tax Codes
      • UID GUID (36)
      • Foreign Key: Unique freight tax code identifier in the form of a guid
      • Code String (3)
      • 3 digit code assigned to the freight tax code.
      • URI String
      • Uniform resource identifier associated with the freight tax code object.
    • UseCustomerTaxCodeBoolean
    • True indicates to use the customer tax code.
      False indicates do not use the customer tax code.
    • Terms
    • The following set of information pulls through customer terms.
      • PaymentIsDueString
      • Default Terms of Payment definitions:
        CashOnDelivery
        PrePaid
        InAGivenNumberOfDays
        OnADayOfTheMonth
        NumberOfDaysAfterEOM
        DayOfMonthAfterEOM
      • DiscountDate Integer
      • If PaymentIsDue = CashOnDelivery, PrePaid, InAGivenNumberOfDaysNumber or NumberOfDaysAfterEOM then set the number of days within which the customer must pay to receive discounts.

        If PaymentIsDue = OnADayOfTheMonth or DayOfMonthAfterEOM then set the day of the month within which the payment must be made to receive discounts.
      • BalanceDueDate Integer
      • If PaymentIsDue = CashOnDelivery, PrePaid, InAGivenNumberOfDaysNumber or NumberOfDaysAfterEOM then set the number of days within which the customer has to pay invoices.

        If PaymentIsDue = OnADayOfTheMonth or DayOfMonthAfterEOM then set the day of the month within which the payment must be made to pay invoices.
      • DiscountForEarlyPayment Double (99.99%)
      • % discount for early payment.
      • MonthlyChargeForLatePayment Double (99.99%)
      • % monthly charge for late payment.
      • VolumeDiscount Double (99.99%)
      • Volume supplier discount.
    • Credit
    • The following set of information pulls through customer credit information.
      • Limit Decimal (13.6)
      • Customer credit limit.
      • Available Decimal (13.6)
      • Customers credit available.
      • PastDue Decimal (13.6)
      • Customers past due balance.
      • OnHoldBoolean
      • True indicates the customer record is on credit hold.
        False indicates the customer record is not on credit hold.
    • TaxIdNumber String (19)
    • Tax id number.
    • Memo String (255)
    • Default memo text.
  • PaymentDetails
  • The following set of information pulls through customer payment details.
    • Method PaymentMethod
    • Payment methods must exist in company file, default methods consist of the following: (Users can add new methods through AccountRight UI)

      American Express
      Bank Card
      Barter Card
      Cash
      Cheque
      Diners Club
      EFTPOS
      MasterCard
      Money Order
      Other
      Visa
    • CardNumber String (4)
    • Last 4 digits only.
    • NameOnCard String (50)
    • Default name on card.
    • BSBNumber String (7)
    • ONLY APPLICABLE FOR AU REGION.
      Default bank account bsb number.
    • BankAccountNumberString (9)
    • Default bank account number.
    • BankAccountName String (32)
    • Default bank account name.
    • Notes String (255)
    • Default payment notes.
  • ForeignCurrency
  • This is an AccountRight only field.Null if no foreign currency is set.
    • UIDGuid (36)
    • This is an AccountRight only field. Foreign Key: Unique identifier for the currency in the form of a guid.
    • CodeString (3)
    • This is an AccountRight only field. The currency code.
    • CurrencyNameString
    • This is an AccountRight only field. The full name of the currency
    • URIString
    • This is an AccountRight only field. Uniform resource identifier associated with the currency object.
  • LastModifiedDateTime
  • Extracts the last modification date for the customer 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" : "2b74006d-a599-42dd-b228-52596f49333c",
    • "LastName" : "Davis",
    • "FirstName" : "Chris",
    • "IsIndividual" : true,
    • "DisplayID" : "CUS000001",
    • "IsActive" : true,
    • "Addresses" : [
      • {
        • "Location" : 1,
        • "Street" : "5/76 Readen Road",
        • "City" : "St Kilda",
        • "State" : "VIC",
        • "PostCode" : "3024",
        • "Country" : "Australia",
        • "Phone1" : "03 9567 3453",
        • "Phone2" : "03 9533 2256",
        • "Phone3" : "03 9534 2345",
        • "Fax" : "03 8934 4543",
        • "Website" : "www.myob.com.au",
        • "ContactName" : "Simon",
        • "Salutation" : "Hello"
        • }
      • ],
    • "Notes" : "API notes",
    • "Identifiers" : [
      • {
        • "Label" : "AZZ",
        • "Value" : "B"
        • }
      • ],
    • "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" : "Perth"
      • },
    • "CurrentBalance" : 1000.00,
    • "SellingDetails" : {
      • "SaleLayout" : "NoDefault",
      • "PrintedForm" : "Pre-Printed Invoice",
      • "InvoiceDelivery" : "Print",
      • "ItemPriceLevel" : "Level A",
      • "IncomeAccount" : null,
      • "ReceiptMemo" : "Thank you",
      • "SalesPerson" : null,
      • "SaleComment" : "We appreciate your business.",
      • "ShippingMethod" : "Freight",
      • "HourlyBillingRate" : 0,
      • "ABN" : "45 676 343 223",
      • "ABNBranch" : "014",
      • "TaxCode" : {
        • "UID" : "97e9b42d-56db-4e57-9033-4714221041f1",
        • "Code" : "GST",
        • "URI" : "{cf_uri}/GeneralLedger/TaxCode/97e9b42d-56db-4e57-9033-4714221041f1"
        • },
      • "FreightTaxCode" : {
        • "UID" : "97e9b42d-56db-4e57-9033-4714221041f1",
        • "Code" : "GST",
        • "URI" : "{cf_uri}/GeneralLedger/TaxCode/97e9b42d-56db-4e57-9033-4714221041f1"
        • },
      • "UseCustomerTaxCode" : true,
      • "Terms" : {
        • "PaymentIsDue" : "DayOfMonthAfterEOM",
        • "DiscountDate" : 1,
        • "BalanceDueDate" : 30,
        • "DiscountForEarlyPayment" : 0,
        • "MonthlyChargeForLatePayment" : 0,
        • "VolumeDiscount" : 0
        • },
      • "Credit" : {
        • "Limit" : 0,
        • "Available" : 0,
        • "PastDue" : 0,
        • "OnHold" : false
        • },
      • "TaxIdNumber" : null,
      • "Memo" : "MYOBapi Team"
      • },
    • "PaymentDetails" : null,
    • "ForeignCurrency" : null,
    • "LastModified" : "2014-03-19T05:04:32.993"
    • "PhotoURI" : "{cf_uri}/Contact/Customer/2b74006d-a599-42dd-b228-52596f49333c/Photo",
    • "URI" : "{cf_uri}/Contact/Customer/2b74006d-a599-42dd-b228-52596f49333c",
    • "RowVersion" : "-2085166627472539648"
    • }
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.