Table of Contents

Employees API v1

Supported Endpoints and Methods 

The endpoint can be found at : https://api.reckon.com/R1/{BOOKID}/p​ayroll/contacts

Delete endpoint: https://api.reckon.com/R1/{BOOKID}/contacts/{employee-id}

Methods supported:   GET, POST, PUT, 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

contacts

 

GET

Retrieve the list of employees

Portal

contacts

/contactId

GET

Retrieve the details of an employee by ID

Portal

contacts

 

POST

Add an employee record

Portal

contacts

/contactid

PUT

Update an employee record > Personal

Portal

contacts

/contactid

PUT

Update an employee record > Employment

Portal

contacts

/contactid

PUT

Update an employee record > Tax

Portal

contacts

/contactid

PUT

Update an employee record > Leave

Portal

contacts

/contactid

DELETE

Deletes an employee record via the contacts endpoint, NOT through the Payroll Contacts endpoint.

https://api.reckon.com/R1/{BOOKID}/contacts/{employee-id}

Portal


Get the list of employees

Endpoint:  ​https://api.reckon.com/R1/{BOOKID}/p​ayroll/contacts

Method: GET

Sample Response

[
 {
        "EmployeeId": "318253cf-8f81-452a-bda4-56fe6e8505a5",
        "FirstName": "Reece",
        "LastName": "Montgomerie",
        "EmployeeNumber": null,
        "IsComplete": false,
        "IsActive": true,
        "EmploymentType": null,
        "PayrollEmail": null
    },
        "EmployeeId": "42f3a2ae-61d3-4dc8-8682-4448e1d6a930",
        "FirstName": "James",
        "LastName": "Hollis",
        "EmployeeNumber": null,
        "IsComplete": false,
        "IsActive": true,
        "EmploymentType": null,
        "PayrollEmail": null
 }
]

Details of each object 

Element

What is it

EmployeeId

The ID of the employee

FirstName

Employee's First Name

LastName

Employee's Last Name

EmployeeNumber

The employee number

IsComplete

If the employee's profile is completed

IsActive

If the employee is active or inactive

Get the details of an Employee by ID

Endpoint:  ​https://api.reckon.com/R1/{BOOKID}/p​ayroll/contacts/{employee-id}

Method: GET

Sample Response

{
    "CashbookId": "{id}",
    "ContactId": "61ab8cef-0009-4d41-85b6-dff6d932371e",
    "PaymentTermId": null,
    "CustomerCreditLimit": null,
    "CustomerSupplierTermID": "61dbd1c3-a7d5-47ac-8b76-fc390630e166",
    "Description": "Ifti C",
    "FirstNameBranchName": "Ifti",
    "SurnameBusinessName": "C",
    "IsCustomer": false,
    "IsSupplier": false,
    "IsActive": true,
    "IsPerson": true,
    "IsTpar": false,
    "Email": "example@email.com",
    "Website": null,
    "BusinessNumber1": null,
    "Notes": null,
    "AreaCode": "02",
    "PhoneNumber": "95775000",
    "FaxCode": null,
    "FaxNumber": null,
    "MobileCode": null,
    "MobileNumber": null,
    "IsBusinessAddressDifferent": false,
    "IsEmployee": true,
    "IsSuperfund": false,
    "Addresses": [
        {
            "AddressId": "7ca8238b-2287-408e-9551-0226b717497c",
            "AddressTypeId": "e771a780-735c-4c72-bdff-59e6442695ee",
            "Line1": "65 Berry Street",
            "Line2": null,
            "Line3": "",
            "Town": null,
            "Postcode": "2060",
            "Suburb": "North Sydney",
            "State": "NSW",
            "Country": null,
            "AddressType": "Postal",
            "IsInternational": false
        },
        {
            "AddressId": "37d9b1b8-c73f-463a-b63c-ced8d3a7d1e3",
            "AddressTypeId": "41ab780d-9982-4e0c-ad8f-5ab0402c3d74",
            "Line1": "656 Berry Street",
            "Line2": null,
            "Line3": "",
            "Town": null,
            "Postcode": "2060",
            "Suburb": "North Sydney",
            "State": "NSW",
            "Country": null,
            "AddressType": "Business",
            "IsInternational": false
        }
    ],
    "LastModified": "2016-04-08T12:40:08.68",
    "EmployeeData": {
        "EmployeeNumber": "123",
        "EmploymentType": 1,
        "Award": null,
        "AwardId": null,
        "ClassificationId": null,
        "Classification": null,
        "PayFrequencyId": 1,
        "PaySchedule": "Schedule 1",
        "PayScheduleId": "3abb973a-b6fc-464b-89cc-4576897a7759",
        "WeeklyHours": 37.5,
        "JobTitle": "Team Leader",
        "Manager": " ",
        "ManagerId": null,
        "JobDescription": null,
        "HireDate": "2016-07-01T00:00:00Z",
        "LongServiceDate": null,
        "TerminationDate": null,
        "Comment": "rehired",
        "PersonalDetail": {
            "DateOfBirth": "1985-01-01T00:00:00",
            "MaritalStatusId": 3,
            "IsDisabled": false,
            "Gender": 1,
            "PayrollEmail": "iftikhar.chowdhury@reckon.com",
            "IsPaySlipPrint": true,
            "IsPaySlipEmail": true,
            "IsPaySumEmail": true,
            "IsPaySumPrint": true,
            "EmergencyContacts": [
                {
                    "Id": "49af6728-78e2-44ae-9cc6-d1e5ff033c22",
                    "EmployeeId": "61ab8cef-0009-4d41-85b6-dff6d932371e",
                    "Name": null,
                    "Relationship": null,
                    "AreaCode": null,
                    "PhoneNumber": null,
                    "IsPrimary": true
                },
                {
                    "Id": "c8c130ae-aa32-42ff-8d64-47388a1a24cd",
                    "EmployeeId": "61ab8cef-0009-4d41-85b6-dff6d932371e",
                    "Name": null,
                    "Relationship": null,
                    "AreaCode": null,
                    "PhoneNumber": null,
                    "IsPrimary": false
                }
            ]
        },
        "Payments": [
            {
                "EmployeePaymentID": "c8e1209a-6228-430d-a1d7-a322a19c70c7",
                "BankAccountID": "e65d1668-8e32-4843-8054-7da6c0f97022",
                "TypeId": 1,
                "AccountName": "Ifti Employee",
                "BankName": "Commonwealth Bank of Australia",
                "Bsb": "062158",
                "AccountNumber": "10102323",
                "Reference": "Ifti Payroll",
                "Amount": 0.0,
                "AmountTypeId": 1
            }
        ],
        "Tax": {
            "Tfn": "111111111",
            "State": "New South Wales",
            "StateId": "2daac33f-30ce-4a69-b2c4-ab5356901459",
            "Residency": 1,
            "TaxOffset": null,
            "ExtraTax": null,
            "ExtraTaxFromDate": null,
            "AmountTypeId": 1,
            "IsHelpOrTsl": false,
            "TaxScale": "Scale 2: Tax free threshold claimed",
            "TaxScaleId": "90a4b1ed-457f-4235-b62a-b6cecdcb0024",
            "IsSfss": false,
            "MedicareIncrease": null,
            "MedicareIncreaseId": null,
            "IsMedicareAdjustment": false,
            "IsPaySummaryNotRequired": false,
            "NumberOfChildren": null,
            "VoluntaryFlatRate": 0.0,
            "IsStatutoryRate": false
        },
        "Leaves": [
            {
                "Id": "430bd948-8453-48f8-9341-0720cfff53d8",
                "EmployeeId": "61ab8cef-0009-4d41-85b6-dff6d932371e",
                "PayItemsLeavesId": "751bf00d-7db4-4380-a45a-1fb1f8dc2a04",
                "LeaveName": "Personal",
                "PayItemTypeId": 13,
                "AnnualEntitlement": null,
                "AccumulationRate": 5.0,
                "LeaveStartDate": "2016-07-01T00:00:00+10:00",
                "AccrualPeriod": 1,
                "Maximum": null,
                "Loading": null,
                "IsPayOnTermination": false
            },
            {
                "Id": "8e272f14-e9f9-4772-986c-c7afc4630af8",
                "EmployeeId": "61ab8cef-0009-4d41-85b6-dff6d932371e",
                "PayItemsLeavesId": "751bf00d-7db4-4380-a45a-1fb1f8dc2a04",
                "LeaveName": "Personal",
                "PayItemTypeId": 13,
                "AnnualEntitlement": 90.0,
                "AccumulationRate": 1.730769,
                "LeaveStartDate": "2016-06-30T00:00:00+10:00",
                "AccrualPeriod": 1,
                "Maximum": null,
                "Loading": null,
                "IsPayOnTermination": false
            },
            {
                "Id": "3ef0110d-4310-42cb-bbfb-c8ee82d30a00",
                "EmployeeId": "61ab8cef-0009-4d41-85b6-dff6d932371e",
                "PayItemsLeavesId": "67ed15f4-4f0f-44dc-ad4f-de43862feecb",
                "LeaveName": "Annual",
                "PayItemTypeId": 12,
                "AnnualEntitlement": 100.0,
                "AccumulationRate": 2.0,
                "LeaveStartDate": "2016-06-30T00:00:00+10:00",
                "AccrualPeriod": 2,
                "Maximum": null,
                "Loading": null,
                "IsPayOnTermination": true
            },
            {
                "Id": "57836dd2-031d-49e6-b25d-d3dbbcf30bbb",
                "EmployeeId": "61ab8cef-0009-4d41-85b6-dff6d932371e",
                "PayItemsLeavesId": "67ed15f4-4f0f-44dc-ad4f-de43862feecb",
                "LeaveName": "Annual",
                "PayItemTypeId": 12,
                "AnnualEntitlement": null,
                "AccumulationRate": 10.0,
                "LeaveStartDate": "2016-07-01T00:00:00+10:00",
                "AccrualPeriod": 1,
                "Maximum": null,
                "Loading": null,
                "IsPayOnTermination": true
            },
            {
                "Id": "60a3ddbd-1b3b-4183-9c34-c35129ce3bfb",
                "EmployeeId": "61ab8cef-0009-4d41-85b6-dff6d932371e",
                "PayItemsLeavesId": "d6dc2b4c-eb0b-4738-a15f-d892ba8c642c",
                "LeaveName": "Time in Lieu",
                "PayItemTypeId": 15,
                "AnnualEntitlement": null,
                "AccumulationRate": 2.0,
                "LeaveStartDate": "2016-04-08T00:00:00+10:00",
                "AccrualPeriod": 1,
                "Maximum": null,
                "Loading": null,
                "IsPayOnTermination": false
            }
        ],
        "PaySetup": {
            "Earnings": [
                {
                    "Id": "9b760414-5e82-4278-92c7-9d983ff47121",
                    "PayItemsEarningsId": "0218c4ab-299a-4f69-960e-4a403b2f6fb9",
                    "RateBasis": 1.0,
                    "CustomerId": null,
                    "ProjectId": null,
                    "Customer": null,
                    "Project": null,
                    "IsBaseRate": false,
                    "PayItemName": "Salary",
                    "Qty": 37.5,
                    "Rate": 60000.0
                }
            ],
            "Allowances": null,
            "Deductions": null,
            "Supers": {
                "SuperAccounts": [
                    {
                        "Id": "05b3c206-f628-4730-84ce-28322906c5fa",
                        "PayItemsSupersId": "51c85875-e967-46a1-b8a0-3156da9203f6",
                        "PayItemName": "Super AMP",
                        "Rate": 9.5,
                        "SuperFund": "Advance Retirement Suite",
                        "FundProduct": "AMP Flexible Lifetime Allocated Pension",
                        "Reference": null,
                        "IsStatutoryRate": true,
                        "JoinDate": "2016-04-20T00:00:00",
                        "Minimum": 0.0,
                        "IsRescEx": false,
                        "IsStatRateRescEx": false,
                        "IsPercentValue": true,
                        "Limit": null
                    },
                    {
                        "Id": "214ce8fd-2f8a-4b68-b618-fa8b831809f4",
                        "PayItemsSupersId": "ac4c6fc1-2595-49da-8a73-c4ef20fa705c",
                        "PayItemName": "Salary Sacrifice",
                        "Rate": 0.0,
                        "SuperFund": "Advance Retirement Suite",
                        "FundProduct": "AMP Flexible Lifetime Allocated Pension",
                        "Reference": null,
                        "IsStatutoryRate": false,
                        "JoinDate": "2016-04-20T00:00:00",
                        "Minimum": 0.0,
                        "IsRescEx": false,
                        "IsStatRateRescEx": false,
                        "IsPercentValue": false,
                        "Limit": null
                    }
                ]
            },
            "CompanyContributions": null
        },
        "Ytds": [
            {
                "YtdGrossPays": [],
                "YtdLeaves": [],
                "YtdTax": [],
                "Year": "2020 - 2021",
                "TotalGrossPay": 0.0,
                "TotalAllowance": 0.0,
                "TotalDeduction": 0.0,
                "TotalSuper": 0.0,
                "TotalResc": 0.0,
                "TotalTax": 0.0
            }
        ]
    }
}

Details of each object

You will find the details from the related sections below.

Add a new employee

Endpoint:  ​https://api.reckon.com/R1/{BOOKID}/p​ayroll/contacts

Method: POST

Sample Payload

 {

    "Description": "Business Analyst",

    "FirstNameBranchName": "Susan",

    "SurnameBusinessName": "Smith"

}

 

Note: This small payload will create an employee record with the minimum information, as the PUT endpoint can then be used to update specific areas of the employee’s profile without having to do large payloads each time.

Sample Response

"e333a010-4a75-46da-b3b6-d0279a18f038"

The response includes the GUID of the new employee which can then be used in further PUT updates to the employee’s profile.

Details of each object 

Element

What is it

Description

A description for the employee. 

FirstNameBranchName

The first name of the employee

SurnameBusinessName

The last name of the employee

Updating Employee Data

Each employee has a profile divided into a number of sections:

  • Personal
  • Employment
  • Tax
  • Leave

Each of these areas of the profile can be updated individually with more concise payloads as detailed below

Updating Employee Data - Personal

Endpoint:  ​https://api.reckon.com/R1/{BOOKID}/p​ayroll/contacts/{employeeid}

Method: PUT

Sample Payload
 {  

    "Description": "Business Analyst",

    "FirstNameBranchName": "Susan",

    "SurnameBusinessName": "Smith",

    "IsCustomer": false,

    "IsSupplier":false,

    "IsActive": "true",

    "IsPerson": true,

    "Email": "example@email.com",

    "Website": "www.reckon.com",

    "BusinessNumber1": "",

    "Notes": "Any notes go here",

    "AreaCode": "02",

    "PhoneNumber": "95775000",

    "FaxCode": "02",

    "FaxNumber": "95776000",

    "MobileCode": "04",

    "MobileNumber": "11144422",

    "IsBusinessAddressDifferent": false,

    "IsEmployee": true,

    "Addresses": 

    [

      {

        "Line1": "Level 2",

        "Line2": "100 Pacific Highway",

        "Postcode": "2060",

        "Suburb": "North Sydney",

        "State": "New South Wales",

        "Country": "Australia",

        "AddressTypeId": "E771A780-735C-4C72-BDFF-59E6442695EE",

        "IsInternational": "false"

      }

     

    ],

    "EmployeeData": 

    {

      "HireDate": "2018-09-30",  

        "PersonalDetail": 

        {

            "DateOfBirth": "1995-02-18",

            "MaritalStatusId": 1,

            "IsDisabled": true,

            "GenderId": 1,

            "PayrollEmail": "name@emailaddress.com",

            "IsPaySlipPrint": true,

            "IsPaySlipEmail": false,

            "IsPaySumEmail": false,

            "IsPaySumPrint": true,

           

           "EmergencyContacts": 

            [

                    {

                      

                      "Name": "Main Contact",

                      "Relationship": "Father 2",

                      "AreaCode": "02",

                      "PhoneNumber": "1234",

                      "IsPrimary": true

                    },

                    {

                      

                      "Name": "aaa",

                      "Relationship": "Daughter",

                      "AreaCode": "02",

                      "PhoneNumber": "1234",

                      "IsPrimary": false

                    }  

            ]

        }

    }

}

 

Sample Response

"e333a010-4a75-46da-b3b6-d0279a18f038"

If the employee is successfully updated, the existing GUID for the employee will be returned in the responses body.

Details of each object 

Element

What is it

Special Rules

Description

Description of the employee

FirstNameBranchName

The first name of the employee

SurnameBusinessName

The last name of the employee

IsCustomer

whether the employee is also a customer

Boolean - true/false

IsSupplier

where the employee is also a supplier

Boolean - true/false

isActive

whether the employee should be set to active in the book

Boolean - true/false

isPerson

Whether the contact is a person

For employees this should always be true

Email

The email address of the employee

Website

the website of the employee

BusinessNumber1

Not relevant for employees in general. This is a ABN

AreaCode

The area code of the phone number for the employee

PhoneNumber

The phone number without the area code for the employee

FaxCode

The fax area code of the employee

FaxNumber

The fax number without the area code of the employee

Mobile Code

The mobile area code of the employee

MobileNumber

The mobile number of the employee without the area code

IsBusinessAddressDifferent

If the employee is also a supplier/customer whether that address is different. Typically for a employee this is false

Boolean - true/false

IsEmployee

Whether the contact is a employee

Always true for employees

Addresses Array

The array and objects which contain information about the employees address

Line1

Line 1 of the employees address

Line2

Line 2 of the employees address

PostCode

The postcode of the employee

Suburb

The suburb of the employee

State

The state of the employee

Valid options:

  • New South Wales
  • Queensland
  • Australian Capital Territory
  • Northern Territory
  • South Australia
  • Western Australia
  • Tasmania
  • Victoria

Country

The country of the employee

AddressTypeID

The address type in the database either business or personal

Always E771A780-735C-4C72-BDFF-59E6442695EE for employees

IsInternational

Whether this is a international address

Always false for employees

EmployeeData Array

Contains employment specific information about the employee

HireDate

The hire date of the employee

Format is always YYYY-MM-DD

PersonalDetail Object

Contains specific information about the personal details area of the employees profile

DateOfBirth

The date of birth of the employee

Format is always YYYY-MM-DD

MaritalStatusId

The marital status of the employee

Valid options:

  1. Not disclosed
  2. Single
  3. Married/De-facto
  4. Divorced
  5. Widowed

IsDisabled

Whether the employee has a disability that needs to be recorded for HR purposes

Boolean - true/false

GenderId

The gender of the employee

Valid options:

  1. Male
  2. Female
  3. Unspecified

PayrollEmail

The email address to be used for payroll documents with the employee

IsPaySlipPrint

Whether the employee should be set to have printed payslips

Boolean - true/false

IsPaySlipEmail

Whether the employee should be set to have emailed payslips

Boolean - true/false

IsPaySumEmail

Whether the employee should be set to have emailed payment summaries

Boolean - true/false

IsPaySumPrint

Whether the employee should be set to have printed payment summaries

Boolean - true/false

EmergencyContacts Array

Array of emergency contacts for the employee

Name

The name of the emergency contact

Relationship

The relationship of the emergency contact

AreaCode

The area code of the emergency contacts phone number

PhoneNumber

The phone number without the area code of the emergency contact

IsPrimary

Whether this should be set to the primary emergency contact or not

Boolean - true/false

 

Updating Employee Data - Employment

Endpoint:  ​https://api.reckon.com/R1/{BOOKID}/p​ayroll/contacts/{employeeid}

Method: PUT 

Sample Payload
{

	"Description": "Business Analyst",

	"FirstNameBranchName": "Susan",

	"SurnameBusinessName": "Smith",

	"IsCustomer": false,

	"IsSupplier": false,

	"IsActive": "true",

	"IsPerson": true,

	"Email": "example@email.com",

	"Website": "www.reckon.com",

	"BusinessNumber1": "",

	"Notes": "Any notes go here",

	"AreaCode": "02",

	"PhoneNumber": "95775000",

	"FaxCode": "02",

	"FaxNumber": "95776000",

	"MobileCode": "04",

	"MobileNumber": "11144422",

	"IsBusinessAddressDifferent": false,

	"IsEmployee": true,

	"Addresses":

		[

			{

				"Line1": "Level 2",

				"Line2": "100 Pacific Highway",

				"Postcode": "2060",

				"Suburb": "North Sydney",

				"State": "New South Wales",

				"Country": "Australia",

				"AddressTypeId": "E771A780-735C-4C72-BDFF-59E6442695EE",

				"IsInternational": "false"

			}



		],

	"EmployeeData": {

		"EmployeeNumber": "",

		"EmploymentTypeId": "1",

		"PayFrequencyId": "1",

		"WeeklyHours": "40",

		"JobTitle": "CEO",

		"ManagerId": "",

		"JobDescription": "PUT DATA",

		"HireDate": "2018-09-30T00:00:00Z",

		"LongServiceDate": "2028-09-30",

		"TerminationDate": "2020-10-20",

		"Comment": "Test Comments",

		"Payments": [

			{

				"EmployeePaymentID": "",

				"BankAccountID": "",

				"TypeId": 1,

				"AccountName": "API PUT",

				"BankName": "ST George Bank",

				"Bsb": "012012",

				"AccountNumber": "12312311",

				"Reference": "Pay",

				"Amount": "",

				"AmountTypeId": 1

			}

		]

	}
}

Sample Response

"e333a010-4a75-46da-b3b6-d0279a18f038"

If the employee is successfully updated, the existing GUID for the employee will be returned in the responses body.

Details of each object  

Element

Description

Data Type

EmployeeData array

Contains information specific about the employment area of the employees profile

EmployeeNumber

The employee number for the employee

PayFrequencyId

How often the employee is paid

Valid options:

  1. Weekly
  2. Fortnightly
  3. Monthly

WeeklyHours

The number of hours per week the employee typically works

JobTitle

The job title of the employee

ManagerId

The GUID of the employees manager if applicable

GUID

JobDescription

Job description

HireDate

The hire date of the employee

Format YYYY-MM-DD

LongServiceDate

The date the employee will be eligible for long service leave

Format YYYY-MM-DD

TerminationDate

The termination date of the employee

Format YYY-MM-DD

Comment

Any comments for the employees profile

Payments Array

Contains information about the employees bank accounts for payment

TypeId

The type of the payment

Valid options:

  1. Cash
  2. Direct Credit

AccountName

The account name of the employees bank account

BankName

The name of the bank the employees account is with

BSB

The bsb number of the account

AccountNumber

The account number without the bsb of the account

Reference

The reference to include on any aba file when payments are made to the employee

Amount

If the employee is splitting the payment over multiple accounts the amount of split can be defined here

AmountTypeId

Whether the split amount is a dollar or percentage

Valid options:

  1. Dollar
  2. Percentage

 

Updating Employee Data - Tax

Endpoint:  ​https://api.reckon.com/R1/{BOOKID}/p​ayroll/contacts/{employeeid}

Method: PUT  

 

Sample Payload
{

	"Description": "Business Analyst",

	"FirstNameBranchName": "Susan",

	"SurnameBusinessName": "Smith",

	"IsCustomer": false,

	"IsSupplier": false,

	"IsActive": "true",

	"IsPerson": true,

	"Email": "example@email.com",

	"Website": "www.reckon.com",

	"BusinessNumber1": "",

	"Notes": "Any notes go here",

	"AreaCode": "02",

	"PhoneNumber": "95775000",

	"FaxCode": "02",

	"FaxNumber": "95776000",

	"MobileCode": "04",

	"MobileNumber": "11144422",

	"IsBusinessAddressDifferent": false,

	"IsEmployee": true,

	"Addresses":

		[

			{

				"Line1": "Level 2",

				"Line2": "100 Pacific Highway",

				"Postcode": "2060",

				"Suburb": "North Sydney",

				"State": "New South Wales",

				"Country": "Australia",

				"AddressTypeId": "E771A780-735C-4C72-BDFF-59E6442695EE",

				"IsInternational": "false"

			}



		],
	"EmployeeData": [

		{

			"EmployeeNumber": "POST001",

			"EmploymentType": 6,

			"PayFrequencyId": 1,

			"WeeklyHours": "",

			"JobTitle": "",

			"ManagerId": "",

			"JobDescription": "",

			"HireDate": "2018-09-30T00:00:00Z",

			"LongServiceDate": "2028-09-30",

			"TerminationDate": "2020-10-20",

			"Comments": "Test Comments",

			"Tax":

			{

				"Tfn": "111111111",

				"StateId": "3A6A5C73-2F06-4558-BDAF-F1743A64B032",

				"Residency": 2,

				"TaxOffset": "",

				"ExtraTax": "",

				"ExtraTaxFromDate": "",

				"AmountTypeId": "",

				"IsHelpOrTsl": false,

				"TaxScaleId": "",

				"IsSfss": false,

				"IsMedicareAdjustment": false,

				"NumberOfChildren": "",

				"VoluntaryFlatRate": 0,

				"IsStaturotyRate": false

			}
		}
	]

}

Sample Response 

"e333a010-4a75-46da-b3b6-d0279a18f038" 

 Details of each object

Element

What is it

Special rules

Tax Object

This contains tax specific information for the employee

Tfn

The tax file number for the employee

Must be 8 or 9 digit number

StateId

The state to be used for state payroll tax calculations with this employee. State payroll tax is a future Reckon One Payroll enhancement

Valid options:

  • {ID} - {Name}
  • 1E78CFFE-C679-4252-8E2A-0245A0E99E23 - Northern Territory
  • 1E1E6166-487C-4D74-AC6F-29478FA8E333 - South Australia
  • 3379A643-52F9-4C34-8DA3-4860DB796A17 - Tasmania
  • 10C75022-553C-46C2-AB63-9BA4DA24E8E2 - Victoria
  • 2DAAC33F-30CE-4A69-B2C4-AB5356901459 - New South Wales
  • EBC47D57-9449-459D-BD33-B5F7A8C57341 - Australian Capital Territory
  • DEBB78C4-E176-4E8B-A1EE-C49F889144F0 - Western Australia
  • 3A6A5C73-2F06-4558-BDAF-F1743A64B032 - Queensland

Residency

Whether the employee is a citizen for tax purposes or foreign resident

Valid options:

  1. Resident for tax purposes
  2. Foreign resident

TaxOffset

Any tax offset amount for the employee

Dollar amount

ExtraTax

Any extra tax the employee has requested to be withheld via PAYG

Dollar amount

ExtraTaxFromDate

The date the employee requested the additional tax to be calculated from

Format YYYY-MM-DD

AmountTypeId

Whether the extra tax is a percentage or dollar amount

Valid options:

  1. Dollar
  2. Percentage

IsHelpOrTSL

Whether the employee has a STSL debt

This is also the same as the IsSfss element. Both elements perform the same task of indicating a student debt based on recent legislative change

TaxScaleId

The tax scale the employee is to be set to

Valid options:

  • {ID} - {Name}
  • EF1C0BFF-A2E3-40F8-8FA8-24E0B1C5583F - Scale 1: Tax free threshold not claimed
  • DCDA2486-77DD-402F-A5A7-26D18F1721FA - Voluntary/Flat rate
  • 10D25900-1B78-4372-A495-7A6BD8781DC0 -  Working holiday maker
  • 448C37D2-78E3-4E45-85B5-AE4532351785 - Scale 5: Full medicare exemption
  • 2CBB1CC1-AD02-4D1F-AAC2-B62146DE4474 - Scale 4: No TFN & No TFN foreign res
  • 90A4B1ED-457F-4235-B62A-B6CECDCB0024 - Scale 2: Tax free threshold claimed
  • B241328A-70FB-400D-9621-CE7E8475ABFD - Scale 3: Foreign resident
  • 6352D8A0-C812-4542-9777-E4E62AD3B80D - Scale 6: Half medicare exemption
  • 9660334D-2EA3-4891-9030-ED145A7B7DCF - Seasonal worker programme

IsSfss

Whether the employee has a STSL debt

This is also the same as the IsSfss element. Both elements perform the same task of indicating a student debt based on recent legislative change

NumberOfChildren

The number of children the employee has as dependents

VoluntaryFlatRate

If the employee is in a tax scale where a flat rate can be used such as working holiday maker, what that rate is

IsStatutoryRate

If the employee is in a tax scale where a statutory rate may apply such as working holiday maker, whether the statutory rate should be used

Boolean - true/false

 

Updating Employee Data - Leave

Endpoint:  ​https://api.reckon.com/R1/{BOOKID}/p​ayroll/contacts/{employeeid}

Method: PUT   

 

Sample Payload
{

	"Description": "Business Analyst",

	"FirstNameBranchName": "Susan",

	"SurnameBusinessName": "Smith",

	"IsCustomer": false,

	"IsSupplier": false,

	"IsActive": "true",

	"IsPerson": true,

	"Email": "example@email.com",

	"Website": "www.reckon.com",

	"BusinessNumber1": "",

	"Notes": "Any notes go here",

	"AreaCode": "02",

	"PhoneNumber": "95775000",

	"FaxCode": "02",

	"FaxNumber": "95776000",

	"MobileCode": "04",

	"MobileNumber": "11144422",

	"IsBusinessAddressDifferent": false,

	"IsEmployee": true,

	"Addresses":

		[

			{

				"Line1": "Level 2",

				"Line2": "100 Pacific Highway",

				"Postcode": "2060",

				"Suburb": "North Sydney",

				"State": "New South Wales",

				"Country": "Australia",

				"AddressTypeId": "E771A780-735C-4C72-BDFF-59E6442695EE",

				"IsInternational": "false"

			}



		],
	"EmployeeData": [

		{

			"EmployeeNumber": "POST001",

			"EmploymentType": 6,

			"PayFrequencyId": 1,

			"WeeklyHours": "",

			"JobTitle": "",

			"ManagerId": "",

			"JobDescription": "",

			"HireDate": "2018-09-30T00:00:00Z",

			"LongServiceDate": "2028-09-30",

			"TerminationDate": "2020-10-20",

			"Comments": "Test Comments",

			"Leaves": [

				{

					"PayItemsLeavesId": "3ADE712C-AD5E-4725-8CD0-BE376D790A8A",

					"AnnualEntitlement": 152,

					"AccumulationRate": 0.0487,

					"LeaveStartDate": "2019-10-04T00:00:00Z",

					"AccrualPeriodId": 1,

					"Maximum": null,

					"Loading": 17.5,

					"IsPayOnTermination": true

				}

			]
		}
	]
}

Sample Response 

"e333a010-4a75-46da-b3b6-d0279a18f038"  

Details of each object 

Element

What is it

Special rules

PayItemLeavesId

The GUID of the payroll item to be allocated as a leave item to the employees profile

To retrieve the list of leave items in the book use the following endpoint

https://api.reckon.com/{cashbook}/payroll/leaveitems

AnnualEntitlement

The amount of hours the employee is entitled to for the leave item per year

AccumulationRate

The accumulation rate for the leave item

LeaveStartDate

The date the leave should start accuring from

Format YYYY-MM-DD

AccrualPeriodId

The accrual period for the leave item

Valid options:

  1. Per pay
  2. Per time worked
  3. Per annum

Maximum

The maximum amount the employee can accrue for the leave before accrual stops

Loading

Any loading amount applied to the leave (leave loading)

Percentage amount but % should not be included in payload

IsPayOnTermination

Whether the leave will be paid out if the employee is terminated

Boolean - true/false

 


Deleting an Employee

Endpoint:  ​https://api.reckon.com/R1/{BOOKID}/contacts/{employeeid}

Method: DELETE   

How did we do?

Endpoints Overview

Payroll Items

Related Articles

Employee Leave Balances API v1
Employees API v2
Contacts API v1
Powered by HelpDocs (opens in a new tab)

Powered by HelpDocs (opens in a new tab)