Skip to content

Commit 2afd38f

Browse files
author
sangeet-joy_xero
committed
generated from codegen
1 parent 488cee8 commit 2afd38f

21 files changed

Lines changed: 1892 additions & 436 deletions

File tree

‎docs/accounting/AccountingApi.md‎

Lines changed: 120 additions & 120 deletions
Large diffs are not rendered by default.

‎docs/accounting/index.html‎

Lines changed: 1035 additions & 143 deletions
Large diffs are not rendered by default.

‎docs/app_store/AppStoreApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ api_instance = xero_client.<api_set>
168168

169169
subscription_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Subscription object
170170
subscription_item_id = '00000000-0000-0000-0000-000000000000' # String | The unique identifier of the subscriptionItem
171-
create_usage_record = { "timestamp": "2022-01-21T13:01:00", "quantity": 10 } # CreateUsageRecord | Contains the quantity for the usage record to create
171+
create_usage_record = {"timestamp":"2022-01-21T13:01:00","quantity":10} # CreateUsageRecord | Contains the quantity for the usage record to create
172172
opts = {
173173
idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
174174
}
@@ -240,7 +240,7 @@ api_instance = xero_client.<api_set>
240240
subscription_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Subscription object
241241
subscription_item_id = '00000000-0000-0000-0000-000000000000' # String | The unique identifier of the subscriptionItem
242242
usage_record_id = '00000000-0000-0000-0000-000000000000' # String | The unique identifier of the usage record
243-
update_usage_record = { "quantity": 10 } # UpdateUsageRecord | Contains the quantity for the usage record to update
243+
update_usage_record = {"quantity":10} # UpdateUsageRecord | Contains the quantity for the usage record to update
244244
opts = {
245245
idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
246246
}

‎docs/app_store/index.html‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1601,7 +1601,10 @@ <h2>Parameters</h2>
16011601
"schema" : {
16021602
"$ref" : "#/components/schemas/CreateUsageRecord"
16031603
},
1604-
"example" : "{ \"timestamp\": \"2022-01-21T13:01:00\", \"quantity\": 10 }"
1604+
"example" : {
1605+
"timestamp" : "2022-01-21T13:01:00",
1606+
"quantity" : 10
1607+
}
16051608
}
16061609
},
16071610
"required" : true
@@ -1802,7 +1805,9 @@ <h2>Parameters</h2>
18021805
"schema" : {
18031806
"$ref" : "#/components/schemas/UpdateUsageRecord"
18041807
},
1805-
"example" : "{ \"quantity\": 10 }"
1808+
"example" : {
1809+
"quantity" : 10
1810+
}
18061811
}
18071812
},
18081813
"required" : true

‎docs/assets/AssetApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ api_instance = xero_client.<api_set>
4747

4848

4949
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
50-
asset = { "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 } # Asset | Fixed asset you are creating
50+
asset = {"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} # Asset | Fixed asset you are creating
5151
opts = {
5252
idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
5353
}
@@ -118,7 +118,7 @@ api_instance = xero_client.<api_set>
118118

119119

120120
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
121-
asset_type = { "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" } } # AssetType | Asset type to add
121+
asset_type = {"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"}} # AssetType | Asset type to add
122122
opts = {
123123
idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
124124
}

‎docs/assets/index.html‎

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1030,7 +1030,6 @@
10301030
};
10311031
defs["BookDepreciationDetail"] = {
10321032
"title" : "",
1033-
"required" : [ "name" ],
10341033
"properties" : {
10351034
"currentCapitalGain" : {
10361035
"type" : "number",
@@ -1084,7 +1083,6 @@
10841083
};
10851084
defs["BookDepreciationSetting"] = {
10861085
"title" : "",
1087-
"required" : [ "name" ],
10881086
"properties" : {
10891087
"depreciationMethod" : {
10901088
"type" : "string",
@@ -1563,7 +1561,28 @@ <h2>Parameters</h2>
15631561
"schema" : {
15641562
"$ref" : "#/components/schemas/Asset"
15651563
},
1566-
"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 }"
1564+
"example" : {
1565+
"assetName" : "Computer74863",
1566+
"assetNumber" : "123477544",
1567+
"purchaseDate" : "2020-01-01",
1568+
"purchasePrice" : 100.0,
1569+
"disposalPrice" : 23.23,
1570+
"assetStatus" : "Draft",
1571+
"bookDepreciationSetting" : {
1572+
"depreciationMethod" : "StraightLine",
1573+
"averagingMethod" : "ActualDays",
1574+
"depreciationRate" : 0.5,
1575+
"depreciationCalculationMethod" : "None"
1576+
},
1577+
"bookDepreciationDetail" : {
1578+
"currentCapitalGain" : 5.32,
1579+
"currentGainLoss" : 3.88,
1580+
"depreciationStartDate" : "2020-01-02",
1581+
"costLimit" : 100.0,
1582+
"currentAccumDepreciationAmount" : 2.25
1583+
},
1584+
"AccountingBookValue" : 99.5
1585+
}
15671586
}
15681587
},
15691588
"required" : true
@@ -1715,7 +1734,18 @@ <h2>Parameters</h2>
17151734
"schema" : {
17161735
"$ref" : "#/components/schemas/AssetType"
17171736
},
1718-
"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\" } }"
1737+
"example" : {
1738+
"assetTypeName" : "Machinery11004",
1739+
"fixedAssetAccountId" : "3d8d063a-c148-4bb8-8b3c-a5e2ad3b1e82",
1740+
"depreciationExpenseAccountId" : "d1602f69-f900-4616-8d34-90af393fa368",
1741+
"accumulatedDepreciationAccountId" : "9195cadd-8645-41e6-9f67-7bcd421defe8",
1742+
"bookDepreciationSetting" : {
1743+
"depreciationMethod" : "DiminishingValue100",
1744+
"averagingMethod" : "ActualDays",
1745+
"depreciationRate" : 0.05,
1746+
"depreciationCalculationMethod" : "None"
1747+
}
1748+
}
17191749
}
17201750
},
17211751
"required" : true

‎docs/payroll_au/PayrollAuApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ api_instance = xero_client.<api_set>
278278

279279

280280
xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
281-
pay_item = { "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" } ] } # PayItem |
281+
pay_item = {"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"}]} # PayItem |
282282
opts = {
283283
idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
284284
}
@@ -2100,7 +2100,7 @@ api_instance = xero_client.<api_set>
21002100

21012101
xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
21022102
payslip_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Payslip id for single object
2103-
payslip_lines = { "Payslip": { "EmployeeID": "cdfb8371-0b21-4b8a-8903-1024df6c391e", "DeductionLines": [ { "DeductionTypeID": "727af5e8-b347-4ae7-85fc-9b82266d0aec", "CalculationType": "FIXEDAMOUNT", "NumberOfUnits": 10 } ] } } # Array<PayslipLines> |
2103+
payslip_lines = {"Payslip":{"EmployeeID":"cdfb8371-0b21-4b8a-8903-1024df6c391e","DeductionLines":[{"DeductionTypeID":"727af5e8-b347-4ae7-85fc-9b82266d0aec","CalculationType":"FIXEDAMOUNT","NumberOfUnits":10}]}} # Array<PayslipLines> |
21042104
opts = {
21052105
idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
21062106
}

‎docs/payroll_au/index.html‎

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4133,7 +4133,25 @@ <h2>Parameters</h2>
41334133
"schema" : {
41344134
"$ref" : "#/components/schemas/PayItem"
41354135
},
4136-
"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\" } ] }"
4136+
"example" : {
4137+
"EarningsRates" : [ {
4138+
"Name" : "MyRate",
4139+
"AccountCode" : "400",
4140+
"TypeOfUnits" : "4.00",
4141+
"IsExemptFromTax" : true,
4142+
"IsExemptFromSuper" : true,
4143+
"IsReportableAsW1" : false,
4144+
"AllowanceContributesToAnnualLeaveRate" : false,
4145+
"AllowanceContributesToOvertimeRate" : false,
4146+
"EarningsType" : "ORDINARYTIMEEARNINGS",
4147+
"EarningsRateID" : "1fa4e226-b711-46ba-a8a7-4344c9c5fb87",
4148+
"RateType" : "MULTIPLE",
4149+
"RatePerUnit" : "10.0",
4150+
"Multiplier" : 1.5,
4151+
"Amount" : 5,
4152+
"EmploymentTerminationPaymentType" : "O"
4153+
} ]
4154+
}
41374155
}
41384156
},
41394157
"required" : true
@@ -8054,7 +8072,16 @@ <h2>Parameters</h2>
80548072
"$ref" : "#/components/schemas/PayslipLines"
80558073
}
80568074
},
8057-
"example" : "{ \"Payslip\": { \"EmployeeID\": \"cdfb8371-0b21-4b8a-8903-1024df6c391e\", \"DeductionLines\": [ { \"DeductionTypeID\": \"727af5e8-b347-4ae7-85fc-9b82266d0aec\", \"CalculationType\": \"FIXEDAMOUNT\", \"NumberOfUnits\": 10 } ] } }"
8075+
"example" : {
8076+
"Payslip" : {
8077+
"EmployeeID" : "cdfb8371-0b21-4b8a-8903-1024df6c391e",
8078+
"DeductionLines" : [ {
8079+
"DeductionTypeID" : "727af5e8-b347-4ae7-85fc-9b82266d0aec",
8080+
"CalculationType" : "FIXEDAMOUNT",
8081+
"NumberOfUnits" : 10
8082+
} ]
8083+
}
8084+
}
80588085
}
80598086
},
80608087
"required" : true

‎docs/payroll_nz/Employee.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**employee_id** | **String** | Xero unique identifier for the employee | [optional]
88
**title** | **String** | Title of the employee | [optional]
9-
**first_name** | **String** | First name of employee | [optional]
10-
**last_name** | **String** | Last name of employee | [optional]
11-
**date_of_birth** | **Date** | Date of birth of the employee (YYYY-MM-DD) | [optional]
12-
**address** | [**Address**](Address.md) | | [optional]
9+
**first_name** | **String** | First name of employee |
10+
**last_name** | **String** | Last name of employee |
11+
**date_of_birth** | **Date** | Date of birth of the employee (YYYY-MM-DD) |
12+
**address** | [**Address**](Address.md) | |
1313
**email** | **String** | The email address for the employee | [optional]
1414
**gender** | **String** | The employee’s gender | [optional]
1515
**phone_number** | **String** | Employee phone number | [optional]

‎docs/payroll_nz/Employment.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**payroll_calendar_id** | **String** | Xero unique identifier for the payroll calendar of the employee | [optional]
7+
**payroll_calendar_id** | **String** | Xero unique identifier for the payroll calendar of the employee |
88
**pay_run_calendar_id** | **String** | Xero unique identifier for the payrun calendar for the employee (Deprecated in version 1.1.6) | [optional]
9-
**start_date** | **Date** | Start date of the employment (YYYY-MM-DD) | [optional]
10-
**engagement_type** | **String** | Engagement type of the employee | [optional]
9+
**start_date** | **Date** | Start date of the employment (YYYY-MM-DD) |
10+
**engagement_type** | **String** | Engagement type of the employee |
1111
**fixed_term_end_date** | **Date** | End date for an employee with a fixed-term engagement type | [optional]
1212

1313
## Code Sample

0 commit comments

Comments
 (0)