EmployeePaymentDetails

Return and update employee payment details on employee contacts for Australian Files.

Date Released: Aug 2014 Date Updated: Dec 2020
URLSupports
/{cf_uri}/Contact/EmployeePaymentDetails GET |  PUT |  POST |  DELETE
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 EmployeePaymentDetails. 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 employee payment details identifier in the form of a guid.
    Required Only: for updating an existing employee's payment details.
  • Employee
  • The following set of information pulls through details for the employee contact
    • UIDGuid (36)
    • Foreign Key: Unique guid identifier belonging to the employee contact.
    • NameString (30)
    • Name of the employee.
    • DisplayIDString (15)
    • Employee contact Card ID, can also be used as a unique employee contact identifier.
    • URIString
    • Uniform resource identifier associated with the employee object.
  • PaymentMethodString
  • Required Only: for updating an existing employee's payment details.
    Payment method can consist of the following Enum values:
    Cash
    Cheque
    Electronic* * AU only
  • BankStatementTextString (18)
  • Text to appear on employee's bank statement where PaymentMethod = Electronic
  • BankAccounts []
  • An array of employee bank account information where PaymentMethod = Electronic
    • BSBNumberString (6)
    • Required Only: for updating an existing employee's payment details where PaymentMethod = Electronic.

      Format looks like "123-456"
    • BankAccountNumberString (9)
    • Required Only: for updating an existing employee's payment details where PaymentMethod = Electronic.
    • BankAccountNameString (32)
    • Required Only: for updating an existing employee's payment details where PaymentMethod = Electronic.
    • ValueDouble
    • Required Only: for updating an existing employee's payment details where PaymentMethod = Electronic.
      Net pay amount to be transferred to employee's account using either Dollars (13.6) or Percent (0.00 - 100.00)
    • UnitString
    • Required Only: for updating an existing employee's payment details where PaymentMethod = Electronic.
      Untis can consist of the following Enum values:

      Percent
      Dollars
      RemainingAmount (read-only for the last account in the collection)
  • 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 employee's payment details.


Paging: default page size is set to 400 with a maximum of 1000 results.

Example json GET response

  • {
  • "UID" : "0c55818c-855a-452e-be92-d8a1595fc5e9",
  • "Employee" : {
    • "UID" : "22985a06-eeaa-4634-89ef-ee4ff314f406",
    • "Name" : "Alan Long",
    • "DisplayID" : "EMP00002",
    • "URI" : "{cf_uri}/Contact/Employee/22985a06-eeaa-4634-89ef-ee4ff314f406"
    • },
  • "PaymentMethod" : "Electronic",
  • "BankStatementText" : "Alan Long; Clearwtr",
  • "BankAccounts" : [
    • {
      • "BSBNumber" : "341-241",
      • "BankAccountNumber" : "123412341",
      • "BankAccountName" : "Mr A Long",
      • "Value" : 100,
      • "Unit" : "Percent"
      • }
    • ],
  • "URI" : "{cf_uri}/Contact/EmployeePaymentDetails/0c55818c-855a-452e-be92-d8a1595fc5e9",
  • "RowVersion" : "2350610157466419312"
  • }
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.