PETOSS-656

XeroAPI · Oct 25, 2024 · cf52334 · cf52334
1 parent 6ec08cf
commit cf52334
Show file tree

Hide file tree

Showing 144 changed files with 1,980 additions and 175 deletions.
diff --git a/docs/v2/accounting/index.html b/docs/v2/accounting/index.html
diff --git a/docs/v2/appstore/index.html b/docs/v2/appstore/index.html
@@ -1624,7 +1624,10 @@ <h2>Parameters</h2>
       "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
@@ -1833,7 +1836,9 @@ <h2>Parameters</h2>
       "schema" : {
         "$ref" : "#/components/schemas/UpdateUsageRecord"
       },
-      "example" : "{ \"quantity\": 10 }"
+      "example" : {
+        "quantity" : 10
+      }
     }
   },
   "required" : true

diff --git a/docs/v2/assets/index.html b/docs/v2/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",
@@ -1569,7 +1567,28 @@ <h2>Parameters</h2>
       "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
@@ -1727,7 +1746,18 @@ <h2>Parameters</h2>
       "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/v2/payroll_au/index.html b/docs/v2/payroll_au/index.html
@@ -4156,7 +4156,25 @@ <h2>Parameters</h2>
       "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
@@ -8275,7 +8293,16 @@ <h2>Parameters</h2>
           "$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