Table of Contents

Payroll Items Super

Supported Endpoints and Methods 

The endpoint can be found at: https://api.reckon.com/R1/{BOOKID}/payroll/superitems

Methods supported:   GET, PUT, POST

The Book ID represents the unique GUID of the Book the user wants to write data to. For example c1b3da90-e9df-4d57-8cfb-71a1d7bfe401  

 

Reckon One Payroll API is available to AU only. 

Endpoint

Additional Parameter(s)

HTTP Method

Description

API Portal

Countries

superitems

 

GET

Retrieve the list of Super items

 Portal

AU

superitems

/superitemid

PUT

Update a Super item

 Portal

AU

superitems

 

POST

Add a Super item

 Portal

AU

 

 

Get the list of Super Items

Endpoint:  https://api.reckon.com/R1/{bookId}/​payroll/superitems

Method: GET  

Sample response

 [
    {
        "PayItemId": "ac4c6fc1-2595-49da-8a73-c4ef20fa705c",
        "PayItemType": 6,
        "Name": "Salary Sacrifice",
        "Description": null,
        "PaySubType": 23,
        "DefaultRate": null,
        "IsPercentValue": false,
        "IsSR": false,
        "ExpenseAccountId": null,
        "ExpenseAccountName": null,
        "Status": 1,
        "Minimum": null,
        "Limit": null,
        "DeductGrossBeforeTax": false,
        "IncludedItemInCalc": [
            {
                "IncludedPayItemId": "3701952b-d790-4726-a693-c38a81868d28",
                "IncludedPayItemName": "Hourly"
            }
        ]
    },
    {
        "PayItemId": "51c85875-e967-46a1-b8a0-3156da9203f6",
        "PayItemType": 6,
        "Name": "Super AMP",
        "Description": null,
        "PaySubType": 19,
        "DefaultRate": 9.5,
        "IsPercentValue": true,
        "IsSR": true,
        "ExpenseAccountId": "075147df-c99c-4704-ba0a-7091493bb493",
        "ExpenseAccountName": "Superannuation",
        "Status": 1,
        "Minimum": 100.0,
        "Limit": null,
        "DeductGrossBeforeTax": false,
        "IncludedItemInCalc": [
            {
                "IncludedPayItemId": "751bf00d-7db4-4380-a45a-1fb1f8dc2a04",
                "IncludedPayItemName": "Personal"
            },
            {
                "IncludedPayItemId": "3701952b-d790-4726-a693-c38a81868d28",
                "IncludedPayItemName": "Hourly"
            },
            {
                "IncludedPayItemId": "67ed15f4-4f0f-44dc-ad4f-de43862feecb",
                "IncludedPayItemName": "Annual"
            }
        ]
    }
]

Details of each object 

Data Field

Description

Data Type

Mandatory?

PayItemID

The unique ID of the item

GUID

No

PayItemType

The Type of Payroll Item

Set data types:

6 - Super

Yes

PayItemName

The name of the payroll item in text

Text

Yes

PaySubType

The subtype of the payrolli tem

Set data types: 

  • 19 - Super Guarantee
  • 20 - Employer Additional
  • 21 - Productivity
  • 22 - Collective Agreement
  • 23 - Salary Sacrifice
  • 24 - Member Voluntary
  • 25 - Spouse Deduction

Yes

DefaultRate

The default rate for the item

Numeric

No

IsPercentValue

Whether the default rate is a percentage value

Boolean true/false

No

ExpenseAccountID

The GUID of the expense account linked to the item

GUID

No (If ExpenseAccountName is included text to guid will be used)

ExpenseAccountName

The name of the expense account in text

text

Yes (unless ExpenseAccount is used with a GUID)

Minimum

The minimum set for the payroll item

Numeric

No

Limit

The limit set for the item

Numeric

No

DeductGrossBeforeTax

Whether the item is deducted from gross before tax calculations occur

Boolean true/false

No

ItemIncludedInCalc Array

This array contains the individual payroll items which are included in a super calculation such as super guarantee act

Array

No

IncludedPayItemId

The GUID of a pay item which is being included in the super calculations

GUID

No

IncludedPayItemName

The name in text of a pay item which is being included in super calculations

Text

No

 

Creating a Super Item

Minimum payload

Endpoint:  https://api.reckon.com/R1/{BOOKID}/​payroll/superitems

Method: POST

Sample Payload

  {
    "PaySubType": "19",
    "Name": "Super",
    "Description": "My Super",
    "IsSR": true,
    "DeductGrossBeforeTax": false,
    "IncludedItemInCalc": [
      {
        "IncludedPayItemId": "0218c4ab-299a-4f69-960e-4a403b2f6fb9"
  
      }
    ]
  }

Updating a Super Item

Minimum payload

Endpoint:  https://api.reckon.com/R1/{bookId}/​payroll/superitems

Method: PUT

Sample Payload

  {
    "PaySubType": "19",
    "Name": "Super",
    "Description": "My Super",
    "IsSR": true,
    "DeductGrossBeforeTax": false,
    "IncludedItemInCalc": [
      {
        "IncludedPayItemId": "0218c4ab-299a-4f69-960e-4a403b2f6fb9"
  
      }
    ]
  }

How did we do?

Payroll Items

Leave Items

Related Articles

Unable to select previous Tax years in the Payment summaries window
Payroll Items
Creating a custom super item in Reckon Payroll Web
Powered by HelpDocs (opens in a new tab)

Powered by HelpDocs (opens in a new tab)