EmployeeStandardPay

Attribute Details

• UIDGuid (36)
• Unique employee payroll details/standard pay identifier in the form of a guid.
  Required: for updating an existing employee's standard pay 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.
• EmployeePayrollDetails
• The following set of information pulls through details for the employee payroll details
• • UIDGuid (36)
  • Foreign Key: Unique guid identifier belonging to the employee payroll details.
    Please note: the UID GUID value is the same as the Standard Pay identifier
  • URIString
  • Uniform resource identifier associated with the employee payroll details object.
• PayFrequencyString
• Pay frequency can consist of the following:
  Weekly
  Fortnightly
  TwiceAMonth
  Monthly
• HoursPerPayFrequencyDecimal (13.3)
• Hours worked in a pay period.
• Category
• The following outlines category information
• • UID GUID (36)
  • Foreign Key: Unique guid identifier belonging to the category assigned.
  • Name String (30)
  • Name of the category
  • DisplayID String (10)
  • Display id for the category
  • URI String
  • Uniform resource identifier associated with the category object
• MemoString (255)
• Default memo text to appear on employee's pays.
• PayrollCategories []
• All payroll categories linked to the employee contact, includes all payroll categories of type Wage
• • PayrollCategory
  • The following set of information pulls through details for the payroll category.
  • • UIDGuid (36)
    • Unique payroll category identifier in the form of a guid.
    • NameString (31)
    • Name of the payroll category.
    • TypeString
    • Indicates the type of payroll category ie: Wage, Expense, Deduction, Entitlement.
    • URIString
    • Uniform resource identifier associated with the payroll category object.
  • HoursDecimal (13.2)
  • Hours for payroll categories that are not automatically calculated, if IsCalculated = true then a null value is returned.
    PUT(update) will allow you to update the hours.
  • AmountDecimal (13.2)
  • Amounts for payroll categories that are not automatically calculated, if IsCalculated = true then a null value is returned.
    PUT(update) will allow you to update the amount.
  • IsCalculatedBoolean
  • Determined by the setup of Payroll category resource.
  • Job
  • The following set of information pulls through the details for a job
  • • UID GUID (36)
    • Foreign Key: Unique guid identifier belonging to the job to which the payroll category amounts are allocated.
    • Number String (15)
    • Number assigned to the job
    • Name String (30)
    • Name assigned to the job
    • URI String
    • Uniform resource identifier associated with the job object
• 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 standard pay details.

For more information, check out our Knowledge base article "Employee Standard Pay Endpoint".

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