Create timesheet line

Create an individual timesheet line IMPORTANT NOTICE: If units are specified the start and end time will be changed to midnight

Request

POST https://api.nzpayroll.co.nz/api/v2/business/{businessId}/timesheet

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

The request body takes a complete NzIndividualTimesheetLineModel resource, containing the following writable properties:

{
    "attachment": {
        "data": "byte",
        "dateCreated": "date-time",
        "dateScanned": "date-time",
        "friendlyName": "string",
        "id": "int32",
        "isDeleted": "boolean",
        "isInfected": "boolean",
        "url": "string"
    },
    "attachmentId": "int32",
    "breaks": [
        {
            "endTime": "date-time",
            "isPaidBreak": "boolean",
            "startTime": "date-time"
        }
    ],
    "comments": "string",
    "dimensionValueIds": [
        "int32"
    ],
    "employeeId": "int32",
    "endTime": "date-time",
    "externalId": "string",
    "fullyQualifiedLocationName": "string",
    "hiddenComments": "string",
    "id": "int32",
    "leaveCategoryId": "int32",
    "locationId": "int32",
    "locationIsDeleted": "boolean",
    "payCategoryId": "int32",
    "rate": "double",
    "shiftConditionIds": [
        "int32"
    ],
    "shiftConditions": [
        {
            "id": "int32",
            "name": "string"
        }
    ],
    "source": "string",
    "startTime": "date-time",
    "status": "string",
    "units": "double",
    "workType": "string",
    "workTypeId": "int32"
}

Properties

Name Type Description
attachment object Attachment
attachment.data byte Byte[]
attachment.dateCreated date-time Nullable
attachment.dateScanned date-time Nullable
attachment.friendlyName string String
attachment.id int32 Nullable
attachment.isDeleted boolean Boolean
attachment.isInfected boolean Nullable
attachment.url string String
attachmentId int32 Nullable
breaks[] array
breaks[].endTime date-time Nullable
breaks[].isPaidBreak boolean Boolean
breaks[].startTime date-time Nullable
comments string String
dimensionValueIds[] array of int32
employeeId int32 Int32
endTime date-time Nullable
externalId string String
fullyQualifiedLocationName string String
hiddenComments string String
id int32 Int32
leaveCategoryId int32 Nullable
locationId int32 Nullable
locationIsDeleted boolean Boolean
payCategoryId int32 Nullable
rate double Nullable
shiftConditionIds[] array of int32
shiftConditions[] array
shiftConditions[].id int32 Int32
shiftConditions[].name string String
source string ExternalService

Possible values are:

  • None
  • Saasu
  • Xero
  • MYOB
  • Deputy
  • EmployeeTimePunch
  • ClickSuper
  • IntegratedTimesheets
  • FileImport
  • FileExport
  • QuickBooks
  • Harmony
  • AwardStore
  • Attache
  • IntegratedRostering
  • ReckonAccounts
  • API
  • MicroPower
  • RosterLive
  • NetSuite
  • Kounta
  • TimeAndAttendanceKiosk
  • DetailedFileExport
  • JonasPremier
  • WageEasy
  • Maestrano
  • WorkZone
  • EmployeePortal
  • RosterTemplate
  • Onboarding
  • Admin
  • WorkZoneClockOnOff
  • NetSuiteOneWorld
  • Sage50
  • PensionSync
  • FinancialsOffice
  • ProntoXI
  • PayRunDefault
  • StandardWorkDay
  • Beam
  • PayRunAutomation
  • BureauDashboard
  • Wiise
  • QBOMigrationTool
  • AbridgedFileImport
  • QBOForcedMigration
  • HmrcDpsUpdate
  • HmrcDpsStudentLoan
  • HmrcDpsPostGradLoan
  • Sage50FileImporter
  • FPSFileImporter
  • OAuth
  • FreshBooks
  • StarFileImporter
  • ActiveCampaign
  • SummaryAndDetailsExport
  • Telleroo
  • EmployeeAdvancedHoursUpload
  • BusinessCentral
  • Paytron
  • AccessFinancials
  • Comma
  • Zoho
  • FlatFileEmployeeImporter
  • Twinfield
  • SageAccounting
  • Square
  • Quickfile
  • Tide
  • TideSso
  • FreeAgent
  • Akahu
  • InstaPay
  • Zepto
  • Slack
  • Caxton
  • QuickbooksStandalonePayroll
  • ImportEmployeeSelfSetup
  • XeroIdentityPayrollSignUp
  • XeroIdentityHrSignUp
  • SageIntacct
  • InstaPayDaily
  • Salesforce
  • AutomatedPublicHolidayNotWorked
  • EmployeePayRatesUpload
  • Zapier
  • StapledSuperFund
  • Swag
startTime date-time Nullable
status string String
units double Nullable
workType string String
workTypeId int32 Nullable

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK

 NzIndividualTimesheetLineModel