openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 104 kB
JSON
{"openapi":"3.0.0","servers":[{"description":"Xero Payroll AU API","url":"https://api.xero.com/payroll.xro/1.0"}],"info":{"contact":{"email":"api@xero.com","name":"Xero Platform Team","url":"https://developer.xero.com","x-twitter":"XeroAPI"},"description":"This is the Xero Payroll API for orgs in Australia region.","license":{"name":"MIT","url":"https://github.com/XeroAPI/Xero-OpenAPI/blob/master/LICENSE"},"termsOfService":"https://developer.xero.com/xero-developer-platform-terms-conditions/","title":"Xero Payroll AU API","version":"2.9.4","x-apisguru-categories":["financial"],"x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/master/xero-payroll-au.yaml","version":"3.0"}],"x-providerName":"xero.com","x-serviceName":"xero-payroll-au"},"tags":[{"description":"Operations available to regular developers","name":"PayrollAu"}],"paths":{"/Employees":{"get":{"operationId":"getEmployees","parameters":[{"description":"Only records created or modified since this timestamp will be returned","in":"header","name":"If-Modified-Since","schema":{"type":"string"}},{"description":"Filter by an any element","example":"Status==\"ACTIVE\"","in":"query","name":"where","schema":{"type":"string"}},{"description":"Order by an any element","example":"EmailAddress%20DESC","in":"query","name":"order","schema":{"type":"string"}},{"description":"e.g. page=1 – Up to 100 employees will be returned in a single API call","in":"query","name":"page","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":"{ \"Id\": \"b22392ec-a288-4258-ba55-87921d0ed63f\", \"Status\": \"OK\", \"ProviderName\": \"java-sdk-oauth2-dev-02\", \"DateTimeUTC\": \"/Date(1573621523465)/\", \"Employees\": [ { \"EmployeeID\": \"b34e89ff-770d-4099-b7e5-f968767118bc\", \"FirstName\": \"Jack\", \"MiddleNames\": \"Johnson\", \"LastName\": \"Sparrow\", \"Status\": \"ACTIVE\", \"Email\": \"jack.sparrow@xero.com\", \"DateOfBirth\": \"/Date(572313600000+0000)/\", \"Gender\": \"M\", \"Phone\": \"4153332323\", \"Mobile\": \"415-1234567\", \"StartDate\": \"/Date(1547164800000+0000)/\", \"OrdinaryEarningsRateID\": \"ab874dfb-ab09-4c91-954e-43acf6fc23b4\", \"PayrollCalendarID\": \"22a05fc5-386d-4950-9842-3e7a6c812135\", \"UpdatedDateUTC\": \"/Date(1572915814000+0000)/\" }, { \"EmployeeID\": \"7aa04979-ded5-44d9-b09a-793749425844\", \"FirstName\": \"John\", \"LastName\": \"Smith\", \"Status\": \"ACTIVE\", \"Email\": \"john.smith@xero.com\", \"DateOfBirth\": \"/Date(315619200000+0000)/\", \"Gender\": \"M\", \"StartDate\": \"/Date(1572566400000+0000)/\", \"OrdinaryEarningsRateID\": \"ab874dfb-ab09-4c91-954e-43acf6fc23b4\", \"PayrollCalendarID\": \"78bb86b9-e1ea-47ac-b75d-f087a81931de\", \"UpdatedDateUTC\": \"/Date(1572916028000+0000)/\" } ] }","schema":{"$ref":"#/components/schemas/Employees"}}},"description":"search results matching criteria"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIException"}}},"description":"validation error for a bad request"}},"security":[{"OAuth2":["payroll.employees.read"]}],"summary":"Searches payroll employees","tags":["PayrollAu"]},"parameters":[{"$ref":"#/components/parameters/requiredHeader"}],"post":{"operationId":"createEmployee","requestBody":{"content":{"application/json":{"example":"[ { \"FirstName\": \"Albus\", \"LastName\": \"Dumbledore\", \"DateOfBirth\": \"/Date(321523200000+0000)/\", \"HomeAddress\": { \"AddressLine1\": \"101 Green St\", \"City\": \"Island Bay\", \"Region\": \"NSW\", \"PostalCode\": \"6023\", \"Country\": \"AUSTRALIA\" }, \"StartDate\": \"/Date(321523200000+0000)/\", \"MiddleNames\": \"Percival\", \"Email\": \"albus39608@hogwarts.edu\", \"Gender\": \"M\", \"Phone\": \"444-2323\", \"Mobile\": \"555-1212\", \"IsAuthorisedToApproveLeave\": true, \"IsAuthorisedToApproveTimesheets\": true, \"JobTitle\": \"Regional Manager\", \"Classification\": \"corporate\", \"OrdinaryEarningsRateID\": \"ab874dfb-ab09-4c91-954e-43acf6fc23b4\", \"Status\": \"ACTIVE\" } ]","schema":{"items":{"$ref":"#/components/schemas/Employee"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":"{ \"Id\": \"e40caf91-1931-40c0-8908-728aa092ab23\", \"Status\": \"OK\", \"ProviderName\": \"java-sdk-oauth2-dev-02\", \"DateTimeUTC\": \"/Date(1573621524489)/\", \"Employees\": [ { \"EmployeeID\": \"cdfb8371-0b21-4b8a-8903-1024df6c391e\", \"FirstName\": \"Albus\", \"MiddleNames\": \"Percival\", \"LastName\": \"Dumbledore\", \"Status\": \"ACTIVE\", \"Email\": \"albus39608@hogwarts.edu\", \"DateOfBirth\": \"/Date(321523200000+0000)/\", \"JobTitle\": \"Regional Manager\", \"Gender\": \"M\", \"HomeAddress\": { \"AddressLine1\": \"101 Green St\", \"City\": \"Island Bay\", \"Region\": \"NSW\", \"PostalCode\": \"6023\", \"Country\": \"AUSTRALIA\" }, \"Phone\": \"444-2323\", \"Mobile\": \"555-1212\", \"StartDate\": \"/Date(321523200000+0000)/\", \"Classification\": \"corporate\", \"OrdinaryEarningsRateID\": \"ab874dfb-ab09-4c91-954e-43acf6fc23b4\", \"UpdatedDateUTC\": \"/Date(1573621524458+0000)/\", \"IsAuthorisedToApproveLeave\": true, \"IsAuthorisedToApproveTimesheets\": true } ] }","schema":{"$ref":"#/components/schemas/Employees"}}},"description":"A successful request"},"400":{"description":"invalid input, object invalid - TODO"}},"security":[{"OAuth2":["payroll.employees"]}],"summary":"Creates a payroll employee","tags":["PayrollAu"],"x-hasPayrollAuProblem":true}},"/Employees/{EmployeeID}":{"get":{"operationId":"getEmployee","parameters":[{"description":"Employee id for single object","in":"path","name":"EmployeeID","required":true,"schema":{"example":"4ff1e5cc-9835-40d5-bb18-09fdb118db9c","format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":"{ \"Id\": \"ff00117e-75d1-4cc3-961c-13fc37b65e01\", \"Status\": \"OK\", \"ProviderName\": \"java-sdk-oauth2-dev-02\", \"DateTimeUTC\": \"/Date(1573623316150)/\", \"Employees\": [ { \"EmployeeID\": \"cdfb8371-0b21-4b8a-8903-1024df6c391e\", \"Title\": \"Mr.\", \"FirstName\": \"Albus\", \"MiddleNames\": \"Frank\", \"LastName\": \"Dumbledore\", \"Status\": \"ACTIVE\", \"Email\": \"albus39608@hogwarts.edu\", \"DateOfBirth\": \"/Date(321494400000+0000)/\", \"JobTitle\": \"Regional Manager\", \"Gender\": \"M\", \"HomeAddress\": { \"AddressLine1\": \"101 Green St\", \"City\": \"Island Bay\", \"Region\": \"NSW\", \"PostalCode\": \"6023\", \"Country\": \"AUSTRALIA\" }, \"Phone\": \"444-2323\", \"Mobile\": \"555-1212\", \"StartDate\": \"/Date(321494400000+0000)/\", \"Classification\": \"corporate\", \"OrdinaryEarningsRateID\": \"ab874dfb-ab09-4c91-954e-43acf6fc23b4\", \"PayrollCalendarID\": \"78bb86b9-e1ea-47ac-b75d-f087a81931de\", \"UpdatedDateUTC\": \"/Date(1573623306000+0000)/\", \"EmployeeGroupName\": \"foo\", \"IsAuthorisedToApproveLeave\": true, \"IsAuthorisedToApproveTimesheets\": true, \"TaxDeclaration\": { \"AustralianResidentForTaxPurposes\": true, \"TaxFreeThresholdClaimed\": true, \"HasHELPDebt\": false, \"HasSFSSDebt\": false, \"EligibleToReceiveLeaveLoading\": false, \"UpdatedDateUTC\": \"/Date(1573623306000+0000)/\", \"HasStudentStartupLoan\": false, \"ResidencyStatus\": \"AUSTRALIANRESIDENT\" }, \"BankAccounts\": [], \"OpeningBalances\": { \"OpeningBalanceDate\": \"/Date(1573603200000+0000)/\", \"EarningsLines\": [], \"DeductionLines\": [], \"SuperLines\": [], \"ReimbursementLines\": [], \"LeaveLines\": [ { \"LeaveTypeID\": \"184ea8f7-d143-46dd-bef3-0c60e1aa6fca\", \"NumberOfUnits\": 10 } ] }, \"PayTemplate\": { \"EarningsLines\": [ { \"EarningsRateID\": \"ab874dfb-ab09-4c91-954e-43acf6fc23b4\", \"CalculationType\": \"USEEARNINGSRATE\", \"NormalNumberOfUnits\": 3 } ], \"DeductionLines\": [ { \"DeductionTypeID\": \"ed05ea82-e40a-4eb6-9c2e-4b3c03e7e938\", \"CalculationType\": \"FIXEDAMOUNT\", \"Amount\": 4 } ], \"SuperLines\": [ { \"ContributionType\": \"SGC\", \"CalculationType\": \"STATUTORY\", \"MinimumMonthlyEarnings\": 450, \"ExpenseAccountCode\": \"478\", \"LiabilityAccountCode\": \"826\" } ], \"ReimbursementLines\": [ { \"ReimbursementTypeID\": \"aa8cfa40-d872-4be0-8a94-bb7f00962f74\", \"Description\": \"boo\", \"Amount\": 55 } ], \"LeaveLines\": [ { \"LeaveTypeID\": \"184ea8f7-d143-46dd-bef3-0c60e1aa6fca\", \"CalculationType\": \"FIXEDAMOUNTEACHPERIOD\", \"AnnualNumberOfUnits\": 4, \"EntitlementFinalPayPayoutType\": \"NOTPAIDOUT\" } ] }, \"SuperMemberships\": [], \"LeaveBalances\": [ { \"LeaveName\": \"Carer Leave (unpaid)\", \"LeaveTypeID\": \"184ea8f7-d143-46dd-bef3-0c60e1aa6fca\", \"NumberOfUnits\": 10, \"TypeOfUnits\": \"Hours\" } ] } ] }","schema":{"$ref":"#/components/schemas/Employees"}}},"description":"search results matching criteria"}},"security":[{"OAuth2":["payroll.employees.read"]}],"summary":"Retrieves an employee's detail by unique employee id","tags":["PayrollAu"]},"parameters":[{"$ref":"#/components/parameters/requiredHeader"}],"post":{"description":"Update properties on a single employee","operationId":"updateEmployee","parameters":[{"description":"Employee id for single object","in":"path","name":"EmployeeID","required":true,"schema":{"example":"4ff1e5cc-9835-40d5-bb18-09fdb118db9c","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"example":"[ { \"MiddleNames\": \"Frank\" } ]","schema":{"items":{"$ref":"#/components/schemas/Employee"},"type":"array"}}}},"responses":{"200":{"content":{"application/json":{"example":"{ \"Id\": \"a40b0b60-def8-4bd7-bcd6-d97d617bf539\", \"Status\": \"OK\", \"ProviderName\": \"3f93110a-df13-49c7-b82f-a069813df188\", \"DateTimeUTC\": \"/Date(1573621524786)/\", \"Employees\": [ { \"EmployeeID\": \"cdfb8371-0b21-4b8a-8903-1024df6c391e\", \"FirstName\": \"Albus\", \"MiddleNames\": \"Frank\", \"LastName\": \"Dumbledore\", \"Status\": \"ACTIVE\", \"Email\": \"albus39608@hogwarts.edu\", \"DateOfBirth\": \"/Date(321523200000+0000)/\", \"JobTitle\": \"Regional Manager\", \"Gender\": \"M\", \"HomeAddress\": { \"AddressLine1\": \"101 Green St\", \"City\": \"Island Bay\", \"Region\": \"NSW\", \"PostalCode\": \"6023\", \"Country\": \"AUSTRALIA\" }, \"Phone\": \"444-2323\", \"Mobile\": \"555-1212\", \"StartDate\": \"/Date(321523200000+0000)/\", \"Classification\": \"corporate\", \"OrdinaryEarningsRateID\": \"ab874dfb-ab09-4c91-954e-43acf6fc23b4\", \"UpdatedDateUTC\": \"/Date(1573621524755+0000)/\", \"IsAuthorisedToApproveLeave\": true, \"IsAuthorisedToApproveTimesheets\": true } ] }","schema":{"$ref":"#/components/schemas/Employees"}}},"description":"A successful request"}},"security":[{"OAuth2":["payroll.employees"]}],"summary":"Updates an employee's detail","tags":["PayrollAu"]}},"/LeaveApplications":{"get":{"operationId":"getLeaveApplications","parameters":[{"description":"Only records created or modified since this timestamp will be returned","in":"header","name":"If-Modified-Since","schema":{"type":"string"}},{"description":"Filter by an any element","example":"Status==\"ACTIVE\"","in":"query","name":"where","schema":{"type":"string"}},{"description":"Order by an any element","example":"EmailAddress%20DESC","in":"query","name":"order","schema":{"type":"string"}},{"description":"e.g. page=1 – Up to 100 objects will be returned in a single API call","in":"query","name":"page","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":"{ \"Id\": \"5d31168a-5024-401d-9531-6902064b3fcb\", \"Status\": \"OK\", \"ProviderName\": \"java-sdk-oauth2-dev-02\", \"DateTimeUTC\": \"/Date(1573679791199)/\", \"LeaveApplications\": [ { \"LeaveApplicationID\": \"1d4cd583-0107-4386-936b-672eb3d1f624\", \"EmployeeID\": \"cdfb8371-0b21-4b8a-8903-1024df6c391e\", \"LeaveTypeID\": \"184ea8f7-d143-46dd-bef3-0c60e1aa6fca\", \"LeavePeriods\": [ { \"PayPeriodStartDate\": \"/Date(1573171200000+0000)/\", \"PayPeriodEndDate\": \"/Date(1573689600000+0000)/\", \"LeavePeriodStatus\": \"SCHEDULED\", \"NumberOfUnits\": 0 } ], \"Title\": \"vacation\", \"StartDate\": \"/Date(1573516800000+0000)/\", \"EndDate\": \"/Date(1573516800000+0000)/\", \"UpdatedDateUTC\": \"/Date(1573623008000+0000)/\" }, { \"LeaveApplicationID\": \"62b90465-66e9-4c3a-8151-de1e6335554d\", \"EmployeeID\": \"b34e89ff-770d-4099-b7e5-f968767118bc\", \"LeaveTypeID\": \"184ea8f7-d143-46dd-bef3-0c60e1aa6fca\", \"LeavePeriods\": [ { \"PayPeriodStartDate\": \"/Date(1571961600000+0000)/\", \"PayPeriodEndDate\": \"/Date(1572480000000+0000)/\", \"LeavePeriodStatus\": \"SCHEDULED\", \"NumberOfUnits\": 0 }, { \"PayPeriodStartDate\": \"/Date(1572566400000+0000)/\", \"PayPeriodEndDate\": \"/Date(1573084800000+0000)/\", \"LeavePeriodStatus\": \"SCHEDULED\", \"NumberOfUnits\": 0 } ], \"Title\": \"Yep Carer Leave\", \"Description\": \"My updated Description\", \"StartDate\": \"/Date(1572559200000+0000)/\", \"EndDate\": \"/Date(1572645600000+0000)/\", \"UpdatedDateUTC\": \"/Date(1573447344000+0000)/\" }, { \"LeaveApplicationID\": \"e8bd9eeb-18c9-4475-9c81-b298f9aa26c0\", \"EmployeeID\": \"b34e89ff-770d-4099-b7e5-f968767118bc\", \"LeaveTypeID\": \"184ea8f7-d143-46dd-bef3-0c60e1aa6fca\", \"LeavePeriods\": [ { \"PayPeriodStartDate\": \"/Date(1571961600000+0000)/\", \"PayPeriodEndDate\": \"/Date(1572480000000+0000)/\", \"LeavePeriodStatus\": \"SCHEDULED\", \"NumberOfUnits\": 0 }, { \"PayPeriodStartDate\": \"/Date(1572566400000+0000)/\", \"PayPeriodEndDate\": \"/Date(1573084800000+0000)/\", \"LeavePeriodStatus\": \"SCHEDULED\", \"NumberOfUnits\": 0 } ], \"Title\": \"Hello World\", \"StartDate\": \"/Date(1572559200000+0000)/\", \"EndDate\": \"/Date(1572645600000+0000)/\", \"UpdatedDateUTC\": \"/Date(1573447343000+0000)/\" } ] }","schema":{"$ref":"#/components/schemas/LeaveApplications"}}},"description":"search results matching criteria"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIException"}}},"description":"validation error for a bad request"}},"security":[{"OAuth2":["payroll.leaveapplications.read"]}],"summary":"Retrieves leave applications","tags":["PayrollAu"]},"parameters":[{"$ref":"#/components/parameters/requiredHeader"}],"post":{"operationId":"createLeaveApplication","requestBody":{"content":{"application/json":{"example":"[ { \"EmployeeID\": \"cdfb8371-0b21-4b8a-8903-1024df6c391e\", \"LeaveTypeID\": \"184ea8f7-d143-46dd-bef3-0c60e1aa6fca\", \"Title\": \"Hello World\", \"StartDate\": \"/Date(1572559200000+0000)/\", \"EndDate\": \"/Date(1572645600000+0000)/\" } ]","schema":{"items":{"$ref":"#/components/schemas/LeaveApplication"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":"{ \"Id\": \"7bbc3541-befd-482e-a6a3-a8cf7a93461e\", \"Status\": \"OK\", \"ProviderName\": \"java-sdk-oauth2-dev-02\", \"DateTimeUTC\": \"/Date(1573679791917)/\", \"LeaveApplications\": [ { \"LeaveApplicationID\": \"5f7097e4-51f2-46cc-921b-45bc73ea7831\", \"EmployeeID\": \"cdfb8371-0b21-4b8a-8903-1024df6c391e\", \"LeaveTypeID\": \"184ea8f7-d143-46dd-bef3-0c60e1aa6fca\", \"LeavePeriods\": [ { \"PayPeriodStartDate\": \"/Date(1572566400000+0000)/\", \"PayPeriodEndDate\": \"/Date(1573084800000+0000)/\", \"LeavePeriodStatus\": \"SCHEDULED\", \"NumberOfUnits\": 0.6 } ], \"Title\": \"Hello World\", \"StartDate\": \"/Date(1572559200000+0000)/\", \"EndDate\": \"/Date(1572645600000+0000)/\", \"UpdatedDateUTC\": \"/Date(1573679791897+0000)/\" } ] }","schema":{"$ref":"#/components/schemas/LeaveApplications"}}},"description":"A successful request"},"400":{"description":"invalid input, object invalid - TODO"}},"security":[{"OAuth2":["payroll.leaveapplications"]}],"summary":"Creates a leave application","tags":["PayrollAu"],"x-hasPayrollAuProblem":true}},"/LeaveApplications/{LeaveApplicationID}":{"get":{"operationId":"getLeaveApplication","parameters":[{"description":"Leave Application id for single object","in":"path","name":"LeaveApplicationID","required":true,"schema":{"example":"4ff1e5cc-9835-40d5-bb18-09fdb118db9c","format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":"{ \"Id\": \"071dafb9-0d50-48b2-8ee4-b48d3f3c119d\", \"Status\": \"OK\", \"ProviderName\": \"java-sdk-oauth2-dev-02\", \"DateTimeUTC\": \"/Date(1573679791457)/\", \"LeaveApplications\": [ { \"LeaveApplicationID\": \"1d4cd583-0107-4386-936b-672eb3d1f624\", \"EmployeeID\": \"cdfb8371-0b21-4b8a-8903-1024df6c391e\", \"LeaveTypeID\": \"184ea8f7-d143-46dd-bef3-0c60e1aa6fca\", \"LeavePeriods\": [ { \"PayPeriodStartDate\": \"/Date(1573171200000+0000)/\", \"PayPeriodEndDate\": \"/Date(1573689600000+0000)/\", \"LeavePeriodStatus\": \"SCHEDULED\", \"NumberOfUnits\": 0 } ], \"Title\": \"vacation\", \"StartDate\": \"/Date(1573516800000+0000)/\", \"EndDate\": \"/Date(1573516800000+0000)/\", \"UpdatedDateUTC\": \"/Date(1573623008000+0000)/\" } ] }","schema":{"$ref":"#/components/schemas/LeaveApplications"}}},"description":"search results matching criteria"}},"security":[{"OAuth2":["payroll.leaveapplications.read"]}],"summary":"Retrieves a leave application by a unique leave application id","tags":["PayrollAu"]},"parameters":[{"$ref":"#/components/parameters/requiredHeader"}],"post":{"operationId":"updateLeaveApplication","parameters":[{"description":"Leave Application id for single object","in":"path","name":"LeaveApplicationID","required":true,"schema":{"example":"4ff1e5cc-9835-40d5-bb18-09fdb118db9c","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"example":"[ { \"EmployeeID\": \"cdfb8371-0b21-4b8a-8903-1024df6c391e\", \"LeaveTypeID\": \"184ea8f7-d143-46dd-bef3-0c60e1aa6fca\", \"StartDate\": \"/Date(1572559200000+0000)/\", \"EndDate\": \"/Date(1572645600000+0000)/\", \"Description\": \"My updated Description\" } ]","schema":{"items":{"$ref":"#/components/schemas/LeaveApplication"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":"{ \"Id\": \"9ebc7d7a-e188-4b31-bb2c-1ab9421b82c4\", \"Status\": \"OK\", \"ProviderName\": \"3f93110a-df13-49c7-b82f-a069813df188\", \"DateTimeUTC\": \"/Date(1573679792293)/\", \"LeaveApplications\": [ { \"LeaveApplicationID\": \"1d4cd583-0107-4386-936b-672eb3d1f624\", \"EmployeeID\": \"cdfb8371-0b21-4b8a-8903-1024df6c391e\", \"LeaveTypeID\": \"184ea8f7-d143-46dd-bef3-0c60e1aa6fca\", \"LeavePeriods\": [ { \"PayPeriodStartDate\": \"/Date(1572566400000+0000)/\", \"PayPeriodEndDate\": \"/Date(1573084800000+0000)/\", \"LeavePeriodStatus\": \"SCHEDULED\", \"NumberOfUnits\": 0.6 } ], \"Title\": \"vacation\", \"Description\": \"My updated Description\", \"StartDate\": \"/Date(1572559200000+0000)/\", \"EndDate\": \"/Date(1572645600000+0000)/\", \"UpdatedDateUTC\": \"/Date(1573679792293+0000)/\" } ] }","schema":{"$ref":"#/components/schemas/LeaveApplications"}}},"description":"A successful request"},"400":{"description":"invalid input, object invalid - TODO"}},"security":[{"OAuth2":["payroll.leaveapplications"]}],"summary":"Updates a specific leave application","tags":["PayrollAu"]}},"/PayItems":{"get":{"operationId":"getPayItems","parameters":[{"description":"Only records created or modified since this timestamp will be returned","in":"header","name":"If-Modified-Since","schema":{"type":"string"}},{"description":"Filter by an any element","example":"Status==\"ACTIVE\"","in":"query","name":"where","schema":{"type":"string"}},{"description":"Order by an any element","example":"EmailAddress%20DESC","in":"query","name":"order","schema":{"type":"string"}},{"description":"e.g. page=1 – Up to 100 objects will be returned in a single API call","in":"query","name":"page","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":"{ \"Id\": \"add39c3e-f397-45fb-aa4f-af1095ec7f65\", \"Status\": \"OK\", \"ProviderName\": \"java-sdk-oauth2-dev-02\", \"DateTimeUTC\": \"/Date(1573620869531)/\", \"PayItems\": { \"EarningsRates\": [ { \"EarningsRateID\": \"ab874dfb-ab09-4c91-954e-43acf6fc23b4\", \"Name\": \"Ordinary Hours\", \"EarningsType\": \"ORDINARYTIMEEARNINGS\", \"RateType\": \"RATEPERUNIT\", \"AccountCode\": \"477\", \"TypeOfUnits\": \"Hours\", \"RatePerUnit\": 3, \"IsExemptFromTax\": true, \"IsExemptFromSuper\": true, \"IsReportableAsW1\": true, \"UpdatedDateUTC\": \"/Date(1573620821000+0000)/\", \"CurrentRecord\": true }, { \"EarningsRateID\": \"dc3ff92e-0e49-4967-aa4b-0bb21c0594ce\", \"Name\": \"Overtime Hours (exempt from super)\", \"EarningsType\": \"OVERTIMEEARNINGS\", \"RateType\": \"RATEPERUNIT\", \"AccountCode\": \"477\", \"TypeOfUnits\": \"Hours\", \"IsExemptFromTax\": false, \"IsExemptFromSuper\": true, \"IsReportableAsW1\": false, \"UpdatedDateUTC\": \"/Date(1547500330000+0000)/\", \"CurrentRecord\": true }, { \"EarningsRateID\": \"f59999ca-cd5c-4a54-a381-2d0c817f0c3e\", \"Name\": \"Redundancy\", \"EarningsType\": \"LUMPSUMD\", \"RateType\": \"FIXEDAMOUNT\", \"AccountCode\": \"477\", \"IsExemptFromTax\": true, \"IsExemptFromSuper\": true, \"IsReportableAsW1\": true, \"UpdatedDateUTC\": \"/Date(1547500330000+0000)/\", \"CurrentRecord\": true }, { \"EarningsRateID\": \"c97dafac-9d99-406f-9f6c-abfaf81c527d\", \"Name\": \"ETP Leave Earning\", \"EarningsType\": \"EMPLOYMENTTERMINATIONPAYMENT\", \"RateType\": \"RATEPERUNIT\", \"AccountCode\": \"477\", \"TypeOfUnits\": \"Hours\", \"IsExemptFromTax\": false, \"IsExemptFromSuper\": true, \"IsReportableAsW1\": true, \"UpdatedDateUTC\": \"/Date(1573620791000+0000)/\", \"EmploymentTerminationPaymentType\": \"O\", \"CurrentRecord\": true } ], \"DeductionTypes\": [ { \"DeductionTypeID\": \"727af5e8-b347-4ae7-85fc-9b82266d0aec\", \"DeductionCategory\": \"UNIONFEES\", \"Name\": \"Union Fees/Subscriptions\", \"AccountCode\": \"850\", \"ReducesTax\": false, \"ReducesSuper\": false, \"IsExemptFromW1\": false, \"UpdatedDateUTC\": \"/Date(1547500330000+0000)/\", \"CurrentRecord\": true }, { \"DeductionTypeID\": \"04191cd3-7952-4a87-9911-9d8575280f6a\", \"DeductionCategory\": \"NONE\", \"Name\": \"Lease Payments\", \"AccountCode\": \"850\", \"ReducesTax\": true, \"ReducesSuper\": true, \"IsExemptFromW1\": false, \"UpdatedDateUTC\": \"/Date(1547500330000+0000)/\", \"CurrentRecord\": true } ], \"ReimbursementTypes\": [ { \"ReimbursementTypeID\": \"98ba33b2-db5b-4204-bcac-5ddd98d63524\", \"Name\": \"Travel Costs\", \"AccountCode\": \"850\", \"UpdatedDateUTC\": \"/Date(1547500330000+0000)/\", \"CurrentRecord\": true }, { \"ReimbursementTypeID\": \"aa8cfa40-d872-4be0-8a94-bb7f00962f74\", \"Name\": \"Other Reimbursable Costs\", \"AccountCode\": \"850\", \"UpdatedDateUTC\": \"/Date(1547500330000+0000)/\", \"CurrentRecord\": true } ], \"LeaveTypes\": [ { \"LeaveTypeID\": \"fbcc9dab-6238-43d9-a3f4-d768423fdcfa\", \"Name\": \"Annual Leave\", \"TypeOfUnits\": \"Hours\", \"NormalEntitlement\": 152, \"LeaveLoadingRate\": 1.0, \"IsPaidLeave\": true, \"ShowOnPayslip\": true, \"UpdatedDateUTC\": \"/Date(1573620853000+0000)/\", \"CurrentRecord\": true }, { \"LeaveTypeID\": \"74195ab2-1f2b-4136-8ddc-20387a0b1027\", \"Name\": \"Long Service Leave\", \"TypeOfUnits\": \"Hours\", \"IsPaidLeave\": true, \"ShowOnPayslip\": false, \"UpdatedDateUTC\": \"/Date(1547500330000+0000)/\", \"CurrentRecord\": true }, { \"LeaveTypeID\": \"ff4d16da-ae8a-4f57-acb3-9ee593996bce\", \"Name\": \"Parental Leave (unpaid)\", \"TypeOfUnits\": \"Hours\", \"IsPaidLeave\": false, \"ShowOnPayslip\": false, \"UpdatedDateUTC\": \"/Date(1547500330000+0000)/\", \"CurrentRecord\": true } ] } }","schema":{"$ref":"#/components/schemas/PayItems"}}},"description":"search results matching criteria"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIException"}}},"description":"validation error for a bad request"}},"security":[{"OAuth2":["payroll.payitems.read"]}],"summary":"Retrieves pay items","tags":["PayrollAu"]},"parameters":[{"$ref":"#/components/parameters/requiredHeader"}],"post":{"operationId":"createPayItem","requestBody":{"content":{"application/json":{"example":"{ \"EarningsRates\": [ { \"Name\": \"MyRate\", \"AccountCode\": \"400\", \"TypeOfUnits\": \"4.00\", \"IsExemptFromTax\": true, \"IsExemptFromSuper\": true, \"IsReportableAsW1\": false, \"EarningsType\": \"ORDINARYTIMEEARNINGS\", \"EarningsRateID\": \"1fa4e226-b711-46ba-a8a7-4344c9c5fb87\", \"RateType\": \"MULTIPLE\", \"RatePerUnit\": \"10.0\", \"Multiplier\": 1.5, \"Amount\": 5, \"EmploymentTerminationPaymentType\": \"O\" } ] }","schema":{"$ref":"#/components/schemas/PayItem"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":"{ \"Id\": \"8c15b526-ea07-42e6-9351-1fa00a9516ea\", \"Status\": \"OK\", \"ProviderName\": \"java-sdk-oauth2-dev-02\", \"DateTimeUTC\": \"/Date(1593448963288)/\", \"PayItems\": { \"EarningsRates\": [ { \"EarningsRateID\": \"1fa4e226-b711-46ba-a8a7-4344c9c5fb87\", \"Name\": \"MyRate\", \"EarningsType\": \"ORDINARYTIMEEARNINGS\", \"RateType\": \"MULTIPLE\", \"AccountCode\": \"400\", \"Multiplier\": 1.5, \"IsExemptFromTax\": true, \"IsExemptFromSuper\": true, \"AccrueLeave\": false, \"IsReportableAsW1\": false, \"UpdatedDateUTC\": \"/Date(1593448963210+0000)/\", \"CurrentRecord\": true }, { \"EarningsRateID\": \"c6905c26-0716-4746-9098-608545e04dd2\", \"Name\": \"Redundancy\", \"EarningsType\": \"LUMPSUMD\", \"RateType\": \"FIXEDAMOUNT\", \"AccountCode\": \"477\", \"IsExemptFromTax\": true, \"IsExemptFromSuper\": true, \"IsReportableAsW1\": true, \"UpdatedDateUTC\": \"/Date(1476729649000+0000)/\", \"CurrentRecord\": true }, { \"EarningsRateID\": \"33820094-656e-4db3-b04b-8bd3e2db0a9b\", \"Name\": \"ETP Leave Earning\", \"EarningsType\": \"EMPLOYMENTTERMINATIONPAYMENT\", \"RateType\": \"RATEPERUNIT\", \"AccountCode\": \"477\", \"TypeOfUnits\": \"Hours\", \"IsExemptFromTax\": false, \"IsExemptFromSuper\": true, \"IsReportableAsW1\": true, \"UpdatedDateUTC\": \"/Date(1520900705000+0000)/\", \"EmploymentTerminationPaymentType\": \"O\", \"CurrentRecord\": true } ] } }","schema":{"$ref":"#/components/schemas/PayItems"}}},"description":"A successful request - currently returns empty array for JSON"},"400":{"description":"invalid input, object invalid - TODO"}},"security":[{"OAuth2":["payroll.payitems"]}],"summary":"Creates a pay item","tags":["PayrollAu"]}},"/PayRuns":{"get":{"operationId":"getPayRuns","parameters":[{"description":"Only records created or modified since this timestamp will be returned","in":"header","name":"If-Modified-Since","schema":{"type":"string"}},{"description":"Filter by an any element","example":"Status==\"ACTIVE\"","in":"query","name":"where","schema":{"type":"string"}},{"description":"Order by an any element","example":"EmailAddress%20DESC","in":"query","name":"order","schema":{"type":"string"}},{"description":"e.g. page=1 – Up to 100 PayRuns will be returned in a single API call","in":"query","name":"page","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":"{ \"Id\":\"31a0c577-5cb0-4c19-a1f5-9f4d6de951d4\", \"Status\":\"OK\", \"ProviderName\":\"java-sdk-oauth2-dev-02\", \"DateTimeUTC\":\"\\/Date(1573611063074)\\/\", \"PayRuns\":[ { \"PayRunID\":\"5de420bb-4ad2-405c-beb1-2610bcc2144e\", \"PayrollCalendarID\":\"78bb86b9-e1ea-47ac-b75d-f087a81931de\", \"PayRunPeriodStartDate\":\"\\/Date(1572566400000+0000)\\/\", \"PayRunPeriodEndDate\":\"\\/Date(1573084800000+0000)\\/\", \"PaymentDate\":\"\\/Date(1573171200000+0000)\\/\", \"Wages\":200.00, \"Deductions\":33.00, \"Tax\":78.00, \"Super\":0.00, \"Reimbursement\":22.00, \"NetPay\":89.00, \"PayRunStatus\":\"POSTED\", \"UpdatedDateUTC\":\"\\/Date(1573610970000+0000)\\/\" } ] }","schema":{"$ref":"#/components/schemas/PayRuns"}}},"description":"search results matching criteria"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIException"}}},"description":"validation error for a bad request"}},"security":[{"OAuth2":["payroll.payruns.read"]}],"summary":"Retrieves pay runs","tags":["PayrollAu"]},"parameters":[{"$ref":"#/components/parameters/requiredHeader"}],"post":{"operationId":"createPayRun","requestBody":{"content":{"application/json":{"example":"[ { \"PayrollCalendarID\": \"78bb86b9-e1ea-47ac-b75d-f087a81931de\", \"PayRunPeriodStartDate\": \"/Date(1572566400000+0000)/\", \"PayRunPeriodEndDate\": \"/Date(1573084800000+0000)/\", \"PayRunStatus\": \"DRAFT\", \"PaymentDate\": \"/Date(1573171200000+0000)/\" } ]","schema":{"items":{"$ref":"#/components/schemas/PayRun"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":"{ \"Id\": \"386f86d9-ae93-4a1d-9a10-eb46495c1184\", \"Status\": \"OK\", \"ProviderName\": \"java-sdk-oauth2-dev-02\", \"DateTimeUTC\": \"/Date(1573685818311)/\", \"PayRuns\": [ { \"PayRunID\": \"d1348fab-f47a-4697-beea-922ee262407a\", \"PayrollCalendarID\": \"78bb86b9-e1ea-47ac-b75d-f087a81931de\", \"PayRunPeriodStartDate\": \"/Date(1572566400000+0000)/\", \"PayRunPeriodEndDate\": \"/Date(1573084800000+0000)/\", \"PaymentDate\": \"/Date(1573171200000+0000)/\", \"PayRunStatus\": \"DRAFT\", \"UpdatedDateUTC\": \"/Date(1573685818311+0000)/\" } ] }","schema":{"$ref":"#/components/schemas/PayRuns"}}},"description":"A successful request"},"400":{"description":"invalid input, object invalid - TODO"}},"security":[{"OAuth2":["payroll.payruns"]}],"summary":"Creates a pay run","tags":["PayrollAu"],"x-hasPayrollAuProblem":true}},"/PayRuns/{PayRunID}":{"get":{"operationId":"getPayRun","parameters":[{"description":"PayRun id for single object","in":"path","name":"PayRunID","required":true,"schema":{"example":"4ff1e5cc-9835-40d5-bb18-09fdb118db9c","format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":"{ \"Id\": \"d31f4401-875e-4a0c-9952-d5dd18519150\", \"Status\": \"OK\", \"ProviderName\": \"java-sdk-oauth2-dev-02\", \"DateTimeUTC\": \"/Date(1573692531699)/\", \"PayRuns\": [ { \"PayRunID\": \"21d6317b-5319-4b3d-8d78-48904db6b665\", \"PayrollCalendarID\": \"78bb86b9-e1ea-47ac-b75d-f087a81931de\", \"PayRunPeriodStartDate\": \"/Date(1572566400000+0000)/\", \"PayRunPeriodEndDate\": \"/Date(1573084800000+0000)/\", \"PaymentDate\": \"/Date(1573171200000+0000)/\", \"Wages\": 205.4, \"Deductions\": 37, \"Tax\": 0, \"Super\": 0, \"Reimbursement\": 77, \"NetPay\": 168.4, \"PayRunStatus\": \"POSTED\", \"UpdatedDateUTC\": \"/Date(1573692155000+0000)/\", \"Payslips\": [ { \"EmployeeID\": \"cdfb8371-0b21-4b8a-8903-1024df6c391e\", \"PayslipID\": \"c81e8bcc-56b0-4740-b46b-767753a6ee45\", \"FirstName\": \"Albus\", \"LastName\": \"Dumbledore\", \"EmployeeGroup\": \"foo\", \"Wages\": 5.4, \"Deductions\": 4, \"Tax\": 0, \"Super\": 0, \"Reimbursements\": 55, \"NetPay\": 1.4, \"UpdatedDateUTC\": \"/Date(1573692155000+0000)/\" }, { \"EmployeeID\": \"7aa04979-ded5-44d9-b09a-793749425844\", \"PayslipID\": \"76b9cb4e-d024-47cf-b09a-4c9cea2870f1\", \"FirstName\": \"John\", \"LastName\": \"Smith\", \"Wages\": 200, \"Deductions\": 33, \"Tax\": 0, \"Super\": 0, \"Reimbursements\": 22, \"NetPay\": 167, \"UpdatedDateUTC\": \"/Date(1573692155000+0000)/\" } ] } ] }","schema":{"$ref":"#/components/schemas/PayRuns"}}},"description":"search results matching criteria"}},"security":[{"OAuth2":["payroll.payruns.read"]}],"summary":"Retrieves a pay run by using a unique pay run id","tags":["PayrollAu"]},"parameters":[{"$ref":"#/components/parameters/requiredHeader"}],"post":{"description":"Update properties on a single PayRun","operationId":"updatePayRun","parameters":[{"description":"PayRun id for single object","in":"path","name":"PayRunID","required":true,"schema":{"example":"4ff1e5cc-9835-40d5-bb18-09fdb118db9c","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"example":"[ { \"PayRunStatus\": \"POSTED\" } ]","items":{"$ref":"#/components/schemas/PayRun"},"type":"array"}}}},"responses":{"200":{"content":{"application/json":{"example":"{ \"Id\": \"7ad056f9-7dbd-4b66-bf11-1bb86d5aec92\", \"Status\": \"OK\", \"ProviderName\": \"java-sdk-oauth2-dev-02\", \"DateTimeUTC\": \"/Date(1573693093680)/\", \"PayRuns\": [ { \"PayRunID\": \"f8fcda54-643f-4406-902a-d7b020d0a036\", \"PayrollCalendarID\": \"78bb86b9-e1ea-47ac-b75d-f087a81931de\", \"PayRunPeriodStartDate\": \"/Date(1572566400000+0000)/\", \"PayRunPeriodEndDate\": \"/Date(1573084800000+0000)/\", \"PaymentDate\": \"/Date(1573171200000+0000)/\", \"PayRunStatus\": \"POSTED\", \"UpdatedDateUTC\": \"/Date(1573693093000+0000)/\" } ] }","schema":{"$ref":"#/components/schemas/PayRuns"}}},"description":"A successful request"}},"security":[{"OAuth2":["payroll.payruns"]}],"summary":"Updates a pay run","tags":["PayrollAu"]}},"/PayrollCalendars":{"get":{"operationId":"getPayrollCalendars","parameters":[{"description":"Only records created or modified since this timestamp will be returned","in":"header","name":"If-Modified-Since","schema":{"type":"string"}},{"description":"Filter by an any element","example":"Status==\"ACTIVE\"","in":"query","name":"where","schema":{"type":"string"}},{"description":"Order by an any element","example":"EmailAddress%20DESC","in":"query","name":"order","schema":{"type":"string"}},{"description":"e.g. page=1 – Up to 100 objects will be returned in a single API call","in":"query","name":"page","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":"{ \"Id\":\"a89fb36b-c573-42d8-88db-a947cbd6af5a\", \"Status\":\"OK\", \"ProviderName\":\"java-sdk-oauth2-dev-02\", \"DateTimeUTC\":\"\\/Date(1573611063408)\\/\", \"PayrollCalendars\":[ { \"PayrollCalendarID\":\"78bb86b9-e1ea-47ac-b75d-f087a81931de\", \"Name\":\"Sid Weekly\", \"CalendarType\":\"WEEKLY\", \"StartDate\":\"\\/Date(1573171200000+0000)\\/\", \"PaymentDate\":\"\\/Date(1573776000000+0000)\\/\", \"UpdatedDateUTC\":\"\\/Date(1573077687000+0000)\\/\" }, { \"PayrollCalendarID\":\"22a05fc5-386d-4950-9842-3e7a6c812135\", \"Name\":\"Weekly\", \"CalendarType\":\"WEEKLY\", \"StartDate\":\"\\/Date(1546560000000+0000)\\/\", \"PaymentDate\":\"\\/Date(1547164800000+0000)\\/\", \"UpdatedDateUTC\":\"\\/Date(1572916157000+0000)\\/\" } ] }","schema":{"$ref":"#/components/schemas/PayrollCalendars"}}},"description":"search results matching criteria"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIException"}}},"description":"validation error for a bad request"}},"security":[{"OAuth2":["payroll.payrollcalendars.read"]}],"summary":"Retrieves payroll calendars","tags":["PayrollAu"]},"parameters":[{"$ref":"#/components/parameters/requiredHeader"}],"post":{"operationId":"createPayrollCalendar","requestBody":{"content":{"application/json":{"example":"[ { \"PayrollCalendarID\":\"78bb86b9-e1ea-47ac-b75d-f087a81931de\", \"PayRunPeriodStartDate\":\"/Date(1572566400000+0000)/\", \"PayRunPeriodEndDate\":\"/Date(1573084800000+0000)/\", \"PayRunStatus\":\"DRAFT\", \"PaymentDate\":\"/Date(1573171200000+0000)/\" } ]","schema":{"items":{"$ref":"#/components/schemas/PayrollCalendar"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":"{ \"Id\":\"113db83f-1769-4352-a097-7ac5c333aa40\", \"Status\":\"OK\", \"ProviderName\":\"java-sdk-oauth2-dev-02\", \"DateTimeUTC\":\"\\/Date(1584125518649)\\/\", \"PayrollCalendars\":[ { \"PayrollCalendarID\":\"57accbfe-f729-4be3-b3cb-8c3445c61d3a\", \"Name\":\"MyCal37127\", \"CalendarType\":\"WEEKLY\", \"StartDate\":\"\\/Date(1572998400000+0000)\\/\", \"PaymentDate\":\"\\/Date(1573516800000+0000)\\/\", \"UpdatedDateUTC\":\"\\/Date(1584125518633+0000)\\/\" } ] }","schema":{"$ref":"#/components/schemas/PayrollCalendars"}}},"description":"A successful request"},"400":{"description":"invalid input, object invalid - TODO"}},"security":[{"OAuth2":["payroll.payrollcalendars"]}],"summary":"Creates a Payroll Calendar","tags":["PayrollAu"],"x-hasPayrollAuProblem":true}},"/PayrollCalendars/{PayrollCalendarID}":{"get":{"operationId":"getPayrollCalendar","parameters":[{"description":"Payroll Calendar id for single object","in":"path","name":"PayrollCalendarID","required":true,"schema":{"example":"4ff1e5cc-9835-40d5-bb18-09fdb118db9c","format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":"{ \"Id\":\"8283e501-2a7f-4080-b3c9-579a51b55b94\", \"Status\":\"OK\", \"ProviderName\":\"java-sdk-oauth2-dev-02\", \"DateTimeUTC\":\"\\/Date(1573611453008)\\/\", \"PayrollCalendars\":[ { \"PayrollCalendarID\":\"78bb86b9-e1ea-47ac-b75d-f087a81931de\", \"Name\":\"Sid Weekly\", \"CalendarType\":\"WEEKLY\", \"StartDate\":\"\\/Date(1573171200000+0000)\\/\", \"PaymentDate\":\"\\/Date(1573776000000+0000)\\/\", \"UpdatedDateUTC\":\"\\/Date(1573077687000+0000)\\/\" } ] }","schema":{"$ref":"#/components/schemas/PayrollCalendars"}}},"description":"search results matching criteria"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIException"}}},"description":"validation error for a bad request"}},"security":[{"OAuth2":["payroll.payrollcalendars.read"]}],"summary":"Retrieves payroll calendar by using a unique payroll calendar ID","tags":["PayrollAu"]},"parameters":[{"$ref":"#/components/parameters/requiredHeader"}]},"/Payslip/{PayslipID}":{"get":{"operationId":"getPayslip","parameters":[{"description":"Payslip id for single object","in":"path","name":"PayslipID","required":true,"schema":{"example":"4ff1e5cc-9835-40d5-bb18-09fdb118db9c","format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":"{ \"Id\": \"cd64816e-af39-4708-879c-4b6c8061abb2\", \"Status\": \"OK\", \"ProviderName\": \"java-sdk-oauth2-dev-02\", \"DateTimeUTC\": \"/Date(1573692677622)/\", \"Payslip\": { \"EmployeeID\": \"cdfb8371-0b21-4b8a-8903-1024df6c391e\", \"PayslipID\": \"c81e8bcc-56b0-4740-b46b-767753a6ee45\", \"FirstName\": \"Albus\", \"LastName\": \"Dumbledore\", \"Tax\": 0, \"NetPay\": 1.4, \"UpdatedDateUTC\": \"/Date(1573692155000+0000)/\", \"EarningsLines\": [ { \"EarningsRateID\": \"ab874dfb-ab09-4c91-954e-43acf6fc23b4\", \"RatePerUnit\": 3, \"NumberOfUnits\": 1.8 } ], \"LeaveEarningsLines\": [ { \"EarningsRateID\": \"ab874dfb-ab09-4c91-954e-43acf6fc23b4\", \"RatePerUnit\": 0, \"NumberOfUnits\": 0.6 }, { \"EarningsRateID\": \"ab874dfb-ab09-4c91-954e-43acf6fc23b4\", \"RatePerUnit\": 0, \"NumberOfUnits\": 0.6 } ], \"TimesheetEarningsLines\": [], \"DeductionLines\": [ { \"Amount\": 4, \"CalculationType\": \"FIXEDAMOUNT\", \"DeductionTypeID\": \"ed05ea82-e40a-4eb6-9c2e-4b3c03e7e938\" } ], \"LeaveAccrualLines\": [ { \"LeaveTypeID\": \"184ea8f7-d143-46dd-bef3-0c60e1aa6fca\", \"NumberOfUnits\": 0.0769, \"AutoCalculate\": true } ], \"ReimbursementLines\": [ { \"ReimbursementTypeID\": \"aa8cfa40-d872-4be0-8a94-bb7f00962f74\", \"Description\": \"boo\", \"ExpenseAccount\": \"850\", \"Amount\": 55 } ], \"SuperannuationLines\": [ { \"ContributionType\": \"SGC\", \"CalculationType\": \"STATUTORY\", \"MinimumMonthlyEarnings\": 450, \"ExpenseAccountCode\": \"478\", \"LiabilityAccountCode\": \"826\", \"PaymentDateForThisPeriod\": \"/Date(1580169600000+0000)/\", \"Amount\": 0 } ], \"TaxLines\": [ { \"PayslipTaxLineID\": \"c129696e-36ef-4677-a54c-96095787ca20\", \"TaxTypeName\": \"PAYG Tax\", \"Description\": \"No tax file number (Australian resident)\", \"Amount\": 0, \"LiabilityAccount\": \"825\" } ] } }","schema":{"$ref":"#/components/schemas/PayslipObject"}}},"description":"search results matching criteria"}},"security":[{"OAuth2":["payroll.payslip.read"]}],"summary":"Retrieves for a payslip by a unique payslip id","tags":["PayrollAu"]},"parameters":[{"$ref":"#/components/parameters/requiredHeader"}],"post":{"description":"Update lines on a single payslips","operationId":"updatePayslip","parameters":[{"description":"Payslip id for single object","in":"path","name":"PayslipID","required":true,"schema":{"example":"4ff1e5cc-9835-40d5-bb18-09fdb118db9c","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"example":"{ \"Payslip\": { \"EmployeeID\": \"cdfb8371-0b21-4b8a-8903-1024df6c391e\", \"DeductionLines\": [ { \"DeductionTypeID\": \"727af5e8-b347-4ae7-85fc-9b82266d0aec\", \"CalculationType\": \"FIXEDAMOUNT\", \"NumberOfUnits\": 10 } ] } }","schema":{"items":{"$ref":"#/components/schemas/PayslipLines"},"type":"array"}}}},"responses":{"200":{"content":{"application/json":{"example":"{ \"Id\": \"6ba774cb-7db6-4c8e-ba13-5342b5ce6cc3\", \"Status\": \"OK\", \"ProviderName\": \"java-sdk-oauth2-dev-02\", \"DateTimeUTC\": \"/Date(1589568253813)/\", \"Payslips\": [ { \"EmployeeID\": \"cdfb8371-0b21-4b8a-8903-1024df6c391e\", \"PayslipID\": \"c81e8bcc-56b0-4740-b46b-767753a6ee45\", \"FirstName\": \"Albus\", \"LastName\": \"Dumbledore\", \"LastEdited\": \"/Date(1589568253735+0000)/\", \"Tax\": 0, \"NetPay\": 1.4, \"UpdatedDateUTC\": \"/Date(1589568253735+0000)/\", \"DeductionLines\": [ { \"Amount\": 4, \"CalculationType\": \"FIXEDAMOUNT\", \"DeductionTypeID\": \"ed05ea82-e40a-4eb6-9c2e-4b3c03e7e938\" } ] } ] }","schema":{"$ref":"#/components/schemas/Payslips"}}},"description":"A successful request - currently returns empty array for JSON"}},"security":[{"OAuth2":["payroll.payslip"]}],"summary":"Updates a payslip","tags":["PayrollAu"],"x-hasPayrollAuError":true}},"/Settings":{"get":{"operationId":"getSettings","responses":{"200":{"content":{"application/json":{"example":"{ \"Id\":\"898a22ce-41d6-4553-b0b3-4cd486332dde\", \"Status\":\"OK\", \"ProviderName\":\"java-sdk-oauth2-dev-02\", \"DateTimeUTC\":\"\\/Date(1573585252781)\\/\", \"Settings\":{ \"Accounts\":[ { \"AccountID\":\"85bd2954-7ef5-4fbe-9e40-a1990d0fd63f\", \"Type\":\"BANK\", \"Code\":\"094\", \"Name\":\"Bank of A\" }, { \"AccountID\":\"7e65fa75-1c64-43d7-b0b4-c05f196e2190\", \"Type\":\"WAGESPAYABLELIABILITY\", \"Code\":\"804\", \"Name\":\"Wages Payable - Payroll\" }, { \"AccountID\":\"dbc164fa-0cdf-4848-92d3-0d1dc864c53f\", \"Type\":\"PAYGLIABILITY\", \"Code\":\"825\", \"Name\":\"PAYG Withholdings Payable\" }, { \"AccountID\":\"7dad84d4-bc7a-482e-99b1-d879e4856578\", \"Type\":\"SUPERANNUATIONEXPENSE\", \"Code\":\"478\", \"Name\":\"Superannuation\" }, { \"AccountID\":\"df3679fe-5ebc-42ce-a7ac-b4d36b520795\", \"Type\":\"SUPERANNUATIONLIABILITY\", \"Code\":\"826\", \"Name\":\"Superannuation Payable\" }, { \"AccountID\":\"7e130864-5864-4c60-94eb-3c53c95da138\", \"Type\":\"WAGESEXPENSE\", \"Code\":\"477\", \"Name\":\"Wages and Salaries\" } ], \"TrackingCategories\":{ \"EmployeeGroups\":{ \"TrackingCategoryID\":\"a28f419f-6ec3-4dcf-9be0-7959ea983630\", \"TrackingCategoryName\":\"Foo70317\" }, \"TimesheetCategories\":{ \"TrackingCategoryID\":\"89375aed-ed51-4624-9e5d-92db6bfa8974\", \"TrackingCategoryName\":\"Foo32551\" } }, \"DaysInPayrollYear\":\"364\" } }","schema":{"$ref":"#/components/schemas/SettingsObject"}}},"description":"payroll settings"}},"security":[{"OAuth2":["payroll.settings.read"]}],"summary":"Retrieves payroll settings","tags":["PayrollAu"]},"parameters":[{"$ref":"#/components/parameters/requiredHeader"}]},"/SuperfundProducts":{"get":{"operationId":"getSuperfundProducts","parameters":[{"description":"The ABN of the Regulated SuperFund","example":40022701955,"in":"query","name":"ABN","schema":{"type":"string"}},{"description":"The USI of the Regulated SuperFund","example":"OSF0001AU","in":"query","name":"USI","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":"{ \"Id\":\"d1c101ee-2fd8-47a3-ad3d-bbc64139181c\", \"Status\":\"OK\", \"ProviderName\":\"java-sdk-oauth2-dev-02\", \"DateTimeUTC\":\"\\/Date(1573570720295)\\/\", \"SuperFundProducts\":[ { \"USI\":\"OSF0001AU\", \"ABN\":\"24248426878\", \"ProductName\":\"Accumulate Plus (Commonwealth Bank Group Super)\" } ] }","schema":{"$ref":"#/components/schemas/SuperFundProducts"}}},"description":"search results matching criteria"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIException"}}},"description":"validation error for a bad request"}},"security":[{"OAuth2":["payroll.superfundproducts.read"]}],"summary":"Retrieves superfund products","tags":["PayrollAu"]},"parameters":[{"$ref":"#/components/parameters/requiredHeader"}]},"/Superfunds":{"get":{"operationId":"getSuperfunds","parameters":[{"description":"Only records created or modified since this timestamp will be returned","in":"header","name":"If-Modified-Since","schema":{"type":"string"}},{"description":"Filter by an any element","example":"Status==\"ACTIVE\"","in":"query","name":"where","schema":{"type":"string"}},{"description":"Order by an any element","example":"EmailAddress%20DESC","in":"query","name":"order","schema":{"type":"string"}},{"description":"e.g. page=1 – Up to 100 SuperFunds will be returned in a single API call","in":"query","name":"page","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":"{ \"Id\":\"c5f5e907-e562-463c-b15c-1d6185fbb779\", \"Status\":\"OK\", \"ProviderName\":\"java-sdk-oauth2-dev-02\", \"DateTimeUTC\":\"\\/Date(1573570941142)\\/\", \"SuperFunds\":[ { \"SuperFundID\":\"fde8e070-bf59-4e56-b1d7-c75a09474b8d\", \"Name\":\"Accumulate Plus (Commonwealth Bank Group Super)\", \"Type\":\"REGULATED\", \"USI\":\"OSF0001AU\", \"UpdatedDateUTC\":\"\\/Date(1573510468000+0000)\\/\" }, { \"SuperFundID\":\"69079de5-67ef-43bb-b5a5-3e7c2ccad7f0\", \"Name\":\"AMG Super\", \"Type\":\"REGULATED\", \"USI\":\"PTC0133AU\", \"UpdatedDateUTC\":\"\\/Date(1573490487000+0000)\\/\" } ] }","schema":{"$ref":"#/components/schemas/SuperFunds"}}},"description":"search results matching criteria"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIException"}}},"description":"validation error for a bad request"}},"security":[{"OAuth2":["payroll.superfunds.read"]}],"summary":"Retrieves superfunds","tags":["PayrollAu"]},"parameters":[{"$ref":"#/components/parameters/requiredHeader"}],"post":{"operationId":"createSuperfund","requestBody":{"content":{"application/json":{"example":"[ { \"usi\":\"PTC0133AU\", \"Type\":\"REGULATED\", \"Name\":\"Bar99359\", \"AccountNumber\":\"FB36350\", \"AccountName\":\"Foo38428\", \"USI\":\"PTC0133AU\" } ]","schema":{"items":{"$ref":"#/components/schemas/SuperFund"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":"{ \"Id\":\"6101dc74-d7b5-4d75-8aa6-ba02697167d9\", \"Status\":\"OK\", \"ProviderName\":\"java-sdk-oauth2-dev-02\", \"DateTimeUTC\":\"\\/Date(1573583393024)\\/\", \"SuperFunds\":[ { \"SuperFundID\":\"e02e44eb-2dba-4d5e-84da-8a0c3a4a4fef\", \"Name\":\"AMG Super\", \"Type\":\"REGULATED\", \"ABN\":\"30099320583\", \"USI\":\"PTC0133AU\", \"AccountNumber\":\"FB36350\", \"AccountName\":\"Foo38428\", \"UpdatedDateUTC\":\"\\/Date(1573583393009+0000)\\/\" } ] }","schema":{"$ref":"#/components/schemas/SuperFunds"}}},"description":"A successful request"},"400":{"description":"invalid input, object invalid - TODO"}},"security":[{"OAuth2":["payroll.superfunds"]}],"summary":"Creates a superfund","tags":["PayrollAu"],"x-hasPayrollAuProblem":true}},"/Superfunds/{SuperFundID}":{"get":{"operationId":"getSuperfund","parameters":[{"description":"Superfund id for single object","in":"path","name":"SuperFundID","required":true,"schema":{"example":"4ff1e5cc-9835-40d5-bb18-09fdb118db9c","format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":"{ \"Id\":\"a023294b-3656-4202-8127-c3d77a794fa7\", \"Status\":\"OK\", \"ProviderName\":\"java-sdk-oauth2-dev-02\", \"DateTimeUTC\":\"\\/Date(1573571518603)\\/\", \"SuperFunds\":[ { \"SuperFundID\":\"540f4327-dda2-4b36-9c2f-2fe1c93a72b5\", \"Name\":\"My Self Managed one\", \"Type\":\"SMSF\", \"ABN\":\"53004085616\", \"EmployerNumber\":\"9876543\", \"BSB\":\"324324\", \"AccountNumber\":\"234234234\", \"AccountName\":\"My Checking\", \"UpdatedDateUTC\":\"\\/Date(1573571429000+0000)\\/\", \"ElectronicServiceAddress\":\"FG48739\" } ] }","schema":{"$ref":"#/components/schemas/SuperFunds"}}},"description":"search results matching criteria"}},"security":[{"OAuth2":["payroll.superfunds.read"]}],"summary":"Retrieves a superfund by using a unique superfund ID","tags":["PayrollAu"]},"parameters":[{"$ref":"#/components/parameters/requiredHeader"}],"post":{"description":"Update properties on a single Superfund","operationId":"updateSuperfund","parameters":[{"description":"Superfund id for single object","in":"path","name":"SuperFundID","required":true,"schema":{"example":"4ff1e5cc-9835-40d5-bb18-09fdb118db9c","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"example":" [ { \"Type\":\"REGULATED\", \"Name\":\"Nice23534\" } ]","schema":{"items":{"$ref":"#/components/schemas/SuperFund"},"type":"array"}}}},"responses":{"200":{"content":{"application/json":{"example":"{ \"Id\":\"5805d551-10ba-43f5-ac08-9e482d35cdcb\", \"Status\":\"OK\", \"ProviderName\":\"java-sdk-oauth2-dev-02\", \"DateTimeUTC\":\"\\/Date(1573570941547)\\/\", \"SuperFunds\":[ { \"SuperFundID\":\"fde8e070-bf59-4e56-b1d7-c75a09474b8d\", \"Name\":\"Accumulate Plus (Commonwealth Bank Group Super)\", \"Type\":\"REGULATED\", \"ABN\":\"24248426878\", \"USI\":\"OSF0001AU\", \"UpdatedDateUTC\":\"\\/Date(1573510468000+0000)\\/\" } ] }","schema":{"$ref":"#/components/schemas/SuperFunds"}}},"description":"A successful request"}},"security":[{"OAuth2":["payroll.superfunds"]}],"summary":"Updates a superfund","tags":["PayrollAu"]}},"/Timesheets":{"get":{"operationId":"getTimesheets","parameters":[{"description":"Only records created or modified since this timestamp will be returned","in":"header","name":"If-Modified-Since","schema":{"type":"string"}},{"description":"Filter by an any element","example":"Status==\"ACTIVE\"","in":"query","name":"where","schema":{"type":"string"}},{"description":"Order by an any element","example":"EmailAddress%20DESC","in":"query","name":"order","schema":{"type":"string"}},{"description":"e.g. page=1 – Up to 100 timesheets will be returned in a single API call","in":"query","name":"page","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":"{ \"Id\":\"581271e7-d02d-4966-ae6c-2a4fb9c48e5a\", \"Status\":\"OK\", \"ProviderName\":\"java-sdk-oauth2-dev-02\", \"DateTimeUTC\":\"\\/Date(1573516183708)\\/\", \"Timesheets\":[ { \"TimesheetID\":\"863bbd31-0447-4419-80d5-d733d5e723ba\", \"EmployeeID\":