From aa55b93f5197b6b07616b567070e5d5f4a681350 Mon Sep 17 00:00:00 2001
From: Raghunath SSJ <100554147+Raghunath-S-S-J@users.noreply.github.com>
Date: Fri, 2 Feb 2024 16:18:48 +0530
Subject: [PATCH] PETOSS-345 - Fix incorrect documentation generated by OpenAPI
---
Gemfile.lock | 2 +-
docs/files/index.html | 69 +-
docs/finance/index.html | 19 +-
docs/payroll_uk/index.html | 1527 ++++++++++++++++++++++++++++++++++--
4 files changed, 1521 insertions(+), 96 deletions(-)
diff --git a/Gemfile.lock b/Gemfile.lock
index c8e901c4..172853fb 100644
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -1,7 +1,7 @@
PATH
remote: .
specs:
- xero-ruby (4.4.0)
+ xero-ruby (5.0.0)
faraday (>= 2.0, < 3.0)
json (~> 2.1, >= 2.1.0)
json-jwt (~> 1.16, >= 1.16.3)
diff --git a/docs/files/index.html b/docs/files/index.html
index b51195a0..44e2e582 100644
--- a/docs/files/index.html
+++ b/docs/files/index.html
@@ -1015,6 +1015,28 @@
"type" : "string",
"description" : "The Object Type",
"enum" : [ "Unknown", "Accpay", "AccPayCredit", "AccPayPayment", "AccRec", "AccRecCredit", "AccRecPayment", "Adjustment", "ApCreditPayment", "ApOverPayment", "ApOverPaymentPayment", "ApOverPaymentSourcePayment", "ApPrepayment", "ApPrepaymentPayment", "ApPrepaymentSourcePayment", "ArCreditPayment", "ArOverPayment", "ArOverpaymentPayment", "ArOverpaymentSourcePayment", "ArPrepayment", "ArPrepaymentPayment", "ArPrepaymentSourcePayment", "CashPaid", "CashRec", "ExpPayment", "ManJournal", "PurchaseOrder", "Receipt", "Transfer", "Account", "Contact", "Business", "Employee", "Person", "User", "Org", "FixedAsset", "PayRun", "PriceListItem", "Bank", "Current", "Equity", "Expense", "Fixed", "Liability", "Prepayment", "Revenue", "Sales", "Overheads", "Depreciatn", "OtherIncome", "DirectCosts", "Currliab", "Termliab", "NonCurrent", "SalesQuote" ]
+};
+ defs["UploadObject"] = {
+ "title" : "",
+ "required" : [ "body", "filename", "name" ],
+ "type" : "object",
+ "properties" : {
+ "body" : {
+ "type" : "string",
+ "format" : "byte"
+ },
+ "name" : {
+ "type" : "string",
+ "description" : "exact name of the file you are uploading"
+ },
+ "filename" : {
+ "type" : "string"
+ },
+ "mimeType" : {
+ "type" : "string"
+ }
+ },
+ "description" : ""
};
defs["User"] = {
"title" : "",
@@ -1234,11 +1256,10 @@ Usage and SDK Samples
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
idempotency_key = 'KEY_VALUE'
begin
- response = xero_client.accounting_api.create_file_association(xero_tenant_idfile_idassociation, idempotency_key)
+ response = xero_client.accounting_api.create_file_association(xero_tenant_id, file_id, association, idempotency_key)
return response
rescue XeroRuby::ApiError => e
puts "Exception when calling create_file_association: #{e}"
@@ -1407,7 +1428,7 @@ Usage and SDK Samples
idempotency_key = 'KEY_VALUE'
begin
- response = xero_client.accounting_api.create_folder(xero_tenant_idfolder, idempotency_key)
+ response = xero_client.accounting_api.create_folder(xero_tenant_id, folder, idempotency_key)
return response
rescue XeroRuby::ApiError => e
puts "Exception when calling create_folder: #{e}"
@@ -1541,10 +1562,9 @@ Usage and SDK Samples
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
begin
- response = xero_client.accounting_api.delete_file(xero_tenant_idfile_id)
+ response = xero_client.accounting_api.delete_file(xero_tenant_id, file_id)
return response
rescue XeroRuby::ApiError => e
puts "Exception when calling delete_file: #{e}"
@@ -1655,12 +1675,10 @@ Usage and SDK Samples
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-object_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
object_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
begin
- response = xero_client.accounting_api.delete_file_association(xero_tenant_idfile_idobject_id)
+ response = xero_client.accounting_api.delete_file_association(xero_tenant_id, file_id, object_id)
return response
rescue XeroRuby::ApiError => e
puts "Exception when calling delete_file_association: #{e}"
@@ -1797,10 +1815,9 @@ Usage and SDK Samples
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
folder_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-folder_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
begin
- response = xero_client.accounting_api.delete_folder(xero_tenant_idfolder_id)
+ response = xero_client.accounting_api.delete_folder(xero_tenant_id, folder_id)
return response
rescue XeroRuby::ApiError => e
puts "Exception when calling delete_folder: #{e}"
@@ -1911,14 +1928,13 @@ Usage and SDK Samples
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
object_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-object_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
pagesize = 50
page = 2
sort = 'Associations/{ObjectId}?sort=CreatedDateUtc'
direction = 'Associations/{ObjectId}?sort=CreatedDateUtc&direction=DESC'
begin
- response = xero_client.accounting_api.get_associations_by_object(xero_tenant_idobject_id, pagesizepagesortdirection)
+ response = xero_client.accounting_api.get_associations_by_object(xero_tenant_id, object_id, pagesize, page, sort, direction)
return response
rescue XeroRuby::ApiError => e
puts "Exception when calling get_associations_by_object: #{e}"
@@ -2120,10 +2136,10 @@ Usage and SDK Samples
xero_client.set_token_set(user.token_set)
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-objectIds =
+objectIds = []
begin
- response = xero_client.accounting_api.get_associations_count(xero_tenant_idobjectIds)
+ response = xero_client.accounting_api.get_associations_count(xero_tenant_id, objectIds)
return response
rescue XeroRuby::ApiError => e
puts "Exception when calling get_associations_count: #{e}"
@@ -2239,10 +2255,9 @@ Usage and SDK Samples
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
begin
- response = xero_client.accounting_api.get_file(xero_tenant_idfile_id)
+ response = xero_client.accounting_api.get_file(xero_tenant_id, file_id)
return response
rescue XeroRuby::ApiError => e
puts "Exception when calling get_file: #{e}"
@@ -2358,10 +2373,9 @@ Usage and SDK Samples
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
begin
- response = xero_client.accounting_api.get_file_associations(xero_tenant_idfile_id)
+ response = xero_client.accounting_api.get_file_associations(xero_tenant_id, file_id)
return response
rescue XeroRuby::ApiError => e
puts "Exception when calling get_file_associations: #{e}"
@@ -2477,10 +2491,9 @@ Usage and SDK Samples
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
begin
- response = xero_client.accounting_api.get_file_content(xero_tenant_idfile_id)
+ response = xero_client.accounting_api.get_file_content(xero_tenant_id, file_id)
return response
rescue XeroRuby::ApiError => e
puts "Exception when calling get_file_content: #{e}"
@@ -2600,7 +2613,7 @@ Usage and SDK Samples
sort = 'CreatedDateUTC DESC'
begin
- response = xero_client.accounting_api.get_files(xero_tenant_id, pagesizepagesort)
+ response = xero_client.accounting_api.get_files(xero_tenant_id, pagesize, page, sort)
return response
rescue XeroRuby::ApiError => e
puts "Exception when calling get_files: #{e}"
@@ -2750,10 +2763,9 @@ Usage and SDK Samples
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
folder_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-folder_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
begin
- response = xero_client.accounting_api.get_folder(xero_tenant_idfolder_id)
+ response = xero_client.accounting_api.get_folder(xero_tenant_id, folder_id)
return response
rescue XeroRuby::ApiError => e
puts "Exception when calling get_folder: #{e}"
@@ -3065,11 +3077,10 @@ Usage and SDK Samples
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
idempotency_key = 'KEY_VALUE'
begin
- response = xero_client.accounting_api.update_file(xero_tenant_idfile_idfileObject, idempotency_key)
+ response = xero_client.accounting_api.update_file(xero_tenant_id, file_id, fileObject, idempotency_key)
return response
rescue XeroRuby::ApiError => e
puts "Exception when calling update_file: #{e}"
@@ -3236,11 +3247,10 @@ Usage and SDK Samples
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
folder_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-folder_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
idempotency_key = 'KEY_VALUE'
begin
- response = xero_client.accounting_api.update_folder(xero_tenant_idfolder_idfolder, idempotency_key)
+ response = xero_client.accounting_api.update_folder(xero_tenant_id, folder_id, folder, idempotency_key)
return response
rescue XeroRuby::ApiError => e
puts "Exception when calling update_folder: #{e}"
@@ -3413,7 +3423,7 @@ Usage and SDK Samples
mimeType = 'mimeType_example'
begin
- response = xero_client.accounting_api.upload_file(xero_tenant_idbodynamefilename, idempotency_keymimeType)
+ response = xero_client.accounting_api.upload_file(xero_tenant_id, body, name, filename, idempotency_key, mimeType)
return response
rescue XeroRuby::ApiError => e
puts "Exception when calling upload_file: #{e}"
@@ -3610,7 +3620,6 @@ Usage and SDK Samples
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
folder_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-folder_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
body = BYTE_ARRAY_DATA_HERE
name = 'name_example'
filename = 'filename_example'
@@ -3618,7 +3627,7 @@ Usage and SDK Samples
mimeType = 'mimeType_example'
begin
- response = xero_client.accounting_api.upload_file_to_folder(xero_tenant_idfolder_idbodynamefilename, idempotency_keymimeType)
+ response = xero_client.accounting_api.upload_file_to_folder(xero_tenant_id, folder_id, body, name, filename, idempotency_key, mimeType)
return response
rescue XeroRuby::ApiError => e
puts "Exception when calling upload_file_to_folder: #{e}"
diff --git a/docs/finance/index.html b/docs/finance/index.html
index 2216a7b7..51612e82 100644
--- a/docs/finance/index.html
+++ b/docs/finance/index.html
@@ -2820,7 +2820,7 @@ Usage and SDK Samples
end_month = '2021-09'
begin
- response = xero_client.accounting_api.get_accounting_activity_account_usage(xero_tenant_id, start_monthend_month)
+ response = xero_client.accounting_api.get_accounting_activity_account_usage(xero_tenant_id, start_month, end_month)
return response
rescue XeroRuby::ApiError => e
puts "Exception when calling get_accounting_activity_account_usage: #{e}"
@@ -3285,13 +3285,12 @@ Usage and SDK Samples
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
bank_account_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-bank_account_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
from_date = '2020-07-01'
to_date = '2021-06-30'
summary_only = true
begin
- response = xero_client.accounting_api.get_bank_statement_accounting(xero_tenant_idbank_account_idfrom_dateto_date, summary_only)
+ response = xero_client.accounting_api.get_bank_statement_accounting(xero_tenant_id, bank_account_id, from_date, to_date, summary_only)
return response
rescue XeroRuby::ApiError => e
puts "Exception when calling get_bank_statement_accounting: #{e}"
@@ -3483,7 +3482,7 @@ Usage and SDK Samples
begin_date = '2021-09-15'
begin
- response = xero_client.accounting_api.get_cash_validation(xero_tenant_id, balance_dateas_at_system_datebegin_date)
+ response = xero_client.accounting_api.get_cash_validation(xero_tenant_id, balance_date, as_at_system_date, begin_date)
return response
rescue XeroRuby::ApiError => e
puts "Exception when calling get_cash_validation: #{e}"
@@ -3755,7 +3754,7 @@ Usage and SDK Samples
end_date = '2021-09-15'
begin
- response = xero_client.accounting_api.get_financial_statement_cashflow(xero_tenant_id, start_dateend_date)
+ response = xero_client.accounting_api.get_financial_statement_cashflow(xero_tenant_id, start_date, end_date)
return response
rescue XeroRuby::ApiError => e
puts "Exception when calling get_financial_statement_cashflow: #{e}"
@@ -3885,13 +3884,13 @@ Usage and SDK Samples
xero_client.set_token_set(user.token_set)
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-contact_ids = ["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000000"]
+contact_ids = [["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000000"]]
include_manual_journals = true
start_date = '2020-09-15'
end_date = '2020-09-15'
begin
- response = xero_client.accounting_api.get_financial_statement_contacts_expense(xero_tenant_id, contact_idsinclude_manual_journalsstart_dateend_date)
+ response = xero_client.accounting_api.get_financial_statement_contacts_expense(xero_tenant_id, contact_ids, include_manual_journals, start_date, end_date)
return response
rescue XeroRuby::ApiError => e
puts "Exception when calling get_financial_statement_contacts_expense: #{e}"
@@ -4070,13 +4069,13 @@ Usage and SDK Samples
xero_client.set_token_set(user.token_set)
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-contact_ids = ["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000000"]
+contact_ids = [["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000000"]]
include_manual_journals = true
start_date = '2020-09-15'
end_date = '2020-09-15'
begin
- response = xero_client.accounting_api.get_financial_statement_contacts_revenue(xero_tenant_id, contact_idsinclude_manual_journalsstart_dateend_date)
+ response = xero_client.accounting_api.get_financial_statement_contacts_revenue(xero_tenant_id, contact_ids, include_manual_journals, start_date, end_date)
return response
rescue XeroRuby::ApiError => e
puts "Exception when calling get_financial_statement_contacts_revenue: #{e}"
@@ -4259,7 +4258,7 @@ Usage and SDK Samples
end_date = '2021-09-15'
begin
- response = xero_client.accounting_api.get_financial_statement_profit_and_loss(xero_tenant_id, start_dateend_date)
+ response = xero_client.accounting_api.get_financial_statement_profit_and_loss(xero_tenant_id, start_date, end_date)
return response
rescue XeroRuby::ApiError => e
puts "Exception when calling get_financial_statement_profit_and_loss: #{e}"
diff --git a/docs/payroll_uk/index.html b/docs/payroll_uk/index.html
index f651592c..8eed13dc 100644
--- a/docs/payroll_uk/index.html
+++ b/docs/payroll_uk/index.html
@@ -953,8 +953,110 @@
},
"description" : ""
};
- defs["Benefit"] = ;
- defs["BenefitLine"] = ;
+ defs["Benefit"] = {
+ "title" : "",
+ "required" : [ "calculationType", "category", "expenseAccountId", "liabilityAccountId", "name", "percentage" ],
+ "type" : "object",
+ "properties" : {
+ "id" : {
+ "type" : "string",
+ "description" : "unique identifier in Xero",
+ "format" : "uuid"
+ },
+ "name" : {
+ "type" : "string",
+ "description" : "Name of the employer pension"
+ },
+ "category" : {
+ "type" : "string",
+ "description" : "Category type of the employer pension",
+ "enum" : [ "StakeholderPension", "Other" ]
+ },
+ "liabilityAccountId" : {
+ "type" : "string",
+ "description" : "Xero identifier for Liability Account",
+ "format" : "uuid"
+ },
+ "expenseAccountId" : {
+ "type" : "string",
+ "description" : "Xero identifier for Expense Account",
+ "format" : "uuid"
+ },
+ "standardAmount" : {
+ "type" : "number",
+ "description" : "Standard amount of the employer pension",
+ "format" : "double",
+ "x-is-money" : true
+ },
+ "percentage" : {
+ "type" : "number",
+ "description" : "Percentage of gross of the employer pension",
+ "format" : "double",
+ "x-is-money" : true
+ },
+ "calculationType" : {
+ "type" : "string",
+ "description" : "Calculation Type of the employer pension (FixedAmount or PercentageOfGross).",
+ "enum" : [ "FixedAmount", "PercentageOfGross" ]
+ },
+ "currentRecord" : {
+ "type" : "boolean",
+ "description" : "Identifier of a record is active or not."
+ },
+ "subjectToNIC" : {
+ "type" : "boolean",
+ "description" : "Identifier of subject To NIC"
+ },
+ "subjectToPension" : {
+ "type" : "boolean",
+ "description" : "Identifier of subject To pension"
+ },
+ "subjectToTax" : {
+ "type" : "boolean",
+ "description" : "Identifier of subject To Tax"
+ },
+ "isCalculatingOnQualifyingEarnings" : {
+ "type" : "boolean",
+ "description" : "Identifier of calculating on qualifying earnings"
+ },
+ "showBalanceToEmployee" : {
+ "type" : "boolean",
+ "description" : "display the balance to employee"
+ }
+ },
+ "description" : ""
+};
+ defs["BenefitLine"] = {
+ "title" : "",
+ "type" : "object",
+ "properties" : {
+ "benefitTypeID" : {
+ "type" : "string",
+ "description" : "Xero identifier for payroll benefit type",
+ "format" : "uuid"
+ },
+ "displayName" : {
+ "type" : "string",
+ "description" : "Benefit display name"
+ },
+ "amount" : {
+ "type" : "number",
+ "description" : "The amount of the benefit line.",
+ "format" : "double"
+ },
+ "fixedAmount" : {
+ "type" : "number",
+ "description" : "Benefit fixed amount",
+ "format" : "double"
+ },
+ "percentage" : {
+ "type" : "number",
+ "description" : "Benefit rate percentage",
+ "format" : "double"
+ }
+ },
+ "description" : ""
+};
defs["BenefitObject"] = {
"title" : "",
"type" : "object",
@@ -990,9 +1092,129 @@
},
"description" : ""
};
- defs["CourtOrderLine"] = ;
- defs["Deduction"] = ;
- defs["DeductionLine"] = ;
+ defs["CourtOrderLine"] = {
+ "title" : "",
+ "type" : "object",
+ "properties" : {
+ "courtOrderTypeID" : {
+ "type" : "string",
+ "description" : "Xero identifier for payroll court order type",
+ "format" : "uuid"
+ },
+ "amount" : {
+ "type" : "number",
+ "description" : "Amount",
+ "format" : "double"
+ }
+ },
+ "description" : ""
+};
+ defs["Deduction"] = {
+ "title" : "",
+ "required" : [ "deductionName", "liabilityAccountId" ],
+ "type" : "object",
+ "properties" : {
+ "deductionId" : {
+ "type" : "string",
+ "description" : "The Xero identifier for Deduction",
+ "format" : "uuid"
+ },
+ "deductionName" : {
+ "type" : "string",
+ "description" : "Name of the deduction"
+ },
+ "deductionCategory" : {
+ "type" : "string",
+ "description" : "Deduction Category type",
+ "enum" : [ "CapitalContributions", "ChildCareVoucher", "MakingGood", "PostgraduateLoanDeductions", "PrivateUsePayments", "SalarySacrifice", "StakeholderPension", "StakeholderPensionPostTax", "StudentLoanDeductions", "UkOther" ]
+ },
+ "liabilityAccountId" : {
+ "type" : "string",
+ "description" : "Xero identifier for Liability Account",
+ "format" : "uuid"
+ },
+ "currentRecord" : {
+ "type" : "boolean",
+ "description" : "Identifier of a record is active or not."
+ },
+ "standardAmount" : {
+ "type" : "number",
+ "description" : "Standard amount of the deduction",
+ "format" : "double",
+ "x-is-money" : true
+ },
+ "reducesSuperLiability" : {
+ "type" : "boolean",
+ "description" : "Identifier of reduces super liability"
+ },
+ "reducesTaxLiability" : {
+ "type" : "boolean",
+ "description" : "Identifier of reduces tax liability"
+ },
+ "calculationType" : {
+ "type" : "string",
+ "description" : "determine the calculation type whether fixed amount or percentage of gross",
+ "enum" : [ "FixedAmount", "PercentageOfGross" ]
+ },
+ "percentage" : {
+ "type" : "number",
+ "description" : "Percentage of gross",
+ "format" : "double",
+ "x-is-money" : true
+ },
+ "subjectToNIC" : {
+ "type" : "boolean",
+ "description" : "Identifier of subject To NIC"
+ },
+ "subjectToTax" : {
+ "type" : "boolean",
+ "description" : "Identifier of subject To Tax"
+ },
+ "isReducedByBasicRate" : {
+ "type" : "boolean",
+ "description" : "Identifier of reduced by basic rate applicable or not"
+ },
+ "applyToPensionCalculations" : {
+ "type" : "boolean",
+ "description" : "Identifier for apply to pension calculations"
+ },
+ "isCalculatingOnQualifyingEarnings" : {
+ "type" : "boolean",
+ "description" : "Identifier of calculating on qualifying earnings"
+ },
+ "isPension" : {
+ "type" : "boolean",
+ "description" : "Identifier of applicable for pension or not"
+ }
+ },
+ "description" : ""
+};
+ defs["DeductionLine"] = {
+ "title" : "",
+ "type" : "object",
+ "properties" : {
+ "deductionTypeID" : {
+ "type" : "string",
+ "description" : "Xero identifier for payroll deduction",
+ "format" : "uuid"
+ },
+ "amount" : {
+ "type" : "number",
+ "description" : "The amount of the deduction line",
+ "format" : "double"
+ },
+ "subjectToTax" : {
+ "type" : "boolean",
+ "description" : "Identifies if the deduction is subject to tax"
+ },
+ "percentage" : {
+ "type" : "number",
+ "description" : "Deduction rate percentage",
+ "format" : "double"
+ }
+ },
+ "description" : ""
+};
defs["DeductionObject"] = {
"title" : "",
"type" : "object",
@@ -1028,7 +1250,55 @@
},
"description" : ""
};
- defs["EarningsLine"] = ;
+ defs["EarningsLine"] = {
+ "title" : "",
+ "type" : "object",
+ "properties" : {
+ "earningsLineID" : {
+ "type" : "string",
+ "description" : "Xero identifier for payroll earnings line",
+ "format" : "uuid"
+ },
+ "earningsRateID" : {
+ "type" : "string",
+ "description" : "Xero identifier for payroll earnings rate",
+ "format" : "uuid"
+ },
+ "displayName" : {
+ "type" : "string",
+ "description" : "name of earnings rate for display in UI"
+ },
+ "ratePerUnit" : {
+ "type" : "number",
+ "description" : "Rate per unit for earnings line",
+ "format" : "double"
+ },
+ "numberOfUnits" : {
+ "type" : "number",
+ "description" : "Earnings number of units",
+ "format" : "double"
+ },
+ "fixedAmount" : {
+ "type" : "number",
+ "description" : "Earnings fixed amount. Only applicable if the EarningsRate RateType is Fixed",
+ "format" : "double"
+ },
+ "amount" : {
+ "type" : "number",
+ "description" : "The amount of the earnings line.",
+ "format" : "double"
+ },
+ "isLinkedToTimesheet" : {
+ "type" : "boolean",
+ "description" : "Identifies if the earnings is taken from the timesheet. False for earnings line"
+ },
+ "isAverageDailyPayRate" : {
+ "type" : "boolean",
+ "description" : "Identifies if the earnings is using an average daily pay rate"
+ }
+ },
+ "description" : ""
+};
defs["EarningsOrder"] = {
"title" : "",
"required" : [ "name" ],
@@ -1094,7 +1364,64 @@
},
"description" : ""
};
- defs["EarningsRate"] = ;
+ defs["EarningsRate"] = {
+ "title" : "",
+ "required" : [ "earningsType", "expenseAccountID", "name", "rateType", "typeOfUnits" ],
+ "type" : "object",
+ "properties" : {
+ "earningsRateID" : {
+ "type" : "string",
+ "description" : "Xero unique identifier for an earning rate",
+ "format" : "uuid"
+ },
+ "name" : {
+ "type" : "string",
+ "description" : "Name of the earning rate"
+ },
+ "earningsType" : {
+ "type" : "string",
+ "description" : "Indicates how an employee will be paid when taking this type of earning",
+ "enum" : [ "Allowance", "BackPay", "Bonus", "Commission", "LumpSum", "OtherEarnings", "OvertimeEarnings", "RegularEarnings", "StatutoryAdoptionPay", "StatutoryAdoptionPayNonPensionable", "StatutoryBereavementPay", "StatutoryMaternityPay", "StatutoryMaternityPayNonPensionable", "StatutoryPaternityPay", "StatutoryPaternityPayNonPensionable", "StatutoryParentalBereavementPayNonPensionable", "StatutorySharedParentalPay", "StatutorySharedParentalPayNonPensionable", "StatutorySickPay", "StatutorySickPayNonPensionable", "TipsNonDirect", "TipsDirect", "TerminationPay" ]
+ },
+ "rateType" : {
+ "type" : "string",
+ "description" : "Indicates the type of the earning rate",
+ "enum" : [ "RatePerUnit", "MultipleOfOrdinaryEarningsRate", "FixedAmount" ]
+ },
+ "typeOfUnits" : {
+ "type" : "string",
+ "description" : "The type of units used to record earnings"
+ },
+ "currentRecord" : {
+ "type" : "boolean",
+ "description" : "Indicates whether an earning type is active"
+ },
+ "expenseAccountID" : {
+ "type" : "string",
+ "description" : "The account that will be used for the earnings rate",
+ "format" : "uuid"
+ },
+ "ratePerUnit" : {
+ "type" : "number",
+ "description" : "Default rate per unit (optional). Only applicable if RateType is RatePerUnit",
+ "format" : "double",
+ "x-is-money" : true
+ },
+ "multipleOfOrdinaryEarningsRate" : {
+ "type" : "number",
+ "description" : "This is the multiplier used to calculate the rate per unit, based on the employee’s ordinary earnings rate. For example, for time and a half enter 1.5. Only applicable if RateType is MultipleOfOrdinaryEarningsRate",
+ "format" : "double",
+ "x-is-money" : true
+ },
+ "fixedAmount" : {
+ "type" : "number",
+ "description" : "Optional Fixed Rate Amount. Applicable for FixedAmount Rate",
+ "format" : "double",
+ "x-is-money" : true
+ }
+ },
+ "description" : ""
+};
defs["EarningsRateObject"] = {
"title" : "",
"type" : "object",
@@ -1130,7 +1457,45 @@
},
"description" : ""
};
- defs["EarningsTemplate"] = ;
+ defs["EarningsTemplate"] = {
+ "title" : "",
+ "type" : "object",
+ "properties" : {
+ "payTemplateEarningID" : {
+ "type" : "string",
+ "description" : "The Xero identifier for the earnings template",
+ "format" : "uuid"
+ },
+ "ratePerUnit" : {
+ "type" : "number",
+ "description" : "The rate per unit",
+ "format" : "double",
+ "x-is-money" : true
+ },
+ "numberOfUnits" : {
+ "type" : "number",
+ "description" : "The rate per unit",
+ "format" : "double",
+ "x-is-money" : true
+ },
+ "fixedAmount" : {
+ "type" : "number",
+ "description" : "The fixed amount per period",
+ "format" : "double",
+ "x-is-money" : true
+ },
+ "earningsRateID" : {
+ "type" : "string",
+ "description" : "The corresponding earnings rate identifier",
+ "format" : "uuid"
+ },
+ "name" : {
+ "type" : "string",
+ "description" : "The read-only name of the Earning Template."
+ }
+ },
+ "description" : ""
+};
defs["EarningsTemplateObject"] = {
"title" : "",
"type" : "object",
@@ -1289,7 +1654,33 @@
},
"description" : ""
};
- defs["EmployeeLeaveBalance"] = ;
+ defs["EmployeeLeaveBalance"] = {
+ "title" : "",
+ "type" : "object",
+ "properties" : {
+ "name" : {
+ "type" : "string",
+ "description" : "Name of the leave type.",
+ "example" : "Holiday"
+ },
+ "leaveTypeID" : {
+ "type" : "string",
+ "description" : "The Xero identifier for leave type",
+ "format" : "uuid"
+ },
+ "balance" : {
+ "type" : "number",
+ "description" : "The employees current balance for the corresponding leave type.",
+ "format" : "double"
+ },
+ "typeOfUnits" : {
+ "type" : "string",
+ "description" : "The type of the units of the leave.",
+ "example" : "hours"
+ }
+ },
+ "description" : ""
+};
defs["EmployeeLeaveBalances"] = {
"title" : "",
"type" : "object",
@@ -1325,7 +1716,44 @@
},
"description" : ""
};
- defs["EmployeeLeaveType"] = ;
+ defs["EmployeeLeaveType"] = {
+ "title" : "",
+ "required" : [ "leaveTypeID", "scheduleOfAccrual" ],
+ "type" : "object",
+ "properties" : {
+ "leaveTypeID" : {
+ "type" : "string",
+ "description" : "The Xero identifier for leave type",
+ "format" : "uuid"
+ },
+ "scheduleOfAccrual" : {
+ "type" : "string",
+ "description" : "The schedule of accrual",
+ "enum" : [ "BeginningOfCalendarYear", "OnAnniversaryDate", "EachPayPeriod", "OnHourWorked" ]
+ },
+ "hoursAccruedAnnually" : {
+ "type" : "number",
+ "description" : "The number of hours accrued for the leave annually. This is 0 when the scheduleOfAccrual chosen is \"OnHourWorked\"",
+ "format" : "double"
+ },
+ "maximumToAccrue" : {
+ "type" : "number",
+ "description" : "The maximum number of hours that can be accrued for the leave",
+ "format" : "double"
+ },
+ "openingBalance" : {
+ "type" : "number",
+ "description" : "The initial number of hours assigned when the leave was added to the employee",
+ "format" : "double"
+ },
+ "rateAccruedHourly" : {
+ "type" : "number",
+ "description" : "The number of hours added to the leave balance for every hour worked by the employee. This is normally 0, unless the scheduleOfAccrual chosen is \"OnHourWorked\"",
+ "format" : "double"
+ }
+ },
+ "description" : ""
+};
defs["EmployeeLeaveTypeObject"] = {
"title" : "",
"type" : "object",
@@ -1396,7 +1824,48 @@
},
"description" : ""
};
- defs["EmployeeOpeningBalances"] = ;
+ defs["EmployeeOpeningBalances"] = {
+ "title" : "",
+ "type" : "object",
+ "properties" : {
+ "statutoryAdoptionPay" : {
+ "type" : "number",
+ "description" : "The total accumulated statutory adoption pay amount received by the employee for current fiscal year to date",
+ "format" : "double",
+ "x-is-money" : true
+ },
+ "statutoryMaternityPay" : {
+ "type" : "number",
+ "description" : "The total accumulated statutory maternity pay amount received by the employee for current fiscal year to date",
+ "format" : "double",
+ "x-is-money" : true
+ },
+ "statutoryPaternityPay" : {
+ "type" : "number",
+ "description" : "The total accumulated statutory paternity pay amount received by the employee for current fiscal year to date",
+ "format" : "double",
+ "x-is-money" : true
+ },
+ "statutorySharedParentalPay" : {
+ "type" : "number",
+ "description" : "The total accumulated statutory shared parental pay amount received by the employee for current fiscal year to date",
+ "format" : "double",
+ "x-is-money" : true
+ },
+ "statutorySickPay" : {
+ "type" : "number",
+ "description" : "The total accumulated statutory sick pay amount received by the employee for current fiscal year to date",
+ "format" : "double",
+ "x-is-money" : true
+ },
+ "priorEmployeeNumber" : {
+ "type" : "number",
+ "description" : "The unique employee number issued by the employee's former employer",
+ "format" : "double"
+ }
+ },
+ "description" : ""
+};
defs["EmployeeOpeningBalancesObject"] = {
"title" : "",
"type" : "object",
@@ -1461,7 +1930,28 @@
},
"description" : ""
};
- defs["EmployeeStatutoryLeaveBalance"] = ;
+ defs["EmployeeStatutoryLeaveBalance"] = {
+ "title" : "",
+ "type" : "object",
+ "properties" : {
+ "leaveType" : {
+ "type" : "string",
+ "description" : "The type of statutory leave",
+ "enum" : [ "Sick", "Adoption", "Maternity", "Paternity", "Sharedparental" ]
+ },
+ "balanceRemaining" : {
+ "type" : "number",
+ "description" : "The balance remaining for the corresponding leave type as of specified date.",
+ "format" : "double"
+ },
+ "units" : {
+ "type" : "string",
+ "description" : "The units will be \"Hours\"",
+ "enum" : [ "Hours" ]
+ }
+ },
+ "description" : ""
+};
defs["EmployeeStatutoryLeaveBalanceObject"] = {
"title" : "",
"type" : "object",
@@ -1540,7 +2030,97 @@
},
"description" : ""
};
- defs["EmployeeStatutorySickLeave"] = ;
+ defs["EmployeeStatutorySickLeave"] = {
+ "title" : "",
+ "required" : [ "employeeID", "endDate", "isPregnancyRelated", "leaveTypeID", "startDate", "sufficientNotice", "workPattern" ],
+ "type" : "object",
+ "properties" : {
+ "statutoryLeaveID" : {
+ "type" : "string",
+ "description" : "The unique identifier (guid) of a statutory leave",
+ "format" : "uuid"
+ },
+ "employeeID" : {
+ "type" : "string",
+ "description" : "The unique identifier (guid) of the employee",
+ "format" : "uuid"
+ },
+ "leaveTypeID" : {
+ "type" : "string",
+ "description" : "The unique identifier (guid) of the \"Statutory Sick Leave (non-pensionable)\" pay item",
+ "format" : "uuid"
+ },
+ "startDate" : {
+ "type" : "string",
+ "description" : "The date when the leave starts",
+ "format" : "date",
+ "x-is-date" : true
+ },
+ "endDate" : {
+ "type" : "string",
+ "description" : "The date when the leave ends",
+ "format" : "date",
+ "x-is-date" : true
+ },
+ "type" : {
+ "type" : "string",
+ "description" : "the type of statutory leave",
+ "example" : "Sick"
+ },
+ "status" : {
+ "type" : "string",
+ "description" : "the type of statutory leave",
+ "example" : "Pending"
+ },
+ "workPattern" : {
+ "type" : "array",
+ "description" : "The days of the work week the employee is scheduled to work at the time the leave is taken",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "isPregnancyRelated" : {
+ "type" : "boolean",
+ "description" : "Whether the sick leave was pregnancy related"
+ },
+ "sufficientNotice" : {
+ "type" : "boolean",
+ "description" : "Whether the employee provided sufficient notice and documentation as required by the employer supporting the sick leave request"
+ },
+ "isEntitled" : {
+ "type" : "boolean",
+ "description" : "Whether the leave was entitled to receive payment"
+ },
+ "entitlementWeeksRequested" : {
+ "type" : "number",
+ "description" : "The amount of requested time (in weeks)",
+ "format" : "double"
+ },
+ "entitlementWeeksQualified" : {
+ "type" : "number",
+ "description" : "The amount of statutory sick leave time off (in weeks) that is available to take at the time the leave was requested",
+ "format" : "double"
+ },
+ "entitlementWeeksRemaining" : {
+ "type" : "number",
+ "description" : "A calculated amount of time (in weeks) that remains for the statutory sick leave period",
+ "format" : "double"
+ },
+ "overlapsWithOtherLeave" : {
+ "type" : "boolean",
+ "description" : "Whether another leave (Paternity, Shared Parental specifically) occurs during the requested leave's period. While this is allowed it could affect payment amounts"
+ },
+ "entitlementFailureReasons" : {
+ "type" : "array",
+ "description" : "If the leave requested was considered \"not entitled\", the reasons why are listed here.",
+ "items" : {
+ "type" : "string",
+ "enum" : [ "UnableToCalculateAwe", "AweLowerThanLel", "NotQualifiedInPreviousPiw", "ExceededMaximumEntitlementWeeksOfSsp", "ExceededMaximumDurationOfPiw", "SufficientNoticeNotGiven" ]
+ }
+ }
+ },
+ "description" : ""
+};
defs["EmployeeStatutorySickLeaveObject"] = {
"title" : "",
"type" : "object",
@@ -1576,7 +2156,68 @@
},
"description" : ""
};
- defs["EmployeeTax"] = ;
+ defs["EmployeeTax"] = {
+ "title" : "",
+ "type" : "object",
+ "properties" : {
+ "starterType" : {
+ "type" : "string",
+ "description" : "The Starter type.",
+ "example" : "New Employee with P45"
+ },
+ "starterDeclaration" : {
+ "type" : "string",
+ "description" : "Starter declaration.",
+ "example" : "B.) This is currently their only job"
+ },
+ "taxCode" : {
+ "type" : "string",
+ "description" : "The Tax code.",
+ "example" : "1185L"
+ },
+ "w1M1" : {
+ "type" : "boolean",
+ "description" : "Describes whether the tax settings is W1M1"
+ },
+ "previousTaxablePay" : {
+ "type" : "number",
+ "description" : "The previous taxable pay",
+ "format" : "double",
+ "x-is-money" : true
+ },
+ "previousTaxPaid" : {
+ "type" : "number",
+ "description" : "The tax amount previously paid",
+ "format" : "double",
+ "x-is-money" : true
+ },
+ "studentLoanDeduction" : {
+ "type" : "string",
+ "description" : "The employee's student loan deduction type",
+ "example" : "Plan Type 2"
+ },
+ "hasPostGraduateLoans" : {
+ "type" : "boolean",
+ "description" : "Describes whether the employee has post graduate loans"
+ },
+ "isDirector" : {
+ "type" : "boolean",
+ "description" : "Describes whether the employee is director"
+ },
+ "directorshipStartDate" : {
+ "type" : "string",
+ "description" : "The directorship start date",
+ "format" : "date",
+ "x-is-date" : true
+ },
+ "nicCalculationMethod" : {
+ "type" : "string",
+ "description" : "NICs calculation method",
+ "example" : "Annualized"
+ }
+ },
+ "description" : ""
+};
defs["EmployeeTaxObject"] = {
"title" : "",
"type" : "object",
@@ -1675,9 +2316,88 @@
},
"description" : ""
};
- defs["LeaveAccrualLine"] = ;
- defs["LeaveEarningsLine"] = ;
- defs["LeavePeriod"] = ;
+ defs["LeaveAccrualLine"] = {
+ "title" : "",
+ "type" : "object",
+ "properties" : {
+ "leaveTypeID" : {
+ "type" : "string",
+ "description" : "Xero identifier for the Leave type",
+ "format" : "uuid"
+ },
+ "numberOfUnits" : {
+ "type" : "number",
+ "description" : "Leave accrual number of units",
+ "format" : "double"
+ }
+ },
+ "description" : ""
+};
+ defs["LeaveEarningsLine"] = {
+ "title" : "",
+ "type" : "object",
+ "properties" : {
+ "earningsRateID" : {
+ "type" : "string",
+ "description" : "Xero identifier for payroll leave earnings rate",
+ "format" : "uuid"
+ },
+ "ratePerUnit" : {
+ "type" : "number",
+ "description" : "Rate per unit for leave earnings line",
+ "format" : "double"
+ },
+ "numberOfUnits" : {
+ "type" : "number",
+ "description" : "Leave earnings number of units",
+ "format" : "double"
+ },
+ "fixedAmount" : {
+ "type" : "number",
+ "description" : "Leave earnings fixed amount. Only applicable if the EarningsRate RateType is Fixed",
+ "format" : "double"
+ },
+ "amount" : {
+ "type" : "number",
+ "description" : "The amount of the earnings line.",
+ "format" : "double"
+ },
+ "isLinkedToTimesheet" : {
+ "type" : "boolean",
+ "description" : "Identifies if the leave earnings is taken from the timesheet. False for leave earnings line"
+ }
+ },
+ "description" : ""
+};
+ defs["LeavePeriod"] = {
+ "title" : "",
+ "type" : "object",
+ "properties" : {
+ "periodStartDate" : {
+ "type" : "string",
+ "description" : "The Pay Period Start Date (YYYY-MM-DD)",
+ "format" : "date",
+ "x-is-date" : true
+ },
+ "periodEndDate" : {
+ "type" : "string",
+ "description" : "The Pay Period End Date (YYYY-MM-DD)",
+ "format" : "date",
+ "x-is-date" : true
+ },
+ "numberOfUnits" : {
+ "type" : "number",
+ "description" : "The Number of Units for the leave",
+ "format" : "double"
+ },
+ "periodStatus" : {
+ "type" : "string",
+ "description" : "Period Status",
+ "enum" : [ "Approved", "Completed" ]
+ }
+ },
+ "description" : ""
+};
defs["LeavePeriods"] = {
"title" : "",
"type" : "object",
@@ -1798,7 +2518,78 @@
},
"description" : ""
};
- defs["PayRun"] = ;
+ defs["PayRun"] = {
+ "title" : "",
+ "type" : "object",
+ "properties" : {
+ "payRunID" : {
+ "type" : "string",
+ "description" : "Xero unique identifier for the pay run",
+ "format" : "uuid"
+ },
+ "payrollCalendarID" : {
+ "type" : "string",
+ "description" : "Xero unique identifier for the payroll calendar",
+ "format" : "uuid"
+ },
+ "periodStartDate" : {
+ "type" : "string",
+ "description" : "Period start date of the payroll calendar",
+ "format" : "date",
+ "x-is-date" : true
+ },
+ "periodEndDate" : {
+ "type" : "string",
+ "description" : "Period end date of the payroll calendar",
+ "format" : "date",
+ "x-is-date" : true
+ },
+ "paymentDate" : {
+ "type" : "string",
+ "description" : "Payment date of the pay run",
+ "format" : "date",
+ "x-is-date" : true
+ },
+ "totalCost" : {
+ "type" : "number",
+ "description" : "Total cost of the pay run",
+ "format" : "double"
+ },
+ "totalPay" : {
+ "type" : "number",
+ "description" : "Total pay of the pay run",
+ "format" : "double"
+ },
+ "payRunStatus" : {
+ "type" : "string",
+ "description" : "Pay run status",
+ "enum" : [ "Draft", "Posted" ]
+ },
+ "payRunType" : {
+ "type" : "string",
+ "description" : "Pay run type",
+ "enum" : [ "Scheduled", "Unscheduled", "EarlierYearUpdate" ]
+ },
+ "calendarType" : {
+ "type" : "string",
+ "description" : "Calendar type of the pay run",
+ "enum" : [ "Weekly", "Fortnightly", "FourWeekly", "Monthly", "Annual", "Quarterly" ]
+ },
+ "postedDateTime" : {
+ "type" : "string",
+ "description" : "Posted date time of the pay run",
+ "format" : "date",
+ "x-is-date" : true
+ },
+ "paySlips" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/Payslip"
+ }
+ }
+ },
+ "description" : ""
+};
defs["PayRunCalendar"] = {
"title" : "",
"required" : [ "calendarType", "name", "paymentDate", "periodStartDate" ],
@@ -1915,7 +2706,35 @@
},
"description" : ""
};
- defs["PaymentLine"] = ;
+ defs["PaymentLine"] = {
+ "title" : "",
+ "type" : "object",
+ "properties" : {
+ "paymentLineID" : {
+ "type" : "string",
+ "description" : "Xero identifier for payroll payment line",
+ "format" : "uuid"
+ },
+ "amount" : {
+ "type" : "number",
+ "description" : "The amount of the payment line",
+ "format" : "double"
+ },
+ "accountNumber" : {
+ "type" : "string",
+ "description" : "The account number"
+ },
+ "sortCode" : {
+ "type" : "string",
+ "description" : "The account sort code"
+ },
+ "accountName" : {
+ "type" : "string",
+ "description" : "The account name"
+ }
+ },
+ "description" : ""
+};
defs["PaymentMethod"] = {
"title" : "",
"required" : [ "paymentMethod" ],
@@ -1942,16 +2761,138 @@
"pagination" : {
"$ref" : "#/components/schemas/Pagination"
},
- "problem" : {
- "$ref" : "#/components/schemas/Problem"
+ "problem" : {
+ "$ref" : "#/components/schemas/Problem"
+ },
+ "paymentMethod" : {
+ "$ref" : "#/components/schemas/PaymentMethod"
+ }
+ },
+ "description" : ""
+};
+ defs["Payslip"] = {
+ "title" : "",
+ "type" : "object",
+ "properties" : {
+ "paySlipID" : {
+ "type" : "string",
+ "description" : "The Xero identifier for a Payslip",
+ "format" : "uuid"
+ },
+ "employeeID" : {
+ "type" : "string",
+ "description" : "The Xero identifier for payroll employee",
+ "format" : "uuid"
+ },
+ "payRunID" : {
+ "type" : "string",
+ "description" : "The Xero identifier for the associated payrun",
+ "format" : "uuid"
+ },
+ "lastEdited" : {
+ "type" : "string",
+ "description" : "The date payslip was last updated",
+ "format" : "date",
+ "x-is-datetime" : true
+ },
+ "firstName" : {
+ "type" : "string",
+ "description" : "Employee first name"
+ },
+ "lastName" : {
+ "type" : "string",
+ "description" : "Employee last name"
+ },
+ "totalEarnings" : {
+ "type" : "number",
+ "description" : "Total earnings before any deductions. Same as gross earnings for UK.",
+ "format" : "double"
+ },
+ "grossEarnings" : {
+ "type" : "number",
+ "description" : "Total earnings before any deductions. Same as total earnings for UK.",
+ "format" : "double"
+ },
+ "totalPay" : {
+ "type" : "number",
+ "description" : "The employee net pay",
+ "format" : "double"
+ },
+ "totalEmployerTaxes" : {
+ "type" : "number",
+ "description" : "The employer's tax obligation",
+ "format" : "double"
+ },
+ "totalEmployeeTaxes" : {
+ "type" : "number",
+ "description" : "The part of an employee's earnings that is deducted for tax purposes",
+ "format" : "double"
+ },
+ "totalDeductions" : {
+ "type" : "number",
+ "description" : "Total amount subtracted from an employee's earnings to reach total pay",
+ "format" : "double"
+ },
+ "totalReimbursements" : {
+ "type" : "number",
+ "description" : "Total reimbursements are nontaxable payments to an employee used to repay out-of-pocket expenses when the person incurs those expenses through employment",
+ "format" : "double"
+ },
+ "totalCourtOrders" : {
+ "type" : "number",
+ "description" : "Total amounts required by law to subtract from the employee's earnings",
+ "format" : "double"
+ },
+ "totalBenefits" : {
+ "type" : "number",
+ "description" : "Benefits (also called fringe benefits, perquisites or perks) are various non-earnings compensations provided to employees in addition to their normal earnings or salaries",
+ "format" : "double"
+ },
+ "bacsHash" : {
+ "type" : "string",
+ "description" : "BACS Service User Number"
+ },
+ "paymentMethod" : {
+ "type" : "string",
+ "description" : "The payment method code",
+ "enum" : [ "Cheque", "Electronically", "Manual" ]
+ },
+ "earningsLines" : {
+ "$ref" : "#/components/schemas/EarningsLines"
+ },
+ "leaveEarningsLines" : {
+ "$ref" : "#/components/schemas/LeaveEarningsLines"
+ },
+ "timesheetEarningsLines" : {
+ "$ref" : "#/components/schemas/TimesheetEarningsLines"
+ },
+ "deductionLines" : {
+ "$ref" : "#/components/schemas/DeductionLines"
},
- "paymentMethod" : {
- "$ref" : "#/components/schemas/PaymentMethod"
+ "reimbursementLines" : {
+ "$ref" : "#/components/schemas/ReimbursementLines"
+ },
+ "leaveAccrualLines" : {
+ "$ref" : "#/components/schemas/LeaveAccrualLines"
+ },
+ "benefitLines" : {
+ "$ref" : "#/components/schemas/BenefitLines"
+ },
+ "paymentLines" : {
+ "$ref" : "#/components/schemas/PaymentLines"
+ },
+ "employeeTaxLines" : {
+ "$ref" : "#/components/schemas/TaxLines"
+ },
+ "employerTaxLines" : {
+ "$ref" : "#/components/schemas/TaxLines"
+ },
+ "courtOrderLines" : {
+ "$ref" : "#/components/schemas/CourtOrderLines"
}
},
"description" : ""
};
- defs["Payslip"] = ;
defs["PayslipObject"] = {
"title" : "",
"type" : "object",
@@ -2049,7 +2990,28 @@
},
"description" : ""
};
- defs["ReimbursementLine"] = ;
+ defs["ReimbursementLine"] = {
+ "title" : "",
+ "type" : "object",
+ "properties" : {
+ "reimbursementTypeID" : {
+ "type" : "string",
+ "description" : "Xero identifier for payroll reimbursement",
+ "format" : "uuid"
+ },
+ "description" : {
+ "type" : "string",
+ "description" : "Reimbursement line description"
+ },
+ "amount" : {
+ "type" : "number",
+ "description" : "Reimbursement amount",
+ "format" : "double",
+ "x-is-money" : true
+ }
+ },
+ "description" : ""
+};
defs["ReimbursementObject"] = {
"title" : "",
"type" : "object",
@@ -2085,7 +3047,60 @@
},
"description" : ""
};
- defs["SalaryAndWage"] = ;
+ defs["SalaryAndWage"] = {
+ "title" : "",
+ "required" : [ "annualSalary", "earningsRateID", "effectiveFrom", "numberOfUnitsPerWeek", "paymentType", "status" ],
+ "type" : "object",
+ "properties" : {
+ "salaryAndWagesID" : {
+ "type" : "string",
+ "description" : "Xero unique identifier for a salary and wages record",
+ "format" : "uuid"
+ },
+ "earningsRateID" : {
+ "type" : "string",
+ "description" : "Xero unique identifier for an earnings rate",
+ "format" : "uuid"
+ },
+ "numberOfUnitsPerWeek" : {
+ "type" : "number",
+ "description" : "The Number of Units per week for the corresponding salary and wages",
+ "format" : "double"
+ },
+ "ratePerUnit" : {
+ "type" : "number",
+ "description" : "The rate of each unit for the corresponding salary and wages",
+ "format" : "double"
+ },
+ "numberOfUnitsPerDay" : {
+ "type" : "number",
+ "description" : "The Number of Units per day for the corresponding salary and wages",
+ "format" : "double"
+ },
+ "effectiveFrom" : {
+ "type" : "string",
+ "description" : "The effective date of the corresponding salary and wages",
+ "format" : "date",
+ "x-is-date" : true
+ },
+ "annualSalary" : {
+ "type" : "number",
+ "description" : "The annual salary",
+ "format" : "double"
+ },
+ "status" : {
+ "type" : "string",
+ "description" : "The current status of the corresponding salary and wages",
+ "enum" : [ "Active", "Pending", "History" ]
+ },
+ "paymentType" : {
+ "type" : "string",
+ "description" : "The type of the payment of the corresponding salary and wages",
+ "enum" : [ "Salary", "Hourly" ]
+ }
+ },
+ "description" : ""
+};
defs["SalaryAndWageObject"] = {
"title" : "",
"type" : "object",
@@ -2171,10 +3186,163 @@
"description" : "Statutory Deduction Category",
"enum" : [ "AdditionalStudentLoan", "ChildSupport", "CourtFines", "Creditor", "FederalLevy", "InlandRevenueArrears", "KiwiSaver", "MsdRepayments", "NonPriorityOrder", "PriorityOrder", "TableBased", "StudentLoan", "VoluntaryStudentLoan", "USChildSupport" ]
};
- defs["TaxLine"] = ;
- defs["Timesheet"] = ;
- defs["TimesheetEarningsLine"] = ;
- defs["TimesheetLine"] = ;
+ defs["TaxLine"] = {
+ "title" : "",
+ "type" : "object",
+ "properties" : {
+ "taxLineID" : {
+ "type" : "string",
+ "description" : "Xero identifier for payroll tax line",
+ "format" : "uuid"
+ },
+ "description" : {
+ "type" : "string",
+ "description" : "Tax line description"
+ },
+ "isEmployerTax" : {
+ "type" : "boolean",
+ "description" : "Identifies if the amount is paid for by the employee or employer. True if employer pays the tax"
+ },
+ "amount" : {
+ "type" : "number",
+ "description" : "The amount of the tax line",
+ "format" : "double"
+ },
+ "globalTaxTypeID" : {
+ "type" : "string",
+ "description" : "Tax type ID"
+ },
+ "manualAdjustment" : {
+ "type" : "boolean",
+ "description" : "Identifies if the tax line is a manual adjustment"
+ }
+ },
+ "description" : ""
+};
+ defs["Timesheet"] = {
+ "title" : "",
+ "required" : [ "employeeID", "endDate", "payrollCalendarID", "startDate" ],
+ "type" : "object",
+ "properties" : {
+ "timesheetID" : {
+ "type" : "string",
+ "description" : "The Xero identifier for a Timesheet",
+ "format" : "uuid"
+ },
+ "payrollCalendarID" : {
+ "type" : "string",
+ "description" : "The Xero identifier for the Payroll Calendar that the Timesheet applies to",
+ "format" : "uuid"
+ },
+ "employeeID" : {
+ "type" : "string",
+ "description" : "The Xero identifier for the Employee that the Timesheet is for",
+ "format" : "uuid"
+ },
+ "startDate" : {
+ "type" : "string",
+ "description" : "The Start Date of the Timesheet period (YYYY-MM-DD)",
+ "format" : "date",
+ "x-is-date" : true
+ },
+ "endDate" : {
+ "type" : "string",
+ "description" : "The End Date of the Timesheet period (YYYY-MM-DD)",
+ "format" : "date",
+ "x-is-date" : true
+ },
+ "status" : {
+ "type" : "string",
+ "description" : "Status of the timesheet",
+ "enum" : [ "Draft", "Approved", "Completed" ]
+ },
+ "totalHours" : {
+ "type" : "number",
+ "description" : "The Total Hours of the Timesheet",
+ "format" : "double"
+ },
+ "updatedDateUTC" : {
+ "type" : "string",
+ "description" : "The UTC date time that the Timesheet was last updated",
+ "format" : "date-time",
+ "x-is-datetime" : true
+ },
+ "timesheetLines" : {
+ "$ref" : "#/components/schemas/TimesheetLines"
+ }
+ },
+ "description" : ""
+};
+ defs["TimesheetEarningsLine"] = {
+ "title" : "",
+ "type" : "object",
+ "properties" : {
+ "earningsRateID" : {
+ "type" : "string",
+ "description" : "Xero identifier for payroll timesheet earnings rate",
+ "format" : "uuid"
+ },
+ "ratePerUnit" : {
+ "type" : "number",
+ "description" : "Rate per unit for timesheet earnings line",
+ "format" : "double"
+ },
+ "numberOfUnits" : {
+ "type" : "number",
+ "description" : "Timesheet earnings number of units",
+ "format" : "double"
+ },
+ "fixedAmount" : {
+ "type" : "number",
+ "description" : "Timesheet earnings fixed amount. Only applicable if the EarningsRate RateType is Fixed",
+ "format" : "double"
+ },
+ "amount" : {
+ "type" : "number",
+ "description" : "The amount of the timesheet earnings line.",
+ "format" : "double"
+ },
+ "isLinkedToTimesheet" : {
+ "type" : "boolean",
+ "description" : "Identifies if the timesheet earnings is taken from the timesheet. False for leave earnings line"
+ }
+ },
+ "description" : ""
+};
+ defs["TimesheetLine"] = {
+ "title" : "",
+ "required" : [ "date", "earningsRateID", "numberOfUnits" ],
+ "type" : "object",
+ "properties" : {
+ "timesheetLineID" : {
+ "type" : "string",
+ "description" : "The Xero identifier for a Timesheet Line",
+ "format" : "uuid"
+ },
+ "date" : {
+ "type" : "string",
+ "description" : "The Date that this Timesheet Line is for (YYYY-MM-DD)",
+ "format" : "date",
+ "x-is-date" : true
+ },
+ "earningsRateID" : {
+ "type" : "string",
+ "description" : "The Xero identifier for the Earnings Rate that the Timesheet is for",
+ "format" : "uuid"
+ },
+ "trackingItemID" : {
+ "type" : "string",
+ "description" : "The Xero identifier for the Tracking Item that the Timesheet is for",
+ "format" : "uuid"
+ },
+ "numberOfUnits" : {
+ "type" : "number",
+ "description" : "The Number of Units of the Timesheet Line",
+ "format" : "double"
+ }
+ },
+ "description" : ""
+};
defs["TimesheetLineObject"] = {
"title" : "",
"type" : "object",
@@ -2833,7 +4001,17 @@ Parameters
@@ -2966,7 +4144,17 @@ Parameters
@@ -3099,7 +4287,17 @@ Parameters
@@ -3240,7 +4438,17 @@ Parameters
@@ -3411,7 +4619,16 @@ Parameters
@@ -3579,7 +4796,17 @@ Parameters
@@ -3745,7 +4972,17 @@ Parameters
@@ -3913,7 +5150,17 @@ Parameters
@@ -4085,7 +5332,17 @@ Parameters
@@ -4253,7 +5510,17 @@ Parameters
@@ -4388,7 +5655,17 @@ Parameters
@@ -4554,7 +5831,17 @@ Parameters
@@ -4686,7 +5973,17 @@ Parameters
@@ -4857,7 +6154,17 @@ Parameters
@@ -4991,7 +6298,17 @@ Parameters
@@ -5122,7 +6439,17 @@ Parameters
@@ -5257,7 +6584,17 @@ Parameters
@@ -5426,7 +6763,17 @@ Parameters
@@ -11170,7 +12517,17 @@ Parameters
@@ -11368,7 +12725,17 @@ Parameters
@@ -11563,7 +12930,17 @@ Parameters
@@ -11731,7 +13108,17 @@ Parameters
@@ -11926,7 +13313,17 @@ Parameters
@@ -12094,7 +13491,17 @@ Parameters
@@ -12290,7 +13697,17 @@ Parameters