MYOB Endpoint: PayrollCategorySummaryReport: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
== Overview == | == Overview == | ||
The MYOB '''PayrollCategorySummaryReport''' [[Endpoints|endpoint]] provides total values by [[MYOB Field: PayrollCategories|payroll categories]] between a start date and an end date. | The MYOB '''PayrollCategorySummaryReport''' [[MYOB Endpoints|endpoint]] provides total values by [[MYOB Field: PayrollCategories|payroll categories]] between a start date and an end date. | ||
It is a [[Function Endpoints|function]] that accepts a series of parameters. | It is a [[Function Endpoints|function]] that accepts a series of parameters. | ||
| Line 31: | Line 31: | ||
The following fields are available for the PayrollCategorySummaryReport endpoint. | The following fields are available for the PayrollCategorySummaryReport endpoint. | ||
;DataFile | |||
:A [[Field Type: Record|record field]] that provides the [[Field: DataFile|DataFile]] associated with the data. | |||
;StartDate | ;StartDate | ||
| Line 80: | Line 83: | ||
:None | :None | ||
== Related Topics == | |||
:[[MYOB Models]] | |||
:[[MYOB Endpoints]] | |||
Latest revision as of 18:13, 2 April 2025
Overview
The MYOB PayrollCategorySummaryReport endpoint provides total values by payroll categories between a start date and an end date.
It is a function that accepts a series of parameters.
Parameters
The PayrollCategorySummaryReport endpoint is a function that accepts the following parameters.
- StartDate
- A date field that determines the start date for which to produce values.
- If omitted, it will use the first date of the last calendar month.
- EndDate
- A date field that determines the end date for which to produce values.
- If omitted, it will use the last date of the last calendar month.
- ReportingBasis
- A text field that determines the way the values will be calculated.
- Possible values are:
- Accrual: Indicates values should be on an accrual basis (based on invoice dates).
- Cash: Indicates values should be on a cash basis (based on payment dates).
- YearEndAdjust
- A true/false field that determines if year end adjustment should be included or excluded.
Fields
The following fields are available for the PayrollCategorySummaryReport endpoint.
- DataFile
- A record field that provides the DataFile associated with the data.
- StartDate
- A date field that indicates the start date for which to produce values.
- This will match the StartDate entered as parameter.
- EndDate
- A date field that indicates the end date for which to produce values.
- This will match the EndDate entered as parameter.
- ReportingBasis
- A text field that indicates the way the values will be calculated.
- This will match the ReportingBasis entered as parameter.
- YearEndAdjust
- A true/false field that indicates if year end adjustment should be included or excluded.
- This will match the YearEndAdjust entered as parameter.
- PayrollCategoryBreakdown
- A table field that provides a list of all values by payroll categories.
- See PayrollCategoryBreakdown Fields for more information.
PayrollCategoryBreakdown Fields
The AccountsBreakdown field contains the following sub-fields.
- Amount
- A decimal field that provides the total amount for a given payroll category.
- Hours
- A decimal field that provides the total hours for a given payroll category.
- PayrollCategory
- A record field that identifies the payroll category associated.
MYOB API
For a detailed run through of the endpoint, you can see the MYOB API.
Related Fields
Related Endpoints
- None