EmployeePayrollAdvice

Attribute Details

• Employer
• The following set of information pulls through details for the employer
• • CompanyNameString (40)
  • Company name as entered within the Company Information window or Company endpoint.
  • ABNOrTFNString (14)
  • ABN or TFN as entered within the Company Information window or Company endpoint.
  • URIString
  • Uniform resource identifier associated with the company file.
• 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.
• PayPeriodStartDateDateTime
• Starting date of the pay period, format YYYY-MM-DD HH:MM:SS { 'PayPeriodStartDate': '2014-06-21 00:00:00' }
• PayPeriodEndDateDateTime
• Finishing date of the pay period,, format YYYY-MM-DD HH:MM:SS { 'PayPeriodEndDate': '2014-06-28 00:00:00' }
• PaymentDateDateTime
• Date when the paycheque was processed and paid, format YYYY-MM-DD HH:MM:SS { 'PaymentDate': '2014-06-28 00:00:00' }
• PayFrequencyString
• Pay frequency can consist of the following:
  Weekly
  Fortnightly
  TwiceAMonth
  Monthly
• AnnualSalaryDecimal (13.3)
• Annual salary amount for the employee (at the time of the API call).
• GrossPayDecimal (13.6)
• Gross Wages for pay period (total amount of money before deductions) for the employee.
• NetPayDecimal (13.6)
• Net Wages for pay period (total amount of money after deductions) for the employee.
• HourlyRateDecimal (13.4)
• Employee's hourly rate.
• ChequeNumberString (8)
• Cheque number or reference type.
• DateOfBirthDateTime
• Employees date of birth, format YYYY-MM-DD HH:MM:SS { 'DateOfBirth': '1978-06-28 00:00:00' }
• SuperannuationFund
• The following set of information pulls through details for the superannuation fund
• • UIDGuid (36)
  • Foreign Key: Unique guid identifier belonging to the superannuation fund.
  • NameString (76)
  • Name of the superannuation fund.
  • URIString
  • Uniform resource identifier associated with the superannuation fund.
• EmploymentClassification
• The following set of information pulls through details for the employment classification
• • UIDGuid (36)
  • Foreign Key: Unique guid identifier belonging to the employment classification.
  • NameString (255)
  • Name of the employment classification.
  • URIString
  • Uniform resource identifier associated with the employment classification.
• Lines []
• An array of pay advice line information
• • PayrollCategory
  • The following set of information pulls through details for the payroll category
  • • UIDGuid (36)
    • Foreign Key: Unique payroll category identifier in the form of a guid.
    • NameString (31)
    • Name of the payroll category.
    • TypeString
    • Indicates the type of payroll category i.e. Wage, Deduction, Expense, Tax.
    • URI String
    • Uniform resource identifier associated with the payroll category object.
  • HoursInteger
  • Number of hours paid on hourly payroll category or accrued for entitlements
    Note: If payroll category is of type salary then null is returned.
  • CalculationRateDecimal (13.6)
  • The rate an hourly wage category is calculated,
    Note: If wage is of type salary then null is returned.
  • AmountDecimal (13.6)
  • Amount processed for payroll category i.e. $ amounts for Wages, Superannuation, Deductions and Hours for entitlements.
  • YearToDateDecimal (13.2)
  • YTD amounts accrued this payroll year based upon pays recorded.

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