diff --git a/README.md b/README.md
index cc9c2c3c..e73b6551 100644
--- a/README.md
+++ b/README.md
@@ -57,7 +57,7 @@ Sample apps can get you started quickly with simple auth flows and advanced usag
# Installation
To install this SDK in your project we recommend using [Composer](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-macos) (For OSX we recommend using [Homebrew](https://formulae.brew.sh/formula/composer)).
-All third party libraries dependencies managed with Composer and the SDK requires `PHP 5.6` and later.
+All third party libraries dependencies managed with Composer and the SDK requires `PHP 8.1` and later.
To install the bindings via [Composer](http://getcomposer.org/), and add the xero-php-oauth2 sdk to your `composer.json` and navigate to where your composer.json file is and run the command:
```
diff --git a/composer.json b/composer.json
index d9c292ee..f8e230eb 100644
--- a/composer.json
+++ b/composer.json
@@ -18,7 +18,7 @@
}
],
"require": {
- "php": ">=5.6",
+ "php": ">=8.1",
"ext-curl": "*",
"ext-json": "*",
"ext-mbstring": "*",
@@ -27,9 +27,8 @@
"firebase/php-jwt": "^6.0"
},
"require-dev": {
- "phpunit/phpunit": "^4.8",
- "squizlabs/php_codesniffer": "~2.6",
- "friendsofphp/php-cs-fixer": "~2.12"
+ "squizlabs/php_codesniffer": "^3.10",
+ "friendsofphp/php-cs-fixer": "^3.60"
},
"autoload": {
"psr-4": { "XeroAPI\\XeroPHP\\" : "lib/" }
diff --git a/docs/v2/accounting/index.html b/docs/v2/accounting/index.html
index df51dea0..1134ba64 100644
--- a/docs/v2/accounting/index.html
+++ b/docs/v2/accounting/index.html
@@ -7210,7 +7210,12 @@
Parameters
"schema" : {
"$ref" : "#/components/schemas/Account"
},
- "example" : "{ \"Code\":\"123456\", \"Name\":\"Foobar\", \"Type\":\"EXPENSE\", \"Description\":\"Hello World\" }"
+ "example" : {
+ "Code" : "123456",
+ "Name" : "Foobar",
+ "Type" : "EXPENSE",
+ "Description" : "Hello World"
+ }
}
},
"required" : true
@@ -7811,7 +7816,11 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/HistoryRecords"
},
- "example" : "{ \"HistoryRecords\": [ { \"Details\": \"Hello World\" } ] }"
+ "example" : {
+ "HistoryRecords" : [ {
+ "Details" : "Hello World"
+ } ]
+ }
}
},
"required" : true
@@ -7983,7 +7992,23 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/BankTransactions"
},
- "example" : "{ bankTransactions: [{ type: BankTransaction.TypeEnum.SPEND, contact: { contactID: \"00000000-0000-0000-0000-000000000000\" }, lineItems: [{ description: \"Foobar\", quantity: 1.0, unitAmount: 20.0, accountCode: \"000\" } ], bankAccount: { code: \"000\" }}]}"
+ "example" : {
+ "bankTransactions" : [ {
+ "type" : "BankTransaction.TypeEnum.SPEND",
+ "contact" : {
+ "contactID" : "00000000-0000-0000-0000-000000000000"
+ },
+ "lineItems" : [ {
+ "description" : "Foobar",
+ "quantity" : 1.0,
+ "unitAmount" : 20.0,
+ "accountCode" : "000"
+ } ],
+ "bankAccount" : {
+ "code" : "000"
+ }
+ } ]
+ }
}
},
"required" : true
@@ -8191,7 +8216,50 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/BankTransfers"
},
- "example" : "{ \"BankTransfers\": [ { \"FromBankAccount\": { \"Code\": \"090\", \"Name\": \"My Savings\", \"AccountID\": \"00000000-0000-0000-0000-000000000000\", \"Type\": \"BANK\", \"BankAccountNumber\": \"123455\", \"Status\": \"ACTIVE\", \"BankAccountType\": \"BANK\", \"CurrencyCode\": \"USD\", \"TaxType\": \"NONE\", \"EnablePaymentsToAccount\": false, \"ShowInExpenseClaims\": false, \"Class\": \"ASSET\", \"ReportingCode\": \"ASS\", \"ReportingCodeName\": \"Assets\", \"HasAttachments\": false, \"UpdatedDateUTC\": \"2016-10-17T13:45:33.993-07:00\" }, \"ToBankAccount\": { \"Code\": \"088\", \"Name\": \"Business Wells Fargo\", \"AccountID\": \"00000000-0000-0000-0000-000000000000\", \"Type\": \"BANK\", \"BankAccountNumber\": \"123455\", \"Status\": \"ACTIVE\", \"BankAccountType\": \"BANK\", \"CurrencyCode\": \"USD\", \"TaxType\": \"NONE\", \"EnablePaymentsToAccount\": false, \"ShowInExpenseClaims\": false, \"Class\": \"ASSET\", \"ReportingCode\": \"ASS\", \"ReportingCodeName\": \"Assets\", \"HasAttachments\": false, \"UpdatedDateUTC\": \"2016-06-03T08:31:14.517-07:00\" }, \"Amount\": \"50.00\", \"FromIsReconciled\": true, \"ToIsReconciled\": true, \"Reference\": \"Sub 098801\" } ] }"
+ "example" : {
+ "BankTransfers" : [ {
+ "FromBankAccount" : {
+ "Code" : "090",
+ "Name" : "My Savings",
+ "AccountID" : "00000000-0000-0000-0000-000000000000",
+ "Type" : "BANK",
+ "BankAccountNumber" : "123455",
+ "Status" : "ACTIVE",
+ "BankAccountType" : "BANK",
+ "CurrencyCode" : "USD",
+ "TaxType" : "NONE",
+ "EnablePaymentsToAccount" : false,
+ "ShowInExpenseClaims" : false,
+ "Class" : "ASSET",
+ "ReportingCode" : "ASS",
+ "ReportingCodeName" : "Assets",
+ "HasAttachments" : false,
+ "UpdatedDateUTC" : "2016-10-17T13:45:33.993-07:00"
+ },
+ "ToBankAccount" : {
+ "Code" : "088",
+ "Name" : "Business Wells Fargo",
+ "AccountID" : "00000000-0000-0000-0000-000000000000",
+ "Type" : "BANK",
+ "BankAccountNumber" : "123455",
+ "Status" : "ACTIVE",
+ "BankAccountType" : "BANK",
+ "CurrencyCode" : "USD",
+ "TaxType" : "NONE",
+ "EnablePaymentsToAccount" : false,
+ "ShowInExpenseClaims" : false,
+ "Class" : "ASSET",
+ "ReportingCode" : "ASS",
+ "ReportingCodeName" : "Assets",
+ "HasAttachments" : false,
+ "UpdatedDateUTC" : "2016-06-03T08:31:14.517-07:00"
+ },
+ "Amount" : "50.00",
+ "FromIsReconciled" : true,
+ "ToIsReconciled" : true,
+ "Reference" : "Sub 098801"
+ } ]
+ }
}
},
"required" : true
@@ -8585,7 +8653,11 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/HistoryRecords"
},
- "example" : "{ \"HistoryRecords\": [ { \"Details\": \"Hello World\" } ] }"
+ "example" : {
+ "HistoryRecords" : [ {
+ "Details" : "Hello World"
+ } ]
+ }
}
},
"required" : true
@@ -8760,7 +8832,28 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/BatchPayments"
},
- "example" : "{ \"BatchPayments\": [ { \"Account\": { \"AccountID\": \"00000000-0000-0000-0000-000000000000\" }, \"Reference\": \"ref\", \"Date\": \"2018-08-01\", \"Payments\": [ { \"Account\": { \"Code\": \"001\" }, \"Date\": \"2019-12-31\", \"Amount\": 500, \"Invoice\": { \"InvoiceID\": \"00000000-0000-0000-0000-000000000000\", \"LineItems\": [], \"Contact\": {}, \"Type\": \"ACCPAY\" } } ] } ] }"
+ "example" : {
+ "BatchPayments" : [ {
+ "Account" : {
+ "AccountID" : "00000000-0000-0000-0000-000000000000"
+ },
+ "Reference" : "ref",
+ "Date" : "2018-08-01",
+ "Payments" : [ {
+ "Account" : {
+ "Code" : "001"
+ },
+ "Date" : "2019-12-31",
+ "Amount" : 500,
+ "Invoice" : {
+ "InvoiceID" : "00000000-0000-0000-0000-000000000000",
+ "LineItems" : [ ],
+ "Contact" : { },
+ "Type" : "ACCPAY"
+ }
+ } ]
+ } ]
+ }
}
},
"required" : true
@@ -8974,7 +9067,11 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/HistoryRecords"
},
- "example" : "{ \"HistoryRecords\": [ { \"Details\": \"Hello World\" } ] }"
+ "example" : {
+ "HistoryRecords" : [ {
+ "Details" : "Hello World"
+ } ]
+ }
}
},
"required" : true
@@ -9164,7 +9261,15 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/PaymentServices"
},
- "example" : "{ \"PaymentServices\": [ { \"PaymentServiceID\": \"54b3b4f6-0443-4fba-bcd1-61ec0c35ca55\", \"PaymentServiceName\": \"PayUpNow\", \"PaymentServiceUrl\": \"https://www.payupnow.com/\", \"PaymentServiceType\": \"Custom\", \"PayNowText\": \"Time To Pay\" } ] }"
+ "example" : {
+ "PaymentServices" : [ {
+ "PaymentServiceID" : "54b3b4f6-0443-4fba-bcd1-61ec0c35ca55",
+ "PaymentServiceName" : "PayUpNow",
+ "PaymentServiceUrl" : "https://www.payupnow.com/",
+ "PaymentServiceType" : "Custom",
+ "PayNowText" : "Time To Pay"
+ } ]
+ }
}
},
"required" : true
@@ -9524,7 +9629,11 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/ContactGroups"
},
- "example" : "{ \"ContactGroups\": [{ \"Name\": \"VIPs\" }]}"
+ "example" : {
+ "ContactGroups" : [ {
+ "Name" : "VIPs"
+ } ]
+ }
}
},
"required" : true
@@ -9711,7 +9820,13 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/Contacts"
},
- "example" : "{ \"Contacts\": [ { \"ContactID\": \"a3675fc4-f8dd-4f03-ba5b-f1870566bcd7\" }, { \"ContactID\": \"4e1753b9-018a-4775-b6aa-1bc7871cfee3\" } ] }"
+ "example" : {
+ "Contacts" : [ {
+ "ContactID" : "a3675fc4-f8dd-4f03-ba5b-f1870566bcd7"
+ }, {
+ "ContactID" : "4e1753b9-018a-4775-b6aa-1bc7871cfee3"
+ } ]
+ }
}
},
"required" : true
@@ -9898,7 +10013,11 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/HistoryRecords"
},
- "example" : "{ \"HistoryRecords\": [ { \"Details\": \"Hello World\" } ] }"
+ "example" : {
+ "HistoryRecords" : [ {
+ "Details" : "Hello World"
+ } ]
+ }
}
},
"required" : true
@@ -10060,7 +10179,66 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/Contacts"
},
- "example" : "{ \"Contacts\": [ { \"ContactID\": \"3ff6d40c-af9a-40a3-89ce-3c1556a25591\", \"ContactStatus\": \"ACTIVE\", \"Name\": \"Foo9987\", \"EmailAddress\": \"sid32476@blah.com\", \"BankAccountDetails\": \"\", \"Addresses\": [ { \"AddressType\": \"STREET\", \"City\": \"\", \"Region\": \"\", \"PostalCode\": \"\", \"Country\": \"\" }, { \"AddressType\": \"POBOX\", \"City\": \"\", \"Region\": \"\", \"PostalCode\": \"\", \"Country\": \"\" } ], \"Phones\": [ { \"PhoneType\": \"DEFAULT\", \"PhoneNumber\": \"\", \"PhoneAreaCode\": \"\", \"PhoneCountryCode\": \"\" }, { \"PhoneType\": \"DDI\", \"PhoneNumber\": \"\", \"PhoneAreaCode\": \"\", \"PhoneCountryCode\": \"\" }, { \"PhoneType\": \"FAX\", \"PhoneNumber\": \"\", \"PhoneAreaCode\": \"\", \"PhoneCountryCode\": \"\" }, { \"PhoneType\": \"MOBILE\", \"PhoneNumber\": \"555-1212\", \"PhoneAreaCode\": \"415\", \"PhoneCountryCode\": \"\" } ], \"UpdatedDateUTC\": \"/Date(1551399321043+0000)/\", \"ContactGroups\": [], \"IsSupplier\": false, \"IsCustomer\": false, \"SalesTrackingCategories\": [], \"PurchasesTrackingCategories\": [], \"PaymentTerms\": { \"Bills\": { \"Day\": 15, \"Type\": \"OFCURRENTMONTH\" }, \"Sales\": { \"Day\": 10, \"Type\": \"DAYSAFTERBILLMONTH\" } }, \"ContactPersons\": [] } ] }"
+ "example" : {
+ "Contacts" : [ {
+ "ContactID" : "3ff6d40c-af9a-40a3-89ce-3c1556a25591",
+ "ContactStatus" : "ACTIVE",
+ "Name" : "Foo9987",
+ "EmailAddress" : "sid32476@blah.com",
+ "BankAccountDetails" : "",
+ "Addresses" : [ {
+ "AddressType" : "STREET",
+ "City" : "",
+ "Region" : "",
+ "PostalCode" : "",
+ "Country" : ""
+ }, {
+ "AddressType" : "POBOX",
+ "City" : "",
+ "Region" : "",
+ "PostalCode" : "",
+ "Country" : ""
+ } ],
+ "Phones" : [ {
+ "PhoneType" : "DEFAULT",
+ "PhoneNumber" : "",
+ "PhoneAreaCode" : "",
+ "PhoneCountryCode" : ""
+ }, {
+ "PhoneType" : "DDI",
+ "PhoneNumber" : "",
+ "PhoneAreaCode" : "",
+ "PhoneCountryCode" : ""
+ }, {
+ "PhoneType" : "FAX",
+ "PhoneNumber" : "",
+ "PhoneAreaCode" : "",
+ "PhoneCountryCode" : ""
+ }, {
+ "PhoneType" : "MOBILE",
+ "PhoneNumber" : "555-1212",
+ "PhoneAreaCode" : "415",
+ "PhoneCountryCode" : ""
+ } ],
+ "UpdatedDateUTC" : "/Date(1551399321043+0000)/",
+ "ContactGroups" : [ ],
+ "IsSupplier" : false,
+ "IsCustomer" : false,
+ "SalesTrackingCategories" : [ ],
+ "PurchasesTrackingCategories" : [ ],
+ "PaymentTerms" : {
+ "Bills" : {
+ "Day" : 15,
+ "Type" : "OFCURRENTMONTH"
+ },
+ "Sales" : {
+ "Day" : 10,
+ "Type" : "DAYSAFTERBILLMONTH"
+ }
+ },
+ "ContactPersons" : [ ]
+ } ]
+ }
}
},
"required" : true
@@ -10281,7 +10459,16 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/Allocations"
},
- "example" : "{ \"Allocations\": [ { \"Invoice\": { \"LineItems\": [], \"InvoiceID\": \"c45720a1-ade3-4a38-a064-d15489be6841\" }, \"Amount\": 1, \"Date\": \"2019-03-05\" } ] }"
+ "example" : {
+ "Allocations" : [ {
+ "Invoice" : {
+ "LineItems" : [ ],
+ "InvoiceID" : "c45720a1-ade3-4a38-a064-d15489be6841"
+ },
+ "Amount" : 1,
+ "Date" : "2019-03-05"
+ } ]
+ }
}
},
"required" : true
@@ -10730,7 +10917,11 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/HistoryRecords"
},
- "example" : "{ \"HistoryRecords\": [ { \"Details\": \"Hello World\" } ] }"
+ "example" : {
+ "HistoryRecords" : [ {
+ "Details" : "Hello World"
+ } ]
+ }
}
},
"required" : true
@@ -10900,7 +11091,21 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/CreditNotes"
},
- "example" : "{ \"CreditNotes\":[ { \"Type\":\"ACCPAYCREDIT\", \"Contact\":{ \"ContactID\":\"430fa14a-f945-44d3-9f97-5df5e28441b8\" }, \"Date\":\"2019-01-05\", \"LineItems\":[ { \"Description\":\"Foobar\", \"Quantity\":2.0, \"UnitAmount\":20.0, \"AccountCode\":\"400\" } ] } ] }"
+ "example" : {
+ "CreditNotes" : [ {
+ "Type" : "ACCPAYCREDIT",
+ "Contact" : {
+ "ContactID" : "430fa14a-f945-44d3-9f97-5df5e28441b8"
+ },
+ "Date" : "2019-01-05",
+ "LineItems" : [ {
+ "Description" : "Foobar",
+ "Quantity" : 2.0,
+ "UnitAmount" : 20.0,
+ "AccountCode" : "400"
+ } ]
+ } ]
+ }
}
},
"required" : true
@@ -11096,7 +11301,10 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/Currency"
},
- "example" : "{ \"Code\": \"USD\", \"Description\": \"United States Dollar\" }"
+ "example" : {
+ "Code" : "USD",
+ "Description" : "United States Dollar"
+ }
}
},
"required" : true
@@ -11251,7 +11459,15 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/Employees"
},
- "example" : "{ \"Employees\": [ { \"FirstName\": \"Nick\", \"LastName\": \"Fury\", \"ExternalLink\": { \"Url\": \"http://twitter.com/#!/search/Nick+Fury\" } } ] }"
+ "example" : {
+ "Employees" : [ {
+ "FirstName" : "Nick",
+ "LastName" : "Fury",
+ "ExternalLink" : {
+ "Url" : "http://twitter.com/#!/search/Nick+Fury"
+ }
+ } ]
+ }
}
},
"required" : true
@@ -11465,7 +11681,11 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/HistoryRecords"
},
- "example" : "{ \"HistoryRecords\": [ { \"Details\": \"Hello World\" } ] }"
+ "example" : {
+ "HistoryRecords" : [ {
+ "Details" : "Hello World"
+ } ]
+ }
}
},
"required" : true
@@ -11630,7 +11850,18 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/ExpenseClaims"
},
- "example" : "{ \"ExpenseClaims\": [ { \"Status\": \"SUBMITTED\", \"User\": { \"UserID\": \"d1164823-0ac1-41ad-987b-b4e30fe0b273\" }, \"Receipts\": [ { \"Lineitems\": [], \"ReceiptID\": \"dc1c7f6d-0a4c-402f-acac-551d62ce5816\" } ] } ] }"
+ "example" : {
+ "ExpenseClaims" : [ {
+ "Status" : "SUBMITTED",
+ "User" : {
+ "UserID" : "d1164823-0ac1-41ad-987b-b4e30fe0b273"
+ },
+ "Receipts" : [ {
+ "Lineitems" : [ ],
+ "ReceiptID" : "dc1c7f6d-0a4c-402f-acac-551d62ce5816"
+ } ]
+ } ]
+ }
}
},
"required" : true
@@ -12052,7 +12283,11 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/HistoryRecords"
},
- "example" : "{ \"HistoryRecords\": [ { \"Details\": \"Hello World\" } ] }"
+ "example" : {
+ "HistoryRecords" : [ {
+ "Details" : "Hello World"
+ } ]
+ }
}
},
"required" : true
@@ -12233,7 +12468,26 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/Invoices"
},
- "example" : "{ \"Invoices\": [ { \"Type\": \"ACCREC\", \"Contact\": { \"ContactID\": \"430fa14a-f945-44d3-9f97-5df5e28441b8\" }, \"LineItems\": [ { \"Description\": \"Acme Tires\", \"Quantity\": 2, \"UnitAmount\": 20, \"AccountCode\": \"200\", \"TaxType\": \"NONE\", \"LineAmount\": 40 } ], \"Date\": \"2019-03-11\", \"DueDate\": \"2018-12-10\", \"Reference\": \"Website Design\", \"Status\": \"AUTHORISED\" } ] }"
+ "example" : {
+ "Invoices" : [ {
+ "Type" : "ACCREC",
+ "Contact" : {
+ "ContactID" : "430fa14a-f945-44d3-9f97-5df5e28441b8"
+ },
+ "LineItems" : [ {
+ "Description" : "Acme Tires",
+ "Quantity" : 2,
+ "UnitAmount" : 20,
+ "AccountCode" : "200",
+ "TaxType" : "NONE",
+ "LineAmount" : 40
+ } ],
+ "Date" : "2019-03-11",
+ "DueDate" : "2018-12-10",
+ "Reference" : "Website Design",
+ "Status" : "AUTHORISED"
+ } ]
+ }
}
},
"required" : true
@@ -12467,7 +12721,11 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/HistoryRecords"
},
- "example" : "{ \"HistoryRecords\": [ { \"Details\": \"Hello World\" } ] }"
+ "example" : {
+ "HistoryRecords" : [ {
+ "Details" : "Hello World"
+ } ]
+ }
}
},
"required" : true
@@ -12629,7 +12887,17 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/Items"
},
- "example" : "{ \"Items\": [ { \"Code\": \"code123\", \"Name\": \"Item Name XYZ\", \"Description\": \"Foobar\", \"InventoryAssetAccountCode\": \"140\", \"PurchaseDetails\": { \"COGSAccountCode\": \"500\" } } ] }"
+ "example" : {
+ "Items" : [ {
+ "Code" : "code123",
+ "Name" : "Item Name XYZ",
+ "Description" : "Foobar",
+ "InventoryAssetAccountCode" : "140",
+ "PurchaseDetails" : {
+ "COGSAccountCode" : "500"
+ }
+ } ]
+ }
}
},
"required" : true
@@ -12825,7 +13093,12 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/LinkedTransaction"
},
- "example" : "{ \"LinkedTransactions\": [ { \"SourceTransactionID\": \"a848644a-f20f-4630-98c3-386bd7505631\", \"SourceLineItemID\": \"b0df260d-3cc8-4ced-9bd6-41924f624ed3\" } ] }"
+ "example" : {
+ "LinkedTransactions" : [ {
+ "SourceTransactionID" : "a848644a-f20f-4630-98c3-386bd7505631",
+ "SourceLineItemID" : "b0df260d-3cc8-4ced-9bd6-41924f624ed3"
+ } ]
+ }
}
},
"required" : true
@@ -13219,7 +13492,11 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/HistoryRecords"
},
- "example" : "{ \"HistoryRecords\": [ { \"Details\": \"Hello World\" } ] }"
+ "example" : {
+ "HistoryRecords" : [ {
+ "Details" : "Hello World"
+ } ]
+ }
}
},
"required" : true
@@ -13389,7 +13666,25 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/ManualJournals"
},
- "example" : "{ \"ManualJournals\": [ { \"Narration\": \"Journal Desc\", \"JournalLines\": [ { \"LineAmount\": 100, \"AccountCode\": \"400\", \"Description\": \"Money Movement\" }, { \"LineAmount\": -100, \"AccountCode\": \"400\", \"Description\": \"Prepayment of things\", \"Tracking\": [ { \"Name\": \"North\", \"Option\": \"Region\" } ] } ], \"Date\": \"2019-03-14\" } ] }"
+ "example" : {
+ "ManualJournals" : [ {
+ "Narration" : "Journal Desc",
+ "JournalLines" : [ {
+ "LineAmount" : 100,
+ "AccountCode" : "400",
+ "Description" : "Money Movement"
+ }, {
+ "LineAmount" : -100,
+ "AccountCode" : "400",
+ "Description" : "Prepayment of things",
+ "Tracking" : [ {
+ "Name" : "North",
+ "Option" : "Region"
+ } ]
+ } ],
+ "Date" : "2019-03-14"
+ } ]
+ }
}
},
"required" : true
@@ -13610,7 +13905,18 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/Allocations"
},
- "example" : "{ \"Allocations\": [ { \"Invoice\": { \"InvoiceID\": \"00000000-0000-0000-0000-000000000000\", \"LineItems\": [], \"Contact\": {}, \"Type\": \"ACCPAY\" }, \"Amount\": 10.00, \"Date\": \"2019-03-12\" } ] }"
+ "example" : {
+ "Allocations" : [ {
+ "Invoice" : {
+ "InvoiceID" : "00000000-0000-0000-0000-000000000000",
+ "LineItems" : [ ],
+ "Contact" : { },
+ "Type" : "ACCPAY"
+ },
+ "Amount" : 10.0,
+ "Date" : "2019-03-12"
+ } ]
+ }
}
},
"required" : true
@@ -13824,7 +14130,11 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/HistoryRecords"
},
- "example" : "{ \"HistoryRecords\": [ { \"Details\": \"Hello World\" } ] }"
+ "example" : {
+ "HistoryRecords" : [ {
+ "Details" : "Hello World"
+ } ]
+ }
}
},
"required" : true
@@ -13987,7 +14297,19 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/Payment"
},
- "example" : "{ \"Payments\": [ { \"Invoice\": { \"LineItems\": [], \"InvoiceID\": \"00000000-0000-0000-0000-000000000000\" }, \"Account\": { \"Code\": \"970\" }, \"Date\": \"2019-03-12\", \"Amount\": 1 } ] }"
+ "example" : {
+ "Payments" : [ {
+ "Invoice" : {
+ "LineItems" : [ ],
+ "InvoiceID" : "00000000-0000-0000-0000-000000000000"
+ },
+ "Account" : {
+ "Code" : "970"
+ },
+ "Date" : "2019-03-12",
+ "Amount" : 1
+ } ]
+ }
}
},
"required" : true
@@ -14174,7 +14496,11 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/HistoryRecords"
},
- "example" : "{ \"HistoryRecords\": [ { \"Details\": \"Hello World\" } ] }"
+ "example" : {
+ "HistoryRecords" : [ {
+ "Details" : "Hello World"
+ } ]
+ }
}
},
"required" : true
@@ -14329,7 +14655,13 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/PaymentServices"
},
- "example" : "{ \"PaymentServices\": [ { \"PaymentServiceName\": \"PayUpNow\", \"PaymentServiceUrl\": \"https://www.payupnow.com/\", \"PayNowText\": \"Time To Pay\" } ] }"
+ "example" : {
+ "PaymentServices" : [ {
+ "PaymentServiceName" : "PayUpNow",
+ "PaymentServiceUrl" : "https://www.payupnow.com/",
+ "PayNowText" : "Time To Pay"
+ } ]
+ }
}
},
"required" : true
@@ -14493,7 +14825,19 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/Payments"
},
- "example" : "{ \"Payments\": [ { \"Invoice\": { \"LineItems\": [], \"InvoiceID\": \"00000000-0000-0000-0000-000000000000\" }, \"Account\": { \"Code\": \"970\" }, \"Date\": \"2019-03-12\", \"Amount\": 1 } ] }"
+ "example" : {
+ "Payments" : [ {
+ "Invoice" : {
+ "LineItems" : [ ],
+ "InvoiceID" : "00000000-0000-0000-0000-000000000000"
+ },
+ "Account" : {
+ "Code" : "970"
+ },
+ "Date" : "2019-03-12",
+ "Amount" : 1
+ } ]
+ }
}
},
"required" : true
@@ -14714,7 +15058,16 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/Allocations"
},
- "example" : "{ \"Allocations\": [ { \"Invoice\": { \"LineItems\": [], \"InvoiceID\": \"00000000-0000-0000-0000-000000000000\" }, \"Amount\": 1, \"Date\": \"2019-01-10\" } ] }"
+ "example" : {
+ "Allocations" : [ {
+ "Invoice" : {
+ "LineItems" : [ ],
+ "InvoiceID" : "00000000-0000-0000-0000-000000000000"
+ },
+ "Amount" : 1,
+ "Date" : "2019-01-10"
+ } ]
+ }
}
},
"required" : true
@@ -14928,7 +15281,11 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/HistoryRecords"
},
- "example" : "{ \"HistoryRecords\": [ { \"Details\": \"Hello World\" } ] }"
+ "example" : {
+ "HistoryRecords" : [ {
+ "Details" : "Hello World"
+ } ]
+ }
}
},
"required" : true
@@ -15322,7 +15679,11 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/HistoryRecords"
},
- "example" : "{ \"HistoryRecords\": [ { \"Details\": \"Hello World\" } ] }"
+ "example" : {
+ "HistoryRecords" : [ {
+ "Details" : "Hello World"
+ } ]
+ }
}
},
"required" : true
@@ -15490,7 +15851,20 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/PurchaseOrders"
},
- "example" : "{ \"PurchaseOrders\": [ { \"Contact\": { \"ContactID\": \"00000000-0000-0000-0000-000000000000\" }, \"LineItems\": [ { \"Description\": \"Foobar\", \"Quantity\": 1, \"UnitAmount\": 20, \"AccountCode\": \"710\" } ], \"Date\": \"2019-03-13\" } ] }"
+ "example" : {
+ "PurchaseOrders" : [ {
+ "Contact" : {
+ "ContactID" : "00000000-0000-0000-0000-000000000000"
+ },
+ "LineItems" : [ {
+ "Description" : "Foobar",
+ "Quantity" : 1,
+ "UnitAmount" : 20,
+ "AccountCode" : "710"
+ } ],
+ "Date" : "2019-03-13"
+ } ]
+ }
}
},
"required" : true
@@ -15911,7 +16285,11 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/HistoryRecords"
},
- "example" : "{ \"HistoryRecords\": [ { \"Details\": \"Hello World\" } ] }"
+ "example" : {
+ "HistoryRecords" : [ {
+ "Details" : "Hello World"
+ } ]
+ }
}
},
"required" : true
@@ -16079,7 +16457,20 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/Quotes"
},
- "example" : "{ \"Quotes\": [ { \"Contact\": { \"ContactID\": \"00000000-0000-0000-0000-000000000000\" }, \"LineItems\": [ { \"Description\": \"Foobar\", \"Quantity\": 1, \"UnitAmount\": 20, \"AccountCode\": \"12775\" } ], \"Date\": \"2020-02-01\" } ] }"
+ "example" : {
+ "Quotes" : [ {
+ "Contact" : {
+ "ContactID" : "00000000-0000-0000-0000-000000000000"
+ },
+ "LineItems" : [ {
+ "Description" : "Foobar",
+ "Quantity" : 1,
+ "UnitAmount" : 20,
+ "AccountCode" : "12775"
+ } ],
+ "Date" : "2020-02-01"
+ } ]
+ }
}
},
"required" : true
@@ -16278,7 +16669,26 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/Receipts"
},
- "example" : "{ \"Receipts\": [ { \"Contact\": { \"ContactID\": \"00000000-0000-0000-0000-000000000000\" }, \"Lineitems\": [ { \"Description\": \"Foobar\", \"Quantity\": 2, \"UnitAmount\": 20, \"AccountCode\": \"400\", \"TaxType\": \"NONE\", \"LineAmount\": 40 } ], \"User\": { \"UserID\": \"00000000-0000-0000-0000-000000000000\" }, \"LineAmountTypes\": \"NoTax\", \"Status\": \"DRAFT\" } ] }"
+ "example" : {
+ "Receipts" : [ {
+ "Contact" : {
+ "ContactID" : "00000000-0000-0000-0000-000000000000"
+ },
+ "Lineitems" : [ {
+ "Description" : "Foobar",
+ "Quantity" : 2,
+ "UnitAmount" : 20,
+ "AccountCode" : "400",
+ "TaxType" : "NONE",
+ "LineAmount" : 40
+ } ],
+ "User" : {
+ "UserID" : "00000000-0000-0000-0000-000000000000"
+ },
+ "LineAmountTypes" : "NoTax",
+ "Status" : "DRAFT"
+ } ]
+ }
}
},
"required" : true
@@ -16699,7 +17109,11 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/HistoryRecords"
},
- "example" : "{ \"HistoryRecords\": [ { \"Details\": \"Hello World\" } ] }"
+ "example" : {
+ "HistoryRecords" : [ {
+ "Details" : "Hello World"
+ } ]
+ }
}
},
"required" : true
@@ -17093,7 +17507,11 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/HistoryRecords"
},
- "example" : "{ \"HistoryRecords\": [ { \"Details\": \"Hello World\" } ] }"
+ "example" : {
+ "HistoryRecords" : [ {
+ "Details" : "Hello World"
+ } ]
+ }
}
},
"required" : true
@@ -17239,7 +17657,42 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/RepeatingInvoices"
},
- "example" : "{ \"RepeatingInvoices\": [ { \"Schedule\": { \"Period\": 1, \"Unit\": \"MONTHLY\", \"DueDate\": 10, \"DueDateType\": \"OFFOLLOWINGMONTH\", \"StartDate\": \"\\/Date(1555286400000+0000)\\/\" }, \"Type\": \"ACCREC\", \"Reference\": \"[Week]\", \"ApprovedForSending\": false, \"SendCopy\": false, \"MarkAsSent\": false, \"IncludePDF\": false, \"Contact\": { \"ContactID\": \"430fa14a-f945-44d3-9f97-5df5e28441b8\", \"Name\": \"Liam Gallagher\" }, \"Status\": \"AUTHORISED\", \"LineAmountTypes\": \"Exclusive\", \"LineItems\": [ { \"Description\": \"Guitars Fender Strat\", \"UnitAmount\": 5000.00, \"TaxType\": \"OUTPUT2\", \"TaxAmount\": 750.00, \"LineAmount\": 5000.00, \"AccountCode\": \"200\", \"Tracking\": [], \"Quantity\": 1.0000, \"LineItemID\": \"13a8353c-d2af-4d5b-920c-438449f08900\", \"DiscountEnteredAsPercent\": true } ], \"CurrencyCode\": \"NZD\" } ] }"
+ "example" : {
+ "RepeatingInvoices" : [ {
+ "Schedule" : {
+ "Period" : 1,
+ "Unit" : "MONTHLY",
+ "DueDate" : 10,
+ "DueDateType" : "OFFOLLOWINGMONTH",
+ "StartDate" : "/Date(1555286400000+0000)/"
+ },
+ "Type" : "ACCREC",
+ "Reference" : "[Week]",
+ "ApprovedForSending" : false,
+ "SendCopy" : false,
+ "MarkAsSent" : false,
+ "IncludePDF" : false,
+ "Contact" : {
+ "ContactID" : "430fa14a-f945-44d3-9f97-5df5e28441b8",
+ "Name" : "Liam Gallagher"
+ },
+ "Status" : "AUTHORISED",
+ "LineAmountTypes" : "Exclusive",
+ "LineItems" : [ {
+ "Description" : "Guitars Fender Strat",
+ "UnitAmount" : 5000.0,
+ "TaxType" : "OUTPUT2",
+ "TaxAmount" : 750.0,
+ "LineAmount" : 5000.0,
+ "AccountCode" : "200",
+ "Tracking" : [ ],
+ "Quantity" : 1.0,
+ "LineItemID" : "13a8353c-d2af-4d5b-920c-438449f08900",
+ "DiscountEnteredAsPercent" : true
+ } ],
+ "CurrencyCode" : "NZD"
+ } ]
+ }
}
},
"required" : true
@@ -17426,7 +17879,15 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/TaxRates"
},
- "example" : "{ \"TaxRates\": [ { \"Name\": \"CA State Tax\", \"TaxComponents\": [ { \"Name\": \"State Tax\", \"Rate\": 2.25 } ] } ] }"
+ "example" : {
+ "TaxRates" : [ {
+ "Name" : "CA State Tax",
+ "TaxComponents" : [ {
+ "Name" : "State Tax",
+ "Rate" : 2.25
+ } ]
+ } ]
+ }
}
},
"required" : true
@@ -17574,7 +18035,9 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/TrackingCategory"
},
- "example" : "{ name: \"FooBar\" }"
+ "example" : {
+ "name" : "FooBar"
+ }
}
},
"required" : true
@@ -17756,7 +18219,9 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/TrackingOption"
},
- "example" : "{ name: \" Bar\" }"
+ "example" : {
+ "name" : " Bar"
+ }
}
},
"required" : true
@@ -18025,7 +18490,10 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/BatchPaymentDelete"
},
- "example" : "{ \"BatchPaymentID\": \"9bf296e9-0748-4d29-a3dc-24dde1098030\", \"Status\":\"DELETED\" }"
+ "example" : {
+ "BatchPaymentID" : "9bf296e9-0748-4d29-a3dc-24dde1098030",
+ "Status" : "DELETED"
+ }
}
},
"required" : true
@@ -18203,7 +18671,9 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/BatchPaymentDeleteByUrlParam"
},
- "example" : "{ \"Status\":\"DELETED\" }"
+ "example" : {
+ "Status" : "DELETED"
+ }
}
},
"required" : true
@@ -19191,7 +19661,11 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/PaymentDelete"
},
- "example" : "{ \"Payments\":[ { \"Status\":\"DELETED\" } ] }"
+ "example" : {
+ "Payments" : [ {
+ "Status" : "DELETED"
+ } ]
+ }
}
},
"required" : true
@@ -19788,7 +20262,7 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/RequestEmpty"
},
- "example" : "{}"
+ "example" : { }
}
},
"required" : true
@@ -39566,7 +40040,33 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/Setup"
},
- "example" : "{ \"ConversionDate\": {}, \"ConversionBalances\": [], \"Accounts\": [ { \"Code\": \"200\", \"Name\": \"Sales\", \"Type\": \"SALES\", \"ReportingCode\": \"REV.TRA.GOO\" }, { \"Code\": \"400\", \"Name\": \"Advertising\", \"Type\": \"OVERHEADS\", \"ReportingCode\": \"EXP\" }, { \"Code\": \"610\", \"Name\": \"Accounts Receivable\", \"Type\": \"CURRENT\", \"SystemAccount\": \"DEBTORS\", \"ReportingCode\": \"ASS.CUR.REC.TRA\" }, { \"Code\": \"800\", \"Name\": \"Accounts Payable\", \"Type\": \"CURRLIAB\", \"SystemAccount\": \"CREDITORS\", \"ReportingCode\": \"LIA.CUR.PAY\" } ] }"
+ "example" : {
+ "ConversionDate" : { },
+ "ConversionBalances" : [ ],
+ "Accounts" : [ {
+ "Code" : "200",
+ "Name" : "Sales",
+ "Type" : "SALES",
+ "ReportingCode" : "REV.TRA.GOO"
+ }, {
+ "Code" : "400",
+ "Name" : "Advertising",
+ "Type" : "OVERHEADS",
+ "ReportingCode" : "EXP"
+ }, {
+ "Code" : "610",
+ "Name" : "Accounts Receivable",
+ "Type" : "CURRENT",
+ "SystemAccount" : "DEBTORS",
+ "ReportingCode" : "ASS.CUR.REC.TRA"
+ }, {
+ "Code" : "800",
+ "Name" : "Accounts Payable",
+ "Type" : "CURRLIAB",
+ "SystemAccount" : "CREDITORS",
+ "ReportingCode" : "LIA.CUR.PAY"
+ } ]
+ }
}
},
"required" : true
@@ -39757,7 +40257,22 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/Accounts"
},
- "example" : "{ \"Accounts\":[ { \"Code\":\"123456\", \"Name\":\"BarFoo\", \"AccountID\":\"99ce6032-0678-4aa0-8148-240c75fee33a\", \"Type\":\"EXPENSE\", \"Description\":\"GoodBye World\", \"TaxType\":\"INPUT\", \"EnablePaymentsToAccount\":false, \"ShowInExpenseClaims\":false, \"Class\":\"EXPENSE\", \"ReportingCode\":\"EXP\", \"ReportingCodeName\":\"Expense\", \"UpdatedDateUTC\":\"2019-02-21T16:29:47.96-08:00\" } ] }"
+ "example" : {
+ "Accounts" : [ {
+ "Code" : "123456",
+ "Name" : "BarFoo",
+ "AccountID" : "99ce6032-0678-4aa0-8148-240c75fee33a",
+ "Type" : "EXPENSE",
+ "Description" : "GoodBye World",
+ "TaxType" : "INPUT",
+ "EnablePaymentsToAccount" : false,
+ "ShowInExpenseClaims" : false,
+ "Class" : "EXPENSE",
+ "ReportingCode" : "EXP",
+ "ReportingCodeName" : "Expense",
+ "UpdatedDateUTC" : "2019-02-21T16:29:47.96-08:00"
+ } ]
+ }
}
},
"required" : true
@@ -40169,7 +40684,77 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/BankTransactions"
},
- "example" : "{ \"BankTransactions\": [ { \"Type\": \"SPEND\", \"Contact\": { \"ContactID\": \"00000000-0000-0000-0000-000000000000\", \"ContactStatus\": \"ACTIVE\", \"Name\": \"Buzz Lightyear\", \"FirstName\": \"Buzz\", \"LastName\": \"Lightyear\", \"EmailAddress\": \"buzz.Lightyear@email.com\", \"ContactPersons\": [], \"BankAccountDetails\": \"\", \"Addresses\": [ { \"AddressType\": \"STREET\", \"City\": \"\", \"Region\": \"\", \"PostalCode\": \"\", \"Country\": \"\" }, { \"AddressType\": \"POBOX\", \"AddressLine1\": \"\", \"AddressLine2\": \"\", \"AddressLine3\": \"\", \"AddressLine4\": \"\", \"City\": \"Palo Alto\", \"Region\": \"CA\", \"PostalCode\": \"94020\", \"Country\": \"United States\" } ], \"Phones\": [ { \"PhoneType\": \"DEFAULT\", \"PhoneNumber\": \"847-1294\", \"PhoneAreaCode\": \"(626)\", \"PhoneCountryCode\": \"\" }, { \"PhoneType\": \"DDI\", \"PhoneNumber\": \"\", \"PhoneAreaCode\": \"\", \"PhoneCountryCode\": \"\" }, { \"PhoneType\": \"FAX\", \"PhoneNumber\": \"\", \"PhoneAreaCode\": \"\", \"PhoneCountryCode\": \"\" }, { \"PhoneType\": \"MOBILE\", \"PhoneNumber\": \"\", \"PhoneAreaCode\": \"\", \"PhoneCountryCode\": \"\" } ], \"UpdatedDateUTC\": \"2017-08-21T13:49:04.227-07:00\", \"ContactGroups\": [] }, \"Lineitems\": [], \"BankAccount\": { \"Code\": \"088\", \"Name\": \"Business Wells Fargo\", \"AccountID\": \"00000000-0000-0000-0000-000000000000\" }, \"IsReconciled\": false, \"Date\": \"2019-02-25\", \"Reference\": \"You just updated\", \"CurrencyCode\": \"USD\", \"CurrencyRate\": 1, \"Status\": \"AUTHORISED\", \"LineAmountTypes\": \"Inclusive\", \"TotalTax\": 1.74, \"BankTransactionID\": \"00000000-0000-0000-0000-000000000000\", \"UpdatedDateUTC\": \"2019-02-26T12:39:27.813-08:00\" } ] }"
+ "example" : {
+ "BankTransactions" : [ {
+ "Type" : "SPEND",
+ "Contact" : {
+ "ContactID" : "00000000-0000-0000-0000-000000000000",
+ "ContactStatus" : "ACTIVE",
+ "Name" : "Buzz Lightyear",
+ "FirstName" : "Buzz",
+ "LastName" : "Lightyear",
+ "EmailAddress" : "buzz.Lightyear@email.com",
+ "ContactPersons" : [ ],
+ "BankAccountDetails" : "",
+ "Addresses" : [ {
+ "AddressType" : "STREET",
+ "City" : "",
+ "Region" : "",
+ "PostalCode" : "",
+ "Country" : ""
+ }, {
+ "AddressType" : "POBOX",
+ "AddressLine1" : "",
+ "AddressLine2" : "",
+ "AddressLine3" : "",
+ "AddressLine4" : "",
+ "City" : "Palo Alto",
+ "Region" : "CA",
+ "PostalCode" : "94020",
+ "Country" : "United States"
+ } ],
+ "Phones" : [ {
+ "PhoneType" : "DEFAULT",
+ "PhoneNumber" : "847-1294",
+ "PhoneAreaCode" : "(626)",
+ "PhoneCountryCode" : ""
+ }, {
+ "PhoneType" : "DDI",
+ "PhoneNumber" : "",
+ "PhoneAreaCode" : "",
+ "PhoneCountryCode" : ""
+ }, {
+ "PhoneType" : "FAX",
+ "PhoneNumber" : "",
+ "PhoneAreaCode" : "",
+ "PhoneCountryCode" : ""
+ }, {
+ "PhoneType" : "MOBILE",
+ "PhoneNumber" : "",
+ "PhoneAreaCode" : "",
+ "PhoneCountryCode" : ""
+ } ],
+ "UpdatedDateUTC" : "2017-08-21T13:49:04.227-07:00",
+ "ContactGroups" : [ ]
+ },
+ "Lineitems" : [ ],
+ "BankAccount" : {
+ "Code" : "088",
+ "Name" : "Business Wells Fargo",
+ "AccountID" : "00000000-0000-0000-0000-000000000000"
+ },
+ "IsReconciled" : false,
+ "Date" : "2019-02-25",
+ "Reference" : "You just updated",
+ "CurrencyCode" : "USD",
+ "CurrencyRate" : 1,
+ "Status" : "AUTHORISED",
+ "LineAmountTypes" : "Inclusive",
+ "TotalTax" : 1.74,
+ "BankTransactionID" : "00000000-0000-0000-0000-000000000000",
+ "UpdatedDateUTC" : "2019-02-26T12:39:27.813-08:00"
+ } ]
+ }
}
},
"required" : true
@@ -40798,7 +41383,12 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/Contacts"
},
- "example" : "{ \"Contacts\": [{ \"ContactID\": \"00000000-0000-0000-0000-000000000000\", \"Name\": \"Thanos\" }]}"
+ "example" : {
+ "Contacts" : [ {
+ "ContactID" : "00000000-0000-0000-0000-000000000000",
+ "Name" : "Thanos"
+ } ]
+ }
}
},
"required" : true
@@ -41192,7 +41782,11 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/ContactGroups"
},
- "example" : "{ \"ContactGroups\":[ { \"Name\":\"Suppliers\" } ] }"
+ "example" : {
+ "ContactGroups" : [ {
+ "Name" : "Suppliers"
+ } ]
+ }
}
},
"required" : true
@@ -41397,7 +41991,24 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/CreditNotes"
},
- "example" : "{ \"CreditNotes\": [ { \"Type\": \"ACCPAYCREDIT\", \"Contact\": { \"ContactID\": \"430fa14a-f945-44d3-9f97-5df5e28441b8\" }, \"Date\": \"2019-01-05\", \"Status\": \"AUTHORISED\", \"Reference\": \"HelloWorld\", \"SentToContact\": true, \"LineItems\": [ { \"Description\": \"Foobar\", \"Quantity\": 2, \"UnitAmount\": 20, \"AccountCode\": \"400\" } ] } ] }"
+ "example" : {
+ "CreditNotes" : [ {
+ "Type" : "ACCPAYCREDIT",
+ "Contact" : {
+ "ContactID" : "430fa14a-f945-44d3-9f97-5df5e28441b8"
+ },
+ "Date" : "2019-01-05",
+ "Status" : "AUTHORISED",
+ "Reference" : "HelloWorld",
+ "SentToContact" : true,
+ "LineItems" : [ {
+ "Description" : "Foobar",
+ "Quantity" : 2,
+ "UnitAmount" : 20,
+ "AccountCode" : "400"
+ } ]
+ } ]
+ }
}
},
"required" : true
@@ -41829,7 +42440,18 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/ExpenseClaims"
},
- "example" : "{ \"ExpenseClaims\": [ { \"Status\": \"SUBMITTED\", \"User\": { \"UserID\": \"d1164823-0ac1-41ad-987b-b4e30fe0b273\" }, \"Receipts\": [ { \"Lineitems\": [], \"ReceiptID\": \"dc1c7f6d-0a4c-402f-acac-551d62ce5816\" } ] } ] }"
+ "example" : {
+ "ExpenseClaims" : [ {
+ "Status" : "SUBMITTED",
+ "User" : {
+ "UserID" : "d1164823-0ac1-41ad-987b-b4e30fe0b273"
+ },
+ "Receipts" : [ {
+ "Lineitems" : [ ],
+ "ReceiptID" : "dc1c7f6d-0a4c-402f-acac-551d62ce5816"
+ } ]
+ } ]
+ }
}
},
"required" : true
@@ -42016,7 +42638,15 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/Invoices"
},
- "example" : "{ \"Invoices\": [{ Reference: \"May the force be with you\", \"InvoiceID\": \"00000000-0000-0000-0000-000000000000\", \"LineItems\": [], \"Contact\": {}, \"Type\": \"ACCPAY\" }]}"
+ "example" : {
+ "Invoices" : [ {
+ "Reference" : "May the force be with you",
+ "InvoiceID" : "00000000-0000-0000-0000-000000000000",
+ "LineItems" : [ ],
+ "Contact" : { },
+ "Type" : "ACCPAY"
+ } ]
+ }
}
},
"required" : true
@@ -42438,7 +43068,12 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/Items"
},
- "example" : "{ \"Items\": [ { \"Code\": \"ItemCode123\", \"Description\": \"Description 123\" } ] }"
+ "example" : {
+ "Items" : [ {
+ "Code" : "ItemCode123",
+ "Description" : "Description 123"
+ } ]
+ }
}
},
"required" : true
@@ -42652,7 +43287,12 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/LinkedTransactions"
},
- "example" : "{ \"LinkedTransactions\": [ { \"SourceTransactionID\": \"00000000-0000-0000-0000-000000000000\", \"SourceLineItemID\": \"00000000-0000-0000-0000-000000000000\" } ] }"
+ "example" : {
+ "LinkedTransactions" : [ {
+ "SourceTransactionID" : "00000000-0000-0000-0000-000000000000",
+ "SourceLineItemID" : "00000000-0000-0000-0000-000000000000"
+ } ]
+ }
}
},
"required" : true
@@ -42854,7 +43494,13 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/ManualJournals"
},
- "example" : "{ \"ManualJournals\": [ { \"Narration\": \"Hello Xero\", \"ManualJournalID\": \"00000000-0000-0000-0000-000000000000\", \"JournalLines\": [] } ] }"
+ "example" : {
+ "ManualJournals" : [ {
+ "Narration" : "Hello Xero",
+ "ManualJournalID" : "00000000-0000-0000-0000-000000000000",
+ "JournalLines" : [ ]
+ } ]
+ }
}
},
"required" : true
@@ -43232,7 +43878,23 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/BankTransactions"
},
- "example" : "{ \"BankTransactions\": [ { \"Type\": \"SPEND\", \"Contact\": { \"ContactID\": \"00000000-0000-0000-0000-000000000000\" }, \"Lineitems\": [ { \"Description\": \"Foobar\", \"Quantity\": 1, \"UnitAmount\": 20, \"AccountCode\": \"400\" } ], \"BankAccount\": { \"Code\": \"088\" } } ] }"
+ "example" : {
+ "BankTransactions" : [ {
+ "Type" : "SPEND",
+ "Contact" : {
+ "ContactID" : "00000000-0000-0000-0000-000000000000"
+ },
+ "Lineitems" : [ {
+ "Description" : "Foobar",
+ "Quantity" : 1,
+ "UnitAmount" : 20,
+ "AccountCode" : "400"
+ } ],
+ "BankAccount" : {
+ "Code" : "088"
+ }
+ } ]
+ }
}
},
"required" : true
@@ -43440,7 +44102,27 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/Contacts"
},
- "example" : "{ \"Contacts\": [ { \"Name\": \"Bruce Banner\", \"EmailAddress\": \"hulk@avengers.com\", \"Phones\": [ { \"PhoneType\": \"MOBILE\", \"PhoneNumber\": \"555-1212\", \"PhoneAreaCode\": \"415\" } ], \"PaymentTerms\": { \"Bills\": { \"Day\": 15, \"Type\": \"OFCURRENTMONTH\" }, \"Sales\": { \"Day\": 10, \"Type\": \"DAYSAFTERBILLMONTH\" } } } ] }"
+ "example" : {
+ "Contacts" : [ {
+ "Name" : "Bruce Banner",
+ "EmailAddress" : "hulk@avengers.com",
+ "Phones" : [ {
+ "PhoneType" : "MOBILE",
+ "PhoneNumber" : "555-1212",
+ "PhoneAreaCode" : "415"
+ } ],
+ "PaymentTerms" : {
+ "Bills" : {
+ "Day" : 15,
+ "Type" : "OFCURRENTMONTH"
+ },
+ "Sales" : {
+ "Day" : 10,
+ "Type" : "DAYSAFTERBILLMONTH"
+ }
+ }
+ } ]
+ }
}
},
"required" : true
@@ -43637,7 +44319,23 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/CreditNotes"
},
- "example" : "{ \"CreditNotes\":[ { \"Type\":\"ACCPAYCREDIT\", \"Contact\":{ \"ContactID\":\"430fa14a-f945-44d3-9f97-5df5e28441b8\" }, \"Date\":\"2019-01-05\", \"Status\":\"AUTHORISED\", \"Reference\": \"HelloWorld\", \"LineItems\":[ { \"Description\":\"Foobar\", \"Quantity\":2.0, \"UnitAmount\":20.0, \"AccountCode\":\"400\" } ] } ] }"
+ "example" : {
+ "CreditNotes" : [ {
+ "Type" : "ACCPAYCREDIT",
+ "Contact" : {
+ "ContactID" : "430fa14a-f945-44d3-9f97-5df5e28441b8"
+ },
+ "Date" : "2019-01-05",
+ "Status" : "AUTHORISED",
+ "Reference" : "HelloWorld",
+ "LineItems" : [ {
+ "Description" : "Foobar",
+ "Quantity" : 2.0,
+ "UnitAmount" : 20.0,
+ "AccountCode" : "400"
+ } ]
+ } ]
+ }
}
},
"required" : true
@@ -43839,7 +44537,15 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/Employees"
},
- "example" : "{ \"Employees\": [ { \"FirstName\": \"Nick\", \"LastName\": \"Fury\", \"ExternalLink\": { \"Url\": \"http://twitter.com/#!/search/Nick+Fury\" } } ] }"
+ "example" : {
+ "Employees" : [ {
+ "FirstName" : "Nick",
+ "LastName" : "Fury",
+ "ExternalLink" : {
+ "Url" : "http://twitter.com/#!/search/Nick+Fury"
+ }
+ } ]
+ }
}
},
"required" : true
@@ -44039,7 +44745,26 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/Invoices"
},
- "example" : "{ \"Invoices\": [ { \"Type\": \"ACCREC\", \"Contact\": { \"ContactID\": \"430fa14a-f945-44d3-9f97-5df5e28441b8\" }, \"LineItems\": [ { \"Description\": \"Acme Tires\", \"Quantity\": 2, \"UnitAmount\": 20, \"AccountCode\": \"200\", \"TaxType\": \"NONE\", \"LineAmount\": 40 } ], \"Date\": \"2019-03-11\", \"DueDate\": \"2018-12-10\", \"Reference\": \"Website Design\", \"Status\": \"AUTHORISED\" } ] }"
+ "example" : {
+ "Invoices" : [ {
+ "Type" : "ACCREC",
+ "Contact" : {
+ "ContactID" : "430fa14a-f945-44d3-9f97-5df5e28441b8"
+ },
+ "LineItems" : [ {
+ "Description" : "Acme Tires",
+ "Quantity" : 2,
+ "UnitAmount" : 20,
+ "AccountCode" : "200",
+ "TaxType" : "NONE",
+ "LineAmount" : 40
+ } ],
+ "Date" : "2019-03-11",
+ "DueDate" : "2018-12-10",
+ "Reference" : "Website Design",
+ "Status" : "AUTHORISED"
+ } ]
+ }
}
},
"required" : true
@@ -44242,7 +44967,13 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/Items"
},
- "example" : "{ \"Items\": [ { \"Code\": \"ItemCode123\", \"Name\": \"ItemName XYZ\", \"Description\": \"Item Description ABC\" } ] }"
+ "example" : {
+ "Items" : [ {
+ "Code" : "ItemCode123",
+ "Name" : "ItemName XYZ",
+ "Description" : "Item Description ABC"
+ } ]
+ }
}
},
"required" : true
@@ -44459,7 +45190,25 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/ManualJournals"
},
- "example" : "{ \"ManualJournals\": [ { \"Narration\": \"Journal Desc\", \"JournalLines\": [ { \"LineAmount\": 100, \"AccountCode\": \"400\", \"Description\": \"Money Movement\" }, { \"LineAmount\": -100, \"AccountCode\": \"400\", \"Description\": \"Prepayment of things\", \"Tracking\": [ { \"Name\": \"North\", \"Option\": \"Region\" } ] } ], \"Date\": \"2019-03-14\" } ] }"
+ "example" : {
+ "ManualJournals" : [ {
+ "Narration" : "Journal Desc",
+ "JournalLines" : [ {
+ "LineAmount" : 100,
+ "AccountCode" : "400",
+ "Description" : "Money Movement"
+ }, {
+ "LineAmount" : -100,
+ "AccountCode" : "400",
+ "Description" : "Prepayment of things",
+ "Tracking" : [ {
+ "Name" : "North",
+ "Option" : "Region"
+ } ]
+ } ],
+ "Date" : "2019-03-14"
+ } ]
+ }
}
},
"required" : true
@@ -44653,7 +45402,20 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/PurchaseOrders"
},
- "example" : "{ \"PurchaseOrders\": [ { \"Contact\": { \"ContactID\": \"00000000-0000-0000-0000-000000000000\" }, \"LineItems\": [ { \"Description\": \"Foobar\", \"Quantity\": 1, \"UnitAmount\": 20, \"AccountCode\": \"710\" } ], \"Date\": \"2019-03-13\" } ] }"
+ "example" : {
+ "PurchaseOrders" : [ {
+ "Contact" : {
+ "ContactID" : "00000000-0000-0000-0000-000000000000"
+ },
+ "LineItems" : [ {
+ "Description" : "Foobar",
+ "Quantity" : 1,
+ "UnitAmount" : 20,
+ "AccountCode" : "710"
+ } ],
+ "Date" : "2019-03-13"
+ } ]
+ }
}
},
"required" : true
@@ -44847,7 +45609,20 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/Quotes"
},
- "example" : "{ \"Quotes\": [ { \"Contact\": { \"ContactID\": \"00000000-0000-0000-0000-000000000000\" }, \"LineItems\": [ { \"Description\": \"Foobar\", \"Quantity\": 1, \"UnitAmount\": 20, \"AccountCode\": \"12775\" } ], \"Date\": \"2020-02-01\" } ] }"
+ "example" : {
+ "Quotes" : [ {
+ "Contact" : {
+ "ContactID" : "00000000-0000-0000-0000-000000000000"
+ },
+ "LineItems" : [ {
+ "Description" : "Foobar",
+ "Quantity" : 1,
+ "UnitAmount" : 20,
+ "AccountCode" : "12775"
+ } ],
+ "Date" : "2020-02-01"
+ } ]
+ }
}
},
"required" : true
@@ -45020,7 +45795,42 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/RepeatingInvoices"
},
- "example" : "{ \"RepeatingInvoices\": [ { \"Schedule\": { \"Period\": 1, \"Unit\": \"MONTHLY\", \"DueDate\": 10, \"DueDateType\": \"OFFOLLOWINGMONTH\", \"StartDate\": \"\\/Date(1555286400000+0000)\\/\" }, \"Type\": \"ACCREC\", \"Reference\": \"[Week]\", \"ApprovedForSending\": false, \"SendCopy\": false, \"MarkAsSent\": false, \"IncludePDF\": false, \"Contact\": { \"ContactID\": \"430fa14a-f945-44d3-9f97-5df5e28441b8\", \"Name\": \"Liam Gallagher\" }, \"Status\": \"AUTHORISED\", \"LineAmountTypes\": \"Exclusive\", \"LineItems\": [ { \"Description\": \"Guitars Fender Strat\", \"UnitAmount\": 5000.00, \"TaxType\": \"OUTPUT2\", \"TaxAmount\": 750.00, \"LineAmount\": 5000.00, \"AccountCode\": \"200\", \"Tracking\": [], \"Quantity\": 1.0000, \"LineItemID\": \"13a8353c-d2af-4d5b-920c-438449f08900\", \"DiscountEnteredAsPercent\": true } ], \"CurrencyCode\": \"NZD\" } ] }"
+ "example" : {
+ "RepeatingInvoices" : [ {
+ "Schedule" : {
+ "Period" : 1,
+ "Unit" : "MONTHLY",
+ "DueDate" : 10,
+ "DueDateType" : "OFFOLLOWINGMONTH",
+ "StartDate" : "/Date(1555286400000+0000)/"
+ },
+ "Type" : "ACCREC",
+ "Reference" : "[Week]",
+ "ApprovedForSending" : false,
+ "SendCopy" : false,
+ "MarkAsSent" : false,
+ "IncludePDF" : false,
+ "Contact" : {
+ "ContactID" : "430fa14a-f945-44d3-9f97-5df5e28441b8",
+ "Name" : "Liam Gallagher"
+ },
+ "Status" : "AUTHORISED",
+ "LineAmountTypes" : "Exclusive",
+ "LineItems" : [ {
+ "Description" : "Guitars Fender Strat",
+ "UnitAmount" : 5000.0,
+ "TaxType" : "OUTPUT2",
+ "TaxAmount" : 750.0,
+ "LineAmount" : 5000.0,
+ "AccountCode" : "200",
+ "Tracking" : [ ],
+ "Quantity" : 1.0,
+ "LineItemID" : "13a8353c-d2af-4d5b-920c-438449f08900",
+ "DiscountEnteredAsPercent" : true
+ } ],
+ "CurrencyCode" : "NZD"
+ } ]
+ }
}
},
"required" : true
@@ -45233,7 +46043,13 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/PurchaseOrders"
},
- "example" : "{ \"PurchaseOrders\": [ { \"AttentionTo\": \"Peter Parker\", \"LineItems\": [], \"Contact\": {} } ] }"
+ "example" : {
+ "PurchaseOrders" : [ {
+ "AttentionTo" : "Peter Parker",
+ "LineItems" : [ ],
+ "Contact" : { }
+ } ]
+ }
}
},
"required" : true
@@ -45632,7 +46448,15 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/Quotes"
},
- "example" : "{ \"Quotes\": [ { \"Reference\": \"I am an update\", \"Contact\": { \"ContactID\": \"00000000-0000-0000-0000-000000000000\" }, \"Date\": \"2020-02-01\" } ] }"
+ "example" : {
+ "Quotes" : [ {
+ "Reference" : "I am an update",
+ "Contact" : {
+ "ContactID" : "00000000-0000-0000-0000-000000000000"
+ },
+ "Date" : "2020-02-01"
+ } ]
+ }
}
},
"required" : true
@@ -46032,7 +46856,15 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/Receipts"
},
- "example" : "{ \"Receipts\": [ { \"Lineitems\": [], \"User\": { \"UserID\": \"00000000-0000-0000-0000-000000000000\" }, \"Reference\": \"Foobar\" } ] }"
+ "example" : {
+ "Receipts" : [ {
+ "Lineitems" : [ ],
+ "User" : {
+ "UserID" : "00000000-0000-0000-0000-000000000000"
+ },
+ "Reference" : "Foobar"
+ } ]
+ }
}
},
"required" : true
@@ -46444,7 +47276,53 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/RepeatingInvoices"
},
- "example" : "{ \"Schedule\": { \"Period\": 1, \"Unit\": \"MONTHLY\", \"DueDate\": 10, \"DueDateType\": \"OFFOLLOWINGMONTH\", \"StartDate\": \"\\/Date(1555286400000+0000)\\/\", \"EndDate\": \"\\/Date(1569801600000+0000)\\/\", \"NextScheduledDate\": \"\\/Date(1555286400000+0000)\\/\" }, \"RepeatingInvoiceID\": \"428c0d75-909f-4b04-8403-a48dc27283b0\", \"Type\": \"ACCREC\", \"Reference\": \"[Week]\", \"HasAttachments\": true, \"ApprovedForSending\": false, \"SendCopy\": false, \"MarkAsSent\": false, \"IncludePDF\": false, \"ID\": \"428c0d75-909f-4b04-8403-a48dc27283b0\", \"Contact\": { \"ContactID\": \"430fa14a-f945-44d3-9f97-5df5e28441b8\", \"Name\": \"Liam Gallagher\", \"Addresses\": [], \"Phones\": [], \"ContactGroups\": [], \"ContactPersons\": [], \"HasValidationErrors\": false }, \"Status\": \"DELETED\", \"LineAmountTypes\": \"Exclusive\", \"LineItems\": [ { \"Description\": \"Guitars Fender Strat\", \"UnitAmount\": 5000.00, \"TaxType\": \"OUTPUT2\", \"TaxAmount\": 750.00, \"LineAmount\": 5000.00, \"AccountCode\": \"200\", \"Tracking\": [], \"Quantity\": 1.0000, \"LineItemID\": \"13a8353c-d2af-4d5b-920c-438449f08900\", \"DiscountEnteredAsPercent\": true } ], \"SubTotal\": 5000.00, \"TotalTax\": 750.00, \"Total\": 5750.00, \"CurrencyCode\": \"NZD\" }"
+ "example" : {
+ "Schedule" : {
+ "Period" : 1,
+ "Unit" : "MONTHLY",
+ "DueDate" : 10,
+ "DueDateType" : "OFFOLLOWINGMONTH",
+ "StartDate" : "/Date(1555286400000+0000)/",
+ "EndDate" : "/Date(1569801600000+0000)/",
+ "NextScheduledDate" : "/Date(1555286400000+0000)/"
+ },
+ "RepeatingInvoiceID" : "428c0d75-909f-4b04-8403-a48dc27283b0",
+ "Type" : "ACCREC",
+ "Reference" : "[Week]",
+ "HasAttachments" : true,
+ "ApprovedForSending" : false,
+ "SendCopy" : false,
+ "MarkAsSent" : false,
+ "IncludePDF" : false,
+ "ID" : "428c0d75-909f-4b04-8403-a48dc27283b0",
+ "Contact" : {
+ "ContactID" : "430fa14a-f945-44d3-9f97-5df5e28441b8",
+ "Name" : "Liam Gallagher",
+ "Addresses" : [ ],
+ "Phones" : [ ],
+ "ContactGroups" : [ ],
+ "ContactPersons" : [ ],
+ "HasValidationErrors" : false
+ },
+ "Status" : "DELETED",
+ "LineAmountTypes" : "Exclusive",
+ "LineItems" : [ {
+ "Description" : "Guitars Fender Strat",
+ "UnitAmount" : 5000.0,
+ "TaxType" : "OUTPUT2",
+ "TaxAmount" : 750.0,
+ "LineAmount" : 5000.0,
+ "AccountCode" : "200",
+ "Tracking" : [ ],
+ "Quantity" : 1.0,
+ "LineItemID" : "13a8353c-d2af-4d5b-920c-438449f08900",
+ "DiscountEnteredAsPercent" : true
+ } ],
+ "SubTotal" : 5000.0,
+ "TotalTax" : 750.0,
+ "Total" : 5750.0,
+ "CurrencyCode" : "NZD"
+ }
}
},
"required" : true
@@ -46810,7 +47688,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
@@ -46991,7 +47879,9 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/TrackingCategory"
},
- "example" : "{ \"Name\": \"Avengers\" }"
+ "example" : {
+ "Name" : "Avengers"
+ }
}
},
"required" : true
@@ -47199,7 +48089,9 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/TrackingOption"
},
- "example" : "{ name: \"Vision\" }"
+ "example" : {
+ "name" : "Vision"
+ }
}
},
"required" : true
diff --git a/docs/v2/appstore/index.html b/docs/v2/appstore/index.html
index d7a9947c..c36d1060 100644
--- a/docs/v2/appstore/index.html
+++ b/docs/v2/appstore/index.html
@@ -1624,7 +1624,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
@@ -1833,7 +1836,9 @@ Parameters
"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
index 3e47a4b6..d052b36b 100644
--- 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 @@ 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
@@ -1727,7 +1746,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/v2/payroll_au/index.html b/docs/v2/payroll_au/index.html
index 8f574fa9..21671674 100644
--- a/docs/v2/payroll_au/index.html
+++ b/docs/v2/payroll_au/index.html
@@ -4156,7 +4156,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
@@ -8275,7 +8293,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/v2/payroll_nz/index.html b/docs/v2/payroll_nz/index.html
index cfd89b00..00a28bcc 100644
--- a/docs/v2/payroll_nz/index.html
+++ b/docs/v2/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" : {
@@ -2463,7 +2463,7 @@
};
defs["Employment"] = {
"title" : "",
- "required" : [ "EngagementType", "PayrollCalendarID", "StartDate" ],
+ "required" : [ "engagementType", "payrollCalendarID", "startDate" ],
"type" : "object",
"properties" : {
"payrollCalendarID" : {
@@ -4603,7 +4603,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
@@ -4752,7 +4756,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
@@ -4909,7 +4919,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
@@ -5097,7 +5120,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
@@ -5284,7 +5312,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
@@ -5475,7 +5508,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
@@ -5659,7 +5701,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
@@ -6033,6 +6085,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"
+ } ]
}
}
},
@@ -6217,7 +6281,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
@@ -6405,7 +6479,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
@@ -6590,7 +6675,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
@@ -6739,7 +6829,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
@@ -7075,7 +7169,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
@@ -7226,7 +7328,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
@@ -7376,7 +7483,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
@@ -7528,7 +7640,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
@@ -7680,7 +7799,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
@@ -7866,7 +7999,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
@@ -13794,7 +13931,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
@@ -14009,7 +14159,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
@@ -14221,7 +14375,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
@@ -14432,7 +14597,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
@@ -14624,6 +14799,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
}
}
},
@@ -14809,7 +15002,9 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/PayRun"
},
- "example" : "{ \"paymentDate\": \"2019-07-01\" }"
+ "example" : {
+ "paymentDate" : "2019-07-01"
+ }
}
},
"required" : true
@@ -15000,7 +15195,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
@@ -15213,7 +15482,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/v2/payroll_uk/index.html b/docs/v2/payroll_uk/index.html
index f41fc661..a27c6b29 100644
--- a/docs/v2/payroll_uk/index.html
+++ b/docs/v2/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" : {
@@ -2272,7 +2272,7 @@
};
defs["Employment"] = {
"title" : "",
- "required" : [ "EmployeeNumber", "NICategories", "PayrollCalendarID", "StartDate" ],
+ "required" : [ "employeeNumber", "niCategories", "payrollCalendarID", "startDate" ],
"type" : "object",
"properties" : {
"payrollCalendarID" : {
@@ -4111,7 +4111,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
@@ -4261,7 +4269,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
@@ -4411,7 +4424,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
@@ -4568,7 +4587,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:00Z",
+ "gender" : "M",
+ "email" : "mike@starkindustries.com",
+ "isOffPayrollWorker" : false,
+ "address" : {
+ "addressLine1" : "171 Midsummer",
+ "city" : "Milton Keyness",
+ "postCode" : "MK9 1EB"
+ }
+ }
}
},
"required" : true
@@ -4940,7 +4972,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
@@ -5124,7 +5161,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
@@ -5309,7 +5350,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
@@ -5497,7 +5545,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
@@ -5682,7 +5737,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
@@ -5834,7 +5898,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
@@ -6019,7 +6091,16 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/Employment"
},
- "example" : "{ \"PayrollCalendarID\": \"216d80e6-af55-47b1-b718-9457c3f5d2fe\", \"StartDate\": \"2020-04-01\", \"NICategories\": [ { \"NICategory\": \"A\", \"StartDate\": \"2020-05-01\" } ], \"EmployeeNumber\": \"123ABC\" }"
+ "example" : {
+ "payrollCalendarID" : "cdfb8371-0b21-4b8a-8903-1024df6c391e",
+ "startDate" : "2024-04-01",
+ "niCategories" : [ {
+ "niCategory" : "I",
+ "startDate" : "2020-05-01",
+ "workplacePostcode" : "SW1A 1AA"
+ } ],
+ "employeeNumber" : "123ABC"
+ }
}
},
"required" : true
@@ -6168,7 +6249,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
@@ -6507,7 +6592,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
@@ -6655,7 +6745,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
@@ -6807,7 +6900,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
@@ -6993,7 +7100,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
@@ -13105,7 +13216,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:00Z",
+ "gender" : "M",
+ "email" : "tester@gmail.com",
+ "phoneNumber" : "0400123456",
+ "isOffPayrollWorker" : false,
+ "address" : {
+ "addressLine1" : "171 Midsummer",
+ "city" : "Milton Keyness",
+ "postCode" : "MK9 1EB"
+ }
+ }
}
},
"required" : true
@@ -13320,7 +13445,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
@@ -13532,7 +13661,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
@@ -13717,7 +13857,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
@@ -13929,7 +14076,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
@@ -14114,7 +14269,9 @@ Parameters
"schema" : {
"$ref" : "#/components/schemas/PayRun"
},
- "example" : "{ \"paymentDate\": \"2020-05-01\" }"
+ "example" : {
+ "paymentDate" : "2020-05-01"
+ }
}
},
"required" : true
@@ -14327,7 +14484,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/v2/projects/index.html b/docs/v2/projects/index.html
index fe6ec657..3b514f0a 100644
--- a/docs/v2/projects/index.html
+++ b/docs/v2/projects/index.html
@@ -2022,7 +2022,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
@@ -4448,7 +4454,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/lib/Models/PayrollNz/Employee.php b/lib/Models/PayrollNz/Employee.php
index 84a00aa9..b18dd5c3 100644
--- a/lib/Models/PayrollNz/Employee.php
+++ b/lib/Models/PayrollNz/Employee.php
@@ -301,6 +301,18 @@ public function listInvalidProperties()
{
$invalidProperties = [];
+ if ($this->container['first_name'] === null) {
+ $invalidProperties[] = "'first_name' can't be null";
+ }
+ if ($this->container['last_name'] === null) {
+ $invalidProperties[] = "'last_name' can't be null";
+ }
+ if ($this->container['date_of_birth'] === null) {
+ $invalidProperties[] = "'date_of_birth' can't be null";
+ }
+ if ($this->container['address'] === null) {
+ $invalidProperties[] = "'address' can't be null";
+ }
$allowedValues = $this->getGenderAllowableValues();
if (!is_null($this->container['gender']) && !in_array($this->container['gender'], $allowedValues, true)) {
$invalidProperties[] = sprintf(
@@ -381,7 +393,7 @@ public function setTitle($title)
/**
* Gets first_name
*
- * @return string|null
+ * @return string
*/
public function getFirstName()
{
@@ -391,7 +403,7 @@ public function getFirstName()
/**
* Sets first_name
*
- * @param string|null $first_name First name of employee
+ * @param string $first_name First name of employee
*
* @return $this
*/
@@ -408,7 +420,7 @@ public function setFirstName($first_name)
/**
* Gets last_name
*
- * @return string|null
+ * @return string
*/
public function getLastName()
{
@@ -418,7 +430,7 @@ public function getLastName()
/**
* Sets last_name
*
- * @param string|null $last_name Last name of employee
+ * @param string $last_name Last name of employee
*
* @return $this
*/
@@ -435,7 +447,7 @@ public function setLastName($last_name)
/**
* Gets date_of_birth
*
- * @return \DateTime|null
+ * @return \DateTime
*/
public function getDateOfBirth()
{
@@ -445,7 +457,7 @@ public function getDateOfBirth()
/**
* Sets date_of_birth
*
- * @param \DateTime|null $date_of_birth Date of birth of the employee (YYYY-MM-DD)
+ * @param \DateTime $date_of_birth Date of birth of the employee (YYYY-MM-DD)
*
* @return $this
*/
@@ -462,7 +474,7 @@ public function setDateOfBirth($date_of_birth)
/**
* Gets address
*
- * @return \XeroAPI\XeroPHP\Models\PayrollNz\Address|null
+ * @return \XeroAPI\XeroPHP\Models\PayrollNz\Address
*/
public function getAddress()
{
@@ -472,7 +484,7 @@ public function getAddress()
/**
* Sets address
*
- * @param \XeroAPI\XeroPHP\Models\PayrollNz\Address|null $address address
+ * @param \XeroAPI\XeroPHP\Models\PayrollNz\Address $address address
*
* @return $this
*/
diff --git a/lib/Models/PayrollNz/Employment.php b/lib/Models/PayrollNz/Employment.php
index 54981820..3520706b 100644
--- a/lib/Models/PayrollNz/Employment.php
+++ b/lib/Models/PayrollNz/Employment.php
@@ -214,6 +214,15 @@ public function listInvalidProperties()
{
$invalidProperties = [];
+ if ($this->container['payroll_calendar_id'] === null) {
+ $invalidProperties[] = "'payroll_calendar_id' can't be null";
+ }
+ if ($this->container['start_date'] === null) {
+ $invalidProperties[] = "'start_date' can't be null";
+ }
+ if ($this->container['engagement_type'] === null) {
+ $invalidProperties[] = "'engagement_type' can't be null";
+ }
return $invalidProperties;
}
@@ -232,7 +241,7 @@ public function valid()
/**
* Gets payroll_calendar_id
*
- * @return string|null
+ * @return string
*/
public function getPayrollCalendarId()
{
@@ -242,7 +251,7 @@ public function getPayrollCalendarId()
/**
* Sets payroll_calendar_id
*
- * @param string|null $payroll_calendar_id Xero unique identifier for the payroll calendar of the employee
+ * @param string $payroll_calendar_id Xero unique identifier for the payroll calendar of the employee
*
* @return $this
*/
@@ -286,7 +295,7 @@ public function setPayRunCalendarId($pay_run_calendar_id)
/**
* Gets start_date
*
- * @return \DateTime|null
+ * @return \DateTime
*/
public function getStartDate()
{
@@ -296,7 +305,7 @@ public function getStartDate()
/**
* Sets start_date
*
- * @param \DateTime|null $start_date Start date of the employment (YYYY-MM-DD)
+ * @param \DateTime $start_date Start date of the employment (YYYY-MM-DD)
*
* @return $this
*/
@@ -313,7 +322,7 @@ public function setStartDate($start_date)
/**
* Gets engagement_type
*
- * @return string|null
+ * @return string
*/
public function getEngagementType()
{
@@ -323,7 +332,7 @@ public function getEngagementType()
/**
* Sets engagement_type
*
- * @param string|null $engagement_type Engagement type of the employee
+ * @param string $engagement_type Engagement type of the employee
*
* @return $this
*/
diff --git a/lib/Models/PayrollUk/Employee.php b/lib/Models/PayrollUk/Employee.php
index e4f21a48..19a5ae83 100644
--- a/lib/Models/PayrollUk/Employee.php
+++ b/lib/Models/PayrollUk/Employee.php
@@ -307,6 +307,24 @@ public function listInvalidProperties()
{
$invalidProperties = [];
+ if ($this->container['title'] === null) {
+ $invalidProperties[] = "'title' can't be null";
+ }
+ if ($this->container['first_name'] === null) {
+ $invalidProperties[] = "'first_name' can't be null";
+ }
+ if ($this->container['last_name'] === null) {
+ $invalidProperties[] = "'last_name' can't be null";
+ }
+ if ($this->container['date_of_birth'] === null) {
+ $invalidProperties[] = "'date_of_birth' can't be null";
+ }
+ if ($this->container['address'] === null) {
+ $invalidProperties[] = "'address' can't be null";
+ }
+ if ($this->container['gender'] === null) {
+ $invalidProperties[] = "'gender' can't be null";
+ }
$allowedValues = $this->getGenderAllowableValues();
if (!is_null($this->container['gender']) && !in_array($this->container['gender'], $allowedValues, true)) {
$invalidProperties[] = sprintf(
@@ -360,7 +378,7 @@ public function setEmployeeId($employee_id)
/**
* Gets title
*
- * @return string|null
+ * @return string
*/
public function getTitle()
{
@@ -370,7 +388,7 @@ public function getTitle()
/**
* Sets title
*
- * @param string|null $title Title of the employee
+ * @param string $title Title of the employee
*
* @return $this
*/
@@ -387,7 +405,7 @@ public function setTitle($title)
/**
* Gets first_name
*
- * @return string|null
+ * @return string
*/
public function getFirstName()
{
@@ -397,7 +415,7 @@ public function getFirstName()
/**
* Sets first_name
*
- * @param string|null $first_name First name of employee
+ * @param string $first_name First name of employee
*
* @return $this
*/
@@ -414,7 +432,7 @@ public function setFirstName($first_name)
/**
* Gets last_name
*
- * @return string|null
+ * @return string
*/
public function getLastName()
{
@@ -424,7 +442,7 @@ public function getLastName()
/**
* Sets last_name
*
- * @param string|null $last_name Last name of employee
+ * @param string $last_name Last name of employee
*
* @return $this
*/
@@ -441,7 +459,7 @@ public function setLastName($last_name)
/**
* Gets date_of_birth
*
- * @return \DateTime|null
+ * @return \DateTime
*/
public function getDateOfBirth()
{
@@ -451,7 +469,7 @@ public function getDateOfBirth()
/**
* Sets date_of_birth
*
- * @param \DateTime|null $date_of_birth Date of birth of the employee (YYYY-MM-DD)
+ * @param \DateTime $date_of_birth Date of birth of the employee (YYYY-MM-DD)
*
* @return $this
*/
@@ -468,7 +486,7 @@ public function setDateOfBirth($date_of_birth)
/**
* Gets address
*
- * @return \XeroAPI\XeroPHP\Models\PayrollUk\Address|null
+ * @return \XeroAPI\XeroPHP\Models\PayrollUk\Address
*/
public function getAddress()
{
@@ -478,7 +496,7 @@ public function getAddress()
/**
* Sets address
*
- * @param \XeroAPI\XeroPHP\Models\PayrollUk\Address|null $address address
+ * @param \XeroAPI\XeroPHP\Models\PayrollUk\Address $address address
*
* @return $this
*/
@@ -522,7 +540,7 @@ public function setEmail($email)
/**
* Gets gender
*
- * @return string|null
+ * @return string
*/
public function getGender()
{
@@ -532,14 +550,14 @@ public function getGender()
/**
* Sets gender
*
- * @param string|null $gender The employee’s gender
+ * @param string $gender The employee’s gender
*
* @return $this
*/
public function setGender($gender)
{
$allowedValues = $this->getGenderAllowableValues();
- if (!is_null($gender) && !in_array($gender, $allowedValues, true)) {
+ if (!in_array($gender, $allowedValues, true)) {
throw new \InvalidArgumentException(
sprintf(
"Invalid value for 'gender', must be one of '%s'",
diff --git a/lib/Models/PayrollUk/Employment.php b/lib/Models/PayrollUk/Employment.php
index fa01a36d..354b8e7d 100644
--- a/lib/Models/PayrollUk/Employment.php
+++ b/lib/Models/PayrollUk/Employment.php
@@ -214,6 +214,18 @@ public function listInvalidProperties()
{
$invalidProperties = [];
+ if ($this->container['payroll_calendar_id'] === null) {
+ $invalidProperties[] = "'payroll_calendar_id' can't be null";
+ }
+ if ($this->container['start_date'] === null) {
+ $invalidProperties[] = "'start_date' can't be null";
+ }
+ if ($this->container['employee_number'] === null) {
+ $invalidProperties[] = "'employee_number' can't be null";
+ }
+ if ($this->container['ni_categories'] === null) {
+ $invalidProperties[] = "'ni_categories' can't be null";
+ }
return $invalidProperties;
}
@@ -232,7 +244,7 @@ public function valid()
/**
* Gets payroll_calendar_id
*
- * @return string|null
+ * @return string
*/
public function getPayrollCalendarId()
{
@@ -242,7 +254,7 @@ public function getPayrollCalendarId()
/**
* Sets payroll_calendar_id
*
- * @param string|null $payroll_calendar_id Xero unique identifier for the payroll calendar of the employee
+ * @param string $payroll_calendar_id Xero unique identifier for the payroll calendar of the employee
*
* @return $this
*/
@@ -259,7 +271,7 @@ public function setPayrollCalendarId($payroll_calendar_id)
/**
* Gets start_date
*
- * @return \DateTime|null
+ * @return \DateTime
*/
public function getStartDate()
{
@@ -269,7 +281,7 @@ public function getStartDate()
/**
* Sets start_date
*
- * @param \DateTime|null $start_date Start date of the employment (YYYY-MM-DD)
+ * @param \DateTime $start_date Start date of the employment (YYYY-MM-DD)
*
* @return $this
*/
@@ -286,7 +298,7 @@ public function setStartDate($start_date)
/**
* Gets employee_number
*
- * @return string|null
+ * @return string
*/
public function getEmployeeNumber()
{
@@ -296,7 +308,7 @@ public function getEmployeeNumber()
/**
* Sets employee_number
*
- * @param string|null $employee_number The employment number of the employee
+ * @param string $employee_number The employment number of the employee
*
* @return $this
*/
@@ -340,7 +352,7 @@ public function setNiCategory($ni_category)
/**
* Gets ni_categories
*
- * @return \XeroAPI\XeroPHP\Models\PayrollUk\NICategory[]|null
+ * @return \XeroAPI\XeroPHP\Models\PayrollUk\NICategory[]
*/
public function getNiCategories()
{
@@ -350,7 +362,7 @@ public function getNiCategories()
/**
* Sets ni_categories
*
- * @param \XeroAPI\XeroPHP\Models\PayrollUk\NICategory[]|null $ni_categories The employee's NI categories
+ * @param \XeroAPI\XeroPHP\Models\PayrollUk\NICategory[] $ni_categories The employee's NI categories
*
* @return $this
*/
diff --git a/test/Api/AccountingApiTest.php b/test/Api/AccountingApiTest.php
deleted file mode 100644
index 7382c2e8..00000000
--- a/test/Api/AccountingApiTest.php
+++ /dev/null
@@ -1,1973 +0,0 @@
-