Table of Contents

Payroll Items

Supported Endpoints and Methods 

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

Methods supported:   GET, PUT, POST, DELETE

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

payrollitems

GET

Retrieve the list of payroll items

 Portal

AU

payrollitems

POST

Add a payroll item

Portal

AU

payrollitems

/payroll-item-id

PUT

Update a payroll item

Portal

AU

payrollitems

/payroll-item-id

DELETE

Delete a payroll item

Portal

 

Get the list of Payroll Items

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

Method: GET

Filter: If you want to filter the response by a specific payroll Item type, then add ?$filter= PayItemTypeId eq '{PayItemTypeId value, for example, 1 for Earnings}' at the end of the endpoint.

Sample response

 {
        "Id": "0218c4ab-299a-4f69-960e-4a403b2f6fb9",
        "PayItemTypeId": 1,
        "PayItemTypeName": "Earnings",
        "SubTypeId": 8,
        "SubTypeName": "OTE",
        "FullName": "Salary",
        "Description": null,
        "Multiplier": null,
        "PayRateBasis": 1,
        "TerminationType": null,
        "ExpenseAccountId": "85fb81f7-e755-43a7-8200-e7f0f5999e0b",
        "ExpenseAccountName": "Salaries & Wages",
        "LiabilityAccount": null,
        "LiabilityAccountName": null,
        "IncludeInTimeAccruals": false,
        "Status": 1,
        "TaxApplicableName": "Gross payments",
        "CalculationBasisType": null,
        "DefaultRate": null,
        "IsPercentValue": false,
        "LimitAmount": null,
        "LimitType": null,
        "ShowAsAllowancePS": null,
        "PayeeId": null,
        "Payee": null,
        "IsDeductedForTax": null
    },
    {
        "Id": "3701952b-d790-4726-a693-c38a81868d28",
        "PayItemTypeId": 1,
        "PayItemTypeName": "Earnings",
        "SubTypeId": 8,
        "SubTypeName": "OTE",
        "FullName": "Hourly",
        "Description": null,
        "Multiplier": null,
        "PayRateBasis": 2,
        "TerminationType": null,
        "ExpenseAccountId": "85fb81f7-e755-43a7-8200-e7f0f5999e0b",
        "ExpenseAccountName": "Salaries & Wages",
        "LiabilityAccount": null,
        "LiabilityAccountName": null,
        "IncludeInTimeAccruals": true,
        "Status": 1,
        "TaxApplicableName": "Gross payments",
        "CalculationBasisType": null,
        "DefaultRate": null,
        "IsPercentValue": false,
        "LimitAmount": null,
        "LimitType": null,
        "ShowAsAllowancePS": null,
        "PayeeId": null,
        "Payee": null,
        "IsDeductedForTax": null
    },
    {
        "Id": "5b9154e9-92f4-4cb9-8b81-7e2e642877b3",
        "PayItemTypeId": 1,
        "PayItemTypeName": "Earnings",
        "SubTypeId": 9,
        "SubTypeName": "Overtime",
        "FullName": "Time and Half",
        "Description": null,
        "Multiplier": 1.50000000,
        "PayRateBasis": 2,
        "TerminationType": null,
        "ExpenseAccountId": "85fb81f7-e755-43a7-8200-e7f0f5999e0b",
        "ExpenseAccountName": "Salaries & Wages",
        "LiabilityAccount": null,
        "LiabilityAccountName": null,
        "IncludeInTimeAccruals": true,
        "Status": 1,
        "TaxApplicableName": "Gross payments",
        "CalculationBasisType": null,
        "DefaultRate": null,
        "IsPercentValue": false,
        "LimitAmount": null,
        "LimitType": null,
        "ShowAsAllowancePS": null,
        "PayeeId": null,
        "Payee": null,
        "IsDeductedForTax": null
    },
    {
        "Id": "cd5435d4-f2da-490b-a2fb-179a006ab883",
        "PayItemTypeId": 1,
        "PayItemTypeName": "Earnings",
        "SubTypeId": 9,
        "SubTypeName": "Overtime",
        "FullName": "Double Time",
        "Description": null,
        "Multiplier": 2.00000000,
        "PayRateBasis": 2,
        "TerminationType": null,
        "ExpenseAccountId": "85fb81f7-e755-43a7-8200-e7f0f5999e0b",
        "ExpenseAccountName": "Salaries & Wages",
        "LiabilityAccount": null,
        "LiabilityAccountName": null,
        "IncludeInTimeAccruals": true,
        "Status": 1,
        "TaxApplicableName": "Gross payments",
        "CalculationBasisType": null,
        "DefaultRate": null,
        "IsPercentValue": false,
        "LimitAmount": null,
        "LimitType": null,
        "ShowAsAllowancePS": null,
        "PayeeId": null,
        "Payee": null,
        "IsDeductedForTax": null
    }
]

Details of each object 

Data Field

Description

Data Type

Mandatory?

ID

The unique ID of the item

GUID

No

PayItemType

The Type of Payroll Item

Set data types:

  • 1 - Earnings
  • 3 - Allowance
  • 4 - Deduction
  • 5 -  Reimbursement 

Yes

PayItemTypeName

The text name of the payroll item type

Text

No

SubTypeId

The subtype of the payroll item

Set data types:

For PayItemType '1' (Earnings):

  • 9 - Overtime (Earnings)
  • 10 - Variable (Earnings)
  • 11 - Termination (Earnings)

For PayItemType '4' (Deductions):

  • 16 - Other (Deductions)
  • 17 - Union Fees (Deductions)
  • 18 - Workplace Giving (Deductions)

For PayItemType '3' (Allowance):

  • 26 - Other
  • 27 - Meals
  • 28 - Transport
  • 29 - Car
  • 30 - Travel
  • 31 - Laundry

Yes

SubTypeName

The text name of the subtype

Text

No

FullName

Text name of the item

Text

Yes

Description

The description for the item

Text

No

Multiplier

The multiplier applied to the item

Numeric

Yes if item is Overtime based item

PayRateBasis

The PayRate basis of the item

Set data types:

  • 1- Hourly
  • 2- Salary

Yes if item is Earnings or Overtime

TerminationTypeId

The type of termination linked to termination items

Set data types (GUID across all books):

  • 12752E20-4D3D-4A92-906E-1DC6CF48C1A6 for "Payment on death of an employee"
  • 4C6D52ED-A06D-42CA-8CD6-397AB5EAB43D for "All other termination payments"
  • B4C3CB5E-3F80-4A60-8E5B-4F4715FC75FB for "Invalidity"
  • 087B68E5-B059-4459-A2A6-A12BA0EB442D for "Genuine redundancy"
  • 1E04CC05-FC17-43E9-8173-BB4F38D30321 for "Compensation for unfair dismissal"
  • 757A523D-0DB4-425D-BD78-BFD7D5652F73 for "Annual leave not accumulated in the system"
  • 862C7DE5-C182-47FD-A729-EA0E04CBD59E for "Long service leave not accumulated in the system"

Yes if item is Termination type

ExpenseAccountId

The expense account linked to the item

GUID

No (unless ExpenseAccount name is not used and you choose to send the GUID instead)

ExpenseAccountName

The name of the expense account linked to the item

Text

Yes if ExpenseAccount is not included (This is used instead of the GUID when using the Text to GUID feature of the API)

LiabilityAccountId

The liability account linked to the item

GUID

No (default account will be used if you don't pass it)

LiabilityAccountName

The liability account name in text linked to the item

Text

No

IncludeInTimeAccruals

Whether the item is included in time accural calculations

Boolean true/false

No

Status

Whether the item is active or not

Set data types:

  • 1- Active
  • 2 - Inactive

No

TaxApplicableName

The name of the tax applicable to the item

Set data types:

  • "Tax free"
  • "Gross payments"
  • "Additional payment method A"
  • "Additional payment method B(i)"
  • "Additional payment method B(ii)"
  • "Return to work"

 

Yes

CalculationBasisType

The type of the calculation basis type 

Set data types:

  • 1 - Quantity
  • 2 - Hourly
  • 3 - Other

Yes if allowance item type

DefaultRate

The default rate to be applied to the item

Numeric

No

IsPercentValue

If the default value is percent or dollar

Boolean (true/false)

No, only required if have passed DefaultRate

LimitAmount

The limit to be applied to the item

Numeric

No

LimitType

If a limit exists, the type of the limit

Set data types:

  • 1 - Per pay
  • 2 - Per annum

No

ShowAsAllowanceOnPS

Whether a allowance item will display on the payment summary as a allowance

Boolean true false

No

PayeeID

The GUID of a payee linked to the payroll item

GUID

No

Payee

The text name of a payee linked to the payroll item

Text

No

 

Minimum Post 

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

Method: POST/PUT

Create an Earnings (Normal)

{
       "PayItemType": "1",
       "SubTypeId": "8", //see the above table for the options
       "Name": "Earnings",
       "PayRateBasis": "2",
       "TaxApplicableName": "Gross Payments"
}

Create an Earnings (Overtime)

{
       "PayItemType": "1",
       "SubTypeId": "9", //see the above table for the options
       "Name": "Overtime",,
       "RateMultiplier":"1.75",
       "PayRateBasis": "2",
       "TaxApplicableName": "Gross Payments"
}

Create an Earnings (Variable)

{
       "PayItemType": "1",
       "SubTypeId": "10", //see the above table for the options
       "Name": "Earnings",
       "PayRateBasis": "2",
       "TaxApplicableName": "Gross Payments"
}

 

Create an Earnings (Termination)

{
       "PayItemType": "1",
       "SubTypeId": "11", //see the above table for the options
       "Name": "Termination",
       "PayRateBasis": "4",
       "TaxApplicableName": "Termination",
       "TerminationTypeId": "087B68E5-B059-4459-A2A6-A12BA0EB442D" //see the above table for the options
   }

Create an Allowance

{
       "PayItemType": "3",
       "Name": "Car Allowance Car",
       "SubTypeId": "29", //see the above table for the options
       "CalculationBasisType": "1",
       "DefaultRate": "30",
       "IsPercentValue": false,
       "TaxApplicableName": "Gross Payments"
   }

Create a Deduction

{
       "PayItemType": "4",
       "SubTypeId": "17", //see the above table for the options
       "Name": "Deduction Union",
       "LiabilityAccountId": "54f1be48-526a-4fc7-8e0f-5051450fc527",
       "CalculationBasisType": "3",
       "IsDeductedForTax" : "false",
       "DefaultRate": "30",
       "IsPercentValue": false
}

 

Create a Reimbursement

{
       "PayItemType": "5",
       "Name": "Reimbursement"
}

Delete a Payroll Item

Endpoint:  https://api.reckon.com/R1/{BOOKID}/​payroll/payrollitems/{payroll-item-id}

Method: DELETE

How did we do?

Employees API v1

Payroll Items Super

Related Articles

Unrecoverable error when processing or editing a pay
No PAYE tax amount is being calculated.
RDP calculations consistently higher than required
Powered by HelpDocs (opens in a new tab)

Powered by HelpDocs (opens in a new tab)