Payruns

Supported Endpoints and Methods

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

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
payruns		GET	Retrieve the list of Payruns	Portal	AU
payruns	/payrunId	GET	Retrieve the details of a Payrun by Id	Portal	AU
payruns		POST	Create a Pay run	Portal	AU
payruns	/payrunId	PUT	Update a Pay run	Portal: Earnings Allowance Deduction	AU
payruns	/payrunId	DELETE	Delete a Pay run	Portal: Pay run by Id Earnings Allowance Deduction

Get the list of Pay runs

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

Method: GET

Sample response

 [
   {
        "Id": "f2844872-b2aa-4e7d-986c-e3b0750c367e",
        "PayRunName": "Unscheduled 31/03/2020",
        "PayRunType": 2,
        "PaymentDate": "2020-03-31T00:00:00",
        "PayEndingDate": "2020-03-31T00:00:00",
        "PayStartingDate": "2020-03-25T00:00:00",
        "Status": 4,
        "Total": 500.0000,
        "JournalID": "6f5c54e1-1fb1-430e-acd4-f4742c9a0224"
    },
    {
        "Id": "f8a98557-0750-4247-9f7c-e9a4628edab7",
        "PayRunName": "Unscheduled 22/05/2018",
        "PayRunType": 2,
        "PaymentDate": "2018-05-22T00:00:00",
        "PayEndingDate": "2018-05-18T00:00:00",
        "PayStartingDate": "2018-05-05T00:00:00",
        "Status": 8,
        "Total": 1153.8500,
        "JournalID": "18c675d6-7995-4b0e-b1cd-6141119ae653"
    }
]

Details of each object

Data Field	Description	Data Type
Id	The unique Id of the pay run	GUID
PayRunName	The name of the pay run	Text
PaymentDate	The Payment date of the pay run	Date/Time
PayEndingDate	The pay ending date of the pay run	Date/Time
Status	The status of the pay run	Set data types: 1 - Draft 4 - Posted 5 - Processing 8 - Paid
Total	The total amount paid in the pay run	Numeric
JournalID	The journal id linked to the pay run	GUID

Get details of a Pay run

Endpoint: https://api.reckon.com/R1/{BOOKID}/payroll/payruns/{payrun-id}

Method: GET

Sample response

{
    "CashbookId": "{book-id}",
    "PayRunName": "Pay run 16/07/2020",
    "PayRunTypeId": 2,
    "PayRunId": "5cb526de-4a13-4821-8cf4-6adf9fffe53e",
    "PayDate": "2020-07-08T00:00:00",
    "PayEndingDate": "2020-07-07T00:00:00",
    "PayrunStatus": 8,
    "Total": 933.85,
    "EmployeeData": [
        {
            "EmployeeId": "61ab8cef-0009-4d41-85b6-dff6d932371e",
            "EmployeeName": "Ifti C",
            "PayFrequencyId": 1,
            "PayStartDate": "2020-07-01T00:00:00",
            "PayEndDate": "2020-07-07T00:00:00",
            "EarningsAndLeaveTotal": 1153.85,
            "AllowancesAndReimbursementsTotal": 30.0,
            "DeductionsAndOtherSuperTotal": 250.0,
            "CompanyTotal": 0.0,
            "TaxTotal": 218.0,
            "NetTotal": 715.85,
            "GrossTotal": 1183.85,
            "Status": 8,
            "PayDetailEarningsLeave": [
                {
                    "DateFrom": null,
                    "DateTo": null,
                    "IsCashOut": false,
                    "Project": null,
                    "Customer": null,
                    "LumpSumTaxOverrideAmount": 0.0,
                    "BaseRate": 30.7692,
                    "Multiplier": 0.0,
                    "Id": "2b20b2ae-469b-4b63-a0cf-87c1e082f79c",
                    "PayItemId": "67ed15f4-4f0f-44dc-ad4f-de43862feecb",
                    "PayItem": "Annual",
                    "Quantity": 7.5,
                    "Rate": 30.7692,
                    "Amount": 230.77,
                    "YTDAmount": 230.77,
                    "PayItemTypeId": 2
                },
                {
                    "DateFrom": null,
                    "DateTo": null,
                    "IsCashOut": false,
                    "Project": null,
                    "Customer": null,
                    "LumpSumTaxOverrideAmount": null,
                    "BaseRate": 30.7692,
                    "Multiplier": 1.0,
                    "Id": "f3ce9b23-e427-4887-b7fa-e67aba5abb7f",
                    "PayItemId": "0218c4ab-299a-4f69-960e-4a403b2f6fb9",
                    "PayItem": "Salary",
                    "Quantity": 30.0,
                    "Rate": 30.7692,
                    "Amount": 923.08,
                    "YTDAmount": 923.08,
                    "PayItemTypeId": 1
                }
            ],
            "PayDetailAllowancesAndReimbursements": [
                {
                    "Tax": 0.0,
                    "Project": null,
                    "Customer": null,
                    "Id": "c89b2086-f704-487a-85cc-6595329ee54c",
                    "PayItemId": "57c27e5a-0ed4-43f1-a633-eacde45055fa",
                    "PayItem": "API Allowance Car",
                    "Quantity": 1.0,
                    "Rate": 30.0,
                    "Amount": 30.0,
                    "YTDAmount": 30.0,
                    "PayItemTypeId": 3
                }
            ],
            "PayDetailDeductionsAndSupers": [
                {
                    "Payee": null,
                    "SuperProduct": "AMP Flexible Lifetime Allocated Pension",
                    "IsPercentValue": false,
                    "Id": "bad3002a-55ca-4a09-9ca8-5d9ab780d2f9",
                    "PayItemId": "ac4c6fc1-2595-49da-8a73-c4ef20fa705c",
                    "PayItem": "Salary Sacrifice",
                    "Quantity": 0.0,
                    "Rate": 250.0,
                    "Amount": 250.0,
                    "YTDAmount": 250.0,
                    "PayItemTypeId": 6
                }
            ],
            "PayDetailCompanySummary": [
                {
                    "Payee": null,
                    "SuperProduct": "AMP Flexible Lifetime Allocated Pension",
                    "IsPercentValue": true,
                    "Id": "bb0bc404-dd2f-4019-8ea3-9654d7682da3",
                    "PayItemId": "51c85875-e967-46a1-b8a0-3156da9203f6",
                    "PayItem": "Super AMP",
                    "Quantity": 0.0,
                    "Rate": 9.5,
                    "Amount": 0.0,
                    "YTDAmount": 0.0,
                    "PayItemTypeId": 6
                }
            ],
            "PayDetailTax": {
                "NumberOfPayPeriods": 1.0,
                "GrossEarnings": {
                    "TaxableGrossEarnings": "1183.8500",
                    "Amount": 218.0,
                    "YTDAmount": 218.0,
                    "IsOverrideAmount": false
                },
                "LumpSums": {
                    "Summary": {
                        "AmountTotal": null,
                        "YTDAmount": null
                    },
                    "Details": null
                },
                "Terminations": {
                    "Summary": {
                        "AmountTotal": null,
                        "YTDAmount": null
                    },
                    "Details": null
                }
            }
        }
    ]
}

Details of each object

Data Field	Description	Data Type
CashbookId	The book's ID	GUID
PayRunName	Pay run's name	Text
PayRunTypeId	Scheduled or unscheduled Pay run	Types: Scheduled Unscheduled
PayRunId	Pay run's Id	GUID
PayDate	Pay run's Payment Date	Date/Time
PayEndingDate	Pay run's Pay Period end date	Date/Time
PayrunStatus	The status of the payrun - draft paid or posted	Set data types: 1 - Draft 4 - Posted 5 - Processing 8 - Paid
Total	The total amount paid in the pay run	Numeric
EmployeeData	Array containing Employees and their pay details	Array
EmployeeId	Employee's Id	GUID
EmployeeName	Employee's Name	Text
PayFrequencyId	The employee's pay frequency (weekly, fortnightly, monthly)	Set data types: Weekly Fortnightly Monthly
PayStartDate	The Pay run's Pay period start date	Date/Time
PayEndDate	The Pay run's Pay period end date	Date/Time
EarningsAndLeaveTotal	The total of the EARNINGS & LEAVE section	Numeric
AllowancesAndReimbursementsTotal	The total of the ALLOWANCES & REIMBURSEMENTS section	Numeric
DeductionsAndOtherSuperTotal	The total of the DEDUCTIONS & EMPLOYEE SUPER CONTRIBUTIONS section	Numeric
CompanyTotal	The total of the COMPANY SUMMARY section	Numeric
TaxTotal	The total Tax of the employee	Numeric
NetTotal	The total Net payment of the employee	Numeric
GrossTotal	The total Gross payment of the employee	Numeric
Status	The status of the pay	Set data types: 1 - Draft 4 - Posted 5 - Processing 8 - Paid
PayDetailEarningsLeave	Array containing details from the EARNINGS & LEAVE section	Array
DateFrom	Pay Item Iine's Date From	Date/Time
DateTo	Pay Item Iine's Date To	Date/Time
IsCashOut	Pay Item Iine's Cash Out	Boolean (true/false)
Project	Pay Item Iine's Project Name	Text
Customer	Pay Item Iine's Customer Name	Text
LumpSumTaxOverrideAmount	Pay Item line's Tax amount for an ETP payment	Numeric
BaseRate	Pay Item Iine's base rate (used for Wage type items)	Numeric
Multiplier	Pay Item Iine's multiplier. For example, Double Time payroll item's multiplier is 2.	Numeric
Id	Pay item line's ID.	GUID
PayItemId	Pay item line's Payroll Item Id. For example, GUID of the Salary payroll item.	GUID
PayItem	Pay item line's Payroll Item Name. For example, Salary.	Text
Quantity	Pay item line's Quantity	Numeric
Rate	Pay Item Iine's base rate (used for Super and relevant type items)	Numeric
Amount	Pay Item Iine's Amount	Numeric
YTDAmount	Pay Item Iine's YTD amount	Numeric
PayItemTypeId	Pay Item Iine's Payroll Item type	Set data types: Earnings = 1 Leave = 2 Allowance = 3 Deduction = 4 Reimbursement = 5 Super = 6 CompanyContribution = 7 OTE (Ordinary Time Earnings) = 8 OverTime = 9 Variable = 10 Termination = 11 Annual = 12 Personal = 13 LongService = 14 OtherLeave = 15 OtherDeduction = 16 UnionProfessionalAssociationFees = 17 WorkplaceGiving = 18
PayDetailAllowancesAndReimbursement	Array containing details from the EARNINGS & LEAVE section	Array
Tax	Pay Item Iine's Tax amount	Numeric
Project	Pay Item Iine's Project Name	Text
Customer	Pay Item Iine's Customer Name	Text
Id	Pay item line's ID.	GUID
PayItemId	Pay item line's Payroll Item Id. For example, GUID of the Allowance payroll item.	GUID
PayItem	Pay item line's Payroll Item Name. For example, Allowance.	Text
Quantity	Pay item line's Quantity	Numeric
Rate	Pay Item Iine's base rate (used for Super and relevant type items)	Numeric
Amount	Pay Item Iine's Amount	Numeric
YTDAmount	Pay Item Iine's YTD amount	Numeric
PayItemTypeId	Pay Item Iine's Payroll Item type	Set data types: Earnings = 1 Leave = 2 Allowance = 3 Deduction = 4 Reimbursement = 5 Super = 6 CompanyContribution = 7 OTE (Ordinary Time Earnings) = 8 OverTime = 9 Variable = 10 Termination = 11 Annual = 12 Personal = 13 LongService = 14 OtherLeave = 15 OtherDeduction = 16 UnionProfessionalAssociationFees = 17 WorkplaceGiving = 18
PayDetailDeductionsAndSupers	Array containing details from the DEDUCTIONS & EMPLOYEE SUPER CONTRIBUTIONS section	Array
Payee	Pay Item Iine's Payroll Item Payee	Text
SuperProduct	Pay Item Iine's Super item Name	Text
IsPercentValue	Pay Item Iine's value is percent or dollar	Boolean (true/false)
Id	Pay item line's ID.	GUID
PayItemId	Pay item line's Payroll Item Id. For example, GUID of the Super payroll item.	GUID
PayItem	Pay item line's Payroll Item Name. For example, Super.	Text
Quantity	Pay item line's Quantity	Numeric
Rate	Pay Item Iine's base rate (used for Super and relevant type items)	Numeric
Amount	Pay Item Iine's Amount	Numeric
YTDAmount	Pay Item Iine's YTD amount	Numeric
PayItemTypeId	Pay Item Iine's Payroll Item type	Set data types: Earnings = 1 Leave = 2 Allowance = 3 Deduction = 4 Reimbursement = 5 Super = 6 CompanyContribution = 7 OTE (Ordinary Time Earnings) = 8 OverTime = 9 Variable = 10 Termination = 11 Annual = 12 Personal = 13 LongService = 14 OtherLeave = 15 OtherDeduction = 16 UnionProfessionalAssociationFees = 17 WorkplaceGiving = 18
PayDetailCompanySummary	Array containing details from the COMPANY SUMMARY section	Array
Payee	Pay Item Iine's Payroll Item Payee	Text
SuperProduct	Pay Item Iine's Super item Name	Text
IsPercentValue	Pay Item Iine's value is percent or dollar	Boolean (true/false)
Id	Pay item line's ID.	GUID
PayItemId	Pay item line's Payroll Item Id. For example, GUID of the Company Contribution payroll item.	GUID
PayItem	Pay item line's Payroll Item Name. For example, Company Contribution.	Text
Quantity	Pay item line's Quantity	Numeric
Rate	Pay Item Iine's base rate (used for Super and relevant type items)	Numeric
Amount	Pay Item Iine's Amount	Numeric
YTDAmount	Pay Item Iine's YTD amount	Numeric
PayItemTypeId	Pay Item Iine's Payroll Item type	Set data types: Earnings = 1 Leave = 2 Allowance = 3 Deduction = 4 Reimbursement = 5 Super = 6 CompanyContribution = 7 OTE (Ordinary Time Earnings) = 8 OverTime = 9 Variable = 10 Termination = 11 Annual = 12 Personal = 13 LongService = 14 OtherLeave = 15 OtherDeduction = 16 UnionProfessionalAssociationFees = 17 WorkplaceGiving = 18
PayDetailTax	Array containing details from the TAX section	Array
NumberOfPayPeriods	Number of Pay periods of this Pay run	Number
GrossEarnings	Contains the details of the Gross Earnings of the Pay run	Number
TaxableGrossEarnings	Taxable Gross Earnings of the Pay run	Number
Amount	Total Tax Amount of the Pay run	Number
YTDAmount	YTD Tax Amount of the Pay run	Number
IsOverrideAmount	Whether the tax was manually overwritten	Boolean (true/false)
LumpSums	Lumpsum amount section
AmountTotal	Lumpsum amount of the Pay run	Number
YTDAmount	Lumpsum YTD amount	Number
Details	Lumpsum related information.	Text
Terminations	Termination payment details section
AmountTotal	Total Amount of the Termination Pay of the Pay run	Number
YTDAmount	YTD Amount of the Termination	Number
Details	Termination related information.	Text

Creating a Pay run

Minimum Payload

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

Method: POST

In the POST, you will use PayDetailEarnings [] to post Earnings and Leave Pay item details. PayDetailEarningsLeave[] is returned in the GET.

The below pay load will create a pay run and it will pre-fill the employee's pay details from their profile.

{
   
    "PayRunName":"Postman Draft Pay run 2 {{$timestamp}}",
	"PayDate": "2019-03-20",
    "PayStartDate":"2019-11-21",
    "PayEndDate":"2019-11-28",
    "EmployeeData":[
    	"61ab8cef-0009-4d41-85b6-dff6d932371e"]
    
}

Details of each object

Data Field	Description	Data Type	Mandatory?
PayRunName	Name of the Pay run	Text	Yes
PayDate	Payment Date	Date	Yes
PayStartDate	Pay Period Start Date	Date	Yes
EmployeeData	The employee's Id	GUID	Yes

Create a Pay run with an Earnings Item

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

Method: POST

{
  
  "PayRunName": "Pay run Name",
  "PayDate":"2019-03-11",
  "PayStartDate":"2019-03-01",
  "PayEndDate":"2019-03-07",
  "CustomEmployeeData": [
    	{
      "EmployeeId": "61ab8cef-0009-4d41-85b6-dff6d932371e",
	      "PayDetailEarnings": [
	        {
	          "PayItemEarningId": "354fbf55-a072-4ae1-a2c7-e2fdacab4c85",
	          "Qty": "40",
	          "Rate": 80,
	          "From": "2019-03-02",
	          "To": "2019-03-06",
	          "CustomerId": ""
	        }
	      ]
	      
	    }
	    ]
}

Create a Pay run with Earnings and Deduction Item

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

Method: POST

{
  "PayRunName": "My Pay run name",
  "PayDate":"2019-03-11",
  "PayStartDate":"2019-03-01",
  "PayEndDate":"2019-03-07",
  "CustomEmployeeData": [
    	{
          "EmployeeId": "e4d0ff56-9578-4510-96a7-5b493bbbfaf1",
	      "PayDetailEarnings": [
	            {
	              "PayItemEarningId": "21592D80-809C-47FA-8E2B-9736A2FEFB1C",
	              "Qty": "40",
	              "Rate": 80,
	              "From": "2019-03-02",
	              "To": "2019-03-06",
	              "CustomerId": "c1d927da-808c-4beb-8484-24b8bdda720f"
	            }
	        
	          ],
	           "PayDetailDeductions": [
                       {
                         "PayItemDeductionId": "73d5d104-a286-4aab-9b3b-7ff965696073",
                         "Qty": "",
                         "Rate": 20,
                         "PayeeId": "c1d927da-808c-4beb-8484-24b8bdda720f"
                       }
               ]
         }
       ]
}

Create a Pay run with multiple Employees

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

Method: POST

{
  
  "PayRunName": "My Pay run Name",
  "PayDate":"2019-03-11",
  "PayStartDate":"2019-03-01",
  "PayEndDate":"2019-03-07",
  "CustomEmployeeData": [
    	
    	{
		 "EmployeeId": "c1302af2-e049-495c-8d72-79bbceb57ce8",
	      "PayDetailEarnings": [
	        {
	          "PayItemEarningId": "21592D80-809C-47FA-8E2B-9736A2FEFB1C",
	          "Qty": "30",
	          "Rate": 80,
	          "From": "2019-03-02",
	          "To": "2019-03-06",
	          "CustomerId": ""
	        }
	      ],
	       "PayDetailReimbursements": [
    	  {
         "PayItemId": "8eaa2c44-4e6e-4e2e-a99e-51c44f9619ce",
         "Qty": 10,
         "Rate": 100
    	  }
    	  ]
    	},
    	  {
    		"EmployeeId": "14776504-5890-4750-a355-5910047a578c",
	    	"PayDetailEarnings": [
	        {
	          "PayItemEarningId": "21592D80-809C-47FA-8E2B-9736A2FEFB1C",
	          "Qty": "31",
	          "Rate": 80,
	          "From": "2019-03-02",
	          "To": "2019-03-06",
	          "CustomerId": ""
	        },
	         {
	          "PayItemEarningId": "e3d502a8-9c46-4b4a-aa2d-a2bcbcbbd750",
	          "Qty": "2",
	          "Rate": 80,
	          "From": "2019-03-02",
	          "To": "2019-03-06",
	          "CustomerId": ""
	        }
	    ]
       },
       {
      "EmployeeId": "4196328c-ff90-4331-9b1e-c04306645989",
	      "PayDetailEarnings": [
	        {
	          "PayItemEarningId": "21592D80-809C-47FA-8E2B-9736A2FEFB1C",
	          "Qty": "32",
	          "Rate": 80,
	          "From": "2019-03-02",
	          "To": "2019-03-06",
	          "CustomerId": ""
	        }
	        
	      ],
	       "PayDetailAllowances": [
       {
         "PayItemAllowanceId": "4ca76b14-fa8d-470c-aabc-1ccd5633675f",
         "Qty": 2,
         "Rate": 20,
         "CustomerId": ""
       }
     ]
       },
       {
      "EmployeeId": "e4d0ff56-9578-4510-96a7-5b493bbbfaf1",
	      "PayDetailEarnings": [
	        {
	          "PayItemEarningId": "21592D80-809C-47FA-8E2B-9736A2FEFB1C",
	          "Qty": "33",
	          "Rate": 80,
	          "From": "2019-03-02",
	          "To": "2019-03-06",
	          "CustomerId": "c1d927da-808c-4beb-8484-24b8bdda720f"
	        }
	        
	      ],
	       "PayDetailDeductions": [
       {
         "PayItemDeductionId": "73d5d104-a286-4aab-9b3b-7ff965696073",
         "Qty": "",
         "Rate": 20,
         "PayeeId": "c1d927da-808c-4beb-8484-24b8bdda720f"
       },
        {
         "PayItemDeductionId": "b7be3168-a346-488b-8a31-40ebcaaaf856",
         "Qty": "",
         "Rate": 20,
         "PayeeId": "ae0371ca-0856-4ded-8b0c-5160a3a54875"
       },
        {
         "PayItemDeductionId": "d1b6d3b1-8abe-406a-ba3a-9acd97f01406",
         "Qty": "",
         "Rate": 20,
         "PayeeId": ""
       }
       ]
       }
       ]
}

Update

You can update a pay run's line item.

Earnings Item line

Endpoint: https://api.reckon.com/R1/{BOOKID}/payroll/payruns/{payrun-id}}/employees/{employee-id}}/earnings/{line-id}}

Method: PUT

{
	"PayItemId": "354fbf55-a072-4ae1-a2c7-e2fdacab4c85",
	"Qty": "50",
	"BaseRate": 803
}

Allowance Item line

Endpoint: https://api.reckon.com/R1/{BOOKID}/payroll/payruns/{payrun-id}}/employees/{employee-id}}/allowances/{line-id}}

Method: PUT

{
	"PayItemId": "df1e064c-93c8-4a83-8540-b9677c288b9d",
	"Qty": 2,
	"Rate": 20
}

Deduction Item line

Endpoint: https://api.reckon.com/R1/{BOOKID}/payroll/payruns/{payrun-id}}/employees/{employee-id}}/deductions/{line-id}}

Method: PUT

{
	"PayItemId": "045e42b5-b0cd-45e2-88ef-ce952c785403",
	"Qty": 2,
	"Rate": 80,
	"Payee": "My Union"
}

Delete

Pay run

Endpoint: https://api.reckon.com/R1/{BOOKID}/payroll/payruns/{payrun-id}

Method: DELETE

Earnings Item line

Endpoint: https://api.reckon.com/R1/{BOOKID}/payroll/payruns/{payrun-id}}/employees/{employee-id}}/earnings/{line-id}}

Method: DELETE

Deduction Item line

Endpoint: https://api.reckon.com/R1/{BOOKID}/payroll/payruns/{payrun-id}}/employees/{employee-id}}/deductions/{line-id}}

Method: DELETE

Allowance Item line

Endpoint: https://api.reckon.com/R1/{BOOKID}/payroll/payruns/{payrun-id}}/employees/{employee-id}}/allowances/{line-id}}

Method: DELETE

Table of Contents

Payruns

Supported Endpoints and Methods

Get the list of Pay runs

Sample response

Details of each object

Get details of a Pay run

Sample response

Details of each object

Creating a Pay run

Minimum Payload

Details of each object

Create a Pay run with an Earnings Item

Create a Pay run with Earnings and Deduction Item

Create a Pay run with multiple Employees

Update

Earnings Item line

Allowance Item line

Deduction Item line

Delete

Pay run

Earnings Item line

Deduction Item line

Allowance Item line

How did we do?

Leave Items

Employee Leave Balances API v1