diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 3d780f58..3a5dd8b1 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,16 +1,3 @@ - - ## Description - - -## Release Notes - + - -## Screenshots (if appropriate): - -## Types of Changes - -- [ ] Bug fix (non-breaking change that fixes an issue) -- [ ] New feature (non-breaking change that adds functionality) -- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) diff --git a/.releaserc b/.releaserc index 0e9e386e..4c6733e0 100644 --- a/.releaserc +++ b/.releaserc @@ -7,7 +7,7 @@ [ "@semantic-release/release-notes-generator", { - "preset": "angular", + "preset": "conventionalcommits", "writerOpts": { "headerPartial": "## What's changed", "footerPartial": "\n**Full Changelog**:https://github.com/XeroAPI/Xero-OpenAPI/compare/{{previousTag}}...{{version}}" diff --git a/.yamllint.yml b/.yamllint.yml index 57d592f3..537c3cca 100644 --- a/.yamllint.yml +++ b/.yamllint.yml @@ -2,12 +2,6 @@ extends: default rules: line-length: disable - trailing-spaces: disable - indentation: disable - colons: disable - commas: disable - new-line-at-end-of-file: disable document-start: disable truthy: disable comments: disable - new-lines: disable \ No newline at end of file diff --git a/scripts/update-version.sh b/scripts/update-version.sh index 896f405f..582b937e 100755 --- a/scripts/update-version.sh +++ b/scripts/update-version.sh @@ -3,15 +3,10 @@ versionNumber=${1:?Version number is required as first argument} branchName=${2:-master} -if [ "${GITHUB_ACTIONS:-}" = "true" ]; then - git config --global user.name "GitHub Actions" - git config --global user.email "actions@github.com" -fi - git checkout "$branchName" for file in xero*.yaml; do - yq eval --no-colors --prettyPrint ".info.version = \"$versionNumber\"" -i "$file" + yq -i ".info.version = \"$versionNumber\"" -i "$file" echo "updated version in $file to $versionNumber" done diff --git a/xero-app-store.yaml b/xero-app-store.yaml index 24842d74..fc52bf98 100644 --- a/xero-app-store.yaml +++ b/xero-app-store.yaml @@ -22,14 +22,14 @@ paths: operationId: getSubscription summary: Retrieves a subscription for a given subscriptionId parameters: - - $ref: '#/components/parameters/subscriptionId' + - $ref: "#/components/parameters/subscriptionId" responses: "200": description: Success - return response of unique Subscription object content: application/json: schema: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" example: currentPeriodEnd: 2021-07-20T03:13:48 endDate: 2021-07-20T03:13:48 @@ -72,7 +72,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ProblemDetails' + $ref: "#/components/schemas/ProblemDetails" description: When a failure occurs in the endpoint security: - OAuth2: @@ -84,16 +84,16 @@ paths: operationId: postUsageRecords summary: Send metered usage belonging to this subscription and subscription item parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/subscriptionId' - - $ref: '#/components/parameters/subscriptionItemId' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/subscriptionId" + - $ref: "#/components/parameters/subscriptionItemId" responses: "200": description: Success - return response of the record submitted content: application/json: schema: - $ref: '#/components/schemas/UsageRecord' + $ref: "#/components/schemas/UsageRecord" example: usageRecordId: 2a90f7d9-4c10-4a23-9c34-b47225167a48 subscriptionId: 391be708-878a-4741-acfb-c0bc9a165bdb @@ -107,7 +107,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ProblemDetails' + $ref: "#/components/schemas/ProblemDetails" description: When a failure occurs in the endpoint security: - OAuth2: @@ -116,7 +116,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CreateUsageRecord' + $ref: "#/components/schemas/CreateUsageRecord" example: timestamp: 2022-01-21T13:01:00 quantity: 10 @@ -129,17 +129,17 @@ paths: operationId: putUsageRecords summary: Update and existing metered usage belonging to this subscription and subscription item parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/subscriptionId' - - $ref: '#/components/parameters/subscriptionItemId' - - $ref: '#/components/parameters/usageRecordId' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/subscriptionId" + - $ref: "#/components/parameters/subscriptionItemId" + - $ref: "#/components/parameters/usageRecordId" responses: "200": description: Success - return response of the modified record content: application/json: schema: - $ref: '#/components/schemas/UsageRecord' + $ref: "#/components/schemas/UsageRecord" example: usageRecordId: 2a90f7d9-4c10-4a23-9c34-b47225167a48 subscriptionId: 391be708-878a-4741-acfb-c0bc9a165bdb @@ -153,7 +153,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ProblemDetails' + $ref: "#/components/schemas/ProblemDetails" description: When a failure occurs in the endpoint security: - OAuth2: @@ -162,7 +162,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdateUsageRecord' + $ref: "#/components/schemas/UpdateUsageRecord" example: quantity: 10 description: Contains the quantity for the usage record to update @@ -174,14 +174,14 @@ paths: operationId: getUsageRecords summary: Gets all usage records related to the subscription parameters: - - $ref: '#/components/parameters/subscriptionId' + - $ref: "#/components/parameters/subscriptionId" responses: "200": description: Success - return a list of all usage record submitted against this subscription for this subscription period content: application/json: schema: - $ref: '#/components/schemas/UsageRecordsList' + $ref: "#/components/schemas/UsageRecordsList" example: usageRecords: - usageRecordId: 206100d3-e18b-4c59-9372-e98e4367a73f @@ -204,7 +204,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ProblemDetails' + $ref: "#/components/schemas/ProblemDetails" description: When a failure occurs in the endpoint security: - OAuth2: @@ -228,7 +228,7 @@ components: description: Unique identifier for Subscription object example: 00000000-0000-0000-0000-000000000000 x-example-java: UUID.fromString("00000000-0000-0000-0000-000000000000") - x-example-php: '"00000000-0000-0000-0000-000000000000"' + x-example-php: ""00000000-0000-0000-0000-000000000000"" x-example-csharp: Guid.Parse("00000000-0000-0000-0000-000000000000"); schema: type: string @@ -241,7 +241,7 @@ components: description: The unique identifier of the subscriptionItem example: 00000000-0000-0000-0000-000000000000 x-example-java: UUID.fromString("00000000-0000-0000-0000-000000000000") - x-example-php: '"00000000-0000-0000-0000-000000000000"' + x-example-php: ""00000000-0000-0000-0000-000000000000"" x-example-csharp: Guid.Parse("00000000-0000-0000-0000-000000000000"); schema: type: string @@ -254,7 +254,7 @@ components: description: The unique identifier of the usage record example: 00000000-0000-0000-0000-000000000000 x-example-java: UUID.fromString("00000000-0000-0000-0000-000000000000") - x-example-php: '"00000000-0000-0000-0000-000000000000"' + x-example-php: ""00000000-0000-0000-0000-000000000000"" x-example-csharp: Guid.Parse("00000000-0000-0000-0000-000000000000"); schema: type: string @@ -294,7 +294,7 @@ components: description: List of plans for the subscription. type: array items: - $ref: '#/components/schemas/Plan' + $ref: "#/components/schemas/Plan" startDate: description: Date when the subscription was first created. format: date-time @@ -343,7 +343,7 @@ components: List of the subscription items belonging to the plan. It does not include cancelled subscription items. items: - $ref: '#/components/schemas/SubscriptionItem' + $ref: "#/components/schemas/SubscriptionItem" type: array required: - id @@ -398,10 +398,10 @@ components: type: string price: description: The price of the product subscribed to. - $ref: '#/components/schemas/Price' + $ref: "#/components/schemas/Price" product: description: The product subscribed to. - $ref: '#/components/schemas/Product' + $ref: "#/components/schemas/Product" quantity: description: The quantity of the item. For a fixed product, it is 1. For a per-seat product, it is a positive integer. For metered products, it is always null. type: integer @@ -508,7 +508,7 @@ components: usageRecords: description: A collection of usage records items: - $ref: '#/components/schemas/UsageRecord' + $ref: "#/components/schemas/UsageRecord" type: array required: - usageRecords diff --git a/xero-finance.yaml b/xero-finance.yaml index 5144e18b..d8d1dc61 100644 --- a/xero-finance.yaml +++ b/xero-finance.yaml @@ -17,7 +17,7 @@ servers: paths: /CashValidation: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -57,7 +57,7 @@ paths: schema: type: array items: - $ref: '#/components/schemas/CashValidationResponse' + $ref: "#/components/schemas/CashValidationResponse" example: - accountId: 73151de8-3676-4887-a021-edec960dd537 statementBalance: @@ -113,15 +113,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" example: type: invalid-request title: InvalidRequest status: 400 - detail: 'Invalid BalanceDate: ''2020-01''' + detail: "Invalid BalanceDate: '2020-01'" /AccountingActivities/AccountUsage: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -152,7 +152,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AccountUsageResponse' + $ref: "#/components/schemas/AccountUsageResponse" example: organisationId: 73151de8-3676-4887-a021-edec960dd537 startMonth: 2010-03 @@ -187,7 +187,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" example: type: invalid-request title: InvalidRequest @@ -195,7 +195,7 @@ paths: detail: Organisation 73151de8-3676-4887-a021-edec960dd537 does not exist /AccountingActivities/LockHistory: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -219,7 +219,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LockHistoryResponse' + $ref: "#/components/schemas/LockHistoryResponse" example: organisationId: 73151de8-3676-4887-a021-edec960dd537 endDate: "2019-06-20" @@ -238,7 +238,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" example: type: invalid-request title: InvalidRequest @@ -246,7 +246,7 @@ paths: detail: Organisation 73151de8-3676-4887-a021-edec960dd537 does not exist /AccountingActivities/ReportHistory: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -270,7 +270,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ReportHistoryResponse' + $ref: "#/components/schemas/ReportHistoryResponse" example: organisationId: 73151de8-3676-4887-a021-edec960dd537 endDate: "2019-10-20" @@ -283,7 +283,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" example: type: invalid-request title: InvalidRequest @@ -291,7 +291,7 @@ paths: detail: Organisation 73151de8-3676-4887-a021-edec960dd537 does not exist /AccountingActivities/UserActivities: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -315,7 +315,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UserActivitiesResponse' + $ref: "#/components/schemas/UserActivitiesResponse" example: organisationId: 73151de8-3676-4887-a021-edec960dd537 dataMonth: 2020-01 @@ -362,7 +362,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" example: type: invalid-request title: InvalidRequest @@ -370,7 +370,7 @@ paths: detail: Organisation 73151de8-3676-4887-a021-edec960dd537 does not exist /FinancialStatements/BalanceSheet: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -394,7 +394,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BalanceSheetResponse' + $ref: "#/components/schemas/BalanceSheetResponse" example: balanceDate: "2021-05-12" asset: @@ -458,7 +458,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" example: type: invalid-request title: InvalidRequest @@ -469,7 +469,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" example: type: service-unavailable title: ServiceUnavailable @@ -477,7 +477,7 @@ paths: detail: Cannot process org xxx at this time. Apologies for inconvenience. /FinancialStatements/Cashflow: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -508,7 +508,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CashflowResponse' + $ref: "#/components/schemas/CashflowResponse" example: startDate: "2018-07-01" endDate: "2019-06-30" @@ -612,7 +612,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" example: type: invalid-request title: InvalidRequest @@ -623,7 +623,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" example: type: service-unavailable title: ServiceUnavailable @@ -631,7 +631,7 @@ paths: detail: Cannot process org xxx at this time. Apologies for inconvenience. /FinancialStatements/ProfitAndLoss: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -662,7 +662,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ProfitAndLossResponse' + $ref: "#/components/schemas/ProfitAndLossResponse" example: startDate: "2020-07-01" endDate: "2021-06-30" @@ -714,7 +714,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" example: type: invalid-request title: InvalidRequest @@ -722,7 +722,7 @@ paths: detail: Organisation xxx does not exist /FinancialStatements/TrialBalance: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -746,7 +746,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TrialBalanceResponse' + $ref: "#/components/schemas/TrialBalanceResponse" example: startDate: "2020-07-01" endDate: "2021-06-30" @@ -774,7 +774,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" example: type: invalid-request title: InvalidRequest @@ -782,7 +782,7 @@ paths: detail: Organisation xxx does not exist /FinancialStatements/contacts/revenue: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -833,7 +833,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/IncomeByContactResponse' + $ref: "#/components/schemas/IncomeByContactResponse" example: startDate: "2019-10-17" endDate: "2020-10-16" @@ -884,7 +884,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" example: type: invalid-request title: InvalidRequest @@ -892,7 +892,7 @@ paths: detail: Organisation xxx does not exist /FinancialStatements/contacts/expense: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -943,7 +943,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/IncomeByContactResponse' + $ref: "#/components/schemas/IncomeByContactResponse" example: startDate: "2019-10-17" endDate: "2020-10-16" @@ -994,7 +994,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" example: type: invalid-request title: InvalidRequest @@ -1002,7 +1002,7 @@ paths: detail: Organisation xxx does not exist /BankStatementsPlus/statements: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -1011,7 +1011,7 @@ paths: - Finance operationId: getBankStatementAccounting summary: Get Bank Statement Accounting - description: 'For lenders that prefer using bank statement data as the source of truth. We provide a data point that will allow access to customer bank statements, plus for reconciled bank transactions the matching accounting, invoice and billing data as well. As customers reconcile bank statements to invoices and bills, this transaction detail will provide valuable insight for lender''s assessment measures. ' + description: "For lenders that prefer using bank statement data as the source of truth. We provide a data point that will allow access to customer bank statements, plus for reconciled bank transactions the matching accounting, invoice and billing data as well. As customers reconcile bank statements to invoices and bills, this transaction detail will provide valuable insight for lender's assessment measures. " parameters: - name: BankAccountID x-snake: bank_account_id @@ -1053,7 +1053,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BankStatementAccountingResponse' + $ref: "#/components/schemas/BankStatementAccountingResponse" example: bankAccountId: 1234eee9-47f0-4179-bd46-9adb4f21cc7f bankAccountName: ANZ BANK @@ -1166,7 +1166,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" example: type: invalid-request title: InvalidRequest @@ -1270,7 +1270,7 @@ components: accountUsage: type: array items: - $ref: '#/components/schemas/AccountUsage' + $ref: "#/components/schemas/AccountUsage" additionalProperties: false HistoryRecordResponse: type: object @@ -1322,7 +1322,7 @@ components: lockDates: type: array items: - $ref: '#/components/schemas/LockHistoryModel' + $ref: "#/components/schemas/LockHistoryModel" additionalProperties: false PracticeResponse: type: object @@ -1349,7 +1349,7 @@ components: type: object properties: type: - $ref: '#/components/schemas/ProblemType' + $ref: "#/components/schemas/ProblemType" title: type: string status: @@ -1400,7 +1400,7 @@ components: reports: type: array items: - $ref: '#/components/schemas/ReportHistoryModel' + $ref: "#/components/schemas/ReportHistoryModel" additionalProperties: false UserActivitiesResponse: type: object @@ -1415,7 +1415,7 @@ components: users: type: array items: - $ref: '#/components/schemas/UserResponse' + $ref: "#/components/schemas/UserResponse" additionalProperties: false UserResponse: type: object @@ -1462,19 +1462,19 @@ components: attachedPractices: type: array items: - $ref: '#/components/schemas/PracticeResponse' + $ref: "#/components/schemas/PracticeResponse" historyRecords: type: array items: - $ref: '#/components/schemas/HistoryRecordResponse' + $ref: "#/components/schemas/HistoryRecordResponse" additionalProperties: false BankStatementResponse: type: object properties: statementLines: - $ref: '#/components/schemas/StatementLinesResponse' + $ref: "#/components/schemas/StatementLinesResponse" currentStatement: - $ref: '#/components/schemas/CurrentStatementResponse' + $ref: "#/components/schemas/CurrentStatementResponse" additionalProperties: false CashAccountResponse: type: object @@ -1511,15 +1511,15 @@ components: description: The Xero identifier for an account format: uuid statementBalance: - $ref: '#/components/schemas/StatementBalanceResponse' + $ref: "#/components/schemas/StatementBalanceResponse" statementBalanceDate: type: string description: UTC Date when the last bank statement item was entered into Xero. This date is represented in ISO 8601 format. format: date bankStatement: - $ref: '#/components/schemas/BankStatementResponse' + $ref: "#/components/schemas/BankStatementResponse" cashAccount: - $ref: '#/components/schemas/CashAccountResponse' + $ref: "#/components/schemas/CashAccountResponse" additionalProperties: false CurrentStatementResponse: type: object @@ -1672,7 +1672,7 @@ components: format: double x-is-money: true dataSource: - $ref: '#/components/schemas/DataSourceResponse' + $ref: "#/components/schemas/DataSourceResponse" earliestReconciledTransaction: type: string description: UTC Date which is the earliest transaction date of a statement line for which the reconciled flag is set to TRUE. This date is represented in ISO 8601 format. @@ -1734,7 +1734,7 @@ components: accountTypes: type: array items: - $ref: '#/components/schemas/BalanceSheetAccountType' + $ref: "#/components/schemas/BalanceSheetAccountType" total: type: number description: Total value of all the accounts in this type @@ -1750,7 +1750,7 @@ components: accounts: type: array items: - $ref: '#/components/schemas/BalanceSheetAccountDetail' + $ref: "#/components/schemas/BalanceSheetAccountDetail" description: A list of all accounts of this type. Refer to the Account section below for each account element detail. total: type: number @@ -1766,11 +1766,11 @@ components: format: date description: Balance date of the report asset: - $ref: '#/components/schemas/BalanceSheetAccountGroup' + $ref: "#/components/schemas/BalanceSheetAccountGroup" liability: - $ref: '#/components/schemas/BalanceSheetAccountGroup' + $ref: "#/components/schemas/BalanceSheetAccountGroup" equity: - $ref: '#/components/schemas/BalanceSheetAccountGroup' + $ref: "#/components/schemas/BalanceSheetAccountGroup" additionalProperties: false CashBalance: type: object @@ -1834,7 +1834,7 @@ components: cashflowTypes: type: array items: - $ref: '#/components/schemas/CashflowType' + $ref: "#/components/schemas/CashflowType" additionalProperties: false CashflowResponse: type: object @@ -1848,11 +1848,11 @@ components: description: End date of the report format: date cashBalance: - $ref: '#/components/schemas/CashBalance' + $ref: "#/components/schemas/CashBalance" cashflowActivities: type: array items: - $ref: '#/components/schemas/CashflowActivity' + $ref: "#/components/schemas/CashflowActivity" description: Break down of cash and cash equivalents for the period additionalProperties: false CashflowType: @@ -1869,7 +1869,7 @@ components: accounts: type: array items: - $ref: '#/components/schemas/CashflowAccount' + $ref: "#/components/schemas/CashflowAccount" description: List of the accounts in this activity additionalProperties: false PnlAccount: @@ -1908,7 +1908,7 @@ components: accountTypes: type: array items: - $ref: '#/components/schemas/PnlAccountType' + $ref: "#/components/schemas/PnlAccountType" description: Contains trading income and other income for revenue section / operating expenses and direct cost for expense section if the data is available for each section. Refer to the account type element below additionalProperties: false PnlAccountType: @@ -1925,7 +1925,7 @@ components: accounts: type: array items: - $ref: '#/components/schemas/PnlAccount' + $ref: "#/components/schemas/PnlAccount" description: A list of the movement on each account detail during the query period. Refer to the account detail element below additionalProperties: false ProfitAndLossResponse: @@ -1945,9 +1945,9 @@ components: format: double x-is-money: true revenue: - $ref: '#/components/schemas/PnlAccountClass' + $ref: "#/components/schemas/PnlAccountClass" expense: - $ref: '#/components/schemas/PnlAccountClass' + $ref: "#/components/schemas/PnlAccountClass" additionalProperties: false TrialBalanceAccount: type: object @@ -1975,14 +1975,14 @@ components: type: string description: Name of the account balance: - $ref: '#/components/schemas/TrialBalanceEntry' + $ref: "#/components/schemas/TrialBalanceEntry" signedBalance: type: number description: Value of balance. Expense and Asset accounts code debits as positive. Revenue, Liability, and Equity accounts code debits as negative format: double x-is-money: true accountMovement: - $ref: '#/components/schemas/TrialBalanceMovement' + $ref: "#/components/schemas/TrialBalanceMovement" additionalProperties: false TrialBalanceEntry: type: object @@ -2010,7 +2010,7 @@ components: format: double x-is-money: true movement: - $ref: '#/components/schemas/TrialBalanceEntry' + $ref: "#/components/schemas/TrialBalanceEntry" signedMovement: type: number description: Value of movement. Expense and Asset accounts code debits as positive. Revenue, Liability, and Equity accounts code debits as negative @@ -2031,7 +2031,7 @@ components: accounts: type: array items: - $ref: '#/components/schemas/TrialBalanceAccount' + $ref: "#/components/schemas/TrialBalanceAccount" description: Refer to the accounts section below additionalProperties: false IncomeByContactResponse: @@ -2051,15 +2051,15 @@ components: format: double x-is-money: true totalDetail: - $ref: '#/components/schemas/TotalDetail' + $ref: "#/components/schemas/TotalDetail" totalOther: - $ref: '#/components/schemas/TotalOther' + $ref: "#/components/schemas/TotalOther" contacts: type: array items: - $ref: '#/components/schemas/ContactDetail' + $ref: "#/components/schemas/ContactDetail" manualJournals: - $ref: '#/components/schemas/ManualJournalTotal' + $ref: "#/components/schemas/ManualJournalTotal" additionalProperties: false ManualJournalTotal: type: object @@ -2124,9 +2124,9 @@ components: format: double x-is-money: true totalDetail: - $ref: '#/components/schemas/ContactTotalDetail' + $ref: "#/components/schemas/ContactTotalDetail" totalOther: - $ref: '#/components/schemas/ContactTotalOther' + $ref: "#/components/schemas/ContactTotalOther" accountCodes: type: array items: @@ -2191,7 +2191,7 @@ components: statements: type: array items: - $ref: '#/components/schemas/StatementResponse' + $ref: "#/components/schemas/StatementResponse" description: List of bank statements and linked accounting data for the requested period additionalProperties: false BankTransactionResponse: @@ -2206,7 +2206,7 @@ components: description: Xero Identifier of batch payment. Present if the transaction is part of a batch. format: uuid contact: - $ref: '#/components/schemas/ContactResponse' + $ref: "#/components/schemas/ContactResponse" date: type: string description: Date of transaction - YYYY-MM-DD @@ -2219,7 +2219,7 @@ components: lineItems: type: array items: - $ref: '#/components/schemas/LineItemResponse' + $ref: "#/components/schemas/LineItemResponse" description: The LineItems element can contain any number of individual LineItem sub-elements. Not included in summary mode additionalProperties: false ContactResponse: @@ -2241,7 +2241,7 @@ components: description: Xero Identifier of credit note format: uuid contact: - $ref: '#/components/schemas/ContactResponse' + $ref: "#/components/schemas/ContactResponse" total: type: number description: Total of Invoice tax inclusive (i.e. SubTotal + TotalTax); Not included in summary mode @@ -2250,7 +2250,7 @@ components: lineItems: type: array items: - $ref: '#/components/schemas/LineItemResponse' + $ref: "#/components/schemas/LineItemResponse" description: Not included in summary mode additionalProperties: false InvoiceResponse: @@ -2261,7 +2261,7 @@ components: description: Xero Identifier of invoice format: uuid contact: - $ref: '#/components/schemas/ContactResponse' + $ref: "#/components/schemas/ContactResponse" total: type: number description: Total of Invoice tax inclusive (i.e. SubTotal + TotalTax); Not included in summary mode @@ -2270,7 +2270,7 @@ components: lineItems: type: array items: - $ref: '#/components/schemas/LineItemResponse' + $ref: "#/components/schemas/LineItemResponse" description: Not included in summary mode additionalProperties: false LineItemResponse: @@ -2300,7 +2300,7 @@ components: description: Xero Identifier of overpayment format: uuid contact: - $ref: '#/components/schemas/ContactResponse' + $ref: "#/components/schemas/ContactResponse" total: type: number description: Total of Invoice tax inclusive (i.e. SubTotal + TotalTax); Not included in summary mode @@ -2309,7 +2309,7 @@ components: lineItems: type: array items: - $ref: '#/components/schemas/LineItemResponse' + $ref: "#/components/schemas/LineItemResponse" description: Not included in summary mode additionalProperties: false PaymentResponse: @@ -2342,13 +2342,13 @@ components: description: Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500 format: double invoice: - $ref: '#/components/schemas/InvoiceResponse' + $ref: "#/components/schemas/InvoiceResponse" creditNote: - $ref: '#/components/schemas/CreditNoteResponse' + $ref: "#/components/schemas/CreditNoteResponse" prepayment: - $ref: '#/components/schemas/PrepaymentResponse' + $ref: "#/components/schemas/PrepaymentResponse" overpayment: - $ref: '#/components/schemas/OverpaymentResponse' + $ref: "#/components/schemas/OverpaymentResponse" additionalProperties: false PrepaymentResponse: type: object @@ -2358,7 +2358,7 @@ components: description: Xero Identifier of prepayment format: uuid contact: - $ref: '#/components/schemas/ContactResponse' + $ref: "#/components/schemas/ContactResponse" total: type: number description: Total of Invoice tax inclusive (i.e. SubTotal + TotalTax); Not included in summary mode @@ -2367,7 +2367,7 @@ components: lineItems: type: array items: - $ref: '#/components/schemas/LineItemResponse' + $ref: "#/components/schemas/LineItemResponse" description: Not included in summary mode additionalProperties: false StatementLineResponse: @@ -2417,12 +2417,12 @@ components: payments: type: array items: - $ref: '#/components/schemas/PaymentResponse' + $ref: "#/components/schemas/PaymentResponse" description: List of payments associated with reconciled statement lines bankTransactions: type: array items: - $ref: '#/components/schemas/BankTransactionResponse' + $ref: "#/components/schemas/BankTransactionResponse" description: List of bank transactions associated with reconciled statement lines additionalProperties: false StatementResponse: @@ -2471,6 +2471,6 @@ components: statementLines: type: array items: - $ref: '#/components/schemas/StatementLineResponse' + $ref: "#/components/schemas/StatementLineResponse" description: List of statement lines additionalProperties: false diff --git a/xero-identity.yaml b/xero-identity.yaml index 411daa87..42baa275 100644 --- a/xero-identity.yaml +++ b/xero-identity.yaml @@ -42,7 +42,7 @@ paths: schema: type: array items: - $ref: '#/components/schemas/Connection' + $ref: "#/components/schemas/Connection" example: '[ { "id": "7cb59f93-2964-421d-bb5e-a0f7a4572a44", "tenantId": "fe79f7dd-b6d4-4a92-ba7b-538af6289c58", "tenantName": "Demo Company (NZ)", "tenantType": "ORGANISATION", "createdDateUtc": "2019-12-07T18:46:19.5165400", "updatedDateUtc": "2019-12-07T18:46:19.5187840" } ]' /Connections/{id}: delete: diff --git a/xero-payroll-au.yaml b/xero-payroll-au.yaml index 561a7de7..338de0ad 100644 --- a/xero-payroll-au.yaml +++ b/xero-payroll-au.yaml @@ -20,7 +20,7 @@ tags: paths: /Employees: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -62,7 +62,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Employees' + $ref: "#/components/schemas/Employees" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -101,7 +101,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/APIException' + $ref: "#/components/schemas/APIException" post: security: - OAuth2: @@ -110,7 +110,7 @@ paths: - PayrollAu summary: Creates a payroll employee parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" operationId: createEmployee x-hasPayrollAuProblem: true x-example: @@ -126,9 +126,9 @@ paths: java: LocalDate.of(2000, Month.OCTOBER, 28) csharp: new DateTime(2000, 10, 10) php: new DateTime('2000-10-28') - node: '''2000-10-28''' + node: "'2000-10-28'" python: dateutil.parser.parse('2000-10-28T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - homeAddress: key: homeAddress keyPascal: HomeAddress @@ -202,7 +202,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Employees' + $ref: "#/components/schemas/Employees" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -241,11 +241,11 @@ paths: schema: type: array items: - $ref: '#/components/schemas/Employee' + $ref: "#/components/schemas/Employee" example: '[ { "FirstName": "Albus", "LastName": "Dumbledore", "DateOfBirth": "/Date(321523200000+0000)/", "HomeAddress": { "AddressLine1": "101 Green St", "City": "Island Bay", "Region": "NSW", "PostalCode": "6023", "Country": "AUSTRALIA" }, "StartDate": "/Date(321523200000+0000)/", "MiddleNames": "Percival", "Email": "albus39608@hogwarts.edu", "Gender": "M", "Phone": "444-2323", "Mobile": "555-1212", "IsAuthorisedToApproveLeave": true, "IsAuthorisedToApproveTimesheets": true, "JobTitle": "Regional Manager", "Classification": "corporate", "OrdinaryEarningsRateID": "ab874dfb-ab09-4c91-954e-43acf6fc23b4", "Status": "ACTIVE" } ]' /Employees/{EmployeeID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -271,7 +271,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Employees' + $ref: "#/components/schemas/Employees" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -376,9 +376,9 @@ paths: java: LocalDate.of(2000, Month.OCTOBER, 28) csharp: new DateTime(2000, 10, 10) php: new DateTime('2000-10-28') - node: '''2000-10-28''' + node: "'2000-10-28'" python: dateutil.parser.parse('2000-10-28T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - homeAddress: key: homeAddress keyPascal: HomeAddress @@ -447,7 +447,7 @@ paths: ruby: home_address object: employee parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: EmployeeID x-snake: employee_id in: path @@ -463,7 +463,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Employees' + $ref: "#/components/schemas/Employees" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -500,11 +500,11 @@ paths: schema: type: array items: - $ref: '#/components/schemas/Employee' + $ref: "#/components/schemas/Employee" example: '[ { "MiddleNames": "Frank" } ]' /LeaveApplications: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -546,7 +546,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LeaveApplications' + $ref: "#/components/schemas/LeaveApplications" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -619,7 +619,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/APIException' + $ref: "#/components/schemas/APIException" post: security: - OAuth2: @@ -628,7 +628,7 @@ paths: - PayrollAu summary: Creates a leave application parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" operationId: createLeaveApplication x-hasPayrollAuProblem: true x-example: @@ -643,9 +643,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 28) csharp: new DateTime(2020, 10, 10) php: new DateTime('2020-10-28') - node: '''2020-10-28''' + node: "'2020-10-28'" python: dateutil.parser.parse('2020-10-28T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - endDateValue: key: endDate keyPascal: EndDate @@ -657,9 +657,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 30) csharp: new DateTime(2020, 10, 12) php: new DateTime('2020-10-30') - node: '''2020-10-30''' + node: "'2020-10-30'" python: dateutil.parser.parse('2020-10-30T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - leaveApplication: key: leaveApplication keyPascal: LeaveApplication @@ -711,7 +711,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LeaveApplications' + $ref: "#/components/schemas/LeaveApplications" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -740,11 +740,11 @@ paths: schema: type: array items: - $ref: '#/components/schemas/LeaveApplication' + $ref: "#/components/schemas/LeaveApplication" example: '[ { "EmployeeID": "cdfb8371-0b21-4b8a-8903-1024df6c391e", "LeaveTypeID": "184ea8f7-d143-46dd-bef3-0c60e1aa6fca", "Title": "Hello World", "StartDate": "/Date(1572559200000+0000)/", "EndDate": "/Date(1572645600000+0000)/" } ]' /LeaveApplications/v2: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -786,7 +786,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LeaveApplications' + $ref: "#/components/schemas/LeaveApplications" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -872,10 +872,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/APIException' + $ref: "#/components/schemas/APIException" /LeaveApplications/{LeaveApplicationID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -901,7 +901,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LeaveApplications' + $ref: "#/components/schemas/LeaveApplications" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -941,9 +941,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 28) csharp: new DateTime(2020, 10, 10) php: new DateTime('2020-10-28') - node: '''2020-10-28''' + node: "'2020-10-28'" python: dateutil.parser.parse('2020-10-28T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - endDateValue: key: endDate keyPascal: EndDate @@ -955,9 +955,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 30) csharp: new DateTime(2020, 10, 12) php: new DateTime('2020-10-30') - node: '''2020-10-30''' + node: "'2020-10-30'" python: dateutil.parser.parse('2020-10-30T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - leaveApplication: key: leaveApplication keyPascal: LeaveApplication @@ -1004,7 +1004,7 @@ paths: ruby: end_date object: leaveApplication parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: LeaveApplicationID x-snake: leave_application_id in: path @@ -1020,7 +1020,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LeaveApplications' + $ref: "#/components/schemas/LeaveApplications" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -1050,11 +1050,11 @@ paths: schema: type: array items: - $ref: '#/components/schemas/LeaveApplication' + $ref: "#/components/schemas/LeaveApplication" example: '[ { "EmployeeID": "cdfb8371-0b21-4b8a-8903-1024df6c391e", "LeaveApplicationID": "1d4cd583-0107-4386-936b-672eb3d1f624", "LeaveTypeID": "184ea8f7-d143-46dd-bef3-0c60e1aa6fca", "LeavePeriods": [ { "PayPeriodStartDate": "/Date(1572566400000+0000)/", "PayPeriodEndDate": "/Date(1573084800000+0000)/", "LeavePeriodStatus": "SCHEDULED", "NumberOfUnits": 7.6 } ], "Title": "vacation", "Description": "My updated Description", "StartDate": "/Date(1572559200000+0000)/", "EndDate": "/Date(1572645600000+0000)/", "PayOutType": "DEFAULT" } ]' /LeaveApplications/{LeaveApplicationID}/approve: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" post: security: - OAuth2: @@ -1064,7 +1064,7 @@ paths: summary: Approve a requested leave application by a unique leave application id operationId: approveLeaveApplication parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: LeaveApplicationID x-snake: leave_application_id in: path @@ -1080,7 +1080,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LeaveApplications' + $ref: "#/components/schemas/LeaveApplications" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -1105,10 +1105,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/APIException' + $ref: "#/components/schemas/APIException" /LeaveApplications/{LeaveApplicationID}/reject: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" post: security: - OAuth2: @@ -1118,7 +1118,7 @@ paths: summary: Reject a leave application by a unique leave application id operationId: rejectLeaveApplication parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: LeaveApplicationID x-snake: leave_application_id in: path @@ -1134,7 +1134,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LeaveApplications' + $ref: "#/components/schemas/LeaveApplications" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -1159,10 +1159,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/APIException' + $ref: "#/components/schemas/APIException" /PayItems: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -1204,7 +1204,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PayItems' + $ref: "#/components/schemas/PayItems" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -1324,7 +1324,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/APIException' + $ref: "#/components/schemas/APIException" post: security: - OAuth2: @@ -1333,7 +1333,7 @@ paths: - PayrollAu summary: Creates a pay item parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" operationId: createPayItem x-example: - earningsRate: @@ -1576,7 +1576,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PayItems' + $ref: "#/components/schemas/PayItems" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -1631,7 +1631,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PayItem' + $ref: "#/components/schemas/PayItem" example: EarningsRates: - Name: MyRate @@ -1651,7 +1651,7 @@ paths: EmploymentTerminationPaymentType: O /PayrollCalendars: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -1693,7 +1693,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PayrollCalendars' + $ref: "#/components/schemas/PayrollCalendars" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -1719,7 +1719,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/APIException' + $ref: "#/components/schemas/APIException" post: security: - OAuth2: @@ -1728,7 +1728,7 @@ paths: - PayrollAu summary: Creates a Payroll Calendar parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" operationId: createPayrollCalendar x-hasPayrollAuProblem: true x-example: @@ -1743,9 +1743,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 28) csharp: new DateTime(2020, 10, 10) php: new DateTime('2020-10-28') - node: '''2000-10-28''' + node: "'2000-10-28'" python: dateutil.parser.parse('2020-10-28T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - paymentDateValue: key: paymentDate keyPascal: PaymentDate @@ -1757,9 +1757,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 30) csharp: new DateTime(2020, 10, 30) php: new DateTime('2020-10-30') - node: '''2000-10-30''' + node: "'2000-10-30'" python: dateutil.parser.parse('2000-10-30T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - payrollCalendar: is_object: true key: payrollCalendar @@ -1829,7 +1829,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PayrollCalendars' + $ref: "#/components/schemas/PayrollCalendars" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -1851,11 +1851,11 @@ paths: schema: type: array items: - $ref: '#/components/schemas/PayrollCalendar' + $ref: "#/components/schemas/PayrollCalendar" example: '[ { "PayrollCalendarID":"78bb86b9-e1ea-47ac-b75d-f087a81931de", "PayRunPeriodStartDate":"/Date(1572566400000+0000)/", "PayRunPeriodEndDate":"/Date(1573084800000+0000)/", "PayRunStatus":"DRAFT", "PaymentDate":"/Date(1573171200000+0000)/" } ]' /PayrollCalendars/{PayrollCalendarID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -1881,7 +1881,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PayrollCalendars' + $ref: "#/components/schemas/PayrollCalendars" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -1900,10 +1900,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/APIException' + $ref: "#/components/schemas/APIException" /PayRuns: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -1945,7 +1945,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PayRuns' + $ref: "#/components/schemas/PayRuns" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -1970,7 +1970,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/APIException' + $ref: "#/components/schemas/APIException" post: security: - OAuth2: @@ -1979,7 +1979,7 @@ paths: - PayrollAu summary: Creates a pay run parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" operationId: createPayRun x-hasPayrollAuProblem: true x-example: @@ -2002,7 +2002,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PayRuns' + $ref: "#/components/schemas/PayRuns" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -2025,11 +2025,11 @@ paths: schema: type: array items: - $ref: '#/components/schemas/PayRun' + $ref: "#/components/schemas/PayRun" example: '[ { "PayrollCalendarID": "78bb86b9-e1ea-47ac-b75d-f087a81931de", "PayRunPeriodStartDate": "/Date(1572566400000+0000)/", "PayRunPeriodEndDate": "/Date(1573084800000+0000)/", "PayRunStatus": "DRAFT", "PaymentDate": "/Date(1573171200000+0000)/" } ]' /PayRuns/{PayRunID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -2055,7 +2055,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PayRuns' + $ref: "#/components/schemas/PayRuns" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -2123,7 +2123,7 @@ paths: object: payRun is_last: true parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: PayRunID x-snake: pay_run_id in: path @@ -2139,7 +2139,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PayRuns' + $ref: "#/components/schemas/PayRuns" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -2160,11 +2160,11 @@ paths: schema: type: array items: - $ref: '#/components/schemas/PayRun' + $ref: "#/components/schemas/PayRun" example: '[ { "PayRunStatus": "POSTED" } ]' /Payslip/{PayslipID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -2190,7 +2190,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PayslipObject' + $ref: "#/components/schemas/PayslipObject" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -2336,7 +2336,7 @@ paths: object: payslipLine description: Update lines on a single payslips parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: PayslipID x-snake: payslip_id in: path @@ -2352,7 +2352,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Payslips' + $ref: "#/components/schemas/Payslips" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -2378,7 +2378,7 @@ paths: schema: type: array items: - $ref: '#/components/schemas/PayslipLines' + $ref: "#/components/schemas/PayslipLines" example: Payslip: EmployeeID: cdfb8371-0b21-4b8a-8903-1024df6c391e @@ -2388,7 +2388,7 @@ paths: NumberOfUnits: 10 /Settings: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -2404,7 +2404,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SettingsObject' + $ref: "#/components/schemas/SettingsObject" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -2447,7 +2447,7 @@ paths: EmployeesAreSTP2: false /Superfunds: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -2489,7 +2489,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SuperFunds' + $ref: "#/components/schemas/SuperFunds" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -2511,7 +2511,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/APIException' + $ref: "#/components/schemas/APIException" post: security: - OAuth2: @@ -2520,7 +2520,7 @@ paths: - PayrollAu summary: Creates a superfund parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" operationId: createSuperfund x-example: - superfund: @@ -2555,7 +2555,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SuperFunds' + $ref: "#/components/schemas/SuperFunds" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -2579,11 +2579,11 @@ paths: schema: type: array items: - $ref: '#/components/schemas/SuperFund' + $ref: "#/components/schemas/SuperFund" example: '[ { "usi":"PTC0133AU", "Type":"REGULATED", "Name":"Bar99359", "AccountNumber":"FB36350", "AccountName":"Foo38428", "USI":"PTC0133AU" } ]' /Superfunds/{SuperFundID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -2609,7 +2609,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SuperFunds' + $ref: "#/components/schemas/SuperFunds" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -2662,7 +2662,7 @@ paths: object: superfund is_last: true parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: SuperFundID x-snake: super_fund_id in: path @@ -2678,7 +2678,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SuperFunds' + $ref: "#/components/schemas/SuperFunds" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -2698,11 +2698,11 @@ paths: schema: type: array items: - $ref: '#/components/schemas/SuperFund' + $ref: "#/components/schemas/SuperFund" example: ' [ { "Type":"REGULATED", "Name":"Nice23534" } ]' /SuperfundProducts: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -2731,7 +2731,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SuperFundProducts' + $ref: "#/components/schemas/SuperFundProducts" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -2746,10 +2746,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/APIException' + $ref: "#/components/schemas/APIException" /Timesheets: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -2791,7 +2791,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Timesheets' + $ref: "#/components/schemas/Timesheets" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -2839,7 +2839,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/APIException' + $ref: "#/components/schemas/APIException" post: security: - OAuth2: @@ -2848,7 +2848,7 @@ paths: - PayrollAu summary: Creates a timesheet parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" operationId: createTimesheet x-hasPayrollAuProblem: true x-example: @@ -2863,9 +2863,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 23) csharp: new DateTime(2020, 10, 23) php: new DateTime('2020-10-23') - node: '''2020-10-23''' + node: "'2020-10-23'" python: dateutil.parser.parse('2020-10-23T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - endDateValue: key: endDate keyPascal: EndDate @@ -2877,9 +2877,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 30) csharp: new DateTime(2020, 10, 30) php: new DateTime('2020-10-30') - node: '''2020-10-30''' + node: "'2020-10-30'" python: dateutil.parser.parse('2020-10-30T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - timesheet: key: timesheet keyPascal: Timesheet @@ -2932,7 +2932,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Timesheets' + $ref: "#/components/schemas/Timesheets" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -2967,11 +2967,11 @@ paths: schema: type: array items: - $ref: '#/components/schemas/Timesheet' + $ref: "#/components/schemas/Timesheet" example: '[ { "EmployeeID":"b34e89ff-770d-4099-b7e5-f968767118bc", "StartDate":"/Date(1573171200000+0000)/", "EndDate":"/Date(1573689600000+0000)/", "Status":"DRAFT", "TimesheetLines":[ { "EarningsRateID":"ab874dfb-ab09-4c91-954e-43acf6fc23b4", "TrackingItemID":"af5e9ce2-2349-4136-be99-3561b189f473", "NumberOfUnits":[ 2.0, 10.0, 0.0, 0.0, 5.0, 0.0, 5.0 ] } ] } ]' /Timesheets/{TimesheetID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -2997,7 +2997,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TimesheetObject' + $ref: "#/components/schemas/TimesheetObject" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -3043,9 +3043,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 23) csharp: new DateTime(2020, 10, 23) php: new DateTime('2020-10-23') - node: '''2020-10-23''' + node: "'2020-10-23'" python: dateutil.parser.parse('2020-10-23T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - endDateValue: key: endDate keyPascal: EndDate @@ -3057,9 +3057,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 30) csharp: new DateTime(2020, 10, 30) php: new DateTime('2020-10-30') - node: '''2020-10-30''' + node: "'2020-10-30'" python: dateutil.parser.parse('2020-10-30T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - timesheet: key: timesheet keyPascal: Timesheet @@ -3107,7 +3107,7 @@ paths: csharp: TimesheetStatus.DRAFT object: timesheet parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: TimesheetID x-snake: timesheet_id in: path @@ -3123,7 +3123,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Timesheets' + $ref: "#/components/schemas/Timesheets" example: Id: 00000000-0000-0000-0000-000000000000 Status: OK @@ -3156,7 +3156,7 @@ paths: schema: type: array items: - $ref: '#/components/schemas/Timesheet' + $ref: "#/components/schemas/Timesheet" example: '[ { "EmployeeID":"b34e89ff-770d-4099-b7e5-f968767118bc", "StartDate":"/Date(1573171200000+0000)/", "EndDate":"/Date(1573689600000+0000)/", "Status":"APPROVED", "Hours":22.0, "TimesheetID":"a7eb0a79-8511-4ee7-b473-3a25f28abcb9", "TimesheetLines":[ { "EarningsRateID":"ab874dfb-ab09-4c91-954e-43acf6fc23b4", "TrackingItemID":"af5e9ce2-2349-4136-be99-3561b189f473", "NumberOfUnits":[ 2.0, 10.0, 0.0, 0.0, 5.0, 0.0, 5.0 ], "UpdatedDateUTC":"/Date(1573516185127+0000)/" } ] } ]' components: securitySchemes: @@ -3206,7 +3206,7 @@ components: Employees: type: array items: - $ref: '#/components/schemas/Employee' + $ref: "#/components/schemas/Employee" Employee: type: object required: @@ -3228,7 +3228,7 @@ components: x-is-msdate: true example: /Date(322560000000+0000)/ HomeAddress: - $ref: '#/components/schemas/HomeAddress' + $ref: "#/components/schemas/HomeAddress" StartDate: description: Start date for an employee (YYYY-MM-DD) type: string @@ -3329,19 +3329,19 @@ components: BankAccounts: type: array items: - $ref: '#/components/schemas/BankAccount' + $ref: "#/components/schemas/BankAccount" PayTemplate: - $ref: '#/components/schemas/PayTemplate' + $ref: "#/components/schemas/PayTemplate" OpeningBalances: - $ref: '#/components/schemas/OpeningBalances' + $ref: "#/components/schemas/OpeningBalances" TaxDeclaration: - $ref: '#/components/schemas/TaxDeclaration' + $ref: "#/components/schemas/TaxDeclaration" IncomeType: - $ref: '#/components/schemas/IncomeType' + $ref: "#/components/schemas/IncomeType" EmploymentType: - $ref: '#/components/schemas/EmploymentType' + $ref: "#/components/schemas/EmploymentType" CountryOfResidence: - $ref: '#/components/schemas/CountryOfResidence' + $ref: "#/components/schemas/CountryOfResidence" IsSTP2Qualified: description: Indicates if the employee has been updated for STP Phase 2 compliance. Doesn't indicate that the employee is payable. type: boolean @@ -3349,17 +3349,17 @@ components: LeaveBalances: type: array items: - $ref: '#/components/schemas/LeaveBalance' + $ref: "#/components/schemas/LeaveBalance" LeaveLines: type: array items: - $ref: '#/components/schemas/LeaveLine' + $ref: "#/components/schemas/LeaveLine" SuperMemberships: type: array items: - $ref: '#/components/schemas/SuperMembership' + $ref: "#/components/schemas/SuperMembership" Status: - $ref: '#/components/schemas/EmployeeStatus' + $ref: "#/components/schemas/EmployeeStatus" UpdatedDateUTC: description: Last modified timestamp type: string @@ -3370,7 +3370,7 @@ components: description: Displays array of validation error messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" LeaveApplications: type: object x-objectArrayKey: leave_applications @@ -3378,7 +3378,7 @@ components: LeaveApplications: type: array items: - $ref: '#/components/schemas/LeaveApplication' + $ref: "#/components/schemas/LeaveApplication" LeaveApplication: type: object properties: @@ -3416,11 +3416,11 @@ components: type: string example: My leave PayOutType: - $ref: '#/components/schemas/PayOutType' + $ref: "#/components/schemas/PayOutType" LeavePeriods: type: array items: - $ref: '#/components/schemas/LeavePeriod' + $ref: "#/components/schemas/LeavePeriod" UpdatedDateUTC: description: Last modified timestamp type: string @@ -3431,7 +3431,7 @@ components: description: Displays array of validation error messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" PayOutType: description: How the requested leave will be paid out, e.g. cashed out. type: string @@ -3458,12 +3458,12 @@ components: x-is-msdate: true example: /Date(322560000000+0000)/ LeavePeriodStatus: - $ref: '#/components/schemas/LeavePeriodStatus' + $ref: "#/components/schemas/LeavePeriodStatus" LeavePeriodStatus: type: string enum: - - SCHEDULED #The default status - - PROCESSED #A LeavePeriod is set to the "Processed" status when the Payrun associated with the LeavePeriod is "POSTED" + - SCHEDULED # The default status + - PROCESSED # A LeavePeriod is set to the "Processed" status when the Payrun associated with the LeavePeriod is "POSTED" - REQUESTED - REJECTED PayItems: @@ -3471,26 +3471,26 @@ components: x-objectArrayKey: pay_items properties: PayItems: - $ref: '#/components/schemas/PayItem' + $ref: "#/components/schemas/PayItem" PayItem: type: object properties: EarningsRates: type: array items: - $ref: '#/components/schemas/EarningsRate' + $ref: "#/components/schemas/EarningsRate" DeductionTypes: type: array items: - $ref: '#/components/schemas/DeductionType' + $ref: "#/components/schemas/DeductionType" LeaveTypes: type: array items: - $ref: '#/components/schemas/LeaveType' + $ref: "#/components/schemas/LeaveType" ReimbursementTypes: type: array items: - $ref: '#/components/schemas/ReimbursementType' + $ref: "#/components/schemas/ReimbursementType" PayrollCalendars: type: object x-objectArrayKey: payroll_calendars @@ -3498,7 +3498,7 @@ components: PayrollCalendars: type: array items: - $ref: '#/components/schemas/PayrollCalendar' + $ref: "#/components/schemas/PayrollCalendar" PayrollCalendar: type: object properties: @@ -3507,7 +3507,7 @@ components: type: string example: Fortnightly Calendar CalendarType: - $ref: '#/components/schemas/CalendarType' + $ref: "#/components/schemas/CalendarType" StartDate: description: The start date of the upcoming pay period. The end date will be calculated based upon this date, and the calendar type selected (YYYY-MM-DD) type: string @@ -3538,7 +3538,7 @@ components: description: Displays array of validation error messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" Timesheets: type: object x-objectArrayKey: timesheets @@ -3546,12 +3546,12 @@ components: Timesheets: type: array items: - $ref: '#/components/schemas/Timesheet' + $ref: "#/components/schemas/Timesheet" TimesheetObject: type: object properties: Timesheet: - $ref: '#/components/schemas/Timesheet' + $ref: "#/components/schemas/Timesheet" Timesheet: type: object required: @@ -3575,7 +3575,7 @@ components: x-is-msdate: true example: /Date(322560000000+0000)/ Status: - $ref: '#/components/schemas/TimesheetStatus' + $ref: "#/components/schemas/TimesheetStatus" Hours: description: Timesheet total hours type: number @@ -3588,7 +3588,7 @@ components: format: uuid example: 049765fc-4506-48fb-bf88-3578dec0ec47 TimesheetLines: - $ref: '#/components/schemas/TimesheetLines' + $ref: "#/components/schemas/TimesheetLines" UpdatedDateUTC: description: Last modified timestamp type: string @@ -3599,11 +3599,11 @@ components: description: Displays array of validation error messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" TimesheetLines: type: array items: - $ref: '#/components/schemas/TimesheetLine' + $ref: "#/components/schemas/TimesheetLine" TimesheetLine: type: object properties: @@ -3638,7 +3638,7 @@ components: PayRuns: type: array items: - $ref: '#/components/schemas/PayRun' + $ref: "#/components/schemas/PayRun" PayRun: type: object required: @@ -3665,7 +3665,7 @@ components: x-is-msdate: true example: /Date(322560000000+0000)/ PayRunStatus: - $ref: '#/components/schemas/PayRunStatus' + $ref: "#/components/schemas/PayRunStatus" PaymentDate: description: Payment Date for the PayRun (YYYY-MM-DD) type: string @@ -3685,7 +3685,7 @@ components: description: The payslips in the payrun type: array items: - $ref: '#/components/schemas/PayslipSummary' + $ref: "#/components/schemas/PayslipSummary" Wages: description: The total Wages for the Payrun type: number @@ -3726,7 +3726,7 @@ components: description: Displays array of validation error messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" PayslipSummary: type: object properties: @@ -3800,40 +3800,40 @@ components: EarningsLines: type: array items: - $ref: '#/components/schemas/EarningsLine' + $ref: "#/components/schemas/EarningsLine" LeaveEarningsLines: type: array items: - $ref: '#/components/schemas/LeaveEarningsLine' + $ref: "#/components/schemas/LeaveEarningsLine" TimesheetEarningsLines: type: array items: - $ref: '#/components/schemas/EarningsLine' + $ref: "#/components/schemas/EarningsLine" DeductionLines: type: array items: - $ref: '#/components/schemas/DeductionLine' + $ref: "#/components/schemas/DeductionLine" LeaveAccrualLines: type: array items: - $ref: '#/components/schemas/LeaveAccrualLine' + $ref: "#/components/schemas/LeaveAccrualLine" ReimbursementLines: type: array items: - $ref: '#/components/schemas/ReimbursementLine' + $ref: "#/components/schemas/ReimbursementLine" SuperannuationLines: type: array items: - $ref: '#/components/schemas/SuperannuationLine' + $ref: "#/components/schemas/SuperannuationLine" TaxLines: type: array items: - $ref: '#/components/schemas/TaxLine' + $ref: "#/components/schemas/TaxLine" PayslipObject: type: object properties: Payslip: - $ref: '#/components/schemas/Payslip' + $ref: "#/components/schemas/Payslip" Payslips: type: object x-objectArrayKey: payslips @@ -3841,7 +3841,7 @@ components: Payslips: type: array items: - $ref: '#/components/schemas/Payslip' + $ref: "#/components/schemas/Payslip" Payslip: type: object properties: @@ -3902,35 +3902,35 @@ components: EarningsLines: type: array items: - $ref: '#/components/schemas/EarningsLine' + $ref: "#/components/schemas/EarningsLine" LeaveEarningsLines: type: array items: - $ref: '#/components/schemas/LeaveEarningsLine' + $ref: "#/components/schemas/LeaveEarningsLine" TimesheetEarningsLines: type: array items: - $ref: '#/components/schemas/EarningsLine' + $ref: "#/components/schemas/EarningsLine" DeductionLines: type: array items: - $ref: '#/components/schemas/DeductionLine' + $ref: "#/components/schemas/DeductionLine" LeaveAccrualLines: type: array items: - $ref: '#/components/schemas/LeaveAccrualLine' + $ref: "#/components/schemas/LeaveAccrualLine" ReimbursementLines: type: array items: - $ref: '#/components/schemas/ReimbursementLine' + $ref: "#/components/schemas/ReimbursementLine" SuperannuationLines: type: array items: - $ref: '#/components/schemas/SuperannuationLine' + $ref: "#/components/schemas/SuperannuationLine" TaxLines: type: array items: - $ref: '#/components/schemas/TaxLine' + $ref: "#/components/schemas/TaxLine" UpdatedDateUTC: description: Last modified timestamp type: string @@ -3964,9 +3964,9 @@ components: format: uuid example: e0eb6747-7c17-4075-b804-989f8d4e5d39 ContributionType: - $ref: '#/components/schemas/SuperannuationContributionType' + $ref: "#/components/schemas/SuperannuationContributionType" CalculationType: - $ref: '#/components/schemas/SuperannuationCalculationType' + $ref: "#/components/schemas/SuperannuationCalculationType" MinimumMonthlyEarnings: description: Superannuation minimum monthly earnings. type: number @@ -4020,7 +4020,7 @@ components: description: Description of the tax line. type: string ManualTaxType: - $ref: '#/components/schemas/ManualTaxType' + $ref: "#/components/schemas/ManualTaxType" LiabilityAccount: description: The tax line liability account code. For posted pay run you should be able to see liability account code type: string @@ -4046,12 +4046,12 @@ components: x-is-money: true example: 2.5 PayOutType: - $ref: '#/components/schemas/PayOutType' + $ref: "#/components/schemas/PayOutType" SettingsObject: type: object properties: Settings: - $ref: '#/components/schemas/Settings' + $ref: "#/components/schemas/Settings" Settings: type: object properties: @@ -4059,7 +4059,7 @@ components: description: Payroll Account details for SuperExpense, SuperLiabilty, WagesExpense, PAYGLiability & WagesPayable. type: array items: - $ref: '#/components/schemas/Account' + $ref: "#/components/schemas/Account" TrackingCategories: description: Tracking categories for Employees and Timesheets type: object @@ -4104,7 +4104,7 @@ components: SuperFunds: type: array items: - $ref: '#/components/schemas/SuperFund' + $ref: "#/components/schemas/SuperFund" SuperFund: type: object required: @@ -4116,7 +4116,7 @@ components: format: uuid example: bfac31bd-ea62-4fc8-a5e7-7965d9504b15 Type: - $ref: '#/components/schemas/SuperFundType' + $ref: "#/components/schemas/SuperFundType" Name: description: Name of the super fund type: string @@ -4163,7 +4163,7 @@ components: description: Displays array of validation error messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" SuperFundProducts: type: object x-objectArrayKey: super_fund_products @@ -4171,7 +4171,7 @@ components: SuperFundProducts: type: array items: - $ref: '#/components/schemas/SuperFundProduct' + $ref: "#/components/schemas/SuperFundProduct" SuperFundProduct: type: object properties: @@ -4200,7 +4200,7 @@ components: format: uuid example: c56b19ef-75bf-45e8-98a4-e699a96609f7 Type: - $ref: '#/components/schemas/AccountType' + $ref: "#/components/schemas/AccountType" Code: description: Customer defined account code type: string @@ -4247,14 +4247,14 @@ components: type: boolean example: false EarningsType: - $ref: '#/components/schemas/EarningsType' + $ref: "#/components/schemas/EarningsType" EarningsRateID: description: Xero identifier type: string format: uuid example: e0eb6747-7c17-4075-b804-989f8d4e5d39 RateType: - $ref: '#/components/schemas/RateType' + $ref: "#/components/schemas/RateType" RatePerUnit: description: Default rate per unit (optional). Only applicable if RateType is RATEPERUNIT. type: string @@ -4276,7 +4276,7 @@ components: x-is-money: true example: 50.30 EmploymentTerminationPaymentType: - $ref: '#/components/schemas/EmploymentTerminationPaymentType' + $ref: "#/components/schemas/EmploymentTerminationPaymentType" UpdatedDateUTC: description: Last modified timestamp type: string @@ -4288,9 +4288,9 @@ components: type: boolean example: true AllowanceType: - $ref: '#/components/schemas/AllowanceType' + $ref: "#/components/schemas/AllowanceType" AllowanceCategory: - $ref: '#/components/schemas/AllowanceCategory' + $ref: "#/components/schemas/AllowanceCategory" DeductionType: type: object properties: @@ -4382,7 +4382,7 @@ components: type: boolean example: true LeaveCategoryCode: - $ref: '#/components/schemas/LeaveCategoryCode' + $ref: "#/components/schemas/LeaveCategoryCode" SGCExempt: description: Set this to indicate that the leave type is exempt from superannuation guarantee contribution type: boolean @@ -4431,7 +4431,7 @@ components: type: string example: St. Kilda Region: - $ref: '#/components/schemas/State' + $ref: "#/components/schemas/State" PostalCode: description: PostCode for employee home address type: string @@ -4449,9 +4449,9 @@ components: format: uuid example: 123 Main St EmploymentBasis: - $ref: '#/components/schemas/EmploymentBasis' + $ref: "#/components/schemas/EmploymentBasis" TFNExemptionType: - $ref: '#/components/schemas/TFNExemptionType' + $ref: "#/components/schemas/TFNExemptionType" TaxFileNumber: description: The tax file number e.g 123123123. type: string @@ -4465,13 +4465,13 @@ components: type: boolean example: true ResidencyStatus: - $ref: '#/components/schemas/ResidencyStatus' + $ref: "#/components/schemas/ResidencyStatus" TaxScaleType: - $ref: '#/components/schemas/TaxScaleType' + $ref: "#/components/schemas/TaxScaleType" WorkCondition: - $ref: '#/components/schemas/WorkCondition' + $ref: "#/components/schemas/WorkCondition" SeniorMaritalStatus: - $ref: '#/components/schemas/SeniorMaritalStatus' + $ref: "#/components/schemas/SeniorMaritalStatus" TaxFreeThresholdClaimed: description: If tax free threshold claimed. e.g true or false type: boolean @@ -4512,7 +4512,7 @@ components: type: boolean example: true HasLoanOrStudentDebt: - description: 'If the employee has any of the following loans or debts: Higher Education Loan Program (HELP/HECS), VET Student Loan (VSL), Financial Supplement (FS), Student Start-up Loan (SSL), or Trade Support Loan (TSL)' + description: "If the employee has any of the following loans or debts: Higher Education Loan Program (HELP/HECS), VET Student Loan (VSL), Financial Supplement (FS), Student Start-up Loan (SSL), or Trade Support Loan (TSL)" type: boolean example: true UpdatedDateUTC: @@ -4557,23 +4557,23 @@ components: EarningsLines: type: array items: - $ref: '#/components/schemas/EarningsLine' + $ref: "#/components/schemas/EarningsLine" DeductionLines: type: array items: - $ref: '#/components/schemas/DeductionLine' + $ref: "#/components/schemas/DeductionLine" SuperLines: type: array items: - $ref: '#/components/schemas/SuperLine' + $ref: "#/components/schemas/SuperLine" ReimbursementLines: type: array items: - $ref: '#/components/schemas/ReimbursementLine' + $ref: "#/components/schemas/ReimbursementLine" LeaveLines: type: array items: - $ref: '#/components/schemas/LeaveLine' + $ref: "#/components/schemas/LeaveLine" EarningsLine: type: object required: @@ -4585,7 +4585,7 @@ components: format: uuid example: 72e962d1-fcac-4083-8a71-742bb3e7ae14 CalculationType: - $ref: '#/components/schemas/EarningsRateCalculationType' + $ref: "#/components/schemas/EarningsRateCalculationType" AnnualSalary: description: Annual salary for earnings line type: number @@ -4639,7 +4639,7 @@ components: format: uuid example: 59cd9d04-4521-4cc3-93ac-7841651ff407 CalculationType: - $ref: '#/components/schemas/DeductionTypeCalculationType' + $ref: "#/components/schemas/DeductionTypeCalculationType" Amount: description: Deduction type amount type: number @@ -4667,9 +4667,9 @@ components: format: uuid example: 4333d5cd-53a5-4c31-98e5-a8b4e5676b0b ContributionType: - $ref: '#/components/schemas/SuperannuationContributionType' + $ref: "#/components/schemas/SuperannuationContributionType" CalculationType: - $ref: '#/components/schemas/SuperannuationCalculationType' + $ref: "#/components/schemas/SuperannuationCalculationType" MinimumMonthlyEarnings: description: amount of minimum earnings type: number @@ -4704,7 +4704,7 @@ components: ReimbursementLines: type: array items: - $ref: '#/components/schemas/ReimbursementLine' + $ref: "#/components/schemas/ReimbursementLine" ReimbursementLine: type: object properties: @@ -4736,7 +4736,7 @@ components: Employee: type: array items: - $ref: '#/components/schemas/LeaveLine' + $ref: "#/components/schemas/LeaveLine" LeaveLine: type: object properties: @@ -4746,11 +4746,11 @@ components: format: uuid example: 742998cb-7584-4ecf-aa88-d694f59c50f9 CalculationType: - $ref: '#/components/schemas/LeaveLineCalculationType' + $ref: "#/components/schemas/LeaveLineCalculationType" EntitlementFinalPayPayoutType: - $ref: '#/components/schemas/EntitlementFinalPayPayoutType' + $ref: "#/components/schemas/EntitlementFinalPayPayoutType" EmploymentTerminationPaymentType: - $ref: '#/components/schemas/EmploymentTerminationPaymentType' + $ref: "#/components/schemas/EmploymentTerminationPaymentType" IncludeSuperannuationGuaranteeContribution: description: amount of leave line type: boolean @@ -4821,27 +4821,27 @@ components: EarningsLines: type: array items: - $ref: '#/components/schemas/EarningsLine' + $ref: "#/components/schemas/EarningsLine" DeductionLines: type: array items: - $ref: '#/components/schemas/DeductionLine' + $ref: "#/components/schemas/DeductionLine" SuperLines: type: array items: - $ref: '#/components/schemas/SuperLine' + $ref: "#/components/schemas/SuperLine" ReimbursementLines: type: array items: - $ref: '#/components/schemas/ReimbursementLine' + $ref: "#/components/schemas/ReimbursementLine" LeaveLines: type: array items: - $ref: '#/components/schemas/LeaveLine' + $ref: "#/components/schemas/LeaveLine" PaidLeaveEarningsLines: type: array items: - $ref: '#/components/schemas/PaidLeaveEarningsLine' + $ref: "#/components/schemas/PaidLeaveEarningsLine" LeaveBalance: type: object properties: @@ -4884,8 +4884,8 @@ components: type: string enum: - FIXEDAMOUNT - - MULTIPLE #Multiple of Employee’s Ordinary Earnings Rate - an earnings rate which is derived from an employee’s ordinary earnings rate - - RATEPERUNIT #An earnings rate allowing entry of a rate per unit + - MULTIPLE # Multiple of Employee’s Ordinary Earnings Rate - an earnings rate which is derived from an employee’s ordinary earnings rate + - RATEPERUNIT # An earnings rate allowing entry of a rate per unit EarningsType: type: string enum: @@ -5336,8 +5336,8 @@ components: type: string description: Employee Status Types enum: - - ACTIVE #Employee with no Termination Date. - - TERMINATED #Employee with a Termination Date. + - ACTIVE # Employee with no Termination Date. + - TERMINATED # Employee with a Termination Date. State: type: string description: State abbreviation for employee home address diff --git a/xero-payroll-nz.yaml b/xero-payroll-nz.yaml index 6e05a52a..5134f1e4 100644 --- a/xero-payroll-nz.yaml +++ b/xero-payroll-nz.yaml @@ -1,9 +1,9 @@ openapi: 3.0.0 info: version: 9.2.0 - title: Xero Payroll NZ - description: This is the Xero Payroll API for orgs in the NZ region. - termsOfService: https://developer.xero.com/xero-developer-platform-terms-conditions/ + title: "Xero Payroll NZ" + description: "This is the Xero Payroll API for orgs in the NZ region." + termsOfService: "https://developer.xero.com/xero-developer-platform-terms-conditions/" contact: name: Xero Platform Team email: api@xero.com @@ -16,7 +16,7 @@ servers: paths: /Employees: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -46,7 +46,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Employees' + $ref: "#/components/schemas/Employees" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -106,7 +106,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" post: security: - OAuth2: @@ -128,9 +128,9 @@ paths: java: LocalDate.of(2000, Month.OCTOBER, 28) csharp: new DateTime(2000, 10, 10) php: new DateTime('2000-10-28') - node: '''2000-10-28''' + node: "'2000-10-28'" python: dateutil.parser.parse('2000-10-28T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - Address: key: address keyPascal: Address @@ -199,14 +199,14 @@ paths: object: employee summary: Creates an employees parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: search results matching criteria content: application/json: schema: - $ref: '#/components/schemas/EmployeeObject' + $ref: "#/components/schemas/EmployeeObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -241,13 +241,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/Employee' + $ref: "#/components/schemas/Employee" example: title: Mr firstName: Mike @@ -262,7 +262,7 @@ paths: gender: M /Employees/{EmployeeID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -289,7 +289,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeObject' + $ref: "#/components/schemas/EmployeeObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -340,9 +340,9 @@ paths: java: LocalDate.of(2000, Month.OCTOBER, 28) csharp: new DateTime(2000, 10, 10) php: new DateTime('2000-10-28') - node: '''2000-10-28''' + node: "'2000-10-28'" python: dateutil.parser.parse('2000-10-28T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - Address: key: address keyPascal: Address @@ -411,7 +411,7 @@ paths: object: employee summary: Updates an existing employee parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: EmployeeID x-snake: employee_id in: path @@ -427,7 +427,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeObject' + $ref: "#/components/schemas/EmployeeObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -462,13 +462,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/Employee' + $ref: "#/components/schemas/Employee" example: title: Mr firstName: Tony @@ -483,7 +483,7 @@ paths: gender: M /Employees/{EmployeeID}/Employment: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" post: security: - OAuth2: @@ -504,9 +504,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 28) csharp: new DateTime(2020, 10, 10) php: new DateTime('2020-10-28') - node: '''2020-10-28''' + node: "'2020-10-28'" python: dateutil.parser.parse('2020-10-28T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - employment: key: employment keyPascal: Employment @@ -545,7 +545,7 @@ paths: is_last: true summary: Creates an employment detail for a specific employee parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: EmployeeID x-snake: employee_id in: path @@ -561,7 +561,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmploymentObject' + $ref: "#/components/schemas/EmploymentObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -579,13 +579,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/Employment' + $ref: "#/components/schemas/Employment" example: payrollCalendarID: 9aa56064-990f-4ad3-a189-d966d8f6a030 startDate: "2020-09-02" @@ -593,7 +593,7 @@ paths: fixedTermEndDate: "2026-01-01" /Employees/{EmployeeID}/Tax: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -620,7 +620,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeTaxObject' + $ref: "#/components/schemas/EmployeeTaxObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -665,9 +665,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 30) csharp: new DateTime(2020, 10, 12) php: new DateTime('2020-10-30') - node: '''2020-10-30''' + node: "'2020-10-30'" python: dateutil.parser.parse('2020-10-30T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - employeeTax: key: employeeTax keyPascal: EmployeeTax @@ -777,7 +777,7 @@ paths: is_last: true summary: Updates the tax records for a specific employee parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: EmployeeID x-snake: employee_id in: path @@ -793,7 +793,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeTaxObject' + $ref: "#/components/schemas/EmployeeTaxObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -823,7 +823,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeTax' + $ref: "#/components/schemas/EmployeeTax" example: irdNumber: "111111111" taxCode: M @@ -843,7 +843,7 @@ paths: studentLoanAsAt: null /Employees/{EmployeeID}/OpeningBalances: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -870,7 +870,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeOpeningBalancesObject' + $ref: "#/components/schemas/EmployeeOpeningBalancesObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -908,9 +908,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 30) csharp: new DateTime(2020, 10, 12) php: new DateTime('2020-10-30') - node: '''2020-10-30''' + node: "'2020-10-30'" python: dateutil.parser.parse('2020-10-30T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - employeeOpeningBalance: key: employeeOpeningBalance keyPascal: EmployeeOpeningBalance @@ -968,7 +968,7 @@ paths: csharp: EmployeeOpeningBalance object: employeeOpeningBalance parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: EmployeeID x-snake: employee_id in: path @@ -984,7 +984,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeOpeningBalancesObject' + $ref: "#/components/schemas/EmployeeOpeningBalancesObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -1002,17 +1002,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/EmployeeOpeningBalances' + $ref: "#/components/schemas/EmployeeOpeningBalances" example: '[{"periodEndDate":"2020-10-01","daysPaid":3,"unpaidWeeks":2,"grossEarnings":40.0}]' /Employees/{EmployeeID}/Leave: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -1039,7 +1039,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeLeaves' + $ref: "#/components/schemas/EmployeeLeaves" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -1082,9 +1082,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 28) csharp: new DateTime(2020, 10, 10) php: new DateTime('2020-10-28') - node: '''2020-10-28''' + node: "'2020-10-28'" python: dateutil.parser.parse('2020-10-28T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - endDateValue: key: endDate keyPascal: EndDate @@ -1096,9 +1096,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 30) csharp: new DateTime(2020, 10, 12) php: new DateTime('2020-10-30') - node: '''2020-10-30''' + node: "'2020-10-30'" python: dateutil.parser.parse('2020-10-30T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - employeeLeave: key: employeeLeave keyPascal: EmployeeLeave @@ -1154,7 +1154,7 @@ paths: object: employeeLeave summary: Creates leave records for a specific employee parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: EmployeeID x-snake: employee_id in: path @@ -1170,7 +1170,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeLeaveObject' + $ref: "#/components/schemas/EmployeeLeaveObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -1198,13 +1198,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/EmployeeLeave' + $ref: "#/components/schemas/EmployeeLeave" example: leaveTypeID: b0b1b79e-2a25-46c2-ad08-ca25ef48d7e4 description: Creating a Description @@ -1212,7 +1212,7 @@ paths: endDate: "2020-04-26" /Employees/{EmployeeID}/Leave/{LeaveID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" put: security: - OAuth2: @@ -1233,9 +1233,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 28) csharp: new DateTime(2020, 10, 10) php: new DateTime('2020-10-28') - node: '''2020-10-28''' + node: "'2020-10-28'" python: dateutil.parser.parse('2020-10-28T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - endDateValue: key: endDate keyPascal: EndDate @@ -1247,9 +1247,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 30) csharp: new DateTime(2020, 10, 12) php: new DateTime('2020-10-30') - node: '''2020-10-30''' + node: "'2020-10-30'" python: dateutil.parser.parse('2020-10-30T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - employeeLeave: key: employeeLeave keyPascal: EmployeeLeave @@ -1285,7 +1285,7 @@ paths: object: employeeLeave summary: Updates leave records for a specific employee parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: EmployeeID x-snake: employee_id in: path @@ -1310,7 +1310,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeLeaveObject' + $ref: "#/components/schemas/EmployeeLeaveObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -1335,13 +1335,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/EmployeeLeave' + $ref: "#/components/schemas/EmployeeLeave" example: leaveTypeID: b0b1b79e-2a25-46c2-ad08-ca25ef48d7e4 description: Creating a Description @@ -1386,7 +1386,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeLeaveObject' + $ref: "#/components/schemas/EmployeeLeaveObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -1396,7 +1396,7 @@ paths: problem: null /Employees/{EmployeeID}/LeaveBalances: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -1423,7 +1423,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeLeaveBalances' + $ref: "#/components/schemas/EmployeeLeaveBalances" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -1454,7 +1454,7 @@ paths: typeOfUnits: Hours /Employees/{EmployeeID}/LeavePeriods: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -1496,7 +1496,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LeavePeriods' + $ref: "#/components/schemas/LeavePeriods" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -1524,10 +1524,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" /Employees/{EmployeeID}/LeaveSetup: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" post: security: - OAuth2: @@ -1630,7 +1630,7 @@ paths: is_last: true summary: Creates a leave set-up for a specific employee. This is required before viewing, configuring and requesting leave for an employee parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: EmployeeID x-snake: employee_id in: path @@ -1646,7 +1646,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeLeaveSetupObject' + $ref: "#/components/schemas/EmployeeLeaveSetupObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -1672,13 +1672,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/EmployeeLeaveSetup' + $ref: "#/components/schemas/EmployeeLeaveSetup" example: holidayPayOpeningBalance: 10 annualLeaveOpeningBalance: 100 @@ -1690,7 +1690,7 @@ paths: annualLeaveAnniversaryDate: "2023-12-31" /Employees/{EmployeeID}/LeaveTypes: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -1717,7 +1717,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeLeaveTypes' + $ref: "#/components/schemas/EmployeeLeaveTypes" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -1745,7 +1745,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" post: security: - OAuth2: @@ -1798,7 +1798,7 @@ paths: object: employeeLeaveType is_last: true parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: EmployeeID x-snake: employee_id in: path @@ -1814,7 +1814,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeLeaveTypeObject' + $ref: "#/components/schemas/EmployeeLeaveTypeObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -1842,13 +1842,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/EmployeeLeaveType' + $ref: "#/components/schemas/EmployeeLeaveType" example: leaveTypeID: 35da97ae-05b9-427f-9a98-69157ba42cec scheduleOfAccrual: AnnuallyAfter6Months @@ -1861,7 +1861,7 @@ paths: rateAccruedHourly: 3.5 /Employees/{EmployeeID}/PaymentMethods: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -1888,7 +1888,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PaymentMethodObject' + $ref: "#/components/schemas/PaymentMethodObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -1911,7 +1911,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" post: security: - OAuth2: @@ -1980,7 +1980,7 @@ paths: object: paymentMethod summary: Creates a payment method for an employee parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: EmployeeID x-snake: employee_id in: path @@ -1996,7 +1996,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PaymentMethodObject' + $ref: "#/components/schemas/PaymentMethodObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -2019,13 +2019,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/PaymentMethod' + $ref: "#/components/schemas/PaymentMethod" example: bankAccounts: - accountName: Casual Worker @@ -2038,7 +2038,7 @@ paths: calculationType: Balance /Employees/{EmployeeID}/PayTemplates: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -2065,7 +2065,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeePayTemplates' + $ref: "#/components/schemas/EmployeePayTemplates" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -2091,10 +2091,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" /Employees/{EmployeeID}/PayTemplates/Earnings: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" post: security: - OAuth2: @@ -2173,7 +2173,7 @@ paths: object: earningsTemplate summary: Creates earnings template records for an employee parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: EmployeeID x-snake: employee_id in: path @@ -2189,7 +2189,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EarningsTemplateObject' + $ref: "#/components/schemas/EarningsTemplateObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -2209,13 +2209,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/EarningsTemplate' + $ref: "#/components/schemas/EarningsTemplate" example: ratePerUnit: 20 numberOfUnits: 8 @@ -2223,7 +2223,7 @@ paths: name: My New One /Employees/{EmployeeID}/PayTemplates/Earnings/{PayTemplateEarningID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" put: security: - OAuth2: @@ -2302,7 +2302,7 @@ paths: object: earningsTemplate summary: Updates an earnings template records for an employee parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: EmployeeID x-snake: employee_id in: path @@ -2327,7 +2327,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EarningsTemplateObject' + $ref: "#/components/schemas/EarningsTemplateObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -2347,13 +2347,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/EarningsTemplate' + $ref: "#/components/schemas/EarningsTemplate" example: ratePerUnit: 25 numberOfUnits: 4 @@ -2391,7 +2391,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EarningsTemplateObject' + $ref: "#/components/schemas/EarningsTemplateObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -2401,7 +2401,7 @@ paths: problem: null /Employees/{EmployeeID}/PayTemplateEarnings: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" post: security: - OAuth2: @@ -2480,7 +2480,7 @@ paths: object: earningsTemplate summary: Creates multiple employee earnings template records for a specific employee parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: EmployeeID x-snake: employee_id in: path @@ -2496,7 +2496,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeEarningsTemplates' + $ref: "#/components/schemas/EmployeeEarningsTemplates" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -2522,17 +2522,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/EarningsTemplates' + $ref: "#/components/schemas/EarningsTemplates" example: '[{"ratePerUnit":20.0,"numberOfUnits":8.0,"earningsRateID":"f9d8f5b5-9049-47f4-8541-35e200f750a5"},{"ratePerUnit":0.0,"numberOfUnits":8.0,"earningsRateID":"65b83d94-f20f-45e1-85ae-387fcf460c26"}]' /Deductions: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -2555,7 +2555,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Deductions' + $ref: "#/components/schemas/Deductions" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -2623,14 +2623,14 @@ paths: is_last: true summary: Creates a new deduction for a specific employee parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: search results matching criteria content: application/json: schema: - $ref: '#/components/schemas/DeductionObject' + $ref: "#/components/schemas/DeductionObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -2650,20 +2650,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/Deduction' + $ref: "#/components/schemas/Deduction" example: deductionName: My new deduction deductionCategory: NzOther liabilityAccountId: 568f2e9a-0870-46cc-8678-f83f132ed4e3 /Deductions/{deductionId}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -2689,7 +2689,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DeductionObject' + $ref: "#/components/schemas/DeductionObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -2706,7 +2706,7 @@ paths: standardAmount: null /StatutoryDeductions: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -2728,7 +2728,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/StatutoryDeductions' + $ref: "#/components/schemas/StatutoryDeductions" example: id: e3731829-9801-4809-a1a1-bbe40cd18b7e providerName: provider-name @@ -2753,7 +2753,7 @@ paths: currentRecord: true /StatutoryDeductions/{id}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -2777,7 +2777,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/StatutoryDeductionObject' + $ref: "#/components/schemas/StatutoryDeductionObject" example: id: e3731829-9801-4809-a1a1-bbe40cd18b7e providerName: provider-name @@ -2793,7 +2793,7 @@ paths: currentRecord: true /Superannuations: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -2815,7 +2815,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Superannuations' + $ref: "#/components/schemas/Superannuations" example: id: 563273ea-0dae-4f82-86a4-e0db77c008ea providerName: provider-name @@ -2919,14 +2919,14 @@ paths: is_last: true summary: Creates a new superannuation parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: search results matching criteria content: application/json: schema: - $ref: '#/components/schemas/SuperannuationObject' + $ref: "#/components/schemas/SuperannuationObject" example: id: 8905a754-7ce8-40e2-9fa5-f819deb7adce providerName: provider-name @@ -2950,13 +2950,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/Benefit' + $ref: "#/components/schemas/Benefit" example: name: SidSaver category: Other @@ -2966,7 +2966,7 @@ paths: standardAmount: 10 /Superannuations/{SuperannuationID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -2991,7 +2991,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SuperannuationObject' + $ref: "#/components/schemas/SuperannuationObject" example: id: 563273ea-0dae-4f82-86a4-e0db77c008ea providerName: provider-name @@ -3012,7 +3012,7 @@ paths: companyMax: null /EarningsRates: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -3035,7 +3035,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EarningsRates' + $ref: "#/components/schemas/EarningsRates" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -3128,14 +3128,14 @@ paths: is_last: true summary: Creates a new earnings rate parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: search results matching criteria content: application/json: schema: - $ref: '#/components/schemas/EarningsRateObject' + $ref: "#/components/schemas/EarningsRateObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -3159,13 +3159,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/EarningsRate' + $ref: "#/components/schemas/EarningsRate" example: name: My Earnings Rate earningsType: RegularEarnings @@ -3174,7 +3174,7 @@ paths: expenseAccountID: e4eb36f6-97e3-4427-a394-dd4e1b355c2e /EarningsRates/{EarningsRateID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -3200,7 +3200,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EarningsRateObject' + $ref: "#/components/schemas/EarningsRateObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -3221,7 +3221,7 @@ paths: multipleOfOrdinaryEarningsRate: null /LeaveTypes: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -3252,7 +3252,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LeaveTypes' + $ref: "#/components/schemas/LeaveTypes" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -3318,14 +3318,14 @@ paths: is_last: true summary: Creates a new leave type parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: search results matching criteria content: application/json: schema: - $ref: '#/components/schemas/LeaveTypeObject' + $ref: "#/components/schemas/LeaveTypeObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -3347,20 +3347,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/LeaveType' + $ref: "#/components/schemas/LeaveType" example: name: My wqwhhiktun Leave isPaidLeave: false showOnPayslip: true /LeaveTypes/{LeaveTypeID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -3386,7 +3386,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LeaveTypeObject' + $ref: "#/components/schemas/LeaveTypeObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -3405,7 +3405,7 @@ paths: typeOfUnitsToAccrue: Days /Reimbursements: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -3428,7 +3428,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Reimbursements' + $ref: "#/components/schemas/Reimbursements" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -3507,14 +3507,14 @@ paths: is_last: true summary: Creates a new reimbursement parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: search results matching criteria content: application/json: schema: - $ref: '#/components/schemas/ReimbursementObject' + $ref: "#/components/schemas/ReimbursementObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -3537,13 +3537,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/Reimbursement' + $ref: "#/components/schemas/Reimbursement" example: name: My new Reimburse accountID: fa5cdc43-643b-4ad8-b4ac-3ffe0d0f4488 @@ -3551,7 +3551,7 @@ paths: calculationType: FixedAmount /Reimbursements/{ReimbursementID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -3577,7 +3577,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ReimbursementObject' + $ref: "#/components/schemas/ReimbursementObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -3597,7 +3597,7 @@ paths: calculationType: null /Timesheets: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -3653,7 +3653,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Timesheets' + $ref: "#/components/schemas/Timesheets" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -3694,9 +3694,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 28) csharp: new DateTime(2020, 10, 10) php: new DateTime('2020-10-28') - node: '''2020-10-28''' + node: "'2020-10-28'" python: dateutil.parser.parse('2020-10-28T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - endDateValue: key: endDate keyPascal: EndDate @@ -3708,9 +3708,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 30) csharp: new DateTime(2020, 10, 12) php: new DateTime('2020-10-30') - node: '''2020-10-30''' + node: "'2020-10-30'" python: dateutil.parser.parse('2020-10-30T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - timesheet: key: timesheet keyPascal: Timesheet @@ -3751,14 +3751,14 @@ paths: object: timesheet summary: Creates a new timesheet parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: search results matching criteria content: application/json: schema: - $ref: '#/components/schemas/TimesheetObject' + $ref: "#/components/schemas/TimesheetObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -3791,13 +3791,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/Timesheet' + $ref: "#/components/schemas/Timesheet" example: payrollCalendarID: 9aa56064-990f-4ad3-a189-d966d8f6a030 employeeID: 68342973-c405-4b86-b5d3-d7b877c27995 @@ -3812,7 +3812,7 @@ paths: numberOfUnits: 6 /Timesheets/{TimesheetID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -3838,7 +3838,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TimesheetObject' + $ref: "#/components/schemas/TimesheetObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -3894,7 +3894,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TimesheetLine' + $ref: "#/components/schemas/TimesheetLine" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -3907,10 +3907,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" /Timesheets/{TimesheetID}/Lines: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" post: security: - OAuth2: @@ -3931,9 +3931,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 28) csharp: new DateTime(2020, 10, 10) php: new DateTime('2020-10-28') - node: '''2020-10-28''' + node: "'2020-10-28'" python: dateutil.parser.parse('2020-10-28T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - timesheetLine: key: timesheetLine keyPascal: TimesheetLine @@ -3980,7 +3980,7 @@ paths: is_last: true summary: Create a new timesheet line for a specific time sheet parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - in: path name: TimesheetID x-snake: timesheet_id @@ -3995,7 +3995,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TimesheetLineObject' + $ref: "#/components/schemas/TimesheetLineObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -4014,20 +4014,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/TimesheetLine' + $ref: "#/components/schemas/TimesheetLine" example: date: "2020-08-03" earningsRateID: f9d8f5b5-9049-47f4-8541-35e200f750a5 numberOfUnits: 1 /Timesheets/{TimesheetID}/Approve: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" post: security: - OAuth2: @@ -4038,7 +4038,7 @@ paths: x-hasPayrollUkProblem: true summary: Approves a timesheet parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - in: path name: TimesheetID x-snake: timesheet_id @@ -4053,7 +4053,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TimesheetObject' + $ref: "#/components/schemas/TimesheetObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -4096,10 +4096,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" /Timesheets/{TimesheetID}/RevertToDraft: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" post: security: - OAuth2: @@ -4110,7 +4110,7 @@ paths: x-hasPayrollUkProblem: true summary: Reverts a timesheet to draft parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - in: path name: TimesheetID x-snake: timesheet_id @@ -4125,7 +4125,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TimesheetObject' + $ref: "#/components/schemas/TimesheetObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -4168,10 +4168,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" /Timesheets/{TimesheetID}/Lines/{TimesheetLineID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" put: security: - OAuth2: @@ -4193,9 +4193,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 28) csharp: new DateTime(2020, 10, 10) php: new DateTime('2020-10-28') - node: '''2020-10-28''' + node: "'2020-10-28'" python: dateutil.parser.parse('2020-10-28T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - timesheetLine: key: timesheetLine keyPascal: TimesheetLine @@ -4241,7 +4241,7 @@ paths: nonString: true is_last: true parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - in: path name: TimesheetID x-snake: timesheet_id @@ -4264,7 +4264,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TimesheetLineObject' + $ref: "#/components/schemas/TimesheetLineObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -4283,13 +4283,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/TimesheetLine' + $ref: "#/components/schemas/TimesheetLine" example: date: "2020-08-04" earningsRateID: f9d8f5b5-9049-47f4-8541-35e200f750a5 @@ -4325,7 +4325,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TimesheetLine' + $ref: "#/components/schemas/TimesheetLine" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -4338,10 +4338,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" /PayRunCalendars: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -4364,7 +4364,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PayRunCalendars' + $ref: "#/components/schemas/PayRunCalendars" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -4411,9 +4411,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 28) csharp: new DateTime(2020, 10, 10) php: new DateTime('2020-10-28') - node: '''2020-10-28''' + node: "'2020-10-28'" python: dateutil.parser.parse('2020-10-28T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - paymentDateValue: key: paymentDate keyPascal: PaymentDate @@ -4425,9 +4425,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 30) csharp: new DateTime(2020, 10, 12) php: new DateTime('2020-10-30') - node: '''2020-10-30''' + node: "'2020-10-30'" python: dateutil.parser.parse('2020-10-30T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - payRunCalendar: key: payRunCalendar keyPascal: PayRunCalendar @@ -4469,14 +4469,14 @@ paths: object: payRunCalendar summary: Creates a new payrun calendar parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: search results matching criteria content: application/json: schema: - $ref: '#/components/schemas/PayRunCalendarObject' + $ref: "#/components/schemas/PayRunCalendarObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -4497,13 +4497,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/PayRunCalendar' + $ref: "#/components/schemas/PayRunCalendar" example: name: My Weekly Cal calendarType: Weekly @@ -4511,7 +4511,7 @@ paths: paymentDate: "2020-05-15" /PayRunCalendars/{PayrollCalendarID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -4537,7 +4537,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PayRunCalendarObject' + $ref: "#/components/schemas/PayRunCalendarObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -4555,7 +4555,7 @@ paths: updatedDateUTC: 2019-09-24T05:08:45 /Employees/{EmployeeID}/SalaryAndWages: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -4587,7 +4587,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SalaryAndWages' + $ref: "#/components/schemas/SalaryAndWages" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -4627,7 +4627,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" post: security: - OAuth2: @@ -4679,7 +4679,7 @@ paths: is_last: true summary: Creates an employee salary and wage record parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: EmployeeID x-snake: employee_id in: path @@ -4695,7 +4695,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SalaryAndWageObject' + $ref: "#/components/schemas/SalaryAndWageObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -4720,13 +4720,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/SalaryAndWage' + $ref: "#/components/schemas/SalaryAndWage" example: earningsRateID: f9d8f5b5-9049-47f4-8541-35e200f750a5 numberOfUnitsPerWeek: 2 @@ -4739,7 +4739,7 @@ paths: paymentType: Salary /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -4775,7 +4775,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SalaryAndWages' + $ref: "#/components/schemas/SalaryAndWages" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -4846,7 +4846,7 @@ paths: is_last: true summary: Updates an employee's salary and wages record parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: EmployeeID x-snake: employee_id in: path @@ -4871,7 +4871,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SalaryAndWageObject' + $ref: "#/components/schemas/SalaryAndWageObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -4896,13 +4896,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/SalaryAndWage' + $ref: "#/components/schemas/SalaryAndWage" example: earningsRateID: f9d8f5b5-9049-47f4-8541-35e200f750a5 numberOfUnitsPerWeek: 3 @@ -4946,7 +4946,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SalaryAndWageObject' + $ref: "#/components/schemas/SalaryAndWageObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -4956,7 +4956,7 @@ paths: problem: null /PayRuns: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -4987,7 +4987,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PayRuns' + $ref: "#/components/schemas/PayRuns" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -5049,14 +5049,14 @@ paths: is_last: true summary: Creates a pay run parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: created payrun results content: application/json: schema: - $ref: '#/components/schemas/PayRunObject' + $ref: "#/components/schemas/PayRunObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -5116,13 +5116,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/PayRun' + $ref: "#/components/schemas/PayRun" example: payrollCalendarID: 9aa56064-990f-4ad3-a189-d966d8f6a030 periodStartDate: "2020-09-08" @@ -5133,7 +5133,7 @@ paths: calendarType: Weekly /PayRuns/{PayRunID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -5159,7 +5159,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PayRunObject' + $ref: "#/components/schemas/PayRunObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -5200,7 +5200,7 @@ paths: invalidPayeeIDs: null /PaySlips: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -5231,7 +5231,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PaySlips' + $ref: "#/components/schemas/PaySlips" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -5337,7 +5337,7 @@ paths: unpaidWeeks: 0 /PaySlips/{PaySlipID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -5363,7 +5363,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PaySlipObject' + $ref: "#/components/schemas/PaySlipObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -5557,7 +5557,7 @@ paths: object: paySlip summary: Creates an employee pay slip parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - in: path name: PaySlipID x-snake: pay_slip_id @@ -5572,7 +5572,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PaySlipObject' + $ref: "#/components/schemas/PaySlipObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -5697,13 +5697,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/PaySlip' + $ref: "#/components/schemas/PaySlip" example: earningsLines: - earningsLineID: f9d8f5b5-9049-47f4-8541-35e200f750a5 @@ -5767,7 +5767,7 @@ paths: unpaidWeeks: 0 /Settings: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -5784,7 +5784,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Settings' + $ref: "#/components/schemas/Settings" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -5812,7 +5812,7 @@ paths: name: Business Bank Account /Settings/TrackingCategories: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -5829,7 +5829,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TrackingCategories' + $ref: "#/components/schemas/TrackingCategories" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -5842,7 +5842,7 @@ paths: timesheetTrackingCategoryID: f8c0b291-be04-497a-a083-dd9cd19658b5 /Employees/{EmployeeID}/Working-Patterns: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -5869,7 +5869,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeWorkingPatternsObject' + $ref: "#/components/schemas/EmployeeWorkingPatternsObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -5906,9 +5906,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 28) csharp: new DateTime(2020, 10, 10) php: new DateTime('2020-10-28') - node: '''2020-10-28''' + node: "'2020-10-28'" python: dateutil.parser.parse('2020-10-28T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - workingWeek: key: workingWeek keyPascal: WorkingWeek @@ -5966,7 +5966,7 @@ paths: is_last: true summary: Creates an employee working pattern parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: EmployeeID x-snake: employee_id in: path @@ -5982,7 +5982,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeWorkingPatternWithWorkingWeeksObject' + $ref: "#/components/schemas/EmployeeWorkingPatternWithWorkingWeeksObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -6006,13 +6006,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/EmployeeWorkingPatternWithWorkingWeeksRequest' + $ref: "#/components/schemas/EmployeeWorkingPatternWithWorkingWeeksRequest" example: effectiveFrom: 2020-01-01T00:00:00 workingWeeks: @@ -6025,7 +6025,7 @@ paths: sunday: 0.0 /Employees/{EmployeeID}/Working-Patterns/{EmployeeWorkingPatternID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -6061,7 +6061,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeWorkingPatternWithWorkingWeeksObject' + $ref: "#/components/schemas/EmployeeWorkingPatternWithWorkingWeeksObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -6114,7 +6114,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeLeaveObject' + $ref: "#/components/schemas/EmployeeLeaveObject" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -6127,7 +6127,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" components: securitySchemes: OAuth2: @@ -6205,7 +6205,7 @@ components: invalidFields: type: array items: - $ref: '#/components/schemas/InvalidField' + $ref: "#/components/schemas/InvalidField" InvalidField: type: object properties: @@ -6221,22 +6221,22 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" employees: type: array items: - $ref: '#/components/schemas/Employee' + $ref: "#/components/schemas/Employee" EmployeeObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" employee: - $ref: '#/components/schemas/Employee' + $ref: "#/components/schemas/Employee" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" Employee: type: object required: @@ -6269,7 +6269,7 @@ components: example: 2019-01-02 x-is-date: true address: - $ref: '#/components/schemas/Address' + $ref: "#/components/schemas/Address" email: description: The email address for the employee type: string @@ -6329,11 +6329,11 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" employment: - $ref: '#/components/schemas/Employment' + $ref: "#/components/schemas/Employment" Employment: type: object required: @@ -6368,11 +6368,11 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" employeeTax: - $ref: '#/components/schemas/EmployeeTax' + $ref: "#/components/schemas/EmployeeTax" EmployeeTax: type: object properties: @@ -6381,7 +6381,7 @@ components: type: string example: 111111111 taxCode: - $ref: '#/components/schemas/TaxCode' + $ref: "#/components/schemas/TaxCode" specialTaxRatePercentage: description: Special tax rate percentage. type: number @@ -6491,17 +6491,17 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" openingBalances: type: array items: - $ref: '#/components/schemas/EmployeeOpeningBalance' + $ref: "#/components/schemas/EmployeeOpeningBalance" EmployeeOpeningBalances: type: array items: - $ref: '#/components/schemas/EmployeeOpeningBalance' + $ref: "#/components/schemas/EmployeeOpeningBalance" EmployeeOpeningBalance: type: object properties: @@ -6528,22 +6528,22 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" leave: type: array items: - $ref: '#/components/schemas/EmployeeLeave' + $ref: "#/components/schemas/EmployeeLeave" EmployeeLeaveObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" leave: - $ref: '#/components/schemas/EmployeeLeave' + $ref: "#/components/schemas/EmployeeLeave" EmployeeLeave: type: object required: @@ -6577,7 +6577,7 @@ components: description: The leave period information. The StartDate, EndDate and NumberOfUnits needs to be specified when you do not want to calculate NumberOfUnits automatically. Using incorrect period StartDate and EndDate will result in automatic computation of the NumberOfUnits. type: array items: - $ref: '#/components/schemas/LeavePeriod' + $ref: "#/components/schemas/LeavePeriod" updatedDateUTC: description: UTC timestamp of last update to the leave type note type: string @@ -6587,13 +6587,13 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" periods: type: array items: - $ref: '#/components/schemas/LeavePeriod' + $ref: "#/components/schemas/LeavePeriod" LeavePeriod: type: object properties: @@ -6633,13 +6633,13 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" leaveBalances: type: array items: - $ref: '#/components/schemas/EmployeeLeaveBalance' + $ref: "#/components/schemas/EmployeeLeaveBalance" EmployeeLeaveBalance: type: object properties: @@ -6664,11 +6664,11 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" leaveBalance: - $ref: '#/components/schemas/EmployeeStatutoryLeaveBalance' + $ref: "#/components/schemas/EmployeeStatutoryLeaveBalance" EmployeeStatutoryLeaveBalance: type: object properties: @@ -6695,13 +6695,13 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" statutoryLeaves: type: array items: - $ref: '#/components/schemas/EmployeeStatutoryLeaveSummary' + $ref: "#/components/schemas/EmployeeStatutoryLeaveSummary" EmployeeStatutoryLeaveSummary: type: object properties: @@ -6746,22 +6746,22 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" statutorySickLeave: type: array items: - $ref: '#/components/schemas/EmployeeStatutorySickLeave' + $ref: "#/components/schemas/EmployeeStatutorySickLeave" EmployeeStatutorySickLeaveObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" statutorySickLeave: - $ref: '#/components/schemas/EmployeeStatutorySickLeave' + $ref: "#/components/schemas/EmployeeStatutorySickLeave" EmployeeStatutorySickLeave: type: object required: @@ -6851,22 +6851,22 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" leaveTypes: type: array items: - $ref: '#/components/schemas/EmployeeLeaveType' + $ref: "#/components/schemas/EmployeeLeaveType" EmployeeLeaveSetupObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" leaveSetup: - $ref: '#/components/schemas/EmployeeLeaveSetup' + $ref: "#/components/schemas/EmployeeLeaveSetup" EmployeeLeaveSetup: type: object properties: @@ -6942,11 +6942,11 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" leaveType: - $ref: '#/components/schemas/EmployeeLeaveType' + $ref: "#/components/schemas/EmployeeLeaveType" EmployeeLeaveType: type: object properties: @@ -7019,31 +7019,31 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" payTemplate: - $ref: '#/components/schemas/EmployeePayTemplate' + $ref: "#/components/schemas/EmployeePayTemplate" EmployeePayTemplates: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" payTemplate: - $ref: '#/components/schemas/EmployeePayTemplate' + $ref: "#/components/schemas/EmployeePayTemplate" EmployeeEarningsTemplates: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" earningTemplates: type: array items: - $ref: '#/components/schemas/EarningsTemplate' + $ref: "#/components/schemas/EarningsTemplate" EmployeePayTemplate: type: object required: @@ -7054,20 +7054,20 @@ components: type: string format: uuid earningTemplates: - $ref: '#/components/schemas/EarningsTemplates' + $ref: "#/components/schemas/EarningsTemplates" EarningsTemplates: type: array items: - $ref: '#/components/schemas/EarningsTemplate' + $ref: "#/components/schemas/EarningsTemplate" EarningsTemplateObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" earningTemplate: - $ref: '#/components/schemas/EarningsTemplate' + $ref: "#/components/schemas/EarningsTemplate" EarningsTemplate: type: object properties: @@ -7101,22 +7101,22 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" benefits: type: array items: - $ref: '#/components/schemas/Benefit' + $ref: "#/components/schemas/Benefit" SuperannuationObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" benefit: - $ref: '#/components/schemas/Benefit' + $ref: "#/components/schemas/Benefit" Benefit: type: object required: @@ -7175,22 +7175,22 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" deductions: type: array items: - $ref: '#/components/schemas/Deduction' + $ref: "#/components/schemas/Deduction" DeductionObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" deduction: - $ref: '#/components/schemas/Deduction' + $ref: "#/components/schemas/Deduction" Deduction: type: object required: @@ -7229,22 +7229,22 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" statutoryDeductions: type: array items: - $ref: '#/components/schemas/StatutoryDeduction' + $ref: "#/components/schemas/StatutoryDeduction" StatutoryDeductionObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" statutoryDeduction: - $ref: '#/components/schemas/StatutoryDeduction' + $ref: "#/components/schemas/StatutoryDeduction" StatutoryDeduction: type: object properties: @@ -7256,7 +7256,7 @@ components: description: Name of the earnings order type: string statutoryDeductionCategory: - $ref: '#/components/schemas/StatutoryDeductionCategory' + $ref: "#/components/schemas/StatutoryDeductionCategory" liabilityAccountId: description: Xero identifier for Liability Account type: string @@ -7283,22 +7283,22 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" statutoryDeductions: type: array items: - $ref: '#/components/schemas/EarningsOrder' + $ref: "#/components/schemas/EarningsOrder" EarningsOrderObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" statutoryDeduction: - $ref: '#/components/schemas/EarningsOrder' + $ref: "#/components/schemas/EarningsOrder" EarningsOrder: type: object required: @@ -7312,7 +7312,7 @@ components: description: Name of the earning order type: string statutoryDeductionCategory: - $ref: '#/components/schemas/StatutoryDeductionCategory' + $ref: "#/components/schemas/StatutoryDeductionCategory" liabilityAccountId: description: Xero identifier for Liability Account type: string @@ -7325,22 +7325,22 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" earningsRates: type: array items: - $ref: '#/components/schemas/EarningsRate' + $ref: "#/components/schemas/EarningsRate" EarningsRateObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" earningsRate: - $ref: '#/components/schemas/EarningsRate' + $ref: "#/components/schemas/EarningsRate" EarningsRate: type: object required: @@ -7412,22 +7412,22 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" leaveTypes: type: array items: - $ref: '#/components/schemas/LeaveType' + $ref: "#/components/schemas/LeaveType" LeaveTypeObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" leaveType: - $ref: '#/components/schemas/LeaveType' + $ref: "#/components/schemas/LeaveType" LeaveType: type: object required: @@ -7466,22 +7466,22 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" reimbursements: type: array items: - $ref: '#/components/schemas/Reimbursement' + $ref: "#/components/schemas/Reimbursement" ReimbursementObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" reimbursement: - $ref: '#/components/schemas/Reimbursement' + $ref: "#/components/schemas/Reimbursement" Reimbursement: type: object required: @@ -7534,22 +7534,22 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" timesheets: type: array items: - $ref: '#/components/schemas/Timesheet' + $ref: "#/components/schemas/Timesheet" TimesheetObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" timesheet: - $ref: '#/components/schemas/Timesheet' + $ref: "#/components/schemas/Timesheet" Timesheet: type: object required: @@ -7599,20 +7599,20 @@ components: format: date-time x-is-datetime: true timesheetLines: - $ref: '#/components/schemas/TimesheetLines' + $ref: "#/components/schemas/TimesheetLines" TimesheetLines: type: array items: - $ref: '#/components/schemas/TimesheetLine' + $ref: "#/components/schemas/TimesheetLine" TimesheetLineObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" timesheetLine: - $ref: '#/components/schemas/TimesheetLine' + $ref: "#/components/schemas/TimesheetLine" TimesheetLine: type: object required: @@ -7646,22 +7646,22 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" payRunCalendars: type: array items: - $ref: '#/components/schemas/PayRunCalendar' + $ref: "#/components/schemas/PayRunCalendar" PayRunCalendarObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" payRunCalendar: - $ref: '#/components/schemas/PayRunCalendar' + $ref: "#/components/schemas/PayRunCalendar" PayRunCalendar: type: object required: @@ -7678,7 +7678,7 @@ components: description: Name of the calendar type: string calendarType: - $ref: '#/components/schemas/CalendarType' + $ref: "#/components/schemas/CalendarType" periodStartDate: description: Period start date of the calendar type: string @@ -7703,11 +7703,11 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" paymentMethod: - $ref: '#/components/schemas/PaymentMethod' + $ref: "#/components/schemas/PaymentMethod" PaymentMethod: type: object properties: @@ -7721,27 +7721,27 @@ components: bankAccounts: type: array items: - $ref: '#/components/schemas/BankAccount' + $ref: "#/components/schemas/BankAccount" SalaryAndWages: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" salaryAndWages: type: array items: - $ref: '#/components/schemas/SalaryAndWage' + $ref: "#/components/schemas/SalaryAndWage" SalaryAndWageObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" salaryAndWages: - $ref: '#/components/schemas/SalaryAndWage' + $ref: "#/components/schemas/SalaryAndWage" SalaryAndWage: type: object required: @@ -7814,22 +7814,22 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" payRuns: type: array items: - $ref: '#/components/schemas/PayRun' + $ref: "#/components/schemas/PayRun" PayRunObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" payRun: - $ref: '#/components/schemas/PayRun' + $ref: "#/components/schemas/PayRun" PayRun: type: object properties: @@ -7880,7 +7880,7 @@ components: - Unscheduled - EarlierYearUpdate calendarType: - $ref: '#/components/schemas/CalendarType' + $ref: "#/components/schemas/CalendarType" postedDateTime: description: Posted date time of the pay run type: string @@ -7889,7 +7889,7 @@ components: paySlips: type: array items: - $ref: '#/components/schemas/PaySlip' + $ref: "#/components/schemas/PaySlip" CalendarType: description: Calendar type of the pay run type: string @@ -7905,22 +7905,22 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" paySlip: - $ref: '#/components/schemas/PaySlip' + $ref: "#/components/schemas/PaySlip" PaySlips: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" paySlips: type: array items: - $ref: '#/components/schemas/PaySlip' + $ref: "#/components/schemas/PaySlip" PaySlip: type: object properties: @@ -8003,35 +8003,35 @@ components: - Electronically - Manual earningsLines: - $ref: '#/components/schemas/EarningsLines' + $ref: "#/components/schemas/EarningsLines" leaveEarningsLines: - $ref: '#/components/schemas/LeaveEarningsLines' + $ref: "#/components/schemas/LeaveEarningsLines" timesheetEarningsLines: - $ref: '#/components/schemas/TimesheetEarningsLines' + $ref: "#/components/schemas/TimesheetEarningsLines" deductionLines: - $ref: '#/components/schemas/DeductionLines' + $ref: "#/components/schemas/DeductionLines" reimbursementLines: - $ref: '#/components/schemas/ReimbursementLines' + $ref: "#/components/schemas/ReimbursementLines" leaveAccrualLines: - $ref: '#/components/schemas/LeaveAccrualLines' + $ref: "#/components/schemas/LeaveAccrualLines" superannuationLines: - $ref: '#/components/schemas/SuperannuationLines' + $ref: "#/components/schemas/SuperannuationLines" paymentLines: - $ref: '#/components/schemas/PaymentLines' + $ref: "#/components/schemas/PaymentLines" employeeTaxLines: - $ref: '#/components/schemas/TaxLines' + $ref: "#/components/schemas/TaxLines" employerTaxLines: - $ref: '#/components/schemas/TaxLines' + $ref: "#/components/schemas/TaxLines" statutoryDeductionLines: - $ref: '#/components/schemas/StatutoryDeductionLines' + $ref: "#/components/schemas/StatutoryDeductionLines" taxSettings: - $ref: '#/components/schemas/TaxSettings' + $ref: "#/components/schemas/TaxSettings" grossEarningsHistory: - $ref: '#/components/schemas/GrossEarningsHistory' + $ref: "#/components/schemas/GrossEarningsHistory" EarningsLines: type: array items: - $ref: '#/components/schemas/EarningsLine' + $ref: "#/components/schemas/EarningsLine" EarningsLine: type: object properties: @@ -8078,7 +8078,7 @@ components: LeaveEarningsLines: type: array items: - $ref: '#/components/schemas/LeaveEarningsLine' + $ref: "#/components/schemas/LeaveEarningsLine" LeaveEarningsLine: type: object properties: @@ -8125,7 +8125,7 @@ components: TimesheetEarningsLines: type: array items: - $ref: '#/components/schemas/TimesheetEarningsLine' + $ref: "#/components/schemas/TimesheetEarningsLine" TimesheetEarningsLine: type: object properties: @@ -8172,7 +8172,7 @@ components: DeductionLines: type: array items: - $ref: '#/components/schemas/DeductionLine' + $ref: "#/components/schemas/DeductionLine" DeductionLine: type: object properties: @@ -8199,7 +8199,7 @@ components: ReimbursementLines: type: array items: - $ref: '#/components/schemas/ReimbursementLine' + $ref: "#/components/schemas/ReimbursementLine" ReimbursementLine: type: object properties: @@ -8228,7 +8228,7 @@ components: LeaveAccrualLines: type: array items: - $ref: '#/components/schemas/LeaveAccrualLine' + $ref: "#/components/schemas/LeaveAccrualLine" LeaveAccrualLine: type: object properties: @@ -8244,7 +8244,7 @@ components: SuperannuationLines: type: array items: - $ref: '#/components/schemas/SuperannuationLine' + $ref: "#/components/schemas/SuperannuationLine" SuperannuationLine: type: object properties: @@ -8276,7 +8276,7 @@ components: PaymentLines: type: array items: - $ref: '#/components/schemas/PaymentLine' + $ref: "#/components/schemas/PaymentLine" PaymentLine: type: object properties: @@ -8301,7 +8301,7 @@ components: TaxLines: type: array items: - $ref: '#/components/schemas/TaxLine' + $ref: "#/components/schemas/TaxLine" TaxLine: type: object properties: @@ -8326,7 +8326,7 @@ components: StatutoryDeductionLines: type: array items: - $ref: '#/components/schemas/StatutoryDeductionLine' + $ref: "#/components/schemas/StatutoryDeductionLine" StatutoryDeductionLine: type: object properties: @@ -8363,7 +8363,7 @@ components: - months example: weeks taxCode: - $ref: '#/components/schemas/TaxCode' + $ref: "#/components/schemas/TaxCode" specialTaxRate: description: Tax rate for STC and WT type: string @@ -8388,18 +8388,18 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" settings: - $ref: '#/components/schemas/Accounts' + $ref: "#/components/schemas/Accounts" Accounts: type: object properties: accounts: type: array items: - $ref: '#/components/schemas/Account' + $ref: "#/components/schemas/Account" Account: type: object properties: @@ -8455,7 +8455,7 @@ components: BankAccounts: type: array items: - $ref: '#/components/schemas/BankAccount' + $ref: "#/components/schemas/BankAccount" BankAccount: type: object required: @@ -8496,11 +8496,11 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" trackingCategories: - $ref: '#/components/schemas/TrackingCategory' + $ref: "#/components/schemas/TrackingCategory" TrackingCategory: type: object properties: @@ -8561,7 +8561,7 @@ components: WorkingWeeks: type: array items: - $ref: '#/components/schemas/WorkingWeek' + $ref: "#/components/schemas/WorkingWeek" EmployeeWorkingPattern: type: object required: @@ -8580,16 +8580,16 @@ components: EmployeeWorkingPatterns: type: array items: - $ref: '#/components/schemas/EmployeeWorkingPattern' + $ref: "#/components/schemas/EmployeeWorkingPattern" EmployeeWorkingPatternsObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" payeeWorkingPatterns: - $ref: '#/components/schemas/EmployeeWorkingPatterns' + $ref: "#/components/schemas/EmployeeWorkingPatterns" EmployeeWorkingPatternWithWorkingWeeks: type: object required: @@ -8606,7 +8606,7 @@ components: format: date x-is-date: true workingWeeks: - $ref: '#/components/schemas/WorkingWeeks' + $ref: "#/components/schemas/WorkingWeeks" EmployeeWorkingPatternWithWorkingWeeksRequest: type: object required: @@ -8619,13 +8619,13 @@ components: format: date x-is-date: true workingWeeks: - $ref: '#/components/schemas/WorkingWeeks' + $ref: "#/components/schemas/WorkingWeeks" EmployeeWorkingPatternWithWorkingWeeksObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" payeeWorkingPattern: - $ref: '#/components/schemas/EmployeeWorkingPatternWithWorkingWeeks' + $ref: "#/components/schemas/EmployeeWorkingPatternWithWorkingWeeks" diff --git a/xero-payroll-uk.yaml b/xero-payroll-uk.yaml index a14fcd2c..227e531a 100644 --- a/xero-payroll-uk.yaml +++ b/xero-payroll-uk.yaml @@ -1,9 +1,9 @@ openapi: 3.0.0 info: version: 9.2.0 - title: Xero Payroll UK - description: This is the Xero Payroll API for orgs in the UK region. - termsOfService: https://developer.xero.com/xero-developer-platform-terms-conditions/ + title: "Xero Payroll UK" + description: "This is the Xero Payroll API for orgs in the UK region." + termsOfService: "https://developer.xero.com/xero-developer-platform-terms-conditions/" contact: name: Xero Platform Team email: api@xero.com @@ -16,7 +16,7 @@ servers: paths: /Employees: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -46,7 +46,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Employees' + $ref: "#/components/schemas/Employees" example: id: 1a14e877-773d-4cd3-b253-f559a4b4be65 providerName: provider-name @@ -118,7 +118,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" post: security: - OAuth2: @@ -140,9 +140,9 @@ paths: java: LocalDate.of(2000, Month.OCTOBER, 28) csharp: new DateTime(2000, 10, 10) php: new DateTime('2000-10-28') - node: '''2000-10-28''' + node: "'2000-10-28'" python: dateutil.parser.parse('2000-10-28T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - Address: key: address keyPascal: Address @@ -211,14 +211,14 @@ paths: object: employee summary: Creates employees parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: search results matching criteria content: application/json: schema: - $ref: '#/components/schemas/EmployeeObject' + $ref: "#/components/schemas/EmployeeObject" example: id: 660ff206-fc4a-42f5-8f7d-de886bc2a3d3 providerName: provider-name @@ -254,13 +254,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/Employee' + $ref: "#/components/schemas/Employee" example: title: Mr firstName: Mike @@ -275,7 +275,7 @@ paths: postCode: MK9 1EB /Employees/{EmployeeID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -302,11 +302,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeObject' + $ref: "#/components/schemas/EmployeeObject" example: id: 9414291b-a8c6-08fa-b165-9b30b1e6aab5 - providerName: '!YLT5Y' - dateTimeUTC: 2018-04-09T05:15:18.1011141 + providerName: "!YLT5Y" + dateTimeUTC: "2018-04-09T05:15:18.1011141" httpStatusCode: OK pagination: null employee: @@ -318,7 +318,7 @@ paths: gender: M email: tester1@gmail.com phoneNumber: "0400123456" - nationalInsuranceNumber: AB123456C + nationalInsuranceNumber: "AB123456C" isOffPayrollWorker: false address: addressLine1: 171 Midsummer @@ -361,9 +361,9 @@ paths: java: LocalDate.of(2000, Month.OCTOBER, 28) csharp: new DateTime(2000, 10, 10) php: new DateTime('2000-10-28') - node: '''2000-10-28''' + node: "'2000-10-28'" python: dateutil.parser.parse('2000-10-28T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - Address: key: address keyPascal: Address @@ -431,7 +431,7 @@ paths: ruby: address object: employee parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: EmployeeID x-snake: employee_id in: path @@ -447,10 +447,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeObject' + $ref: "#/components/schemas/EmployeeObject" example: id: 9414291b-a8c6-08fa-b165-9b30b1e6aab5 - providerName: '!YLT5Y' + providerName: "!YLT5Y" dateTimeUTC: 2018-04-09T05:10:51.3504472 httpStatusCode: OK pagination: null @@ -481,13 +481,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/Employee' + $ref: "#/components/schemas/Employee" example: title: Mr. firstName: TestDataUK @@ -503,7 +503,7 @@ paths: postCode: MK9 1EB /Employees/{EmployeeID}/Employment: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" post: security: - OAuth2: @@ -524,9 +524,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 28) csharp: new DateTime(2020, 10, 10) php: new DateTime('2020-10-28') - node: '''2020-10-28''' + node: "'2020-10-28'" python: dateutil.parser.parse('2020-10-28T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - employment: key: employment keyPascal: Employment @@ -559,7 +559,7 @@ paths: default: A summary: Creates employment detail for a specific employee using a unique employee ID parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: EmployeeID x-snake: employee_id in: path @@ -575,17 +575,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmploymentObject' + $ref: "#/components/schemas/EmploymentObject" example: id: 0160a355-1e6d-4fdc-9532-c0857feaa515 providerName: provider-name - dateTimeUTC: 2020-03-26T18:09:11.6235442 + dateTimeUTC: "2020-03-26T18:09:11.6235442" httpStatusCode: OK pagination: problem: employment: payrollCalendarID: 216d80e6-af55-47b1-b718-9457c3f5d2fe - startDate: 2020-04-01T00:00:00 + startDate: "2020-04-01T00:00:00" niCategories: - niCategory: I startDate: "2020-05-01" @@ -598,13 +598,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/Employment' + $ref: "#/components/schemas/Employment" example: payrollCalendarID: cdfb8371-0b21-4b8a-8903-1024df6c391e startDate: "2024-04-01" @@ -615,7 +615,7 @@ paths: employeeNumber: 123ABC /Employees/{EmployeeID}/Tax: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -642,7 +642,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeTaxObject' + $ref: "#/components/schemas/EmployeeTaxObject" example: id: a8577248-393a-4e7a-8a03-b43b90800b69 providerName: provider-name @@ -664,7 +664,7 @@ paths: nicCalculationMethod: null /Employees/{EmployeeID}/ukopeningbalances: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -691,7 +691,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeOpeningBalancesObject' + $ref: "#/components/schemas/EmployeeOpeningBalancesObject" example: id: ab1c33de-1927-4210-bf4f-2a55965cb4a9 providerName: provider-name @@ -763,7 +763,7 @@ paths: is_last: true summary: Creates an opening balance for a specific employee parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: EmployeeID x-snake: employee_id in: path @@ -779,7 +779,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeOpeningBalancesObject' + $ref: "#/components/schemas/EmployeeOpeningBalancesObject" example: id: 0d30ef37-2fb4-4925-b563-faaee361c9cd providerName: provider-name @@ -793,13 +793,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/EmployeeOpeningBalances' + $ref: "#/components/schemas/EmployeeOpeningBalances" example: statutoryAdoptionPay: 10 statutoryMaternityPay: 10 @@ -864,7 +864,7 @@ paths: is_last: true summary: Updates a specific employee's opening balances parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: EmployeeID x-snake: employee_id in: path @@ -880,7 +880,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeOpeningBalancesObject' + $ref: "#/components/schemas/EmployeeOpeningBalancesObject" example: id: 21953776-783c-426c-bf15-cbde997839c4 providerName: provider-name @@ -894,13 +894,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/EmployeeOpeningBalances' + $ref: "#/components/schemas/EmployeeOpeningBalances" example: statutoryAdoptionPay: 20 statutoryMaternityPay: 20 @@ -910,7 +910,7 @@ paths: priorEmployeeNumber: 20 /Employees/{EmployeeID}/Leave: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -937,7 +937,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeLeaves' + $ref: "#/components/schemas/EmployeeLeaves" example: id: e4d42712-4876-4b32-987d-1f62538089de providerName: provider-name @@ -977,9 +977,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 28) csharp: new DateTime(2020, 10, 10) php: new DateTime('2020-10-28') - node: '''2020-10-28''' + node: "'2020-10-28'" python: dateutil.parser.parse('2020-10-28T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - endDateValue: key: endDate keyPascal: EndDate @@ -991,9 +991,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 30) csharp: new DateTime(2020, 10, 12) php: new DateTime('2020-10-30') - node: '''2020-10-30''' + node: "'2020-10-30'" python: dateutil.parser.parse('2020-10-30T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - employeeLeave: key: employeeLeave keyPascal: EmployeeLeave @@ -1029,7 +1029,7 @@ paths: object: employeeLeave summary: Creates leave records for a specific employee parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: EmployeeID x-snake: employee_id in: path @@ -1045,7 +1045,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeLeaveObject' + $ref: "#/components/schemas/EmployeeLeaveObject" example: id: ef91410a-2be1-42cc-86db-e625344a82e9 providerName: provider-name @@ -1070,13 +1070,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/EmployeeLeave' + $ref: "#/components/schemas/EmployeeLeave" example: leaveTypeID: 1d2778ee-86ea-45c0-bbf8-1045485f6b3f description: Creating a Description @@ -1084,7 +1084,7 @@ paths: endDate: "2020-03-26" /Employees/{EmployeeID}/Leave/{LeaveID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -1120,7 +1120,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeLeaveObject' + $ref: "#/components/schemas/EmployeeLeaveObject" example: id: 6ae25805-fef3-4c9b-9e69-9ccc71a6a8da providerName: provider-name @@ -1160,9 +1160,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 28) csharp: new DateTime(2020, 10, 10) php: new DateTime('2020-10-28') - node: '''2020-10-28''' + node: "'2020-10-28'" python: dateutil.parser.parse('2020-10-28T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - endDateValue: key: endDate keyPascal: EndDate @@ -1174,9 +1174,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 30) csharp: new DateTime(2020, 10, 12) php: new DateTime('2020-10-30') - node: '''2020-10-30''' + node: "'2020-10-30'" python: dateutil.parser.parse('2020-10-30T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - employeeLeave: key: employeeLeave keyPascal: EmployeeLeave @@ -1212,7 +1212,7 @@ paths: object: employeeLeave summary: Updates a specific employee's leave records parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: EmployeeID x-snake: employee_id in: path @@ -1237,7 +1237,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeLeaveObject' + $ref: "#/components/schemas/EmployeeLeaveObject" example: id: ea115d89-61a0-4a2d-ad77-e3c63a2b401f providerName: provider-name @@ -1262,13 +1262,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/EmployeeLeave' + $ref: "#/components/schemas/EmployeeLeave" example: leaveTypeID: ed08dffe-788e-4b24-9630-f0fa2f4d164c description: Creating a Description @@ -1313,7 +1313,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeLeaveObject' + $ref: "#/components/schemas/EmployeeLeaveObject" example: id: b0ab87f6-bbca-4c81-b616-c545592f6988 providerName: provider-name @@ -1323,7 +1323,7 @@ paths: problem: null /Employees/{EmployeeID}/LeaveBalances: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -1350,7 +1350,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeLeaveBalances' + $ref: "#/components/schemas/EmployeeLeaveBalances" example: id: a9b96d49-fc15-4e25-8b62-818462ea6dbd providerName: provider-name @@ -1373,7 +1373,7 @@ paths: typeOfUnits: Hours /Employees/{EmployeeID}/StatutoryLeaveBalance: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -1414,7 +1414,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeStatutoryLeaveBalanceObject' + $ref: "#/components/schemas/EmployeeStatutoryLeaveBalanceObject" example: id: ee863df3-c394-4102-bb91-2b14de404c1c providerName: provider-name @@ -1428,7 +1428,7 @@ paths: units: Hours /StatutoryLeaves/Summary/{EmployeeID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -1461,7 +1461,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeStatutoryLeavesSummaries' + $ref: "#/components/schemas/EmployeeStatutoryLeavesSummaries" example: id: 1908f4d1-b85d-4d6d-a885-6b6e2922ad03 providerName: provider-name @@ -1479,7 +1479,7 @@ paths: status: Pending /StatutoryLeaves/Sick: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" post: security: - OAuth2: @@ -1500,9 +1500,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 28) csharp: new DateTime(2020, 10, 10) php: new DateTime('2020-10-28') - node: '''2020-10-28''' + node: "'2020-10-28'" python: dateutil.parser.parse('2020-10-28T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - endDateValue: key: endDate keyPascal: EndDate @@ -1514,9 +1514,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 30) csharp: new DateTime(2020, 10, 12) php: new DateTime('2020-10-30') - node: '''2020-10-30''' + node: "'2020-10-30'" python: dateutil.parser.parse('2020-10-30T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - employeeStatutorySickLeave: key: employeeStatutorySickLeave keyPascal: EmployeeStatutorySickLeave @@ -1559,14 +1559,14 @@ paths: object: employeeStatutorySickLeave summary: Creates statutory sick leave records parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: search results matching criteria content: application/json: schema: - $ref: '#/components/schemas/EmployeeStatutorySickLeaveObject' + $ref: "#/components/schemas/EmployeeStatutorySickLeaveObject" example: id: 35c840a3-04aa-43f1-9171-f7eaf4fd4454 providerName: provider-name @@ -1600,13 +1600,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/EmployeeStatutorySickLeave' + $ref: "#/components/schemas/EmployeeStatutorySickLeave" example: employeeID: aad6b292-7b94-408b-93f6-e489867e3fb0 leaveTypeID: aab78802-e9d3-4bbd-bc87-df858054988f @@ -1622,7 +1622,7 @@ paths: sufficientNotice: true /StatutoryLeaves/Sick/{StatutorySickLeaveID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -1649,7 +1649,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeStatutorySickLeaveObject' + $ref: "#/components/schemas/EmployeeStatutorySickLeaveObject" example: id: c484213d-6225-4ede-bc5e-e81ef350af41 providerName: provider-name @@ -1680,7 +1680,7 @@ paths: - AweLowerThanLel /Employees/{EmployeeID}/LeavePeriods: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -1721,7 +1721,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LeavePeriods' + $ref: "#/components/schemas/LeavePeriods" example: id: 00000000-0000-0000-0000-000000000000 providerName: provider-name @@ -1743,10 +1743,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" /Employees/{EmployeeID}/LeaveTypes: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -1773,7 +1773,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeLeaveTypes' + $ref: "#/components/schemas/EmployeeLeaveTypes" example: id: d86959c6-94f5-437a-9367-581cb145fc4f providerName: provider-name @@ -1794,7 +1794,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" post: security: - OAuth2: @@ -1847,7 +1847,7 @@ paths: is_last: true summary: Creates employee leave type records parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: EmployeeID x-snake: employee_id in: path @@ -1863,7 +1863,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeeLeaveTypeObject' + $ref: "#/components/schemas/EmployeeLeaveTypeObject" example: id: 3245e4c9-1ec5-4f3e-b659-fdb722733060 providerName: provider-name @@ -1883,20 +1883,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/EmployeeLeaveType' + $ref: "#/components/schemas/EmployeeLeaveType" example: leaveTypeID: 4918f233-bd31-43f9-9633-bcc6de1178f2 scheduleOfAccrual: BeginningOfCalendarYear hoursAccruedAnnually: 10 /Employees/{EmployeeID}/PaymentMethods: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -1923,7 +1923,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PaymentMethodObject' + $ref: "#/components/schemas/PaymentMethodObject" example: id: 33c27fe9-de53-4114-8455-a6392add88b8 providerName: provider-name @@ -1942,7 +1942,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" post: security: - OAuth2: @@ -2010,7 +2010,7 @@ paths: object: paymentMethod summary: Creates an employee payment method parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: EmployeeID x-snake: employee_id in: path @@ -2026,7 +2026,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PaymentMethodObject' + $ref: "#/components/schemas/PaymentMethodObject" example: id: 6c5eab91-8f3c-4569-a5ce-ab4eec112d35 providerName: provider-name @@ -2045,13 +2045,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/PaymentMethod' + $ref: "#/components/schemas/PaymentMethod" example: paymentMethod: Electronically bankAccounts: @@ -2060,7 +2060,7 @@ paths: sortCode: "287654" /Employees/{EmployeeID}/PayTemplates: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -2087,7 +2087,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeePayTemplateObject' + $ref: "#/components/schemas/EmployeePayTemplateObject" example: id: 3138be2b-96d9-44d0-a01e-80fd527555c8 providerName: provider-name @@ -2113,11 +2113,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" # 503 /Employees/{EmployeeID}/PayTemplates/earnings: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" post: security: - OAuth2: @@ -2196,7 +2196,7 @@ paths: object: earningsTemplate summary: Creates an earnings template records for a specific employee parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: EmployeeID x-snake: employee_id in: path @@ -2212,22 +2212,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EarningsTemplateObject' + $ref: "#/components/schemas/EarningsTemplateObject" "400": description: validation error for a bad request content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/EarningsTemplate' + $ref: "#/components/schemas/EarningsTemplate" /Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" put: security: - OAuth2: @@ -2306,7 +2306,7 @@ paths: object: earningsTemplate summary: Updates a specific employee's earnings template records parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: EmployeeID x-snake: employee_id in: path @@ -2331,7 +2331,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EarningsTemplateObject' + $ref: "#/components/schemas/EarningsTemplateObject" example: id: 39603f09-e06f-4cd4-8291-e3ad1df8b35b providerName: provider-name @@ -2351,13 +2351,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/EarningsTemplate' + $ref: "#/components/schemas/EarningsTemplate" example: ratePerUnit: 30 numberOfUnits: 4 @@ -2394,7 +2394,7 @@ paths: description: deletion successful /Employees/{EmployeeID}/paytemplateearnings: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" post: security: - OAuth2: @@ -2473,7 +2473,7 @@ paths: object: earningsTemplate summary: Creates multiple earnings template records for a specific employee using a unique employee ID parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: EmployeeID x-snake: employee_id in: path @@ -2489,7 +2489,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EmployeePayTemplates' + $ref: "#/components/schemas/EmployeePayTemplates" example: id: 1c08b529-0827-4e91-a6a1-c479765aa65f providerName: provider-name @@ -2515,17 +2515,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/EarningsTemplates' + $ref: "#/components/schemas/EarningsTemplates" example: '[ { "ratePerUnit":20.0, "numberOfUnits":8.0, "earningsRateID":"87f5b43a-cf51-4b74-92de-94c819e82d27" }, { "ratePerUnit":20.0, "numberOfUnits":8.0, "earningsRateID":"973365f3-66b2-4c33-8ae6-14b75f78f68b" } ]' /Benefits: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -2548,7 +2548,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Benefits' + $ref: "#/components/schemas/Benefits" example: id: 079865dc-f3df-4783-98a9-67db747ab82c providerName: provider-name @@ -2585,7 +2585,7 @@ paths: x-hasPayrollUkProblem: true summary: Creates a new employee benefit parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" x-example: - benefit: key: benefit @@ -2626,7 +2626,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BenefitObject' + $ref: "#/components/schemas/BenefitObject" example: id: 95352407-6477-42f1-bd9c-bab28af8b0d9 providerName: provider-name @@ -2654,13 +2654,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/Benefit' + $ref: "#/components/schemas/Benefit" example: name: My Big Bennie category: StakeholderPension @@ -2671,7 +2671,7 @@ paths: calculationType: PercentageOfGross /Benefits/{id}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -2696,7 +2696,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BenefitObject' + $ref: "#/components/schemas/BenefitObject" example: id: e7959d7b-370d-47e5-bb15-4b68f136ddae providerName: provider-name @@ -2721,7 +2721,7 @@ paths: isCalculatingOnQualifyingEarnings: null /Deductions: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -2744,7 +2744,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Deductions' + $ref: "#/components/schemas/Deductions" example: id: 846b81f3-7192-4a78-a05c-ae5d2c402546 providerName: provider-name @@ -2845,14 +2845,14 @@ paths: is_last: true summary: Creates a new deduction parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: search results matching criteria content: application/json: schema: - $ref: '#/components/schemas/DeductionObject' + $ref: "#/components/schemas/DeductionObject" example: id: 26cf94f5-6b62-4f76-8e89-44e4d0062566 providerName: provider-name @@ -2882,13 +2882,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/Deduction' + $ref: "#/components/schemas/Deduction" example: deductionName: My new deduction deductionCategory: SalarySacrifice @@ -2896,7 +2896,7 @@ paths: calculationType: FixedAmount /Deductions/{deductionId}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -2922,7 +2922,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DeductionObject' + $ref: "#/components/schemas/DeductionObject" example: id: addf44c5-5a3b-4d25-a61c-4e9e85cb27b3 providerName: provider-name @@ -2998,7 +2998,7 @@ paths: # $ref: '#/components/schemas/Benefit' /EarningsOrders: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -3021,7 +3021,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EarningsOrders' + $ref: "#/components/schemas/EarningsOrders" example: id: 5bf85b65-c2de-4632-8e5e-cc0ab3d18ff0 providerName: provider-name @@ -3076,7 +3076,7 @@ paths: currentRecord: true /EarningsOrders/{id}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -3101,7 +3101,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EarningsOrderObject' + $ref: "#/components/schemas/EarningsOrderObject" example: id: e0fd1c57-e9d0-4c3f-9a1a-0355ddf7c060 providerName: provider-name @@ -3117,7 +3117,7 @@ paths: currentRecord: true /EarningsRates: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -3140,7 +3140,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EarningsRates' + $ref: "#/components/schemas/EarningsRates" example: id: fbe7a960-fad3-4293-8de9-0fabfbea615f providerName: provider-name @@ -3183,7 +3183,7 @@ paths: x-hasPayrollUkProblem: true summary: Creates a new earnings rate parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" x-example: - earningsRate: key: earningsRate @@ -3236,7 +3236,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EarningsRateObject' + $ref: "#/components/schemas/EarningsRateObject" example: id: cc5341dd-c652-47f0-b8a3-67a22617ca7b providerName: provider-name @@ -3260,13 +3260,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/EarningsRate' + $ref: "#/components/schemas/EarningsRate" example: name: My Earnings Rate earningsType: RegularEarnings @@ -3275,7 +3275,7 @@ paths: expenseAccountID: 4b03500d-32fd-4616-8d70-e1e56e0519c6 /EarningsRates/{EarningsRateID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -3301,7 +3301,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EarningsRateObject' + $ref: "#/components/schemas/EarningsRateObject" example: id: 85375ff5-6ccf-4d8c-a976-0531c94597de providerName: provider-name @@ -3322,7 +3322,7 @@ paths: multipleOfOrdinaryEarningsRate: null /LeaveTypes: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -3351,7 +3351,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LeaveTypes' + $ref: "#/components/schemas/LeaveTypes" example: id: cb429b37-78d3-4b15-9788-83cbd1fd3f72 providerName: provider-name @@ -3415,14 +3415,14 @@ paths: is_last: true summary: Creates a new leave type parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: search results matching criteria content: application/json: schema: - $ref: '#/components/schemas/LeaveTypeObject' + $ref: "#/components/schemas/LeaveTypeObject" example: id: 89aeb982-d6e8-45dd-a853-fcaee4fc99cc providerName: provider-name @@ -3443,20 +3443,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/LeaveType' + $ref: "#/components/schemas/LeaveType" example: name: My opebvwbfxf Leave isPaidLeave: false showOnPayslip: true /LeaveTypes/{LeaveTypeID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -3482,7 +3482,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LeaveTypeObject' + $ref: "#/components/schemas/LeaveTypeObject" example: id: 684454f6-d808-46e0-b83d-5593a560b9d0 providerName: provider-name @@ -3500,7 +3500,7 @@ paths: isActive: true /Reimbursements: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -3523,7 +3523,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Reimbursements' + $ref: "#/components/schemas/Reimbursements" example: id: eea19a1d-a714-41c0-8730-94b6d4fbac84 providerName: provider-name @@ -3574,14 +3574,14 @@ paths: is_last: true summary: Creates a new reimbursement parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: search results matching criteria content: application/json: schema: - $ref: '#/components/schemas/ReimbursementObject' + $ref: "#/components/schemas/ReimbursementObject" example: id: 310ecff7-8577-4e05-98a3-3ce7ecb2868a providerName: provider-name @@ -3599,19 +3599,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/Reimbursement' + $ref: "#/components/schemas/Reimbursement" example: name: My new Reimburse accountID: 9ee28149-32a9-4661-8eab-a28738696983 /Reimbursements/{ReimbursementID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -3637,7 +3637,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ReimbursementObject' + $ref: "#/components/schemas/ReimbursementObject" example: id: 9c727a87-a96b-4998-b7e7-6b79347915cc providerName: provider-name @@ -3652,7 +3652,7 @@ paths: currentRecord: true /Timesheets: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -3708,7 +3708,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Timesheets' + $ref: "#/components/schemas/Timesheets" example: id: d81c2087-3ecb-4d91-b775-73d85f593370 providerName: provider-name @@ -3749,9 +3749,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 28) csharp: new DateTime(2020, 10, 10) php: new DateTime('2020-10-28') - node: '''2020-10-28''' + node: "'2020-10-28'" python: dateutil.parser.parse('2020-10-28T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - endDateValue: key: endDate keyPascal: EndDate @@ -3763,9 +3763,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 30) csharp: new DateTime(2020, 10, 12) php: new DateTime('2020-10-30') - node: '''2020-10-30''' + node: "'2020-10-30'" python: dateutil.parser.parse('2020-10-30T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - timesheet: key: timesheet keyPascal: Timesheet @@ -3808,14 +3808,14 @@ paths: object: timesheet summary: Creates a new timesheet parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: search results matching criteria content: application/json: schema: - $ref: '#/components/schemas/TimesheetObject' + $ref: "#/components/schemas/TimesheetObject" example: id: ef0aa7e2-6f7f-43f6-9186-af670dce7c69 providerName: provider-name @@ -3848,13 +3848,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/Timesheet' + $ref: "#/components/schemas/Timesheet" example: payrollCalendarID: 216d80e6-af55-47b1-b718-9457c3f5d2fe employeeID: aad6b292-7b94-408b-93f6-e489867e3fb0 @@ -3869,7 +3869,7 @@ paths: numberOfUnits: 6 /Timesheets/{TimesheetID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -3895,7 +3895,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TimesheetObject' + $ref: "#/components/schemas/TimesheetObject" example: id: 504259ac-df26-482e-bd0a-d792d96453bb providerName: provider-name @@ -3946,16 +3946,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TimesheetLine' + $ref: "#/components/schemas/TimesheetLine" "400": description: validation error for a bad request content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" /Timesheets/{TimesheetID}/Lines: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" post: security: - OAuth2: @@ -3976,9 +3976,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 28) csharp: new DateTime(2020, 10, 10) php: new DateTime('2020-10-28') - node: '''2020-10-28''' + node: "'2020-10-28'" python: dateutil.parser.parse('2020-10-28T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - timesheetLine: key: timesheetLine keyPascal: TimesheetLine @@ -4025,7 +4025,7 @@ paths: is_last: true summary: Creates a new timesheet line for a specific timesheet using a unique timesheet ID parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - in: path name: TimesheetID x-snake: timesheet_id @@ -4040,7 +4040,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TimesheetLineObject' + $ref: "#/components/schemas/TimesheetLineObject" example: id: cf701261-529e-47cd-8156-5ec9ab3394ff providerName: provider-name @@ -4059,20 +4059,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/TimesheetLine' + $ref: "#/components/schemas/TimesheetLine" example: date: "2020-04-14" earningsRateID: 87f5b43a-cf51-4b74-92de-94c819e82d27 numberOfUnits: 1 /Timesheets/{TimesheetID}/Approve: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" post: security: - OAuth2: @@ -4083,7 +4083,7 @@ paths: x-hasPayrollUkProblem: true summary: Approves a specific timesheet parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - in: path name: TimesheetID x-snake: timesheet_id @@ -4098,7 +4098,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TimesheetObject' + $ref: "#/components/schemas/TimesheetObject" example: id: 94c27148-2749-4d85-bc1a-986e6de230ae providerName: provider-name @@ -4136,10 +4136,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" /Timesheets/{TimesheetID}/RevertToDraft: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" post: security: - OAuth2: @@ -4150,7 +4150,7 @@ paths: x-hasPayrollUkProblem: true summary: Reverts a specific timesheet to draft parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - in: path name: TimesheetID x-snake: timesheet_id @@ -4165,7 +4165,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TimesheetObject' + $ref: "#/components/schemas/TimesheetObject" example: id: a774530a-a50c-4480-a094-358cf80a7d98 providerName: provider-name @@ -4203,10 +4203,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" /Timesheets/{TimesheetID}/Lines/{TimesheetLineID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" put: security: - OAuth2: @@ -4227,9 +4227,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 28) csharp: new DateTime(2020, 10, 10) php: new DateTime('2020-10-28') - node: '''2020-10-28''' + node: "'2020-10-28'" python: dateutil.parser.parse('2020-10-28T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - timesheetLine: key: timesheetLine keyPascal: TimesheetLine @@ -4276,7 +4276,7 @@ paths: is_last: true summary: Updates a specific timesheet line for a specific timesheet parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - in: path name: TimesheetID x-snake: timesheet_id @@ -4299,7 +4299,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TimesheetLineObject' + $ref: "#/components/schemas/TimesheetLineObject" example: id: 582b87a6-14f3-409b-be89-f9b9c49db983 providerName: provider-name @@ -4318,13 +4318,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/TimesheetLine' + $ref: "#/components/schemas/TimesheetLine" example: date: "2020-04-14" earningsRateID: 87f5b43a-cf51-4b74-92de-94c819e82d27 @@ -4360,16 +4360,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TimesheetLine' + $ref: "#/components/schemas/TimesheetLine" "400": description: validation error for a bad request content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" /PayRunCalendars: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -4392,7 +4392,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PayRunCalendars' + $ref: "#/components/schemas/PayRunCalendars" example: id: f66c8da6-06c1-47c7-a415-366cb3991858 providerName: provider-name @@ -4406,21 +4406,21 @@ paths: problem: null payRunCalendars: - payrollCalendarID: 216d80e6-af55-47b1-b718-9457c3f5d2fe - name: 'Weekly ' + name: "Weekly " calendarType: Weekly periodStartDate: 2020-02-10T00:00:00 periodEndDate: 2020-02-16T00:00:00 paymentDate: 2020-02-17T00:00:00 updatedDateUTC: 2020-02-13T16:53:54 - payrollCalendarID: d45bc68f-59d6-4000-929d-1058dcfa79e1 - name: 'Fortnightly ' + name: "Fortnightly " calendarType: Fortnightly periodStartDate: 2020-02-03T00:00:00 periodEndDate: 2020-02-16T00:00:00 paymentDate: 2020-02-10T00:00:00 updatedDateUTC: 2020-02-10T10:02:09 - payrollCalendarID: 5e813d9e-949c-461f-8a89-e9ee8955a254 - name: 'Monthly ' + name: "Monthly " calendarType: Monthly periodStartDate: 2020-03-03T00:00:00 periodEndDate: 2020-04-02T00:00:00 @@ -4446,9 +4446,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 28) csharp: new DateTime(2020, 10, 10) php: new DateTime('2020-10-28') - node: '''2020-10-28''' + node: "'2020-10-28'" python: dateutil.parser.parse('2020-10-28T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - paymentDateValue: key: paymentDate keyPascal: PaymentDate @@ -4460,9 +4460,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 30) csharp: new DateTime(2020, 10, 12) php: new DateTime('2020-10-30') - node: '''2020-10-30''' + node: "'2020-10-30'" python: dateutil.parser.parse('2020-10-30T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - payRunCalendar: key: payRunCalendar keyPascal: PayRunCalendar @@ -4504,14 +4504,14 @@ paths: object: payRunCalendar summary: Creates a new payrun calendar parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: search results matching criteria content: application/json: schema: - $ref: '#/components/schemas/PayRunCalendarObject' + $ref: "#/components/schemas/PayRunCalendarObject" example: id: ef25e7f2-b5d6-454c-8147-396c373565dd providerName: provider-name @@ -4532,13 +4532,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/PayRunCalendar' + $ref: "#/components/schemas/PayRunCalendar" example: name: My Weekly Cal calendarType: Weekly @@ -4546,7 +4546,7 @@ paths: paymentDate: "2020-05-15" /PayRunCalendars/{PayRunCalendarID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -4572,7 +4572,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PayRunCalendarObject' + $ref: "#/components/schemas/PayRunCalendarObject" example: id: dae942a3-b4fb-4b24-839b-14e1073f8cca providerName: provider-name @@ -4582,7 +4582,7 @@ paths: problem: null payRunCalendar: payrollCalendarID: 216d80e6-af55-47b1-b718-9457c3f5d2fe - name: 'Weekly ' + name: "Weekly " calendarType: Weekly periodStartDate: 2020-02-10T00:00:00 periodEndDate: 2020-02-16T00:00:00 @@ -4590,7 +4590,7 @@ paths: updatedDateUTC: 2020-02-13T16:53:54 /Employees/{EmployeeID}/SalaryAndWages: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -4622,7 +4622,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SalaryAndWages' + $ref: "#/components/schemas/SalaryAndWages" example: id: 56273e64-dff0-4542-96f3-54ad3ac27431 providerName: provider-name @@ -4650,7 +4650,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" post: security: - OAuth2: @@ -4715,7 +4715,7 @@ paths: is_last: true summary: Creates a salary and wage record for a specific employee parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: EmployeeID x-snake: employee_id in: path @@ -4731,7 +4731,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SalaryAndWageObject' + $ref: "#/components/schemas/SalaryAndWageObject" example: id: a15f15ec-a8ed-420b-82f6-1546a9bf6d57 providerName: provider-name @@ -4755,13 +4755,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/SalaryAndWage' + $ref: "#/components/schemas/SalaryAndWage" example: earningsRateID: 87f5b43a-cf51-4b74-92de-94c819e82d27 numberOfUnitsPerWeek: 2 @@ -4773,7 +4773,7 @@ paths: paymentType: Salary /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -4809,7 +4809,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SalaryAndWages' + $ref: "#/components/schemas/SalaryAndWages" example: id: cd4f35e7-5062-494a-96c4-f81e9083b0b9 providerName: provider-name @@ -4892,7 +4892,7 @@ paths: is_last: true summary: Updates salary and wages record for a specific employee parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: EmployeeID x-snake: employee_id in: path @@ -4917,7 +4917,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SalaryAndWageObject' + $ref: "#/components/schemas/SalaryAndWageObject" example: id: d12a31ee-e094-4e67-9092-0d5e1d7569a6 providerName: provider-name @@ -4941,13 +4941,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/SalaryAndWage' + $ref: "#/components/schemas/SalaryAndWage" example: earningsRateID: 87f5b43a-cf51-4b74-92de-94c819e82d27 numberOfUnitsPerWeek: 3 @@ -4988,7 +4988,7 @@ paths: description: deletion successful /PayRuns: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -5019,7 +5019,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PayRuns' + $ref: "#/components/schemas/PayRuns" example: id: d748445b-fd11-4832-a85a-905fbfcf3d7c providerName: provider-name @@ -5058,7 +5058,7 @@ paths: payslipMessage: null /PayRuns/{PayRunID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -5084,7 +5084,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PayRunObject' + $ref: "#/components/schemas/PayRunObject" example: id: 84471d62-74b6-4b21-845c-6d1e6f031172 providerName: provider-name @@ -5125,7 +5125,7 @@ paths: invalidPayeeIDs: null /Payslips: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -5156,7 +5156,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Payslips' + $ref: "#/components/schemas/Payslips" example: id: c07aa280-478b-48b5-a778-499cf95c9781 providerName: provider-name @@ -5230,7 +5230,7 @@ paths: courtOrderLines: [] /Payslips/{PayslipID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -5256,7 +5256,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PayslipObject' + $ref: "#/components/schemas/PayslipObject" example: id: 80c558c3-bc7a-48d0-91b2-20b8ec784f0d providerName: provider-name @@ -5326,7 +5326,7 @@ paths: courtOrderLines: [] /Settings: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -5343,7 +5343,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Settings' + $ref: "#/components/schemas/Settings" example: id: 3cb41871-980a-47e4-878f-7c576b0d3677 providerName: provider-name @@ -5383,7 +5383,7 @@ paths: name: Wages Payable - Payroll /Settings/trackingCategories: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -5400,7 +5400,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TrackingCategories' + $ref: "#/components/schemas/TrackingCategories" example: id: e56628f7-a25e-4d23-88c5-56e2895e2143 providerName: provider-name @@ -5488,7 +5488,7 @@ components: invalidFields: type: array items: - $ref: '#/components/schemas/InvalidField' + $ref: "#/components/schemas/InvalidField" InvalidField: type: object properties: @@ -5504,22 +5504,22 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" employees: type: array items: - $ref: '#/components/schemas/Employee' + $ref: "#/components/schemas/Employee" EmployeeObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" employee: - $ref: '#/components/schemas/Employee' + $ref: "#/components/schemas/Employee" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" Employee: type: object required: @@ -5554,7 +5554,7 @@ components: example: 2019-01-02 x-is-date: true address: - $ref: '#/components/schemas/Address' + $ref: "#/components/schemas/Address" email: description: The email address for the employee type: string @@ -5597,13 +5597,13 @@ components: format: date-time x-is-datetime: true niCategory: - $ref: '#/components/schemas/NICategoryLetter' + $ref: "#/components/schemas/NICategoryLetter" deprecated: true niCategories: description: The employee's NI categories type: array items: - $ref: '#/components/schemas/NICategory' + $ref: "#/components/schemas/NICategory" nationalInsuranceNumber: description: National insurance number of the employee type: string @@ -5615,11 +5615,11 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" employment: - $ref: '#/components/schemas/Employment' + $ref: "#/components/schemas/Employment" Employment: type: object required: @@ -5642,22 +5642,22 @@ components: type: string example: 007 niCategory: - $ref: '#/components/schemas/NICategoryLetter' + $ref: "#/components/schemas/NICategoryLetter" deprecated: true niCategories: description: The employee's NI categories type: array items: - $ref: '#/components/schemas/NICategory' + $ref: "#/components/schemas/NICategory" EmployeeTaxObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" employeeTax: - $ref: '#/components/schemas/EmployeeTax' + $ref: "#/components/schemas/EmployeeTax" EmployeeTax: type: object properties: @@ -5709,11 +5709,11 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" openingBalances: - $ref: '#/components/schemas/EmployeeOpeningBalances' + $ref: "#/components/schemas/EmployeeOpeningBalances" EmployeeOpeningBalances: type: object properties: @@ -5750,22 +5750,22 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" leave: type: array items: - $ref: '#/components/schemas/EmployeeLeave' + $ref: "#/components/schemas/EmployeeLeave" EmployeeLeaveObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" leave: - $ref: '#/components/schemas/EmployeeLeave' + $ref: "#/components/schemas/EmployeeLeave" EmployeeLeave: type: object required: @@ -5799,7 +5799,7 @@ components: description: The leave period information. The StartDate, EndDate and NumberOfUnits needs to be specified when you do not want to calculate NumberOfUnits automatically. Using incorrect period StartDate and EndDate will result in automatic computation of the NumberOfUnits. type: array items: - $ref: '#/components/schemas/LeavePeriod' + $ref: "#/components/schemas/LeavePeriod" updatedDateUTC: description: UTC timestamp of last update to the leave type note type: string @@ -5809,13 +5809,13 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" periods: type: array items: - $ref: '#/components/schemas/LeavePeriod' + $ref: "#/components/schemas/LeavePeriod" LeavePeriod: type: object properties: @@ -5843,13 +5843,13 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" leaveBalances: type: array items: - $ref: '#/components/schemas/EmployeeLeaveBalance' + $ref: "#/components/schemas/EmployeeLeaveBalance" EmployeeLeaveBalance: type: object properties: @@ -5873,11 +5873,11 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" leaveBalance: - $ref: '#/components/schemas/EmployeeStatutoryLeaveBalance' + $ref: "#/components/schemas/EmployeeStatutoryLeaveBalance" EmployeeStatutoryLeaveBalance: type: object properties: @@ -5905,13 +5905,13 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" statutoryLeaves: type: array items: - $ref: '#/components/schemas/EmployeeStatutoryLeaveSummary' + $ref: "#/components/schemas/EmployeeStatutoryLeaveSummary" EmployeeStatutoryLeaveSummary: type: object properties: @@ -5958,22 +5958,22 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" statutorySickLeave: type: array items: - $ref: '#/components/schemas/EmployeeStatutorySickLeave' + $ref: "#/components/schemas/EmployeeStatutorySickLeave" EmployeeStatutorySickLeaveObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" statutorySickLeave: - $ref: '#/components/schemas/EmployeeStatutorySickLeave' + $ref: "#/components/schemas/EmployeeStatutorySickLeave" EmployeeStatutorySickLeave: type: object required: @@ -6060,22 +6060,22 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" leaveTypes: type: array items: - $ref: '#/components/schemas/EmployeeLeaveType' + $ref: "#/components/schemas/EmployeeLeaveType" EmployeeLeaveTypeObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" leaveType: - $ref: '#/components/schemas/EmployeeLeaveType' + $ref: "#/components/schemas/EmployeeLeaveType" EmployeeLeaveType: type: object required: @@ -6120,20 +6120,20 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" payTemplate: - $ref: '#/components/schemas/EmployeePayTemplate' + $ref: "#/components/schemas/EmployeePayTemplate" EmployeePayTemplates: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" earningTemplates: - $ref: '#/components/schemas/EarningsTemplates' + $ref: "#/components/schemas/EarningsTemplates" EmployeePayTemplate: type: object required: @@ -6144,20 +6144,20 @@ components: type: string format: uuid earningTemplates: - $ref: '#/components/schemas/EarningsTemplates' + $ref: "#/components/schemas/EarningsTemplates" EarningsTemplates: type: array items: - $ref: '#/components/schemas/EarningsTemplate' + $ref: "#/components/schemas/EarningsTemplate" EarningsTemplateObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" earningTemplate: - $ref: '#/components/schemas/EarningsTemplate' + $ref: "#/components/schemas/EarningsTemplate" EarningsTemplate: type: object properties: @@ -6191,22 +6191,22 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" benefits: type: array items: - $ref: '#/components/schemas/Benefit' + $ref: "#/components/schemas/Benefit" BenefitObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" benefit: - $ref: '#/components/schemas/Benefit' + $ref: "#/components/schemas/Benefit" Benefit: type: object required: @@ -6276,22 +6276,22 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" deductions: type: array items: - $ref: '#/components/schemas/Deduction' + $ref: "#/components/schemas/Deduction" DeductionObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" deduction: - $ref: '#/components/schemas/Deduction' + $ref: "#/components/schemas/Deduction" Deduction: type: object required: @@ -6369,7 +6369,7 @@ components: StatutoryDeductions: type: array items: - $ref: '#/components/schemas/StatutoryDeduction' + $ref: "#/components/schemas/StatutoryDeduction" StatutoryDeduction: type: object properties: @@ -6381,7 +6381,7 @@ components: description: Name of the earnings order type: string statutoryDeductionCategory: - $ref: '#/components/schemas/StatutoryDeductionCategory' + $ref: "#/components/schemas/StatutoryDeductionCategory" liabilityAccountId: description: Xero identifier for Liability Account type: string @@ -6411,22 +6411,22 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" statutoryDeductions: type: array items: - $ref: '#/components/schemas/EarningsOrder' + $ref: "#/components/schemas/EarningsOrder" EarningsOrderObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" statutoryDeduction: - $ref: '#/components/schemas/EarningsOrder' + $ref: "#/components/schemas/EarningsOrder" EarningsOrder: type: object required: @@ -6440,7 +6440,7 @@ components: description: Name of the earning order type: string statutoryDeductionCategory: - $ref: '#/components/schemas/StatutoryDeductionCategory' + $ref: "#/components/schemas/StatutoryDeductionCategory" liabilityAccountId: description: Xero identifier for Liability Account type: string @@ -6453,22 +6453,22 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" earningsRates: type: array items: - $ref: '#/components/schemas/EarningsRate' + $ref: "#/components/schemas/EarningsRate" EarningsRateObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" earningsRate: - $ref: '#/components/schemas/EarningsRate' + $ref: "#/components/schemas/EarningsRate" EarningsRate: type: object required: @@ -6550,22 +6550,22 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" leaveTypes: type: array items: - $ref: '#/components/schemas/LeaveType' + $ref: "#/components/schemas/LeaveType" LeaveTypeObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" leaveType: - $ref: '#/components/schemas/LeaveType' + $ref: "#/components/schemas/LeaveType" LeaveType: type: object required: @@ -6605,22 +6605,22 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" reimbursements: type: array items: - $ref: '#/components/schemas/Reimbursement' + $ref: "#/components/schemas/Reimbursement" ReimbursementObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" reimbursement: - $ref: '#/components/schemas/Reimbursement' + $ref: "#/components/schemas/Reimbursement" Reimbursement: type: object required: @@ -6645,22 +6645,22 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" timesheets: type: array items: - $ref: '#/components/schemas/Timesheet' + $ref: "#/components/schemas/Timesheet" TimesheetObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" timesheet: - $ref: '#/components/schemas/Timesheet' + $ref: "#/components/schemas/Timesheet" Timesheet: type: object required: @@ -6708,20 +6708,20 @@ components: format: date-time x-is-datetime: true timesheetLines: - $ref: '#/components/schemas/TimesheetLines' + $ref: "#/components/schemas/TimesheetLines" TimesheetLines: type: array items: - $ref: '#/components/schemas/TimesheetLine' + $ref: "#/components/schemas/TimesheetLine" TimesheetLineObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" timesheetLine: - $ref: '#/components/schemas/TimesheetLine' + $ref: "#/components/schemas/TimesheetLine" TimesheetLine: type: object required: @@ -6754,22 +6754,22 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" payRunCalendars: type: array items: - $ref: '#/components/schemas/PayRunCalendar' + $ref: "#/components/schemas/PayRunCalendar" PayRunCalendarObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" payRunCalendar: - $ref: '#/components/schemas/PayRunCalendar' + $ref: "#/components/schemas/PayRunCalendar" PayRunCalendar: type: object required: @@ -6819,11 +6819,11 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" paymentMethod: - $ref: '#/components/schemas/PaymentMethod' + $ref: "#/components/schemas/PaymentMethod" PaymentMethod: type: object required: @@ -6839,27 +6839,27 @@ components: bankAccounts: type: array items: - $ref: '#/components/schemas/BankAccount' + $ref: "#/components/schemas/BankAccount" SalaryAndWages: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" salaryAndWages: type: array items: - $ref: '#/components/schemas/SalaryAndWage' + $ref: "#/components/schemas/SalaryAndWage" SalaryAndWageObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" salaryAndWages: - $ref: '#/components/schemas/SalaryAndWage' + $ref: "#/components/schemas/SalaryAndWage" SalaryAndWage: type: object required: @@ -6916,22 +6916,22 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" payRuns: type: array items: - $ref: '#/components/schemas/PayRun' + $ref: "#/components/schemas/PayRun" PayRunObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" payRun: - $ref: '#/components/schemas/PayRun' + $ref: "#/components/schemas/PayRun" PayRun: type: object properties: @@ -6997,27 +6997,27 @@ components: paySlips: type: array items: - $ref: '#/components/schemas/Payslip' + $ref: "#/components/schemas/Payslip" PayslipObject: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" paySlip: - $ref: '#/components/schemas/Payslip' + $ref: "#/components/schemas/Payslip" Payslips: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" paySlips: type: array items: - $ref: '#/components/schemas/Payslip' + $ref: "#/components/schemas/Payslip" Payslip: type: object properties: @@ -7091,31 +7091,31 @@ components: - Electronically - Manual earningsLines: - $ref: '#/components/schemas/EarningsLines' + $ref: "#/components/schemas/EarningsLines" leaveEarningsLines: - $ref: '#/components/schemas/LeaveEarningsLines' + $ref: "#/components/schemas/LeaveEarningsLines" timesheetEarningsLines: - $ref: '#/components/schemas/TimesheetEarningsLines' + $ref: "#/components/schemas/TimesheetEarningsLines" deductionLines: - $ref: '#/components/schemas/DeductionLines' + $ref: "#/components/schemas/DeductionLines" reimbursementLines: - $ref: '#/components/schemas/ReimbursementLines' + $ref: "#/components/schemas/ReimbursementLines" leaveAccrualLines: - $ref: '#/components/schemas/LeaveAccrualLines' + $ref: "#/components/schemas/LeaveAccrualLines" benefitLines: - $ref: '#/components/schemas/BenefitLines' + $ref: "#/components/schemas/BenefitLines" paymentLines: - $ref: '#/components/schemas/PaymentLines' + $ref: "#/components/schemas/PaymentLines" employeeTaxLines: - $ref: '#/components/schemas/TaxLines' + $ref: "#/components/schemas/TaxLines" employerTaxLines: - $ref: '#/components/schemas/TaxLines' + $ref: "#/components/schemas/TaxLines" courtOrderLines: - $ref: '#/components/schemas/CourtOrderLines' + $ref: "#/components/schemas/CourtOrderLines" EarningsLines: type: array items: - $ref: '#/components/schemas/EarningsLine' + $ref: "#/components/schemas/EarningsLine" EarningsLine: type: object properties: @@ -7155,7 +7155,7 @@ components: LeaveEarningsLines: type: array items: - $ref: '#/components/schemas/LeaveEarningsLine' + $ref: "#/components/schemas/LeaveEarningsLine" LeaveEarningsLine: type: object properties: @@ -7185,7 +7185,7 @@ components: TimesheetEarningsLines: type: array items: - $ref: '#/components/schemas/TimesheetEarningsLine' + $ref: "#/components/schemas/TimesheetEarningsLine" TimesheetEarningsLine: type: object properties: @@ -7215,7 +7215,7 @@ components: DeductionLines: type: array items: - $ref: '#/components/schemas/DeductionLine' + $ref: "#/components/schemas/DeductionLine" DeductionLine: type: object properties: @@ -7237,7 +7237,7 @@ components: ReimbursementLines: type: array items: - $ref: '#/components/schemas/ReimbursementLine' + $ref: "#/components/schemas/ReimbursementLine" ReimbursementLine: type: object properties: @@ -7256,7 +7256,7 @@ components: LeaveAccrualLines: type: array items: - $ref: '#/components/schemas/LeaveAccrualLine' + $ref: "#/components/schemas/LeaveAccrualLine" LeaveAccrualLine: type: object properties: @@ -7271,7 +7271,7 @@ components: BenefitLines: type: array items: - $ref: '#/components/schemas/BenefitLine' + $ref: "#/components/schemas/BenefitLine" BenefitLine: type: object properties: @@ -7297,7 +7297,7 @@ components: PaymentLines: type: array items: - $ref: '#/components/schemas/PaymentLine' + $ref: "#/components/schemas/PaymentLine" PaymentLine: type: object properties: @@ -7321,7 +7321,7 @@ components: TaxLines: type: array items: - $ref: '#/components/schemas/TaxLine' + $ref: "#/components/schemas/TaxLine" TaxLine: type: object properties: @@ -7348,7 +7348,7 @@ components: CourtOrderLines: type: array items: - $ref: '#/components/schemas/CourtOrderLine' + $ref: "#/components/schemas/CourtOrderLine" CourtOrderLine: type: object properties: @@ -7364,18 +7364,18 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" settings: - $ref: '#/components/schemas/Accounts' + $ref: "#/components/schemas/Accounts" Accounts: type: object properties: accounts: type: array items: - $ref: '#/components/schemas/Account' + $ref: "#/components/schemas/Account" Account: type: object properties: @@ -7430,7 +7430,7 @@ components: BankAccounts: type: array items: - $ref: '#/components/schemas/BankAccount' + $ref: "#/components/schemas/BankAccount" BankAccount: type: object required: @@ -7451,11 +7451,11 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" problem: - $ref: '#/components/schemas/Problem' + $ref: "#/components/schemas/Problem" trackingCategories: - $ref: '#/components/schemas/TrackingCategory' + $ref: "#/components/schemas/TrackingCategory" TrackingCategory: type: object properties: @@ -7502,7 +7502,7 @@ components: example: 2024-12-02 x-is-date: true niCategory: - $ref: '#/components/schemas/NICategoryLetter' + $ref: "#/components/schemas/NICategoryLetter" niCategoryID: description: Xero unique identifier for the NI category type: number diff --git a/xero-projects.yaml b/xero-projects.yaml index b7dc8e18..faa3f1c2 100644 --- a/xero-projects.yaml +++ b/xero-projects.yaml @@ -17,7 +17,7 @@ servers: paths: /Projects: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -78,7 +78,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Projects' + $ref: "#/components/schemas/Projects" example: pagination: page: 1 @@ -134,7 +134,7 @@ paths: value: 99.99 status: INPROGRESS "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" post: security: - OAuth2: @@ -143,7 +143,7 @@ paths: - Project summary: Create one or more new projects parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" operationId: createProject requestBody: required: true @@ -151,7 +151,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ProjectCreateOrUpdate' + $ref: "#/components/schemas/ProjectCreateOrUpdate" example: '{ "contactId": "00000000-0000-0000-000-000000000000", "name": "New Kitchen", "deadlineUtc": "2019-12-10T12:59:59Z", "estimateAmount": "99.99" }' responses: "201": @@ -159,7 +159,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" example: projectId: ed957eee-bc6f-4f52-a663-aa42e6af9620 contactId: 216830cb-9a68-487e-928b-c1a7ccc4fc81 @@ -209,10 +209,10 @@ paths: value: 99.99 status: INPROGRESS "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" /Projects/{projectId}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -238,7 +238,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" example: projectId: b021e7cb-1903-4292-b48b-5b27b4271e3e contactId: 216830cb-9a68-487e-928b-c1a7ccc4fc81 @@ -288,7 +288,7 @@ paths: value: 99.99 status: INPROGRESS "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" put: security: - OAuth2: @@ -299,7 +299,7 @@ paths: operationId: updateProject description: Allows you to update a specific projects. parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: projectId x-snake: project_id in: path @@ -314,14 +314,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ProjectCreateOrUpdate' + $ref: "#/components/schemas/ProjectCreateOrUpdate" example: '{ "name": "New Kitchen", "deadlineUtc": "2017-04-23T18:25:43.511Z", "estimateAmount": 99.99 }' responses: "204": description: Success - return response 204 no content x-isEmpty: true "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" patch: security: - OAuth2: @@ -332,7 +332,7 @@ paths: operationId: patchProject description: Allows you to update a specific projects. parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: projectId x-snake: project_id in: path @@ -347,17 +347,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ProjectPatch' + $ref: "#/components/schemas/ProjectPatch" example: '{ "status": "INPROGRESS" }' responses: "204": description: Success - return response 204 no content x-isEmpty: true "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" /ProjectsUsers: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -394,7 +394,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ProjectUsers' + $ref: "#/components/schemas/ProjectUsers" example: pagination: page: 1 @@ -409,10 +409,10 @@ paths: name: API Team email: api@xero.com "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" /Projects/{projectId}/Tasks: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -452,14 +452,14 @@ paths: schema: type: string - name: chargeType - $ref: '#/components/parameters/chargeType' + $ref: "#/components/parameters/chargeType" responses: "200": description: OK/success, returns a list of task objects content: application/json: schema: - $ref: '#/components/schemas/Tasks' + $ref: "#/components/schemas/Tasks" example: pagination: page: 1 @@ -491,7 +491,7 @@ paths: currency: AUD value: 0.0 "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" post: security: - OAuth2: @@ -502,7 +502,7 @@ paths: operationId: createTask description: Allows you to create a specific task parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: projectId x-snake: project_id in: path @@ -517,7 +517,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TaskCreateOrUpdate' + $ref: "#/components/schemas/TaskCreateOrUpdate" example: '{ "status": "INPROGRESS" }' responses: "201": @@ -525,7 +525,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" example: name: Demolition rate: @@ -551,10 +551,10 @@ paths: currency: AUD value: 0 "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" /Projects/{projectId}/Tasks/{taskId}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -588,7 +588,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" example: name: Demolition rate: @@ -614,7 +614,7 @@ paths: currency: AUD value: 0 "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" put: security: - OAuth2: @@ -625,7 +625,7 @@ paths: operationId: updateTask description: Allows you to update a specific task parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: projectId x-snake: project_id in: path @@ -648,14 +648,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TaskCreateOrUpdate' + $ref: "#/components/schemas/TaskCreateOrUpdate" example: "" responses: "204": description: OK/Success - return response 204 no content x-isEmpty: true "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" delete: security: - OAuth2: @@ -687,10 +687,10 @@ paths: description: Success - return response 204 no content x-isEmpty: true "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" /Projects/{projectId}/Time: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -784,7 +784,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TimeEntries' + $ref: "#/components/schemas/TimeEntries" example: pagination: page: 1 @@ -811,7 +811,7 @@ paths: description: My description status: ACTIVE "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" post: security: - OAuth2: @@ -822,7 +822,7 @@ paths: operationId: createTimeEntry description: Allows you to create a specific task parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: projectId x-snake: project_id in: path @@ -837,7 +837,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TimeEntryCreateOrUpdate' + $ref: "#/components/schemas/TimeEntryCreateOrUpdate" example: userId: 00000000-0000-0000-0000-000000000000 taskId: 00000000-0000-0000-0000-000000000000 @@ -850,7 +850,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TimeEntry' + $ref: "#/components/schemas/TimeEntry" example: timeEntryId: c6539534-f1d2-43a6-80df-3bd1f8aca24d userId: c6539534-f1d2-43a6-80df-3bd1f8aca24d @@ -862,10 +862,10 @@ paths: description: My description status: ACTIVE "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" /Projects/{projectId}/Time/{timeEntryId}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -899,7 +899,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TimeEntry' + $ref: "#/components/schemas/TimeEntry" example: timeEntryId: 3cd35eca-704f-4bca-b258-236028ae8ed1 userId: 740add2a-a703-4b8a-a670-1093919c2040 @@ -911,7 +911,7 @@ paths: description: My description status: ACTIVE "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" put: security: - OAuth2: @@ -922,7 +922,7 @@ paths: operationId: updateTimeEntry description: Allows you to update time entry in a project parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: projectId x-snake: project_id in: path @@ -945,7 +945,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TimeEntryCreateOrUpdate' + $ref: "#/components/schemas/TimeEntryCreateOrUpdate" example: userId: 00000000-0000-0000-0000-000000000000 taskId: 00000000-0000-0000-0000-000000000000 @@ -957,7 +957,7 @@ paths: description: Success - return response 204 no content x-isEmpty: true "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" delete: security: - OAuth2: @@ -989,7 +989,7 @@ paths: description: Success - return response 204 no content x-isEmpty: true "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" components: securitySchemes: OAuth2: @@ -1019,7 +1019,7 @@ components: name: chargeType x-snake: charge_type schema: - $ref: '#/components/schemas/ChargeType' + $ref: "#/components/schemas/ChargeType" idempotencyKey: in: header name: Idempotency-Key @@ -1035,11 +1035,11 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" items: type: array items: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" ProjectCreateOrUpdate: externalDocs: url: https://developer.xero.com/documentation/projects/projects @@ -1074,7 +1074,7 @@ components: type: object properties: status: - $ref: '#/components/schemas/ProjectStatus' + $ref: "#/components/schemas/ProjectStatus" type: string required: - status @@ -1100,52 +1100,52 @@ components: example: New Kitchen description: Name of the project. currencyCode: - $ref: '#/components/schemas/CurrencyCode' + $ref: "#/components/schemas/CurrencyCode" type: string minutesLogged: type: integer example: 0 description: A total of minutes logged against all tasks on the Project. totalTaskAmount: - $ref: '#/components/schemas/Amount' + $ref: "#/components/schemas/Amount" totalExpenseAmount: - $ref: '#/components/schemas/Amount' + $ref: "#/components/schemas/Amount" estimateAmount: - $ref: '#/components/schemas/Amount' + $ref: "#/components/schemas/Amount" minutesToBeInvoiced: type: integer example: 0 description: Minutes which have not been invoiced across all chargeable tasks in the project. taskAmountToBeInvoiced: - $ref: '#/components/schemas/Amount' + $ref: "#/components/schemas/Amount" taskAmountInvoiced: - $ref: '#/components/schemas/Amount' + $ref: "#/components/schemas/Amount" expenseAmountToBeInvoiced: - $ref: '#/components/schemas/Amount' + $ref: "#/components/schemas/Amount" expenseAmountInvoiced: - $ref: '#/components/schemas/Amount' + $ref: "#/components/schemas/Amount" projectAmountInvoiced: - $ref: '#/components/schemas/Amount' + $ref: "#/components/schemas/Amount" deposit: - $ref: '#/components/schemas/Amount' + $ref: "#/components/schemas/Amount" depositApplied: - $ref: '#/components/schemas/Amount' + $ref: "#/components/schemas/Amount" creditNoteAmount: - $ref: '#/components/schemas/Amount' + $ref: "#/components/schemas/Amount" deadlineUtc: type: string format: date-time example: "2019-12-10T12:59:59Z" description: Deadline for the project. UTC Date Time in ISO-8601 format. totalInvoiced: - $ref: '#/components/schemas/Amount' + $ref: "#/components/schemas/Amount" totalToBeInvoiced: - $ref: '#/components/schemas/Amount' + $ref: "#/components/schemas/Amount" estimate: - $ref: '#/components/schemas/Amount' + $ref: "#/components/schemas/Amount" status: type: string - $ref: '#/components/schemas/ProjectStatus' + $ref: "#/components/schemas/ProjectStatus" required: - name Pagination: @@ -1172,11 +1172,11 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" items: type: array items: - $ref: '#/components/schemas/ProjectUser' + $ref: "#/components/schemas/ProjectUser" ProjectUser: externalDocs: url: https://developer.xero.com/documentation/projects/users @@ -1199,7 +1199,7 @@ components: type: object properties: currency: - $ref: '#/components/schemas/CurrencyCode' + $ref: "#/components/schemas/CurrencyCode" type: string value: type: number @@ -1398,11 +1398,11 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" items: type: array items: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" Task: externalDocs: url: https://developer.xero.com/documentation/projects/projects @@ -1417,10 +1417,10 @@ components: type: string description: Name of the task. rate: - $ref: '#/components/schemas/Amount' + $ref: "#/components/schemas/Amount" type: number chargeType: - $ref: '#/components/schemas/ChargeType' + $ref: "#/components/schemas/ChargeType" type: string estimateMinutes: type: integer @@ -1434,7 +1434,7 @@ components: type: integer description: Total minutes which have been logged against the task. Logged by assigning a time entry to a task totalAmount: - $ref: '#/components/schemas/Amount' + $ref: "#/components/schemas/Amount" type: number minutesInvoiced: type: integer @@ -1449,10 +1449,10 @@ components: type: integer description: Minutes logged against this task if its charge type is `NON_CHARGEABLE`. amountToBeInvoiced: - $ref: '#/components/schemas/Amount' + $ref: "#/components/schemas/Amount" type: number amountInvoiced: - $ref: '#/components/schemas/Amount' + $ref: "#/components/schemas/Amount" type: number status: type: string @@ -1478,10 +1478,10 @@ components: description: Name of the task. Max length 100 characters. maximum: 100 rate: - $ref: '#/components/schemas/Amount' + $ref: "#/components/schemas/Amount" type: number chargeType: - $ref: '#/components/schemas/ChargeType' + $ref: "#/components/schemas/ChargeType" type: string estimateMinutes: type: integer @@ -1496,11 +1496,11 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" items: type: array items: - $ref: '#/components/schemas/TimeEntry' + $ref: "#/components/schemas/TimeEntry" TimeEntry: externalDocs: url: https://developer.xero.com/documentation/projects/time @@ -1583,4 +1583,4 @@ components: content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" diff --git a/xero-webhooks.yaml b/xero-webhooks.yaml index bf9c88c8..caba199b 100644 --- a/xero-webhooks.yaml +++ b/xero-webhooks.yaml @@ -23,12 +23,12 @@ webhooks: content: application/json: schema: - $ref: '#/components/schemas/WebhookEvent' + $ref: "#/components/schemas/WebhookEvent" responses: "200": - $ref: '#/components/responses/200WebhookDataReceivedOk' + $ref: "#/components/responses/200WebhookDataReceivedOk" "401": - $ref: '#/components/responses/401InvalidWebhookData' + $ref: "#/components/responses/401InvalidWebhookData" subscriptions: post: summary: Subscriptions Webhook Endpoint @@ -40,12 +40,12 @@ webhooks: content: application/json: schema: - $ref: '#/components/schemas/WebhookEvent' + $ref: "#/components/schemas/WebhookEvent" responses: "200": - $ref: '#/components/responses/200WebhookDataReceivedOk' + $ref: "#/components/responses/200WebhookDataReceivedOk" "401": - $ref: '#/components/responses/401InvalidWebhookData' + $ref: "#/components/responses/401InvalidWebhookData" contacts: post: summary: Contacts Webhook Endpoint @@ -57,19 +57,19 @@ webhooks: content: application/json: schema: - $ref: '#/components/schemas/WebhookEvent' + $ref: "#/components/schemas/WebhookEvent" responses: "200": - $ref: '#/components/responses/200WebhookDataReceivedOk' + $ref: "#/components/responses/200WebhookDataReceivedOk" "401": - $ref: '#/components/responses/401InvalidWebhookData' + $ref: "#/components/responses/401InvalidWebhookData" components: headers: x-xero-signature: description: A hashed signature of the payload is passed along in the headers of each request as x-xero-signature schema: type: string - example: + example: "" schemas: WebhookEvent: required: @@ -137,11 +137,11 @@ components: description: Return a 200 status to indicate that the webhook subscription succeeded headers: x-xero-signature: - $ref: '#/components/headers/x-xero-signature' + $ref: "#/components/headers/x-xero-signature" content: application/json: schema: - $ref: '#/components/schemas/WebhookEvent' + $ref: "#/components/schemas/WebhookEvent" example: events: - resourceUrl: https://api.xero.com/api.xro/2.0/Contacts/717f2bfc-c6d4-41fd-b238-3f2f0c0cf777 diff --git a/xero_accounting.yaml b/xero_accounting.yaml index b129bb95..5c2b6824 100644 --- a/xero_accounting.yaml +++ b/xero_accounting.yaml @@ -13,7 +13,7 @@ servers: paths: /Accounts: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" type: string get: security: @@ -25,7 +25,7 @@ paths: operationId: getAccounts summary: Retrieves the full chart of accounts parameters: - - $ref: '#/components/parameters/ifModifiedSince' + - $ref: "#/components/parameters/ifModifiedSince" - in: query name: where description: Filter by an any element @@ -48,7 +48,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Accounts' + $ref: "#/components/schemas/Accounts" example: Accounts: - AccountID: ebd06280-af70-4bed-97c6-7451a454ad85 @@ -76,7 +76,7 @@ paths: operationId: createAccount summary: Creates a new chart of accounts parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" x-hasAccountingValidationError: true x-example: - object: @@ -117,7 +117,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Accounts' + $ref: "#/components/schemas/Accounts" example: Id: 11814c9d-3b5e-492e-93b0-fad16bf3244f Status: OK @@ -142,7 +142,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: ErrorNumber: 10 Type: ValidationException @@ -161,7 +161,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Account' + $ref: "#/components/schemas/Account" example: Code: "123456" Name: Foobar @@ -169,7 +169,7 @@ paths: Description: Hello World /Accounts/{AccountID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -180,14 +180,14 @@ paths: operationId: getAccount summary: Retrieves a single chart of accounts by using a unique account Id parameters: - - $ref: '#/components/parameters/AccountID' + - $ref: "#/components/parameters/AccountID" responses: "200": description: Success - return response of type Accounts array with one Account content: application/json: schema: - $ref: '#/components/schemas/Accounts' + $ref: "#/components/schemas/Accounts" example: Id: 323455cc-9511-4451-a873-248d2983f38e Status: OK @@ -268,15 +268,15 @@ paths: csharp: Account object: account parameters: - - $ref: '#/components/parameters/AccountID' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/AccountID" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - update existing Account and return response of type Accounts array with updated Account content: application/json: schema: - $ref: '#/components/schemas/Accounts' + $ref: "#/components/schemas/Accounts" example: Id: 9012e75c-ec08-40a9-ae15-153fc1f35c4d Status: OK @@ -301,7 +301,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: ErrorNumber: 10 Type: ValidationException @@ -320,7 +320,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Accounts' + $ref: "#/components/schemas/Accounts" example: Accounts: - Code: "123456" @@ -345,14 +345,14 @@ paths: x-hasAccountingValidationError: true summary: Deletes a chart of accounts parameters: - - $ref: '#/components/parameters/AccountID' + - $ref: "#/components/parameters/AccountID" responses: "200": description: Success - delete existing Account and return response of type Accounts array with deleted Account content: application/json: schema: - $ref: '#/components/schemas/Accounts' + $ref: "#/components/schemas/Accounts" example: Id: 76bb0543-8efe-4acc-b7f6-67dfcdec37b4 Status: OK @@ -377,7 +377,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: ErrorNumber: 10 Type: ValidationException @@ -392,7 +392,7 @@ paths: - Message: Please enter a unique Name. /Accounts/{AccountID}/Attachments: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -403,7 +403,7 @@ paths: operationId: getAccountAttachments summary: Retrieves attachments for a specific accounts by using a unique account Id parameters: - - $ref: '#/components/parameters/AccountID' + - $ref: "#/components/parameters/AccountID" responses: "200": description: Success - return response of type Attachments array of Attachment @@ -411,7 +411,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: 439c1573-3cd8-4697-a9f6-81fa651ee8f3 Status: OK @@ -425,7 +425,7 @@ paths: ContentLength: 2878711 /Accounts/{AccountID}/Attachments/{AttachmentID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -436,9 +436,9 @@ paths: operationId: getAccountAttachmentById summary: Retrieves a specific attachment from a specific account using a unique attachment Id parameters: - - $ref: '#/components/parameters/AccountID' - - $ref: '#/components/parameters/AttachmentID' - - $ref: '#/components/parameters/ContentType' + - $ref: "#/components/parameters/AccountID" + - $ref: "#/components/parameters/AttachmentID" + - $ref: "#/components/parameters/ContentType" responses: "200": description: Success - return response of attachment for Account as binary data @@ -449,7 +449,7 @@ paths: format: binary /Accounts/{AccountID}/Attachments/{FileName}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -460,9 +460,9 @@ paths: operationId: getAccountAttachmentByFileName summary: Retrieves an attachment for a specific account by filename parameters: - - $ref: '#/components/parameters/AccountID' - - $ref: '#/components/parameters/FileName' - - $ref: '#/components/parameters/ContentType' + - $ref: "#/components/parameters/AccountID" + - $ref: "#/components/parameters/FileName" + - $ref: "#/components/parameters/ContentType" responses: "200": description: Success - return response of attachment for Account as binary data @@ -481,9 +481,9 @@ paths: x-hasAccountingValidationError: true summary: Updates attachment on a specific account by filename parameters: - - $ref: '#/components/parameters/AccountID' - - $ref: '#/components/parameters/FileName' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/AccountID" + - $ref: "#/components/parameters/FileName" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type Attachments array of Attachment @@ -491,7 +491,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: c8d6413a-1da2-4faa-9848-21f60443e906 Status: OK @@ -508,7 +508,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" requestBody: required: true description: Byte array of file in body of request @@ -527,9 +527,9 @@ paths: x-hasAccountingValidationError: true summary: Creates an attachment on a specific account parameters: - - $ref: '#/components/parameters/AccountID' - - $ref: '#/components/parameters/FileName' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/AccountID" + - $ref: "#/components/parameters/FileName" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type Attachments array of Attachment @@ -537,7 +537,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: 724cdff5-bcd1-4c5c-977e-e864c24258e0 Status: OK @@ -550,7 +550,7 @@ paths: MimeType: image/jpg ContentLength: 2878711 "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: Byte array of file in body of request @@ -561,7 +561,7 @@ paths: format: byte /BatchPayments: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" description: Batch payments allow you to bundle multiple bills or invoices into one payment transaction. This means a single payment in Xero can be reconciled with a single transaction on the bank statement making for a much simpler bank reconciliation experience. get: security: @@ -573,7 +573,7 @@ paths: operationId: getBatchPayments summary: Retrieves either one or many batch payments for invoices parameters: - - $ref: '#/components/parameters/ifModifiedSince' + - $ref: "#/components/parameters/ifModifiedSince" - in: query name: where description: Filter by an any element @@ -596,7 +596,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BatchPayments' + $ref: "#/components/schemas/BatchPayments" example: Id: 6ab84949-4fe5-4788-a135-4d8f690d24d7 Status: OK @@ -700,10 +700,10 @@ paths: default: LocalDate.now() java: LocalDate.now() csharp: DateTime.Now - node: '''2020-12-10''' + node: "'2020-12-10'" php: new DateTime('2020-12-10') python: dateutil.parser.parse('2020-12-03T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - paymentAccount: is_object: true key: paymentAccount @@ -841,15 +841,15 @@ paths: csharp: BatchPayment object: batchPayment parameters: - - $ref: '#/components/parameters/summarizeErrors' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/summarizeErrors" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type BatchPayments array of BatchPayment objects content: application/json: schema: - $ref: '#/components/schemas/BatchPayments' + $ref: "#/components/schemas/BatchPayments" example: Id: 424745ed-6356-46ad-87d4-3585f9062fb4 Status: OK @@ -909,14 +909,14 @@ paths: UpdatedDateUTC: /Date(1550865987783+0000)/ IsReconciled: false "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: BatchPayments with an array of Payments in body of request content: application/json: schema: - $ref: '#/components/schemas/BatchPayments' + $ref: "#/components/schemas/BatchPayments" example: BatchPayments: - Account: @@ -942,7 +942,7 @@ paths: operationId: deleteBatchPayment summary: Updates a specific batch payment for invoices and credit notes parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" x-hasAccountingValidationError: true x-example: - batchPaymentDelete: @@ -969,7 +969,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BatchPayments' + $ref: "#/components/schemas/BatchPayments" example: Id: ee23328c-4a8b-4ee7-8fb6-9796ffab9cb0 Status: OK @@ -989,19 +989,19 @@ paths: UpdatedDateUTC: /Date(1659377631813+0000)/ IsReconciled: false "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/BatchPaymentDelete' + $ref: "#/components/schemas/BatchPaymentDelete" example: BatchPaymentID: 9bf296e9-0748-4d29-a3dc-24dde1098030 Status: DELETED /BatchPayments/{BatchPaymentID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -1012,14 +1012,14 @@ paths: operationId: getBatchPayment summary: Retrieves a specific batch payment using a unique batch payment Id parameters: - - $ref: '#/components/parameters/BatchPaymentID' + - $ref: "#/components/parameters/BatchPaymentID" responses: "200": description: Success - return response of type BatchPayments array with matching batch payment Id content: application/json: schema: - $ref: '#/components/schemas/BatchPayments' + $ref: "#/components/schemas/BatchPayments" example: Id: 6ab84949-4fe5-4788-a135-4d8f690d24d7 Status: OK @@ -1088,15 +1088,15 @@ paths: operationId: deleteBatchPaymentByUrlParam summary: Updates a specific batch payment for invoices and credit notes parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/BatchPaymentID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/BatchPaymentID" responses: "200": description: Success - return response of type BatchPayments array for updated BatchPayment content: application/json: schema: - $ref: '#/components/schemas/BatchPayments' + $ref: "#/components/schemas/BatchPayments" example: Id: ee23328c-4a8b-4ee7-8fb6-9796ffab9cb0 Status: OK @@ -1116,18 +1116,18 @@ paths: UpdatedDateUTC: /Date(1659377631813+0000)/ IsReconciled: false "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/BatchPaymentDeleteByUrlParam' + $ref: "#/components/schemas/BatchPaymentDeleteByUrlParam" example: Status: DELETED /BatchPayments/{BatchPaymentID}/History: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -1138,14 +1138,14 @@ paths: operationId: getBatchPaymentHistory summary: Retrieves history from a specific batch payment parameters: - - $ref: '#/components/parameters/BatchPaymentID' + - $ref: "#/components/parameters/BatchPaymentID" responses: "200": description: Success - return response of HistoryRecords array of 0 to N HistoryRecord content: application/json: schema: - $ref: '#/components/schemas/HistoryRecords' + $ref: "#/components/schemas/HistoryRecords" example: Id: c58e2f9c-baad-42a4-8bb7-f32b6f88fa04 Status: OK @@ -1194,15 +1194,15 @@ paths: csharp: HistoryRecord object: historyRecord parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/BatchPaymentID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/BatchPaymentID" responses: "200": description: Success - return response of type HistoryRecords array of HistoryRecord objects content: application/json: schema: - $ref: '#/components/schemas/HistoryRecords' + $ref: "#/components/schemas/HistoryRecords" example: Id: d7525479-3392-44c0-bb37-ff4a0b5df5bd Status: OK @@ -1214,12 +1214,12 @@ paths: Details: Hello World ValidationErrors: [] "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: - $ref: '#/components/requestBodies/historyRecords' + $ref: "#/components/requestBodies/historyRecords" /BankTransactions: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -1230,7 +1230,7 @@ paths: operationId: getBankTransactions summary: Retrieves any spent or received money transactions parameters: - - $ref: '#/components/parameters/ifModifiedSince' + - $ref: "#/components/parameters/ifModifiedSince" - in: query name: where description: Filter by an any element @@ -1253,15 +1253,15 @@ paths: example: 1 schema: type: integer - - $ref: '#/components/parameters/unitdp' - - $ref: '#/components/parameters/pageSize' + - $ref: "#/components/parameters/unitdp" + - $ref: "#/components/parameters/pageSize" responses: "200": description: Success - return response of type BankTransactions array with 0 to n BankTransaction content: application/json: schema: - $ref: '#/components/schemas/BankTransactions' + $ref: "#/components/schemas/BankTransactions" example: Id: 18e7e80c-5dca-4a57-974e-8b572cc5efe8 Status: OK @@ -1507,16 +1507,16 @@ paths: csharp: BankTransaction object: bankTransaction parameters: - - $ref: '#/components/parameters/summarizeErrors' - - $ref: '#/components/parameters/unitdp' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/summarizeErrors" + - $ref: "#/components/parameters/unitdp" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type BankTransactions array with new BankTransaction content: application/json: schema: - $ref: '#/components/schemas/BankTransactions' + $ref: "#/components/schemas/BankTransactions" example: Id: 5bc1d776-3c7f-4fe8-9b2d-09e747077a88 Status: OK @@ -1599,16 +1599,16 @@ paths: CurrencyCode: USD StatusAttributeString: ERROR ValidationErrors: - - Message: 'The Contact must contain at least 1 of the following elements to identify the contact: Name, ContactID, ContactNumber' + - Message: "The Contact must contain at least 1 of the following elements to identify the contact: Name, ContactID, ContactNumber" "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: BankTransactions with an array of BankTransaction objects in body of request content: application/json: schema: - $ref: '#/components/schemas/BankTransactions' + $ref: "#/components/schemas/BankTransactions" example: bankTransactions: - type: BankTransaction.TypeEnum.SPEND @@ -1764,16 +1764,16 @@ paths: csharp: BankTransaction object: bankTransaction parameters: - - $ref: '#/components/parameters/summarizeErrors' - - $ref: '#/components/parameters/unitdp' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/summarizeErrors" + - $ref: "#/components/parameters/unitdp" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type BankTransactions array with new BankTransaction content: application/json: schema: - $ref: '#/components/schemas/BankTransactions' + $ref: "#/components/schemas/BankTransactions" example: Id: 5bc1d776-3c7f-4fe8-9b2d-09e747077a88 Status: OK @@ -1856,15 +1856,15 @@ paths: CurrencyCode: USD StatusAttributeString: ERROR ValidationErrors: - - Message: 'The Contact must contain at least 1 of the following elements to identify the contact: Name, ContactID, ContactNumber' + - Message: "The Contact must contain at least 1 of the following elements to identify the contact: Name, ContactID, ContactNumber" "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/BankTransactions' + $ref: "#/components/schemas/BankTransactions" example: BankTransactions: - Type: SPEND @@ -1879,7 +1879,7 @@ paths: Code: "088" /BankTransactions/{BankTransactionID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -1890,15 +1890,15 @@ paths: operationId: getBankTransaction summary: Retrieves a single spent or received money transaction by using a unique bank transaction Id parameters: - - $ref: '#/components/parameters/BankTransactionID' - - $ref: '#/components/parameters/unitdp' + - $ref: "#/components/parameters/BankTransactionID" + - $ref: "#/components/parameters/unitdp" responses: "200": description: Success - return response of type BankTransactions array with a specific BankTransaction content: application/json: schema: - $ref: '#/components/schemas/BankTransactions' + $ref: "#/components/schemas/BankTransactions" example: Id: 612e204d-21ab-469b-ac84-afe0697b4461 Status: OK @@ -2139,16 +2139,16 @@ paths: csharp: BankTransaction object: bankTransaction parameters: - - $ref: '#/components/parameters/BankTransactionID' - - $ref: '#/components/parameters/unitdp' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/BankTransactionID" + - $ref: "#/components/parameters/unitdp" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type BankTransactions array with updated BankTransaction content: application/json: schema: - $ref: '#/components/schemas/BankTransactions' + $ref: "#/components/schemas/BankTransactions" example: Id: f2c7f037-96fc-49bd-8f59-d3c7bfdd4746 Status: OK @@ -2232,13 +2232,13 @@ paths: UpdatedDateUTC: /Date(1551213568733+0000)/ CurrencyCode: USD "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/BankTransactions' + $ref: "#/components/schemas/BankTransactions" example: BankTransactions: - Type: SPEND @@ -2302,7 +2302,7 @@ paths: UpdatedDateUTC: "2019-02-26T12:39:27.813-08:00" /BankTransactions/{BankTransactionID}/Attachments: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -2313,7 +2313,7 @@ paths: operationId: getBankTransactionAttachments summary: Retrieves any attachments from a specific bank transactions parameters: - - $ref: '#/components/parameters/BankTransactionID' + - $ref: "#/components/parameters/BankTransactionID" responses: "200": description: Success - return response of type Attachments array with 0 to n Attachment @@ -2321,7 +2321,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: c50798e1-29e9-4a30-a452-bb6e42e400c8 Status: OK @@ -2340,7 +2340,7 @@ paths: ContentLength: 2878711 /BankTransactions/{BankTransactionID}/Attachments/{AttachmentID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -2351,9 +2351,9 @@ paths: operationId: getBankTransactionAttachmentById summary: Retrieves specific attachments from a specific BankTransaction using a unique attachment Id parameters: - - $ref: '#/components/parameters/BankTransactionID' - - $ref: '#/components/parameters/AttachmentID' - - $ref: '#/components/parameters/ContentType' + - $ref: "#/components/parameters/BankTransactionID" + - $ref: "#/components/parameters/AttachmentID" + - $ref: "#/components/parameters/ContentType" responses: "200": description: Success - return response of attachment for BankTransaction as binary data @@ -2364,7 +2364,7 @@ paths: format: binary /BankTransactions/{BankTransactionID}/Attachments/{FileName}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -2375,9 +2375,9 @@ paths: operationId: getBankTransactionAttachmentByFileName summary: Retrieves a specific attachment from a specific bank transaction by filename parameters: - - $ref: '#/components/parameters/BankTransactionID' - - $ref: '#/components/parameters/FileName' - - $ref: '#/components/parameters/ContentType' + - $ref: "#/components/parameters/BankTransactionID" + - $ref: "#/components/parameters/FileName" + - $ref: "#/components/parameters/ContentType" responses: "200": description: Success - return response of attachment for BankTransaction as binary data @@ -2396,9 +2396,9 @@ paths: x-hasAccountingValidationError: true summary: Updates a specific attachment from a specific bank transaction by filename parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/BankTransactionID' - - $ref: '#/components/parameters/FileName' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/BankTransactionID" + - $ref: "#/components/parameters/FileName" responses: "200": description: Success - return response of Attachments array of Attachment @@ -2406,7 +2406,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: 572ad2fe-8c23-45aa-82f9-864485327685 Status: OK @@ -2419,7 +2419,7 @@ paths: MimeType: image/jpg ContentLength: 2878711 "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: Byte array of file in body of request @@ -2438,9 +2438,9 @@ paths: x-hasAccountingValidationError: true summary: Creates an attachment for a specific bank transaction by filename parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/BankTransactionID' - - $ref: '#/components/parameters/FileName' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/BankTransactionID" + - $ref: "#/components/parameters/FileName" responses: "200": description: Success - return response of Attachments array of Attachment @@ -2448,7 +2448,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: 572ad2fe-8c23-45aa-82f9-864485327685 Status: OK @@ -2461,7 +2461,7 @@ paths: MimeType: image/jpg ContentLength: 2878711 "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: Byte array of file in body of request @@ -2472,7 +2472,7 @@ paths: format: byte /BankTransactions/{BankTransactionID}/History: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -2483,10 +2483,10 @@ paths: operationId: getBankTransactionsHistory summary: Retrieves history from a specific bank transaction using a unique bank transaction Id parameters: - - $ref: '#/components/parameters/BankTransactionID' + - $ref: "#/components/parameters/BankTransactionID" responses: "200": - $ref: '#/components/responses/HistoryRetrieved' + $ref: "#/components/responses/HistoryRetrieved" put: security: - OAuth2: @@ -2524,18 +2524,18 @@ paths: csharp: HistoryRecord object: historyRecord parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/BankTransactionID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/BankTransactionID" responses: "200": - $ref: '#/components/responses/HistoryRecordCreated' + $ref: "#/components/responses/HistoryRecordCreated" "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: - $ref: '#/components/requestBodies/historyRecords' + $ref: "#/components/requestBodies/historyRecords" /BankTransfers: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -2546,7 +2546,7 @@ paths: operationId: getBankTransfers summary: Retrieves all bank transfers parameters: - - $ref: '#/components/parameters/ifModifiedSince' + - $ref: "#/components/parameters/ifModifiedSince" - in: query name: where description: Filter by an any element @@ -2565,7 +2565,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BankTransfers' + $ref: "#/components/schemas/BankTransfers" example: Id: dfc0d130-9007-4a98-a5ef-6f01700f18e2 Status: OK @@ -2617,7 +2617,7 @@ paths: operationId: createBankTransfer summary: Creates a bank transfer parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" x-hasAccountingValidationError: true x-example: - fromBankAccount: @@ -2694,7 +2694,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BankTransfers' + $ref: "#/components/schemas/BankTransfers" example: Id: ae767b68-affd-4e17-bac0-83eaf1854dcd Status: OK @@ -2721,14 +2721,14 @@ paths: CurrencyRate: 1.000000 ValidationErrors: [] "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: BankTransfers with array of BankTransfer objects in request body content: application/json: schema: - $ref: '#/components/schemas/BankTransfers' + $ref: "#/components/schemas/BankTransfers" example: BankTransfers: - FromBankAccount: @@ -2771,7 +2771,7 @@ paths: Reference: Sub 098801 /BankTransfers/{BankTransferID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -2782,14 +2782,14 @@ paths: operationId: getBankTransfer summary: Retrieves specific bank transfers by using a unique bank transfer Id parameters: - - $ref: '#/components/parameters/BankTransferID' + - $ref: "#/components/parameters/BankTransferID" responses: "200": description: Success - return response of BankTransfers array with one BankTransfer content: application/json: schema: - $ref: '#/components/schemas/BankTransfers' + $ref: "#/components/schemas/BankTransfers" example: Id: 1a5fa46d-5ece-4ef2-89b1-77c293b5d833 Status: OK @@ -2825,7 +2825,7 @@ paths: ContentLength: 2878711 /BankTransfers/{BankTransferID}/Attachments: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -2836,7 +2836,7 @@ paths: operationId: getBankTransferAttachments summary: Retrieves attachments from a specific bank transfer parameters: - - $ref: '#/components/parameters/BankTransferID' + - $ref: "#/components/parameters/BankTransferID" responses: "200": description: Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer @@ -2844,7 +2844,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: 5cb6b587-7b02-46b6-97fe-d8ad8f20321b Status: OK @@ -2858,7 +2858,7 @@ paths: ContentLength: 2878711 /BankTransfers/{BankTransferID}/Attachments/{AttachmentID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -2869,9 +2869,9 @@ paths: operationId: getBankTransferAttachmentById summary: Retrieves a specific attachment from a specific bank transfer using a unique attachment ID parameters: - - $ref: '#/components/parameters/BankTransferID' - - $ref: '#/components/parameters/AttachmentID' - - $ref: '#/components/parameters/ContentType' + - $ref: "#/components/parameters/BankTransferID" + - $ref: "#/components/parameters/AttachmentID" + - $ref: "#/components/parameters/ContentType" responses: "200": description: Success - return response of binary data from the Attachment to a Bank Transfer @@ -2882,7 +2882,7 @@ paths: format: binary /BankTransfers/{BankTransferID}/Attachments/{FileName}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -2893,9 +2893,9 @@ paths: operationId: getBankTransferAttachmentByFileName summary: Retrieves a specific attachment on a specific bank transfer by file name parameters: - - $ref: '#/components/parameters/BankTransferID' - - $ref: '#/components/parameters/FileName' - - $ref: '#/components/parameters/ContentType' + - $ref: "#/components/parameters/BankTransferID" + - $ref: "#/components/parameters/FileName" + - $ref: "#/components/parameters/ContentType" responses: "200": description: Success - return response of binary data from the Attachment to a Bank Transfer @@ -2913,9 +2913,9 @@ paths: operationId: updateBankTransferAttachmentByFileName x-hasAccountingValidationError: true parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/BankTransferID' - - $ref: '#/components/parameters/FileName' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/BankTransferID" + - $ref: "#/components/parameters/FileName" responses: "200": description: Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer @@ -2923,7 +2923,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: c7810140-19c2-4ff7-b3ec-b7e95ce7becf Status: OK @@ -2936,7 +2936,7 @@ paths: MimeType: image/jpg ContentLength: 2878711 "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: Byte array of file in body of request @@ -2954,9 +2954,9 @@ paths: operationId: createBankTransferAttachmentByFileName x-hasAccountingValidationError: true parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/BankTransferID' - - $ref: '#/components/parameters/FileName' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/BankTransferID" + - $ref: "#/components/parameters/FileName" responses: "200": description: Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer @@ -2964,7 +2964,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: b73ba149-76a9-4e7c-a5c6-b9230022f416 Status: OK @@ -2977,7 +2977,7 @@ paths: MimeType: image/jpg ContentLength: 2878711 "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: Byte array of file in body of request @@ -2988,7 +2988,7 @@ paths: format: byte /BankTransfers/{BankTransferID}/History: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -2999,10 +2999,10 @@ paths: operationId: getBankTransferHistory summary: Retrieves history from a specific bank transfer using a unique bank transfer Id parameters: - - $ref: '#/components/parameters/BankTransferID' + - $ref: "#/components/parameters/BankTransferID" responses: "200": - $ref: '#/components/responses/HistoryRetrieved' + $ref: "#/components/responses/HistoryRetrieved" put: security: - OAuth2: @@ -3040,18 +3040,18 @@ paths: csharp: HistoryRecord object: historyRecord parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/BankTransferID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/BankTransferID" responses: "200": - $ref: '#/components/responses/HistoryRecordCreated' + $ref: "#/components/responses/HistoryRecordCreated" "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: - $ref: '#/components/requestBodies/historyRecords' + $ref: "#/components/requestBodies/historyRecords" /BrandingThemes: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -3067,7 +3067,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BrandingThemes' + $ref: "#/components/schemas/BrandingThemes" example: Id: d1a1beea-bdfe-4ee4-9dbc-27226a26cd68 Status: OK @@ -3080,7 +3080,7 @@ paths: CreatedDateUTC: /Date(1464967643813+0000)/ /BrandingThemes/{BrandingThemeID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -3091,14 +3091,14 @@ paths: operationId: getBrandingTheme summary: Retrieves a specific branding theme using a unique branding theme Id parameters: - - $ref: '#/components/parameters/BrandingThemeID' + - $ref: "#/components/parameters/BrandingThemeID" responses: "200": description: Success - return response of type BrandingThemes with one BrandingTheme content: application/json: schema: - $ref: '#/components/schemas/BrandingThemes' + $ref: "#/components/schemas/BrandingThemes" example: Id: df671650-cf14-4a7f-b609-4166933719bc Status: OK @@ -3111,7 +3111,7 @@ paths: CreatedDateUTC: /Date(1464967643813+0000)/ /BrandingThemes/{BrandingThemeID}/PaymentServices: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -3122,14 +3122,14 @@ paths: summary: Retrieves the payment services for a specific branding theme x-excludeFromPreview: true parameters: - - $ref: '#/components/parameters/BrandingThemeID' + - $ref: "#/components/parameters/BrandingThemeID" responses: "200": description: Success - return response of type PaymentServices array with 0 to N PaymentService content: application/json: schema: - $ref: '#/components/schemas/PaymentServices' + $ref: "#/components/schemas/PaymentServices" example: Id: bfd5adbe-0e92-48f0-8c5a-39072f6c4ed3 Status: OK @@ -3199,15 +3199,15 @@ paths: csharp: PaymentService object: paymentService parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/BrandingThemeID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/BrandingThemeID" responses: "200": description: Success - return response of type PaymentServices array with newly created PaymentService content: application/json: schema: - $ref: '#/components/schemas/PaymentServices' + $ref: "#/components/schemas/PaymentServices" example: Id: 918feecb-067a-4ed9-841b-571c04eaada3 Status: OK @@ -3220,14 +3220,14 @@ paths: PaymentServiceType: Custom PayNowText: Pay Now "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: PaymentServices array with PaymentService object in body of request content: application/json: schema: - $ref: '#/components/schemas/PaymentServices' + $ref: "#/components/schemas/PaymentServices" example: PaymentServices: - PaymentServiceID: 54b3b4f6-0443-4fba-bcd1-61ec0c35ca55 @@ -3237,7 +3237,7 @@ paths: PayNowText: Time To Pay /Budgets: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -3253,9 +3253,9 @@ paths: description: Filter by BudgetID. Allows you to retrieve a specific individual budget. style: form explode: false - example: '"00000000-0000-0000-0000-000000000000"' + example: ""00000000-0000-0000-0000-000000000000"" x-example-java: UUID.fromString("00000000-0000-0000-0000-000000000000") - x-example-php: '"00000000-0000-0000-0000-000000000000"' + x-example-php: ""00000000-0000-0000-0000-000000000000"" x-example-csharp: Guid.Parse("00000000-0000-0000-0000-000000000000"); schema: type: string @@ -3284,7 +3284,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Budgets' + $ref: "#/components/schemas/Budgets" example: Id: 04e93d48-e72f-4775-b7dd-15a041fab972 Status: OK @@ -3307,7 +3307,7 @@ paths: Tracking: [] /Budgets/{BudgetID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -3317,7 +3317,7 @@ paths: operationId: getBudget summary: Retrieves a specific budget, which includes budget lines parameters: - - $ref: '#/components/parameters/BudgetID' + - $ref: "#/components/parameters/BudgetID" - in: query name: DateTo x-snake: date_to @@ -3340,7 +3340,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Budgets' + $ref: "#/components/schemas/Budgets" example: Id: 04e93d48-e72f-4775-b7dd-15a041fab972 Status: OK @@ -3387,7 +3387,7 @@ paths: Notes: "" /Contacts: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -3398,7 +3398,7 @@ paths: operationId: getContacts summary: Retrieves all contacts in a Xero organisation parameters: - - $ref: '#/components/parameters/ifModifiedSince' + - $ref: "#/components/parameters/ifModifiedSince" - in: query name: where description: Filter by an any element @@ -3421,9 +3421,9 @@ paths: description: Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call. style: form explode: false - example: '"00000000-0000-0000-0000-000000000000"' + example: ""00000000-0000-0000-0000-000000000000"" x-example-java: Arrays.asList(UUID.fromString("00000000-0000-0000-0000-000000000000")) - x-example-php: '"00000000-0000-0000-0000-000000000000"' + x-example-php: ""00000000-0000-0000-0000-000000000000"" x-example-csharp: new List<Guid>{Guid.Parse("00000000-0000-0000-0000-000000000000")}; schema: type: array @@ -3444,7 +3444,7 @@ paths: x-example-python: "True" schema: type: boolean - - $ref: '#/components/parameters/summaryOnly' + - $ref: "#/components/parameters/summaryOnly" - in: query name: searchTerm x-snake: search_term @@ -3452,14 +3452,14 @@ paths: example: Joe Bloggs schema: type: string - - $ref: '#/components/parameters/pageSize' + - $ref: "#/components/parameters/pageSize" responses: "200": description: Success - return response of type Contacts array with 0 to N Contact content: application/json: schema: - $ref: '#/components/schemas/Contacts' + $ref: "#/components/schemas/Contacts" example: Id: 04e93d48-e72f-4775-b7dd-15a041fab972 Status: OK @@ -3657,15 +3657,15 @@ paths: csharp: Contact object: contact parameters: - - $ref: '#/components/parameters/summarizeErrors' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/summarizeErrors" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type Contacts array with newly created Contact content: application/json: schema: - $ref: '#/components/schemas/Contacts' + $ref: "#/components/schemas/Contacts" example: Id: e997d6d7-6dad-4458-beb8-d9c1bf7f2edf Status: OK @@ -3728,7 +3728,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: ErrorNumber: 10 Type: ValidationException @@ -3775,7 +3775,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Contacts' + $ref: "#/components/schemas/Contacts" example: Contacts: - ContactID: 3ff6d40c-af9a-40a3-89ce-3c1556a25591 @@ -3905,15 +3905,15 @@ paths: csharp: Contact object: contact parameters: - - $ref: '#/components/parameters/summarizeErrors' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/summarizeErrors" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type Contacts array with newly created Contact content: application/json: schema: - $ref: '#/components/schemas/Contacts' + $ref: "#/components/schemas/Contacts" example: Id: e997d6d7-6dad-4458-beb8-d9c1bf7f2edf Status: OK @@ -3976,7 +3976,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: ErrorNumber: 10 Type: ValidationException @@ -4022,7 +4022,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Contacts' + $ref: "#/components/schemas/Contacts" example: Contacts: - Name: Bruce Banner @@ -4040,7 +4040,7 @@ paths: Type: DAYSAFTERBILLMONTH /Contacts/{ContactNumber}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -4065,7 +4065,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Contacts' + $ref: "#/components/schemas/Contacts" example: Id: 5c83b115-a6e8-4f2a-877f-ba63d009235b Status: OK @@ -4166,7 +4166,7 @@ paths: HasValidationErrors: false /Contacts/{ContactID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -4177,14 +4177,14 @@ paths: operationId: getContact summary: Retrieves a specific contacts in a Xero organisation using a unique contact Id parameters: - - $ref: '#/components/parameters/ContactID' + - $ref: "#/components/parameters/ContactID" responses: "200": description: Success - return response of type Contacts array with a unique Contact content: application/json: schema: - $ref: '#/components/schemas/Contacts' + $ref: "#/components/schemas/Contacts" example: Id: 5c83b115-a6e8-4f2a-877f-ba63d009235b Status: OK @@ -4322,15 +4322,15 @@ paths: csharp: Contact object: contact parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/ContactID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/ContactID" responses: "200": description: Success - return response of type Contacts array with an updated Contact content: application/json: schema: - $ref: '#/components/schemas/Contacts' + $ref: "#/components/schemas/Contacts" example: Id: 4166b727-c3f0-4881-acd0-d4f7c0e8fcda Status: OK @@ -4388,21 +4388,21 @@ paths: ContactPersons: [] HasValidationErrors: false "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: description: an array of Contacts containing single Contact object with properties to update required: true content: application/json: schema: - $ref: '#/components/schemas/Contacts' + $ref: "#/components/schemas/Contacts" example: Contacts: - ContactID: 00000000-0000-0000-0000-000000000000 Name: Thanos /Contacts/{ContactID}/Attachments: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -4420,7 +4420,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: 0f63b631-a205-496d-b1d2-e6b13a9b497b Status: OK @@ -4433,10 +4433,10 @@ paths: MimeType: image/jpg ContentLength: 2878711 parameters: - - $ref: '#/components/parameters/ContactID' + - $ref: "#/components/parameters/ContactID" /Contacts/{ContactID}/Attachments/{AttachmentID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -4447,9 +4447,9 @@ paths: operationId: getContactAttachmentById summary: Retrieves a specific attachment from a specific contact using a unique attachment Id parameters: - - $ref: '#/components/parameters/ContactID' - - $ref: '#/components/parameters/AttachmentID' - - $ref: '#/components/parameters/ContentType' + - $ref: "#/components/parameters/ContactID" + - $ref: "#/components/parameters/AttachmentID" + - $ref: "#/components/parameters/ContentType" responses: "200": description: Success - return response of attachment for Contact as binary data @@ -4460,7 +4460,7 @@ paths: format: binary /Contacts/{ContactID}/Attachments/{FileName}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -4471,9 +4471,9 @@ paths: operationId: getContactAttachmentByFileName summary: Retrieves a specific attachment from a specific contact by file name parameters: - - $ref: '#/components/parameters/ContactID' - - $ref: '#/components/parameters/FileName' - - $ref: '#/components/parameters/ContentType' + - $ref: "#/components/parameters/ContactID" + - $ref: "#/components/parameters/FileName" + - $ref: "#/components/parameters/ContentType" responses: "200": description: Success - return response of attachment for Contact as binary data @@ -4491,9 +4491,9 @@ paths: operationId: updateContactAttachmentByFileName x-hasAccountingValidationError: true parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/ContactID' - - $ref: '#/components/parameters/FileName' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/ContactID" + - $ref: "#/components/parameters/FileName" responses: "200": description: Success - return response of type Attachments array with an updated Attachment @@ -4501,7 +4501,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: 8543ae1a-297c-49b8-bf91-47decac452d5 Status: OK @@ -4514,7 +4514,7 @@ paths: MimeType: image/jpg ContentLength: 2878711 "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: Byte array of file in body of request @@ -4532,9 +4532,9 @@ paths: operationId: createContactAttachmentByFileName x-hasAccountingValidationError: true parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/ContactID' - - $ref: '#/components/parameters/FileName' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/ContactID" + - $ref: "#/components/parameters/FileName" responses: "200": description: Success - return response of type Attachments array with an newly created Attachment @@ -4542,7 +4542,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: a5eddf71-86aa-42f5-99e2-0aaf9caf96b6 Status: OK @@ -4555,7 +4555,7 @@ paths: MimeType: image/jpg ContentLength: 2878711 "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: Byte array of file in body of request @@ -4566,7 +4566,7 @@ paths: format: byte /Contacts/{ContactID}/CISSettings: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -4577,14 +4577,14 @@ paths: operationId: getContactCISSettings summary: Retrieves CIS settings for a specific contact in a Xero organisation parameters: - - $ref: '#/components/parameters/ContactID' + - $ref: "#/components/parameters/ContactID" responses: "200": description: Success - return response of type CISSettings for a specific Contact content: application/json: schema: - $ref: '#/components/schemas/CISSettings' + $ref: "#/components/schemas/CISSettings" example: CISSetting: - CISContractorEnabled: true @@ -4592,7 +4592,7 @@ paths: Rate: 100 /Contacts/{ContactID}/History: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -4603,10 +4603,10 @@ paths: operationId: getContactHistory summary: Retrieves history records for a specific contact parameters: - - $ref: '#/components/parameters/ContactID' + - $ref: "#/components/parameters/ContactID" responses: "200": - $ref: '#/components/responses/HistoryRetrieved' + $ref: "#/components/responses/HistoryRetrieved" put: security: - OAuth2: @@ -4644,18 +4644,18 @@ paths: csharp: HistoryRecord object: historyRecord parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/ContactID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/ContactID" requestBody: - $ref: '#/components/requestBodies/historyRecords' + $ref: "#/components/requestBodies/historyRecords" responses: "200": - $ref: '#/components/responses/HistoryRecordCreated' + $ref: "#/components/responses/HistoryRecordCreated" "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" /ContactGroups: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -4688,7 +4688,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ContactGroups' + $ref: "#/components/schemas/ContactGroups" example: Id: b825df86-1a72-49c9-97dd-36afc7d04bd5 Status: OK @@ -4714,7 +4714,7 @@ paths: operationId: createContactGroup summary: Creates a contact group parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" x-hasAccountingValidationError: true x-example: - contact: @@ -4749,7 +4749,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ContactGroups' + $ref: "#/components/schemas/ContactGroups" example: Id: 5afe53f9-2271-45b8-9767-88d023b71d34 Status: OK @@ -4766,7 +4766,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: ErrorNumber: 10 Type: ValidationException @@ -4784,13 +4784,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ContactGroups' + $ref: "#/components/schemas/ContactGroups" example: ContactGroups: - Name: VIPs /ContactGroups/{ContactGroupID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -4801,14 +4801,14 @@ paths: operationId: getContactGroup summary: Retrieves a specific contact group by using a unique contact group Id parameters: - - $ref: '#/components/parameters/ContactGroupID' + - $ref: "#/components/parameters/ContactGroupID" responses: "200": description: Success - return response of type Contact Groups array with a specific Contact Group content: application/json: schema: - $ref: '#/components/schemas/ContactGroups' + $ref: "#/components/schemas/ContactGroups" example: Id: 079c14f6-2c2d-464e-a2c7-0edf7e465723 Status: OK @@ -4871,15 +4871,15 @@ paths: csharp: ContactGroup object: contactGroup parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/ContactGroupID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/ContactGroupID" responses: "200": description: Success - return response of type Contact Groups array of updated Contact Group content: application/json: schema: - $ref: '#/components/schemas/ContactGroups' + $ref: "#/components/schemas/ContactGroups" example: Id: b1ba6cdb-1637-4209-bb92-bd0c593f3243 Status: OK @@ -4892,20 +4892,20 @@ paths: Contacts: [] HasValidationErrors: false "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: description: an array of Contact groups with Name of specific group to update required: true content: application/json: schema: - $ref: '#/components/schemas/ContactGroups' + $ref: "#/components/schemas/ContactGroups" example: ContactGroups: - Name: Suppliers /ContactGroups/{ContactGroupID}/Contacts: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" put: security: - OAuth2: @@ -4941,15 +4941,15 @@ paths: csharp: Contact object: contact parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/ContactGroupID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/ContactGroupID" responses: "200": description: Success - return response of type Contacts array of added Contacts content: application/json: schema: - $ref: '#/components/schemas/Contacts' + $ref: "#/components/schemas/Contacts" example: Id: 99db8024-6895-45c8-a1b5-54805aa8689c Status: OK @@ -4971,14 +4971,14 @@ paths: HasValidationErrors: false ValidationErrors: [] "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: description: Contacts with array of contacts specifying the ContactID to be added to ContactGroup in body of request required: true content: application/json: schema: - $ref: '#/components/schemas/Contacts' + $ref: "#/components/schemas/Contacts" example: Contacts: - ContactID: a3675fc4-f8dd-4f03-ba5b-f1870566bcd7 @@ -4992,14 +4992,14 @@ paths: operationId: deleteContactGroupContacts summary: Deletes all contacts from a specific contact group parameters: - - $ref: '#/components/parameters/ContactGroupID' + - $ref: "#/components/parameters/ContactGroupID" responses: "204": description: Success - return response 204 no content x-isEmpty: true /ContactGroups/{ContactGroupID}/Contacts/{ContactID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" delete: security: - OAuth2: @@ -5009,17 +5009,17 @@ paths: operationId: deleteContactGroupContact summary: Deletes a specific contact from a contact group using a unique contact Id parameters: - - $ref: '#/components/parameters/ContactGroupID' - - $ref: '#/components/parameters/ContactID' + - $ref: "#/components/parameters/ContactGroupID" + - $ref: "#/components/parameters/ContactID" responses: "204": description: Success - return response 204 no content x-isEmpty: true "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" /CreditNotes: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -5030,7 +5030,7 @@ paths: operationId: getCreditNotes summary: Retrieves any credit notes parameters: - - $ref: '#/components/parameters/ifModifiedSince' + - $ref: "#/components/parameters/ifModifiedSince" - in: query name: where description: Filter by an any element @@ -5053,15 +5053,15 @@ paths: example: 1 schema: type: integer - - $ref: '#/components/parameters/unitdp' - - $ref: '#/components/parameters/pageSize' + - $ref: "#/components/parameters/unitdp" + - $ref: "#/components/parameters/pageSize" responses: "200": description: Success - return response of type Credit Notes array of CreditNote content: application/json: schema: - $ref: '#/components/schemas/CreditNotes' + $ref: "#/components/schemas/CreditNotes" example: Id: 306379b0-3d75-4c77-953a-be08fa0efae8 Status: OK @@ -5154,11 +5154,11 @@ paths: java_datatype: LocalDate default: LocalDate.now() java: LocalDate.now() - node: '''2020-12-10''' + node: "'2020-12-10'" csharp: DateTime.Now php: new DateTime('2020-12-10') python: dateutil.parser.parse('2020-12-03T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - contact: is_object: true key: contact @@ -5281,16 +5281,16 @@ paths: csharp: CreditNote object: creditNote parameters: - - $ref: '#/components/parameters/summarizeErrors' - - $ref: '#/components/parameters/unitdp' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/summarizeErrors" + - $ref: "#/components/parameters/unitdp" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type Credit Notes array of newly created CreditNote content: application/json: schema: - $ref: '#/components/schemas/CreditNotes' + $ref: "#/components/schemas/CreditNotes" example: Id: 5e57a661-42da-4a19-96a0-00405a0e946d Status: OK @@ -5371,14 +5371,14 @@ paths: ValidationErrors: - Message: An existing Credit Note with the specified CreditNoteID could not be found "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: description: Credit Notes with array of CreditNote object in body of request required: true content: application/json: schema: - $ref: '#/components/schemas/CreditNotes' + $ref: "#/components/schemas/CreditNotes" example: CreditNotes: - Type: ACCPAYCREDIT @@ -5409,10 +5409,10 @@ paths: default: LocalDate.now() java: LocalDate.now() csharp: DateTime.Now - node: '''2020-12-10''' + node: "'2020-12-10'" php: new DateTime('2020-12-10') python: dateutil.parser.parse('2020-12-03T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - contact: is_object: true key: contact @@ -5535,16 +5535,16 @@ paths: csharp: CreditNote object: creditNote parameters: - - $ref: '#/components/parameters/summarizeErrors' - - $ref: '#/components/parameters/unitdp' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/summarizeErrors" + - $ref: "#/components/parameters/unitdp" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type Credit Notes array of newly created CreditNote content: application/json: schema: - $ref: '#/components/schemas/CreditNotes' + $ref: "#/components/schemas/CreditNotes" example: Id: 5e57a661-42da-4a19-96a0-00405a0e946d Status: OK @@ -5626,14 +5626,14 @@ paths: ValidationErrors: - Message: An existing Credit Note with the specified CreditNoteID could not be found "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: description: an array of Credit Notes with a single CreditNote object. required: true content: application/json: schema: - $ref: '#/components/schemas/CreditNotes' + $ref: "#/components/schemas/CreditNotes" example: CreditNotes: - Type: ACCPAYCREDIT @@ -5649,7 +5649,7 @@ paths: AccountCode: "400" /CreditNotes/{CreditNoteID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -5660,15 +5660,15 @@ paths: operationId: getCreditNote summary: Retrieves a specific credit note using a unique credit note Id parameters: - - $ref: '#/components/parameters/CreditNoteID' - - $ref: '#/components/parameters/unitdp' + - $ref: "#/components/parameters/CreditNoteID" + - $ref: "#/components/parameters/unitdp" responses: "200": description: Success - return response of type Credit Notes array with a unique CreditNote content: application/json: schema: - $ref: '#/components/schemas/CreditNotes' + $ref: "#/components/schemas/CreditNotes" example: Id: dd5c5da7-08ab-486a-ac34-aea295f1614b Status: OK @@ -5778,10 +5778,10 @@ paths: default: LocalDate.now() java: LocalDate.now() csharp: DateTime.Now - node: '''2020-12-10''' + node: "'2020-12-10'" php: new DateTime('2020-12-10') python: dateutil.parser.parse('2020-12-03T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - contact: is_object: true key: contact @@ -5921,16 +5921,16 @@ paths: csharp: CreditNote object: creditNote parameters: - - $ref: '#/components/parameters/CreditNoteID' - - $ref: '#/components/parameters/unitdp' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/CreditNoteID" + - $ref: "#/components/parameters/unitdp" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type Credit Notes array with updated CreditNote content: application/json: schema: - $ref: '#/components/schemas/CreditNotes' + $ref: "#/components/schemas/CreditNotes" example: Id: db2f7659-6044-418d-a4c6-d4b93eba4e1e Status: OK @@ -6008,14 +6008,14 @@ paths: UpdatedDateUTC: /Date(1551812704223+0000)/ CurrencyCode: NZD "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: description: an array of Credit Notes containing credit note details to update required: true content: application/json: schema: - $ref: '#/components/schemas/CreditNotes' + $ref: "#/components/schemas/CreditNotes" example: CreditNotes: - Type: ACCPAYCREDIT @@ -6032,7 +6032,7 @@ paths: AccountCode: "400" /CreditNotes/{CreditNoteID}/Attachments: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -6043,7 +6043,7 @@ paths: operationId: getCreditNoteAttachments summary: Retrieves attachments for a specific credit notes parameters: - - $ref: '#/components/parameters/CreditNoteID' + - $ref: "#/components/parameters/CreditNoteID" responses: "200": description: Success - return response of type Attachments array with all Attachment for specific Credit Note @@ -6051,7 +6051,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: 2bb15054-3868-4f85-a9c6-0402ec8c1201 Status: OK @@ -6065,7 +6065,7 @@ paths: ContentLength: 76091 /CreditNotes/{CreditNoteID}/Attachments/{AttachmentID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -6076,9 +6076,9 @@ paths: operationId: getCreditNoteAttachmentById summary: Retrieves a specific attachment from a specific credit note using a unique attachment Id parameters: - - $ref: '#/components/parameters/CreditNoteID' - - $ref: '#/components/parameters/AttachmentID' - - $ref: '#/components/parameters/ContentType' + - $ref: "#/components/parameters/CreditNoteID" + - $ref: "#/components/parameters/AttachmentID" + - $ref: "#/components/parameters/ContentType" responses: "200": description: Success - return response of attachment for Credit Note as binary data @@ -6089,7 +6089,7 @@ paths: format: binary /CreditNotes/{CreditNoteID}/Attachments/{FileName}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -6100,9 +6100,9 @@ paths: operationId: getCreditNoteAttachmentByFileName summary: Retrieves a specific attachment on a specific credit note by file name parameters: - - $ref: '#/components/parameters/CreditNoteID' - - $ref: '#/components/parameters/FileName' - - $ref: '#/components/parameters/ContentType' + - $ref: "#/components/parameters/CreditNoteID" + - $ref: "#/components/parameters/FileName" + - $ref: "#/components/parameters/ContentType" responses: "200": description: Success - return response of attachment for Credit Note as binary data @@ -6121,9 +6121,9 @@ paths: x-hasAccountingValidationError: true summary: Updates attachments on a specific credit note by file name parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/CreditNoteID' - - $ref: '#/components/parameters/FileName' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/CreditNoteID" + - $ref: "#/components/parameters/FileName" responses: "200": description: Success - return response of type Attachments array with updated Attachment for specific Credit Note @@ -6131,7 +6131,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: 27253066-8c4d-4e34-a251-7a749b72de40 Status: OK @@ -6144,7 +6144,7 @@ paths: MimeType: image/jpg ContentLength: 2878711 "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: Byte array of file in body of request @@ -6163,10 +6163,10 @@ paths: x-hasAccountingValidationError: true summary: Creates an attachment for a specific credit note parameters: - - $ref: '#/components/parameters/CreditNoteID' - - $ref: '#/components/parameters/FileName' - - $ref: '#/components/parameters/includeOnline' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/CreditNoteID" + - $ref: "#/components/parameters/FileName" + - $ref: "#/components/parameters/includeOnline" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type Attachments array with newly created Attachment for specific Credit Note @@ -6174,7 +6174,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: 22a8d402-5dea-40ed-9d01-26896429f649 Status: OK @@ -6187,7 +6187,7 @@ paths: MimeType: image/jpg ContentLength: 2878711 "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: Byte array of file in body of request @@ -6198,7 +6198,7 @@ paths: format: byte /CreditNotes/{CreditNoteID}/pdf: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -6210,7 +6210,7 @@ paths: x-path: /CreditNotes/{CreditNoteID} summary: Retrieves credit notes as PDF files parameters: - - $ref: '#/components/parameters/CreditNoteID' + - $ref: "#/components/parameters/CreditNoteID" responses: "200": description: Success - return response of binary data from the Attachment to a Credit Note @@ -6221,7 +6221,7 @@ paths: format: binary /CreditNotes/{CreditNoteID}/Allocations: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" put: security: - OAuth2: @@ -6241,10 +6241,10 @@ paths: default: LocalDate.now() java: LocalDate.now() csharp: DateTime.Now - node: '''2020-12-10''' + node: "'2020-12-10'" php: new DateTime('2020-12-10') python: dateutil.parser.parse('2020-12-03T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - invoice: is_object: true key: invoice @@ -6298,16 +6298,16 @@ paths: csharp: Allocation object: allocation parameters: - - $ref: '#/components/parameters/CreditNoteID' - - $ref: '#/components/parameters/summarizeErrors' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/CreditNoteID" + - $ref: "#/components/parameters/summarizeErrors" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type Allocations array with newly created Allocation for specific Credit Note content: application/json: schema: - $ref: '#/components/schemas/Allocations' + $ref: "#/components/schemas/Allocations" example: Id: 73452751-6eaa-4bcb-86f5-4c013316f4cf Status: OK @@ -6332,14 +6332,14 @@ paths: LineItems: [] ValidationErrors: [] "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: description: Allocations with array of Allocation object in body of request. required: true content: application/json: schema: - $ref: '#/components/schemas/Allocations' + $ref: "#/components/schemas/Allocations" example: Allocations: - Invoice: @@ -6349,7 +6349,7 @@ paths: Date: "2019-03-05" /CreditNotes/{CreditNoteID}/Allocations/{AllocationID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" delete: security: - OAuth2: @@ -6359,15 +6359,15 @@ paths: operationId: deleteCreditNoteAllocations summary: Deletes an Allocation from a Credit Note parameters: - - $ref: '#/components/parameters/CreditNoteID' - - $ref: '#/components/parameters/AllocationID' + - $ref: "#/components/parameters/CreditNoteID" + - $ref: "#/components/parameters/AllocationID" responses: "200": description: Success - return response of type Allocation with the isDeleted flag as true content: application/json: schema: - $ref: '#/components/schemas/Allocation' + $ref: "#/components/schemas/Allocation" example: AllocationId: 2bb15054-3868-4f85-a9c6-0402ec8c1201 Date: /Date(1551822670731)/ @@ -6376,7 +6376,7 @@ paths: IsDeleted: true /CreditNotes/{CreditNoteID}/History: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -6387,10 +6387,10 @@ paths: operationId: getCreditNoteHistory summary: Retrieves history records of a specific credit note parameters: - - $ref: '#/components/parameters/CreditNoteID' + - $ref: "#/components/parameters/CreditNoteID" responses: "200": - $ref: '#/components/responses/HistoryRetrieved' + $ref: "#/components/responses/HistoryRetrieved" put: security: - OAuth2: @@ -6428,18 +6428,18 @@ paths: csharp: HistoryRecord object: historyRecord parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/CreditNoteID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/CreditNoteID" responses: "200": - $ref: '#/components/responses/HistoryRecordCreated' + $ref: "#/components/responses/HistoryRecordCreated" "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: - $ref: '#/components/requestBodies/historyRecords' + $ref: "#/components/requestBodies/historyRecords" /Currencies: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -6471,7 +6471,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Currencies' + $ref: "#/components/schemas/Currencies" example: Id: e6803fc8-8035-4251-b3e4-39d6b2de0f4a Status: OK @@ -6489,7 +6489,7 @@ paths: operationId: createCurrency summary: Create a new currency for a Xero organisation parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" x-hasAccountingValidationError: true x-example: - currency: @@ -6520,7 +6520,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Currencies' + $ref: "#/components/schemas/Currencies" example: Currencies: - Code: USD @@ -6531,13 +6531,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Currency' + $ref: "#/components/schemas/Currency" example: Code: USD Description: United States Dollar /Employees: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: deprecated: true security: @@ -6550,7 +6550,7 @@ paths: summary: Retrieves employees used in Xero payrun description: This endpoint is deprecated and will be removed April 28, 2026 parameters: - - $ref: '#/components/parameters/ifModifiedSince' + - $ref: "#/components/parameters/ifModifiedSince" - in: query name: where description: Filter by an any element @@ -6573,7 +6573,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Employees' + $ref: "#/components/schemas/Employees" example: Id: 593cbccc-5cd2-4cd2-be5e-150f0843709e Status: OK @@ -6646,15 +6646,15 @@ paths: csharp: Employee object: employee parameters: - - $ref: '#/components/parameters/summarizeErrors' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/summarizeErrors" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type Employees array with new Employee content: application/json: schema: - $ref: '#/components/schemas/Employees' + $ref: "#/components/schemas/Employees" example: Id: 0d6a08e7-6936-4828-a1bc-e4595e0ef778 Status: OK @@ -6670,14 +6670,14 @@ paths: Description: Go to external link UpdatedDateUTC: /Date(1552324736463+0000)/ "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: Employees with array of Employee object in body of request content: application/json: schema: - $ref: '#/components/schemas/Employees' + $ref: "#/components/schemas/Employees" example: Employees: - FirstName: Nick @@ -6726,15 +6726,15 @@ paths: csharp: Employee object: employee parameters: - - $ref: '#/components/parameters/summarizeErrors' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/summarizeErrors" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type Employees array with new Employee content: application/json: schema: - $ref: '#/components/schemas/Employees' + $ref: "#/components/schemas/Employees" example: Id: 0d6a08e7-6936-4828-a1bc-e4595e0ef778 Status: OK @@ -6750,14 +6750,14 @@ paths: Description: Go to external link UpdatedDateUTC: /Date(1552324736463+0000)/ "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: Employees with array of Employee object in body of request content: application/json: schema: - $ref: '#/components/schemas/Employees' + $ref: "#/components/schemas/Employees" example: Employees: - FirstName: Nick @@ -6766,7 +6766,7 @@ paths: Url: http://twitter.com/#!/search/Nick+Fury /Employees/{EmployeeID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: deprecated: true security: @@ -6779,14 +6779,14 @@ paths: summary: Retrieves a specific employee used in Xero payrun using a unique employee Id description: This endpoint is deprecated and will be removed April 28, 2026 parameters: - - $ref: '#/components/parameters/EmployeeID' + - $ref: "#/components/parameters/EmployeeID" responses: "200": description: Success - return response of type Employees array with specified Employee content: application/json: schema: - $ref: '#/components/schemas/Employees' + $ref: "#/components/schemas/Employees" example: Id: 417a529e-4f8d-4b1a-8816-7100245cf8b2 Status: OK @@ -6803,7 +6803,7 @@ paths: UpdatedDateUTC: /Date(1552324681593+0000)/ /ExpenseClaims: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -6814,7 +6814,7 @@ paths: operationId: getExpenseClaims summary: Retrieves expense claims parameters: - - $ref: '#/components/parameters/ifModifiedSince' + - $ref: "#/components/parameters/ifModifiedSince" - in: query name: where description: Filter by an any element @@ -6837,7 +6837,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ExpenseClaims' + $ref: "#/components/schemas/ExpenseClaims" example: Id: f6a8867e-af29-41ee-8f77-855f5ff214fe Status: OK @@ -6850,7 +6850,7 @@ paths: User: UserID: d1164823-0ac1-41ad-987b-b4e30fe0b273 EmailAddress: api@xero.com - FirstName: 'API ' + FirstName: "API " LastName: Team UpdatedDateUTC: /Date(1511957179217+0000)/ IsSubscriber: true @@ -6870,7 +6870,7 @@ paths: operationId: createExpenseClaims summary: Creates expense claims parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" x-hasAccountingValidationError: true x-example: - currDate: @@ -6882,10 +6882,10 @@ paths: default: LocalDate.now() java: LocalDate.now() csharp: DateTime.Now - node: '''2020-12-10''' + node: "'2020-12-10'" php: new DateTime('2020-12-10') python: dateutil.parser.parse('2020-12-03T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - user: is_object: true key: user @@ -6982,7 +6982,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ExpenseClaims' + $ref: "#/components/schemas/ExpenseClaims" example: ExpenseClaims: - Status: SUBMITTED @@ -6997,7 +6997,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ExpenseClaims' + $ref: "#/components/schemas/ExpenseClaims" example: Id: 4a0879a6-3860-4b73-adc6-f6a0e0f68fc8 Status: OK @@ -7010,7 +7010,7 @@ paths: User: UserID: d1164823-0ac1-41ad-987b-b4e30fe0b273 EmailAddress: api@xero.com - FirstName: 'API ' + FirstName: "API " LastName: Team UpdatedDateUTC: /Date(1511957179217+0000)/ IsSubscriber: true @@ -7022,7 +7022,7 @@ paths: User: UserID: d1164823-0ac1-41ad-987b-b4e30fe0b273 EmailAddress: api@xero.com - FirstName: 'API ' + FirstName: "API " LastName: Team UpdatedDateUTC: /Date(1511957179217+0000)/ IsSubscriber: true @@ -7058,10 +7058,10 @@ paths: AmountPaid: 0.00 StatusAttributeString: OK "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" /ExpenseClaims/{ExpenseClaimID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -7072,14 +7072,14 @@ paths: operationId: getExpenseClaim summary: Retrieves a specific expense claim using a unique expense claim Id parameters: - - $ref: '#/components/parameters/ExpenseClaimID' + - $ref: "#/components/parameters/ExpenseClaimID" responses: "200": description: Success - return response of type ExpenseClaims array with specified ExpenseClaim content: application/json: schema: - $ref: '#/components/schemas/ExpenseClaims' + $ref: "#/components/schemas/ExpenseClaims" example: Id: b54bb45d-37da-4f53-9f1d-536302d6bad7 Status: OK @@ -7092,7 +7092,7 @@ paths: User: UserID: d1164823-0ac1-41ad-987b-b4e30fe0b273 EmailAddress: api@xero.com - FirstName: 'API ' + FirstName: "API " LastName: Team UpdatedDateUTC: /Date(1511957179217+0000)/ IsSubscriber: true @@ -7104,7 +7104,7 @@ paths: User: UserID: d1164823-0ac1-41ad-987b-b4e30fe0b273 EmailAddress: api@xero.com - FirstName: 'API ' + FirstName: "API " LastName: Team UpdatedDateUTC: /Date(1511957179217+0000)/ IsSubscriber: true @@ -7159,10 +7159,10 @@ paths: default: LocalDate.now() java: LocalDate.now() csharp: DateTime.Now - node: '''2020-12-10''' + node: "'2020-12-10'" php: new DateTime('2020-12-10') python: dateutil.parser.parse('2020-12-03T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - user: is_object: true key: user @@ -7254,15 +7254,15 @@ paths: csharp: ExpenseClaim object: expenseClaim parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/ExpenseClaimID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/ExpenseClaimID" responses: "200": description: Success - return response of type ExpenseClaims array with updated ExpenseClaim content: application/json: schema: - $ref: '#/components/schemas/ExpenseClaims' + $ref: "#/components/schemas/ExpenseClaims" example: Id: 8ee87f9c-058b-4f1b-b5b2-29569bf055d7 Status: OK @@ -7275,7 +7275,7 @@ paths: User: UserID: d1164823-0ac1-41ad-987b-b4e30fe0b273 EmailAddress: api@xero.com - FirstName: 'API ' + FirstName: "API " LastName: Team UpdatedDateUTC: /Date(1511957179217+0000)/ IsSubscriber: true @@ -7287,7 +7287,7 @@ paths: User: UserID: d1164823-0ac1-41ad-987b-b4e30fe0b273 EmailAddress: api@xero.com - FirstName: 'API ' + FirstName: "API " LastName: Team UpdatedDateUTC: /Date(1511957179217+0000)/ IsSubscriber: true @@ -7324,13 +7324,13 @@ paths: AmountPaid: 0.00 ReportingDate: /Date(1552262400000+0000)/ "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/ExpenseClaims' + $ref: "#/components/schemas/ExpenseClaims" example: ExpenseClaims: - Status: SUBMITTED @@ -7341,7 +7341,7 @@ paths: ReceiptID: dc1c7f6d-0a4c-402f-acac-551d62ce5816 /ExpenseClaims/{ExpenseClaimID}/History: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -7352,10 +7352,10 @@ paths: operationId: getExpenseClaimHistory summary: Retrieves history records of a specific expense claim parameters: - - $ref: '#/components/parameters/ExpenseClaimID' + - $ref: "#/components/parameters/ExpenseClaimID" responses: "200": - $ref: '#/components/responses/HistoryRetrieved' + $ref: "#/components/responses/HistoryRetrieved" put: security: - OAuth2: @@ -7393,16 +7393,16 @@ paths: csharp: HistoryRecord object: historyRecord parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/ExpenseClaimID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/ExpenseClaimID" responses: "200": - $ref: '#/components/responses/HistoryRecordCreated' + $ref: "#/components/responses/HistoryRecordCreated" requestBody: - $ref: '#/components/requestBodies/historyRecords' + $ref: "#/components/requestBodies/historyRecords" /Invoices: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -7413,7 +7413,7 @@ paths: operationId: getInvoices summary: Retrieves sales invoices or purchase bills parameters: - - $ref: '#/components/parameters/ifModifiedSince' + - $ref: "#/components/parameters/ifModifiedSince" - in: query name: where description: Filter by an any element @@ -7436,9 +7436,9 @@ paths: description: Filter by a comma-separated list of InvoicesIDs. style: form explode: false - example: '"00000000-0000-0000-0000-000000000000"' + example: ""00000000-0000-0000-0000-000000000000"" x-example-java: Arrays.asList(UUID.fromString("00000000-0000-0000-0000-000000000000")) - x-example-php: '"00000000-0000-0000-0000-000000000000"' + x-example-php: ""00000000-0000-0000-0000-000000000000"" x-example-csharp: new List<Guid>{Guid.Parse("00000000-0000-0000-0000-000000000000")}; schema: type: array @@ -7451,9 +7451,9 @@ paths: description: Filter by a comma-separated list of InvoiceNumbers. style: form explode: false - example: '"INV-001", "INV-002"' + example: ""INV-001", "INV-002"" x-example-java: Arrays.asList("INV-001","INV-002") - x-example-php: '"INV-001", "INV-002"' + x-example-php: ""INV-001", "INV-002"" x-example-csharp: new List<string>{"INV-001","INV-002"}; schema: type: array @@ -7465,9 +7465,9 @@ paths: description: Filter by a comma-separated list of ContactIDs. style: form explode: false - example: '"00000000-0000-0000-0000-000000000000"' + example: ""00000000-0000-0000-0000-000000000000"" x-example-java: Arrays.asList(UUID.fromString("00000000-0000-0000-0000-000000000000")) - x-example-php: '"00000000-0000-0000-0000-000000000000"' + x-example-php: ""00000000-0000-0000-0000-000000000000"" x-example-csharp: new List<Guid>{Guid.Parse("00000000-0000-0000-0000-000000000000")}; schema: type: array @@ -7479,9 +7479,9 @@ paths: x-snake: statuses description: Filter by a comma-separated list Statuses. For faster response times we recommend using these explicit parameters instead of passing OR conditions into the Where filter. explode: false - example: '"DRAFT", "SUBMITTED"' + example: ""DRAFT", "SUBMITTED"" x-example-java: Arrays.asList("DRAFT","SUBMITTED") - x-example-php: '"DRAFT", "SUBMITTED"' + x-example-php: ""DRAFT", "SUBMITTED"" x-example-csharp: new List<string>{"DRAFT","SUBMITTED"}; schema: type: array @@ -7509,17 +7509,17 @@ paths: x-example-python: "False" schema: type: boolean - - $ref: '#/components/parameters/unitdp' - - $ref: '#/components/parameters/summaryOnly' - - $ref: '#/components/parameters/pageSize' - - $ref: '#/components/parameters/searchTerm' + - $ref: "#/components/parameters/unitdp" + - $ref: "#/components/parameters/summaryOnly" + - $ref: "#/components/parameters/pageSize" + - $ref: "#/components/parameters/searchTerm" responses: "200": description: Success - return response of type Invoices array with all Invoices content: application/json: schema: - $ref: '#/components/schemas/Invoices' + $ref: "#/components/schemas/Invoices" example: Id: 900c500b-e83c-4ce2-902a-b8ba04751748 Status: OK @@ -7666,9 +7666,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 10) csharp: new DateTime(2020, 10, 10) php: new DateTime('2020-10-10') - node: '''2020-10-10''' + node: "'2020-10-10'" python: dateutil.parser.parse('2020-10-10T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - dueDateValue: is_date: true key: dueDateValue @@ -7680,9 +7680,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 28) csharp: new DateTime(2020, 10, 10) php: new DateTime('2020-10-28') - node: '''2020-10-28''' + node: "'2020-10-28'" python: dateutil.parser.parse('2020-10-28T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - contact: is_object: true key: contact @@ -7868,16 +7868,16 @@ paths: csharp: Invoice object: invoice parameters: - - $ref: '#/components/parameters/summarizeErrors' - - $ref: '#/components/parameters/unitdp' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/summarizeErrors" + - $ref: "#/components/parameters/unitdp" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type Invoices array with newly created Invoice content: application/json: schema: - $ref: '#/components/schemas/Invoices' + $ref: "#/components/schemas/Invoices" example: Id: ccece84a-075c-4fcd-9073-149d4f7a91cf Status: OK @@ -7975,14 +7975,14 @@ paths: CurrencyCode: NZD StatusAttributeString: OK "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: Invoices with an array of invoice objects in body of request content: application/json: schema: - $ref: '#/components/schemas/Invoices' + $ref: "#/components/schemas/Invoices" example: Invoices: - Type: ACCREC @@ -8019,9 +8019,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 10) csharp: new DateTime(2020, 10, 10) php: new DateTime('2020-10-10') - node: '''2020-10-10''' + node: "'2020-10-10'" python: dateutil.parser.parse('2020-10-10T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - dueDateValue: is_date: true key: dueDateValue @@ -8032,9 +8032,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 28) csharp: new DateTime(2020, 10, 10) php: new DateTime('2020-10-28') - node: '''2020-10-28''' + node: "'2020-10-28'" python: dateutil.parser.parse('2020-10-28T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - contact: is_object: true key: contact @@ -8180,16 +8180,16 @@ paths: csharp: Invoice object: invoice parameters: - - $ref: '#/components/parameters/summarizeErrors' - - $ref: '#/components/parameters/unitdp' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/summarizeErrors" + - $ref: "#/components/parameters/unitdp" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type Invoices array with newly created Invoice content: application/json: schema: - $ref: '#/components/schemas/Invoices' + $ref: "#/components/schemas/Invoices" example: Id: ccece84a-075c-4fcd-9073-149d4f7a91cf Status: OK @@ -8287,13 +8287,13 @@ paths: CurrencyCode: NZD StatusAttributeString: OK "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/Invoices' + $ref: "#/components/schemas/Invoices" example: Invoices: - Type: ACCREC @@ -8312,7 +8312,7 @@ paths: Status: AUTHORISED /Invoices/{InvoiceID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -8323,15 +8323,15 @@ paths: operationId: getInvoice summary: Retrieves a specific sales invoice or purchase bill using a unique invoice Id parameters: - - $ref: '#/components/parameters/InvoiceID' - - $ref: '#/components/parameters/unitdp' + - $ref: "#/components/parameters/InvoiceID" + - $ref: "#/components/parameters/unitdp" responses: "200": description: Success - return response of type Invoices array with specified Invoices content: application/json: schema: - $ref: '#/components/schemas/Invoices' + $ref: "#/components/schemas/Invoices" example: Id: 516f400a-b764-4c88-831b-12d2b210fa24 Status: OK @@ -8446,7 +8446,7 @@ paths: FullyPaidOnDate: /Date(1552953600000+0000)/ StatusAttributeString: ERROR ValidationErrors: - - Message: 'Invoice # must be unique.' + - Message: "Invoice # must be unique." post: security: - OAuth2: @@ -8480,16 +8480,16 @@ paths: csharp: Invoice object: invoice parameters: - - $ref: '#/components/parameters/InvoiceID' - - $ref: '#/components/parameters/unitdp' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/InvoiceID" + - $ref: "#/components/parameters/unitdp" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type Invoices array with updated Invoice content: application/json: schema: - $ref: '#/components/schemas/Invoices' + $ref: "#/components/schemas/Invoices" example: Id: bd83b60e-9d16-4a3b-9f59-0a2d0ccd35f2 Status: OK @@ -8574,13 +8574,13 @@ paths: UpdatedDateUTC: /Date(1552329728987+0000)/ CurrencyCode: NZD "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/Invoices' + $ref: "#/components/schemas/Invoices" example: Invoices: - Reference: May the force be with you @@ -8590,7 +8590,7 @@ paths: Type: ACCPAY /Invoices/{InvoiceID}/pdf: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -8602,7 +8602,7 @@ paths: x-path: /Invoices/{InvoiceID} summary: Retrieves invoices or purchase bills as PDF files parameters: - - $ref: '#/components/parameters/InvoiceID' + - $ref: "#/components/parameters/InvoiceID" responses: "200": description: Success - return response of byte array pdf version of specified Invoices @@ -8613,7 +8613,7 @@ paths: format: binary /Invoices/{InvoiceID}/Attachments: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -8624,7 +8624,7 @@ paths: operationId: getInvoiceAttachments summary: Retrieves attachments for a specific invoice or purchase bill parameters: - - $ref: '#/components/parameters/InvoiceID' + - $ref: "#/components/parameters/InvoiceID" responses: "200": description: Success - return response of type Attachments array of Attachments for specified Invoices @@ -8632,7 +8632,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: 7e357a45-69f5-4e8f-8d7b-15da8ef50aab Status: OK @@ -8651,7 +8651,7 @@ paths: ContentLength: 2878711 /Invoices/{InvoiceID}/Attachments/{AttachmentID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -8662,9 +8662,9 @@ paths: operationId: getInvoiceAttachmentById summary: Retrieves a specific attachment from a specific invoices or purchase bills by using a unique attachment Id parameters: - - $ref: '#/components/parameters/InvoiceID' - - $ref: '#/components/parameters/AttachmentID' - - $ref: '#/components/parameters/ContentType' + - $ref: "#/components/parameters/InvoiceID" + - $ref: "#/components/parameters/AttachmentID" + - $ref: "#/components/parameters/ContentType" responses: "200": description: Success - return response of attachment for Invoice as binary data @@ -8675,7 +8675,7 @@ paths: format: binary /Invoices/{InvoiceID}/Attachments/{FileName}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -8686,9 +8686,9 @@ paths: operationId: getInvoiceAttachmentByFileName summary: Retrieves an attachment from a specific invoice or purchase bill by filename parameters: - - $ref: '#/components/parameters/InvoiceID' - - $ref: '#/components/parameters/FileName' - - $ref: '#/components/parameters/ContentType' + - $ref: "#/components/parameters/InvoiceID" + - $ref: "#/components/parameters/FileName" + - $ref: "#/components/parameters/ContentType" responses: "200": description: Success - return response of attachment for Invoice as binary data @@ -8707,9 +8707,9 @@ paths: x-hasAccountingValidationError: true summary: Updates an attachment from a specific invoices or purchase bill by filename parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/InvoiceID' - - $ref: '#/components/parameters/FileName' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/InvoiceID" + - $ref: "#/components/parameters/FileName" responses: "200": description: Success - return response of type Attachments array with updated Attachment @@ -8717,7 +8717,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: acd7d618-5fef-4d45-849c-a339ea31a973 Status: OK @@ -8730,7 +8730,7 @@ paths: MimeType: image/jpg ContentLength: 2878711 "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: Byte array of file in body of request @@ -8749,10 +8749,10 @@ paths: x-hasAccountingValidationError: true summary: Creates an attachment for a specific invoice or purchase bill by filename parameters: - - $ref: '#/components/parameters/InvoiceID' - - $ref: '#/components/parameters/FileName' - - $ref: '#/components/parameters/includeOnline' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/InvoiceID" + - $ref: "#/components/parameters/FileName" + - $ref: "#/components/parameters/includeOnline" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type Attachments array with newly created Attachment @@ -8760,7 +8760,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: 971fbd18-c850-453a-825f-63f2fee096ee Status: OK @@ -8773,7 +8773,7 @@ paths: MimeType: image/jpg ContentLength: 2878711 "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: Byte array of file in body of request @@ -8784,7 +8784,7 @@ paths: format: byte /Invoices/{InvoiceID}/OnlineInvoice: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -8795,14 +8795,14 @@ paths: operationId: getOnlineInvoice summary: Retrieves a URL to an online invoice parameters: - - $ref: '#/components/parameters/InvoiceID' + - $ref: "#/components/parameters/InvoiceID" responses: "200": description: Success - return response of type OnlineInvoice array with one OnlineInvoice content: application/json: schema: - $ref: '#/components/schemas/OnlineInvoices' + $ref: "#/components/schemas/OnlineInvoices" example: Id: d20705fb-fe1c-4366-835b-98de7474da3c Status: OK @@ -8812,7 +8812,7 @@ paths: - OnlineInvoiceUrl: https://in.xero.com/bCWCCfytGdTXoJam9HENWlQt07G6zcDaj4gQojHu /Invoices/{InvoiceID}/Email: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" post: security: - OAuth2: @@ -8829,24 +8829,24 @@ paths: key: requestEmpty keyPascal: RequestEmpty parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/InvoiceID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/InvoiceID" responses: "204": description: Success - return response 204 no content x-isEmpty: true "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/RequestEmpty' + $ref: "#/components/schemas/RequestEmpty" example: {} /Invoices/{InvoiceID}/History: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -8857,10 +8857,10 @@ paths: operationId: getInvoiceHistory summary: Retrieves history records for a specific invoice parameters: - - $ref: '#/components/parameters/InvoiceID' + - $ref: "#/components/parameters/InvoiceID" responses: "200": - $ref: '#/components/responses/HistoryRetrieved' + $ref: "#/components/responses/HistoryRetrieved" put: security: - OAuth2: @@ -8898,18 +8898,18 @@ paths: csharp: HistoryRecord object: historyRecord parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/InvoiceID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/InvoiceID" responses: "200": - $ref: '#/components/responses/HistoryRecordCreated' + $ref: "#/components/responses/HistoryRecordCreated" "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: - $ref: '#/components/requestBodies/historyRecords' + $ref: "#/components/requestBodies/historyRecords" /InvoiceReminders/Settings: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -8925,7 +8925,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InvoiceReminders' + $ref: "#/components/schemas/InvoiceReminders" example: Id: c7cd0953-c012-4be8-b618-63ce4c2c3494 Status: OK @@ -8935,7 +8935,7 @@ paths: - Enabled: false /Items: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -8946,7 +8946,7 @@ paths: operationId: getItems summary: Retrieves items parameters: - - $ref: '#/components/parameters/ifModifiedSince' + - $ref: "#/components/parameters/ifModifiedSince" - in: query name: where description: Filter by an any element @@ -8959,14 +8959,14 @@ paths: example: Code ASC schema: type: string - - $ref: '#/components/parameters/unitdp' + - $ref: "#/components/parameters/unitdp" responses: "200": description: Success - return response of type Items array with all Item content: application/json: schema: - $ref: '#/components/schemas/Items' + $ref: "#/components/schemas/Items" example: Id: 8487e8d7-5fb3-4f02-b949-dec8f1e38182 Status: OK @@ -9068,16 +9068,16 @@ paths: csharp: Item object: item parameters: - - $ref: '#/components/parameters/summarizeErrors' - - $ref: '#/components/parameters/unitdp' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/summarizeErrors" + - $ref: "#/components/parameters/unitdp" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type Items array with newly created Item content: application/json: schema: - $ref: '#/components/schemas/Items' + $ref: "#/components/schemas/Items" example: Id: ae7ef7c8-9024-4d42-8d59-5f26ed3f508b Status: OK @@ -9097,14 +9097,14 @@ paths: ValidationErrors: - Message: Price List Item with Code ''abc'' already exists "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: Items with an array of Item objects in body of request content: application/json: schema: - $ref: '#/components/schemas/Items' + $ref: "#/components/schemas/Items" example: Items: - Code: code123 @@ -9156,16 +9156,16 @@ paths: csharp: Item object: item parameters: - - $ref: '#/components/parameters/summarizeErrors' - - $ref: '#/components/parameters/unitdp' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/summarizeErrors" + - $ref: "#/components/parameters/unitdp" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type Items array with newly created Item content: application/json: schema: - $ref: '#/components/schemas/Items' + $ref: "#/components/schemas/Items" example: Id: ae7ef7c8-9024-4d42-8d59-5f26ed3f508b Status: OK @@ -9185,13 +9185,13 @@ paths: ValidationErrors: - Message: Price List Item with Code ''abc'' already exists "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/Items' + $ref: "#/components/schemas/Items" example: Items: - Code: ItemCode123 @@ -9199,7 +9199,7 @@ paths: Description: Item Description ABC /Items/{ItemID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -9210,15 +9210,15 @@ paths: operationId: getItem summary: Retrieves a specific item using a unique item Id parameters: - - $ref: '#/components/parameters/ItemID' - - $ref: '#/components/parameters/unitdp' + - $ref: "#/components/parameters/ItemID" + - $ref: "#/components/parameters/unitdp" responses: "200": description: Success - return response of type Items array with specified Item content: application/json: schema: - $ref: '#/components/schemas/Items' + $ref: "#/components/schemas/Items" example: Id: 0bbd8a92-9ba7-4711-8040-8d6a609ca7e8 Status: OK @@ -9284,16 +9284,16 @@ paths: csharp: Item object: item parameters: - - $ref: '#/components/parameters/ItemID' - - $ref: '#/components/parameters/unitdp' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/ItemID" + - $ref: "#/components/parameters/unitdp" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type Items array with updated Item content: application/json: schema: - $ref: '#/components/schemas/Items' + $ref: "#/components/schemas/Items" example: Id: 24feb629-6b14-499e-9aa1-fc2c596c0280 Status: OK @@ -9312,13 +9312,13 @@ paths: IsPurchased: true ValidationErrors: [] "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/Items' + $ref: "#/components/schemas/Items" example: Items: - Code: ItemCode123 @@ -9332,16 +9332,16 @@ paths: operationId: deleteItem summary: Deletes a specific item parameters: - - $ref: '#/components/parameters/ItemID' + - $ref: "#/components/parameters/ItemID" responses: "204": description: Success - return response 204 no content x-isEmpty: true "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" /Items/{ItemID}/History: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -9352,10 +9352,10 @@ paths: operationId: getItemHistory summary: Retrieves history for a specific item parameters: - - $ref: '#/components/parameters/ItemID' + - $ref: "#/components/parameters/ItemID" responses: "200": - $ref: '#/components/responses/HistoryRetrieved' + $ref: "#/components/responses/HistoryRetrieved" put: security: - OAuth2: @@ -9393,16 +9393,16 @@ paths: csharp: HistoryRecord object: historyRecord parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/ItemID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/ItemID" responses: "200": - $ref: '#/components/responses/HistoryRecordCreated' + $ref: "#/components/responses/HistoryRecordCreated" requestBody: - $ref: '#/components/requestBodies/historyRecords' + $ref: "#/components/requestBodies/historyRecords" /Journals: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -9412,7 +9412,7 @@ paths: operationId: getJournals summary: Retrieves journals parameters: - - $ref: '#/components/parameters/ifModifiedSince' + - $ref: "#/components/parameters/ifModifiedSince" - in: query name: offset description: Offset by a specified journal number. e.g. journals with a JournalNumber greater than the offset will be returned @@ -9433,7 +9433,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Journals' + $ref: "#/components/schemas/Journals" example: Id: 49a09a97-df50-4679-8043-02c86e0dcf5f Status: OK @@ -9569,7 +9569,7 @@ paths: TrackingCategories: [] /Journals/{JournalID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -9579,14 +9579,14 @@ paths: operationId: getJournal summary: Retrieves a specific journal using a unique journal Id. parameters: - - $ref: '#/components/parameters/JournalID' + - $ref: "#/components/parameters/JournalID" responses: "200": description: Success - return response of type Journals array with specified Journal content: application/json: schema: - $ref: '#/components/schemas/Journals' + $ref: "#/components/schemas/Journals" example: Id: 39ab8367-eb14-420d-83a9-e01ddddd21f8 Status: OK @@ -9625,7 +9625,7 @@ paths: TrackingCategories: [] /Journals/{JournalNumber}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -9635,14 +9635,14 @@ paths: operationId: getJournalByNumber summary: Retrieves a specific journal using a unique journal number. parameters: - - $ref: '#/components/parameters/JournalNumber' + - $ref: "#/components/parameters/JournalNumber" responses: "200": description: Success - return response of type Journals array with specified Journal content: application/json: schema: - $ref: '#/components/schemas/Journals' + $ref: "#/components/schemas/Journals" example: Id: 39ab8367-eb14-420d-83a9-e01ddddd21f8 Status: OK @@ -9681,7 +9681,7 @@ paths: TrackingCategories: [] /LinkedTransactions: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -9743,7 +9743,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LinkedTransactions' + $ref: "#/components/schemas/LinkedTransactions" example: Id: 516aabd0-e670-48d5-b0eb-10dce4494dd8 Status: OK @@ -9769,7 +9769,7 @@ paths: operationId: createLinkedTransaction summary: Creates linked transactions (billable expenses) parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" x-hasAccountingValidationError: true x-example: - linkedTransaction: @@ -9798,7 +9798,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LinkedTransactions' + $ref: "#/components/schemas/LinkedTransactions" example: Id: f32b30e5-32d1-42a8-bcc9-5b22828f725c Status: OK @@ -9815,21 +9815,21 @@ paths: ValidationErrors: - Message: The SourceLineItemID and SourceTransactionID do not match "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: LinkedTransaction object in body of request content: application/json: schema: - $ref: '#/components/schemas/LinkedTransaction' + $ref: "#/components/schemas/LinkedTransaction" example: LinkedTransactions: - SourceTransactionID: a848644a-f20f-4630-98c3-386bd7505631 SourceLineItemID: b0df260d-3cc8-4ced-9bd6-41924f624ed3 /LinkedTransactions/{LinkedTransactionID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -9840,14 +9840,14 @@ paths: operationId: getLinkedTransaction summary: Retrieves a specific linked transaction (billable expenses) using a unique linked transaction Id parameters: - - $ref: '#/components/parameters/LinkedTransactionID' + - $ref: "#/components/parameters/LinkedTransactionID" responses: "200": description: Success - return response of type LinkedTransactions array with a specified LinkedTransaction content: application/json: schema: - $ref: '#/components/schemas/LinkedTransactions' + $ref: "#/components/schemas/LinkedTransactions" example: Id: 171ca542-874d-44e2-8930-db9bccd7d88b Status: OK @@ -9909,15 +9909,15 @@ paths: csharp: LinkedTransaction object: linkedTransaction parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/LinkedTransactionID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/LinkedTransactionID" responses: "200": description: Success - return response of type LinkedTransactions array with updated LinkedTransaction content: application/json: schema: - $ref: '#/components/schemas/LinkedTransactions' + $ref: "#/components/schemas/LinkedTransactions" example: Id: bd364af7-08f0-432b-81db-c1e5ba05f3dd Status: OK @@ -9937,7 +9937,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: ErrorNumber: 10 Type: ValidationException @@ -9960,7 +9960,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LinkedTransactions' + $ref: "#/components/schemas/LinkedTransactions" example: LinkedTransactions: - SourceTransactionID: 00000000-0000-0000-0000-000000000000 @@ -9974,16 +9974,16 @@ paths: operationId: deleteLinkedTransaction summary: Deletes a specific linked transactions (billable expenses) parameters: - - $ref: '#/components/parameters/LinkedTransactionID' + - $ref: "#/components/parameters/LinkedTransactionID" responses: "204": description: Success - return response 204 no content x-isEmpty: true "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" /ManualJournals: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -9994,7 +9994,7 @@ paths: operationId: getManualJournals summary: Retrieves manual journals parameters: - - $ref: '#/components/parameters/ifModifiedSince' + - $ref: "#/components/parameters/ifModifiedSince" - in: query name: where description: Filter by an any element @@ -10017,14 +10017,14 @@ paths: example: 1 schema: type: integer - - $ref: '#/components/parameters/pageSize' + - $ref: "#/components/parameters/pageSize" responses: "200": description: Success - return response of type ManualJournals array with a all ManualJournals content: application/json: schema: - $ref: '#/components/schemas/ManualJournals' + $ref: "#/components/schemas/ManualJournals" example: Id: 8a508ec1-b578-48bf-97df-020c918fbf7d Status: OK @@ -10041,7 +10041,7 @@ paths: LineAmountTypes: NoTax UpdatedDateUTC: /Date(1552357188083+0000)/ ManualJournalID: 0b159335-606b-485f-b51b-97b3b32bad32 - Narration: 'Reversal: These aren''''t the droids you are looking for' + Narration: "Reversal: These aren''t the droids you are looking for" JournalLines: [] ShowOnCashBasisReports: true HasAttachments: false @@ -10083,9 +10083,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 10) csharp: new DateTime(2020, 10, 10) php: new DateTime('2019-10-10') - node: '''2020-10-10''' + node: "'2020-10-10'" python: dateutil.parser.parse('2020-12-03T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - manualJournalLines: is_list: true key: manualJournalLines @@ -10200,15 +10200,15 @@ paths: csharp: ManualJournal object: manualJournal parameters: - - $ref: '#/components/parameters/summarizeErrors' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/summarizeErrors" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type ManualJournals array with newly created ManualJournal content: application/json: schema: - $ref: '#/components/schemas/ManualJournals' + $ref: "#/components/schemas/ManualJournals" example: Id: 45dfa608-0fcb-4f30-a377-c82cd348569c Status: OK @@ -10246,14 +10246,14 @@ paths: ValidationErrors: - Message: The total debits (100.00) must equal total credits (-10.00) "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: ManualJournals array with ManualJournal object in body of request content: application/json: schema: - $ref: '#/components/schemas/ManualJournals' + $ref: "#/components/schemas/ManualJournals" example: ManualJournals: - Narration: Journal Desc @@ -10288,9 +10288,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 10) csharp: new DateTime(2020, 10, 10) php: new DateTime('2020-10-10') - node: '''2020-10-10''' + node: "'2020-10-10'" python: dateutil.parser.parse('2020-12-03T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - manualJournalLines: is_list: true key: manualJournalLines @@ -10405,15 +10405,15 @@ paths: csharp: ManualJournal object: manualJournal parameters: - - $ref: '#/components/parameters/summarizeErrors' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/summarizeErrors" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type ManualJournals array with newly created ManualJournal content: application/json: schema: - $ref: '#/components/schemas/ManualJournals' + $ref: "#/components/schemas/ManualJournals" example: Id: 45dfa608-0fcb-4f30-a377-c82cd348569c Status: OK @@ -10451,14 +10451,14 @@ paths: ValidationErrors: - Message: The total debits (100.00) must equal total credits (-10.00) "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: ManualJournals array with ManualJournal object in body of request content: application/json: schema: - $ref: '#/components/schemas/ManualJournals' + $ref: "#/components/schemas/ManualJournals" example: ManualJournals: - Narration: Journal Desc @@ -10475,7 +10475,7 @@ paths: Date: "2019-03-14" /ManualJournals/{ManualJournalID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -10486,14 +10486,14 @@ paths: operationId: getManualJournal summary: Retrieves a specific manual journal parameters: - - $ref: '#/components/parameters/ManualJournalID' + - $ref: "#/components/parameters/ManualJournalID" responses: "200": description: Success - return response of type ManualJournals array with a specified ManualJournals content: application/json: schema: - $ref: '#/components/schemas/ManualJournals' + $ref: "#/components/schemas/ManualJournals" example: Id: 7321fc21-1a13-4f40-ae47-df59cff5676d Status: OK @@ -10556,9 +10556,9 @@ paths: java: LocalDate.of(2020, Month.OCTOBER, 10) csharp: new DateTime(2020, 10, 10) php: new DateTime('2020-10-10') - node: '''2020-10-10''' + node: "'2020-10-10'" python: dateutil.parser.parse('2020-12-03T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - manualJournalLines: is_list: true key: manualJournalLines @@ -10673,15 +10673,15 @@ paths: csharp: ManualJournal object: manualJournal parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/ManualJournalID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/ManualJournalID" responses: "200": description: Success - return response of type ManualJournals array with an updated ManualJournal content: application/json: schema: - $ref: '#/components/schemas/ManualJournals' + $ref: "#/components/schemas/ManualJournals" example: Id: b694559c-686c-4047-b657-661ba6c0dd1f Status: OK @@ -10715,13 +10715,13 @@ paths: HasAttachments: false Attachments: [] "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/ManualJournals' + $ref: "#/components/schemas/ManualJournals" example: ManualJournals: - Narration: Hello Xero @@ -10729,7 +10729,7 @@ paths: JournalLines: [] /ManualJournals/{ManualJournalID}/Attachments: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -10740,7 +10740,7 @@ paths: operationId: getManualJournalAttachments summary: Retrieves attachment for a specific manual journal parameters: - - $ref: '#/components/parameters/ManualJournalID' + - $ref: "#/components/parameters/ManualJournalID" responses: "200": description: Success - return response of type Attachments array with all Attachments for a ManualJournals @@ -10748,7 +10748,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: 5fa4b3ef-7945-45a7-9bab-10e830673dfb Status: OK @@ -10767,7 +10767,7 @@ paths: ContentLength: 2878711 /ManualJournals/{ManualJournalID}/Attachments/{AttachmentID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -10778,9 +10778,9 @@ paths: operationId: getManualJournalAttachmentById summary: Allows you to retrieve a specific attachment from a specific manual journal using a unique attachment Id parameters: - - $ref: '#/components/parameters/ManualJournalID' - - $ref: '#/components/parameters/AttachmentID' - - $ref: '#/components/parameters/ContentType' + - $ref: "#/components/parameters/ManualJournalID" + - $ref: "#/components/parameters/AttachmentID" + - $ref: "#/components/parameters/ContentType" responses: "200": description: Success - return response of attachment for Manual Journal as binary data @@ -10791,7 +10791,7 @@ paths: format: binary /ManualJournals/{ManualJournalID}/Attachments/{FileName}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -10802,9 +10802,9 @@ paths: operationId: getManualJournalAttachmentByFileName summary: Retrieves a specific attachment from a specific manual journal by file name parameters: - - $ref: '#/components/parameters/ManualJournalID' - - $ref: '#/components/parameters/FileName' - - $ref: '#/components/parameters/ContentType' + - $ref: "#/components/parameters/ManualJournalID" + - $ref: "#/components/parameters/FileName" + - $ref: "#/components/parameters/ContentType" responses: "200": description: Success - return response of attachment for Manual Journal as binary data @@ -10823,9 +10823,9 @@ paths: x-hasAccountingValidationError: true summary: Updates a specific attachment from a specific manual journal by file name parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/ManualJournalID' - - $ref: '#/components/parameters/FileName' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/ManualJournalID" + - $ref: "#/components/parameters/FileName" responses: "200": description: Success - return response of type Attachments array with an update Attachment for a ManualJournals @@ -10833,7 +10833,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: e1cb9deb-a8f0-477f-b4d1-cf0c6c39e080 Status: OK @@ -10846,7 +10846,7 @@ paths: MimeType: image/jpg ContentLength: 2878711 "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: Byte array of file in body of request @@ -10865,9 +10865,9 @@ paths: x-hasAccountingValidationError: true summary: Creates a specific attachment for a specific manual journal by file name parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/ManualJournalID' - - $ref: '#/components/parameters/FileName' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/ManualJournalID" + - $ref: "#/components/parameters/FileName" responses: "200": description: Success - return response of type Attachments array with a newly created Attachment for a ManualJournals @@ -10875,7 +10875,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: a864994c-e7d7-4dee-b5ca-0a729fde2f39 Status: OK @@ -10888,7 +10888,7 @@ paths: MimeType: image/jpg ContentLength: 2878711 "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: Byte array of file in body of request @@ -10899,7 +10899,7 @@ paths: format: byte /ManualJournals/{ManualJournalID}/History: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -10910,10 +10910,10 @@ paths: operationId: getManualJournalsHistory summary: Retrieves history for a specific manual journal parameters: - - $ref: '#/components/parameters/ManualJournalID' + - $ref: "#/components/parameters/ManualJournalID" responses: "200": - $ref: '#/components/responses/HistoryRetrieved' + $ref: "#/components/responses/HistoryRetrieved" put: security: - OAuth2: @@ -10951,18 +10951,18 @@ paths: csharp: HistoryRecord object: historyRecord parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/ManualJournalID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/ManualJournalID" responses: "200": - $ref: '#/components/responses/HistoryRecordCreated' + $ref: "#/components/responses/HistoryRecordCreated" "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: - $ref: '#/components/requestBodies/historyRecords' + $ref: "#/components/requestBodies/historyRecords" /Organisation: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -10978,7 +10978,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Organisations' + $ref: "#/components/schemas/Organisations" example: Id: 27b7a645-a3ee-43c8-b2c6-a2fa7b84c8c5 Status: OK @@ -11007,7 +11007,7 @@ paths: CreatedDateUTC: /Date(1455827393000)/ OrganisationEntityType: COMPANY Timezone: NEWZEALANDSTANDARDTIME - ShortCode: '!mBdtL' + ShortCode: "!mBdtL" OrganisationID: b2c885a9-4bb9-4a00-9b6e-6c2bf60b1a2b Edition: BUSINESS Class: PREMIUM @@ -11017,7 +11017,7 @@ paths: PaymentTerms: {} /Organisation/Actions: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -11033,7 +11033,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Actions' + $ref: "#/components/schemas/Actions" example: Id: f02c0dd1-1917-4d57-9853-997f6bcaf2bc Status: OK @@ -11068,7 +11068,7 @@ paths: Status: ALLOWED /Organisation/{OrganisationID}/CISSettings: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -11079,21 +11079,21 @@ paths: operationId: getOrganisationCISSettings summary: Retrieves the CIS settings for the Xero organistaion. parameters: - - $ref: '#/components/parameters/OrganisationID' + - $ref: "#/components/parameters/OrganisationID" responses: "200": description: Success - return response of type Organisation array with specified Organisation content: application/json: schema: - $ref: '#/components/schemas/CISOrgSettings' + $ref: "#/components/schemas/CISOrgSettings" example: CISSettings: - CISEnambed: true Rate: 10 /Overpayments: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -11104,7 +11104,7 @@ paths: operationId: getOverpayments summary: Retrieves overpayments parameters: - - $ref: '#/components/parameters/ifModifiedSince' + - $ref: "#/components/parameters/ifModifiedSince" - in: query name: where description: Filter by an any element @@ -11127,15 +11127,15 @@ paths: example: 1 schema: type: integer - - $ref: '#/components/parameters/unitdp' - - $ref: '#/components/parameters/pageSize' + - $ref: "#/components/parameters/unitdp" + - $ref: "#/components/parameters/pageSize" responses: "200": description: Success - return response of type Overpayments array with all Overpayments content: application/json: schema: - $ref: '#/components/schemas/Overpayments' + $ref: "#/components/schemas/Overpayments" example: Id: c0ce675e-e5bc-4b2a-a20e-76a9eaedf89d Status: OK @@ -11274,7 +11274,7 @@ paths: CurrencyCode: NZD /Overpayments/{OverpaymentID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -11285,14 +11285,14 @@ paths: operationId: getOverpayment summary: Retrieves a specific overpayment using a unique overpayment Id parameters: - - $ref: '#/components/parameters/OverpaymentID' + - $ref: "#/components/parameters/OverpaymentID" responses: "200": description: Success - return response of type Overpayments array with specified Overpayments content: application/json: schema: - $ref: '#/components/schemas/Overpayments' + $ref: "#/components/schemas/Overpayments" example: Id: 46c9e8e2-9410-4e75-9297-f0ca8fa76c32 Status: OK @@ -11389,7 +11389,7 @@ paths: CurrencyCode: NZD /Overpayments/{OverpaymentID}/Allocations: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" put: security: - OAuth2: @@ -11409,10 +11409,10 @@ paths: default: LocalDate.now() java: LocalDate.now() csharp: DateTime.Now - node: '''2020-12-10''' + node: "'2020-12-10'" php: new DateTime('2020-12-10') python: dateutil.parser.parse('2020-12-03T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - invoice: is_object: true key: invoice @@ -11466,16 +11466,16 @@ paths: csharp: Allocation object: allocation parameters: - - $ref: '#/components/parameters/OverpaymentID' - - $ref: '#/components/parameters/summarizeErrors' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/OverpaymentID" + - $ref: "#/components/parameters/summarizeErrors" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type Allocations array with all Allocation for Overpayments content: application/json: schema: - $ref: '#/components/schemas/Allocations' + $ref: "#/components/schemas/Allocations" example: Id: 3b7f7be2-384a-4703-bcfb-c56e9116c914 Status: OK @@ -11500,14 +11500,14 @@ paths: LineItems: [] ValidationErrors: [] "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: Allocations array with Allocation object in body of request content: application/json: schema: - $ref: '#/components/schemas/Allocations' + $ref: "#/components/schemas/Allocations" example: Allocations: - Invoice: @@ -11519,7 +11519,7 @@ paths: Date: "2019-03-12" /Overpayments/{OverpaymentID}/Allocations/{AllocationID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" delete: security: - OAuth2: @@ -11529,15 +11529,15 @@ paths: operationId: deleteOverpaymentAllocations summary: Deletes an Allocation from an overpayment parameters: - - $ref: '#/components/parameters/OverpaymentID' - - $ref: '#/components/parameters/AllocationID' + - $ref: "#/components/parameters/OverpaymentID" + - $ref: "#/components/parameters/AllocationID" responses: "200": description: Success - return response of type Allocation with the isDeleted flag as true content: application/json: schema: - $ref: '#/components/schemas/Allocation' + $ref: "#/components/schemas/Allocation" example: AllocationId: 2bb15054-3868-4f85-a9c6-0402ec8c1201 Date: /Date(1551822670731)/ @@ -11546,7 +11546,7 @@ paths: IsDeleted: true /Overpayments/{OverpaymentID}/History: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -11557,10 +11557,10 @@ paths: operationId: getOverpaymentHistory summary: Retrieves history records of a specific overpayment parameters: - - $ref: '#/components/parameters/OverpaymentID' + - $ref: "#/components/parameters/OverpaymentID" responses: "200": - $ref: '#/components/responses/HistoryRetrieved' + $ref: "#/components/responses/HistoryRetrieved" put: security: - OAuth2: @@ -11598,17 +11598,17 @@ paths: csharp: HistoryRecord object: historyRecord parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/OverpaymentID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/OverpaymentID" responses: "200": - $ref: '#/components/responses/HistoryRecordCreated' + $ref: "#/components/responses/HistoryRecordCreated" "400": description: A failed request due to validation error - API is not able to create HistoryRecord for Overpayments content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: ErrorNumber: 10 Type: ValidationException @@ -11620,10 +11620,10 @@ paths: ValidationErrors: - Message: The document with the supplied id was not found for this endpoint. requestBody: - $ref: '#/components/requestBodies/historyRecords' + $ref: "#/components/requestBodies/historyRecords" /Payments: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -11634,7 +11634,7 @@ paths: operationId: getPayments summary: Retrieves payments for invoices and credit notes parameters: - - $ref: '#/components/parameters/ifModifiedSince' + - $ref: "#/components/parameters/ifModifiedSince" - in: query name: where description: Filter by an any element @@ -11657,14 +11657,14 @@ paths: example: 1 schema: type: integer - - $ref: '#/components/parameters/pageSize' + - $ref: "#/components/parameters/pageSize" responses: "200": description: Success - return response of type Payments array for all Payments content: application/json: schema: - $ref: '#/components/schemas/Payments' + $ref: "#/components/schemas/Payments" example: Id: 9f310473-e1b5-4704-a25c-eec653deb596 Status: OK @@ -11779,9 +11779,9 @@ paths: java: LocalDate.now() csharp: DateTime.Now php: new DateTime('2020-10-10') - node: '''2020-10-10''' + node: "'2020-10-10'" python: dateutil.parser.parse('2020-10-10T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - invoice: is_object: true key: invoice @@ -11854,15 +11854,15 @@ paths: csharp: Payment object: payment parameters: - - $ref: '#/components/parameters/summarizeErrors' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/summarizeErrors" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type Payments array for newly created Payment content: application/json: schema: - $ref: '#/components/schemas/Payments' + $ref: "#/components/schemas/Payments" example: Id: 83b5715a-6a77-4c16-b5b8-2da08b5fde44 Status: OK @@ -11927,14 +11927,14 @@ paths: ValidationErrors: - Message: Payment amount exceeds the amount outstanding on this document "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: Payments array with Payment object in body of request content: application/json: schema: - $ref: '#/components/schemas/Payments' + $ref: "#/components/schemas/Payments" example: Payments: - Invoice: @@ -11953,7 +11953,7 @@ paths: operationId: createPayment summary: Creates a single payment for invoice or credit notes parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" x-hasAccountingValidationError: true x-example: - dateValue: @@ -11966,9 +11966,9 @@ paths: java: LocalDate.now() csharp: DateTime.Now php: new DateTime('2020-10-10') - node: '''2020-10-10''' + node: "'2020-10-10'" python: dateutil.parser.parse('2020-10-10T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - invoice: is_object: true key: invoice @@ -12046,7 +12046,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Payments' + $ref: "#/components/schemas/Payments" example: Id: 83b5715a-6a77-4c16-b5b8-2da08b5fde44 Status: OK @@ -12111,14 +12111,14 @@ paths: ValidationErrors: - Message: Payment amount exceeds the amount outstanding on this document "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: Request body with a single Payment object content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" example: Payments: - Invoice: @@ -12130,7 +12130,7 @@ paths: Amount: 1 /Payments/{PaymentID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -12141,14 +12141,14 @@ paths: operationId: getPayment summary: Retrieves a specific payment for invoices and credit notes using a unique payment Id parameters: - - $ref: '#/components/parameters/PaymentID' + - $ref: "#/components/parameters/PaymentID" responses: "200": description: Success - return response of type Payments array for specified Payment content: application/json: schema: - $ref: '#/components/schemas/Payments' + $ref: "#/components/schemas/Payments" example: Id: 4876f9ee-3a17-47d8-8c1b-84377c8f2998 Status: OK @@ -12250,15 +12250,15 @@ paths: default: DELETED object: paymentDelete parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/PaymentID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/PaymentID" responses: "200": description: Success - return response of type Payments array for updated Payment content: application/json: schema: - $ref: '#/components/schemas/Payments' + $ref: "#/components/schemas/Payments" example: Id: ee23328c-4a8b-4ee7-8fb6-9796ffab9cb0 Status: OK @@ -12319,19 +12319,19 @@ paths: CurrencyCode: AUD HasValidationErrors: false "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/PaymentDelete' + $ref: "#/components/schemas/PaymentDelete" example: Payments: - Status: DELETED /Payments/{PaymentID}/History: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -12342,10 +12342,10 @@ paths: operationId: getPaymentHistory summary: Retrieves history records of a specific payment parameters: - - $ref: '#/components/parameters/PaymentID' + - $ref: "#/components/parameters/PaymentID" responses: "200": - $ref: '#/components/responses/HistoryRetrieved' + $ref: "#/components/responses/HistoryRetrieved" put: security: - OAuth2: @@ -12383,17 +12383,17 @@ paths: csharp: HistoryRecord object: historyRecord parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/PaymentID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/PaymentID" responses: "200": - $ref: '#/components/responses/HistoryRecordCreated' + $ref: "#/components/responses/HistoryRecordCreated" "400": description: A failed request due to validation error - API is not able to create HistoryRecord for Payments content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: ErrorNumber: 10 Type: ValidationException @@ -12405,10 +12405,10 @@ paths: ValidationErrors: - Message: The document with the supplied id was not found for this endpoint. requestBody: - $ref: '#/components/requestBodies/historyRecords' + $ref: "#/components/requestBodies/historyRecords" /PaymentServices: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -12424,7 +12424,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PaymentServices' + $ref: "#/components/schemas/PaymentServices" example: Id: ab82a7dd-5070-4e82-b841-0af52909fe04 Status: OK @@ -12445,7 +12445,7 @@ paths: operationId: createPaymentService summary: Creates a payment service parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" x-excludeFromPreview: true x-hasAccountingValidationError: true x-example: @@ -12491,7 +12491,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PaymentServices' + $ref: "#/components/schemas/PaymentServices" example: Id: 7ed8b3c0-2155-49ee-a583-f2dce6607dfb Status: OK @@ -12506,14 +12506,14 @@ paths: ValidationErrors: - Message: Payment service could not be found "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: PaymentServices array with PaymentService object in body of request content: application/json: schema: - $ref: '#/components/schemas/PaymentServices' + $ref: "#/components/schemas/PaymentServices" example: PaymentServices: - PaymentServiceName: PayUpNow @@ -12521,7 +12521,7 @@ paths: PayNowText: Time To Pay /Prepayments: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -12532,7 +12532,7 @@ paths: operationId: getPrepayments summary: Retrieves prepayments parameters: - - $ref: '#/components/parameters/ifModifiedSince' + - $ref: "#/components/parameters/ifModifiedSince" - in: query name: where description: Filter by an any element @@ -12555,15 +12555,15 @@ paths: example: 1 schema: type: integer - - $ref: '#/components/parameters/unitdp' - - $ref: '#/components/parameters/pageSize' + - $ref: "#/components/parameters/unitdp" + - $ref: "#/components/parameters/pageSize" responses: "200": description: Success - return response of type Prepayments array for all Prepayment content: application/json: schema: - $ref: '#/components/schemas/Prepayments' + $ref: "#/components/schemas/Prepayments" example: Id: d7a9ca0c-6159-4c26-ad2e-715440c50b7d Status: OK @@ -12603,7 +12603,7 @@ paths: CurrencyCode: NZD /Prepayments/{PrepaymentID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -12614,14 +12614,14 @@ paths: operationId: getPrepayment summary: Allows you to retrieve a specified prepayments parameters: - - $ref: '#/components/parameters/PrepaymentID' + - $ref: "#/components/parameters/PrepaymentID" responses: "200": description: Success - return response of type Prepayments array for a specified Prepayment content: application/json: schema: - $ref: '#/components/schemas/Prepayments' + $ref: "#/components/schemas/Prepayments" example: Id: 18e5f578-ef28-4096-a7aa-d06d65574b99 Status: OK @@ -12716,7 +12716,7 @@ paths: CurrencyCode: NZD /Prepayments/{PrepaymentID}/Allocations: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" put: security: - OAuth2: @@ -12736,10 +12736,10 @@ paths: default: LocalDate.now() java: LocalDate.now() csharp: DateTime.Now - node: '''2020-12-10''' + node: "'2020-12-10'" php: new DateTime('2020-12-10') python: dateutil.parser.parse('2020-12-03T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - invoice: is_object: true key: invoice @@ -12793,16 +12793,16 @@ paths: csharp: Allocation object: allocation parameters: - - $ref: '#/components/parameters/PrepaymentID' - - $ref: '#/components/parameters/summarizeErrors' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/PrepaymentID" + - $ref: "#/components/parameters/summarizeErrors" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type Allocations array of Allocation for all Prepayment content: application/json: schema: - $ref: '#/components/schemas/Allocations' + $ref: "#/components/schemas/Allocations" example: Id: d4758808-d14d-45d5-851a-52787ae5739a Status: OK @@ -12827,14 +12827,14 @@ paths: LineItems: [] ValidationErrors: [] "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: Allocations with an array of Allocation object in body of request content: application/json: schema: - $ref: '#/components/schemas/Allocations' + $ref: "#/components/schemas/Allocations" example: Allocations: - Invoice: @@ -12844,7 +12844,7 @@ paths: Date: "2019-01-10" /Prepayments/{PrepaymentID}/Allocations/{AllocationID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" delete: security: - OAuth2: @@ -12854,15 +12854,15 @@ paths: operationId: deletePrepaymentAllocations summary: Deletes an Allocation from a Prepayment parameters: - - $ref: '#/components/parameters/PrepaymentID' - - $ref: '#/components/parameters/AllocationID' + - $ref: "#/components/parameters/PrepaymentID" + - $ref: "#/components/parameters/AllocationID" responses: "200": description: Success - return response of type Allocation with the isDeleted flag as true content: application/json: schema: - $ref: '#/components/schemas/Allocation' + $ref: "#/components/schemas/Allocation" example: AllocationId: 2bb15054-3868-4f85-a9c6-0402ec8c1201 Date: /Date(1551822670731)/ @@ -12871,7 +12871,7 @@ paths: IsDeleted: true /Prepayments/{PrepaymentID}/History: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -12882,10 +12882,10 @@ paths: operationId: getPrepaymentHistory summary: Retrieves history record for a specific prepayment parameters: - - $ref: '#/components/parameters/PrepaymentID' + - $ref: "#/components/parameters/PrepaymentID" responses: "200": - $ref: '#/components/responses/HistoryRetrieved' + $ref: "#/components/responses/HistoryRetrieved" put: security: - OAuth2: @@ -12923,23 +12923,23 @@ paths: csharp: HistoryRecord object: historyRecord parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/PrepaymentID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/PrepaymentID" responses: "200": - $ref: '#/components/responses/HistoryRecordCreated' + $ref: "#/components/responses/HistoryRecordCreated" "400": description: Unsupported - return response incorrect exception, API is not able to create HistoryRecord for Expense Claims content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: ' { "ErrorNumber": 10, "Type": "ValidationException", "Message": "A validation exception occurred", "Elements": [ { "DateUTCString": "2019-03-14T00:15:35", "DateUTC": "/Date(1552522535440)/", "Details": "Hello World", "ValidationErrors": [ { "Message": "The document with the supplied id was not found for this endpoint." } ] } ] }' requestBody: - $ref: '#/components/requestBodies/historyRecords' + $ref: "#/components/requestBodies/historyRecords" /PurchaseOrders: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -12950,7 +12950,7 @@ paths: operationId: getPurchaseOrders summary: Retrieves purchase orders parameters: - - $ref: '#/components/parameters/ifModifiedSince' + - $ref: "#/components/parameters/ifModifiedSince" - in: query name: Status x-snake: status @@ -12990,14 +12990,14 @@ paths: example: 1 schema: type: integer - - $ref: '#/components/parameters/pageSize' + - $ref: "#/components/parameters/pageSize" responses: "200": description: Success - return response of type PurchaseOrder array of all PurchaseOrder content: application/json: schema: - $ref: '#/components/schemas/PurchaseOrders' + $ref: "#/components/schemas/PurchaseOrders" example: Id: 66910bfc-15cc-4692-bd4c-cc8f671e653c Status: OK @@ -13139,9 +13139,9 @@ paths: java: LocalDate.now() csharp: DateTime.Now php: new DateTime('2020-12-10') - node: '''2020-10-10''' + node: "'2020-10-10'" python: dateutil.parser.parse('2020-12-03T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - contact: is_object: true key: contact @@ -13252,15 +13252,15 @@ paths: csharp: PurchaseOrder object: purchaseOrder parameters: - - $ref: '#/components/parameters/summarizeErrors' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/summarizeErrors" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type PurchaseOrder array for specified PurchaseOrder content: application/json: schema: - $ref: '#/components/schemas/PurchaseOrders' + $ref: "#/components/schemas/PurchaseOrders" example: Id: aa2f9d23-fd76-4bee-9600-30c0f0f34036 Status: OK @@ -13343,14 +13343,14 @@ paths: ValidationErrors: - Message: Order number must be unique "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: PurchaseOrders with an array of PurchaseOrder object in body of request content: application/json: schema: - $ref: '#/components/schemas/PurchaseOrders' + $ref: "#/components/schemas/PurchaseOrders" example: PurchaseOrders: - Contact: @@ -13381,9 +13381,9 @@ paths: java: LocalDate.now() csharp: DateTime.Now php: new DateTime('2020-12-10') - node: '''2020-10-10''' + node: "'2020-10-10'" python: dateutil.parser.parse('2020-12-03T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - contact: is_object: true key: contact @@ -13494,15 +13494,15 @@ paths: csharp: PurchaseOrder object: purchaseOrder parameters: - - $ref: '#/components/parameters/summarizeErrors' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/summarizeErrors" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type PurchaseOrder array for specified PurchaseOrder content: application/json: schema: - $ref: '#/components/schemas/PurchaseOrders' + $ref: "#/components/schemas/PurchaseOrders" example: Id: aa2f9d23-fd76-4bee-9600-30c0f0f34036 Status: OK @@ -13585,13 +13585,13 @@ paths: ValidationErrors: - Message: Order number must be unique "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/PurchaseOrders' + $ref: "#/components/schemas/PurchaseOrders" example: PurchaseOrders: - Contact: @@ -13604,7 +13604,7 @@ paths: Date: "2019-03-13" /PurchaseOrders/{PurchaseOrderID}/pdf: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -13616,7 +13616,7 @@ paths: x-path: /PurchaseOrders/{PurchaseOrderID} summary: Retrieves specific purchase order as PDF files using a unique purchase order Id parameters: - - $ref: '#/components/parameters/PurchaseOrderID' + - $ref: "#/components/parameters/PurchaseOrderID" responses: "200": description: Success - return response of byte array pdf version of specified Purchase Orders @@ -13627,7 +13627,7 @@ paths: format: binary /PurchaseOrders/{PurchaseOrderID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -13638,14 +13638,14 @@ paths: operationId: getPurchaseOrder summary: Retrieves a specific purchase order using a unique purchase order Id parameters: - - $ref: '#/components/parameters/PurchaseOrderID' + - $ref: "#/components/parameters/PurchaseOrderID" responses: "200": description: Success - return response of type PurchaseOrder array for specified PurchaseOrder content: application/json: schema: - $ref: '#/components/schemas/PurchaseOrders' + $ref: "#/components/schemas/PurchaseOrders" example: Id: 53a8c7a5-92e8-475b-a037-acf7c55c3afd Status: OK @@ -13786,15 +13786,15 @@ paths: csharp: PurchaseOrder object: purchaseOrder parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/PurchaseOrderID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/PurchaseOrderID" responses: "200": description: Success - return response of type PurchaseOrder array for updated PurchaseOrder content: application/json: schema: - $ref: '#/components/schemas/PurchaseOrders' + $ref: "#/components/schemas/PurchaseOrders" example: Id: 0e9bb3f8-d68b-4bb2-a54d-7da240a4f51a Status: OK @@ -13873,13 +13873,13 @@ paths: Total: 23.00 UpdatedDateUTC: /Date(1552523976853+0000)/ "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/PurchaseOrders' + $ref: "#/components/schemas/PurchaseOrders" example: PurchaseOrders: - AttentionTo: Peter Parker @@ -13887,7 +13887,7 @@ paths: Contact: {} /PurchaseOrders/{PurchaseOrderNumber}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -13912,7 +13912,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PurchaseOrders' + $ref: "#/components/schemas/PurchaseOrders" example: Id: 53a8c7a5-92e8-475b-a037-acf7c55c3afd Status: OK @@ -14018,7 +14018,7 @@ paths: ContentLength: 76091 /PurchaseOrders/{PurchaseOrderID}/History: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -14029,10 +14029,10 @@ paths: operationId: getPurchaseOrderHistory summary: Retrieves history for a specific purchase order parameters: - - $ref: '#/components/parameters/PurchaseOrderID' + - $ref: "#/components/parameters/PurchaseOrderID" responses: "200": - $ref: '#/components/responses/HistoryRetrieved' + $ref: "#/components/responses/HistoryRetrieved" put: security: - OAuth2: @@ -14070,18 +14070,18 @@ paths: csharp: HistoryRecord object: historyRecord parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/PurchaseOrderID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/PurchaseOrderID" responses: "200": - $ref: '#/components/responses/HistoryRecordCreated' + $ref: "#/components/responses/HistoryRecordCreated" "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: - $ref: '#/components/requestBodies/historyRecords' + $ref: "#/components/requestBodies/historyRecords" /PurchaseOrders/{PurchaseOrderID}/Attachments: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -14092,7 +14092,7 @@ paths: operationId: getPurchaseOrderAttachments summary: Retrieves attachments for a specific purchase order parameters: - - $ref: '#/components/parameters/PurchaseOrderID' + - $ref: "#/components/parameters/PurchaseOrderID" responses: "200": description: Success - return response of type Attachments array of Purchase Orders @@ -14100,7 +14100,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: dfc29f55-8ddd-4921-a82c-bcc0798d207f Status: OK @@ -14124,7 +14124,7 @@ paths: ContentLength: 146384 /PurchaseOrders/{PurchaseOrderID}/Attachments/{AttachmentID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -14135,9 +14135,9 @@ paths: operationId: getPurchaseOrderAttachmentById summary: Retrieves specific attachment for a specific purchase order using a unique attachment Id parameters: - - $ref: '#/components/parameters/PurchaseOrderID' - - $ref: '#/components/parameters/AttachmentID' - - $ref: '#/components/parameters/ContentType' + - $ref: "#/components/parameters/PurchaseOrderID" + - $ref: "#/components/parameters/AttachmentID" + - $ref: "#/components/parameters/ContentType" responses: "200": description: Success - return response of attachment for Account as binary data @@ -14148,7 +14148,7 @@ paths: format: binary /PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -14159,9 +14159,9 @@ paths: operationId: getPurchaseOrderAttachmentByFileName summary: Retrieves a specific attachment for a specific purchase order by filename parameters: - - $ref: '#/components/parameters/PurchaseOrderID' - - $ref: '#/components/parameters/FileName' - - $ref: '#/components/parameters/ContentType' + - $ref: "#/components/parameters/PurchaseOrderID" + - $ref: "#/components/parameters/FileName" + - $ref: "#/components/parameters/ContentType" responses: "200": description: Success - return response of attachment for Purchase Order as binary data @@ -14180,9 +14180,9 @@ paths: x-hasAccountingValidationError: true summary: Updates a specific attachment for a specific purchase order by filename parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/PurchaseOrderID' - - $ref: '#/components/parameters/FileName' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/PurchaseOrderID" + - $ref: "#/components/parameters/FileName" responses: "200": description: Success - return response of type Attachments array of Attachment @@ -14190,7 +14190,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: aeff9be0-54c2-45dd-8e3d-aa4f8af0fbd7 Status: OK @@ -14207,7 +14207,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" requestBody: required: true description: Byte array of file in body of request @@ -14226,9 +14226,9 @@ paths: x-hasAccountingValidationError: true summary: Creates attachment for a specific purchase order parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/PurchaseOrderID' - - $ref: '#/components/parameters/FileName' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/PurchaseOrderID" + - $ref: "#/components/parameters/FileName" responses: "200": description: Success - return response of type Attachments array of Attachment @@ -14236,7 +14236,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: c728a4a4-179e-4bbd-a2d5-63e7f9ceba92 Status: OK @@ -14249,7 +14249,7 @@ paths: MimeType: image/png ContentLength: 82529 "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: Byte array of file in body of request @@ -14260,7 +14260,7 @@ paths: format: byte /Quotes: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -14271,7 +14271,7 @@ paths: operationId: getQuotes summary: Retrieves sales quotes parameters: - - $ref: '#/components/parameters/ifModifiedSince' + - $ref: "#/components/parameters/ifModifiedSince" - in: query name: DateFrom x-snake: date_from @@ -14344,7 +14344,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Quotes' + $ref: "#/components/schemas/Quotes" example: Id: bb583e7e-9b6b-471e-88da-4cbfcfad7a57 Status: OK @@ -14410,9 +14410,9 @@ paths: java: LocalDate.now() csharp: DateTime.Now php: new DateTime('2020-12-10') - node: '''2020-10-10''' + node: "'2020-10-10'" python: dateutil.parser.parse('2020-12-03T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - contact: is_object: true key: contact @@ -14519,15 +14519,15 @@ paths: csharp: Quote object: quote parameters: - - $ref: '#/components/parameters/summarizeErrors' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/summarizeErrors" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type Quotes with array with newly created Quote content: application/json: schema: - $ref: '#/components/schemas/Quotes' + $ref: "#/components/schemas/Quotes" example: SummarizeErrors: false Id: 29571f5a-bf73-4bb6-9de5-86be44e6bf2e @@ -14564,14 +14564,14 @@ paths: LineAmountTypes: EXCLUSIVE StatusAttributeString: OK "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: Quotes with an array of Quote object in body of request content: application/json: schema: - $ref: '#/components/schemas/Quotes' + $ref: "#/components/schemas/Quotes" example: Quotes: - Contact: @@ -14602,9 +14602,9 @@ paths: java: LocalDate.now() csharp: DateTime.Now php: new DateTime('2020-12-10') - node: '''2020-10-10''' + node: "'2020-10-10'" python: dateutil.parser.parse('2020-12-03T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - contact: is_object: true key: contact @@ -14711,15 +14711,15 @@ paths: csharp: Quote object: quote parameters: - - $ref: '#/components/parameters/summarizeErrors' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/summarizeErrors" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type Quotes array with updated or created Quote content: application/json: schema: - $ref: '#/components/schemas/Quotes' + $ref: "#/components/schemas/Quotes" example: SummarizeErrors: false Id: b425754f-0512-481d-827b-c8958db7667e @@ -14756,13 +14756,13 @@ paths: LineAmountTypes: EXCLUSIVE StatusAttributeString: OK "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/Quotes' + $ref: "#/components/schemas/Quotes" example: Quotes: - Contact: @@ -14775,7 +14775,7 @@ paths: Date: "2020-02-01" /Quotes/{QuoteID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -14786,14 +14786,14 @@ paths: operationId: getQuote summary: Retrieves a specific quote using a unique quote Id parameters: - - $ref: '#/components/parameters/QuoteID' + - $ref: "#/components/parameters/QuoteID" responses: "200": description: Success - return response of type Quotes array with specified Quote content: application/json: schema: - $ref: '#/components/schemas/Quotes' + $ref: "#/components/schemas/Quotes" example: SummarizeErrors: true Id: e3626c45-77f1-4ab0-ba9b-3593c7bcd25c @@ -14862,9 +14862,9 @@ paths: java: LocalDate.now() csharp: DateTime.Now php: new DateTime('2020-12-10') - node: '''2020-10-10''' + node: "'2020-10-10'" python: dateutil.parser.parse('2020-12-03T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - contact: is_object: true key: contact @@ -14916,15 +14916,15 @@ paths: csharp: Quote object: quote parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/QuoteID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/QuoteID" responses: "200": description: Success - return response of type Quotes array with updated Quote content: application/json: schema: - $ref: '#/components/schemas/Quotes' + $ref: "#/components/schemas/Quotes" example: SummarizeErrors: true Id: be4f43a7-ef02-497a-96c2-fc0bc047a82a @@ -14961,13 +14961,13 @@ paths: UpdatedDateUTC: /Date(1580605644360)/ LineAmountTypes: EXCLUSIVE "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/Quotes' + $ref: "#/components/schemas/Quotes" example: Quotes: - Reference: I am an update @@ -14976,7 +14976,7 @@ paths: Date: "2020-02-01" /Quotes/{QuoteID}/History: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -14987,10 +14987,10 @@ paths: operationId: getQuoteHistory summary: Retrieves history records of a specific quote parameters: - - $ref: '#/components/parameters/QuoteID' + - $ref: "#/components/parameters/QuoteID" responses: "200": - $ref: '#/components/responses/HistoryRetrieved' + $ref: "#/components/responses/HistoryRetrieved" put: security: - OAuth2: @@ -15028,18 +15028,18 @@ paths: csharp: HistoryRecord object: historyRecord parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/QuoteID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/QuoteID" responses: "200": - $ref: '#/components/responses/HistoryRecordCreated' + $ref: "#/components/responses/HistoryRecordCreated" "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: - $ref: '#/components/requestBodies/historyRecords' + $ref: "#/components/requestBodies/historyRecords" /Quotes/{QuoteID}/pdf: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -15051,7 +15051,7 @@ paths: x-path: /Quotes/{QuoteID} summary: Retrieves a specific quote as a PDF file using a unique quote Id parameters: - - $ref: '#/components/parameters/QuoteID' + - $ref: "#/components/parameters/QuoteID" responses: "200": description: Success - return response of byte array pdf version of specified Quotes @@ -15062,7 +15062,7 @@ paths: format: binary /Quotes/{QuoteID}/Attachments: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -15073,7 +15073,7 @@ paths: operationId: getQuoteAttachments summary: Retrieves attachments for a specific quote parameters: - - $ref: '#/components/parameters/QuoteID' + - $ref: "#/components/parameters/QuoteID" responses: "200": description: Success - return response of type Attachments array of Attachment @@ -15081,7 +15081,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: 439c1573-3cd8-4697-a9f6-81fa651ee8f3 Status: OK @@ -15095,7 +15095,7 @@ paths: ContentLength: 2878711 /Quotes/{QuoteID}/Attachments/{AttachmentID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -15106,9 +15106,9 @@ paths: operationId: getQuoteAttachmentById summary: Retrieves a specific attachment from a specific quote using a unique attachment Id parameters: - - $ref: '#/components/parameters/QuoteID' - - $ref: '#/components/parameters/AttachmentID' - - $ref: '#/components/parameters/ContentType' + - $ref: "#/components/parameters/QuoteID" + - $ref: "#/components/parameters/AttachmentID" + - $ref: "#/components/parameters/ContentType" responses: "200": description: Success - return response of attachment for Quote as binary data @@ -15119,7 +15119,7 @@ paths: format: binary /Quotes/{QuoteID}/Attachments/{FileName}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -15130,9 +15130,9 @@ paths: operationId: getQuoteAttachmentByFileName summary: Retrieves a specific attachment from a specific quote by filename parameters: - - $ref: '#/components/parameters/QuoteID' - - $ref: '#/components/parameters/FileName' - - $ref: '#/components/parameters/ContentType' + - $ref: "#/components/parameters/QuoteID" + - $ref: "#/components/parameters/FileName" + - $ref: "#/components/parameters/ContentType" responses: "200": description: Success - return response of attachment for Quote as binary data @@ -15151,9 +15151,9 @@ paths: x-hasAccountingValidationError: true summary: Updates a specific attachment from a specific quote by filename parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/QuoteID' - - $ref: '#/components/parameters/FileName' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/QuoteID" + - $ref: "#/components/parameters/FileName" responses: "200": description: Success - return response of type Attachments array of Attachment @@ -15161,7 +15161,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: c8d6413a-1da2-4faa-9848-21f60443e906 Status: OK @@ -15178,7 +15178,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" requestBody: required: true description: Byte array of file in body of request @@ -15197,9 +15197,9 @@ paths: x-hasAccountingValidationError: true summary: Creates attachment for a specific quote parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/QuoteID' - - $ref: '#/components/parameters/FileName' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/QuoteID" + - $ref: "#/components/parameters/FileName" responses: "200": description: Success - return response of type Attachments array of Attachment @@ -15207,7 +15207,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: 724cdff5-bcd1-4c5c-977e-e864c24258e0 Status: OK @@ -15220,7 +15220,7 @@ paths: MimeType: image/jpg ContentLength: 2878711 "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: Byte array of file in body of request @@ -15231,7 +15231,7 @@ paths: format: byte /Receipts: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -15242,7 +15242,7 @@ paths: operationId: getReceipts summary: Retrieves draft expense claim receipts for any user parameters: - - $ref: '#/components/parameters/ifModifiedSince' + - $ref: "#/components/parameters/ifModifiedSince" - in: query name: where description: Filter by an any element @@ -15259,14 +15259,14 @@ paths: example: ReceiptNumber ASC schema: type: string - - $ref: '#/components/parameters/unitdp' + - $ref: "#/components/parameters/unitdp" responses: "200": description: Success - return response of type Receipts array for all Receipt content: application/json: schema: - $ref: '#/components/schemas/Receipts' + $ref: "#/components/schemas/Receipts" example: Id: 078b2a2c-902f-4154-8739-357ece5982e5 Status: OK @@ -15278,7 +15278,7 @@ paths: Status: DRAFT User: UserID: d1164823-0ac1-41ad-987b-b4e30fe0b273 - FirstName: 'API ' + FirstName: "API " LastName: Team ValidationErrors: [] Warnings: [] @@ -15459,15 +15459,15 @@ paths: csharp: Receipt object: receipt parameters: - - $ref: '#/components/parameters/unitdp' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/unitdp" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type Receipts array for newly created Receipt content: application/json: schema: - $ref: '#/components/schemas/Receipts' + $ref: "#/components/schemas/Receipts" example: Id: 35898898-5361-4b42-b6ca-9d2c584fc53d Status: OK @@ -15480,7 +15480,7 @@ paths: User: UserID: d1164823-0ac1-41ad-987b-b4e30fe0b273 EmailAddress: api@xero.com - FirstName: 'API ' + FirstName: "API " LastName: Team UpdatedDateUTC: /Date(1511957179217+0000)/ IsSubscriber: true @@ -15548,14 +15548,14 @@ paths: ValidationErrors: - Message: A valid user should be identified using the UserID. "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: Receipts with an array of Receipt object in body of request content: application/json: schema: - $ref: '#/components/schemas/Receipts' + $ref: "#/components/schemas/Receipts" example: Receipts: - Contact: @@ -15573,7 +15573,7 @@ paths: Status: DRAFT /Receipts/{ReceiptID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -15584,15 +15584,15 @@ paths: operationId: getReceipt summary: Retrieves a specific draft expense claim receipt by using a unique receipt Id parameters: - - $ref: '#/components/parameters/ReceiptID' - - $ref: '#/components/parameters/unitdp' + - $ref: "#/components/parameters/ReceiptID" + - $ref: "#/components/parameters/unitdp" responses: "200": description: Success - return response of type Receipts array for a specified Receipt content: application/json: schema: - $ref: '#/components/schemas/Receipts' + $ref: "#/components/schemas/Receipts" example: Id: 2c99af06-d278-4580-8c8c-463c806af5b6 Status: OK @@ -15605,7 +15605,7 @@ paths: User: UserID: d1164823-0ac1-41ad-987b-b4e30fe0b273 EmailAddress: api@xero.com - FirstName: 'API ' + FirstName: "API " LastName: Team UpdatedDateUTC: /Date(1511957179217+0000)/ IsSubscriber: true @@ -15702,9 +15702,9 @@ paths: java: LocalDate.now() csharp: DateTime.Now php: new DateTime('2020-12-10') - node: '''2020-10-10''' + node: "'2020-10-10'" python: dateutil.parser.parse('2020-10-10T00:00:00Z') - ruby: '''YYYY-MM-DD''' + ruby: "'YYYY-MM-DD'" - user: is_object: true key: user @@ -15754,16 +15754,16 @@ paths: csharp: Receipt object: receipt parameters: - - $ref: '#/components/parameters/ReceiptID' - - $ref: '#/components/parameters/unitdp' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/ReceiptID" + - $ref: "#/components/parameters/unitdp" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type Receipts array for updated Receipt content: application/json: schema: - $ref: '#/components/schemas/Receipts' + $ref: "#/components/schemas/Receipts" example: Id: 05b76bf7-4734-4633-a399-7d569a6a25c6 Status: OK @@ -15776,7 +15776,7 @@ paths: User: UserID: d1164823-0ac1-41ad-987b-b4e30fe0b273 EmailAddress: api@xero.com - FirstName: 'API ' + FirstName: "API " LastName: Team UpdatedDateUTC: /Date(1511957179217+0000)/ IsSubscriber: true @@ -15843,13 +15843,13 @@ paths: HasAttachments: false ValidationErrors: [] "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/Receipts' + $ref: "#/components/schemas/Receipts" example: Receipts: - Lineitems: [] @@ -15858,7 +15858,7 @@ paths: Reference: Foobar /Receipts/{ReceiptID}/Attachments: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -15869,7 +15869,7 @@ paths: operationId: getReceiptAttachments summary: Retrieves attachments for a specific expense claim receipt parameters: - - $ref: '#/components/parameters/ReceiptID' + - $ref: "#/components/parameters/ReceiptID" responses: "200": description: Success - return response of type Attachments array of Attachments for a specified Receipt @@ -15877,7 +15877,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: d379c04d-d3aa-4034-95b8-af69a449bd78 Status: OK @@ -15891,7 +15891,7 @@ paths: ContentLength: 495727 /Receipts/{ReceiptID}/Attachments/{AttachmentID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -15902,9 +15902,9 @@ paths: operationId: getReceiptAttachmentById summary: Retrieves a specific attachments from a specific expense claim receipts by using a unique attachment Id parameters: - - $ref: '#/components/parameters/ReceiptID' - - $ref: '#/components/parameters/AttachmentID' - - $ref: '#/components/parameters/ContentType' + - $ref: "#/components/parameters/ReceiptID" + - $ref: "#/components/parameters/AttachmentID" + - $ref: "#/components/parameters/ContentType" responses: "200": description: Success - return response of attachment for Receipt as binary data @@ -15915,7 +15915,7 @@ paths: format: binary /Receipts/{ReceiptID}/Attachments/{FileName}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -15926,9 +15926,9 @@ paths: operationId: getReceiptAttachmentByFileName summary: Retrieves a specific attachment from a specific expense claim receipts by file name parameters: - - $ref: '#/components/parameters/ReceiptID' - - $ref: '#/components/parameters/FileName' - - $ref: '#/components/parameters/ContentType' + - $ref: "#/components/parameters/ReceiptID" + - $ref: "#/components/parameters/FileName" + - $ref: "#/components/parameters/ContentType" responses: "200": description: Success - return response of attachment for Receipt as binary data @@ -15947,9 +15947,9 @@ paths: x-hasAccountingValidationError: true summary: Updates a specific attachment on a specific expense claim receipts by file name parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/ReceiptID' - - $ref: '#/components/parameters/FileName' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/ReceiptID" + - $ref: "#/components/parameters/FileName" responses: "200": description: Success - return response of type Attachments array with updated Attachment for a specified Receipt @@ -15957,7 +15957,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: aeca1ea8-8fd9-4757-96a6-397dc4957a69 Status: OK @@ -15970,7 +15970,7 @@ paths: MimeType: image/jpg ContentLength: 2878711 "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: Byte array of file in body of request @@ -15989,9 +15989,9 @@ paths: x-hasAccountingValidationError: true summary: Creates an attachment on a specific expense claim receipts by file name parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/ReceiptID' - - $ref: '#/components/parameters/FileName' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/ReceiptID" + - $ref: "#/components/parameters/FileName" responses: "200": description: Success - return response of type Attachments array with newly created Attachment for a specified Receipt @@ -15999,7 +15999,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: 01c9a720-b1f1-4477-8de8-ff46d945fd1d Status: OK @@ -16012,7 +16012,7 @@ paths: MimeType: image/jpg ContentLength: 2878711 "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: Byte array of file in body of request @@ -16023,7 +16023,7 @@ paths: format: byte /Receipts/{ReceiptID}/History: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -16034,10 +16034,10 @@ paths: operationId: getReceiptHistory summary: Retrieves a history record for a specific receipt parameters: - - $ref: '#/components/parameters/ReceiptID' + - $ref: "#/components/parameters/ReceiptID" responses: "200": - $ref: '#/components/responses/HistoryRetrieved' + $ref: "#/components/responses/HistoryRetrieved" put: security: - OAuth2: @@ -16075,17 +16075,17 @@ paths: csharp: HistoryRecord object: historyRecord parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/ReceiptID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/ReceiptID" responses: "200": - $ref: '#/components/responses/HistoryRecordCreated' + $ref: "#/components/responses/HistoryRecordCreated" "400": description: Unsupported - return response incorrect exception, API is not able to create HistoryRecord for Receipts content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: ErrorNumber: 10 Type: ValidationException @@ -16097,10 +16097,10 @@ paths: ValidationErrors: - Message: The document with the supplied id was not found for this endpoint. requestBody: - $ref: '#/components/requestBodies/historyRecords' + $ref: "#/components/requestBodies/historyRecords" /RepeatingInvoices: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -16133,7 +16133,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RepeatingInvoices' + $ref: "#/components/schemas/RepeatingInvoices" example: Id: b336833d-a3a8-4a67-ab4c-6280b3ad87b0 Status: OK @@ -16150,7 +16150,7 @@ paths: NextScheduledDate: /Date(1555286400000+0000)/ RepeatingInvoiceID: 428c0d75-909f-4b04-8403-a48dc27283b0 Type: ACCREC - Reference: '[Week]' + Reference: "[Week]" HasAttachments: true ApprovedForSending: false SendCopy: false @@ -16192,15 +16192,15 @@ paths: summary: Creates one or more repeating invoice templates x-hasAccountingValidationError: true parameters: - - $ref: '#/components/parameters/summarizeErrors' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/summarizeErrors" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type RepeatingInvoices array with newly created RepeatingInvoice content: application/json: schema: - $ref: '#/components/schemas/RepeatingInvoices' + $ref: "#/components/schemas/RepeatingInvoices" example: Id: b336833d-a3a8-4a67-ab4c-6280b3ad87b0 Status: OK @@ -16217,7 +16217,7 @@ paths: NextScheduledDate: /Date(1555286400000+0000)/ RepeatingInvoiceID: 428c0d75-909f-4b04-8403-a48dc27283b0 Type: ACCREC - Reference: '[Week]' + Reference: "[Week]" HasAttachments: true ApprovedForSending: false SendCopy: false @@ -16250,14 +16250,14 @@ paths: Total: 5750.00 CurrencyCode: NZD "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: RepeatingInvoices with an array of repeating invoice objects in body of request content: application/json: schema: - $ref: '#/components/schemas/RepeatingInvoices' + $ref: "#/components/schemas/RepeatingInvoices" example: RepeatingInvoices: - Schedule: @@ -16267,7 +16267,7 @@ paths: DueDateType: OFFOLLOWINGMONTH StartDate: /Date(1555286400000+0000)/ Type: ACCREC - Reference: '[Week]' + Reference: "[Week]" ApprovedForSending: false SendCopy: false MarkAsSent: false @@ -16299,15 +16299,15 @@ paths: summary: Creates or deletes one or more repeating invoice templates x-hasAccountingValidationError: true parameters: - - $ref: '#/components/parameters/summarizeErrors' - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/summarizeErrors" + - $ref: "#/components/parameters/idempotencyKey" responses: "200": description: Success - return response of type RepeatingInvoices array with newly created RepeatingInvoice content: application/json: schema: - $ref: '#/components/schemas/RepeatingInvoices' + $ref: "#/components/schemas/RepeatingInvoices" example: Id: b336833d-a3a8-4a67-ab4c-6280b3ad87b0 Status: OK @@ -16324,7 +16324,7 @@ paths: NextScheduledDate: /Date(1555286400000+0000)/ RepeatingInvoiceID: 428c0d75-909f-4b04-8403-a48dc27283b0 Type: ACCREC - Reference: '[Week]' + Reference: "[Week]" HasAttachments: true ApprovedForSending: false SendCopy: false @@ -16357,14 +16357,14 @@ paths: Total: 5750.00 CurrencyCode: NZD "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: RepeatingInvoices with an array of repeating invoice objects in body of request content: application/json: schema: - $ref: '#/components/schemas/RepeatingInvoices' + $ref: "#/components/schemas/RepeatingInvoices" example: RepeatingInvoices: - Schedule: @@ -16374,7 +16374,7 @@ paths: DueDateType: OFFOLLOWINGMONTH StartDate: /Date(1555286400000+0000)/ Type: ACCREC - Reference: '[Week]' + Reference: "[Week]" ApprovedForSending: false SendCopy: false MarkAsSent: false @@ -16398,7 +16398,7 @@ paths: CurrencyCode: NZD /RepeatingInvoices/{RepeatingInvoiceID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -16409,14 +16409,14 @@ paths: operationId: getRepeatingInvoice summary: Retrieves a specific repeating invoice by using a unique repeating invoice Id parameters: - - $ref: '#/components/parameters/RepeatingInvoiceID' + - $ref: "#/components/parameters/RepeatingInvoiceID" responses: "200": description: Success - return response of type Repeating Invoices array with a specified Repeating Invoice content: application/json: schema: - $ref: '#/components/schemas/RepeatingInvoices' + $ref: "#/components/schemas/RepeatingInvoices" example: Id: d9ac3755-7b81-4e3a-bef0-fa8a4f171442 Status: OK @@ -16433,7 +16433,7 @@ paths: NextScheduledDate: /Date(1555286400000+0000)/ RepeatingInvoiceID: 428c0d75-909f-4b04-8403-a48dc27283b0 Type: ACCREC - Reference: '[Week]' + Reference: "[Week]" HasAttachments: true Attachments: - AttachmentID: 2a488b0f-3966-4b6e-a7e1-b6d3286351f2 @@ -16487,15 +16487,15 @@ paths: summary: Deletes a specific repeating invoice template x-hasAccountingValidationError: true parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/RepeatingInvoiceID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/RepeatingInvoiceID" responses: "200": description: Success - return response of type RepeatingInvoices array with deleted Invoice content: application/json: schema: - $ref: '#/components/schemas/RepeatingInvoices' + $ref: "#/components/schemas/RepeatingInvoices" example: Id: b336833d-a3a8-4a67-ab4c-6280b3ad87b0 Status: OK @@ -16512,7 +16512,7 @@ paths: NextScheduledDate: /Date(1555286400000+0000)/ RepeatingInvoiceID: 428c0d75-909f-4b04-8403-a48dc27283b0 Type: ACCREC - Reference: '[Week]' + Reference: "[Week]" HasAttachments: true ApprovedForSending: false SendCopy: false @@ -16545,13 +16545,13 @@ paths: Total: 5750.00 CurrencyCode: NZD "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/RepeatingInvoices' + $ref: "#/components/schemas/RepeatingInvoices" example: Schedule: Period: 1 @@ -16563,7 +16563,7 @@ paths: NextScheduledDate: /Date(1555286400000+0000)/ RepeatingInvoiceID: 428c0d75-909f-4b04-8403-a48dc27283b0 Type: ACCREC - Reference: '[Week]' + Reference: "[Week]" HasAttachments: true ApprovedForSending: false SendCopy: false @@ -16597,7 +16597,7 @@ paths: CurrencyCode: NZD /RepeatingInvoices/{RepeatingInvoiceID}/Attachments: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -16608,7 +16608,7 @@ paths: operationId: getRepeatingInvoiceAttachments summary: Retrieves attachments from a specific repeating invoice parameters: - - $ref: '#/components/parameters/RepeatingInvoiceID' + - $ref: "#/components/parameters/RepeatingInvoiceID" responses: "200": description: Success - return response of type Attachments array with all Attachments for a specified Repeating Invoice @@ -16616,7 +16616,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: b88b807b-3087-474b-a4f9-d8f1b4f5a899 Status: OK @@ -16640,7 +16640,7 @@ paths: ContentLength: 2878711 /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{AttachmentID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -16651,9 +16651,9 @@ paths: operationId: getRepeatingInvoiceAttachmentById summary: Retrieves a specific attachment from a specific repeating invoice parameters: - - $ref: '#/components/parameters/RepeatingInvoiceID' - - $ref: '#/components/parameters/AttachmentID' - - $ref: '#/components/parameters/ContentType' + - $ref: "#/components/parameters/RepeatingInvoiceID" + - $ref: "#/components/parameters/AttachmentID" + - $ref: "#/components/parameters/ContentType" responses: "200": description: Success - return response of attachment for Repeating Invoice as binary data @@ -16664,7 +16664,7 @@ paths: format: binary /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -16675,9 +16675,9 @@ paths: operationId: getRepeatingInvoiceAttachmentByFileName summary: Retrieves a specific attachment from a specific repeating invoices by file name parameters: - - $ref: '#/components/parameters/RepeatingInvoiceID' - - $ref: '#/components/parameters/FileName' - - $ref: '#/components/parameters/ContentType' + - $ref: "#/components/parameters/RepeatingInvoiceID" + - $ref: "#/components/parameters/FileName" + - $ref: "#/components/parameters/ContentType" responses: "200": description: Success - return response of attachment for Repeating Invoice as binary data @@ -16696,9 +16696,9 @@ paths: x-hasAccountingValidationError: true summary: Updates a specific attachment from a specific repeating invoices by file name parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/RepeatingInvoiceID' - - $ref: '#/components/parameters/FileName' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/RepeatingInvoiceID" + - $ref: "#/components/parameters/FileName" responses: "200": description: Success - return response of type Attachments array with specified Attachment for a specified Repeating Invoice @@ -16706,7 +16706,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: 61b24d5c-4d6e-468f-9de1-abbc234b239a Status: OK @@ -16719,7 +16719,7 @@ paths: MimeType: image/jpg ContentLength: 2878711 "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: Byte array of file in body of request @@ -16738,9 +16738,9 @@ paths: x-hasAccountingValidationError: true summary: Creates an attachment from a specific repeating invoices by file name parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/RepeatingInvoiceID' - - $ref: '#/components/parameters/FileName' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/RepeatingInvoiceID" + - $ref: "#/components/parameters/FileName" responses: "200": description: Success - return response of type Attachments array with updated Attachment for a specified Repeating Invoice @@ -16748,7 +16748,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachments' + $ref: "#/components/schemas/Attachments" example: Id: 219de8c0-ee70-48af-a000-594eba14b417 Status: OK @@ -16761,7 +16761,7 @@ paths: MimeType: image/jpg ContentLength: 2878711 "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: Byte array of file in body of request @@ -16772,7 +16772,7 @@ paths: format: byte /RepeatingInvoices/{RepeatingInvoiceID}/History: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -16783,10 +16783,10 @@ paths: operationId: getRepeatingInvoiceHistory summary: Retrieves history record for a specific repeating invoice parameters: - - $ref: '#/components/parameters/RepeatingInvoiceID' + - $ref: "#/components/parameters/RepeatingInvoiceID" responses: "200": - $ref: '#/components/responses/HistoryRetrieved' + $ref: "#/components/responses/HistoryRetrieved" put: security: - OAuth2: @@ -16824,18 +16824,18 @@ paths: csharp: HistoryRecord object: historyRecord parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/RepeatingInvoiceID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/RepeatingInvoiceID" responses: "200": - $ref: '#/components/responses/HistoryRecordCreated' + $ref: "#/components/responses/HistoryRecordCreated" "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: - $ref: '#/components/requestBodies/historyRecords' + $ref: "#/components/requestBodies/historyRecords" /Reports/TenNinetyNine: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -16859,7 +16859,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Reports' + $ref: "#/components/schemas/Reports" example: Id: 8b474ddb-9ef4-457c-8640-1c0e3670ea0e Status: OK @@ -16963,7 +16963,7 @@ paths: FederalTaxClassification: C_CORP /Reports/AgedPayablesByContact: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -16989,15 +16989,15 @@ paths: schema: type: string format: date - - $ref: '#/components/parameters/FromDate' - - $ref: '#/components/parameters/ToDate' + - $ref: "#/components/parameters/FromDate" + - $ref: "#/components/parameters/ToDate" responses: "200": description: Success - return response of type ReportWithRows content: application/json: schema: - $ref: '#/components/schemas/ReportWithRows' + $ref: "#/components/schemas/ReportWithRows" example: Id: 5a33f9d4-44a6-4467-a812-4f025506ee35 Status: OK @@ -17100,7 +17100,7 @@ paths: - Value: "250.00" /Reports/AgedReceivablesByContact: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -17126,15 +17126,15 @@ paths: schema: type: string format: date - - $ref: '#/components/parameters/FromDate' - - $ref: '#/components/parameters/ToDate' + - $ref: "#/components/parameters/FromDate" + - $ref: "#/components/parameters/ToDate" responses: "200": description: Success - return response of type ReportWithRows content: application/json: schema: - $ref: '#/components/schemas/ReportWithRows' + $ref: "#/components/schemas/ReportWithRows" example: Id: b977b607-955d-47cb-92fd-7c29b3dd755c Status: OK @@ -17271,7 +17271,7 @@ paths: - Value: "150.00" /Reports/BalanceSheet: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -17340,7 +17340,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ReportWithRows' + $ref: "#/components/schemas/ReportWithRows" example: Id: 2ddba304-6ed3-4da4-b185-3b6289699653 Status: OK @@ -17665,7 +17665,7 @@ paths: - Value: "464.00" /Reports/BankSummary: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -17675,15 +17675,15 @@ paths: operationId: getReportBankSummary summary: Retrieves report for bank summary parameters: - - $ref: '#/components/parameters/FromDate' - - $ref: '#/components/parameters/ToDate' + - $ref: "#/components/parameters/FromDate" + - $ref: "#/components/parameters/ToDate" responses: "200": description: Success - return response of type ReportWithRows content: application/json: schema: - $ref: '#/components/schemas/ReportWithRows' + $ref: "#/components/schemas/ReportWithRows" example: Id: ae58d0ec-9c5c-455f-b96e-690107579257 Status: OK @@ -17735,7 +17735,7 @@ paths: - Value: "10.00" /Reports/{ReportID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -17759,10 +17759,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ReportWithRows' + $ref: "#/components/schemas/ReportWithRows" /Reports/BudgetSummary: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -17797,7 +17797,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ReportWithRows' + $ref: "#/components/schemas/ReportWithRows" example: Id: 9f1e2722-0d98-4669-890f-f8f4217c968b Status: OK @@ -17886,7 +17886,7 @@ paths: - Value: "0.00" /Reports/ExecutiveSummary: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -17909,7 +17909,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ReportWithRows' + $ref: "#/components/schemas/ReportWithRows" example: Id: 068d3505-ac37-43f3-8135-f912a5963d8a Status: OK @@ -18090,7 +18090,7 @@ paths: - Value: 0.0% /Reports: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -18105,10 +18105,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ReportWithRows' + $ref: "#/components/schemas/ReportWithRows" /Reports/ProfitAndLoss: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -18118,8 +18118,8 @@ paths: operationId: getReportProfitAndLoss summary: Retrieves report for profit and loss parameters: - - $ref: '#/components/parameters/FromDate' - - $ref: '#/components/parameters/ToDate' + - $ref: "#/components/parameters/FromDate" + - $ref: "#/components/parameters/ToDate" - in: query name: periods description: The number of periods to compare (integer between 1 and 12) @@ -18186,10 +18186,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ReportWithRows' + $ref: "#/components/schemas/ReportWithRows" /Reports/TrialBalance: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -18220,7 +18220,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ReportWithRows' + $ref: "#/components/schemas/ReportWithRows" example: Id: 0b3ee35e-b97c-4b3c-b7e2-9a465233e329 Status: OK @@ -18705,7 +18705,7 @@ paths: - Value: "46019.00" /Setup: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" post: security: - OAuth2: @@ -18715,7 +18715,7 @@ paths: operationId: postSetup summary: Sets the chart of accounts, the conversion date and conversion balances parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" x-example: - account: is_object: true @@ -18815,7 +18815,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ImportSummaryObject' + $ref: "#/components/schemas/ImportSummaryObject" example: Id: 80dcb65b-4d14-4350-84e6-1438a809244a Status: OK @@ -18840,7 +18840,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Setup' + $ref: "#/components/schemas/Setup" example: ConversionDate: {} ConversionBalances: [] @@ -18865,7 +18865,7 @@ paths: ReportingCode: LIA.CUR.PAY /TaxRates: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -18898,7 +18898,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TaxRates' + $ref: "#/components/schemas/TaxRates" example: Id: 455d494d-9706-465b-b584-7086ca406b27 Status: OK @@ -18994,7 +18994,7 @@ paths: operationId: createTaxRates summary: Creates one or more tax rates parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" x-hasAccountingValidationError: true x-example: - taxComponent: @@ -19069,7 +19069,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TaxRates' + $ref: "#/components/schemas/TaxRates" example: Id: 9d2c5e56-fab4-450b-a5ff-d47409508eab Status: OK @@ -19093,14 +19093,14 @@ paths: IsCompound: false IsNonRecoverable: false "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: TaxRates array with TaxRate object in body of request content: application/json: schema: - $ref: '#/components/schemas/TaxRates' + $ref: "#/components/schemas/TaxRates" example: TaxRates: - Name: CA State Tax @@ -19116,7 +19116,7 @@ paths: operationId: updateTaxRate summary: Updates tax rates parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" x-hasAccountingValidationError: true x-example: - taxComponent: @@ -19191,7 +19191,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TaxRates' + $ref: "#/components/schemas/TaxRates" example: Id: 12f4c453-2e25-41aa-a52f-6faaf6c05832 Status: OK @@ -19215,13 +19215,13 @@ paths: IsCompound: false IsNonRecoverable: false "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/TaxRates' + $ref: "#/components/schemas/TaxRates" example: TaxRates: - Name: State Tax NY @@ -19232,7 +19232,7 @@ paths: ReportTaxType: INPUT /TaxRates/{TaxType}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -19243,14 +19243,14 @@ paths: operationId: getTaxRateByTaxType summary: Retrieves a specific tax rate according to given TaxType code parameters: - - $ref: '#/components/parameters/TaxType' + - $ref: "#/components/parameters/TaxType" responses: "200": description: Success - return response of type TaxRates array with one TaxRate content: application/json: schema: - $ref: '#/components/schemas/TaxRates' + $ref: "#/components/schemas/TaxRates" example: Id: 455d494d-9706-465b-b584-7086ca406b27 Status: OK @@ -19275,7 +19275,7 @@ paths: IsNonRecoverable: false /TrackingCategories: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -19316,7 +19316,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TrackingCategories' + $ref: "#/components/schemas/TrackingCategories" example: Id: cec55068-8061-48e5-ac83-c77e7c54cf3d Status: OK @@ -19340,7 +19340,7 @@ paths: operationId: createTrackingCategory summary: Create tracking categories parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" x-hasAccountingValidationError: true x-example: - trackingCategory: @@ -19359,7 +19359,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TrackingCategories' + $ref: "#/components/schemas/TrackingCategories" example: Id: 1a9f8e03-9916-4a42-93a9-e8fa4902d49c Status: OK @@ -19371,19 +19371,19 @@ paths: TrackingCategoryID: b1df776b-b093-4730-b6ea-590cca40e723 Options: [] "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: TrackingCategory object in body of request content: application/json: schema: - $ref: '#/components/schemas/TrackingCategory' + $ref: "#/components/schemas/TrackingCategory" example: name: FooBar /TrackingCategories/{TrackingCategoryID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -19394,14 +19394,14 @@ paths: operationId: getTrackingCategory summary: Retrieves specific tracking categories and options using a unique tracking category Id parameters: - - $ref: '#/components/parameters/TrackingCategoryID' + - $ref: "#/components/parameters/TrackingCategoryID" responses: "200": description: Success - return response of type TrackingCategories array of specified TrackingCategory content: application/json: schema: - $ref: '#/components/schemas/TrackingCategories' + $ref: "#/components/schemas/TrackingCategories" example: Id: b75b8862-39c0-45a8-82b8-30ab4831996b Status: OK @@ -19433,15 +19433,15 @@ paths: default: Foobar object: trackingCategory parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/TrackingCategoryID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/TrackingCategoryID" responses: "200": description: Success - return response of type TrackingCategories array of updated TrackingCategory content: application/json: schema: - $ref: '#/components/schemas/TrackingCategories' + $ref: "#/components/schemas/TrackingCategories" example: Id: 55438774-f87d-4731-b586-799cf0f914ed Status: OK @@ -19453,13 +19453,13 @@ paths: TrackingCategoryID: b1df776b-b093-4730-b6ea-590cca40e723 Options: [] "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/TrackingCategory' + $ref: "#/components/schemas/TrackingCategory" example: Name: Avengers delete: @@ -19471,14 +19471,14 @@ paths: operationId: deleteTrackingCategory summary: Deletes a specific tracking category parameters: - - $ref: '#/components/parameters/TrackingCategoryID' + - $ref: "#/components/parameters/TrackingCategoryID" responses: "200": description: Success - return response of type TrackingCategories array of deleted TrackingCategory content: application/json: schema: - $ref: '#/components/schemas/TrackingCategories' + $ref: "#/components/schemas/TrackingCategories" example: Id: ca7f8145-c8a5-4366-a2fb-784edc0cfbb7 Status: OK @@ -19490,10 +19490,10 @@ paths: TrackingCategoryID: 0390bdfd-94f2-49d6-b7a0-4a38c46ebf03 Options: [] "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" /TrackingCategories/{TrackingCategoryID}/Options: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" put: security: - OAuth2: @@ -19515,15 +19515,15 @@ paths: default: Foobar object: trackingOption parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/TrackingCategoryID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/TrackingCategoryID" responses: "200": description: Success - return response of type TrackingOptions array of options for a specified category content: application/json: schema: - $ref: '#/components/schemas/TrackingOptions' + $ref: "#/components/schemas/TrackingOptions" example: Id: 923be702-d124-4f5c-a568-760906538d8e Status: OK @@ -19538,19 +19538,19 @@ paths: IsArchived: false IsActive: true "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true description: TrackingOption object in body of request content: application/json: schema: - $ref: '#/components/schemas/TrackingOption' + $ref: "#/components/schemas/TrackingOption" example: - name: ' Bar' + name: " Bar" /TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" post: security: - OAuth2: @@ -19572,16 +19572,16 @@ paths: default: Foobar object: trackingOption parameters: - - $ref: '#/components/parameters/idempotencyKey' - - $ref: '#/components/parameters/TrackingCategoryID' - - $ref: '#/components/parameters/TrackingOptionID' + - $ref: "#/components/parameters/idempotencyKey" + - $ref: "#/components/parameters/TrackingCategoryID" + - $ref: "#/components/parameters/TrackingOptionID" responses: "200": description: Success - return response of type TrackingOptions array of options for a specified category content: application/json: schema: - $ref: '#/components/schemas/TrackingOptions' + $ref: "#/components/schemas/TrackingOptions" example: Id: 923be702-d124-4f5c-a568-760906538d8e Status: OK @@ -19596,13 +19596,13 @@ paths: IsArchived: false IsActive: true "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/TrackingOption' + $ref: "#/components/schemas/TrackingOption" example: name: Vision delete: @@ -19614,15 +19614,15 @@ paths: operationId: deleteTrackingOptions summary: Deletes a specific option for a specific tracking category parameters: - - $ref: '#/components/parameters/TrackingCategoryID' - - $ref: '#/components/parameters/TrackingOptionID' + - $ref: "#/components/parameters/TrackingCategoryID" + - $ref: "#/components/parameters/TrackingOptionID" responses: "200": description: Success - return response of type TrackingOptions array of remaining options for a specified category content: application/json: schema: - $ref: '#/components/schemas/TrackingOptions' + $ref: "#/components/schemas/TrackingOptions" example: Id: d985866e-0831-418f-a07c-4d843ff66d25 Status: OK @@ -19637,10 +19637,10 @@ paths: IsArchived: false IsActive: false "400": - $ref: '#/components/responses/400Error' + $ref: "#/components/responses/400Error" /Users: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -19651,7 +19651,7 @@ paths: operationId: getUsers summary: Retrieves users parameters: - - $ref: '#/components/parameters/ifModifiedSince' + - $ref: "#/components/parameters/ifModifiedSince" - in: query name: where description: Filter by an any element @@ -19670,7 +19670,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Users' + $ref: "#/components/schemas/Users" example: Id: 17932a4e-4948-4d50-8672-4ef0e1dd90c5 Status: OK @@ -19686,14 +19686,14 @@ paths: OrganisationRole: FINANCIALADVISER - UserID: d1164823-0ac1-41ad-987b-b4e30fe0b273 EmailAddress: api@xero.com - FirstName: 'API ' + FirstName: "API " LastName: Team UpdatedDateUTC: /Date(1511957179217+0000)/ IsSubscriber: true OrganisationRole: FINANCIALADVISER /Users/{UserID}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -19704,14 +19704,14 @@ paths: operationId: getUser summary: Retrieves a specific user parameters: - - $ref: '#/components/parameters/UserID' + - $ref: "#/components/parameters/UserID" responses: "200": description: Success - return response of type Users array of specified User content: application/json: schema: - $ref: '#/components/schemas/Users' + $ref: "#/components/schemas/Users" example: Id: 51250ce8-1b35-4ba4-b404-dc94ff75bd87 Status: OK @@ -19758,7 +19758,7 @@ components: content: application/json: schema: - $ref: '#/components/schemas/HistoryRecords' + $ref: "#/components/schemas/HistoryRecords" example: HistoryRecords: - Details: Hello World @@ -20191,13 +20191,13 @@ components: content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" HistoryRecordCreated: description: Success - return response of type HistoryRecords array of HistoryRecord objects content: application/json: schema: - $ref: '#/components/schemas/HistoryRecords' + $ref: "#/components/schemas/HistoryRecords" example: Id: d7525479-3392-44c0-bb37-ff4a0b5df5bd Status: OK @@ -20213,7 +20213,7 @@ components: content: application/json: schema: - $ref: '#/components/schemas/HistoryRecords' + $ref: "#/components/schemas/HistoryRecords" example: Id: cd54cc7b-b721-4207-b11d-7d13c7902f91 Status: OK @@ -20358,7 +20358,7 @@ components: Accounts: type: array items: - $ref: '#/components/schemas/Account' + $ref: "#/components/schemas/Account" Account: type: object externalDocs: @@ -20379,7 +20379,7 @@ components: format: uuid example: 00000000-0000-0000-0000-000000000000 Type: - $ref: '#/components/schemas/AccountType' + $ref: "#/components/schemas/AccountType" type: string BankAccountNumber: description: For bank accounts only (Account Type BANK) @@ -20404,7 +20404,7 @@ components: - NONE - "" CurrencyCode: - $ref: '#/components/schemas/CurrencyCode' + $ref: "#/components/schemas/CurrencyCode" type: string TaxType: description: The tax type from taxRates @@ -20477,7 +20477,7 @@ components: description: Displays array of validation error messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" AccountType: description: See Account Types type: string @@ -20507,7 +20507,7 @@ components: Attachments: type: array items: - $ref: '#/components/schemas/Attachment' + $ref: "#/components/schemas/Attachment" Attachment: type: object externalDocs: @@ -20541,16 +20541,16 @@ components: x-objectArrayKey: bank_transactions properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" Warnings: description: Displays array of warning messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" BankTransactions: type: array items: - $ref: '#/components/schemas/BankTransaction' + $ref: "#/components/schemas/BankTransaction" BankTransaction: externalDocs: url: http://developer.xero.com/documentation/api/banktransactions/ @@ -20568,14 +20568,14 @@ components: - RECEIVE-TRANSFER - SPEND-TRANSFER Contact: - $ref: '#/components/schemas/Contact' + $ref: "#/components/schemas/Contact" LineItems: description: See LineItems type: array items: - $ref: '#/components/schemas/LineItem' + $ref: "#/components/schemas/LineItem" BankAccount: - $ref: '#/components/schemas/Account' + $ref: "#/components/schemas/Account" IsReconciled: description: Boolean to show if transaction is reconciled type: boolean @@ -20587,7 +20587,7 @@ components: description: Reference for the transaction. Only supported for SPEND and RECEIVE transactions. type: string CurrencyCode: - $ref: '#/components/schemas/CurrencyCode' + $ref: "#/components/schemas/CurrencyCode" type: string CurrencyRate: description: Exchange rate to base currency when money is spent or received. e.g.0.7500 Only used for bank transactions in non base currency. If this isn’t specified for non base currency accounts then either the user-defined rate (preference) or the XE.com day rate will be used. Setting currency is only supported on overpayments. @@ -20605,7 +20605,7 @@ components: - DELETED - VOIDED LineAmountTypes: - $ref: '#/components/schemas/LineAmountTypes' + $ref: "#/components/schemas/LineAmountTypes" type: string SubTotal: description: Total of bank transaction excluding taxes @@ -20658,7 +20658,7 @@ components: description: Displays array of validation error messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" required: - Type - LineItems @@ -20713,7 +20713,7 @@ components: format: double x-is-money: true Item: - $ref: '#/components/schemas/LineItemItem' + $ref: "#/components/schemas/LineItemItem" LineAmount: description: If you wish to omit either the Quantity or UnitAmount you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if either a DiscountRate or DiscountAmount has been used i.e. LineAmount = Quantity * Unit Amount * ((100 - DiscountRate)/100) or LineAmount = (Quantity * UnitAmount) - DiscountAmount type: number @@ -20723,7 +20723,7 @@ components: description: Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 elements. type: array items: - $ref: '#/components/schemas/LineItemTracking' + $ref: "#/components/schemas/LineItemTracking" DiscountRate: description: Percentage discount being applied to a line item (only supported on ACCREC invoices – ACC PAY invoices and credit notes in Xero do not support discounts type: number @@ -20755,7 +20755,7 @@ components: description: An array of tax components defined for this line item type: array items: - $ref: '#/components/schemas/TaxBreakdownComponent' + $ref: "#/components/schemas/TaxBreakdownComponent" type: object LineItemItem: properties: @@ -20802,15 +20802,15 @@ components: BankTransfers: type: array items: - $ref: '#/components/schemas/BankTransfer' + $ref: "#/components/schemas/BankTransfer" BankTransfer: externalDocs: url: http://developer.xero.com/documentation/api/bank-transfers/ properties: FromBankAccount: - $ref: '#/components/schemas/Account' + $ref: "#/components/schemas/Account" ToBankAccount: - $ref: '#/components/schemas/Account' + $ref: "#/components/schemas/Account" Amount: description: amount of the transaction type: number @@ -20870,7 +20870,7 @@ components: description: Displays array of validation error messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" required: - FromBankAccount - ToBankAccount @@ -20883,13 +20883,13 @@ components: BatchPayments: type: array items: - $ref: '#/components/schemas/BatchPayment' + $ref: "#/components/schemas/BatchPayment" BatchPayment: externalDocs: url: http://developer.xero.com/documentation/api/BatchPayments/ properties: Account: - $ref: '#/components/schemas/Account' + $ref: "#/components/schemas/Account" Reference: description: (NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero. type: string @@ -20930,7 +20930,7 @@ components: description: An array of payments type: array items: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" Type: description: PAYBATCH for bill payments or RECBATCH for sales invoice payments (read-only) readOnly: true @@ -20965,7 +20965,7 @@ components: description: Displays array of validation error messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" type: object BatchPaymentDetails: description: Bank details for use on a batch payment stored with each contact @@ -21028,7 +21028,7 @@ components: BrandingThemes: type: array items: - $ref: '#/components/schemas/BrandingTheme' + $ref: "#/components/schemas/BrandingTheme" BrandingTheme: externalDocs: url: http://developer.xero.com/documentation/api/branding-themes/ @@ -21065,7 +21065,7 @@ components: PaymentServices: type: array items: - $ref: '#/components/schemas/PaymentService' + $ref: "#/components/schemas/PaymentService" PaymentService: externalDocs: url: http://developer.xero.com/documentation/api/branding-themes/ @@ -21090,22 +21090,22 @@ components: description: Displays array of validation error messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" Contacts: type: object x-objectArrayKey: contacts properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" Warnings: description: Displays array of warning messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" Contacts: type: array items: - $ref: '#/components/schemas/Contact' + $ref: "#/components/schemas/Contact" Contact: externalDocs: url: http://developer.xero.com/documentation/api/contacts/ @@ -21157,7 +21157,7 @@ components: description: See contact persons type: array items: - $ref: '#/components/schemas/ContactPerson' + $ref: "#/components/schemas/ContactPerson" BankAccountDetails: description: Bank account number of contact type: string @@ -21183,12 +21183,12 @@ components: description: Store certain address types for a contact – see address types type: array items: - $ref: '#/components/schemas/Address' + $ref: "#/components/schemas/Address" Phones: description: Store certain phone types for a contact – see phone types type: array items: - $ref: '#/components/schemas/Phone' + $ref: "#/components/schemas/Phone" IsSupplier: description: true or false – Boolean that describes if a contact that has any AP invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts payable invoice is generated against this contact. type: boolean @@ -21210,7 +21210,7 @@ components: - EXCLUSIVE - NONE DefaultCurrency: - $ref: '#/components/schemas/CurrencyCode' + $ref: "#/components/schemas/CurrencyCode" type: string XeroNetworkKey: description: Store XeroNetworkKey for contacts. @@ -21225,12 +21225,12 @@ components: description: The default sales tracking categories for contacts type: array items: - $ref: '#/components/schemas/SalesTrackingCategory' + $ref: "#/components/schemas/SalesTrackingCategory" PurchasesTrackingCategories: description: The default purchases tracking categories for contacts type: array items: - $ref: '#/components/schemas/SalesTrackingCategory' + $ref: "#/components/schemas/SalesTrackingCategory" TrackingCategoryName: description: The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories type: string @@ -21238,7 +21238,7 @@ components: description: The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories type: string PaymentTerms: - $ref: '#/components/schemas/PaymentTerm' + $ref: "#/components/schemas/PaymentTerm" UpdatedDateUTC: description: UTC timestamp of last update to contact type: string @@ -21249,15 +21249,15 @@ components: description: Displays which contact groups a contact is included in type: array items: - $ref: '#/components/schemas/ContactGroup' + $ref: "#/components/schemas/ContactGroup" Website: description: Website address for contact (read only) readOnly: true type: string BrandingTheme: - $ref: '#/components/schemas/BrandingTheme' + $ref: "#/components/schemas/BrandingTheme" BatchPayments: - $ref: '#/components/schemas/BatchPaymentDetails' + $ref: "#/components/schemas/BatchPaymentDetails" Discount: description: The default discount rate for the contact (read only) readOnly: true @@ -21265,12 +21265,12 @@ components: format: double x-is-money: true Balances: - $ref: '#/components/schemas/Balances' + $ref: "#/components/schemas/Balances" Attachments: description: Displays array of attachments from the API type: array items: - $ref: '#/components/schemas/Attachment' + $ref: "#/components/schemas/Attachment" HasAttachments: description: A boolean to indicate if a contact has an attachment type: boolean @@ -21280,7 +21280,7 @@ components: description: Displays validation errors returned from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" HasValidationErrors: description: A boolean to indicate if a contact has an validation errors type: boolean @@ -21297,7 +21297,7 @@ components: Budgets: type: array items: - $ref: '#/components/schemas/Budget' + $ref: "#/components/schemas/Budget" Budget: type: object externalDocs: @@ -21326,11 +21326,11 @@ components: BudgetLines: type: array items: - $ref: '#/components/schemas/BudgetLine' + $ref: "#/components/schemas/BudgetLine" Tracking: type: array items: - $ref: '#/components/schemas/TrackingCategory' + $ref: "#/components/schemas/TrackingCategory" BudgetLine: type: object externalDocs: @@ -21347,7 +21347,7 @@ components: BudgetBalances: type: array items: - $ref: '#/components/schemas/BudgetBalance' + $ref: "#/components/schemas/BudgetBalance" BudgetBalance: type: object properties: @@ -21374,9 +21374,9 @@ components: description: The raw AccountsReceivable(sales invoices) and AccountsPayable(bills) outstanding and overdue amounts, not converted to base currency (read only) properties: AccountsReceivable: - $ref: '#/components/schemas/AccountsReceivable' + $ref: "#/components/schemas/AccountsReceivable" AccountsPayable: - $ref: '#/components/schemas/AccountsPayable' + $ref: "#/components/schemas/AccountsPayable" AccountsReceivable: type: object properties: @@ -21406,7 +21406,7 @@ components: CISSettings: type: array items: - $ref: '#/components/schemas/CISSetting' + $ref: "#/components/schemas/CISSetting" CISSetting: externalDocs: url: http://developer.xero.com/documentation/api/contacts/ @@ -21427,7 +21427,7 @@ components: CISSettings: type: array items: - $ref: '#/components/schemas/CISOrgSetting' + $ref: "#/components/schemas/CISOrgSetting" CISOrgSetting: externalDocs: url: https://developer.xero.com/documentation/api/organisation @@ -21468,7 +21468,7 @@ components: ContactGroups: type: array items: - $ref: '#/components/schemas/ContactGroup' + $ref: "#/components/schemas/ContactGroup" ContactGroup: externalDocs: url: http://developer.xero.com/documentation/api/contactgroups/ @@ -21490,7 +21490,7 @@ components: description: The ContactID and Name of Contacts in a contact group. Returned on GETs when the ContactGroupID is supplied in the URL. type: array items: - $ref: '#/components/schemas/Contact' + $ref: "#/components/schemas/Contact" type: object RequestEmpty: externalDocs: @@ -21505,16 +21505,16 @@ components: x-objectArrayKey: credit_notes properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" Warnings: description: Displays array of warning messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" CreditNotes: type: array items: - $ref: '#/components/schemas/CreditNote' + $ref: "#/components/schemas/CreditNote" CreditNote: externalDocs: url: http://developer.xero.com/documentation/api/credit-notes/ @@ -21526,7 +21526,7 @@ components: - ACCPAYCREDIT - ACCRECCREDIT Contact: - $ref: '#/components/schemas/Contact' + $ref: "#/components/schemas/Contact" Date: description: The date the credit note is issued YYYY-MM-DD. If the Date element is not specified then it will default to the current date based on the timezone setting of the organisation type: string @@ -21546,13 +21546,13 @@ components: - PAID - VOIDED LineAmountTypes: - $ref: '#/components/schemas/LineAmountTypes' + $ref: "#/components/schemas/LineAmountTypes" type: string LineItems: description: See Invoice Line Items type: array items: - $ref: '#/components/schemas/LineItem' + $ref: "#/components/schemas/LineItem" SubTotal: description: The subtotal of the credit note excluding taxes type: number @@ -21588,7 +21588,7 @@ components: readOnly: true CurrencyCode: description: The specified currency code - $ref: '#/components/schemas/CurrencyCode' + $ref: "#/components/schemas/CurrencyCode" type: string FullyPaidOnDate: description: Date when credit note was fully paid(UTC format) @@ -21622,7 +21622,7 @@ components: description: See Allocations type: array items: - $ref: '#/components/schemas/Allocation' + $ref: "#/components/schemas/Allocation" AppliedAmount: description: The amount of applied to an invoice type: number @@ -21633,7 +21633,7 @@ components: description: See Payments type: array items: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" BrandingThemeID: description: See BrandingThemes type: string @@ -21655,17 +21655,17 @@ components: description: Displays array of validation error messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" Warnings: description: Displays array of warning messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" InvoiceAddresses: description: An array of addresses used to auto calculate sales tax type: array items: - $ref: '#/components/schemas/InvoiceAddress' + $ref: "#/components/schemas/InvoiceAddress" type: object Allocations: type: object @@ -21674,7 +21674,7 @@ components: Allocations: type: array items: - $ref: '#/components/schemas/Allocation' + $ref: "#/components/schemas/Allocation" Allocation: externalDocs: url: http://developer.xero.com/documentation/api/prepayments/ @@ -21684,13 +21684,13 @@ components: type: string format: uuid Invoice: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" Overpayment: - $ref: '#/components/schemas/Overpayment' + $ref: "#/components/schemas/Overpayment" Prepayment: - $ref: '#/components/schemas/Prepayment' + $ref: "#/components/schemas/Prepayment" CreditNote: - $ref: '#/components/schemas/CreditNote' + $ref: "#/components/schemas/CreditNote" Amount: description: the amount being applied to the invoice type: number @@ -21711,7 +21711,7 @@ components: description: Displays array of validation error messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" required: - Amount - Invoice @@ -21724,13 +21724,13 @@ components: Currencies: type: array items: - $ref: '#/components/schemas/Currency' + $ref: "#/components/schemas/Currency" Currency: externalDocs: url: http://developer.xero.com/documentation/api/currencies/ properties: Code: - $ref: '#/components/schemas/CurrencyCode' + $ref: "#/components/schemas/CurrencyCode" type: string Description: description: Name of Currency @@ -22085,7 +22085,7 @@ components: Employees: type: array items: - $ref: '#/components/schemas/Employee' + $ref: "#/components/schemas/Employee" Employee: externalDocs: url: http://developer.xero.com/documentation/api/employees/ @@ -22111,7 +22111,7 @@ components: maxLength: 255 type: string ExternalLink: - $ref: '#/components/schemas/ExternalLink' + $ref: "#/components/schemas/ExternalLink" UpdatedDateUTC: type: string x-is-msdate-time: true @@ -22125,7 +22125,7 @@ components: description: Displays array of validation error messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" type: object ExpenseClaims: type: object @@ -22134,7 +22134,7 @@ components: ExpenseClaims: type: array items: - $ref: '#/components/schemas/ExpenseClaim' + $ref: "#/components/schemas/ExpenseClaim" ExpenseClaim: externalDocs: url: http://developer.xero.com/documentation/api/expense-claims/ @@ -22156,13 +22156,13 @@ components: description: See Payments type: array items: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" User: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" Receipts: type: array items: - $ref: '#/components/schemas/Receipt' + $ref: "#/components/schemas/Receipt" UpdatedDateUTC: description: Last modified date UTC format type: string @@ -22209,7 +22209,7 @@ components: HistoryRecords: type: array items: - $ref: '#/components/schemas/HistoryRecord' + $ref: "#/components/schemas/HistoryRecord" HistoryRecord: externalDocs: url: https://developer.xero.com/documentation/api/history-and-notes @@ -22235,16 +22235,16 @@ components: x-objectArrayKey: invoices properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" Warnings: description: Displays array of warning messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" Invoices: type: array items: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" Invoice: externalDocs: url: http://developer.xero.com/documentation/api/invoices/ @@ -22262,12 +22262,12 @@ components: - AROVERPAYMENT - ARPREPAYMENT Contact: - $ref: '#/components/schemas/Contact' + $ref: "#/components/schemas/Contact" LineItems: description: See LineItems type: array items: - $ref: '#/components/schemas/LineItem' + $ref: "#/components/schemas/LineItem" Date: description: Date invoice was issued – YYYY-MM-DD. If the Date element is not specified it will default to the current date based on the timezone setting of the organisation type: string @@ -22277,7 +22277,7 @@ components: type: string x-is-msdate: true LineAmountTypes: - $ref: '#/components/schemas/LineAmountTypes' + $ref: "#/components/schemas/LineAmountTypes" type: string InvoiceNumber: description: ACCREC – Unique alpha numeric code identifying invoice (when missing will auto-generate from your Organisation Invoice Settings) (max length = 255) @@ -22294,7 +22294,7 @@ components: description: URL link to a source document – shown as “Go to [appName]” in the Xero app type: string CurrencyCode: - $ref: '#/components/schemas/CurrencyCode' + $ref: "#/components/schemas/CurrencyCode" type: string CurrencyRate: description: The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used. (max length = [18].[6]) @@ -22381,19 +22381,19 @@ components: readOnly: true type: array items: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" Prepayments: description: See Prepayments readOnly: true type: array items: - $ref: '#/components/schemas/Prepayment' + $ref: "#/components/schemas/Prepayment" Overpayments: description: See Overpayments readOnly: true type: array items: - $ref: '#/components/schemas/Overpayment' + $ref: "#/components/schemas/Overpayment" AmountDue: description: Amount remaining to be paid on invoice readOnly: true @@ -22428,12 +22428,12 @@ components: readOnly: true type: array items: - $ref: '#/components/schemas/CreditNote' + $ref: "#/components/schemas/CreditNote" Attachments: description: Displays array of attachments from the API type: array items: - $ref: '#/components/schemas/Attachment' + $ref: "#/components/schemas/Attachment" HasErrors: description: A boolean to indicate if a invoice has an validation errors type: boolean @@ -22446,17 +22446,17 @@ components: description: Displays array of validation error messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" Warnings: description: Displays array of warning messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" InvoiceAddresses: description: An array of addresses used to auto calculate sales tax type: array items: - $ref: '#/components/schemas/InvoiceAddress' + $ref: "#/components/schemas/InvoiceAddress" type: object OnlineInvoices: type: object @@ -22465,7 +22465,7 @@ components: OnlineInvoices: type: array items: - $ref: '#/components/schemas/OnlineInvoice' + $ref: "#/components/schemas/OnlineInvoice" OnlineInvoice: externalDocs: url: http://developer.xero.com/documentation/api/invoices/ @@ -22481,7 +22481,7 @@ components: InvoiceReminders: type: array items: - $ref: '#/components/schemas/InvoiceReminder' + $ref: "#/components/schemas/InvoiceReminder" InvoiceReminder: externalDocs: url: http://developer.xero.com/documentation/api/invoice-reminders/ @@ -22497,7 +22497,7 @@ components: Items: type: array items: - $ref: '#/components/schemas/Item' + $ref: "#/components/schemas/Item" Item: externalDocs: url: http://developer.xero.com/documentation/api/items/ @@ -22528,9 +22528,9 @@ components: maxLength: 4000 type: string PurchaseDetails: - $ref: '#/components/schemas/Purchase' + $ref: "#/components/schemas/Purchase" SalesDetails: - $ref: '#/components/schemas/Purchase' + $ref: "#/components/schemas/Purchase" IsTrackedAsInventory: description: True for items that are tracked as inventory. An item will be tracked as inventory if the InventoryAssetAccountCode and COGSAccountCode are set. type: boolean @@ -22561,7 +22561,7 @@ components: description: Displays array of validation error messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" required: - Code type: object @@ -22592,11 +22592,11 @@ components: description: Displays array of warning messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" Journals: type: array items: - $ref: '#/components/schemas/Journal' + $ref: "#/components/schemas/Journal" Journal: externalDocs: url: http://developer.xero.com/documentation/api/journals/ @@ -22658,7 +22658,7 @@ components: description: See JournalLines type: array items: - $ref: '#/components/schemas/JournalLine' + $ref: "#/components/schemas/JournalLine" type: object JournalLine: externalDocs: @@ -22679,7 +22679,7 @@ components: type: string example: 090 AccountType: - $ref: '#/components/schemas/AccountType' + $ref: "#/components/schemas/AccountType" type: string AccountName: description: See AccountCodes @@ -22719,7 +22719,7 @@ components: description: Optional Tracking Category – see Tracking. Any JournalLine can have a maximum of 2 elements. type: array items: - $ref: '#/components/schemas/TrackingCategory' + $ref: "#/components/schemas/TrackingCategory" type: object LinkedTransactions: type: object @@ -22728,7 +22728,7 @@ components: LinkedTransactions: type: array items: - $ref: '#/components/schemas/LinkedTransaction' + $ref: "#/components/schemas/LinkedTransaction" LinkedTransaction: externalDocs: url: http://developer.xero.com/documentation/api/linked-transactions/ @@ -22787,23 +22787,23 @@ components: description: Displays array of validation error messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" type: object ManualJournals: type: object x-objectArrayKey: manual_journals properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" Warnings: description: Displays array of warning messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" ManualJournals: type: array items: - $ref: '#/components/schemas/ManualJournal' + $ref: "#/components/schemas/ManualJournal" ManualJournal: externalDocs: url: http://developer.xero.com/documentation/api/manual-journals/ @@ -22815,13 +22815,13 @@ components: description: See JournalLines type: array items: - $ref: '#/components/schemas/ManualJournalLine' + $ref: "#/components/schemas/ManualJournalLine" Date: description: Date journal was posted – YYYY-MM-DD type: string x-is-msdate: true LineAmountTypes: - $ref: '#/components/schemas/LineAmountTypes' + $ref: "#/components/schemas/LineAmountTypes" type: string Status: description: See Manual Journal Status Codes @@ -22862,17 +22862,17 @@ components: description: Displays array of warning messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" ValidationErrors: description: Displays array of validation error messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" Attachments: description: Displays array of attachments from the API type: array items: - $ref: '#/components/schemas/Attachment' + $ref: "#/components/schemas/Attachment" required: - Narration type: object @@ -22905,7 +22905,7 @@ components: description: Optional Tracking Category – see Tracking. Any JournalLine can have a maximum of 2 elements. type: array items: - $ref: '#/components/schemas/TrackingCategory' + $ref: "#/components/schemas/TrackingCategory" TaxAmount: description: The calculated tax amount based on the TaxType and LineAmount type: number @@ -22924,7 +22924,7 @@ components: Actions: type: array items: - $ref: '#/components/schemas/Action' + $ref: "#/components/schemas/Action" Action: externalDocs: url: http://developer.xero.com/documentation/api/organisation/ @@ -22946,7 +22946,7 @@ components: Organisations: type: array items: - $ref: '#/components/schemas/Organisation' + $ref: "#/components/schemas/Organisation" Organisation: externalDocs: url: http://developer.xero.com/documentation/api/organisation/ @@ -23000,10 +23000,10 @@ components: - SUPERANNUATION_FUND - TRUST BaseCurrency: - $ref: '#/components/schemas/CurrencyCode' + $ref: "#/components/schemas/CurrencyCode" type: string CountryCode: - $ref: '#/components/schemas/CountryCode' + $ref: "#/components/schemas/CountryCode" type: string IsDemoCompany: description: Boolean to describe if organisation is a demo company. @@ -23078,7 +23078,7 @@ components: example: /Date(1573755038314)/ readOnly: true Timezone: - $ref: '#/components/schemas/TimeZone' + $ref: "#/components/schemas/TimeZone" type: string OrganisationEntityType: description: Organisation Entity Type @@ -23138,19 +23138,19 @@ components: description: Address details for organisation – see Addresses type: array items: - $ref: '#/components/schemas/AddressForOrganisation' + $ref: "#/components/schemas/AddressForOrganisation" Phones: description: Phones details for organisation – see Phones type: array items: - $ref: '#/components/schemas/Phone' + $ref: "#/components/schemas/Phone" ExternalLinks: description: Organisation profile links for popular services such as Facebook,Twitter, GooglePlus and LinkedIn. You can also add link to your website here. Shown if Organisation settings is updated in Xero. See ExternalLinks below type: array items: - $ref: '#/components/schemas/ExternalLink' + $ref: "#/components/schemas/ExternalLink" PaymentTerms: - $ref: '#/components/schemas/PaymentTerm' + $ref: "#/components/schemas/PaymentTerm" type: object CountryCode: type: string @@ -23545,9 +23545,9 @@ components: url: http://developer.xero.com/documentation/api/organisation/ properties: Bills: - $ref: '#/components/schemas/Bill' + $ref: "#/components/schemas/Bill" Sales: - $ref: '#/components/schemas/Bill' + $ref: "#/components/schemas/Bill" type: object PaymentTermType: type: string @@ -23583,23 +23583,23 @@ components: description: Day of Month (0-31) type: integer Type: - $ref: '#/components/schemas/PaymentTermType' + $ref: "#/components/schemas/PaymentTermType" type: object Overpayments: type: object x-objectArrayKey: overpayments properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" Warnings: description: Displays array of warning messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" Overpayments: type: array items: - $ref: '#/components/schemas/Overpayment' + $ref: "#/components/schemas/Overpayment" Overpayment: externalDocs: url: http://developer.xero.com/documentation/api/overpayments/ @@ -23612,7 +23612,7 @@ components: - SPEND-OVERPAYMENT - AROVERPAYMENT Contact: - $ref: '#/components/schemas/Contact' + $ref: "#/components/schemas/Contact" Date: description: The date the overpayment is created YYYY-MM-DD type: string @@ -23625,13 +23625,13 @@ components: - PAID - VOIDED LineAmountTypes: - $ref: '#/components/schemas/LineAmountTypes' + $ref: "#/components/schemas/LineAmountTypes" type: string LineItems: description: See Overpayment Line Items type: array items: - $ref: '#/components/schemas/LineItem' + $ref: "#/components/schemas/LineItem" SubTotal: description: The subtotal of the overpayment excluding taxes type: number @@ -23654,7 +23654,7 @@ components: example: /Date(1573755038314)/ readOnly: true CurrencyCode: - $ref: '#/components/schemas/CurrencyCode' + $ref: "#/components/schemas/CurrencyCode" type: string OverpaymentID: description: Xero generated unique identifier @@ -23674,7 +23674,7 @@ components: description: See Allocations type: array items: - $ref: '#/components/schemas/Allocation' + $ref: "#/components/schemas/Allocation" AppliedAmount: description: The amount of applied to an invoice type: number @@ -23684,7 +23684,7 @@ components: description: See Payments type: array items: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" HasAttachments: description: boolean to indicate if a overpayment has an attachment readOnly: true @@ -23695,23 +23695,23 @@ components: description: See Attachments type: array items: - $ref: '#/components/schemas/Attachment' + $ref: "#/components/schemas/Attachment" type: object Payments: type: object x-objectArrayKey: payments properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" Warnings: description: Displays array of warning messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" Payments: type: array items: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" PaymentDelete: externalDocs: url: http://developer.xero.com/documentation/api/payments/ @@ -23728,13 +23728,13 @@ components: url: http://developer.xero.com/documentation/api/payments/ properties: Invoice: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" CreditNote: - $ref: '#/components/schemas/CreditNote' + $ref: "#/components/schemas/CreditNote" Prepayment: - $ref: '#/components/schemas/Prepayment' + $ref: "#/components/schemas/Prepayment" Overpayment: - $ref: '#/components/schemas/Overpayment' + $ref: "#/components/schemas/Overpayment" InvoiceNumber: description: Number of invoice or credit note you are applying payment to e.g.INV-4003 type: string @@ -23742,9 +23742,9 @@ components: description: Number of invoice or credit note you are applying payment to e.g. INV-4003 type: string BatchPayment: - $ref: '#/components/schemas/BatchPayment' + $ref: "#/components/schemas/BatchPayment" Account: - $ref: '#/components/schemas/Account' + $ref: "#/components/schemas/Account" Code: description: Code of account you are using to make the payment e.g. 001 (note- not all accounts have a code value) type: string @@ -23834,28 +23834,28 @@ components: description: Displays array of validation error messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" Warnings: description: Displays array of warning messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" type: object Prepayments: type: object x-objectArrayKey: prepayments properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" Warnings: description: Displays array of warning messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" Prepayments: type: array items: - $ref: '#/components/schemas/Prepayment' + $ref: "#/components/schemas/Prepayment" Prepayment: externalDocs: url: http://developer.xero.com/documentation/api/prepayments/ @@ -23869,7 +23869,7 @@ components: - ARPREPAYMENT - APPREPAYMENT Contact: - $ref: '#/components/schemas/Contact' + $ref: "#/components/schemas/Contact" Date: description: The date the prepayment is created YYYY-MM-DD type: string @@ -23882,13 +23882,13 @@ components: - PAID - VOIDED LineAmountTypes: - $ref: '#/components/schemas/LineAmountTypes' + $ref: "#/components/schemas/LineAmountTypes" type: string LineItems: description: See Prepayment Line Items type: array items: - $ref: '#/components/schemas/LineItem' + $ref: "#/components/schemas/LineItem" SubTotal: description: The subtotal of the prepayment excluding taxes type: number @@ -23915,7 +23915,7 @@ components: example: /Date(1573755038314)/ readOnly: true CurrencyCode: - $ref: '#/components/schemas/CurrencyCode' + $ref: "#/components/schemas/CurrencyCode" type: string PrepaymentID: description: Xero generated unique identifier @@ -23935,12 +23935,12 @@ components: description: See Allocations type: array items: - $ref: '#/components/schemas/Allocation' + $ref: "#/components/schemas/Allocation" Payments: description: See Payments type: array items: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" AppliedAmount: description: The amount of applied to an invoice type: number @@ -23956,34 +23956,34 @@ components: description: See Attachments type: array items: - $ref: '#/components/schemas/Attachment' + $ref: "#/components/schemas/Attachment" type: object PurchaseOrders: type: object x-objectArrayKey: purchase_orders properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" Warnings: description: Displays array of warning messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" PurchaseOrders: type: array items: - $ref: '#/components/schemas/PurchaseOrder' + $ref: "#/components/schemas/PurchaseOrder" PurchaseOrder: externalDocs: url: http://developer.xero.com/documentation/api/purchase-orders/ properties: Contact: - $ref: '#/components/schemas/Contact' + $ref: "#/components/schemas/Contact" LineItems: description: See LineItems type: array items: - $ref: '#/components/schemas/LineItem' + $ref: "#/components/schemas/LineItem" Date: description: Date purchase order was issued – YYYY-MM-DD. If the Date element is not specified then it will default to the current date based on the timezone setting of the organisation type: string @@ -23993,7 +23993,7 @@ components: type: string x-is-msdate: true LineAmountTypes: - $ref: '#/components/schemas/LineAmountTypes' + $ref: "#/components/schemas/LineAmountTypes" type: string PurchaseOrderNumber: description: Unique alpha numeric code identifying purchase order (when missing will auto-generate from your Organisation Invoice Settings) @@ -24006,7 +24006,7 @@ components: type: string format: uuid CurrencyCode: - $ref: '#/components/schemas/CurrencyCode' + $ref: "#/components/schemas/CurrencyCode" type: string Status: description: See Purchase Order Status Codes @@ -24088,17 +24088,17 @@ components: description: Displays array of validation error messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" Warnings: description: Displays array of warning messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" Attachments: description: Displays array of attachments from the API type: array items: - $ref: '#/components/schemas/Attachment' + $ref: "#/components/schemas/Attachment" type: object Pagination: type: object @@ -24118,7 +24118,7 @@ components: Quotes: type: array items: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" Quote: externalDocs: url: http://developer.xero.com/documentation/api/Quotes/ @@ -24140,12 +24140,12 @@ components: maxLength: 4000 type: string Contact: - $ref: '#/components/schemas/Contact' + $ref: "#/components/schemas/Contact" LineItems: description: See LineItems type: array items: - $ref: '#/components/schemas/LineItem' + $ref: "#/components/schemas/LineItem" Date: description: Date quote was issued – YYYY-MM-DD. If the Date element is not specified it will default to the current date based on the timezone setting of the organisation type: string @@ -24161,10 +24161,10 @@ components: description: Date the quote expires – YYYY-MM-DD. type: string Status: - $ref: '#/components/schemas/QuoteStatusCodes' + $ref: "#/components/schemas/QuoteStatusCodes" type: string CurrencyCode: - $ref: '#/components/schemas/CurrencyCode' + $ref: "#/components/schemas/CurrencyCode" type: string CurrencyRate: description: The currency rate for a multicurrency quote @@ -24213,7 +24213,7 @@ components: example: /Date(1573755038314)/ readOnly: true LineAmountTypes: - $ref: '#/components/schemas/QuoteLineAmountTypes' + $ref: "#/components/schemas/QuoteLineAmountTypes" type: string description: See Quote Line Amount Types StatusAttributeString: @@ -24223,7 +24223,7 @@ components: description: Displays array of validation error messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" type: object QuoteLineAmountTypes: description: Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types @@ -24249,7 +24249,7 @@ components: Receipts: type: array items: - $ref: '#/components/schemas/Receipt' + $ref: "#/components/schemas/Receipt" Receipt: externalDocs: url: http://developer.xero.com/documentation/api/receipts/ @@ -24259,18 +24259,18 @@ components: type: string x-is-msdate: true Contact: - $ref: '#/components/schemas/Contact' + $ref: "#/components/schemas/Contact" LineItems: type: array items: - $ref: '#/components/schemas/LineItem' + $ref: "#/components/schemas/LineItem" User: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" Reference: description: Additional reference number type: string LineAmountTypes: - $ref: '#/components/schemas/LineAmountTypes' + $ref: "#/components/schemas/LineAmountTypes" type: string SubTotal: description: Total of receipt excluding taxes @@ -24324,17 +24324,17 @@ components: description: Displays array of validation error messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" Warnings: description: Displays array of warning messages from the API type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" Attachments: description: Displays array of attachments from the API type: array items: - $ref: '#/components/schemas/Attachment' + $ref: "#/components/schemas/Attachment" type: object RepeatingInvoices: type: object @@ -24343,7 +24343,7 @@ components: RepeatingInvoices: type: array items: - $ref: '#/components/schemas/RepeatingInvoice' + $ref: "#/components/schemas/RepeatingInvoice" RepeatingInvoice: externalDocs: url: http://developer.xero.com/documentation/api/repeating-invoices/ @@ -24355,16 +24355,16 @@ components: - ACCPAY - ACCREC Contact: - $ref: '#/components/schemas/Contact' + $ref: "#/components/schemas/Contact" Schedule: - $ref: '#/components/schemas/Schedule' + $ref: "#/components/schemas/Schedule" LineItems: description: See LineItems type: array items: - $ref: '#/components/schemas/LineItem' + $ref: "#/components/schemas/LineItem" LineAmountTypes: - $ref: '#/components/schemas/LineAmountTypes' + $ref: "#/components/schemas/LineAmountTypes" type: string Reference: description: ACCREC only – additional reference number @@ -24374,7 +24374,7 @@ components: type: string format: uuid CurrencyCode: - $ref: '#/components/schemas/CurrencyCode' + $ref: "#/components/schemas/CurrencyCode" type: string Status: description: One of the following - DRAFT or AUTHORISED – See Invoice Status Codes @@ -24416,7 +24416,7 @@ components: description: Displays array of attachments from the API type: array items: - $ref: '#/components/schemas/Attachment' + $ref: "#/components/schemas/Attachment" ApprovedForSending: description: Boolean to indicate whether the invoice has been approved for sending type: boolean @@ -24444,7 +24444,7 @@ components: Reports: type: array items: - $ref: '#/components/schemas/ReportWithRow' + $ref: "#/components/schemas/ReportWithRow" ReportWithRow: externalDocs: url: http://developer.xero.com/documentation/api/reports/ @@ -24472,7 +24472,7 @@ components: Rows: type: array items: - $ref: '#/components/schemas/ReportRows' + $ref: "#/components/schemas/ReportRows" UpdatedDateUTC: description: Updated Date type: string @@ -24482,22 +24482,22 @@ components: Fields: type: array items: - $ref: '#/components/schemas/ReportFields' + $ref: "#/components/schemas/ReportFields" ReportRows: type: object properties: RowType: - $ref: '#/components/schemas/RowType' + $ref: "#/components/schemas/RowType" Title: type: string Cells: type: array items: - $ref: '#/components/schemas/ReportCell' + $ref: "#/components/schemas/ReportCell" Rows: type: array items: - $ref: '#/components/schemas/ReportRow' + $ref: "#/components/schemas/ReportRow" RowType: type: string enum: @@ -24509,13 +24509,13 @@ components: type: object properties: RowType: - $ref: '#/components/schemas/RowType' + $ref: "#/components/schemas/RowType" Title: type: string Cells: type: array items: - $ref: '#/components/schemas/ReportCell' + $ref: "#/components/schemas/ReportCell" ReportCell: type: object properties: @@ -24524,7 +24524,7 @@ components: Attributes: type: array items: - $ref: '#/components/schemas/ReportAttribute' + $ref: "#/components/schemas/ReportAttribute" ReportAttribute: externalDocs: url: http://developer.xero.com/documentation/api/reports/ @@ -24549,7 +24549,7 @@ components: Reports: type: array items: - $ref: '#/components/schemas/Report' + $ref: "#/components/schemas/Report" Report: externalDocs: url: http://developer.xero.com/documentation/api/reports/ @@ -24577,7 +24577,7 @@ components: Contacts: type: array items: - $ref: '#/components/schemas/TenNinetyNineContact' + $ref: "#/components/schemas/TenNinetyNineContact" TenNinetyNineContact: properties: Box1: @@ -24736,7 +24736,7 @@ components: TaxRates: type: array items: - $ref: '#/components/schemas/TaxRate' + $ref: "#/components/schemas/TaxRate" TaxType: description: See Tax Types – can only be used on update calls type: string @@ -24869,16 +24869,16 @@ components: url: https://developer.xero.com/documentation/api-guides/conversions properties: ConversionDate: - $ref: '#/components/schemas/ConversionDate' + $ref: "#/components/schemas/ConversionDate" ConversionBalances: description: Balance supplied for each account that has a value as at the conversion date. type: array items: - $ref: '#/components/schemas/ConversionBalances' + $ref: "#/components/schemas/ConversionBalances" Accounts: type: array items: - $ref: '#/components/schemas/Account' + $ref: "#/components/schemas/Account" ConversionDate: description: The date when the organisation starts using Xero type: object @@ -24904,7 +24904,7 @@ components: BalanceDetails: type: array items: - $ref: '#/components/schemas/BalanceDetails' + $ref: "#/components/schemas/BalanceDetails" type: object BalanceDetails: description: An array to specify multiple currency balances of an account @@ -24927,7 +24927,7 @@ components: url: https://developer.xero.com/documentation/api-guides/conversions properties: ImportSummary: - $ref: '#/components/schemas/ImportSummary' + $ref: "#/components/schemas/ImportSummary" ImportSummary: externalDocs: url: https://developer.xero.com/documentation/api-guides/conversions @@ -24935,9 +24935,9 @@ components: type: object properties: Accounts: - $ref: '#/components/schemas/ImportSummaryAccounts' + $ref: "#/components/schemas/ImportSummaryAccounts" Organisation: - $ref: '#/components/schemas/ImportSummaryOrganisation' + $ref: "#/components/schemas/ImportSummaryOrganisation" ImportSummaryAccounts: description: A summary of the accounts changes type: object @@ -24995,7 +24995,7 @@ components: description: See TaxComponents type: array items: - $ref: '#/components/schemas/TaxComponent' + $ref: "#/components/schemas/TaxComponent" Status: description: See Status Codes type: string @@ -25166,7 +25166,7 @@ components: TrackingCategories: type: array items: - $ref: '#/components/schemas/TrackingCategory' + $ref: "#/components/schemas/TrackingCategory" TrackingCategory: externalDocs: url: http://developer.xero.com/documentation/api/tracking-categories/ @@ -25198,7 +25198,7 @@ components: description: See Tracking Options type: array items: - $ref: '#/components/schemas/TrackingOption' + $ref: "#/components/schemas/TrackingOption" type: object TrackingOptions: type: object @@ -25207,7 +25207,7 @@ components: Options: type: array items: - $ref: '#/components/schemas/TrackingOption' + $ref: "#/components/schemas/TrackingOption" TrackingOption: externalDocs: url: http://developer.xero.com/documentation/api/tracking-categories/ @@ -25250,7 +25250,7 @@ components: Users: type: array items: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" User: externalDocs: url: http://developer.xero.com/documentation/api/users/ @@ -25307,7 +25307,7 @@ components: description: Array of Elements of validation Errors type: array items: - $ref: '#/components/schemas/Element' + $ref: "#/components/schemas/Element" type: object Element: externalDocs: @@ -25317,7 +25317,7 @@ components: description: Array of Validation Error message type: array items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" BatchPaymentID: description: Unique ID for batch payment object with validation error type: string diff --git a/xero_assets.yaml b/xero_assets.yaml index e2a42499..965d2366 100644 --- a/xero_assets.yaml +++ b/xero_assets.yaml @@ -17,7 +17,7 @@ servers: paths: /Assets: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -33,7 +33,7 @@ paths: in: query description: Required when retrieving a collection of assets. See Asset Status Codes schema: - $ref: '#/components/schemas/AssetStatusQueryParam' + $ref: "#/components/schemas/AssetStatusQueryParam" required: true - name: page in: query @@ -86,7 +86,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Assets' + $ref: "#/components/schemas/Assets" example: pagination: page: 1 @@ -167,7 +167,7 @@ paths: - Asset summary: adds a fixed asset parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" operationId: createAsset x-hasAssetsValidationError: true x-example: @@ -209,7 +209,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Asset' + $ref: "#/components/schemas/Asset" example: assetId: 2257c64a-77ca-444c-a5ea-fa9a588c7039 assetName: Computer74863 @@ -260,7 +260,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Asset' + $ref: "#/components/schemas/Asset" example: assetName: Computer74863 assetNumber: "123477544" @@ -283,7 +283,7 @@ paths: description: Fixed asset you are creating /Assets/{id}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -311,7 +311,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Asset' + $ref: "#/components/schemas/Asset" example: assetId: 68f17094-af97-4f1b-b36b-013b45b6ad3c assetName: Computer47822 @@ -348,7 +348,7 @@ paths: description: bad input parameter /AssetTypes: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -367,7 +367,7 @@ paths: schema: type: array items: - $ref: '#/components/schemas/AssetType' + $ref: "#/components/schemas/AssetType" example: - assetTypeId: 710255c6-d2ed-4463-b992-06c8685add5e assetTypeName: Computer Equipment @@ -411,7 +411,7 @@ paths: - Asset summary: adds a fixed asset type parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" operationId: createAssetType x-example: - bookDepreciationSetting: @@ -497,7 +497,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AssetType' + $ref: "#/components/schemas/AssetType" example: assetTypeId: 85509b5d-308e-420d-9532-b85105058916 assetTypeName: Machinery11004 @@ -542,7 +542,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AssetType' + $ref: "#/components/schemas/AssetType" example: assetTypeName: Machinery11004 fixedAssetAccountId: 3d8d063a-c148-4bb8-8b3c-a5e2ad3b1e82 @@ -556,7 +556,7 @@ paths: description: Asset type to add /Settings: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -573,7 +573,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Setting' + $ref: "#/components/schemas/Setting" example: assetNumberPrefix: FA- assetNumberSequence: "0007" @@ -619,11 +619,11 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" items: type: array items: - $ref: '#/components/schemas/Asset' + $ref: "#/components/schemas/Asset" Pagination: properties: page: @@ -684,7 +684,7 @@ components: description: The price the asset was disposed at example: "1.0000" assetStatus: - $ref: '#/components/schemas/AssetStatus' + $ref: "#/components/schemas/AssetStatus" warrantyExpiryDate: type: string description: The date the asset’s warranty expires (if needed) YYYY-MM-DD @@ -694,9 +694,9 @@ components: description: The asset's serial number example: ca4c6b39-4f4f-43e8-98da-5e1f350a6694 bookDepreciationSetting: - $ref: '#/components/schemas/BookDepreciationSetting' + $ref: "#/components/schemas/BookDepreciationSetting" bookDepreciationDetail: - $ref: '#/components/schemas/BookDepreciationDetail' + $ref: "#/components/schemas/BookDepreciationDetail" canRollback: type: boolean description: Boolean to indicate whether depreciation can be rolled back for this asset individually. This is true if it doesn't have 'legacy' journal entries and if there is no lock period that would prevent this asset from rolling back. @@ -759,7 +759,7 @@ components: example: ca4c6b39-4f4f-43e8-98da-5e1f350a6694 description: The account for accumulated depreciation of fixed assets of this type bookDepreciationSetting: - $ref: '#/components/schemas/BookDepreciationSetting' + $ref: "#/components/schemas/BookDepreciationSetting" locks: type: integer example: 33 @@ -933,12 +933,12 @@ components: description: Array of elements of resource validation errors type: array items: - $ref: '#/components/schemas/ResourceValidationErrorsElement' + $ref: "#/components/schemas/ResourceValidationErrorsElement" fieldValidationErrors: description: Array of elements of field validation errors type: array items: - $ref: '#/components/schemas/FieldValidationErrorsElement' + $ref: "#/components/schemas/FieldValidationErrorsElement" type: description: The internal type of error, not accessible externally type: string diff --git a/xero_bankfeeds.yaml b/xero_bankfeeds.yaml index 6830ca93..e6c4827f 100644 --- a/xero_bankfeeds.yaml +++ b/xero_bankfeeds.yaml @@ -17,7 +17,7 @@ servers: paths: /FeedConnections: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -46,7 +46,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FeedConnections' + $ref: "#/components/schemas/FeedConnections" example: pagination: page: 1 @@ -80,7 +80,7 @@ paths: - BankFeeds summary: Create one or more new feed connection parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" operationId: createFeedConnections x-hasBankFeedsValidationError: true description: By passing in the FeedConnections array object in the body, you can create one or more new feed connections @@ -90,7 +90,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FeedConnections' + $ref: "#/components/schemas/FeedConnections" example: items: - accountToken: foobar71760 @@ -104,7 +104,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FeedConnections' + $ref: "#/components/schemas/FeedConnections" example: items: - id: 2a19d46c-2a92-4e50-9401-dcf2cb895be7 @@ -115,7 +115,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FeedConnections' + $ref: "#/components/schemas/FeedConnections" example: items: - accountToken: foobar71760 @@ -127,7 +127,7 @@ paths: detail: For the request field 'AccountNumber' exceeded the maximum length of 40. /FeedConnections/{id}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -151,7 +151,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FeedConnection' + $ref: "#/components/schemas/FeedConnection" example: id: b58b685a-1bee-4904-91f1-fee30bb6ea52 accountToken: foobar84778 @@ -165,7 +165,7 @@ paths: description: bad input parameter /FeedConnections/DeleteRequests: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" post: security: - OAuth2: @@ -174,7 +174,7 @@ paths: - BankFeeds summary: Delete an existing feed connection parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" operationId: deleteFeedConnections description: By passing in FeedConnections array object in the body, you can delete a feed connection. requestBody: @@ -183,7 +183,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FeedConnections' + $ref: "#/components/schemas/FeedConnections" example: items: - id: b4cc693b-24d9-42ec-a6d4-2943d253ff63 @@ -193,7 +193,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FeedConnections' + $ref: "#/components/schemas/FeedConnections" example: items: - id: b4cc693b-24d9-42ec-a6d4-2943d253ff63 @@ -208,7 +208,7 @@ paths: description: bad input parameter /Statements: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -251,7 +251,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Statements' + $ref: "#/components/schemas/Statements" example: pagination: page: 1 @@ -293,7 +293,7 @@ paths: content: application/problem+json: schema: - $ref: '#/components/schemas/Statements' + $ref: "#/components/schemas/Statements" example: type: invalid-request title: Invalid Request @@ -307,7 +307,7 @@ paths: - BankFeeds summary: Creates one or more new statements parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" operationId: createStatements x-hasBankFeedsValidationError: true responses: @@ -316,7 +316,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Statements' + $ref: "#/components/schemas/Statements" example: items: - id: d69b02b7-a30c-464a-99cf-ba9770373c61 @@ -330,7 +330,7 @@ paths: content: application/problem+json: schema: - $ref: '#/components/schemas/Statements' + $ref: "#/components/schemas/Statements" example: type: invalid-request title: Invalid Request @@ -341,7 +341,7 @@ paths: content: application/problem+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: type: invalid-application title: Invalid Application @@ -352,7 +352,7 @@ paths: content: application/problem+json: schema: - $ref: '#/components/schemas/Statements' + $ref: "#/components/schemas/Statements" example: items: - id: 29fefeb6-f449-470d-9179-f1d8900930d6 @@ -368,7 +368,7 @@ paths: content: application/problem+json: schema: - $ref: '#/components/schemas/Statements' + $ref: "#/components/schemas/Statements" example: type: invalid-request title: Request too large @@ -379,7 +379,7 @@ paths: content: application/problem+json: schema: - $ref: '#/components/schemas/Statements' + $ref: "#/components/schemas/Statements" example: type: invalid-end-balance title: Invalid End Balance @@ -390,7 +390,7 @@ paths: content: application/problem+json: schema: - $ref: '#/components/schemas/Statements' + $ref: "#/components/schemas/Statements" example: type: internal-error title: Intermittent Internal Xero Error @@ -402,7 +402,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Statements' + $ref: "#/components/schemas/Statements" example: items: - feedConnectionId: 6a4b9ff5-3a5f-4321-936b-4796163550f6 @@ -445,7 +445,7 @@ paths: transactionType: Currency Conversion Fee /Statements/{statementId}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -469,7 +469,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Statement' + $ref: "#/components/schemas/Statement" example: id: 97aca24a-dd10-4cda-98c7-1084a048257b feedConnectionId: 6a4b9ff5-3a5f-4321-936b-4796163550f6 @@ -522,11 +522,11 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" items: type: array items: - $ref: '#/components/schemas/FeedConnection' + $ref: "#/components/schemas/FeedConnection" FeedConnection: externalDocs: url: https://developer.xero.com/documentation/bank-feeds-api/feed-connections @@ -564,9 +564,9 @@ components: example: BANK description: High level bank account type - BANK CREDITCARD BANK encompasses all bank account types other than credit cards. currency: - $ref: '#/components/schemas/CurrencyCode' + $ref: "#/components/schemas/CurrencyCode" country: - $ref: '#/components/schemas/CountryCode' + $ref: "#/components/schemas/CountryCode" status: type: string enum: @@ -575,18 +575,18 @@ components: example: REJECTED description: the current status of the feed connection error: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" Statements: externalDocs: url: https://developer.xero.com/documentation/bank-feeds-api/statements type: object properties: pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" items: type: array items: - $ref: '#/components/schemas/Statement' + $ref: "#/components/schemas/Statement" Pagination: type: object properties: @@ -637,15 +637,15 @@ components: example: "2018-07-27" description: Closing balance date ISO-8601 YYYY-MM-DD startBalance: - $ref: '#/components/schemas/StartBalance' + $ref: "#/components/schemas/StartBalance" endBalance: - $ref: '#/components/schemas/EndBalance' + $ref: "#/components/schemas/EndBalance" statementLines: - $ref: '#/components/schemas/StatementLines' + $ref: "#/components/schemas/StatementLines" errors: type: array items: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" statementLineCount: type: integer example: 1 @@ -660,7 +660,7 @@ components: example: "9.0000" description: decimal(19,4) unsigned Opening/closing balance amount. creditDebitIndicator: - $ref: '#/components/schemas/CreditDebitIndicator' + $ref: "#/components/schemas/CreditDebitIndicator" EndBalance: description: The StartBalance plus all the Statement Line Amounts should be equal to the EndBalance Amount. type: object @@ -671,11 +671,11 @@ components: x-is-money: true example: "10.1340" creditDebitIndicator: - $ref: '#/components/schemas/CreditDebitIndicator' + $ref: "#/components/schemas/CreditDebitIndicator" StatementLines: type: array items: - $ref: '#/components/schemas/StatementLine' + $ref: "#/components/schemas/StatementLine" StatementLine: type: object description: the lines details for a statement @@ -697,7 +697,7 @@ components: example: "5.00" description: Transaction amount creditDebitIndicator: - $ref: '#/components/schemas/CreditDebitIndicator' + $ref: "#/components/schemas/CreditDebitIndicator" transactionId: type: string example: transaction-id-2 diff --git a/xero_files.yaml b/xero_files.yaml index 03562f74..9a2aeabe 100644 --- a/xero_files.yaml +++ b/xero_files.yaml @@ -17,7 +17,7 @@ tags: paths: /Files: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -67,7 +67,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Files' + $ref: "#/components/schemas/Files" example: '{ "TotalCount": 100, "Page": 1, "PerPage": 2, "Items": [ { "Name": "helo-heros.jpg", "MimeType": "application/jpg", "Size": 2878711, "CreatedDateUtc": "2021-02-10T16:02:54.9930000", "UpdatedDateUtc": "2021-02-10T16:02:54.9930000", "User": { "Name": "sid.maestre@xero.com", "FirstName": "Sidney", "LastName": "Maestre", "FullName": "Sidney Maestre", "Id": "740add2a-a703-4b8a-a670-1093919c2040" }, "FolderId": "bf924975-7097-46f2-a143-1ecfbab3c8c3", "Id": "3d413bfe-f40f-4807-b953-9a42f834ff15" }, { "Name": "helo-heros.jpg", "MimeType": "application/jpg", "Size": 2878711, "CreatedDateUtc": "2021-02-09T21:16:00.6130000", "UpdatedDateUtc": "2021-02-09T21:16:00.6130000", "User": { "Name": "sid.maestre@xero.com", "FirstName": "Sidney", "LastName": "Maestre", "FullName": "Sidney Maestre", "Id": "740add2a-a703-4b8a-a670-1093919c2040" }, "FolderId": "bf924975-7097-46f2-a143-1ecfbab3c8c3", "Id": "22f87409-cdfd-4813-a868-559481bcb052" } ] }' post: security: @@ -77,7 +77,7 @@ paths: - Files summary: Uploads a File to the inbox parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" operationId: uploadFile responses: "201": @@ -85,7 +85,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FileObject' + $ref: "#/components/schemas/FileObject" example: '{ "Name": "helo-heros.jpg", "MimeType": "application/jpg", "Size": 2878711, "CreatedDateUtc": "2021-02-10T23:17:50.1930000", "UpdatedDateUtc": "2021-02-10T23:17:50.1930000", "User": { "Name": "sid.maestre@xero.com", "FirstName": "Sidney", "LastName": "Maestre", "FullName": "Sidney Maestre", "Id": "740add2a-a703-4b8a-a670-1093919c2040" }, "FolderId": "bf924975-7097-46f2-a143-1ecfbab3c8c3", "Id": "22f87409-cdfd-4813-a868-559481bcb052" }' "400": description: invalid input, object invalid @@ -97,10 +97,10 @@ paths: content: multipart/form-data: schema: - $ref: '#/components/schemas/UploadObject' + $ref: "#/components/schemas/UploadObject" /Files/{FileId}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -126,7 +126,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FileObject' + $ref: "#/components/schemas/FileObject" example: '{ "Name": "helo-heros.jpg", "MimeType": "application/jpg", "Size": 2878711, "CreatedDateUtc": "2021-02-10T23:17:50.1930000", "UpdatedDateUtc": "2021-02-10T23:17:50.1930000", "User": { "Name": "sid.maestre@xero.com", "FirstName": "Sidney", "LastName": "Maestre", "FullName": "Sidney Maestre", "Id": "740add2a-a703-4b8a-a670-1093919c2040" }, "FolderId": "bf924975-7097-46f2-a143-1ecfbab3c8c3", "Id": "efd77bfc-7018-4da1-b251-7aa2d438382c" }' put: security: @@ -138,7 +138,7 @@ paths: operationId: updateFile description: Updates file properties of a single file parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: FileId x-snake: file_id in: path @@ -154,7 +154,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FileObject' + $ref: "#/components/schemas/FileObject" example: '{ "Name": "helo-heros.jpg", "MimeType": "application/jpg", "Size": 2878711, "CreatedDateUtc": "2021-02-10T23:17:50.1930000", "UpdatedDateUtc": "2021-02-10T23:58:54.1000000", "User": { "Name": "sid.maestre@xero.com", "FirstName": "Sidney", "LastName": "Maestre", "FullName": "Sidney Maestre", "Id": "740add2a-a703-4b8a-a670-1093919c2040" }, "FolderId": "bf924975-7097-46f2-a143-1ecfbab3c8c3", "Id": "efd77bfc-7018-4da1-b251-7aa2d438382c" }' "400": description: invalid input, object invalid @@ -166,7 +166,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FileObject' + $ref: "#/components/schemas/FileObject" example: '{ "FolderId": "bf924975-7097-46f2-a143-1ecfbab3c8c3" }' delete: security: @@ -193,7 +193,7 @@ paths: x-isEmpty: true /Files/{FolderId}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" post: security: - OAuth2: @@ -203,7 +203,7 @@ paths: summary: Uploads a File to a specific folder operationId: uploadFileToFolder parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - in: path x-snake: folder_id name: FolderId @@ -219,7 +219,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FileObject' + $ref: "#/components/schemas/FileObject" example: '{ "Name": "helo-heros.jpg", "MimeType": "application/jpg", "Size": 2878711, "CreatedDateUtc": "2021-02-10T23:17:50.1930000", "UpdatedDateUtc": "2021-02-10T23:17:50.1930000", "User": { "Name": "sid.maestre@xero.com", "FirstName": "Sidney", "LastName": "Maestre", "FullName": "Sidney Maestre", "Id": "740add2a-a703-4b8a-a670-1093919c2040" }, "FolderId": "bf924975-7097-46f2-a143-1ecfbab3c8c3", "Id": "22f87409-cdfd-4813-a868-559481bcb052" }' "400": description: invalid input, object invalid @@ -231,10 +231,10 @@ paths: content: multipart/form-data: schema: - $ref: '#/components/schemas/UploadObject' + $ref: "#/components/schemas/UploadObject" /Files/{FileId}/Content: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -265,7 +265,7 @@ paths: format: binary /Files/{FileId}/Associations: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -294,7 +294,7 @@ paths: schema: type: array items: - $ref: '#/components/schemas/Association' + $ref: "#/components/schemas/Association" example: '[ { "FileId":"6beccb4a-0d7d-4518-93f3-e0cd1dccb254", "ObjectId":"1270bf7c-5d18-473a-9231-1e36c4bd33ed", "ObjectType":"Business", "ObjectGroup":"Contact" } ]' post: security: @@ -306,7 +306,7 @@ paths: operationId: createFileAssociation description: By passing in the appropriate options, you can create a new folder parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: FileId x-snake: file_id in: path @@ -322,7 +322,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Association' + $ref: "#/components/schemas/Association" example: '{ "FileId": "6beccb4a-0d7d-4518-93f3-e0cd1dccb254", "ObjectId": "1270bf7c-5d18-473a-9231-1e36c4bd33ed", "ObjectType": "Business", "ObjectGroup": "Contact" }' "400": description: invalid input, object invalid @@ -334,11 +334,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Association' + $ref: "#/components/schemas/Association" example: '{ "ObjectId": "1270bf7c-5d18-473a-9231-1e36c4bd33ed", "ObjectGroup": "Contact", "ObjectType": "Business" }' /Files/{FileId}/Associations/{ObjectId}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" delete: security: - OAuth2: @@ -373,7 +373,7 @@ paths: x-isEmpty: true /Associations/{ObjectId}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -434,11 +434,11 @@ paths: schema: type: array items: - $ref: '#/components/schemas/Association' + $ref: "#/components/schemas/Association" example: '[ { "SendWithObject":false, "Name":"testfile.pdf", "Size":12357, "FileId":"6beccb4a-0d7d-4518-93f3-e0cd1dccb254", "ObjectId":"1270bf7c-5d18-473a-9231-1e36c4bd33ed", "ObjectType":"Business", "ObjectGroup":"Contact" } ]' /Associations/Count: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -470,7 +470,7 @@ paths: example: '{ "19d4fc59-e799-410f-912b-03d4ab294d73": 2, "82195976-5175-45d4-926e-807ff10892e7": 1, "a8547af2-2900-4879-98b8-f1a780c78feb": 0}' /Folders: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -500,7 +500,7 @@ paths: schema: type: array items: - $ref: '#/components/schemas/Folder' + $ref: "#/components/schemas/Folder" example: '[ { "Name":"Inbox", "FileCount":14, "Email":"xero.inbox.jpf4.6oo29retajkhtfus@xerofiles.com", "IsInbox":true, "Id":"bf924975-7097-46f2-a143-1ecfbab3c8c3" }, { "Name":"Contracts", "FileCount":7, "IsInbox":false, "Id":"554ff1ad-4b94-4266-9b45-e29bcb75e6bf" } ]' post: security: @@ -510,7 +510,7 @@ paths: - Files summary: Creates a new folder parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" operationId: createFolder description: By passing in the appropriate properties, you can create a new folder responses: @@ -519,7 +519,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Folder' + $ref: "#/components/schemas/Folder" example: '{ "Name": "My Docs", "FileCount": 0, "IsInbox": false, "Id": "913970ad-8c8e-4666-8294-35b9cac23206" }' "400": description: invalid input, object invalid @@ -531,11 +531,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Folder' + $ref: "#/components/schemas/Folder" example: '{ "Name": "My Docs" }' /Folders/{FolderId}: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -562,7 +562,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Folder' + $ref: "#/components/schemas/Folder" example: '{ "Name": "My Docs", "FileCount": 0, "IsInbox": false, "Id": "4c5f3fe4-2516-4863-ac88-3029351773bf" }' put: security: @@ -574,7 +574,7 @@ paths: operationId: updateFolder description: By passing in the appropriate ID and properties, you can update a folder parameters: - - $ref: '#/components/parameters/idempotencyKey' + - $ref: "#/components/parameters/idempotencyKey" - name: FolderId x-snake: folder_id in: path @@ -590,7 +590,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Folder' + $ref: "#/components/schemas/Folder" example: '{ "Name": "Your Docs", "FileCount": 0, "IsInbox": false, "Id": "4c5f3fe4-2516-4863-ac88-3029351773bf" }' "400": description: invalid input, object invalid @@ -602,7 +602,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Folder' + $ref: "#/components/schemas/Folder" example: '{ "Name": "Your Docs" }' delete: security: @@ -629,7 +629,7 @@ paths: x-isEmpty: true /Inbox: parameters: - - $ref: '#/components/parameters/requiredHeader' + - $ref: "#/components/parameters/requiredHeader" get: security: - OAuth2: @@ -646,7 +646,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Folder' + $ref: "#/components/schemas/Folder" example: '{ "Name": "Inbox", "FileCount": 14, "Email": "xero.inbox.jpf4.6oo29retajkhtfus@xerofiles.com", "IsInbox": true, "Id": "bf924975-7097-46f2-a143-1ecfbab3c8c3" }' components: securitySchemes: @@ -697,7 +697,7 @@ components: Items: type: array items: - $ref: '#/components/schemas/FileObject' + $ref: "#/components/schemas/FileObject" FileObject: type: object required: @@ -727,7 +727,7 @@ components: type: string example: 2020-12-03T19:04:58.6970000 User: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" Id: description: File object's UUID type: string @@ -787,7 +787,7 @@ components: Folders: type: array items: - $ref: '#/components/schemas/Folder' + $ref: "#/components/schemas/Folder" Folder: required: - name @@ -837,9 +837,9 @@ components: type: string format: uuid ObjectGroup: - $ref: '#/components/schemas/ObjectGroup' + $ref: "#/components/schemas/ObjectGroup" ObjectType: - $ref: '#/components/schemas/ObjectType' + $ref: "#/components/schemas/ObjectType" ObjectGroup: description: The Object Group that the object is in. These roughly correlate to the endpoints that can be used to retrieve the object via the core accounting API. type: string