@@ -44960,7 +45640,7 @@
Parameters
"application/octet-stream" : {
"schema" : {
"type" : "string",
- "format" : "byte"
+ "format" : "binary"
}
}
},
@@ -45112,7 +45792,17 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/TaxRates"
},
- "example" : "{ \"TaxRates\": [ { \"Name\": \"State Tax NY\", \"TaxComponents\": [ { \"Name\": \"State Tax\", \"Rate\": 2.25 } ], \"Status\": \"DELETED\", \"ReportTaxType\": \"INPUT\" } ] }"
+ "example" : {
+ "TaxRates" : [ {
+ "Name" : "State Tax NY",
+ "TaxComponents" : [ {
+ "Name" : "State Tax",
+ "Rate" : 2.25
+ } ],
+ "Status" : "DELETED",
+ "ReportTaxType" : "INPUT"
+ } ]
+ }
}
},
"required" : true
@@ -45286,7 +45976,9 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/TrackingCategory"
},
- "example" : "{ \"Name\": \"Avengers\" }"
+ "example" : {
+ "Name" : "Avengers"
+ }
}
},
"required" : true
@@ -45487,7 +46179,9 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/TrackingOption"
},
- "example" : "{ name: \"Vision\" }"
+ "example" : {
+ "name" : "Vision"
+ }
}
},
"required" : true
diff --git a/docs/appstore/index.html b/docs/appstore/index.html
index 91b318e9..8dbe6d7a 100644
--- a/docs/appstore/index.html
+++ b/docs/appstore/index.html
@@ -1602,7 +1602,10 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/CreateUsageRecord"
},
- "example" : "{ \"timestamp\": \"2022-01-21T13:01:00\", \"quantity\": 10 }"
+ "example" : {
+ "timestamp" : "2022-01-21T13:01:00",
+ "quantity" : 10
+ }
}
},
"required" : true
@@ -1803,7 +1806,9 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/UpdateUsageRecord"
},
- "example" : "{ \"quantity\": 10 }"
+ "example" : {
+ "quantity" : 10
+ }
}
},
"required" : true
diff --git a/docs/assets/index.html b/docs/assets/index.html
index 344058b1..27d2ed99 100644
--- a/docs/assets/index.html
+++ b/docs/assets/index.html
@@ -1030,7 +1030,6 @@
};
defs["BookDepreciationDetail"] = {
"title" : "",
- "required" : [ "name" ],
"properties" : {
"currentCapitalGain" : {
"type" : "number",
@@ -1084,7 +1083,6 @@
};
defs["BookDepreciationSetting"] = {
"title" : "",
- "required" : [ "name" ],
"properties" : {
"depreciationMethod" : {
"type" : "string",
@@ -1564,7 +1562,28 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/Asset"
},
- "example" : "{ \"assetName\":\"Computer74863\", \"assetNumber\":\"123477544\", \"purchaseDate\":\"2020-01-01\", \"purchasePrice\":100.0, \"disposalPrice\":23.23, \"assetStatus\":\"Draft\", \"bookDepreciationSetting\":{ \"depreciationMethod\":\"StraightLine\", \"averagingMethod\":\"ActualDays\", \"depreciationRate\":0.5, \"depreciationCalculationMethod\":\"None\" }, \"bookDepreciationDetail\":{ \"currentCapitalGain\":5.32, \"currentGainLoss\":3.88, \"depreciationStartDate\":\"2020-01-02\", \"costLimit\":100.0, \"currentAccumDepreciationAmount\":2.25 }, \"AccountingBookValue\":99.5 }"
+ "example" : {
+ "assetName" : "Computer74863",
+ "assetNumber" : "123477544",
+ "purchaseDate" : "2020-01-01",
+ "purchasePrice" : 100.0,
+ "disposalPrice" : 23.23,
+ "assetStatus" : "Draft",
+ "bookDepreciationSetting" : {
+ "depreciationMethod" : "StraightLine",
+ "averagingMethod" : "ActualDays",
+ "depreciationRate" : 0.5,
+ "depreciationCalculationMethod" : "None"
+ },
+ "bookDepreciationDetail" : {
+ "currentCapitalGain" : 5.32,
+ "currentGainLoss" : 3.88,
+ "depreciationStartDate" : "2020-01-02",
+ "costLimit" : 100.0,
+ "currentAccumDepreciationAmount" : 2.25
+ },
+ "AccountingBookValue" : 99.5
+ }
}
},
"required" : true
@@ -1716,7 +1735,18 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/AssetType"
},
- "example" : "{ \"assetTypeName\":\"Machinery11004\", \"fixedAssetAccountId\":\"3d8d063a-c148-4bb8-8b3c-a5e2ad3b1e82\", \"depreciationExpenseAccountId\":\"d1602f69-f900-4616-8d34-90af393fa368\", \"accumulatedDepreciationAccountId\":\"9195cadd-8645-41e6-9f67-7bcd421defe8\", \"bookDepreciationSetting\":{ \"depreciationMethod\":\"DiminishingValue100\", \"averagingMethod\":\"ActualDays\", \"depreciationRate\":0.05, \"depreciationCalculationMethod\":\"None\" } }"
+ "example" : {
+ "assetTypeName" : "Machinery11004",
+ "fixedAssetAccountId" : "3d8d063a-c148-4bb8-8b3c-a5e2ad3b1e82",
+ "depreciationExpenseAccountId" : "d1602f69-f900-4616-8d34-90af393fa368",
+ "accumulatedDepreciationAccountId" : "9195cadd-8645-41e6-9f67-7bcd421defe8",
+ "bookDepreciationSetting" : {
+ "depreciationMethod" : "DiminishingValue100",
+ "averagingMethod" : "ActualDays",
+ "depreciationRate" : 0.05,
+ "depreciationCalculationMethod" : "None"
+ }
+ }
}
},
"required" : true
diff --git a/docs/payroll-au/index.html b/docs/payroll-au/index.html
index 2e0283fc..d5f5a004 100644
--- a/docs/payroll-au/index.html
+++ b/docs/payroll-au/index.html
@@ -4134,7 +4134,25 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/PayItem"
},
- "example" : "{ \"EarningsRates\": [ { \"Name\": \"MyRate\", \"AccountCode\": \"400\", \"TypeOfUnits\": \"4.00\", \"IsExemptFromTax\": true, \"IsExemptFromSuper\": true, \"IsReportableAsW1\": false, \"AllowanceContributesToAnnualLeaveRate\": false, \"AllowanceContributesToOvertimeRate\": false, \"EarningsType\": \"ORDINARYTIMEEARNINGS\", \"EarningsRateID\": \"1fa4e226-b711-46ba-a8a7-4344c9c5fb87\", \"RateType\": \"MULTIPLE\", \"RatePerUnit\": \"10.0\", \"Multiplier\": 1.5, \"Amount\": 5, \"EmploymentTerminationPaymentType\": \"O\" } ] }"
+ "example" : {
+ "EarningsRates" : [ {
+ "Name" : "MyRate",
+ "AccountCode" : "400",
+ "TypeOfUnits" : "4.00",
+ "IsExemptFromTax" : true,
+ "IsExemptFromSuper" : true,
+ "IsReportableAsW1" : false,
+ "AllowanceContributesToAnnualLeaveRate" : false,
+ "AllowanceContributesToOvertimeRate" : false,
+ "EarningsType" : "ORDINARYTIMEEARNINGS",
+ "EarningsRateID" : "1fa4e226-b711-46ba-a8a7-4344c9c5fb87",
+ "RateType" : "MULTIPLE",
+ "RatePerUnit" : "10.0",
+ "Multiplier" : 1.5,
+ "Amount" : 5,
+ "EmploymentTerminationPaymentType" : "O"
+ } ]
+ }
}
},
"required" : true
@@ -8055,7 +8073,16 @@
Parameters
"$ref" : "#/components/schemas/PayslipLines"
}
},
- "example" : "{ \"Payslip\": { \"EmployeeID\": \"cdfb8371-0b21-4b8a-8903-1024df6c391e\", \"DeductionLines\": [ { \"DeductionTypeID\": \"727af5e8-b347-4ae7-85fc-9b82266d0aec\", \"CalculationType\": \"FIXEDAMOUNT\", \"NumberOfUnits\": 10 } ] } }"
+ "example" : {
+ "Payslip" : {
+ "EmployeeID" : "cdfb8371-0b21-4b8a-8903-1024df6c391e",
+ "DeductionLines" : [ {
+ "DeductionTypeID" : "727af5e8-b347-4ae7-85fc-9b82266d0aec",
+ "CalculationType" : "FIXEDAMOUNT",
+ "NumberOfUnits" : 10
+ } ]
+ }
+ }
}
},
"required" : true
diff --git a/docs/payroll-nz/index.html b/docs/payroll-nz/index.html
index 2011dbce..fb7c6d55 100644
--- a/docs/payroll-nz/index.html
+++ b/docs/payroll-nz/index.html
@@ -1048,7 +1048,7 @@
};
defs["Deduction"] = {
"title" : "",
- "required" : [ "calculationType", "deductionCategory", "deductionName", "liabilityAccountId" ],
+ "required" : [ "deductionCategory", "deductionName", "liabilityAccountId" ],
"type" : "object",
"properties" : {
"deductionId" : {
@@ -1422,7 +1422,7 @@
};
defs["Employee"] = {
"title" : "",
- "required" : [ "Address", "DateOfBirth", "FirstName", "LastName" ],
+ "required" : [ "address", "dateOfBirth", "firstName", "lastName" ],
"type" : "object",
"properties" : {
"employeeID" : {
@@ -2428,7 +2428,7 @@
};
defs["Employment"] = {
"title" : "",
- "required" : [ "EngagementType", "PayrollCalendarID", "StartDate" ],
+ "required" : [ "engagementType", "payrollCalendarID", "startDate" ],
"type" : "object",
"properties" : {
"payrollCalendarID" : {
@@ -4534,7 +4534,11 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/Deduction"
},
- "example" : "{ \"deductionName\": \"My new deduction\", \"deductionCategory\": \"NzOther\", \"liabilityAccountId\": \"568f2e9a-0870-46cc-8678-f83f132ed4e3\" }"
+ "example" : {
+ "deductionName" : "My new deduction",
+ "deductionCategory" : "NzOther",
+ "liabilityAccountId" : "568f2e9a-0870-46cc-8678-f83f132ed4e3"
+ }
}
},
"required" : true
@@ -4676,7 +4680,13 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/EarningsRate"
},
- "example" : "{ \"name\": \"My Earnings Rate\", \"earningsType\": \"RegularEarnings\", \"rateType\": \"RatePerUnit\", \"typeOfUnits\": \"hours\", \"expenseAccountID\": \"e4eb36f6-97e3-4427-a394-dd4e1b355c2e\" }"
+ "example" : {
+ "name" : "My Earnings Rate",
+ "earningsType" : "RegularEarnings",
+ "rateType" : "RatePerUnit",
+ "typeOfUnits" : "hours",
+ "expenseAccountID" : "e4eb36f6-97e3-4427-a394-dd4e1b355c2e"
+ }
}
},
"required" : true
@@ -4827,7 +4837,20 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/Employee"
},
- "example" : "{ \"title\": \"Mr\", \"firstName\": \"Mike\", \"lastName\": \"Johntzxzpxhmkgson\", \"dateOfBirth\": \"2000-01-01\", \"address\": { \"addressLine1\": \"101 Green St\", \"city\": \"San Francisco\", \"postCode\": \"4351\", \"countryName\": \"United Kingdom\" }, \"email\": \"83139@starkindustries.com\", \"gender\": \"M\" }"
+ "example" : {
+ "title" : "Mr",
+ "firstName" : "Mike",
+ "lastName" : "Johntzxzpxhmkgson",
+ "dateOfBirth" : "2000-01-01",
+ "address" : {
+ "addressLine1" : "101 Green St",
+ "city" : "San Francisco",
+ "postCode" : "4351",
+ "countryName" : "United Kingdom"
+ },
+ "email" : "83139@starkindustries.com",
+ "gender" : "M"
+ }
}
},
"required" : true
@@ -5008,7 +5031,12 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/EarningsTemplate"
},
- "example" : "{ \"ratePerUnit\": 20, \"numberOfUnits\": 8, \"earningsRateID\": \"f9d8f5b5-9049-47f4-8541-35e200f750a5\", \"name\": \"My New One\" }"
+ "example" : {
+ "ratePerUnit" : 20,
+ "numberOfUnits" : 8,
+ "earningsRateID" : "f9d8f5b5-9049-47f4-8541-35e200f750a5",
+ "name" : "My New One"
+ }
}
},
"required" : true
@@ -5188,7 +5216,12 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/EmployeeLeave"
},
- "example" : "{ \"leaveTypeID\": \"b0b1b79e-2a25-46c2-ad08-ca25ef48d7e4\", \"description\": \"Creating a Description\", \"startDate\": \"2020-04-24\", \"endDate\": \"2020-04-26\" }"
+ "example" : {
+ "leaveTypeID" : "b0b1b79e-2a25-46c2-ad08-ca25ef48d7e4",
+ "description" : "Creating a Description",
+ "startDate" : "2020-04-24",
+ "endDate" : "2020-04-26"
+ }
}
},
"required" : true
@@ -5372,7 +5405,16 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/EmployeeLeaveSetup"
},
- "example" : "{ \"holidayPayOpeningBalance\": 10, \"annualLeaveOpeningBalance\": 100, \"sickLeaveHoursToAccrueAnnually\": 20, \"sickLeaveToAccrueAnnually\": 20, \"sickLeaveOpeningBalance\": 10, \"sickLeaveScheduleOfAccrual\": \"OnAnniversaryDate\", \"sickLeaveAnniversaryDate\": \"2023-12-31\", \"annualLeaveAnniversaryDate\": \"2023-12-31\" }"
+ "example" : {
+ "holidayPayOpeningBalance" : 10,
+ "annualLeaveOpeningBalance" : 100,
+ "sickLeaveHoursToAccrueAnnually" : 20,
+ "sickLeaveToAccrueAnnually" : 20,
+ "sickLeaveOpeningBalance" : 10,
+ "sickLeaveScheduleOfAccrual" : "OnAnniversaryDate",
+ "sickLeaveAnniversaryDate" : "2023-12-31",
+ "annualLeaveAnniversaryDate" : "2023-12-31"
+ }
}
},
"required" : true
@@ -5549,7 +5591,17 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/EmployeeLeaveType"
},
- "example" : "{ \"leaveTypeID\": \"35da97ae-05b9-427f-9a98-69157ba42cec\", \"scheduleOfAccrual\": \"AnnuallyAfter6Months\", \"hoursAccruedAnnually\": 10, \"unitsAccruedAnnually\": 10, \"typeOfUnitsToAccrue\": \"Hours\", \"openingBalanceTypeOfUnits\": \"Hours\" \"maximumToAccrue\": 80, \"openingBalance\": 100, \"rateAccruedHourly\": 3.5 }"
+ "example" : {
+ "leaveTypeID" : "35da97ae-05b9-427f-9a98-69157ba42cec",
+ "scheduleOfAccrual" : "AnnuallyAfter6Months",
+ "hoursAccruedAnnually" : 10,
+ "unitsAccruedAnnually" : 10,
+ "typeOfUnitsToAccrue" : "Hours",
+ "openingBalanceTypeOfUnits" : "Hours",
+ "maximumToAccrue" : 80,
+ "openingBalance" : 100,
+ "rateAccruedHourly" : 3.5
+ }
}
},
"required" : true
@@ -5910,6 +5962,18 @@
Parameters
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaymentMethod"
+ },
+ "example" : {
+ "bankAccounts" : [ {
+ "accountName" : "Casual Worker",
+ "accountNumber" : "0607050201419000",
+ "sortCode" : null,
+ "particulars" : null,
+ "code" : null,
+ "dollarAmount" : null,
+ "reference" : "",
+ "calculationType" : "Balance"
+ } ]
}
}
},
@@ -6087,7 +6151,17 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/SalaryAndWage"
},
- "example" : "{ \"earningsRateID\": \"f9d8f5b5-9049-47f4-8541-35e200f750a5\", \"numberOfUnitsPerWeek\": 2, \"ratePerUnit\": 10, \"numberOfUnitsPerDay\": 2, \"daysPerWeek\": 1, \"effectiveFrom\": \"2020-05-01\", \"annualSalary\": 100, \"status\": \"Active\", \"paymentType\": \"Salary\" }"
+ "example" : {
+ "earningsRateID" : "f9d8f5b5-9049-47f4-8541-35e200f750a5",
+ "numberOfUnitsPerWeek" : 2,
+ "ratePerUnit" : 10,
+ "numberOfUnitsPerDay" : 2,
+ "daysPerWeek" : 1,
+ "effectiveFrom" : "2020-05-01",
+ "annualSalary" : 100,
+ "status" : "Active",
+ "paymentType" : "Salary"
+ }
}
},
"required" : true
@@ -6268,7 +6342,18 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/EmployeeWorkingPatternWithWorkingWeeksRequest"
},
- "example" : "{ \"effectiveFrom\": \"2020-01-01T00:00:00\", \"workingWeeks\": [ { \"monday\": 0.0, \"tuesday\": 3.0000, \"wednesday\": 0.0, \"thursday\": 0.0, \"friday\": 0.0, \"saturday\": 0.0, \"sunday\": 0.0 } ] }"
+ "example" : {
+ "effectiveFrom" : "2020-01-01T00:00:00",
+ "workingWeeks" : [ {
+ "monday" : 0.0,
+ "tuesday" : 3.0,
+ "wednesday" : 0.0,
+ "thursday" : 0.0,
+ "friday" : 0.0,
+ "saturday" : 0.0,
+ "sunday" : 0.0
+ } ]
+ }
}
},
"required" : true
@@ -6446,7 +6531,12 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/Employment"
},
- "example" : "{ \"payrollCalendarID\": \"9aa56064-990f-4ad3-a189-d966d8f6a030\", \"startDate\": \"2020-09-02\", \"engagementType\": \"FixedTerm\", \"fixedTermEndDate\": \"2026-01-01\" }"
+ "example" : {
+ "payrollCalendarID" : "9aa56064-990f-4ad3-a189-d966d8f6a030",
+ "startDate" : "2020-09-02",
+ "engagementType" : "FixedTerm",
+ "fixedTermEndDate" : "2026-01-01"
+ }
}
},
"required" : true
@@ -6588,7 +6678,11 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/LeaveType"
},
- "example" : "{ \"name\": \"My wqwhhiktun Leave\", \"isPaidLeave\": false, \"showOnPayslip\": true }"
+ "example" : {
+ "name" : "My wqwhhiktun Leave",
+ "isPaidLeave" : false,
+ "showOnPayslip" : true
+ }
}
},
"required" : true
@@ -6910,7 +7004,15 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/PayRun"
},
- "example" : "{ \"payrollCalendarID\": \"9aa56064-990f-4ad3-a189-d966d8f6a030\", \"periodStartDate\": \"2020-09-08\", \"periodEndDate\": \"2020-09-15\", \"paymentDate\": \"2020-09-20\", \"payRunStatus\": \"Draft\", \"payRunType\": \"Scheduled\", \"calendarType\": \"Weekly\" }"
+ "example" : {
+ "payrollCalendarID" : "9aa56064-990f-4ad3-a189-d966d8f6a030",
+ "periodStartDate" : "2020-09-08",
+ "periodEndDate" : "2020-09-15",
+ "paymentDate" : "2020-09-20",
+ "payRunStatus" : "Draft",
+ "payRunType" : "Scheduled",
+ "calendarType" : "Weekly"
+ }
}
},
"required" : true
@@ -7054,7 +7156,12 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/PayRunCalendar"
},
- "example" : "{ \"name\": \"My Weekly Cal\", \"calendarType\": \"Weekly\", \"periodStartDate\": \"2020-05-01\", \"paymentDate\": \"2020-05-15\" }"
+ "example" : {
+ "name" : "My Weekly Cal",
+ "calendarType" : "Weekly",
+ "periodStartDate" : "2020-05-01",
+ "paymentDate" : "2020-05-15"
+ }
}
},
"required" : true
@@ -7198,7 +7305,12 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/Reimbursement"
},
- "example" : "{ \"name\": \"My new Reimburse\", \"accountID\": \"fa5cdc43-643b-4ad8-b4ac-3ffe0d0f4488\", \"reimbursementCategory\": \"GSTInclusive\", \"calculationType\": \"FixedAmount\" }"
+ "example" : {
+ "name" : "My new Reimburse",
+ "accountID" : "fa5cdc43-643b-4ad8-b4ac-3ffe0d0f4488",
+ "reimbursementCategory" : "GSTInclusive",
+ "calculationType" : "FixedAmount"
+ }
}
},
"required" : true
@@ -7343,7 +7455,14 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/Benefit"
},
- "example" : "{ \"name\": \"SidSaver\", \"category\": \"Other\", \"liabilityAccountId\": \"568f2e9a-0870-46cc-8678-f83f132ed4e3\", \"expenseAccountId\": \"e4eb36f6-97e3-4427-a394-dd4e1b355c2e\", \"CalculationTypeNZ\": \"FixedAmount\", \"standardAmount\": 10 }"
+ "example" : {
+ "name" : "SidSaver",
+ "category" : "Other",
+ "liabilityAccountId" : "568f2e9a-0870-46cc-8678-f83f132ed4e3",
+ "expenseAccountId" : "e4eb36f6-97e3-4427-a394-dd4e1b355c2e",
+ "CalculationTypeNZ" : "FixedAmount",
+ "standardAmount" : 10
+ }
}
},
"required" : true
@@ -7488,7 +7607,21 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/Timesheet"
},
- "example" : "{ \"payrollCalendarID\": \"9aa56064-990f-4ad3-a189-d966d8f6a030\", \"employeeID\": \"68342973-c405-4b86-b5d3-d7b877c27995\", \"startDate\": \"2020-04-13\", \"endDate\": \"2020-04-19\", \"timesheetLines\": [ { \"date\": \"2020-04-13\", \"earningsRateID\": \"f9d8f5b5-9049-47f4-8541-35e200f750a5\", \"numberOfUnits\": 8 }, { \"date\": \"2020-04-15\", \"earningsRateID\": \"f9d8f5b5-9049-47f4-8541-35e200f750a5\", \"numberOfUnits\": 6 } ] }"
+ "example" : {
+ "payrollCalendarID" : "9aa56064-990f-4ad3-a189-d966d8f6a030",
+ "employeeID" : "68342973-c405-4b86-b5d3-d7b877c27995",
+ "startDate" : "2020-04-13",
+ "endDate" : "2020-04-19",
+ "timesheetLines" : [ {
+ "date" : "2020-04-13",
+ "earningsRateID" : "f9d8f5b5-9049-47f4-8541-35e200f750a5",
+ "numberOfUnits" : 8
+ }, {
+ "date" : "2020-04-15",
+ "earningsRateID" : "f9d8f5b5-9049-47f4-8541-35e200f750a5",
+ "numberOfUnits" : 6
+ } ]
+ }
}
},
"required" : true
@@ -7667,7 +7800,11 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/TimesheetLine"
},
- "example" : "{ \"date\": \"2020-08-03\", \"earningsRateID\": \"f9d8f5b5-9049-47f4-8541-35e200f750a5\", \"numberOfUnits\": 1 }"
+ "example" : {
+ "date" : "2020-08-03",
+ "earningsRateID" : "f9d8f5b5-9049-47f4-8541-35e200f750a5",
+ "numberOfUnits" : 1
+ }
}
},
"required" : true
@@ -13245,7 +13382,20 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/Employee"
},
- "example" : "{ \"title\": \"Mr\", \"firstName\": \"Tony\", \"lastName\": \"Starkgtrzgquusrson\", \"dateOfBirth\": \"1999-01-01\", \"address\": { \"addressLine1\": \"101 Green St\", \"city\": \"San Francisco\", \"postCode\": \"4432\", \"countryName\": \"United Kingdom\" }, \"email\": \"58315@starkindustries.com\", \"gender\": \"M\" }"
+ "example" : {
+ "title" : "Mr",
+ "firstName" : "Tony",
+ "lastName" : "Starkgtrzgquusrson",
+ "dateOfBirth" : "1999-01-01",
+ "address" : {
+ "addressLine1" : "101 Green St",
+ "city" : "San Francisco",
+ "postCode" : "4432",
+ "countryName" : "United Kingdom"
+ },
+ "email" : "58315@starkindustries.com",
+ "gender" : "M"
+ }
}
},
"required" : true
@@ -13453,7 +13603,11 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/EarningsTemplate"
},
- "example" : "{ \"ratePerUnit\": 25, \"numberOfUnits\": 4, \"earningsRateID\": \"f9d8f5b5-9049-47f4-8541-35e200f750a5\" }"
+ "example" : {
+ "ratePerUnit" : 25,
+ "numberOfUnits" : 4,
+ "earningsRateID" : "f9d8f5b5-9049-47f4-8541-35e200f750a5"
+ }
}
},
"required" : true
@@ -13658,7 +13812,18 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/EmployeeLeave"
},
- "example" : "{ \"leaveTypeID\": \"b0b1b79e-2a25-46c2-ad08-ca25ef48d7e4\", \"description\": \"Creating a Description\", \"startDate\": \"2020-04-24\", \"endDate\": \"2020-04-26\", \"periods\": [ { \"periodStartDate\": \"2020-04-20\", \"periodEndDate\": \"2020-04-26\", \"numberOfUnits\": 1, \"periodStatus\": \"Approved\" } ] }"
+ "example" : {
+ "leaveTypeID" : "b0b1b79e-2a25-46c2-ad08-ca25ef48d7e4",
+ "description" : "Creating a Description",
+ "startDate" : "2020-04-24",
+ "endDate" : "2020-04-26",
+ "periods" : [ {
+ "periodStartDate" : "2020-04-20",
+ "periodEndDate" : "2020-04-26",
+ "numberOfUnits" : 1,
+ "periodStatus" : "Approved"
+ } ]
+ }
}
},
"required" : true
@@ -13862,7 +14027,17 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/SalaryAndWage"
},
- "example" : "{ \"earningsRateID\": \"f9d8f5b5-9049-47f4-8541-35e200f750a5\", \"numberOfUnitsPerWeek\": 3, \"ratePerUnit\": 11, \"numberOfUnitsPerDay\": 3, \"daysPerWeek\": 1, \"effectiveFrom\": \"2020-05-15\", \"annualSalary\": 101, \"status\": \"Active\", \"paymentType\": \"Salary\" }"
+ "example" : {
+ "earningsRateID" : "f9d8f5b5-9049-47f4-8541-35e200f750a5",
+ "numberOfUnitsPerWeek" : 3,
+ "ratePerUnit" : 11,
+ "numberOfUnitsPerDay" : 3,
+ "daysPerWeek" : 1,
+ "effectiveFrom" : "2020-05-15",
+ "annualSalary" : 101,
+ "status" : "Active",
+ "paymentType" : "Salary"
+ }
}
},
"required" : true
@@ -14047,6 +14222,24 @@
Parameters
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EmployeeTax"
+ },
+ "example" : {
+ "irdNumber" : "111111111",
+ "taxCode" : "M",
+ "esctRatePercentage" : 17.5,
+ "isEligibleForKiwiSaver" : true,
+ "hasSpecialStudentLoanRate" : false,
+ "specialStudentLoanRatePercentage" : null,
+ "specialTaxRatePercentage" : null,
+ "kiwiSaverContributions" : "MakeContributions",
+ "kiwiSaverOptOutDate" : null,
+ "kiwiSaverContributionHolidayEndDate" : null,
+ "kiwiSaverEmployeeContributionRatePercentage" : 3,
+ "kiwiSaverEmployerContributionRatePercentage" : 3,
+ "kiwiSaverEmployerSalarySacrificeContributionRatePercentage" : 0,
+ "hasStudentLoanBalance" : false,
+ "studentLoanBalance" : null,
+ "studentLoanAsAt" : null
}
}
},
@@ -14225,7 +14418,9 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/PayRun"
},
- "example" : "{ \"paymentDate\": \"2019-07-01\" }"
+ "example" : {
+ "paymentDate" : "2019-07-01"
+ }
}
},
"required" : true
@@ -14410,7 +14605,81 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/PaySlip"
},
- "example" : "{ \"earningsLines\": [ { \"earningsLineID\": \"f9d8f5b5-9049-47f4-8541-35e200f750a5\", \"earningsRateID\": \"f9d8f5b5-9049-47f4-8541-35e200f750a5\", \"displayName\": \"Ordinary Time\", \"ratePerUnit\": 25, \"numberOfUnits\": 0, \"amount\": 0, \"isLinkedToTimesheet\": false, \"isSystemGenerated\": true }, { \"earningsLineID\": \"65b83d94-f20f-45e1-85ae-387fcf460c26\", \"earningsRateID\": \"65b83d94-f20f-45e1-85ae-387fcf460c26\", \"displayName\": \"Salary\", \"ratePerUnit\": 0, \"numberOfUnits\": 8, \"amount\": 0, \"isLinkedToTimesheet\": false, \"isSystemGenerated\": false } ], \"leaveEarningsLines\": [ { \"earningsLineID\": \"0441497f-5dc7-4cd3-a90d-f2e07e21b2a6\", \"earningsRateID\": \"39b3560a-5d2f-4538-924a-4349dc86396e\", \"displayName\": \"Holiday Pay\", \"fixedAmount\": 268.8, \"amount\": 268.8, \"isLinkedToTimesheet\": false, \"isSystemGenerated\": true } ], \"deductionLines\": [ { \"deductionTypeID\": \"a3760fe4-68a4-4e38-8326-fe616af7dc74\", \"amount\": 100 } ], \"leaveAccrualLines\": [ { \"leaveTypeID\": \"0441497f-5dc7-4cd3-a90d-f2e07e21b2a6\", \"numberOfUnits\": 268.8 }, { \"leaveTypeID\": \"b0b1b79e-2a25-46c2-ad08-ca25ef48d7e4\", \"numberOfUnits\": 0 }, { \"leaveTypeID\": \"f2f994cf-1899-46f3-ad4f-5d92d78c3719\", \"numberOfUnits\": 0 }, { \"leaveTypeID\": \"34129765-11cb-4d8c-b568-84a2219beda3\", \"numberOfUnits\": 0 } ], \"superannuationLines\": [ { \"superannuationTypeID\": \"563273ea-0dae-4f82-86a4-e0db77c008ea\", \"displayName\": \"KiwiSaver\", \"amount\": 108.86, \"fixedAmount\": 3, \"percentage\": 3, \"manualAdjustment\": false } ], \"employeeTaxLines\": [ { \"taxLineID\": \"1084146b-e890-489c-aed3-06de80f63d84\", \"amount\": 1057.22, \"globalTaxTypeID\": \"11\", \"manualAdjustment\": false } ], \"employerTaxLines\": [ { \"taxLineID\": \"6f9eb8cd-0f4a-440b-939c-bdb0f6ad694c\", \"amount\": 18.9, \"globalTaxTypeID\": \"10\", \"manualAdjustment\": false } ], \"statutoryDeductionLines\": [ { \"statutoryDeductionTypeID\": \"b5efd8d1-0c93-4a14-a314-b5cba4a4e6b3\", \"amount\": 108.86 } ], \"grossEarningsHistory\": { \"daysPaid\": 3, \"unpaidWeeks\": 0 } }"
+ "example" : {
+ "earningsLines" : [ {
+ "earningsLineID" : "f9d8f5b5-9049-47f4-8541-35e200f750a5",
+ "earningsRateID" : "f9d8f5b5-9049-47f4-8541-35e200f750a5",
+ "displayName" : "Ordinary Time",
+ "ratePerUnit" : 25,
+ "numberOfUnits" : 0,
+ "amount" : 0,
+ "isLinkedToTimesheet" : false,
+ "isSystemGenerated" : true
+ }, {
+ "earningsLineID" : "65b83d94-f20f-45e1-85ae-387fcf460c26",
+ "earningsRateID" : "65b83d94-f20f-45e1-85ae-387fcf460c26",
+ "displayName" : "Salary",
+ "ratePerUnit" : 0,
+ "numberOfUnits" : 8,
+ "amount" : 0,
+ "isLinkedToTimesheet" : false,
+ "isSystemGenerated" : false
+ } ],
+ "leaveEarningsLines" : [ {
+ "earningsLineID" : "0441497f-5dc7-4cd3-a90d-f2e07e21b2a6",
+ "earningsRateID" : "39b3560a-5d2f-4538-924a-4349dc86396e",
+ "displayName" : "Holiday Pay",
+ "fixedAmount" : 268.8,
+ "amount" : 268.8,
+ "isLinkedToTimesheet" : false,
+ "isSystemGenerated" : true
+ } ],
+ "deductionLines" : [ {
+ "deductionTypeID" : "a3760fe4-68a4-4e38-8326-fe616af7dc74",
+ "amount" : 100
+ } ],
+ "leaveAccrualLines" : [ {
+ "leaveTypeID" : "0441497f-5dc7-4cd3-a90d-f2e07e21b2a6",
+ "numberOfUnits" : 268.8
+ }, {
+ "leaveTypeID" : "b0b1b79e-2a25-46c2-ad08-ca25ef48d7e4",
+ "numberOfUnits" : 0
+ }, {
+ "leaveTypeID" : "f2f994cf-1899-46f3-ad4f-5d92d78c3719",
+ "numberOfUnits" : 0
+ }, {
+ "leaveTypeID" : "34129765-11cb-4d8c-b568-84a2219beda3",
+ "numberOfUnits" : 0
+ } ],
+ "superannuationLines" : [ {
+ "superannuationTypeID" : "563273ea-0dae-4f82-86a4-e0db77c008ea",
+ "displayName" : "KiwiSaver",
+ "amount" : 108.86,
+ "fixedAmount" : 3,
+ "percentage" : 3,
+ "manualAdjustment" : false
+ } ],
+ "employeeTaxLines" : [ {
+ "taxLineID" : "1084146b-e890-489c-aed3-06de80f63d84",
+ "amount" : 1057.22,
+ "globalTaxTypeID" : "11",
+ "manualAdjustment" : false
+ } ],
+ "employerTaxLines" : [ {
+ "taxLineID" : "6f9eb8cd-0f4a-440b-939c-bdb0f6ad694c",
+ "amount" : 18.9,
+ "globalTaxTypeID" : "10",
+ "manualAdjustment" : false
+ } ],
+ "statutoryDeductionLines" : [ {
+ "statutoryDeductionTypeID" : "b5efd8d1-0c93-4a14-a314-b5cba4a4e6b3",
+ "amount" : 108.86
+ } ],
+ "grossEarningsHistory" : {
+ "daysPaid" : 3,
+ "unpaidWeeks" : 0
+ }
+ }
}
},
"required" : true
@@ -14616,7 +14885,11 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/TimesheetLine"
},
- "example" : "{ \"date\": \"2020-08-04\", \"earningsRateID\": \"f9d8f5b5-9049-47f4-8541-35e200f750a5\", \"numberOfUnits\": 2 }"
+ "example" : {
+ "date" : "2020-08-04",
+ "earningsRateID" : "f9d8f5b5-9049-47f4-8541-35e200f750a5",
+ "numberOfUnits" : 2
+ }
}
},
"required" : true
diff --git a/docs/payroll-uk/index.html b/docs/payroll-uk/index.html
index 0ed33ea3..57017fc7 100644
--- a/docs/payroll-uk/index.html
+++ b/docs/payroll-uk/index.html
@@ -1514,7 +1514,7 @@
};
defs["Employee"] = {
"title" : "",
- "required" : [ "Address", "DateOfBirth", "FirstName", "Gender", "LastName", "Title" ],
+ "required" : [ "address", "dateOfBirth", "firstName", "gender", "lastName", "title" ],
"type" : "object",
"properties" : {
"employeeID" : {
@@ -2262,7 +2262,7 @@
};
defs["Employment"] = {
"title" : "",
- "required" : [ "EmployeeNumber", "NICategory", "PayrollCalendarID", "StartDate" ],
+ "required" : [ "employeeNumber", "niCategory", "payrollCalendarID", "startDate" ],
"type" : "object",
"properties" : {
"payrollCalendarID" : {
@@ -4015,7 +4015,15 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/Benefit"
},
- "example" : "{ \"name\": \"My Big Bennie\", \"category\": \"StakeholderPension\", \"liabilityAccountId\": \"e0faa299-ca0d-4b0a-9e32-0dfabdf9179a\", \"expenseAccountId\": \"4b03500d-32fd-4616-8d70-e1e56e0519c6\", \"standardAmount\": 50, \"percentage\": 25, \"calculationType\": \"PercentageOfGross\" }"
+ "example" : {
+ "name" : "My Big Bennie",
+ "category" : "StakeholderPension",
+ "liabilityAccountId" : "e0faa299-ca0d-4b0a-9e32-0dfabdf9179a",
+ "expenseAccountId" : "4b03500d-32fd-4616-8d70-e1e56e0519c6",
+ "standardAmount" : 50,
+ "percentage" : 25,
+ "calculationType" : "PercentageOfGross"
+ }
}
},
"required" : true
@@ -4158,7 +4166,12 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/Deduction"
},
- "example" : "{ \"deductionName\": \"My new deduction\", \"deductionCategory\": \"SalarySacrifice\", \"liabilityAccountId\": \"e0faa299-ca0d-4b0a-9e32-0dfabdf9179a\", \"calculationType\": \"FixedAmount\" }"
+ "example" : {
+ "deductionName" : "My new deduction",
+ "deductionCategory" : "SalarySacrifice",
+ "liabilityAccountId" : "e0faa299-ca0d-4b0a-9e32-0dfabdf9179a",
+ "calculationType" : "FixedAmount"
+ }
}
},
"required" : true
@@ -4301,7 +4314,13 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/EarningsRate"
},
- "example" : "{ \"name\": \"My Earnings Rate\", \"earningsType\": \"RegularEarnings\", \"rateType\": \"RatePerUnit\", \"typeOfUnits\": \"hours\", \"expenseAccountID\": \"4b03500d-32fd-4616-8d70-e1e56e0519c6\" }"
+ "example" : {
+ "name" : "My Earnings Rate",
+ "earningsType" : "RegularEarnings",
+ "rateType" : "RatePerUnit",
+ "typeOfUnits" : "hours",
+ "expenseAccountID" : "4b03500d-32fd-4616-8d70-e1e56e0519c6"
+ }
}
},
"required" : true
@@ -4452,7 +4471,20 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/Employee"
},
- "example" : "{ \"title\":\"Mr\", \"firstName\":\"Mike\", \"lastName\":\"Fancy\", \"dateOfBirth\":\"1999-01-01T00:00:00\", \"gender\":\"M\", \"email\":\"mike@starkindustries.com\", \"isOffPayrollWorker\": false, \"address\": { \"addressLine1\": \"171 Midsummer\", \"city\": \"Milton Keyness\", \"postCode\": \"MK9 1EB\" } }"
+ "example" : {
+ "title" : "Mr",
+ "firstName" : "Mike",
+ "lastName" : "Fancy",
+ "dateOfBirth" : "1999-01-01T00:00:00",
+ "gender" : "M",
+ "email" : "mike@starkindustries.com",
+ "isOffPayrollWorker" : false,
+ "address" : {
+ "addressLine1" : "171 Midsummer",
+ "city" : "Milton Keyness",
+ "postCode" : "MK9 1EB"
+ }
+ }
}
},
"required" : true
@@ -4810,7 +4842,12 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/EmployeeLeave"
},
- "example" : "{ \"leaveTypeID\": \"1d2778ee-86ea-45c0-bbf8-1045485f6b3f\", \"description\": \"Creating a Description\", \"startDate\": \"2020-03-24\", \"endDate\": \"2020-03-26\" }"
+ "example" : {
+ "leaveTypeID" : "1d2778ee-86ea-45c0-bbf8-1045485f6b3f",
+ "description" : "Creating a Description",
+ "startDate" : "2020-03-24",
+ "endDate" : "2020-03-26"
+ }
}
},
"required" : true
@@ -4987,7 +5024,11 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/EmployeeLeaveType"
},
- "example" : "{ \"leaveTypeID\": \"4918f233-bd31-43f9-9633-bcc6de1178f2\", \"scheduleOfAccrual\": \"BeginningOfCalendarYear\", \"hoursAccruedAnnually\": 10 }"
+ "example" : {
+ "leaveTypeID" : "4918f233-bd31-43f9-9633-bcc6de1178f2",
+ "scheduleOfAccrual" : "BeginningOfCalendarYear",
+ "hoursAccruedAnnually" : 10
+ }
}
},
"required" : true
@@ -5165,7 +5206,14 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/EmployeeOpeningBalances"
},
- "example" : "{ \"statutoryAdoptionPay\": 10, \"statutoryMaternityPay\": 10, \"statutoryPaternityPay\": 10, \"statutorySharedParentalPay\": 10, \"statutorySickPay\": 10, \"priorEmployeeNumber\": 10 }"
+ "example" : {
+ "statutoryAdoptionPay" : 10,
+ "statutoryMaternityPay" : 10,
+ "statutoryPaternityPay" : 10,
+ "statutorySharedParentalPay" : 10,
+ "statutorySickPay" : 10,
+ "priorEmployeeNumber" : 10
+ }
}
},
"required" : true
@@ -5347,7 +5395,14 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/PaymentMethod"
},
- "example" : "{ \"paymentMethod\": \"Electronically\", \"bankAccounts\": [ { \"accountName\": \"Sid BofA\", \"accountNumber\": \"24987654\", \"sortCode\": \"287654\" } ] }"
+ "example" : {
+ "paymentMethod" : "Electronically",
+ "bankAccounts" : [ {
+ "accountName" : "Sid BofA",
+ "accountNumber" : "24987654",
+ "sortCode" : "287654"
+ } ]
+ }
}
},
"required" : true
@@ -5525,7 +5580,16 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/SalaryAndWage"
},
- "example" : "{ \"earningsRateID\": \"87f5b43a-cf51-4b74-92de-94c819e82d27\", \"numberOfUnitsPerWeek\": 2, \"ratePerUnit\": 10, \"numberOfUnitsPerDay\": 2, \"effectiveFrom\": \"2020-05-01\", \"annualSalary\": 100, \"status\": \"ACTIVE\", \"paymentType\": \"Salary\" }"
+ "example" : {
+ "earningsRateID" : "87f5b43a-cf51-4b74-92de-94c819e82d27",
+ "numberOfUnitsPerWeek" : 2,
+ "ratePerUnit" : 10,
+ "numberOfUnitsPerDay" : 2,
+ "effectiveFrom" : "2020-05-01",
+ "annualSalary" : 100,
+ "status" : "ACTIVE",
+ "paymentType" : "Salary"
+ }
}
},
"required" : true
@@ -5670,7 +5734,15 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/EmployeeStatutorySickLeave"
},
- "example" : "{ \"employeeID\": \"aad6b292-7b94-408b-93f6-e489867e3fb0\", \"leaveTypeID\": \"aab78802-e9d3-4bbd-bc87-df858054988f\", \"startDate\": \"2020-04-21\", \"endDate\": \"2020-04-24\", \"workPattern\": [ \"Monday\", \"Tuesday\", \"Wednesday\", \"Thursday\", \"Friday\" ], \"isPregnancyRelated\": false, \"sufficientNotice\": true }"
+ "example" : {
+ "employeeID" : "aad6b292-7b94-408b-93f6-e489867e3fb0",
+ "leaveTypeID" : "aab78802-e9d3-4bbd-bc87-df858054988f",
+ "startDate" : "2020-04-21",
+ "endDate" : "2020-04-24",
+ "workPattern" : [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday" ],
+ "isPregnancyRelated" : false,
+ "sufficientNotice" : true
+ }
}
},
"required" : true
@@ -5846,7 +5918,12 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/Employment"
},
- "example" : "{ \"PayrollCalendarID\": \"216d80e6-af55-47b1-b718-9457c3f5d2fe\", \"StartDate\": \"2020-04-01\", \"EmployeeNumber\": \"123ABC\", \"NICategory\": \"A\" }"
+ "example" : {
+ "PayrollCalendarID" : "216d80e6-af55-47b1-b718-9457c3f5d2fe",
+ "StartDate" : "2020-04-01",
+ "EmployeeNumber" : "123ABC",
+ "NICategory" : "A"
+ }
}
},
"required" : true
@@ -5988,7 +6065,11 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/LeaveType"
},
- "example" : "{ \"name\": \"My opebvwbfxf Leave\", \"isPaidLeave\": false, \"showOnPayslip\": true }"
+ "example" : {
+ "name" : "My opebvwbfxf Leave",
+ "isPaidLeave" : false,
+ "showOnPayslip" : true
+ }
}
},
"required" : true
@@ -6313,7 +6394,12 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/PayRunCalendar"
},
- "example" : "{ \"name\": \"My Weekly Cal\", \"calendarType\": \"Weekly\", \"periodStartDate\": \"2020-05-01\", \"paymentDate\": \"2020-05-15\" }"
+ "example" : {
+ "name" : "My Weekly Cal",
+ "calendarType" : "Weekly",
+ "periodStartDate" : "2020-05-01",
+ "paymentDate" : "2020-05-15"
+ }
}
},
"required" : true
@@ -6454,7 +6540,10 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/Reimbursement"
},
- "example" : "{ \"name\": \"My new Reimburse\", \"accountID\": \"9ee28149-32a9-4661-8eab-a28738696983\" }"
+ "example" : {
+ "name" : "My new Reimburse",
+ "accountID" : "9ee28149-32a9-4661-8eab-a28738696983"
+ }
}
},
"required" : true
@@ -6599,7 +6688,21 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/Timesheet"
},
- "example" : "{ \"payrollCalendarID\": \"216d80e6-af55-47b1-b718-9457c3f5d2fe\", \"employeeID\": \"aad6b292-7b94-408b-93f6-e489867e3fb0\", \"startDate\": \"2020-04-13\", \"endDate\": \"2020-04-19\", \"timesheetLines\": [ { \"date\": \"2020-04-13\", \"earningsRateID\": \"87f5b43a-cf51-4b74-92de-94c819e82d27\", \"numberOfUnits\": 8 }, { \"date\": \"2020-04-15\", \"earningsRateID\": \"87f5b43a-cf51-4b74-92de-94c819e82d27\", \"numberOfUnits\": 6 } ] }"
+ "example" : {
+ "payrollCalendarID" : "216d80e6-af55-47b1-b718-9457c3f5d2fe",
+ "employeeID" : "aad6b292-7b94-408b-93f6-e489867e3fb0",
+ "startDate" : "2020-04-13",
+ "endDate" : "2020-04-19",
+ "timesheetLines" : [ {
+ "date" : "2020-04-13",
+ "earningsRateID" : "87f5b43a-cf51-4b74-92de-94c819e82d27",
+ "numberOfUnits" : 8
+ }, {
+ "date" : "2020-04-15",
+ "earningsRateID" : "87f5b43a-cf51-4b74-92de-94c819e82d27",
+ "numberOfUnits" : 6
+ } ]
+ }
}
},
"required" : true
@@ -6778,7 +6881,11 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/TimesheetLine"
},
- "example" : "{ \"date\": \"2020-04-14\", \"earningsRateID\": \"87f5b43a-cf51-4b74-92de-94c819e82d27\", \"numberOfUnits\": 1 }"
+ "example" : {
+ "date" : "2020-04-14",
+ "earningsRateID" : "87f5b43a-cf51-4b74-92de-94c819e82d27",
+ "numberOfUnits" : 1
+ }
}
},
"required" : true
@@ -12532,7 +12639,21 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/Employee"
},
- "example" : "{ \"title\": \"Mr.\", \"firstName\": \"TestDataUK\", \"lastName\": \"Tester\", \"dateOfBirth\": \"1992-11-22T00:00:00\", \"gender\": \"M\", \"email\": \"tester@gmail.com\", \"phoneNumber\": \"0400123456\", \"isOffPayrollWorker\": false, \"address\": { \"addressLine1\": \"171 Midsummer\", \"city\": \"Milton Keyness\", \"postCode\": \"MK9 1EB\" } }"
+ "example" : {
+ "title" : "Mr.",
+ "firstName" : "TestDataUK",
+ "lastName" : "Tester",
+ "dateOfBirth" : "1992-11-22T00:00:00",
+ "gender" : "M",
+ "email" : "tester@gmail.com",
+ "phoneNumber" : "0400123456",
+ "isOffPayrollWorker" : false,
+ "address" : {
+ "addressLine1" : "171 Midsummer",
+ "city" : "Milton Keyness",
+ "postCode" : "MK9 1EB"
+ }
+ }
}
},
"required" : true
@@ -12740,7 +12861,11 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/EarningsTemplate"
},
- "example" : "{ \"ratePerUnit\": 30, \"numberOfUnits\": 4, \"earningsRateID\": \"87f5b43a-cf51-4b74-92de-94c819e82d27\" }"
+ "example" : {
+ "ratePerUnit" : 30,
+ "numberOfUnits" : 4,
+ "earningsRateID" : "87f5b43a-cf51-4b74-92de-94c819e82d27"
+ }
}
},
"required" : true
@@ -12945,7 +13070,18 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/EmployeeLeave"
},
- "example" : "{ \"leaveTypeID\": \"ed08dffe-788e-4b24-9630-f0fa2f4d164c\", \"description\": \"Creating a Description\", \"startDate\": \"2020-04-24\", \"endDate\": \"2020-04-26\", \"periods\": [ { \"periodStartDate\": \"2020-04-20\", \"periodEndDate\": \"2020-04-26\", \"numberOfUnits\": 1, \"periodStatus\": \"Approved\" } ] }"
+ "example" : {
+ "leaveTypeID" : "ed08dffe-788e-4b24-9630-f0fa2f4d164c",
+ "description" : "Creating a Description",
+ "startDate" : "2020-04-24",
+ "endDate" : "2020-04-26",
+ "periods" : [ {
+ "periodStartDate" : "2020-04-20",
+ "periodEndDate" : "2020-04-26",
+ "numberOfUnits" : 1,
+ "periodStatus" : "Approved"
+ } ]
+ }
}
},
"required" : true
@@ -13123,7 +13259,14 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/EmployeeOpeningBalances"
},
- "example" : "{ \"statutoryAdoptionPay\": 20, \"statutoryMaternityPay\": 20, \"statutoryPaternityPay\": 20, \"statutorySharedParentalPay\": 20, \"statutorySickPay\": 20, \"priorEmployeeNumber\": 20 }"
+ "example" : {
+ "statutoryAdoptionPay" : 20,
+ "statutoryMaternityPay" : 20,
+ "statutoryPaternityPay" : 20,
+ "statutorySharedParentalPay" : 20,
+ "statutorySickPay" : 20,
+ "priorEmployeeNumber" : 20
+ }
}
},
"required" : true
@@ -13328,7 +13471,15 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/SalaryAndWage"
},
- "example" : "{ \"earningsRateID\": \"87f5b43a-cf51-4b74-92de-94c819e82d27\", \"numberOfUnitsPerWeek\": 3, \"ratePerUnit\": 11, \"effectiveFrom\": \"2020-05-15\", \"annualSalary\": 101, \"status\": \"ACTIVE\", \"paymentType\": \"Salary\" }"
+ "example" : {
+ "earningsRateID" : "87f5b43a-cf51-4b74-92de-94c819e82d27",
+ "numberOfUnitsPerWeek" : 3,
+ "ratePerUnit" : 11,
+ "effectiveFrom" : "2020-05-15",
+ "annualSalary" : 101,
+ "status" : "ACTIVE",
+ "paymentType" : "Salary"
+ }
}
},
"required" : true
@@ -13506,7 +13657,9 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/PayRun"
},
- "example" : "{ \"paymentDate\": \"2020-05-01\" }"
+ "example" : {
+ "paymentDate" : "2020-05-01"
+ }
}
},
"required" : true
@@ -13712,7 +13865,11 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/TimesheetLine"
},
- "example" : "{ \"date\": \"2020-04-14\", \"earningsRateID\": \"87f5b43a-cf51-4b74-92de-94c819e82d27\", \"numberOfUnits\": 2 }"
+ "example" : {
+ "date" : "2020-04-14",
+ "earningsRateID" : "87f5b43a-cf51-4b74-92de-94c819e82d27",
+ "numberOfUnits" : 2
+ }
}
},
"required" : true
diff --git a/docs/projects/index.html b/docs/projects/index.html
index 5d982425..0585df0a 100644
--- a/docs/projects/index.html
+++ b/docs/projects/index.html
@@ -2000,7 +2000,13 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/TimeEntryCreateOrUpdate"
},
- "example" : "{ \"userId\": \"00000000-0000-0000-0000-000000000000\", \"taskId\": \"00000000-0000-0000-0000-000000000000\", \"dateUtc\": \"2020-02-26T15:00:00Z\", \"duration\":30, \"description\": \"My description\" }"
+ "example" : {
+ "userId" : "00000000-0000-0000-0000-000000000000",
+ "taskId" : "00000000-0000-0000-0000-000000000000",
+ "dateUtc" : "2020-02-26T15:00:00Z",
+ "duration" : 30,
+ "description" : "My description"
+ }
}
},
"required" : true
@@ -4322,7 +4328,13 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/TimeEntryCreateOrUpdate"
},
- "example" : "{ \"userId\": \"00000000-0000-0000-0000-000000000000\", \"taskId\": \"00000000-0000-0000-0000-000000000000\", \"dateUtc\": \"2020-02-27T15:00:00Z\", \"duration\":45, \"description\": \"My UPDATED description\" }"
+ "example" : {
+ "userId" : "00000000-0000-0000-0000-000000000000",
+ "taskId" : "00000000-0000-0000-0000-000000000000",
+ "dateUtc" : "2020-02-27T15:00:00Z",
+ "duration" : 45,
+ "description" : "My UPDATED description"
+ }
}
},
"required" : true
diff --git a/src/gen/api/accountingApi.ts b/src/gen/api/accountingApi.ts
index e5faf9e9..fa15fe83 100644
--- a/src/gen/api/accountingApi.ts
+++ b/src/gen/api/accountingApi.ts
@@ -68,7 +68,7 @@ import { TrackingOption } from '../model/accounting/trackingOption';
import { TrackingOptions } from '../model/accounting/trackingOptions';
import { Users } from '../model/accounting/users';
-import { ObjectSerializer, Authentication, VoidAuth } from '../model/accounting/models';
+import { ObjectSerializer, Authentication, VoidAuth, RequestFile } from '../model/accounting/models';
import { ApiError } from '../../model/ApiError';
import axios, { AxiosRequestConfig, AxiosResponse } from 'axios';
import { Readable } from "stream";
@@ -215,7 +215,7 @@ export class AccountingApi {
* @param body Byte array of file in body of request
* @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
*/
- public async createAccountAttachmentByFileName (xeroTenantId: string, accountID: string, fileName: string, body: fs.ReadStream | Readable | Buffer , idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
+ public async createAccountAttachmentByFileName (xeroTenantId: string, accountID: string, fileName: string, body: RequestFile, idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
const localVarPath = this.basePath + '/Accounts/{AccountID}/Attachments/{FileName}'
.replace('{' + 'AccountID' + '}', encodeURIComponent(String(accountID)))
.replace('{' + 'FileName' + '}', encodeURIComponent(String(fileName)));
@@ -261,7 +261,7 @@ export class AccountingApi {
headers: localVarHeaderParams,
url: localVarPath,
responseType: responseTypeOption,
- data: ObjectSerializer.serialize(body, "string"),
+ data: ObjectSerializer.serialize(body, "RequestFile"),
};
let authenticationPromise = Promise.resolve();
@@ -325,7 +325,7 @@ export class AccountingApi {
* @param body Byte array of file in body of request
* @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
*/
- public async createBankTransactionAttachmentByFileName (xeroTenantId: string, bankTransactionID: string, fileName: string, body: fs.ReadStream | Readable | Buffer , idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
+ public async createBankTransactionAttachmentByFileName (xeroTenantId: string, bankTransactionID: string, fileName: string, body: RequestFile, idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
const localVarPath = this.basePath + '/BankTransactions/{BankTransactionID}/Attachments/{FileName}'
.replace('{' + 'BankTransactionID' + '}', encodeURIComponent(String(bankTransactionID)))
.replace('{' + 'FileName' + '}', encodeURIComponent(String(fileName)));
@@ -371,7 +371,7 @@ export class AccountingApi {
headers: localVarHeaderParams,
url: localVarPath,
responseType: responseTypeOption,
- data: ObjectSerializer.serialize(body, "string"),
+ data: ObjectSerializer.serialize(body, "RequestFile"),
};
let authenticationPromise = Promise.resolve();
@@ -676,7 +676,7 @@ export class AccountingApi {
* @param body Byte array of file in body of request
* @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
*/
- public async createBankTransferAttachmentByFileName (xeroTenantId: string, bankTransferID: string, fileName: string, body: fs.ReadStream | Readable | Buffer , idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
+ public async createBankTransferAttachmentByFileName (xeroTenantId: string, bankTransferID: string, fileName: string, body: RequestFile, idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
const localVarPath = this.basePath + '/BankTransfers/{BankTransferID}/Attachments/{FileName}'
.replace('{' + 'BankTransferID' + '}', encodeURIComponent(String(bankTransferID)))
.replace('{' + 'FileName' + '}', encodeURIComponent(String(fileName)));
@@ -722,7 +722,7 @@ export class AccountingApi {
headers: localVarHeaderParams,
url: localVarPath,
responseType: responseTypeOption,
- data: ObjectSerializer.serialize(body, "string"),
+ data: ObjectSerializer.serialize(body, "RequestFile"),
};
let authenticationPromise = Promise.resolve();
@@ -1111,7 +1111,7 @@ export class AccountingApi {
* @param body Byte array of file in body of request
* @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
*/
- public async createContactAttachmentByFileName (xeroTenantId: string, contactID: string, fileName: string, body: fs.ReadStream | Readable | Buffer , idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
+ public async createContactAttachmentByFileName (xeroTenantId: string, contactID: string, fileName: string, body: RequestFile, idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
const localVarPath = this.basePath + '/Contacts/{ContactID}/Attachments/{FileName}'
.replace('{' + 'ContactID' + '}', encodeURIComponent(String(contactID)))
.replace('{' + 'FileName' + '}', encodeURIComponent(String(fileName)));
@@ -1157,7 +1157,7 @@ export class AccountingApi {
headers: localVarHeaderParams,
url: localVarPath,
responseType: responseTypeOption,
- data: ObjectSerializer.serialize(body, "string"),
+ data: ObjectSerializer.serialize(body, "RequestFile"),
};
let authenticationPromise = Promise.resolve();
@@ -1628,7 +1628,7 @@ export class AccountingApi {
* @param includeOnline Allows an attachment to be seen by the end customer within their online invoice
* @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
*/
- public async createCreditNoteAttachmentByFileName (xeroTenantId: string, creditNoteID: string, fileName: string, body: fs.ReadStream | Readable | Buffer , includeOnline?: boolean, idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
+ public async createCreditNoteAttachmentByFileName (xeroTenantId: string, creditNoteID: string, fileName: string, body: RequestFile, includeOnline?: boolean, idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
const localVarPath = this.basePath + '/CreditNotes/{CreditNoteID}/Attachments/{FileName}'
.replace('{' + 'CreditNoteID' + '}', encodeURIComponent(String(creditNoteID)))
.replace('{' + 'FileName' + '}', encodeURIComponent(String(fileName)));
@@ -1678,7 +1678,7 @@ export class AccountingApi {
headers: localVarHeaderParams,
url: localVarPath,
responseType: responseTypeOption,
- data: ObjectSerializer.serialize(body, "string"),
+ data: ObjectSerializer.serialize(body, "RequestFile"),
};
let authenticationPromise = Promise.resolve();
@@ -2222,7 +2222,7 @@ export class AccountingApi {
* @param includeOnline Allows an attachment to be seen by the end customer within their online invoice
* @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
*/
- public async createInvoiceAttachmentByFileName (xeroTenantId: string, invoiceID: string, fileName: string, body: fs.ReadStream | Readable | Buffer , includeOnline?: boolean, idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
+ public async createInvoiceAttachmentByFileName (xeroTenantId: string, invoiceID: string, fileName: string, body: RequestFile, includeOnline?: boolean, idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
const localVarPath = this.basePath + '/Invoices/{InvoiceID}/Attachments/{FileName}'
.replace('{' + 'InvoiceID' + '}', encodeURIComponent(String(invoiceID)))
.replace('{' + 'FileName' + '}', encodeURIComponent(String(fileName)));
@@ -2272,7 +2272,7 @@ export class AccountingApi {
headers: localVarHeaderParams,
url: localVarPath,
responseType: responseTypeOption,
- data: ObjectSerializer.serialize(body, "string"),
+ data: ObjectSerializer.serialize(body, "RequestFile"),
};
let authenticationPromise = Promise.resolve();
@@ -2745,7 +2745,7 @@ export class AccountingApi {
* @param body Byte array of file in body of request
* @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
*/
- public async createManualJournalAttachmentByFileName (xeroTenantId: string, manualJournalID: string, fileName: string, body: fs.ReadStream | Readable | Buffer , idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
+ public async createManualJournalAttachmentByFileName (xeroTenantId: string, manualJournalID: string, fileName: string, body: RequestFile, idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
const localVarPath = this.basePath + '/ManualJournals/{ManualJournalID}/Attachments/{FileName}'
.replace('{' + 'ManualJournalID' + '}', encodeURIComponent(String(manualJournalID)))
.replace('{' + 'FileName' + '}', encodeURIComponent(String(fileName)));
@@ -2791,7 +2791,7 @@ export class AccountingApi {
headers: localVarHeaderParams,
url: localVarPath,
responseType: responseTypeOption,
- data: ObjectSerializer.serialize(body, "string"),
+ data: ObjectSerializer.serialize(body, "RequestFile"),
};
let authenticationPromise = Promise.resolve();
@@ -3667,7 +3667,7 @@ export class AccountingApi {
* @param body Byte array of file in body of request
* @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
*/
- public async createPurchaseOrderAttachmentByFileName (xeroTenantId: string, purchaseOrderID: string, fileName: string, body: fs.ReadStream | Readable | Buffer , idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
+ public async createPurchaseOrderAttachmentByFileName (xeroTenantId: string, purchaseOrderID: string, fileName: string, body: RequestFile, idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
const localVarPath = this.basePath + '/PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName}'
.replace('{' + 'PurchaseOrderID' + '}', encodeURIComponent(String(purchaseOrderID)))
.replace('{' + 'FileName' + '}', encodeURIComponent(String(fileName)));
@@ -3713,7 +3713,7 @@ export class AccountingApi {
headers: localVarHeaderParams,
url: localVarPath,
responseType: responseTypeOption,
- data: ObjectSerializer.serialize(body, "string"),
+ data: ObjectSerializer.serialize(body, "RequestFile"),
};
let authenticationPromise = Promise.resolve();
@@ -3939,7 +3939,7 @@ export class AccountingApi {
* @param body Byte array of file in body of request
* @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
*/
- public async createQuoteAttachmentByFileName (xeroTenantId: string, quoteID: string, fileName: string, body: fs.ReadStream | Readable | Buffer , idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
+ public async createQuoteAttachmentByFileName (xeroTenantId: string, quoteID: string, fileName: string, body: RequestFile, idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
const localVarPath = this.basePath + '/Quotes/{QuoteID}/Attachments/{FileName}'
.replace('{' + 'QuoteID' + '}', encodeURIComponent(String(quoteID)))
.replace('{' + 'FileName' + '}', encodeURIComponent(String(fileName)));
@@ -3985,7 +3985,7 @@ export class AccountingApi {
headers: localVarHeaderParams,
url: localVarPath,
responseType: responseTypeOption,
- data: ObjectSerializer.serialize(body, "string"),
+ data: ObjectSerializer.serialize(body, "RequestFile"),
};
let authenticationPromise = Promise.resolve();
@@ -4291,7 +4291,7 @@ export class AccountingApi {
* @param body Byte array of file in body of request
* @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
*/
- public async createReceiptAttachmentByFileName (xeroTenantId: string, receiptID: string, fileName: string, body: fs.ReadStream | Readable | Buffer , idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
+ public async createReceiptAttachmentByFileName (xeroTenantId: string, receiptID: string, fileName: string, body: RequestFile, idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
const localVarPath = this.basePath + '/Receipts/{ReceiptID}/Attachments/{FileName}'
.replace('{' + 'ReceiptID' + '}', encodeURIComponent(String(receiptID)))
.replace('{' + 'FileName' + '}', encodeURIComponent(String(fileName)));
@@ -4337,7 +4337,7 @@ export class AccountingApi {
headers: localVarHeaderParams,
url: localVarPath,
responseType: responseTypeOption,
- data: ObjectSerializer.serialize(body, "string"),
+ data: ObjectSerializer.serialize(body, "RequestFile"),
};
let authenticationPromise = Promise.resolve();
@@ -4483,7 +4483,7 @@ export class AccountingApi {
* @param body Byte array of file in body of request
* @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
*/
- public async createRepeatingInvoiceAttachmentByFileName (xeroTenantId: string, repeatingInvoiceID: string, fileName: string, body: fs.ReadStream | Readable | Buffer , idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
+ public async createRepeatingInvoiceAttachmentByFileName (xeroTenantId: string, repeatingInvoiceID: string, fileName: string, body: RequestFile, idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
const localVarPath = this.basePath + '/RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName}'
.replace('{' + 'RepeatingInvoiceID' + '}', encodeURIComponent(String(repeatingInvoiceID)))
.replace('{' + 'FileName' + '}', encodeURIComponent(String(fileName)));
@@ -4529,7 +4529,7 @@ export class AccountingApi {
headers: localVarHeaderParams,
url: localVarPath,
responseType: responseTypeOption,
- data: ObjectSerializer.serialize(body, "string"),
+ data: ObjectSerializer.serialize(body, "RequestFile"),
};
let authenticationPromise = Promise.resolve();
@@ -16505,7 +16505,7 @@ export class AccountingApi {
* @param body Byte array of file in body of request
* @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
*/
- public async updateAccountAttachmentByFileName (xeroTenantId: string, accountID: string, fileName: string, body: fs.ReadStream | Readable | Buffer , idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
+ public async updateAccountAttachmentByFileName (xeroTenantId: string, accountID: string, fileName: string, body: RequestFile, idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
const localVarPath = this.basePath + '/Accounts/{AccountID}/Attachments/{FileName}'
.replace('{' + 'AccountID' + '}', encodeURIComponent(String(accountID)))
.replace('{' + 'FileName' + '}', encodeURIComponent(String(fileName)));
@@ -16551,7 +16551,7 @@ export class AccountingApi {
headers: localVarHeaderParams,
url: localVarPath,
responseType: responseTypeOption,
- data: ObjectSerializer.serialize(body, "string"),
+ data: ObjectSerializer.serialize(body, "RequestFile"),
};
let authenticationPromise = Promise.resolve();
@@ -16702,7 +16702,7 @@ export class AccountingApi {
* @param body Byte array of file in body of request
* @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
*/
- public async updateBankTransactionAttachmentByFileName (xeroTenantId: string, bankTransactionID: string, fileName: string, body: fs.ReadStream | Readable | Buffer , idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
+ public async updateBankTransactionAttachmentByFileName (xeroTenantId: string, bankTransactionID: string, fileName: string, body: RequestFile, idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
const localVarPath = this.basePath + '/BankTransactions/{BankTransactionID}/Attachments/{FileName}'
.replace('{' + 'BankTransactionID' + '}', encodeURIComponent(String(bankTransactionID)))
.replace('{' + 'FileName' + '}', encodeURIComponent(String(fileName)));
@@ -16748,7 +16748,7 @@ export class AccountingApi {
headers: localVarHeaderParams,
url: localVarPath,
responseType: responseTypeOption,
- data: ObjectSerializer.serialize(body, "string"),
+ data: ObjectSerializer.serialize(body, "RequestFile"),
};
let authenticationPromise = Promise.resolve();
@@ -16811,7 +16811,7 @@ export class AccountingApi {
* @param body Byte array of file in body of request
* @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
*/
- public async updateBankTransferAttachmentByFileName (xeroTenantId: string, bankTransferID: string, fileName: string, body: fs.ReadStream | Readable | Buffer , idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
+ public async updateBankTransferAttachmentByFileName (xeroTenantId: string, bankTransferID: string, fileName: string, body: RequestFile, idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
const localVarPath = this.basePath + '/BankTransfers/{BankTransferID}/Attachments/{FileName}'
.replace('{' + 'BankTransferID' + '}', encodeURIComponent(String(bankTransferID)))
.replace('{' + 'FileName' + '}', encodeURIComponent(String(fileName)));
@@ -16857,7 +16857,7 @@ export class AccountingApi {
headers: localVarHeaderParams,
url: localVarPath,
responseType: responseTypeOption,
- data: ObjectSerializer.serialize(body, "string"),
+ data: ObjectSerializer.serialize(body, "RequestFile"),
};
let authenticationPromise = Promise.resolve();
@@ -17002,7 +17002,7 @@ export class AccountingApi {
* @param body Byte array of file in body of request
* @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
*/
- public async updateContactAttachmentByFileName (xeroTenantId: string, contactID: string, fileName: string, body: fs.ReadStream | Readable | Buffer , idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
+ public async updateContactAttachmentByFileName (xeroTenantId: string, contactID: string, fileName: string, body: RequestFile, idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
const localVarPath = this.basePath + '/Contacts/{ContactID}/Attachments/{FileName}'
.replace('{' + 'ContactID' + '}', encodeURIComponent(String(contactID)))
.replace('{' + 'FileName' + '}', encodeURIComponent(String(fileName)));
@@ -17048,7 +17048,7 @@ export class AccountingApi {
headers: localVarHeaderParams,
url: localVarPath,
responseType: responseTypeOption,
- data: ObjectSerializer.serialize(body, "string"),
+ data: ObjectSerializer.serialize(body, "RequestFile"),
};
let authenticationPromise = Promise.resolve();
@@ -17281,7 +17281,7 @@ export class AccountingApi {
* @param body Byte array of file in body of request
* @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
*/
- public async updateCreditNoteAttachmentByFileName (xeroTenantId: string, creditNoteID: string, fileName: string, body: fs.ReadStream | Readable | Buffer , idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
+ public async updateCreditNoteAttachmentByFileName (xeroTenantId: string, creditNoteID: string, fileName: string, body: RequestFile, idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
const localVarPath = this.basePath + '/CreditNotes/{CreditNoteID}/Attachments/{FileName}'
.replace('{' + 'CreditNoteID' + '}', encodeURIComponent(String(creditNoteID)))
.replace('{' + 'FileName' + '}', encodeURIComponent(String(fileName)));
@@ -17327,7 +17327,7 @@ export class AccountingApi {
headers: localVarHeaderParams,
url: localVarPath,
responseType: responseTypeOption,
- data: ObjectSerializer.serialize(body, "string"),
+ data: ObjectSerializer.serialize(body, "RequestFile"),
};
let authenticationPromise = Promise.resolve();
@@ -17560,7 +17560,7 @@ export class AccountingApi {
* @param body Byte array of file in body of request
* @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
*/
- public async updateInvoiceAttachmentByFileName (xeroTenantId: string, invoiceID: string, fileName: string, body: fs.ReadStream | Readable | Buffer , idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
+ public async updateInvoiceAttachmentByFileName (xeroTenantId: string, invoiceID: string, fileName: string, body: RequestFile, idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
const localVarPath = this.basePath + '/Invoices/{InvoiceID}/Attachments/{FileName}'
.replace('{' + 'InvoiceID' + '}', encodeURIComponent(String(invoiceID)))
.replace('{' + 'FileName' + '}', encodeURIComponent(String(fileName)));
@@ -17606,7 +17606,7 @@ export class AccountingApi {
headers: localVarHeaderParams,
url: localVarPath,
responseType: responseTypeOption,
- data: ObjectSerializer.serialize(body, "string"),
+ data: ObjectSerializer.serialize(body, "RequestFile"),
};
let authenticationPromise = Promise.resolve();
@@ -17921,7 +17921,7 @@ export class AccountingApi {
* @param body Byte array of file in body of request
* @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
*/
- public async updateManualJournalAttachmentByFileName (xeroTenantId: string, manualJournalID: string, fileName: string, body: fs.ReadStream | Readable | Buffer , idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
+ public async updateManualJournalAttachmentByFileName (xeroTenantId: string, manualJournalID: string, fileName: string, body: RequestFile, idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
const localVarPath = this.basePath + '/ManualJournals/{ManualJournalID}/Attachments/{FileName}'
.replace('{' + 'ManualJournalID' + '}', encodeURIComponent(String(manualJournalID)))
.replace('{' + 'FileName' + '}', encodeURIComponent(String(fileName)));
@@ -17967,7 +17967,7 @@ export class AccountingApi {
headers: localVarHeaderParams,
url: localVarPath,
responseType: responseTypeOption,
- data: ObjectSerializer.serialize(body, "string"),
+ data: ObjectSerializer.serialize(body, "RequestFile"),
};
let authenticationPromise = Promise.resolve();
@@ -18933,7 +18933,7 @@ export class AccountingApi {
* @param body Byte array of file in body of request
* @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
*/
- public async updatePurchaseOrderAttachmentByFileName (xeroTenantId: string, purchaseOrderID: string, fileName: string, body: fs.ReadStream | Readable | Buffer , idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
+ public async updatePurchaseOrderAttachmentByFileName (xeroTenantId: string, purchaseOrderID: string, fileName: string, body: RequestFile, idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
const localVarPath = this.basePath + '/PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName}'
.replace('{' + 'PurchaseOrderID' + '}', encodeURIComponent(String(purchaseOrderID)))
.replace('{' + 'FileName' + '}', encodeURIComponent(String(fileName)));
@@ -18979,7 +18979,7 @@ export class AccountingApi {
headers: localVarHeaderParams,
url: localVarPath,
responseType: responseTypeOption,
- data: ObjectSerializer.serialize(body, "string"),
+ data: ObjectSerializer.serialize(body, "RequestFile"),
};
let authenticationPromise = Promise.resolve();
@@ -19125,7 +19125,7 @@ export class AccountingApi {
* @param body Byte array of file in body of request
* @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
*/
- public async updateQuoteAttachmentByFileName (xeroTenantId: string, quoteID: string, fileName: string, body: fs.ReadStream | Readable | Buffer , idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
+ public async updateQuoteAttachmentByFileName (xeroTenantId: string, quoteID: string, fileName: string, body: RequestFile, idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
const localVarPath = this.basePath + '/Quotes/{QuoteID}/Attachments/{FileName}'
.replace('{' + 'QuoteID' + '}', encodeURIComponent(String(quoteID)))
.replace('{' + 'FileName' + '}', encodeURIComponent(String(fileName)));
@@ -19171,7 +19171,7 @@ export class AccountingApi {
headers: localVarHeaderParams,
url: localVarPath,
responseType: responseTypeOption,
- data: ObjectSerializer.serialize(body, "string"),
+ data: ObjectSerializer.serialize(body, "RequestFile"),
};
let authenticationPromise = Promise.resolve();
@@ -19322,7 +19322,7 @@ export class AccountingApi {
* @param body Byte array of file in body of request
* @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
*/
- public async updateReceiptAttachmentByFileName (xeroTenantId: string, receiptID: string, fileName: string, body: fs.ReadStream | Readable | Buffer , idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
+ public async updateReceiptAttachmentByFileName (xeroTenantId: string, receiptID: string, fileName: string, body: RequestFile, idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
const localVarPath = this.basePath + '/Receipts/{ReceiptID}/Attachments/{FileName}'
.replace('{' + 'ReceiptID' + '}', encodeURIComponent(String(receiptID)))
.replace('{' + 'FileName' + '}', encodeURIComponent(String(fileName)));
@@ -19368,7 +19368,7 @@ export class AccountingApi {
headers: localVarHeaderParams,
url: localVarPath,
responseType: responseTypeOption,
- data: ObjectSerializer.serialize(body, "string"),
+ data: ObjectSerializer.serialize(body, "RequestFile"),
};
let authenticationPromise = Promise.resolve();
@@ -19514,7 +19514,7 @@ export class AccountingApi {
* @param body Byte array of file in body of request
* @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
*/
- public async updateRepeatingInvoiceAttachmentByFileName (xeroTenantId: string, repeatingInvoiceID: string, fileName: string, body: fs.ReadStream | Readable | Buffer , idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
+ public async updateRepeatingInvoiceAttachmentByFileName (xeroTenantId: string, repeatingInvoiceID: string, fileName: string, body: RequestFile, idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Attachments; }> {
const localVarPath = this.basePath + '/RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName}'
.replace('{' + 'RepeatingInvoiceID' + '}', encodeURIComponent(String(repeatingInvoiceID)))
.replace('{' + 'FileName' + '}', encodeURIComponent(String(fileName)));
@@ -19560,7 +19560,7 @@ export class AccountingApi {
headers: localVarHeaderParams,
url: localVarPath,
responseType: responseTypeOption,
- data: ObjectSerializer.serialize(body, "string"),
+ data: ObjectSerializer.serialize(body, "RequestFile"),
};
let authenticationPromise = Promise.resolve();
diff --git a/src/gen/api/appStoreApi.ts b/src/gen/api/appStoreApi.ts
index be416be0..7b62316c 100644
--- a/src/gen/api/appStoreApi.ts
+++ b/src/gen/api/appStoreApi.ts
@@ -21,7 +21,7 @@ import { UpdateUsageRecord } from '../model/appstore/updateUsageRecord';
import { UsageRecord } from '../model/appstore/usageRecord';
import { UsageRecordsList } from '../model/appstore/usageRecordsList';
-import { ObjectSerializer, Authentication, VoidAuth } from '../model/appstore/models';
+import { ObjectSerializer, Authentication, VoidAuth, RequestFile } from '../model/appstore/models';
import { ApiError } from '../../model/ApiError';
import axios, { AxiosRequestConfig, AxiosResponse } from 'axios';
import { Readable } from "stream";
diff --git a/src/gen/api/assetApi.ts b/src/gen/api/assetApi.ts
index f4ab82ec..d0684a25 100644
--- a/src/gen/api/assetApi.ts
+++ b/src/gen/api/assetApi.ts
@@ -20,7 +20,7 @@ import { AssetType } from '../model/assets/assetType';
import { Assets } from '../model/assets/assets';
import { Setting } from '../model/assets/setting';
-import { ObjectSerializer, Authentication, VoidAuth } from '../model/assets/models';
+import { ObjectSerializer, Authentication, VoidAuth, RequestFile } from '../model/assets/models';
import { ApiError } from '../../model/ApiError';
import axios, { AxiosRequestConfig, AxiosResponse } from 'axios';
import { Readable } from "stream";
diff --git a/src/gen/api/bankfeedsApi.ts b/src/gen/api/bankfeedsApi.ts
index a1887181..68b49de7 100644
--- a/src/gen/api/bankfeedsApi.ts
+++ b/src/gen/api/bankfeedsApi.ts
@@ -19,7 +19,7 @@ import { FeedConnections } from '../model/bankfeeds/feedConnections';
import { Statement } from '../model/bankfeeds/statement';
import { Statements } from '../model/bankfeeds/statements';
-import { ObjectSerializer, Authentication, VoidAuth } from '../model/bankfeeds/models';
+import { ObjectSerializer, Authentication, VoidAuth, RequestFile } from '../model/bankfeeds/models';
import { ApiError } from '../../model/ApiError';
import axios, { AxiosRequestConfig, AxiosResponse } from 'axios';
import { Readable } from "stream";
diff --git a/src/gen/api/filesApi.ts b/src/gen/api/filesApi.ts
index 0e87e135..5df79d74 100644
--- a/src/gen/api/filesApi.ts
+++ b/src/gen/api/filesApi.ts
@@ -19,7 +19,7 @@ import { FileObject } from '../model/files/fileObject';
import { Files } from '../model/files/files';
import { Folder } from '../model/files/folder';
-import { ObjectSerializer, Authentication, VoidAuth } from '../model/files/models';
+import { ObjectSerializer, Authentication, VoidAuth, RequestFile } from '../model/files/models';
import { ApiError } from '../../model/ApiError';
import axios, { AxiosRequestConfig, AxiosResponse } from 'axios';
import { Readable } from "stream";
@@ -1347,8 +1347,7 @@ export class FilesApi {
if (body === null || body === undefined) {
throw new Error('Required parameter body was null or undefined when calling uploadFile.');
}
- this.binaryHeaders = {'Accept': 'application/json'};
- (
Object).assign(localVarHeaderParams, this.binaryHeaders);
+
// verify required parameter 'name' is not null or undefined
if (name === null || name === undefined) {
throw new Error('Required parameter name was null or undefined when calling uploadFile.');
@@ -1459,8 +1458,7 @@ export class FilesApi {
if (body === null || body === undefined) {
throw new Error('Required parameter body was null or undefined when calling uploadFileToFolder.');
}
- this.binaryHeaders = {'Accept': 'application/json'};
- (Object).assign(localVarHeaderParams, this.binaryHeaders);
+
// verify required parameter 'name' is not null or undefined
if (name === null || name === undefined) {
throw new Error('Required parameter name was null or undefined when calling uploadFileToFolder.');
diff --git a/src/gen/api/financeApi.ts b/src/gen/api/financeApi.ts
index fcfd7cc4..fb6ce9c3 100644
--- a/src/gen/api/financeApi.ts
+++ b/src/gen/api/financeApi.ts
@@ -27,7 +27,7 @@ import { ReportHistoryResponse } from '../model/finance/reportHistoryResponse';
import { TrialBalanceResponse } from '../model/finance/trialBalanceResponse';
import { UserActivitiesResponse } from '../model/finance/userActivitiesResponse';
-import { ObjectSerializer, Authentication, VoidAuth } from '../model/finance/models';
+import { ObjectSerializer, Authentication, VoidAuth, RequestFile } from '../model/finance/models';
import { ApiError } from '../../model/ApiError';
import axios, { AxiosRequestConfig, AxiosResponse } from 'axios';
import { Readable } from "stream";
diff --git a/src/gen/api/payrollAUApi.ts b/src/gen/api/payrollAUApi.ts
index 26d49c1b..eff75af9 100644
--- a/src/gen/api/payrollAUApi.ts
+++ b/src/gen/api/payrollAUApi.ts
@@ -36,7 +36,7 @@ import { Timesheet } from '../model/payroll-au/timesheet';
import { TimesheetObject } from '../model/payroll-au/timesheetObject';
import { Timesheets } from '../model/payroll-au/timesheets';
-import { ObjectSerializer, Authentication, VoidAuth } from '../model/payroll-au/models';
+import { ObjectSerializer, Authentication, VoidAuth, RequestFile } from '../model/payroll-au/models';
import { ApiError } from '../../model/ApiError';
import axios, { AxiosRequestConfig, AxiosResponse } from 'axios';
import { Readable } from "stream";
diff --git a/src/gen/api/payrollNZApi.ts b/src/gen/api/payrollNZApi.ts
index b2c8b2d6..83a318e7 100644
--- a/src/gen/api/payrollNZApi.ts
+++ b/src/gen/api/payrollNZApi.ts
@@ -80,7 +80,7 @@ import { TimesheetObject } from '../model/payroll-nz/timesheetObject';
import { Timesheets } from '../model/payroll-nz/timesheets';
import { TrackingCategories } from '../model/payroll-nz/trackingCategories';
-import { ObjectSerializer, Authentication, VoidAuth } from '../model/payroll-nz/models';
+import { ObjectSerializer, Authentication, VoidAuth, RequestFile } from '../model/payroll-nz/models';
import { ApiError } from '../../model/ApiError';
import axios, { AxiosRequestConfig, AxiosResponse } from 'axios';
import { Readable } from "stream";
diff --git a/src/gen/api/payrollUKApi.ts b/src/gen/api/payrollUKApi.ts
index 8ec54fc4..602eebbf 100644
--- a/src/gen/api/payrollUKApi.ts
+++ b/src/gen/api/payrollUKApi.ts
@@ -77,7 +77,7 @@ import { TimesheetObject } from '../model/payroll-uk/timesheetObject';
import { Timesheets } from '../model/payroll-uk/timesheets';
import { TrackingCategories } from '../model/payroll-uk/trackingCategories';
-import { ObjectSerializer, Authentication, VoidAuth } from '../model/payroll-uk/models';
+import { ObjectSerializer, Authentication, VoidAuth, RequestFile } from '../model/payroll-uk/models';
import { ApiError } from '../../model/ApiError';
import axios, { AxiosRequestConfig, AxiosResponse } from 'axios';
import { Readable } from "stream";
diff --git a/src/gen/api/projectApi.ts b/src/gen/api/projectApi.ts
index 4700fdd5..89e2b990 100644
--- a/src/gen/api/projectApi.ts
+++ b/src/gen/api/projectApi.ts
@@ -27,7 +27,7 @@ import { TimeEntries } from '../model/projects/timeEntries';
import { TimeEntry } from '../model/projects/timeEntry';
import { TimeEntryCreateOrUpdate } from '../model/projects/timeEntryCreateOrUpdate';
-import { ObjectSerializer, Authentication, VoidAuth } from '../model/projects/models';
+import { ObjectSerializer, Authentication, VoidAuth, RequestFile } from '../model/projects/models';
import { ApiError } from '../../model/ApiError';
import axios, { AxiosRequestConfig, AxiosResponse } from 'axios';
import { Readable } from "stream";
diff --git a/src/gen/model/accounting/models.ts b/src/gen/model/accounting/models.ts
index 028fc90c..9db7b137 100644
--- a/src/gen/model/accounting/models.ts
+++ b/src/gen/model/accounting/models.ts
@@ -272,6 +272,11 @@ import { User } from '././user';
import { Users } from '././users';
import { ValidationError } from '././validationError';
+import * as fs from 'fs';
+import { Readable } from "stream";
+
+export type RequestFile = Buffer | fs.ReadStream | Readable;
+
/* tslint:disable:no-unused-variable */
let primitives = [
"string",
diff --git a/src/gen/model/appstore/models.ts b/src/gen/model/appstore/models.ts
index e1efdaab..9f6d16e2 100644
--- a/src/gen/model/appstore/models.ts
+++ b/src/gen/model/appstore/models.ts
@@ -20,6 +20,11 @@ import { UpdateUsageRecord } from '././updateUsageRecord';
import { UsageRecord } from '././usageRecord';
import { UsageRecordsList } from '././usageRecordsList';
+import * as fs from 'fs';
+import { Readable } from "stream";
+
+export type RequestFile = Buffer | fs.ReadStream | Readable;
+
/* tslint:disable:no-unused-variable */
let primitives = [
"string",
diff --git a/src/gen/model/assets/models.ts b/src/gen/model/assets/models.ts
index aba6faad..5dfe0b1a 100644
--- a/src/gen/model/assets/models.ts
+++ b/src/gen/model/assets/models.ts
@@ -24,6 +24,11 @@ import { Pagination } from '././pagination';
import { ResourceValidationErrorsElement } from '././resourceValidationErrorsElement';
import { Setting } from '././setting';
+import * as fs from 'fs';
+import { Readable } from "stream";
+
+export type RequestFile = Buffer | fs.ReadStream | Readable;
+
/* tslint:disable:no-unused-variable */
let primitives = [
"string",
diff --git a/src/gen/model/bankfeeds/models.ts b/src/gen/model/bankfeeds/models.ts
index 109c0065..c725a02f 100644
--- a/src/gen/model/bankfeeds/models.ts
+++ b/src/gen/model/bankfeeds/models.ts
@@ -24,6 +24,11 @@ import { Statement } from '././statement';
import { StatementLine } from '././statementLine';
import { Statements } from '././statements';
+import * as fs from 'fs';
+import { Readable } from "stream";
+
+export type RequestFile = Buffer | fs.ReadStream | Readable;
+
/* tslint:disable:no-unused-variable */
let primitives = [
"string",
diff --git a/src/gen/model/files/models.ts b/src/gen/model/files/models.ts
index ce1fa497..b871bba2 100644
--- a/src/gen/model/files/models.ts
+++ b/src/gen/model/files/models.ts
@@ -18,6 +18,11 @@ import { ObjectType } from '././objectType';
import { UploadObject } from '././uploadObject';
import { User } from '././user';
+import * as fs from 'fs';
+import { Readable } from "stream";
+
+export type RequestFile = Buffer | fs.ReadStream | Readable;
+
/* tslint:disable:no-unused-variable */
let primitives = [
"string",
diff --git a/src/gen/model/finance/models.ts b/src/gen/model/finance/models.ts
index 0996263c..c827e47a 100644
--- a/src/gen/model/finance/models.ts
+++ b/src/gen/model/finance/models.ts
@@ -108,6 +108,11 @@ import { TrialBalanceResponse } from '././trialBalanceResponse';
import { UserActivitiesResponse } from '././userActivitiesResponse';
import { UserResponse } from '././userResponse';
+import * as fs from 'fs';
+import { Readable } from "stream";
+
+export type RequestFile = Buffer | fs.ReadStream | Readable;
+
/* tslint:disable:no-unused-variable */
let primitives = [
"string",
diff --git a/src/gen/model/payroll-au/models.ts b/src/gen/model/payroll-au/models.ts
index 7da3e62f..1146ac66 100644
--- a/src/gen/model/payroll-au/models.ts
+++ b/src/gen/model/payroll-au/models.ts
@@ -176,6 +176,11 @@ import { Timesheets } from '././timesheets';
import { ValidationError } from '././validationError';
import { WorkCondition } from '././workCondition';
+import * as fs from 'fs';
+import { Readable } from "stream";
+
+export type RequestFile = Buffer | fs.ReadStream | Readable;
+
/* tslint:disable:no-unused-variable */
let primitives = [
"string",
diff --git a/src/gen/model/payroll-nz/employee.ts b/src/gen/model/payroll-nz/employee.ts
index d2d32478..92cacdb4 100644
--- a/src/gen/model/payroll-nz/employee.ts
+++ b/src/gen/model/payroll-nz/employee.ts
@@ -12,16 +12,16 @@ export class Employee {
/**
* First name of employee
*/
- 'firstName'?: string;
+ 'firstName': string;
/**
* Last name of employee
*/
- 'lastName'?: string;
+ 'lastName': string;
/**
* Date of birth of the employee (YYYY-MM-DD)
*/
- 'dateOfBirth'?: string;
- 'address'?: Address;
+ 'dateOfBirth': string;
+ 'address': Address;
/**
* The email address for the employee
*/
diff --git a/src/gen/model/payroll-nz/employment.ts b/src/gen/model/payroll-nz/employment.ts
index 194f1113..3407edb5 100644
--- a/src/gen/model/payroll-nz/employment.ts
+++ b/src/gen/model/payroll-nz/employment.ts
@@ -3,7 +3,7 @@ export class Employment {
/**
* Xero unique identifier for the payroll calendar of the employee
*/
- 'payrollCalendarID'?: string;
+ 'payrollCalendarID': string;
/**
* Xero unique identifier for the payrun calendar for the employee (Deprecated in version 1.1.6)
*/
@@ -11,11 +11,11 @@ export class Employment {
/**
* Start date of the employment (YYYY-MM-DD)
*/
- 'startDate'?: string;
+ 'startDate': string;
/**
* Engagement type of the employee
*/
- 'engagementType'?: string;
+ 'engagementType': string;
/**
* End date for an employee with a fixed-term engagement type
*/
diff --git a/src/gen/model/payroll-nz/models.ts b/src/gen/model/payroll-nz/models.ts
index a5eabb2e..1ebc2d5b 100644
--- a/src/gen/model/payroll-nz/models.ts
+++ b/src/gen/model/payroll-nz/models.ts
@@ -210,6 +210,11 @@ import { TrackingCategories } from '././trackingCategories';
import { TrackingCategory } from '././trackingCategory';
import { WorkingWeek } from '././workingWeek';
+import * as fs from 'fs';
+import { Readable } from "stream";
+
+export type RequestFile = Buffer | fs.ReadStream | Readable;
+
/* tslint:disable:no-unused-variable */
let primitives = [
"string",
diff --git a/src/gen/model/payroll-uk/employee.ts b/src/gen/model/payroll-uk/employee.ts
index c405e6fe..7c5afd52 100644
--- a/src/gen/model/payroll-uk/employee.ts
+++ b/src/gen/model/payroll-uk/employee.ts
@@ -8,20 +8,20 @@ export class Employee {
/**
* Title of the employee
*/
- 'title'?: string;
+ 'title': string;
/**
* First name of employee
*/
- 'firstName'?: string;
+ 'firstName': string;
/**
* Last name of employee
*/
- 'lastName'?: string;
+ 'lastName': string;
/**
* Date of birth of the employee (YYYY-MM-DD)
*/
- 'dateOfBirth'?: string;
- 'address'?: Address;
+ 'dateOfBirth': string;
+ 'address': Address;
/**
* The email address for the employee
*/
@@ -29,7 +29,7 @@ export class Employee {
/**
* The employee’s gender
*/
- 'gender'?: Employee.GenderEnum;
+ 'gender': Employee.GenderEnum;
/**
* Employee phone number
*/
diff --git a/src/gen/model/payroll-uk/employment.ts b/src/gen/model/payroll-uk/employment.ts
index af76f3c4..b4c69ccc 100644
--- a/src/gen/model/payroll-uk/employment.ts
+++ b/src/gen/model/payroll-uk/employment.ts
@@ -3,19 +3,19 @@ export class Employment {
/**
* Xero unique identifier for the payroll calendar of the employee
*/
- 'payrollCalendarID'?: string;
+ 'payrollCalendarID': string;
/**
* Start date of the employment (YYYY-MM-DD)
*/
- 'startDate'?: string;
+ 'startDate': string;
/**
* The employment number of the employee
*/
- 'employeeNumber'?: string;
+ 'employeeNumber': string;
/**
* The NI Category of the employee
*/
- 'niCategory'?: Employment.NiCategoryEnum;
+ 'niCategory': Employment.NiCategoryEnum;
static discriminator: string | undefined = undefined;
diff --git a/src/gen/model/payroll-uk/models.ts b/src/gen/model/payroll-uk/models.ts
index 9b62edfc..7c02a47c 100644
--- a/src/gen/model/payroll-uk/models.ts
+++ b/src/gen/model/payroll-uk/models.ts
@@ -180,6 +180,11 @@ import { Timesheets } from '././timesheets';
import { TrackingCategories } from '././trackingCategories';
import { TrackingCategory } from '././trackingCategory';
+import * as fs from 'fs';
+import { Readable } from "stream";
+
+export type RequestFile = Buffer | fs.ReadStream | Readable;
+
/* tslint:disable:no-unused-variable */
let primitives = [
"string",
diff --git a/src/gen/model/projects/models.ts b/src/gen/model/projects/models.ts
index 8c0992d0..44ed8647 100644
--- a/src/gen/model/projects/models.ts
+++ b/src/gen/model/projects/models.ts
@@ -36,6 +36,11 @@ import { TimeEntries } from '././timeEntries';
import { TimeEntry } from '././timeEntry';
import { TimeEntryCreateOrUpdate } from '././timeEntryCreateOrUpdate';
+import * as fs from 'fs';
+import { Readable } from "stream";
+
+export type RequestFile = Buffer | fs.ReadStream | Readable;
+
/* tslint:disable:no-unused-variable */
let primitives = [
"string",