PayrollCategorySummary
Returns a Payroll Category Summary report
Date Released: Nov 2018 Date Updated: Jan 2021
| URL | Supports |
| /{cf_uri}/Report/PayrollCategorySummary
|
GET |
PUT |
POST |
DELETE
|
The following query is required for the above URL:
?StartDate={start_date}&EndDate={end_date}&ReportingBasis={reporting_basis}&YearEndAdjust={year_end_adjust}
The {start_date} is the date that you would like to start at.The {end_date} is the date of the end of the period.The {reporting_basis} will either be Cash or Accural.The {year_end_adjust} stats if you are includeding Year end Adjustments. This is a true or False value. |
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 PayrollCategorySummary. 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
- StartDateDateTime
- Starting date of the period, format YYYY-MM-DD HH:MM:SS { 'StartDate': '2018-07-01 00:00:00' }
- EndDateDateTime
- Ending date of the period, format YYYY-MM-DD HH:MM:SS { 'EndDate': '2018-09-30 00:00:00' }
- PayrollCategoryBreakdown []
- An array of Payroll Category information
- AmountDecimal (13.2)
- Total amount for the Payroll Category for that date range.
- HoursDecimal (13.2)
- Total Hours for the Payroll Category for that date range.
- Payroll Category
- The following set of information pulls through details for the Payroll Category
- UIDGuid (36)
- Foreign Key: Unique guid identifier belonging to the Payroll Category
- NameString (50)
- Name of the Payroll Category.
- TypeString (15)
- Payroll Category Type.
- URIString
- Uniform resource identifier associated with the Payroll Category object.
- URIString
- Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
Paging: default page size is set to 400 with a maximum of 1000 results.
Example json GET response
- {
- "StartDate" : "2018-07-01T00:00:00",
- "EndDate" : "2018-09-30T23:59:59",
- PayrollCategoryBreakdown" : [
- {
- "Amount" : 18653.86,
- "Hours" : 0,
- "PayrollCategory" : {
- "UID" : "fa19205d-bf4c-415a-8458-043c072bf1df",
- "Name" : "Base Salary",
- "Type" : "Wage",
- "URI" : "{cf_uri}/Payroll/PayrollCategory/fa19205d-bf4c-415a-8458-043c072bf1df"
- }
- },
{ "Amount" : 0, "Hours" : 11.39, "PayrollCategory" : {
- "UID" : "a0156740-0d9a-4c0e-b954-2b76abce0412",
- "Name" : "Sick Leave Accrual",
- "Type" : "Entitlement",
- "URI" : "{cf_uri}/Payroll/PayrollCategory/a0156740-0d9a-4c0e-b954-2b76abce0412"
- }
} ],"URI" : "{cf_uri}/Report/PayrollCategorySummary?StartDate=2018-07-01&EndDate=2018-09-30&ReportingBasis=Cash&YearEndAdjust=true"}
