PayrollCategory
Returns generic information on all payroll category types for Australian Files
Date Released: Mar 2014 Date Updated: Jan 2021
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 PayrollCategory. 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 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, Tax, Superannuation, Entitlement
- 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.
Paging: default page size is set to 400 with a maximum of 1000 results.
Example json GET response
- {
- "UID" : "b8cfe4cf-bb11-4013-a13d-0e4e1f3b3b41",
- "Name" : "Advance",
- "Type" : "Wage",
- "URI" : "{cf_uri}/PayrollCategory/Wage/b8cfe4cf-bb11-4013-a13d-0e4e1f3b3b41",
- "RowVersion" : "3694640544304070656"
- }
The {cf_uri} is provided by the businessId
parameter as described
here.