diff --git a/.github/actions/notify-slack/action.yml b/.github/actions/notify-slack/action.yml new file mode 100644 index 00000000..add9673f --- /dev/null +++ b/.github/actions/notify-slack/action.yml @@ -0,0 +1,103 @@ +name: slack-alert-action +description: "Action to send slack payload to public-sdk-events channel" + +inputs: + heading_text: + required: true + description: "Heading of the slack payload" + alert_type: + required: true + description: "type of the slack alert" + job_status: + required: true + description: "status of the job" + XERO_SLACK_WEBHOOK_URL: + required: true + description: "webhook url for channel - public-sdk-events" + job_url: + required: true + description: "job run id link" + button_type: + required: true + description: "color for the check logs button" + package_version: + required: true + description: "released package version" + repo_link: + required: true + description: "link of the repo" + + +runs: + using: "composite" + + steps: + + - name: Send slack notification + id: slack + uses: slackapi/slack-github-action@v1.27.0 + env: + SLACK_WEBHOOK_URL: ${{inputs.XERO_SLACK_WEBHOOK_URL}} + SLACK_WEBHOOK_TYPE: INCOMING_WEBHOOK + with: + payload: | + { + "blocks": [ + { + "type": "rich_text", + "elements": [ + { + "type": "rich_text_section", + "elements": [ + { + "type": "text", + "text": "${{inputs.heading_text}} ", + "style": { + "bold": true + } + }, + { + "type": "emoji", + "name": "${{inputs.alert_type}}" + } + ] + } + ] + }, + { + "type": "divider" + }, + { + "type": "section", + "fields": [ + { + "type": "mrkdwn", + "text": "*Repository:* \n ${{inputs.repo_link}}" + }, + { + "type": "mrkdwn", + "text": "*Status:*\n ${{inputs.job_status}}" + }, + { + "type": "mrkdwn", + "text": "*Package Version:*\n ${{inputs.package_version}}" + } + ] + }, + { + "type": "actions", + "elements": [ + { + "type": "button", + "text": { + "type": "plain_text", + "text": "Check the logs", + "emoji": true + }, + "style": "${{inputs.button_type}}", + "url": "${{inputs.job_url}}" + } + ] + } + ] + } diff --git a/.github/octokit/index.js b/.github/octokit/index.js new file mode 100644 index 00000000..b308cb3b --- /dev/null +++ b/.github/octokit/index.js @@ -0,0 +1,30 @@ +import {Octokit} from "@octokit/rest"; +import {createAppAuth} from "@octokit/auth-app" + +export const getAccessToken = async () => { + + const {GITHUB_APP_ID, GITHUB_APP_PRIVATE_KEY} = process.env + + const octoKitInstance = new Octokit({ + authStrategy: createAppAuth, + auth: { + appId: GITHUB_APP_ID, + privateKey: GITHUB_APP_PRIVATE_KEY + } + }); + + const {data: installations} = await octoKitInstance.rest.apps.listInstallations() + + console.log("installations -----", installations); + + + if(!installations.length) { + throw new Error("No Installations found for this github app") + } + + const installationId = installations[0].id; + + const installationAccessToken = await octoKitInstance.rest.apps.createInstallationAccessToken({installation_id: installationId}) + + return installationAccessToken.data.token +} \ No newline at end of file diff --git a/.github/octokit/package.json b/.github/octokit/package.json new file mode 100644 index 00000000..66fb13ca --- /dev/null +++ b/.github/octokit/package.json @@ -0,0 +1,16 @@ +{ + "name": "xero-octokit", + "version": "1.0.0", + "description": "", + "main": "index.js", + "type": "module", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "author": "", + "license": "ISC", + "dependencies": { + "@octokit/auth-app": "^7.1.1", + "@octokit/rest": "^21.0.2" + } + } \ No newline at end of file diff --git a/.github/workflows/build-test-lint.yml b/.github/workflows/build-test-lint.yml new file mode 100644 index 00000000..14722dcc --- /dev/null +++ b/.github/workflows/build-test-lint.yml @@ -0,0 +1,63 @@ +name: Python Build, Lint + +on: + push: + +jobs: + build-test-lint: + runs-on: ubuntu-latest + + steps: + - name: Checkout xero-python repo + uses: actions/checkout@v4 + with: + repository: XeroAPI/xero-python + path: xero-python + + - name: Set up Python environment + uses: actions/setup-python@v5 + with: + python-version: '3.8' + cache: 'pip' + + - name: Install dependencies + run: | + python -m venv venv + source venv/bin/activate + pip install --upgrade pip + pip install black + sudo pip install flake8 + sudo pip install pip-audit + pip install -r requirements.txt -r requirements/dev.txt + working-directory: xero-python + + - name: Run Flake8 + run: flake8 xero_python + working-directory: xero-python + + - name: Build package + run: python setup.py sdist + working-directory: xero-python + + - name: Set up Node environment + uses: actions/setup-node@v2 + with: + node-version: 20 + + - name: Install Prism + run: npm install -g @stoplight/prism-cli + + - name: Start PRISM Server + run: ./start-prism.sh & sleep 15 + working-directory: xero-python/tests/utils + + - name: Run Test + run: | + source venv/bin/activate + pytest -v + working-directory: xero-python + + - name: Stop PRISM + if: success() || failure() + run: pkill -f prism + working-directory: xero-python diff --git a/.github/workflows/jira_create_issue.yml b/.github/workflows/jira_create_issue.yml new file mode 100644 index 00000000..c8534823 --- /dev/null +++ b/.github/workflows/jira_create_issue.yml @@ -0,0 +1,11 @@ +name: Create Issue in Jira + +on: + issues: + types: + - opened + +jobs: + create_jira_issue: + uses: XeroAPI/Xero-OpenAPI/.github/workflows/jira_create_issue.yml@master + secrets: inherit diff --git a/.github/workflows/jira_update_issue_closed.yml b/.github/workflows/jira_update_issue_closed.yml new file mode 100644 index 00000000..a9f6ac31 --- /dev/null +++ b/.github/workflows/jira_update_issue_closed.yml @@ -0,0 +1,11 @@ +name: Update Jira Ticket Status To Done + +on: + issues: + types: + - closed + +jobs: + create_jira_issue: + uses: XeroAPI/Xero-OpenAPI/.github/workflows/jira_update_issue_closed.yml@master + secrets: inherit diff --git a/.github/workflows/jira_update_issue_reopen.yml b/.github/workflows/jira_update_issue_reopen.yml new file mode 100644 index 00000000..e883ac68 --- /dev/null +++ b/.github/workflows/jira_update_issue_reopen.yml @@ -0,0 +1,11 @@ +name: Update Jira Ticket Status To Backlog + +on: + issues: + types: + - reopened + +jobs: + create_jira_issue: + uses: XeroAPI/Xero-OpenAPI/.github/workflows/jira_update_issue_reopen.yml@master + secrets: inherit diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml new file mode 100644 index 00000000..9335c48f --- /dev/null +++ b/.github/workflows/publish.yml @@ -0,0 +1,161 @@ +name: Publish & Release SDK +on: + workflow_dispatch: + inputs: + cab_id: + description: "CAB id for the change/release" + required: true + type: string + +jobs: + publish: + runs-on: ubuntu-latest + environment: prod + outputs: + release_number: ${{steps.get_latest_release_number.outputs.release_tag}} + permissions: + contents: write + pull-requests: write + steps: + - name: Checkout xero-python repo + uses: actions/checkout@v4 + with: + repository: XeroAPI/xero-python + path: xero-python + + - name: Set up Python environment + uses: actions/setup-python@v5 + with: + python-version: '3.8' + cache: 'pip' + + - name: Install dependencies + run: | + python -m venv venv + source venv/bin/activate + pip install --upgrade pip + pip install twine + echo "$PWD/venv/bin" >> "$GITHUB_PATH" + working-directory: xero-python + + - name: Fetch Latest release number + id: get_latest_release_number + run: | + latest_version=$(gh release view --json tagName --jq '.tagName') + echo "Latest release version is - $latest_version" + echo "::set-output name=release_tag::$latest_version" + working-directory: xero-python + env: + GH_TOKEN: ${{secrets.GITHUB_TOKEN}} + + - name: Build Package + run: python setup.py sdist + working-directory: xero-python + + - name: Publish to PyPi + env: + TWINE_USERNAME: __token__ + TWINE_PASSWORD: ${{ secrets.PYPI_APIKEY }} + run: twine upload dist/* + working-directory: xero-python + + notify-slack-on-success: + runs-on: ubuntu-latest + needs: publish + if: success() + permissions: + contents: read + steps: + - name: Checkout xero-pythonrepo + uses: actions/checkout@v4 + with: + repository: XeroAPI/xero-python + path: xero-python + + - name: Send slack notification on success + uses: ./xero-python/.github/actions/notify-slack + with: + heading_text: "Publish job has succeeded !" + alert_type: "thumbsup" + job_status: "Success" + XERO_SLACK_WEBHOOK_URL: ${{secrets.XERO_SLACK_WEBHOOK_URL}} + job_url: "https://github.com/${{github.repository}}/actions/runs/${{github.run_id}}" + button_type: "primary" + package_version: ${{needs.publish.outputs.release_number}} + repo_link: ${{github.server_url}}/${{github.repository}} + + notify-slack-on-failure: + runs-on: ubuntu-latest + needs: publish + if: failure() + permissions: + contents: read + steps: + - name: Checkout xero-python repo + uses: actions/checkout@v4 + with: + repository: XeroAPI/xero-python + path: xero-python + + - name: Send slack notification on failure + uses: ./xero-python/.github/actions/notify-slack + with: + heading_text: "Publish job has failed !" + alert_type: "alert" + job_status: "Failed" + XERO_SLACK_WEBHOOK_URL: ${{secrets.XERO_SLACK_WEBHOOK_URL}} + job_url: "https://github.com/${{github.repository}}/actions/runs/${{github.run_id}}" + button_type: "danger" + package_version: ${{needs.publish.outputs.release_number}} + repo_link: ${{github.server_url}}/${{github.repository}} + + notify-codegen-repo: + needs: publish + if: always() + runs-on: ubuntu-latest + permissions: + contents: write + pull-requests: write + + steps: + - name: Checkout + uses: actions/checkout@v4 + with: + repository: XeroAPI/xero-python + path: xero-python + + - name: Install octokit dependencies + run: npm i + working-directory: xero-python/.github/octokit + + - name: Get github app access token + id: get_access_token + env: + GITHUB_APP_ID: ${{ secrets.XERO_CODEGEN_BOT_APPLICATION_ID }} + GITHUB_APP_PRIVATE_KEY: ${{ secrets.XERO_CODEGEN_BOT_APPLICATION_KEY }} + uses: actions/github-script@v7 + with: + result-encoding: string + script: | + const { getAccessToken } = await import('${{ github.workspace }}/xero-python/.github/octokit/index.js') + const token = await getAccessToken() + return token + + - name: Notify codegen repo + run: | + curl -X POST -H "Authorization: token ${{ steps.get_access_token.outputs.result }}" \ + -H "Accept: application/vnd.github.v3+json" \ + -H "Content-Type: application/json" \ + https://api.github.com/repos/xero-internal/xeroapi-sdk-codegen/actions/workflows/notify-sdk-publish.yml/dispatches \ + -d '{ + "ref": "master", + "inputs": { + "commit": "${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.sha }}", + "status": "${{needs.publish.result}}", + "deployer": "xero-codegen-bot", + "url": "${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}", + "environment": "prod", + "sdk_type": "python", + "cab_key": "${{ github.event.inputs.cab_id }}" + } + }' diff --git a/README.md b/README.md index 0c1f6e6c..060fac4b 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![PyPI version](https://badge.fury.io/py/xero-python.svg)](https://badge.fury.io/py/xero-python) [![Github forks](https://img.shields.io/github/forks/XeroAPI/xero-python.svg)](https://github.com/XeroAPI/xero-python/network) [![Github stars](https://img.shields.io/github/stars/XeroAPI/xero-python.svg)](https://github.com/XeroAPI/xero-python/stargazers) -![total downloads](https://ruby-gem-downloads-badge.herokuapp.com/xero-ruby?type=total) +[![Downloads](https://pepy.tech/badge/xero-python)](https://pepy.tech/project/xero-python) The xero-python SDK makes it easy for developers to access Xero's APIs in their python code, and build robust applications and software using small business & general ledger accounting data. # Table of Contents @@ -18,6 +18,7 @@ The xero-python SDK makes it easy for developers to access Xero's APIs in their - [Helper Methods](#helper-methods) - [Usage Examples](#usage-examples) - [SDK conventions](#sdk-conventions) +- [Running Test(s) in Local](#running-tests-in-local) - [Participating in Xero’s developer community](#participating-in-xeros-developer-community) - [Contributing](#contributing) @@ -32,9 +33,9 @@ This SDK supports full method coverage for the following Xero API sets: | [Assets](https://xeroapi.github.io/xero-python/v1/assets/index.html) | The Assets API exposes fixed asset related functions of the Xero Accounting application | | [Files](https://xeroapi.github.io/xero-python/v1/files/index.html) | The Files API provides access to the files, folders, and the association of files within a Xero organisation | | [Projects](https://xeroapi.github.io/xero-python/v1/projects/index.html) | Xero Projects allows businesses to track time and costs on projects/jobs and report on profitability | -| [Payroll (AU)](https://xeroapi.github.io/xero-python/v1/payroll_au/index.html) | The (AU) Payroll API exposes payroll related functions of the payroll Xero application | -| [Payroll (UK)](https://xeroapi.github.io/xero-python/v1/payroll_uk/index.html) | The (UK) Payroll API exposes payroll related functions of the payroll Xero application | -| [Payroll (NZ)](https://xeroapi.github.io/xero-python/v1/payroll_nz/index.html) | The (NZ) Payroll API exposes payroll related functions of the payroll Xero application | +| [Payroll (AU)](https://xeroapi.github.io/xero-python/v1/payroll-au/index.html) | The (AU) Payroll API exposes payroll related functions of the payroll Xero application | +| [Payroll (UK)](https://xeroapi.github.io/xero-python/v1/payroll-uk/index.html) | The (UK) Payroll API exposes payroll related functions of the payroll Xero application | +| [Payroll (NZ)](https://xeroapi.github.io/xero-python/v1/payroll-nz/index.html) | The (NZ) Payroll API exposes payroll related functions of the payroll Xero application | drawing @@ -222,7 +223,7 @@ It is recommended that you store this token set JSON in a datastore in relation | access_token: | "xxx.yyy.zzz" | [Bearer token](https://oauth.net/2/jwt/) with a 30 minute expiration required for all API calls | | expires_in: | 1800 | Time in seconds till the token expires - 1800s is 30m | | refresh_token: | "XXXXXXX" | Alphanumeric string used to obtain a new Token Set w/ a fresh access_token - 60 day expiry | -| scope: | "email profile openid accounting.transactions offline_access" | The Xero permissions that are embedded in the `access_token` | +| scope: | ["email", "profile", "openid", "accounting.transactions", "offline_access"] | The Xero permissions that are embedded in the `access_token` | Example Token Set JSON: ``` @@ -232,12 +233,12 @@ Example Token Set JSON: "expires_in": 1800, "token_type": "Bearer", "refresh_token": "xxxxxxxxx", - "scope": "email profile openid accounting.transactions offline_access" + "scope": ["email", "profile", "openid", "accounting.transactions", "offline_access"] } ``` --- -## Custom Connections +## Custom Connections Custom Connections are a Xero [premium option](https://developer.xero.com/documentation/oauth2/custom-connections) used for building M2M integrations to a single organisation. A custom connection uses OAuth 2.0's [`client_credentials`](https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/) grant which eliminates the step of exchanging the temporary code for a token set. @@ -335,7 +336,7 @@ Because Custom Connections are only valid for a single organisation you don't ne --- -## App Store Subscriptions +## App Store Subscriptions If you are implementing subscriptions to participate in Xero's App Store you will need to setup [App Store subscriptions](https://developer.xero.com/documentation/guides/how-to-guides/xero-app-store-referrals/) endpoints. @@ -457,7 +458,7 @@ store_xero_oauth2_token(token_set) # refresh token set on the api client api_client.refresh_oauth2_token() - + # call the Xero API accounting_api = AccountingApi(api_client) read_accounts = accounting_api.get_accounts(xero_tenant_id) @@ -540,6 +541,18 @@ created_invoice_attachments_by_file_name = accounting_api.create_invoice_attachm --- ## SDK conventions + +--- +## Running Test(s) in Local +For Running Test cases PRISM Mock Server needs to be started in the local machine. +Steps to Run Test(s) +* Install PRISM from npm using the command: **npm install -g @stoplight/prism-cli** +* Verify Installation: **prism --version** +* Navigate to **tests--> utils--> ** folder in the terminal +* Execute the script **./start-prism.sh** +* This will start the PRISM Server in Local +* Run **pytest** to run the Python test cases. + ### Querying & Filtering Describe the support for query options and filtering @@ -571,7 +584,7 @@ def accounting_get_invoices(): include_archived = 'true' created_by_my_app = 'false' summary_only = 'true' - + api_response = api_instance.get_invoices( xero_tenant_id, if_modified_since, @@ -593,11 +606,11 @@ api_response = api_instance.get_invoices( ## Participating in Xero’s developer community -This SDK is one of a number of SDK’s that the Xero Developer team builds and maintains. We are grateful for all the contributions that the community makes. +This SDK is one of a number of SDK’s that the Xero Developer team builds and maintains. We are grateful for all the contributions that the community makes. Here are a few things you should be aware of as a contributor: * Xero has adopted the Contributor Covenant [Code of Conduct](https://github.com/XeroAPI/xero-python/blob/master/CODE_OF_CONDUCT.md), we expect all contributors in our community to adhere to it -* If you raise an issue then please make sure to fill out the Github issue template, doing so helps us help you +* If you raise an issue then please make sure to fill out the Github issue template, doing so helps us help you * You’re welcome to raise PRs. As our SDKs are generated we may use your code in the core SDK build instead of merging your code * We have a [contribution guide](https://github.com/XeroAPI/xero-python/blob/master/CONTRIBUTING.md) for you to follow when contributing to this SDK * Curious about how we generate our SDK’s? Have a [read of our process](https://devblog.xero.com/building-sdks-for-the-future-b79ff726dfd6) and have a look at our [OpenAPISpec](https://github.com/XeroAPI/Xero-OpenAPI) @@ -609,4 +622,4 @@ For questions that aren’t related to SDKs please refer to our [developer suppo PRs, issues, and discussion are highly appreciated and encouraged. Note that the majority of this project is generated code based on [Xero's OpenAPI specs](https://github.com/XeroAPI/Xero-OpenAPI) - PR's will be evaluated and pre-merge will be incorporated into the root generation templates. ### Versioning -We do our best to keep OS industry `semver` standards, but we can make mistakes! If something is not accurately reflected in a version's release notes please let the team know. \ No newline at end of file +We do our best to keep OS industry `semver` standards, but we can make mistakes! If something is not accurately reflected in a version's release notes please let the team know. diff --git a/bin/post-generation-hook.sh b/bin/post-generation-hook.sh index 4e89c606..6742b8ea 100755 --- a/bin/post-generation-hook.sh +++ b/bin/post-generation-hook.sh @@ -2,8 +2,11 @@ SCRIPT_DIR=$(dirname "$0") PROJECT_ROOT=$(realpath "${SCRIPT_DIR}/..") # expects script in bin/ -PATH=${PROJECT_ROOT}/venv/bin:$PATH # expects python environment in venv/ +PATH=${PROJECT_ROOT}/venv/Scripts:$PATH # expects python environment in venv/ command -v black >/dev/null 2>&1 || { echo >&2 "'black' required, but not found. Please read 'Local installation' section in ${PROJECT_ROOT}/CONTRIBUTING.md file. Aborting."; exit 1; } command -v flake8 >/dev/null 2>&1 || { echo >&2 "'flake8' required, but not found. Please read 'Local installation' section in ${PROJECT_ROOT}/CONTRIBUTING.md file. Aborting."; exit 1; } cd "${PROJECT_ROOT}" && black xero_python && flake8 xero_python -python bin/get_yaml_value.py "${1}" "${2}" | xargs python bin/bumpversion.py + +# python bin/get_yaml_value.py "${1}" "packageVersion" | xargs python ./bin/bumpversion.py + +python ./bin/bumpversion.py $2 diff --git a/docs/v1/accounting/index.html b/docs/v1/accounting/index.html index f9c11fa0..dae37327 100644 --- a/docs/v1/accounting/index.html +++ b/docs/v1/accounting/index.html @@ -909,7 +909,7 @@ }, "TaxType" : { "type" : "string", - "description" : "The tax type from TaxRates" + "description" : "The tax type from taxRates" }, "EnablePaymentsToAccount" : { "type" : "boolean", @@ -975,7 +975,7 @@ "title" : "", "type" : "string", "description" : "See Account Types", - "enum" : [ "BANK", "CURRENT", "CURRLIAB", "DEPRECIATN", "DIRECTCOSTS", "EQUITY", "EXPENSE", "FIXED", "INVENTORY", "LIABILITY", "NONCURRENT", "OTHERINCOME", "OVERHEADS", "PREPAYMENT", "REVENUE", "SALES", "TERMLIAB", "PAYGLIABILITY", "PAYG", "SUPERANNUATIONEXPENSE", "SUPERANNUATIONLIABILITY", "WAGESEXPENSE" ] + "enum" : [ "BANK", "CURRENT", "CURRLIAB", "DEPRECIATN", "DIRECTCOSTS", "EQUITY", "EXPENSE", "FIXED", "INVENTORY", "LIABILITY", "NONCURRENT", "OTHERINCOME", "OVERHEADS", "PREPAYMENT", "REVENUE", "SALES", "TERMLIAB", "PAYG" ] }; defs["Accounts"] = { "title" : "", @@ -989,7 +989,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "accounts" }; defs["AccountsPayable"] = { "title" : "", @@ -1056,7 +1056,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "actions" }; defs["Address"] = { "title" : "", @@ -1183,6 +1183,11 @@ "required" : [ "Amount", "Date", "Invoice" ], "type" : "object", "properties" : { + "AllocationID" : { + "type" : "string", + "description" : "Xero generated unique identifier", + "format" : "uuid" + }, "Invoice" : { "$ref" : "#/components/schemas/Invoice" }, @@ -1206,6 +1211,11 @@ "description" : "the date the allocation is applied YYYY-MM-DD.", "x-is-msdate" : true }, + "IsDeleted" : { + "type" : "boolean", + "description" : "A flag that returns true when the allocation is succesfully deleted", + "readOnly" : true + }, "StatusAttributeString" : { "type" : "string", "description" : "A string to indicate if a invoice status" @@ -1235,7 +1245,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "allocations" }; defs["Attachment"] = { "title" : "", @@ -1288,7 +1298,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "attachments" }; defs["BalanceDetails"] = { "title" : "", @@ -1455,6 +1465,16 @@ "title" : "", "type" : "object", "properties" : { + "pagination" : { + "$ref" : "#/components/schemas/Pagination" + }, + "Warnings" : { + "type" : "array", + "description" : "Displays array of warning messages from the API", + "items" : { + "$ref" : "#/components/schemas/ValidationError" + } + }, "BankTransactions" : { "type" : "array", "items" : { @@ -1463,7 +1483,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "bank_transactions" }; defs["BankTransfer"] = { "title" : "", @@ -1542,6 +1562,26 @@ "example" : "/Date(1573755038314)/", "x-is-msdate-time" : true }, + "Status" : { + "type" : "string", + "description" : "AUTHORISED or DELETED (read-only). New bank transfers will have a status of AUTHORISED.", + "readOnly" : true, + "enum" : [ "AUTHORISED", "DELETED" ] + }, + "FromTracking" : { + "type" : "array", + "description" : "Optional Tracking Category for the source account – see Tracking. A bank transfer can have a maximum of 2 tracking categories per account.", + "items" : { + "$ref" : "#/components/schemas/TrackingReference" + } + }, + "ToTracking" : { + "type" : "array", + "description" : "Optional Tracking Category for the destination account – see Tracking. A bank transfer can have a maximum of 2 tracking categories per account.", + "items" : { + "$ref" : "#/components/schemas/TrackingReference" + } + }, "ValidationErrors" : { "type" : "array", "description" : "Displays array of validation error messages from the API", @@ -1554,6 +1594,43 @@ "externalDocs" : { "url" : "http://developer.xero.com/documentation/api/bank-transfers/" } +}; + defs["BankTransferDelete"] = { + "title" : "", + "required" : [ "BankTransferID", "Status" ], + "type" : "object", + "properties" : { + "BankTransferID" : { + "type" : "string", + "description" : "The Xero identifier for a bank transfer", + "format" : "uuid" + }, + "Status" : { + "type" : "string", + "description" : "The status of the bank transfer.", + "default" : "DELETED" + } + }, + "description" : "", + "externalDocs" : { + "url" : "http://developer.xero.com/documentation/api/bank-transfers/" + } +}; + defs["BankTransferDeleteByUrlParam"] = { + "title" : "", + "required" : [ "Status" ], + "type" : "object", + "properties" : { + "Status" : { + "type" : "string", + "description" : "The status of the bank transfer.", + "default" : "DELETED" + } + }, + "description" : "", + "externalDocs" : { + "url" : "http://developer.xero.com/documentation/api/bank-transfers/" + } }; defs["BankTransfers"] = { "title" : "", @@ -1567,7 +1644,21 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "bank_transfers" +}; + defs["BankTransfersDelete"] = { + "title" : "", + "type" : "object", + "properties" : { + "BankTransfers" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/BankTransferDelete" + } + } + }, + "description" : "", + "x-objectArrayKey" : "bank_transfers" }; defs["BatchPayment"] = { "title" : "", @@ -1641,9 +1732,11 @@ "enum" : [ "AUTHORISED", "DELETED" ] }, "TotalAmount" : { - "type" : "string", + "type" : "number", "description" : "The total of the payments that make up the batch (read-only)", - "readOnly" : true + "format" : "double", + "readOnly" : true, + "x-is-money" : true }, "UpdatedDateUTC" : { "type" : "string", @@ -1653,7 +1746,7 @@ "x-is-msdate-time" : true }, "IsReconciled" : { - "type" : "string", + "type" : "boolean", "description" : "Booelan that tells you if the batch payment has been reconciled (read-only)", "readOnly" : true }, @@ -1669,6 +1762,43 @@ "externalDocs" : { "url" : "http://developer.xero.com/documentation/api/BatchPayments/" } +}; + defs["BatchPaymentDelete"] = { + "title" : "", + "required" : [ "BatchPaymentID", "Status" ], + "type" : "object", + "properties" : { + "BatchPaymentID" : { + "type" : "string", + "description" : "The Xero generated unique identifier for the bank transaction (read-only)", + "format" : "uuid" + }, + "Status" : { + "type" : "string", + "description" : "The status of the batch payment.", + "default" : "DELETED" + } + }, + "description" : "", + "externalDocs" : { + "url" : "http://developer.xero.com/documentation/api/accounting/batchpayments" + } +}; + defs["BatchPaymentDeleteByUrlParam"] = { + "title" : "", + "required" : [ "Status" ], + "type" : "object", + "properties" : { + "Status" : { + "type" : "string", + "description" : "The status of the batch payment.", + "default" : "DELETED" + } + }, + "description" : "", + "externalDocs" : { + "url" : "http://developer.xero.com/documentation/api/accounting/batchpayments" + } }; defs["BatchPaymentDetails"] = { "title" : "", @@ -1718,7 +1848,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "batch_payments" }; defs["Bill"] = { "title" : "", @@ -1788,7 +1918,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "branding_themes" }; defs["Budget"] = { "title" : "", @@ -1901,7 +2031,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "budgets" }; defs["CISOrgSetting"] = { "title" : "", @@ -1939,7 +2069,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "cis_settings" }; defs["CISSetting"] = { "title" : "", @@ -1973,7 +2103,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "cis_settings" }; defs["Contact"] = { "title" : "", @@ -2029,10 +2159,6 @@ "type" : "string", "description" : "Email address of contact person (umlauts not supported) (max length = 255)" }, - "SkypeUserName" : { - "type" : "string", - "description" : "Skype user name of contact" - }, "ContactPersons" : { "type" : "array", "description" : "See contact persons", @@ -2049,6 +2175,11 @@ "type" : "string", "description" : "Tax number of contact – this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50)" }, + "TaxNumberType" : { + "type" : "string", + "description" : "Identifier of the regional type of tax number, such as US, UK, or other regional tax identifiers", + "enum" : [ "SSN", "EIN", "ITIN", "ATIN" ] + }, "AccountsReceivableTaxType" : { "type" : "string", "description" : "The tax type from TaxRates" @@ -2243,7 +2374,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "contact_groups" }; defs["ContactPerson"] = { "title" : "", @@ -2275,6 +2406,16 @@ "title" : "", "type" : "object", "properties" : { + "pagination" : { + "$ref" : "#/components/schemas/Pagination" + }, + "Warnings" : { + "type" : "array", + "description" : "Displays array of warning messages from the API", + "items" : { + "$ref" : "#/components/schemas/ValidationError" + } + }, "Contacts" : { "type" : "array", "items" : { @@ -2283,7 +2424,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "contacts" }; defs["ConversionBalances"] = { "title" : "", @@ -2406,6 +2547,12 @@ "example" : "/Date(1573755038314)/", "x-is-msdate-time" : true }, + "UpdatedDateUTCString" : { + "type" : "string", + "description" : "UTC ISO-8601 formatted timestamp of last update to the credit note", + "readOnly" : true, + "example" : "2019-11-14T18:10:38Z" + }, "CurrencyCode" : { "$ref" : "#/components/schemas/CurrencyCode" }, @@ -2429,7 +2576,7 @@ }, "SentToContact" : { "type" : "boolean", - "description" : "boolean to indicate if a credit note has been sent to a contact via the Xero app (currently read only)", + "description" : "Boolean to set whether the credit note in the Xero app should be marked as “sent”. This can be set only on credit notes that have been approved", "readOnly" : true }, "CurrencyRate" : { @@ -2499,6 +2646,13 @@ "items" : { "$ref" : "#/components/schemas/ValidationError" } + }, + "InvoiceAddresses" : { + "type" : "array", + "description" : "An array of addresses used to auto calculate sales tax", + "items" : { + "$ref" : "#/components/schemas/InvoiceAddress" + } } }, "description" : "", @@ -2510,6 +2664,16 @@ "title" : "", "type" : "object", "properties" : { + "pagination" : { + "$ref" : "#/components/schemas/Pagination" + }, + "Warnings" : { + "type" : "array", + "description" : "Displays array of warning messages from the API", + "items" : { + "$ref" : "#/components/schemas/ValidationError" + } + }, "CreditNotes" : { "type" : "array", "items" : { @@ -2518,7 +2682,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "credit_notes" }; defs["Currencies"] = { "title" : "", @@ -2532,7 +2696,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "currencies" }; defs["Currency"] = { "title" : "", @@ -2555,8 +2719,8 @@ "title" : "", "type" : "string", "description" : "3 letter alpha code for the currency – see list of currency codes", - "enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZMK", "ZWD", "" ], - "x-enum-varnames" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY_LIRA", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZMK", "ZWD", "EMPTY_CURRENCY" ] + "enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SKK", "SLE", "SLL", "SOS", "SRD", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZMK", "ZWD" ], + "x-enum-varnames" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SKK", "SLE", "SLL", "SOS", "SRD", "STN", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY_LIRA", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZMK", "ZWD", "EMPTY_CURRENCY" ] }; defs["Element"] = { "title" : "", @@ -2667,7 +2831,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "employees" }; defs["Error"] = { "title" : "", @@ -2791,7 +2955,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "expense_claims" }; defs["ExternalLink"] = { "title" : "", @@ -2856,7 +3020,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "history_records" }; defs["ImportSummary"] = { "title" : "", @@ -3141,11 +3305,17 @@ }, "UpdatedDateUTC" : { "type" : "string", - "description" : "Last modified date UTC format", + "description" : "UTC timestamp of last update to the invoice", "readOnly" : true, "example" : "/Date(1573755038314)/", "x-is-msdate-time" : true }, + "UpdatedDateUTCString" : { + "type" : "string", + "description" : "UTC ISO-8601 formatted timestamp of last update to the invoice", + "readOnly" : true, + "example" : "2019-11-14T18:10:38Z" + }, "CreditNotes" : { "type" : "array", "description" : "Details of credit notes that have been applied to an invoice", @@ -3184,12 +3354,63 @@ "items" : { "$ref" : "#/components/schemas/ValidationError" } + }, + "InvoiceAddresses" : { + "type" : "array", + "description" : "An array of addresses used to auto calculate sales tax", + "items" : { + "$ref" : "#/components/schemas/InvoiceAddress" + } } }, "description" : "", "externalDocs" : { "url" : "http://developer.xero.com/documentation/api/invoices/" } +}; + defs["InvoiceAddress"] = { + "title" : "", + "type" : "object", + "properties" : { + "InvoiceAddressType" : { + "type" : "string", + "description" : "Indicates whether the address is defined as origin (FROM) or destination (TO)", + "enum" : [ "FROM", "TO" ] + }, + "AddressLine1" : { + "type" : "string", + "description" : "First line of a physical address" + }, + "AddressLine2" : { + "type" : "string", + "description" : "Second line of a physical address" + }, + "AddressLine3" : { + "type" : "string", + "description" : "Third line of a physical address" + }, + "AddressLine4" : { + "type" : "string", + "description" : "Fourth line of a physical address" + }, + "City" : { + "type" : "string", + "description" : "City of a physical address" + }, + "Region" : { + "type" : "string", + "description" : "Region or state of a physical address" + }, + "PostalCode" : { + "type" : "string", + "description" : "Postal code of a physical address" + }, + "Country" : { + "type" : "string", + "description" : "Country of a physical address" + } + }, + "description" : "" }; defs["InvoiceReminder"] = { "title" : "", @@ -3217,12 +3438,22 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "invoice_reminders" }; defs["Invoices"] = { "title" : "", "type" : "object", "properties" : { + "pagination" : { + "$ref" : "#/components/schemas/Pagination" + }, + "Warnings" : { + "type" : "array", + "description" : "Displays array of warning messages from the API", + "items" : { + "$ref" : "#/components/schemas/ValidationError" + } + }, "Invoices" : { "type" : "array", "items" : { @@ -3231,7 +3462,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "invoices" }; defs["Item"] = { "title" : "", @@ -3288,10 +3519,22 @@ }, "QuantityOnHand" : { "type" : "number", - "description" : "The quantity of the item on hand", + "description" : "The quantity of the item on hand. This will be 0 if `QuantityOnBackOrder` is greater than 0.", "format" : "double", "x-is-money" : true }, + "QuantityAvailable" : { + "type" : "number", + "description" : "The quantity of the item available. This is equal to `QuantityOnHand` - `QuantityOnBackOrder`. This value will be negative if `QuantityOnBackOrder` is greater than 0.", + "format" : "double", + "readOnly" : true + }, + "QuantityOnBackOrder" : { + "type" : "number", + "description" : "The quantity of the item on backorder. This will be 0 if `QuantityOnHand` is greater than 0.", + "format" : "double", + "readOnly" : true + }, "UpdatedDateUTC" : { "type" : "string", "description" : "Last modified date in UTC format", @@ -3333,7 +3576,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "items" }; defs["Journal"] = { "title" : "", @@ -3445,7 +3688,7 @@ }, "TaxType" : { "type" : "string", - "description" : "The tax type from TaxRates" + "description" : "The tax type from taxRates" }, "TaxName" : { "type" : "string", @@ -3469,6 +3712,13 @@ "title" : "", "type" : "object", "properties" : { + "Warnings" : { + "type" : "array", + "description" : "Displays array of warning messages from the API", + "items" : { + "$ref" : "#/components/schemas/ValidationError" + } + }, "Journals" : { "type" : "array", "items" : { @@ -3477,7 +3727,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "journals" }; defs["LineAmountTypes"] = { "title" : "", @@ -3540,7 +3790,7 @@ }, "LineAmount" : { "type" : "number", - "description" : "If you wish to omit either of the or you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if a DiscountRate has been used . i.e LineAmount = Quantity * Unit Amount * ((100 – DiscountRate)/100)", + "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", "format" : "double", "x-is-money" : true }, @@ -3559,7 +3809,7 @@ }, "DiscountAmount" : { "type" : "number", - "description" : "Discount amount being applied to a line item. Only supported on ACCREC invoices - ACCPAY invoices and credit notes in Xero do not support discounts.", + "description" : "Discount amount being applied to a line item. Only supported on ACCREC invoices and quotes. ACCPAY invoices and credit notes in Xero do not support discounts.", "format" : "double", "x-is-money" : true }, @@ -3568,6 +3818,22 @@ "description" : "The Xero identifier for a Repeating Invoice", "format" : "uuid", "example" : "00000000-0000-0000-0000-000000000000" + }, + "Taxability" : { + "type" : "string", + "description" : "The type of taxability", + "enum" : [ "TAXABLE", "NON_TAXABLE", "EXEMPT", "PART_TAXABLE", "NOT_APPLICABLE" ] + }, + "SalesTaxCodeId" : { + "type" : "number", + "description" : "The ID of the sales tax code" + }, + "TaxBreakdown" : { + "type" : "array", + "description" : "An array of tax components defined for this line item", + "items" : { + "$ref" : "#/components/schemas/TaxBreakdownComponent" + } } }, "description" : "", @@ -3710,7 +3976,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "linked_transactions" }; defs["ManualJournal"] = { "title" : "", @@ -3859,6 +4125,16 @@ "title" : "", "type" : "object", "properties" : { + "pagination" : { + "$ref" : "#/components/schemas/Pagination" + }, + "Warnings" : { + "type" : "array", + "description" : "Displays array of warning messages from the API", + "items" : { + "$ref" : "#/components/schemas/ValidationError" + } + }, "ManualJournals" : { "type" : "array", "items" : { @@ -3867,7 +4143,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "manual_journals" }; defs["OnlineInvoice"] = { "title" : "", @@ -3895,7 +4171,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "online_invoices" }; defs["Organisation"] = { "title" : "", @@ -3931,7 +4207,7 @@ "OrganisationType" : { "type" : "string", "description" : "Organisation Type", - "enum" : [ "ACCOUNTING_PRACTICE", "COMPANY", "CHARITY", "CLUB_OR_SOCIETY", "INDIVIDUAL", "LOOK_THROUGH_COMPANY", "NOT_FOR_PROFIT", "PARTNERSHIP", "S_CORPORATION", "SELF_MANAGED_SUPERANNUATION_FUND", "SOLE_TRADER", "SUPERANNUATION_FUND", "TRUST" ] + "enum" : [ "ACCOUNTING_PRACTICE", "COMPANY", "CHARITY", "CLUB_OR_SOCIETY", "INDIVIDUAL", "LOOK_THROUGH_COMPANY", "NOT_FOR_PROFIT", "PARTNERSHIP", "S_CORPORATION", "SELF_MANAGED_SUPERANNUATION_FUND", "SOLE_TRADER", "SUPERANNUATION_FUND", "TRUST", "PERSONAL", "SINGLEMEMBERLLC", "CCORPORATIONLLC", "PARTNERSHIPLLC", "SCORPORATIONLLC", "LLC", "NOTLLC", "UNSPECIFIED" ] }, "BaseCurrency" : { "$ref" : "#/components/schemas/CurrencyCode" @@ -4008,7 +4284,7 @@ "OrganisationEntityType" : { "type" : "string", "description" : "Organisation Entity Type", - "enum" : [ "ACCOUNTING_PRACTICE", "COMPANY", "CHARITY", "CLUB_OR_SOCIETY", "INDIVIDUAL", "LOOK_THROUGH_COMPANY", "NOT_FOR_PROFIT", "PARTNERSHIP", "S_CORPORATION", "SELF_MANAGED_SUPERANNUATION_FUND", "SOLE_TRADER", "SUPERANNUATION_FUND", "TRUST" ] + "enum" : [ "ACCOUNTING_PRACTICE", "COMPANY", "CHARITY", "CLUB_OR_SOCIETY", "INDIVIDUAL", "LOOK_THROUGH_COMPANY", "NOT_FOR_PROFIT", "PARTNERSHIP", "S_CORPORATION", "SELF_MANAGED_SUPERANNUATION_FUND", "SOLE_TRADER", "SUPERANNUATION_FUND", "TRUST", "PERSONAL", "SINGLEMEMBERLLC", "CCORPORATIONLLC", "PARTNERSHIPLLC", "SCORPORATIONLLC", "LLC", "NOTLLC", "UNSPECIFIED" ] }, "ShortCode" : { "type" : "string", @@ -4017,7 +4293,7 @@ "Class" : { "type" : "string", "description" : "Organisation Classes describe which plan the Xero organisation is on (e.g. DEMO, TRIAL, PREMIUM)", - "enum" : [ "DEMO", "TRIAL", "STARTER", "STANDARD", "PREMIUM", "PREMIUM_20", "PREMIUM_50", "PREMIUM_100", "LEDGER", "GST_CASHBOOK", "NON_GST_CASHBOOK" ] + "enum" : [ "DEMO", "TRIAL", "STARTER", "STANDARD", "PREMIUM", "PREMIUM_20", "PREMIUM_50", "PREMIUM_100", "LEDGER", "GST_CASHBOOK", "NON_GST_CASHBOOK", "ULTIMATE", "LITE", "ULTIMATE_10", "ULTIMATE_20", "ULTIMATE_50", "ULTIMATE_100", "IGNITE", "GROW", "COMPREHENSIVE", "SIMPLE", "BASICLITE", "ULTRA" ] }, "Edition" : { "type" : "string", @@ -4070,7 +4346,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "organisations" }; defs["Overpayment"] = { "title" : "", @@ -4129,6 +4405,12 @@ "example" : "/Date(1573755038314)/", "x-is-msdate-time" : true }, + "UpdatedDateUTCString" : { + "type" : "string", + "description" : "UTC ISO-8601 formatted timestamp of last update to the overpayment", + "readOnly" : true, + "example" : "2019-11-14T18:10:38Z" + }, "CurrencyCode" : { "$ref" : "#/components/schemas/CurrencyCode" }, @@ -4176,6 +4458,11 @@ "example" : false, "default" : false }, + "Reference" : { + "type" : "string", + "description" : "An optional description for Overpayment", + "example" : "Ref for payment" + }, "Attachments" : { "type" : "array", "description" : "See Attachments", @@ -4193,6 +4480,16 @@ "title" : "", "type" : "object", "properties" : { + "pagination" : { + "$ref" : "#/components/schemas/Pagination" + }, + "Warnings" : { + "type" : "array", + "description" : "Displays array of warning messages from the API", + "items" : { + "$ref" : "#/components/schemas/ValidationError" + } + }, "Overpayments" : { "type" : "array", "items" : { @@ -4201,7 +4498,26 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "overpayments" +}; + defs["Pagination"] = { + "title" : "", + "type" : "object", + "properties" : { + "page" : { + "type" : "integer" + }, + "pageSize" : { + "type" : "integer" + }, + "pageCount" : { + "type" : "integer" + }, + "itemCount" : { + "type" : "integer" + } + }, + "description" : "" }; defs["Payment"] = { "title" : "", @@ -4227,6 +4543,9 @@ "type" : "string", "description" : "Number of invoice or credit note you are applying payment to e.g. INV-4003" }, + "BatchPayment" : { + "$ref" : "#/components/schemas/BatchPayment" + }, "Account" : { "$ref" : "#/components/schemas/Account" }, @@ -4283,6 +4602,12 @@ "example" : "/Date(1573755038314)/", "x-is-msdate-time" : true }, + "UpdatedDateUTCString" : { + "type" : "string", + "description" : "UTC ISO-8601 formatted timestamp of last update to the payment", + "readOnly" : true, + "example" : "2019-11-14T18:10:38Z" + }, "PaymentID" : { "type" : "string", "description" : "The Xero identifier for an Payment e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9", @@ -4329,6 +4654,13 @@ "items" : { "$ref" : "#/components/schemas/ValidationError" } + }, + "Warnings" : { + "type" : "array", + "description" : "Displays array of warning messages from the API", + "items" : { + "$ref" : "#/components/schemas/ValidationError" + } } }, "description" : "", @@ -4401,7 +4733,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "payment_services" }; defs["PaymentTerm"] = { "title" : "", @@ -4429,6 +4761,16 @@ "title" : "", "type" : "object", "properties" : { + "pagination" : { + "$ref" : "#/components/schemas/Pagination" + }, + "Warnings" : { + "type" : "array", + "description" : "Displays array of warning messages from the API", + "items" : { + "$ref" : "#/components/schemas/ValidationError" + } + }, "Payments" : { "type" : "array", "items" : { @@ -4437,7 +4779,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "payments" }; defs["Phone"] = { "title" : "", @@ -4523,6 +4865,11 @@ "description" : "Returns Invoice number field. Reference field isn't available.", "readOnly" : true }, + "InvoiceNumber" : { + "type" : "string", + "description" : "Returns Invoice number for prepayment receive document only.", + "readOnly" : true + }, "UpdatedDateUTC" : { "type" : "string", "description" : "UTC timestamp of last update to the prepayment", @@ -4530,6 +4877,12 @@ "example" : "/Date(1573755038314)/", "x-is-msdate-time" : true }, + "UpdatedDateUTCString" : { + "type" : "string", + "description" : "UTC ISO-8601 formatted timestamp of last update to the prepayment", + "readOnly" : true, + "example" : "2019-11-14T18:10:38Z" + }, "CurrencyCode" : { "$ref" : "#/components/schemas/CurrencyCode" }, @@ -4538,6 +4891,12 @@ "description" : "Xero generated unique identifier", "format" : "uuid" }, + "BrandingThemeID" : { + "type" : "string", + "description" : "The unique identifier of the branding template applied to a receive prepayment", + "format" : "uuid", + "readOnly" : true + }, "CurrencyRate" : { "type" : "number", "description" : "The currency rate for a multicurrency prepayment. If no rate is specified, the XE.com day rate is used", @@ -4594,6 +4953,16 @@ "title" : "", "type" : "object", "properties" : { + "pagination" : { + "$ref" : "#/components/schemas/Pagination" + }, + "Warnings" : { + "type" : "array", + "description" : "Displays array of warning messages from the API", + "items" : { + "$ref" : "#/components/schemas/ValidationError" + } + }, "Prepayments" : { "type" : "array", "items" : { @@ -4602,7 +4971,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "prepayments" }; defs["Purchase"] = { "title" : "", @@ -4793,6 +5162,16 @@ "title" : "", "type" : "object", "properties" : { + "pagination" : { + "$ref" : "#/components/schemas/Pagination" + }, + "Warnings" : { + "type" : "array", + "description" : "Displays array of warning messages from the API", + "items" : { + "$ref" : "#/components/schemas/ValidationError" + } + }, "PurchaseOrders" : { "type" : "array", "items" : { @@ -4801,7 +5180,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "purchase_orders" }; defs["Quote"] = { "title" : "", @@ -4960,7 +5339,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "quotes" }; defs["Receipt"] = { "title" : "", @@ -5081,7 +5460,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "receipts" }; defs["RepeatingInvoice"] = { "title" : "", @@ -5155,7 +5534,7 @@ }, "HasAttachments" : { "type" : "boolean", - "description" : "boolean to indicate if an invoice has an attachment", + "description" : "Boolean to indicate if an invoice has an attachment", "readOnly" : true, "example" : false, "default" : false @@ -5166,6 +5545,30 @@ "items" : { "$ref" : "#/components/schemas/Attachment" } + }, + "ApprovedForSending" : { + "type" : "boolean", + "description" : "Boolean to indicate whether the invoice has been approved for sending", + "example" : false, + "default" : false + }, + "SendCopy" : { + "type" : "boolean", + "description" : "Boolean to indicate whether a copy is sent to sender's email", + "example" : false, + "default" : false + }, + "MarkAsSent" : { + "type" : "boolean", + "description" : "Boolean to indicate whether the invoice in the Xero app displays as \"sent\"", + "example" : false, + "default" : false + }, + "IncludePDF" : { + "type" : "boolean", + "description" : "Boolean to indicate whether to include PDF attachment", + "example" : false, + "default" : false } }, "description" : "", @@ -5185,7 +5588,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "repeating_invoices" }; defs["Report"] = { "title" : "", @@ -5397,7 +5800,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "reports" }; defs["RequestEmpty"] = { "title" : "", @@ -5504,6 +5907,55 @@ "externalDocs" : { "url" : "https://developer.xero.com/documentation/api-guides/conversions" } +}; + defs["TaxBreakdownComponent"] = { + "title" : "", + "type" : "object", + "properties" : { + "TaxComponentId" : { + "type" : "string", + "description" : "The unique ID number of this component", + "format" : "uuid" + }, + "Type" : { + "type" : "string", + "description" : "The type of the jurisdiction", + "enum" : [ "SYSGST/USCOUNTRY", "SYSGST/USSTATE", "SYSGST/USCOUNTY", "SYSGST/USCITY", "SYSGST/USSPECIAL" ] + }, + "Name" : { + "type" : "string", + "description" : "The name of the jurisdiction" + }, + "TaxPercentage" : { + "type" : "number", + "description" : "The percentage of the tax" + }, + "TaxAmount" : { + "type" : "number", + "description" : "The amount of the tax" + }, + "TaxableAmount" : { + "type" : "number", + "description" : "The amount that is taxable" + }, + "NonTaxableAmount" : { + "type" : "number", + "description" : "The amount that is not taxable" + }, + "ExemptAmount" : { + "type" : "number", + "description" : "The amount that is exempt" + }, + "StateAssignedNo" : { + "type" : "string", + "description" : "The state assigned number of the jurisdiction" + }, + "JurisdictionRegion" : { + "type" : "string", + "description" : "Name identifying the region within the country" + } + }, + "description" : "" }; defs["TaxComponent"] = { "title" : "", @@ -5560,7 +6012,7 @@ "ReportTaxType" : { "type" : "string", "description" : "See ReportTaxTypes", - "enum" : [ "AVALARA", "BASEXCLUDED", "CAPITALSALESOUTPUT", "CAPITALEXPENSESINPUT", "ECOUTPUT", "ECOUTPUTSERVICES", "ECINPUT", "ECACQUISITIONS", "EXEMPTEXPENSES", "EXEMPTINPUT", "EXEMPTOUTPUT", "GSTONIMPORTS", "INPUT", "INPUTTAXED", "MOSSSALES", "NONE", "NONEOUTPUT", "OUTPUT", "PURCHASESINPUT", "SALESOUTPUT", "EXEMPTCAPITAL", "EXEMPTEXPORT", "CAPITALEXINPUT", "GSTONCAPIMPORTS", "GSTONCAPITALIMPORTS", "REVERSECHARGES", "PAYMENTS", "INVOICE", "CASH", "ACCRUAL", "FLATRATECASH", "FLATRATEACCRUAL", "ACCRUALS", "TXCA", "SRCAS", "DSOUTPUT", "BLINPUT2", "EPINPUT", "IMINPUT2", "MEINPUT", "IGDSINPUT2", "ESN33OUTPUT", "OPINPUT", "OSOUTPUT", "TXN33INPUT", "TXESSINPUT", "TXREINPUT", "TXPETINPUT", "NRINPUT", "ES33OUTPUT", "ZERORATEDINPUT", "ZERORATEDOUTPUT", "DRCHARGESUPPLY", "DRCHARGE", "CAPINPUT", "CAPIMPORTS", "IMINPUT", "INPUT2", "CIUINPUT", "SRINPUT", "OUTPUT2", "SROUTPUT", "CAPOUTPUT", "SROUTPUT2", "CIUOUTPUT", "ZROUTPUT", "ZREXPORT", "ACC28PLUS", "ACCUPTO28", "OTHEROUTPUT", "SHOUTPUT", "ZRINPUT", "BADDEBT", "OTHERINPUT" ] + "enum" : [ "AVALARA", "BASEXCLUDED", "CAPITALSALESOUTPUT", "CAPITALEXPENSESINPUT", "ECOUTPUT", "ECOUTPUTSERVICES", "ECINPUT", "ECACQUISITIONS", "EXEMPTEXPENSES", "EXEMPTINPUT", "EXEMPTOUTPUT", "GSTONIMPORTS", "INPUT", "INPUTTAXED", "MOSSSALES", "NONE", "NONEOUTPUT", "OUTPUT", "PURCHASESINPUT", "SALESOUTPUT", "EXEMPTCAPITAL", "EXEMPTEXPORT", "CAPITALEXINPUT", "GSTONCAPIMPORTS", "GSTONCAPITALIMPORTS", "REVERSECHARGES", "PAYMENTS", "INVOICE", "CASH", "ACCRUAL", "FLATRATECASH", "FLATRATEACCRUAL", "ACCRUALS", "TXCA", "SRCAS", "DSOUTPUT", "BLINPUT2", "EPINPUT", "IMINPUT2", "MEINPUT", "IGDSINPUT2", "ESN33OUTPUT", "OPINPUT", "OSOUTPUT", "TXN33INPUT", "TXESSINPUT", "TXREINPUT", "TXPETINPUT", "NRINPUT", "ES33OUTPUT", "ZERORATEDINPUT", "ZERORATEDOUTPUT", "DRCHARGESUPPLY", "DRCHARGE", "CAPINPUT", "CAPIMPORTS", "IMINPUT", "INPUT2", "CIUINPUT", "SRINPUT", "OUTPUT2", "SROUTPUT", "CAPOUTPUT", "SROUTPUT2", "CIUOUTPUT", "ZROUTPUT", "ZREXPORT", "ACC28PLUS", "ACCUPTO28", "OTHEROUTPUT", "SHOUTPUT", "ZRINPUT", "BADDEBT", "OTHERINPUT", "BADDEBTRELIEF", "IGDSINPUT3", "SROVR", "TOURISTREFUND", "TXRCN33", "TXRCRE", "TXRCESS", "TXRCTS", "CAPEXINPUT", "UNDEFINED", "CAPEXOUTPUT", "ZEROEXPOUTPUT", "GOODSIMPORT", "NONEINPUT", "NOTREPORTED", "SROVRRS", "SROVRLVG", "SRLVG", "IM", "IMESS", "IMN33", "IMRE", "BADDEBTRECOVERY", "USSALESTAX", "BLINPUT3" ] }, "CanApplyToAssets" : { "type" : "boolean", @@ -5619,13 +6071,13 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "tax_rates" }; defs["TaxType"] = { "title" : "", "type" : "string", "description" : "See Tax Types – can only be used on update calls", - "enum" : [ "OUTPUT", "INPUT", "CAPEXINPUT", "EXEMPTEXPORT", "EXEMPTEXPENSES", "EXEMPTCAPITAL", "EXEMPTOUTPUT", "INPUTTAXED", "BASEXCLUDED", "GSTONCAPIMPORTS", "GSTONIMPORTS", "NONE", "INPUT2", "ZERORATED", "OUTPUT2", "CAPEXINPUT2", "CAPEXOUTPUT", "CAPEXOUTPUT2", "CAPEXSRINPUT", "CAPEXSROUTPUT", "ECACQUISITIONS", "ECZRINPUT", "ECZROUTPUT", "ECZROUTPUTSERVICES", "EXEMPTINPUT", "REVERSECHARGES", "RRINPUT", "RROUTPUT", "SRINPUT", "SROUTPUT", "ZERORATEDINPUT", "ZERORATEDOUTPUT", "BLINPUT", "DSOUTPUT", "EPINPUT", "ES33OUTPUT", "ESN33OUTPUT", "IGDSINPUT2", "IMINPUT2", "MEINPUT", "NRINPUT", "OPINPUT", "OSOUTPUT", "TXESSINPUT", "TXN33INPUT", "TXPETINPUT", "TXREINPUT", "INPUT3", "INPUT4", "OUTPUT3", "OUTPUT4", "SROUTPUT2", "TXCA", "SRCAS", "BLINPUT2", "DRCHARGESUPPLY20", "DRCHARGE20", "DRCHARGESUPPLY5", "DRCHARGE5" ] + "enum" : [ "OUTPUT", "INPUT", "CAPEXINPUT", "EXEMPTEXPORT", "EXEMPTEXPENSES", "EXEMPTCAPITAL", "EXEMPTOUTPUT", "INPUTTAXED", "BASEXCLUDED", "GSTONCAPIMPORTS", "GSTONIMPORTS", "NONE", "INPUT2", "ZERORATED", "OUTPUT2", "CAPEXINPUT2", "CAPEXOUTPUT", "CAPEXOUTPUT2", "CAPEXSRINPUT", "CAPEXSROUTPUT", "ECACQUISITIONS", "ECZRINPUT", "ECZROUTPUT", "ECZROUTPUTSERVICES", "EXEMPTINPUT", "REVERSECHARGES", "RRINPUT", "RROUTPUT", "SRINPUT", "SROUTPUT", "ZERORATEDINPUT", "ZERORATEDOUTPUT", "BLINPUT", "DSOUTPUT", "EPINPUT", "ES33OUTPUT", "ESN33OUTPUT", "IGDSINPUT2", "IMINPUT2", "MEINPUT", "NRINPUT", "OPINPUT", "OSOUTPUT", "TXESSINPUT", "TXN33INPUT", "TXPETINPUT", "TXREINPUT", "INPUT3", "INPUT4", "OUTPUT3", "OUTPUT4", "SROUTPUT2", "TXCA", "SRCAS", "BLINPUT2", "DRCHARGESUPPLY20", "DRCHARGE20", "DRCHARGESUPPLY5", "DRCHARGE5", "BADDEBTRELIEF", "IGDSINPUT3", "SROVR", "TOURISTREFUND", "TXRCN33", "TXRCRE", "TXRCESS", "TXRCTS", "OUTPUTY23", "DSOUTPUTY23", "INPUTY23", "IMINPUT2Y23", "IGDSINPUT2Y23", "TXPETINPUTY23", "TXESSINPUTY23", "TXN33INPUTY23", "TXREINPUTY23", "TXCAY23", "BADDEBTRELIEFY23", "IGDSINPUT3Y23", "SROVRRSY23", "SROVRLVGY23", "SRLVGY23", "TXRCN33Y23", "TXRCREY23", "TXRCESSY23", "TXRCTSY23", "IM", "IMY23", "IMESS", "IMESSY23", "IMN33", "IMN33Y23", "IMRE", "IMREY23", "BADDEBTRECOVERY", "BADDEBTRECOVERYY23", "OUTPUTY24", "DSOUTPUTY24", "INPUTY24", "IGDSINPUT2Y24", "TXPETINPUTY24", "TXESSINPUTY24", "TXN33INPUTY24", "TXREINPUTY24", "TXCAY24", "BADDEBTRELIEFY24", "IGDSINPUT3Y24", "SROVRRSY24", "SROVRLVGY24", "SRLVGY24", "TXRCTSY24", "TXRCESSY24", "TXRCN33Y24", "TXRCREY24", "IMY24", "IMESSY24", "IMN33Y24", "IMREY24", "BADDEBTRECOVERYY24", "OSOUTPUT2", "BLINPUT3", "BLINPUT3Y23", "BLINPUT3Y24" ] }; defs["TenNinetyNineContact"] = { "title" : "", @@ -5744,6 +6196,19 @@ "type" : "string", "description" : "Contact contact id", "format" : "uuid" + }, + "LegalName" : { + "type" : "string", + "description" : "Contact legal name" + }, + "BusinessName" : { + "type" : "string", + "description" : "Contact business name" + }, + "FederalTaxClassification" : { + "type" : "string", + "description" : "Contact federal tax classification", + "enum" : [ "SOLE_PROPRIETOR", "PARTNERSHIP", "TRUST_OR_ESTATE", "NONPROFIT", "C_CORP", "S_CORP", "OTHER" ] } }, "description" : "" @@ -5752,7 +6217,7 @@ "title" : "", "type" : "string", "description" : "Timezone specifications", - "enum" : [ "MOROCCOSTANDARDTIME", "UTC", "GMTSTANDARDTIME", "GREENWICHSTANDARDTIME", "WEUROPESTANDARDTIME", "CENTRALEUROPESTANDARDTIME", "ROMANCESTANDARDTIME", "CENTRALEUROPEANSTANDARDTIME", "WCENTRALAFRICASTANDARDTIME", "NAMIBIASTANDARDTIME", "JORDANSTANDARDTIME", "GTBSTANDARDTIME", "MIDDLEEASTSTANDARDTIME", "EGYPTSTANDARDTIME", "SYRIASTANDARDTIME", "EEUROPESTANDARDTIME", "SOUTHAFRICASTANDARDTIME", "FLESTANDARDTIME", "TURKEYSTANDARDTIME", "ISRAELSTANDARDTIME", "KALININGRADSTANDARDTIME", "LIBYASTANDARDTIME", "ARABICSTANDARDTIME", "ARABSTANDARDTIME", "BELARUSSTANDARDTIME", "RUSSIANSTANDARDTIME", "EAFRICASTANDARDTIME", "IRANSTANDARDTIME", "ARABIANSTANDARDTIME", "AZERBAIJANSTANDARDTIME", "RUSSIATIMEZONE3", "MAURITIUSSTANDARDTIME", "GEORGIANSTANDARDTIME", "CAUCASUSSTANDARDTIME", "AFGHANISTANSTANDARDTIME", "WESTASIASTANDARDTIME", "EKATERINBURGSTANDARDTIME", "PAKISTANSTANDARDTIME", "INDIASTANDARDTIME", "SRILANKASTANDARDTIME", "NEPALSTANDARDTIME", "CENTRALASIASTANDARDTIME", "BANGLADESHSTANDARDTIME", "NCENTRALASIASTANDARDTIME", "MYANMARSTANDARDTIME", "SEASIASTANDARDTIME", "NORTHASIASTANDARDTIME", "CHINASTANDARDTIME", "NORTHASIAEASTSTANDARDTIME", "SINGAPORESTANDARDTIME", "WAUSTRALIASTANDARDTIME", "TAIPEISTANDARDTIME", "ULAANBAATARSTANDARDTIME", "TOKYOSTANDARDTIME", "KOREASTANDARDTIME", "YAKUTSKSTANDARDTIME", "CENAUSTRALIASTANDARDTIME", "AUSCENTRALSTANDARDTIME", "EAUSTRALIASTANDARDTIME", "AUSEASTERNSTANDARDTIME", "WESTPACIFICSTANDARDTIME", "TASMANIASTANDARDTIME", "MAGADANSTANDARDTIME", "VLADIVOSTOKSTANDARDTIME", "RUSSIATIMEZONE10", "CENTRALPACIFICSTANDARDTIME", "RUSSIATIMEZONE11", "NEWZEALANDSTANDARDTIME", "UTC+12", "UTC+13", "FIJISTANDARDTIME", "KAMCHATKASTANDARDTIME", "TONGASTANDARDTIME", "SAMOASTANDARDTIME", "LINEISLANDSSTANDARDTIME", "AZORESSTANDARDTIME", "CAPEVERDESTANDARDTIME", "UTC02", "MIDATLANTICSTANDARDTIME", "ESOUTHAMERICASTANDARDTIME", "ARGENTINASTANDARDTIME", "SAEASTERNSTANDARDTIME", "GREENLANDSTANDARDTIME", "MONTEVIDEOSTANDARDTIME", "BAHIASTANDARDTIME", "NEWFOUNDLANDSTANDARDTIME", "PARAGUAYSTANDARDTIME", "ATLANTICSTANDARDTIME", "CENTRALBRAZILIANSTANDARDTIME", "SAWESTERNSTANDARDTIME", "PACIFICSASTANDARDTIME", "VENEZUELASTANDARDTIME", "SAPACIFICSTANDARDTIME", "EASTERNSTANDARDTIME", "USEASTERNSTANDARDTIME", "CENTRALAMERICASTANDARDTIME", "CENTRALSTANDARDTIME", "CENTRALSTANDARDTIME(MEXICO)", "CANADACENTRALSTANDARDTIME", "USMOUNTAINSTANDARDTIME", "MOUNTAINSTANDARDTIME(MEXICO)", "MOUNTAINSTANDARDTIME", "PACIFICSTANDARDTIME(MEXICO)", "PACIFICSTANDARDTIME", "ALASKANSTANDARDTIME", "HAWAIIANSTANDARDTIME", "UTC11", "DATELINESTANDARDTIME", "EASTERISLANDSTANDARDTIME" ] + "enum" : [ "AFGHANISTANSTANDARDTIME", "ALASKANSTANDARDTIME", "ALEUTIANSTANDARDTIME", "ALTAISTANDARDTIME", "ARABIANSTANDARDTIME", "ARABICSTANDARDTIME", "ARABSTANDARDTIME", "ARGENTINASTANDARDTIME", "ASTRAKHANSTANDARDTIME", "ATLANTICSTANDARDTIME", "AUSCENTRALSTANDARDTIME", "AUSCENTRALWSTANDARDTIME", "AUSEASTERNSTANDARDTIME", "AZERBAIJANSTANDARDTIME", "AZORESSTANDARDTIME", "BAHIASTANDARDTIME", "BANGLADESHSTANDARDTIME", "BELARUSSTANDARDTIME", "BOUGAINVILLESTANDARDTIME", "CANADACENTRALSTANDARDTIME", "CAPEVERDESTANDARDTIME", "CAUCASUSSTANDARDTIME", "CENAUSTRALIASTANDARDTIME", "CENTRALAMERICASTANDARDTIME", "CENTRALASIASTANDARDTIME", "CENTRALBRAZILIANSTANDARDTIME", "CENTRALEUROPEANSTANDARDTIME", "CENTRALEUROPESTANDARDTIME", "CENTRALPACIFICSTANDARDTIME", "CENTRALSTANDARDTIME", "CENTRALSTANDARDTIME(MEXICO)", "CHATHAMISLANDSSTANDARDTIME", "CHINASTANDARDTIME", "CUBASTANDARDTIME", "DATELINESTANDARDTIME", "EAFRICASTANDARDTIME", "EASTERISLANDSTANDARDTIME", "EASTERNSTANDARDTIME", "EASTERNSTANDARDTIME(MEXICO)", "EAUSTRALIASTANDARDTIME", "EEUROPESTANDARDTIME", "EGYPTSTANDARDTIME", "EKATERINBURGSTANDARDTIME", "ESOUTHAMERICASTANDARDTIME", "FIJISTANDARDTIME", "FLESTANDARDTIME", "GEORGIANSTANDARDTIME", "GMTSTANDARDTIME", "GREENLANDSTANDARDTIME", "GREENWICHSTANDARDTIME", "GTBSTANDARDTIME", "HAITISTANDARDTIME", "HAWAIIANSTANDARDTIME", "INDIASTANDARDTIME", "IRANSTANDARDTIME", "ISRAELSTANDARDTIME", "JORDANSTANDARDTIME", "KALININGRADSTANDARDTIME", "KAMCHATKASTANDARDTIME", "KOREASTANDARDTIME", "LIBYASTANDARDTIME", "LINEISLANDSSTANDARDTIME", "LORDHOWESTANDARDTIME", "MAGADANSTANDARDTIME", "MAGALLANESSTANDARDTIME", "MARQUESASSTANDARDTIME", "MAURITIUSSTANDARDTIME", "MIDATLANTICSTANDARDTIME", "MIDDLEEASTSTANDARDTIME", "MONTEVIDEOSTANDARDTIME", "MOROCCOSTANDARDTIME", "MOUNTAINSTANDARDTIME", "MOUNTAINSTANDARDTIME(MEXICO)", "MYANMARSTANDARDTIME", "NAMIBIASTANDARDTIME", "NCENTRALASIASTANDARDTIME", "NEPALSTANDARDTIME", "NEWFOUNDLANDSTANDARDTIME", "NEWZEALANDSTANDARDTIME", "NORFOLKSTANDARDTIME", "NORTHASIAEASTSTANDARDTIME", "NORTHASIASTANDARDTIME", "NORTHKOREASTANDARDTIME", "OMSKSTANDARDTIME", "PACIFICSASTANDARDTIME", "PACIFICSTANDARDTIME", "PACIFICSTANDARDTIME(MEXICO)", "PAKISTANSTANDARDTIME", "PARAGUAYSTANDARDTIME", "QYZYLORDASTANDARDTIME", "ROMANCESTANDARDTIME", "RUSSIANSTANDARDTIME", "RUSSIATIMEZONE10", "RUSSIATIMEZONE11", "RUSSIATIMEZONE3", "SAEASTERNSTANDARDTIME", "SAINTPIERRESTANDARDTIME", "SAKHALINSTANDARDTIME", "SAMOASTANDARDTIME", "SAOTOMESTANDARDTIME", "SAPACIFICSTANDARDTIME", "SARATOVSTANDARDTIME", "SAWESTERNSTANDARDTIME", "SEASIASTANDARDTIME", "SINGAPORESTANDARDTIME", "SOUTHAFRICASTANDARDTIME", "SOUTHSUDANSTANDARDTIME", "SRILANKASTANDARDTIME", "SUDANSTANDARDTIME", "SYRIASTANDARDTIME", "TAIPEISTANDARDTIME", "TASMANIASTANDARDTIME", "TOCANTINSSTANDARDTIME", "TOKYOSTANDARDTIME", "TOMSKSTANDARDTIME", "TONGASTANDARDTIME", "TRANSBAIKALSTANDARDTIME", "TURKEYSTANDARDTIME", "TURKSANDCAICOSSTANDARDTIME", "ULAANBAATARSTANDARDTIME", "USEASTERNSTANDARDTIME", "USMOUNTAINSTANDARDTIME", "UTC", "UTC+12", "UTC+13", "UTC02", "UTC08", "UTC09", "UTC11", "VENEZUELASTANDARDTIME", "VLADIVOSTOKSTANDARDTIME", "VOLGOGRADSTANDARDTIME", "WAUSTRALIASTANDARDTIME", "WCENTRALAFRICASTANDARDTIME", "WESTASIASTANDARDTIME", "WESTBANKSTANDARDTIME", "WESTPACIFICSTANDARDTIME", "WEUROPESTANDARDTIME", "WMONGOLIASTANDARDTIME", "YAKUTSKSTANDARDTIME", "YUKONSTANDARDTIME" ] }; defs["TrackingCategories"] = { "title" : "", @@ -5766,7 +6231,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "tracking_categories" }; defs["TrackingCategory"] = { "title" : "", @@ -5852,7 +6317,39 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "options" +}; + defs["TrackingReference"] = { + "title" : "", + "required" : [ "TrackingCategoryID", "TrackingOptionID" ], + "type" : "object", + "properties" : { + "TrackingCategoryID" : { + "type" : "string", + "description" : "The Xero identifier for a tracking category", + "format" : "uuid" + }, + "TrackingOptionID" : { + "type" : "string", + "description" : "The Xero identifier for a tracking category option", + "format" : "uuid" + }, + "Name" : { + "maxLength" : 100, + "type" : "string", + "description" : "The name of the tracking category", + "readOnly" : true + }, + "Option" : { + "type" : "string", + "description" : "See Tracking Options", + "readOnly" : true + } + }, + "description" : "", + "externalDocs" : { + "url" : "http://developer.xero.com/documentation/api/tracking-categories/" + } }; defs["User"] = { "title" : "", @@ -5889,7 +6386,7 @@ "OrganisationRole" : { "type" : "string", "description" : "User role that defines permissions in Xero and via API (READONLY, INVOICEONLY, STANDARD, FINANCIALADVISER, etc)", - "enum" : [ "READONLY", "INVOICEONLY", "STANDARD", "FINANCIALADVISER", "MANAGEDCLIENT", "CASHBOOKCLIENT", "UNKNOWN" ] + "enum" : [ "READONLY", "INVOICEONLY", "STANDARD", "FINANCIALADVISER", "MANAGEDCLIENT", "CASHBOOKCLIENT", "UNKNOWN", "REMOVED" ] } }, "description" : "", @@ -5909,7 +6406,7 @@ } }, "description" : "", - "x-isObjectArray" : true + "x-objectArrayKey" : "users" }; defs["ValidationError"] = { "title" : "", @@ -5959,6 +6456,15 @@ + + + + + + + + +
@@ -6000,7 +6506,7 @@
+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -6821,7 +7375,12 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/Account" }, - "example" : "{ \"Code\":\"123456\", \"Name\":\"Foobar\", \"Type\":\"EXPENSE\", \"Description\":\"Hello World\" }" + "example" : { + "Code" : "123456", + "Name" : "Foobar", + "Type" : "EXPENSE", + "Description" : "Hello World" + } } }, "required" : true @@ -6872,13 +7431,14 @@

Usage and SDK Samples

xero_tenant_id = 'YOUR_XERO_TENANT_ID' account_id = '00000000-0000-0000-0000-000000000000' file_name = 'xero-dev.jpg' + idempotency_key = 'KEY_VALUE' path_to_upload = Path(__file__).resolve().parent.joinpath(fileName) open_file = open(path_to_upload, 'rb') body = open_file.read() try: - api_response = api_instance.create_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body) + api_response = api_instance.create_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createAccountAttachmentByFileName: %s\n" % e) @@ -6977,6 +7537,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -7061,13 +7641,14 @@

Usage and SDK Samples

xero_tenant_id = 'YOUR_XERO_TENANT_ID' bank_transaction_id = '00000000-0000-0000-0000-000000000000' file_name = 'xero-dev.jpg' + idempotency_key = 'KEY_VALUE' path_to_upload = Path(__file__).resolve().parent.joinpath(fileName) open_file = open(path_to_upload, 'rb') body = open_file.read() try: - api_response = api_instance.create_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body) + api_response = api_instance.create_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createBankTransactionAttachmentByFileName: %s\n" % e) @@ -7166,6 +7747,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -7249,6 +7850,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' bank_transaction_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' history_record = HistoryRecord( details = "Hello World") @@ -7257,7 +7859,7 @@

Usage and SDK Samples

history_records = [history_record]) try: - api_response = api_instance.create_bank_transaction_history_record(xero_tenant_id, bank_transaction_id, historyRecords) + api_response = api_instance.create_bank_transaction_history_record(xero_tenant_id, bank_transaction_id, historyRecords, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createBankTransactionHistoryRecord: %s\n" % e) @@ -7333,6 +7935,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -7366,7 +7988,11 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/HistoryRecords" }, - "example" : "{ \"HistoryRecords\": [ { \"Details\": \"Hello World\" } ] }" + "example" : { + "HistoryRecords" : [ { + "Details" : "Hello World" + } ] + } } }, "required" : true @@ -7416,6 +8042,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' summarize_errors = 'True' + idempotency_key = 'KEY_VALUE' contact = Contact( contact_id = "00000000-0000-0000-0000-000000000000") @@ -7442,7 +8069,7 @@

Usage and SDK Samples

bank_transactions = [bank_transaction]) try: - api_response = api_instance.create_bank_transactions(xero_tenant_id, bankTransactions, summarize_errors, unitdp) + api_response = api_instance.create_bank_transactions(xero_tenant_id, bankTransactions, summarize_errors, unitdp, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createBankTransactions: %s\n" % e) @@ -7485,6 +8112,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -7518,7 +8165,23 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/BankTransactions" }, - "example" : "{ bankTransactions: [{ type: BankTransaction.TypeEnum.SPEND, contact: { contactID: \"00000000-0000-0000-0000-000000000000\" }, lineItems: [{ description: \"Foobar\", quantity: 1.0, unitAmount: 20.0, accountCode: \"000\" } ], bankAccount: { code: \"000\" }}]}" + "example" : { + "bankTransactions" : [ { + "type" : "BankTransaction.TypeEnum.SPEND", + "contact" : { + "contactID" : "00000000-0000-0000-0000-000000000000" + }, + "lineItems" : [ { + "description" : "Foobar", + "quantity" : 1.0, + "unitAmount" : 20.0, + "accountCode" : "000" + } ], + "bankAccount" : { + "code" : "000" + } + } ] + } } }, "required" : true @@ -7614,6 +8277,7 @@

Usage and SDK Samples

def accounting_create_bank_transfer(): api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' + idempotency_key = 'KEY_VALUE' fromBankAccount = Account( account_id = "00000000-0000-0000-0000-000000000000") @@ -7630,7 +8294,7 @@

Usage and SDK Samples

bank_transfers = [bank_transfer]) try: - api_response = api_instance.create_bank_transfer(xero_tenant_id, bankTransfers) + api_response = api_instance.create_bank_transfer(xero_tenant_id, bankTransfers, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createBankTransfer: %s\n" % e) @@ -7673,6 +8337,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -7706,7 +8390,58 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/BankTransfers" }, - "example" : "{ \"BankTransfers\": [ { \"FromBankAccount\": { \"Code\": \"090\", \"Name\": \"My Savings\", \"AccountID\": \"00000000-0000-0000-0000-000000000000\", \"Type\": \"BANK\", \"BankAccountNumber\": \"123455\", \"Status\": \"ACTIVE\", \"BankAccountType\": \"BANK\", \"CurrencyCode\": \"USD\", \"TaxType\": \"NONE\", \"EnablePaymentsToAccount\": false, \"ShowInExpenseClaims\": false, \"Class\": \"ASSET\", \"ReportingCode\": \"ASS\", \"ReportingCodeName\": \"Assets\", \"HasAttachments\": false, \"UpdatedDateUTC\": \"2016-10-17T13:45:33.993-07:00\" }, \"ToBankAccount\": { \"Code\": \"088\", \"Name\": \"Business Wells Fargo\", \"AccountID\": \"00000000-0000-0000-0000-000000000000\", \"Type\": \"BANK\", \"BankAccountNumber\": \"123455\", \"Status\": \"ACTIVE\", \"BankAccountType\": \"BANK\", \"CurrencyCode\": \"USD\", \"TaxType\": \"NONE\", \"EnablePaymentsToAccount\": false, \"ShowInExpenseClaims\": false, \"Class\": \"ASSET\", \"ReportingCode\": \"ASS\", \"ReportingCodeName\": \"Assets\", \"HasAttachments\": false, \"UpdatedDateUTC\": \"2016-06-03T08:31:14.517-07:00\" }, \"Amount\": \"50.00\", \"FromIsReconciled\": true, \"ToIsReconciled\": true, \"Reference\": \"Sub 098801\" } ] }" + "example" : { + "BankTransfers" : [ { + "FromBankAccount" : { + "Code" : "090", + "Name" : "My Savings", + "AccountID" : "00000000-0000-0000-0000-000000000000", + "Type" : "BANK", + "BankAccountNumber" : "123455", + "Status" : "ACTIVE", + "BankAccountType" : "BANK", + "CurrencyCode" : "USD", + "TaxType" : "NONE", + "EnablePaymentsToAccount" : false, + "ShowInExpenseClaims" : false, + "Class" : "ASSET", + "ReportingCode" : "ASS", + "ReportingCodeName" : "Assets", + "HasAttachments" : false, + "UpdatedDateUTC" : "2016-10-17T13:45:33.993-07:00" + }, + "ToBankAccount" : { + "Code" : "088", + "Name" : "Business Wells Fargo", + "AccountID" : "00000000-0000-0000-0000-000000000000", + "Type" : "BANK", + "BankAccountNumber" : "123455", + "Status" : "ACTIVE", + "BankAccountType" : "BANK", + "CurrencyCode" : "USD", + "TaxType" : "NONE", + "EnablePaymentsToAccount" : false, + "ShowInExpenseClaims" : false, + "Class" : "ASSET", + "ReportingCode" : "ASS", + "ReportingCodeName" : "Assets", + "HasAttachments" : false, + "UpdatedDateUTC" : "2016-06-03T08:31:14.517-07:00" + }, + "Amount" : "50.00", + "FromIsReconciled" : true, + "ToIsReconciled" : true, + "Reference" : "Sub 098801", + "FromTracking" : [ { + "TrackingCategoryID" : "e2f2f732-e92a-4f3a-9c4d-ee4da0182a13", + "TrackingOptionID" : "cd0a4b7e-3c6b-4b3c-8e2a-1f2d3c4b5a69" + } ], + "ToTracking" : [ { + "TrackingCategoryID" : "e2f2f732-e92a-4f3a-9c4d-ee4da0182a13", + "TrackingOptionID" : "9f8e7d6c-5b4a-3c2d-1e0f-a9b8c7d6e5f4" + } ] + } ] + } } }, "required" : true @@ -7757,13 +8492,14 @@

Usage and SDK Samples

xero_tenant_id = 'YOUR_XERO_TENANT_ID' bank_transfer_id = '00000000-0000-0000-0000-000000000000' file_name = 'xero-dev.jpg' + idempotency_key = 'KEY_VALUE' path_to_upload = Path(__file__).resolve().parent.joinpath(fileName) open_file = open(path_to_upload, 'rb') body = open_file.read() try: - api_response = api_instance.create_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body) + api_response = api_instance.create_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createBankTransferAttachmentByFileName: %s\n" % e) @@ -7862,6 +8598,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -7945,6 +8701,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' bank_transfer_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' history_record = HistoryRecord( details = "Hello World") @@ -7953,7 +8710,7 @@

Usage and SDK Samples

history_records = [history_record]) try: - api_response = api_instance.create_bank_transfer_history_record(xero_tenant_id, bank_transfer_id, historyRecords) + api_response = api_instance.create_bank_transfer_history_record(xero_tenant_id, bank_transfer_id, historyRecords, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createBankTransferHistoryRecord: %s\n" % e) @@ -8029,6 +8786,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -8062,7 +8839,11 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/HistoryRecords" }, - "example" : "{ \"HistoryRecords\": [ { \"Details\": \"Hello World\" } ] }" + "example" : { + "HistoryRecords" : [ { + "Details" : "Hello World" + } ] + } } }, "required" : true @@ -8112,6 +8893,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' summarize_errors = 'True' + idempotency_key = 'KEY_VALUE' curr_date = dateutil.parser.parse('2020-12-03T00:00:00Z') payment_account = Account( @@ -8142,7 +8924,7 @@

Usage and SDK Samples

batch_payments = [batch_payment]) try: - api_response = api_instance.create_batch_payment(xero_tenant_id, batchPayments, summarize_errors) + api_response = api_instance.create_batch_payment(xero_tenant_id, batchPayments, summarize_errors, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createBatchPayment: %s\n" % e) @@ -8185,6 +8967,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -8218,7 +9020,28 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/BatchPayments" }, - "example" : "{ \"BatchPayments\": [ { \"Account\": { \"AccountID\": \"00000000-0000-0000-0000-000000000000\" }, \"Reference\": \"ref\", \"Date\": \"2018-08-01\", \"Payments\": [ { \"Account\": { \"Code\": \"001\" }, \"Date\": \"2019-12-31\", \"Amount\": 500, \"Invoice\": { \"InvoiceID\": \"00000000-0000-0000-0000-000000000000\", \"LineItems\": [], \"Contact\": {}, \"Type\": \"ACCPAY\" } } ] } ] }" + "example" : { + "BatchPayments" : [ { + "Account" : { + "AccountID" : "00000000-0000-0000-0000-000000000000" + }, + "Reference" : "ref", + "Date" : "2018-08-01", + "Payments" : [ { + "Account" : { + "Code" : "001" + }, + "Date" : "2019-12-31", + "Amount" : 500, + "Invoice" : { + "InvoiceID" : "00000000-0000-0000-0000-000000000000", + "LineItems" : [ ], + "Contact" : { }, + "Type" : "ACCPAY" + } + } ] + } ] + } } }, "required" : true @@ -8295,6 +9118,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' batch_payment_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' history_record = HistoryRecord( details = "Hello World") @@ -8303,7 +9127,7 @@

Usage and SDK Samples

history_records = [history_record]) try: - api_response = api_instance.create_batch_payment_history_record(xero_tenant_id, batch_payment_id, historyRecords) + api_response = api_instance.create_batch_payment_history_record(xero_tenant_id, batch_payment_id, historyRecords, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createBatchPaymentHistoryRecord: %s\n" % e) @@ -8379,6 +9203,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -8412,7 +9256,11 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/HistoryRecords" }, - "example" : "{ \"HistoryRecords\": [ { \"Details\": \"Hello World\" } ] }" + "example" : { + "HistoryRecords" : [ { + "Details" : "Hello World" + } ] + } } }, "required" : true @@ -8462,15 +9310,19 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' branding_theme_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' payment_service = PaymentService( payment_service_id = "00000000-0000-0000-0000-000000000000", payment_service_name = "ACME Payments", payment_service_url = "https://www.payupnow.com/", pay_now_text = "Pay Now") + + paymentServices = PaymentServices( + paymentServices = [paymentService]) try: - api_response = api_instance.create_branding_theme_payment_services(xero_tenant_id, branding_theme_id, paymentService) + api_response = api_instance.create_branding_theme_payment_services(xero_tenant_id, branding_theme_id, paymentServices, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createBrandingThemePaymentServices: %s\n" % e) @@ -8546,6 +9398,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -8556,15 +9428,15 @@

Parameters

Description - paymentService * + paymentServices *
- PaymentService + PaymentServices
- PaymentService object in body of request + PaymentServices array with PaymentService object in body of request
@@ -8573,13 +9445,21 @@

Parameters

- - -
-
-
-
-
-

createEmployees

-

Creates new employees used in Xero payrun

-
-
-
-

-

-

-
- 
/Employees
-

-

Usage and SDK Samples

-

- -
- -
- 
# configure api_client for use with xero-python sdk client
-api_client = ApiClient(
-    Configuration(
-        debug=false,
-        oauth2_token=OAuth2Token(
-            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
-        ),
-    ),
-    pool_threads=1,
-)
-
-api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
-
-def accounting_create_employees():
-    api_instance = AccountingApi(api_client)
-    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    summarize_errors = 'True'
-
-    employee = Employee(
-        first_name = "Nick",
-        last_name = "Fury")
-
-    employees = Employees( 
-        employees = [employee])
-    
-    try:
-        api_response = api_instance.create_employees(xero_tenant_id, employees, summarize_errors)
-        print(api_response)
-    except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->createEmployees: %s\n" % e)
-
-
-

Scopes

- - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
-

Parameters

-
Header parameters
- - - - - - + @@ -10430,15 +11485,15 @@

Parameters

- +
NameDescription
xero-tenant-id*
Idempotency-Key -
+
@@ -10411,12 +11469,9 @@

Parameters
-Xero identifier for Tenant +This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
-
- Required -
Description
employees *currency *
- Employees + Currency
- Employees with array of Employee object in body of request + Currency object in the body of request
@@ -10447,46 +11502,22 @@

Parameters

-
Query parameters
- - - - - - - - - -
NameDescription
summarizeErrors - - -
-
-
- - Boolean - - -
-If false return 200 OK and mix of successfully created objects and any with validation errors -
-
-
-
-
@@ -10530,6 +11561,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' expense_claim_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' history_record = HistoryRecord( details = "Hello World") @@ -10538,7 +11570,7 @@

Usage and SDK Samples

history_records = [history_record]) try: - api_response = api_instance.create_expense_claim_history(xero_tenant_id, expense_claim_id, historyRecords) + api_response = api_instance.create_expense_claim_history(xero_tenant_id, expense_claim_id, historyRecords, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createExpenseClaimHistory: %s\n" % e) @@ -10614,6 +11646,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -10647,7 +11699,11 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/HistoryRecords" }, - "example" : "{ \"HistoryRecords\": [ { \"Details\": \"Hello World\" } ] }" + "example" : { + "HistoryRecords" : [ { + "Details" : "Hello World" + } ] + } } }, "required" : true @@ -10696,6 +11752,7 @@

Usage and SDK Samples

def accounting_create_expense_claims(): api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' + idempotency_key = 'KEY_VALUE' curr_date = dateutil.parser.parse('2020-12-03T00:00:00Z') user = User( @@ -10717,7 +11774,7 @@

Usage and SDK Samples

expense_claims = [expense_claim]) try: - api_response = api_instance.create_expense_claims(xero_tenant_id, expenseClaims) + api_response = api_instance.create_expense_claims(xero_tenant_id, expenseClaims, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createExpenseClaims: %s\n" % e) @@ -10760,6 +11817,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -10793,7 +11870,18 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/ExpenseClaims" }, - "example" : "{ \"ExpenseClaims\": [ { \"Status\": \"SUBMITTED\", \"User\": { \"UserID\": \"d1164823-0ac1-41ad-987b-b4e30fe0b273\" }, \"Receipts\": [ { \"Lineitems\": [], \"ReceiptID\": \"dc1c7f6d-0a4c-402f-acac-551d62ce5816\" } ] } ] }" + "example" : { + "ExpenseClaims" : [ { + "Status" : "SUBMITTED", + "User" : { + "UserID" : "d1164823-0ac1-41ad-987b-b4e30fe0b273" + }, + "Receipts" : [ { + "Lineitems" : [ ], + "ReceiptID" : "dc1c7f6d-0a4c-402f-acac-551d62ce5816" + } ] + } ] + } } }, "required" : true @@ -10844,14 +11932,15 @@

Usage and SDK Samples

xero_tenant_id = 'YOUR_XERO_TENANT_ID' invoice_id = '00000000-0000-0000-0000-000000000000' file_name = 'xero-dev.jpg' - include_online = 'true' + include_online = 'True' + idempotency_key = 'KEY_VALUE' path_to_upload = Path(__file__).resolve().parent.joinpath(fileName) open_file = open(path_to_upload, 'rb') body = open_file.read() try: - api_response = api_instance.create_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body, include_online) + api_response = api_instance.create_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body, include_online, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createInvoiceAttachmentByFileName: %s\n" % e) @@ -10950,6 +12039,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -11060,6 +12169,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' invoice_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' history_record = HistoryRecord( details = "Hello World") @@ -11068,7 +12178,7 @@

Usage and SDK Samples

history_records = [history_record]) try: - api_response = api_instance.create_invoice_history(xero_tenant_id, invoice_id, historyRecords) + api_response = api_instance.create_invoice_history(xero_tenant_id, invoice_id, historyRecords, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createInvoiceHistory: %s\n" % e) @@ -11144,6 +12254,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -11177,7 +12307,11 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/HistoryRecords" }, - "example" : "{ \"HistoryRecords\": [ { \"Details\": \"Hello World\" } ] }" + "example" : { + "HistoryRecords" : [ { + "Details" : "Hello World" + } ] + } } }, "required" : true @@ -11227,6 +12361,8 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' summarize_errors = 'True' + idempotency_key = 'KEY_VALUE' + allow_backorders = 'true' date_value = dateutil.parser.parse('2020-10-10T00:00:00Z') due_date_value = dateutil.parser.parse('2020-10-28T00:00:00Z') @@ -11263,7 +12399,7 @@

Usage and SDK Samples

invoices = [invoice]) try: - api_response = api_instance.create_invoices(xero_tenant_id, invoices, summarize_errors, unitdp) + api_response = api_instance.create_invoices(xero_tenant_id, invoices, summarize_errors, unitdp, idempotency_key, allow_backorders) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createInvoices: %s\n" % e) @@ -11306,6 +12442,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -11339,7 +12495,26 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/Invoices" }, - "example" : "{ \"Invoices\": [ { \"Type\": \"ACCREC\", \"Contact\": { \"ContactID\": \"430fa14a-f945-44d3-9f97-5df5e28441b8\" }, \"LineItems\": [ { \"Description\": \"Acme Tires\", \"Quantity\": 2, \"UnitAmount\": 20, \"AccountCode\": \"200\", \"TaxType\": \"NONE\", \"LineAmount\": 40 } ], \"Date\": \"2019-03-11\", \"DueDate\": \"2018-12-10\", \"Reference\": \"Website Design\", \"Status\": \"AUTHORISED\" } ] }" + "example" : { + "Invoices" : [ { + "Type" : "ACCREC", + "Contact" : { + "ContactID" : "430fa14a-f945-44d3-9f97-5df5e28441b8" + }, + "LineItems" : [ { + "Description" : "Acme Tires", + "Quantity" : 2, + "UnitAmount" : 20, + "AccountCode" : "200", + "TaxType" : "NONE", + "LineAmount" : 40 + } ], + "Date" : "2019-03-11", + "DueDate" : "2018-12-10", + "Reference" : "Website Design", + "Status" : "AUTHORISED" + } ] + } } }, "required" : true @@ -11390,6 +12565,26 @@

Parameters

+ + + allowBackorders + + + +
+
+
+ + Boolean + + +
+Allows an invoice to be created even when one or more line items contain tracked inventory where the invoice quantity would cause the available quantity to go negative +
+
+
+
+ @@ -11436,6 +12631,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' item_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' history_record = HistoryRecord( details = "Hello World") @@ -11444,7 +12640,7 @@

Usage and SDK Samples

history_records = [history_record]) try: - api_response = api_instance.create_item_history(xero_tenant_id, item_id, historyRecords) + api_response = api_instance.create_item_history(xero_tenant_id, item_id, historyRecords, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createItemHistory: %s\n" % e) @@ -11520,6 +12716,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -11553,7 +12769,11 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/HistoryRecords" }, - "example" : "{ \"HistoryRecords\": [ { \"Details\": \"Hello World\" } ] }" + "example" : { + "HistoryRecords" : [ { + "Details" : "Hello World" + } ] + } } }, "required" : true @@ -11603,6 +12823,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' summarize_errors = 'True' + idempotency_key = 'KEY_VALUE' purchase_details = Purchase( cogs_account_code = "500") @@ -11618,7 +12839,7 @@

Usage and SDK Samples

items = [item]) try: - api_response = api_instance.create_items(xero_tenant_id, items, summarize_errors, unitdp) + api_response = api_instance.create_items(xero_tenant_id, items, summarize_errors, unitdp, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createItems: %s\n" % e) @@ -11661,6 +12882,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -11694,7 +12935,17 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/Items" }, - "example" : "{ \"Items\": [ { \"Code\": \"code123\", \"Name\": \"Item Name XYZ\", \"Description\": \"Foobar\", \"InventoryAssetAccountCode\": \"140\", \"PurchaseDetails\": { \"COGSAccountCode\": \"500\" } } ] }" + "example" : { + "Items" : [ { + "Code" : "code123", + "Name" : "Item Name XYZ", + "Description" : "Foobar", + "InventoryAssetAccountCode" : "140", + "PurchaseDetails" : { + "COGSAccountCode" : "500" + } + } ] + } } }, "required" : true @@ -11790,13 +13041,14 @@

Usage and SDK Samples

def accounting_create_linked_transaction(): api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' + idempotency_key = 'KEY_VALUE' linked_transaction = LinkedTransaction( source_transaction_id = "00000000-0000-0000-0000-000000000000", source_line_item_id = "00000000-0000-0000-0000-000000000000") try: - api_response = api_instance.create_linked_transaction(xero_tenant_id, linkedTransaction) + api_response = api_instance.create_linked_transaction(xero_tenant_id, linkedTransaction, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createLinkedTransaction: %s\n" % e) @@ -11839,6 +13091,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -11872,7 +13144,12 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/LinkedTransaction" }, - "example" : "{ \"LinkedTransactions\": [ { \"SourceTransactionID\": \"a848644a-f20f-4630-98c3-386bd7505631\", \"SourceLineItemID\": \"b0df260d-3cc8-4ced-9bd6-41924f624ed3\" } ] }" + "example" : { + "LinkedTransactions" : [ { + "SourceTransactionID" : "a848644a-f20f-4630-98c3-386bd7505631", + "SourceLineItemID" : "b0df260d-3cc8-4ced-9bd6-41924f624ed3" + } ] + } } }, "required" : true @@ -11923,13 +13200,14 @@

Usage and SDK Samples

xero_tenant_id = 'YOUR_XERO_TENANT_ID' manual_journal_id = '00000000-0000-0000-0000-000000000000' file_name = 'xero-dev.jpg' + idempotency_key = 'KEY_VALUE' path_to_upload = Path(__file__).resolve().parent.joinpath(fileName) open_file = open(path_to_upload, 'rb') body = open_file.read() try: - api_response = api_instance.create_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body) + api_response = api_instance.create_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createManualJournalAttachmentByFileName: %s\n" % e) @@ -12028,6 +13306,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -12111,6 +13409,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' manual_journal_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' history_record = HistoryRecord( details = "Hello World") @@ -12119,7 +13418,7 @@

Usage and SDK Samples

history_records = [history_record]) try: - api_response = api_instance.create_manual_journal_history_record(xero_tenant_id, manual_journal_id, historyRecords) + api_response = api_instance.create_manual_journal_history_record(xero_tenant_id, manual_journal_id, historyRecords, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createManualJournalHistoryRecord: %s\n" % e) @@ -12195,6 +13494,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -12228,7 +13547,11 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/HistoryRecords" }, - "example" : "{ \"HistoryRecords\": [ { \"Details\": \"Hello World\" } ] }" + "example" : { + "HistoryRecords" : [ { + "Details" : "Hello World" + } ] + } } }, "required" : true @@ -12278,18 +13601,19 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' summarize_errors = 'True' + idempotency_key = 'KEY_VALUE' date_value = dateutil.parser.parse('2020-12-03T00:00:00Z') manual_journal_lines = [] credit = ManualJournalLine( - line_amount = 100.0, + line_amount = -100.0, account_code = "400", description = "Hello there") manual_journal_lines.append(credit) debit = ManualJournalLine( - line_amount = -100.0, + line_amount = 100.0, account_code = "120", description = "Hello there") manual_journal_lines.append(debit) @@ -12303,7 +13627,7 @@

Usage and SDK Samples

manual_journals = [manual_journal]) try: - api_response = api_instance.create_manual_journals(xero_tenant_id, manualJournals, summarize_errors) + api_response = api_instance.create_manual_journals(xero_tenant_id, manualJournals, summarize_errors, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createManualJournals: %s\n" % e) @@ -12346,6 +13670,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -12379,7 +13723,25 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/ManualJournals" }, - "example" : "{ \"ManualJournals\": [ { \"Narration\": \"Journal Desc\", \"JournalLines\": [ { \"LineAmount\": 100, \"AccountCode\": \"400\", \"Description\": \"Money Movement\" }, { \"LineAmount\": -100, \"AccountCode\": \"400\", \"Description\": \"Prepayment of things\", \"Tracking\": [ { \"Name\": \"North\", \"Option\": \"Region\" } ] } ], \"Date\": \"2019-03-14\" } ] }" + "example" : { + "ManualJournals" : [ { + "Narration" : "Journal Desc", + "JournalLines" : [ { + "LineAmount" : 100, + "AccountCode" : "400", + "Description" : "Money Movement" + }, { + "LineAmount" : -100, + "AccountCode" : "400", + "Description" : "Prepayment of things", + "Tracking" : [ { + "Name" : "North", + "Option" : "Region" + } ] + } ], + "Date" : "2019-03-14" + } ] + } } }, "required" : true @@ -12457,6 +13819,7 @@

Usage and SDK Samples

xero_tenant_id = 'YOUR_XERO_TENANT_ID' overpayment_id = '00000000-0000-0000-0000-000000000000' summarize_errors = 'True' + idempotency_key = 'KEY_VALUE' curr_date = dateutil.parser.parse('2020-12-03T00:00:00Z') invoice = Invoice( @@ -12471,7 +13834,7 @@

Usage and SDK Samples

allocations = [allocation]) try: - api_response = api_instance.create_overpayment_allocations(xero_tenant_id, overpayment_id, allocations, summarize_errors) + api_response = api_instance.create_overpayment_allocations(xero_tenant_id, overpayment_id, allocations, summarize_errors, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createOverpaymentAllocations: %s\n" % e) @@ -12547,6 +13910,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -12580,7 +13963,18 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/Allocations" }, - "example" : "{ \"Allocations\": [ { \"Invoice\": { \"InvoiceID\": \"00000000-0000-0000-0000-000000000000\", \"LineItems\": [], \"Contact\": {}, \"Type\": \"ACCPAY\" }, \"Amount\": 10.00, \"Date\": \"2019-03-12\" } ] }" + "example" : { + "Allocations" : [ { + "Invoice" : { + "InvoiceID" : "00000000-0000-0000-0000-000000000000", + "LineItems" : [ ], + "Contact" : { }, + "Type" : "ACCPAY" + }, + "Amount" : 10.0, + "Date" : "2019-03-12" + } ] + } } }, "required" : true @@ -12657,6 +14051,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' overpayment_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' history_record = HistoryRecord( details = "Hello World") @@ -12665,7 +14060,7 @@

Usage and SDK Samples

history_records = [history_record]) try: - api_response = api_instance.create_overpayment_history(xero_tenant_id, overpayment_id, historyRecords) + api_response = api_instance.create_overpayment_history(xero_tenant_id, overpayment_id, historyRecords, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createOverpaymentHistory: %s\n" % e) @@ -12741,6 +14136,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -12774,7 +14189,11 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/HistoryRecords" }, - "example" : "{ \"HistoryRecords\": [ { \"Details\": \"Hello World\" } ] }" + "example" : { + "HistoryRecords" : [ { + "Details" : "Hello World" + } ] + } } }, "required" : true @@ -12823,6 +14242,7 @@

Usage and SDK Samples

def accounting_create_payment(): api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' + idempotency_key = 'KEY_VALUE' date_value = dateutil.parser.parse('2020-10-10T00:00:00Z') invoice = Invoice( @@ -12841,7 +14261,7 @@

Usage and SDK Samples

payments = [payment]) try: - api_response = api_instance.create_payment(xero_tenant_id, payment) + api_response = api_instance.create_payment(xero_tenant_id, payment, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createPayment: %s\n" % e) @@ -12884,6 +14304,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -12917,7 +14357,19 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/Payment" }, - "example" : "{ \"Payments\": [ { \"Invoice\": { \"LineItems\": [], \"InvoiceID\": \"00000000-0000-0000-0000-000000000000\" }, \"Account\": { \"Code\": \"970\" }, \"Date\": \"2019-03-12\", \"Amount\": 1 } ] }" + "example" : { + "Payments" : [ { + "Invoice" : { + "LineItems" : [ ], + "InvoiceID" : "00000000-0000-0000-0000-000000000000" + }, + "Account" : { + "Code" : "970" + }, + "Date" : "2019-03-12", + "Amount" : 1 + } ] + } } }, "required" : true @@ -12967,6 +14419,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' payment_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' history_record = HistoryRecord( details = "Hello World") @@ -12975,7 +14428,7 @@

Usage and SDK Samples

history_records = [history_record]) try: - api_response = api_instance.create_payment_history(xero_tenant_id, payment_id, historyRecords) + api_response = api_instance.create_payment_history(xero_tenant_id, payment_id, historyRecords, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createPaymentHistory: %s\n" % e) @@ -13051,6 +14504,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -13084,7 +14557,11 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/HistoryRecords" }, - "example" : "{ \"HistoryRecords\": [ { \"Details\": \"Hello World\" } ] }" + "example" : { + "HistoryRecords" : [ { + "Details" : "Hello World" + } ] + } } }, "required" : true @@ -13133,6 +14610,7 @@

Usage and SDK Samples

def accounting_create_payment_service(): api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' + idempotency_key = 'KEY_VALUE' payment_service = PaymentService( payment_service_name = "ACME Payments", @@ -13143,7 +14621,7 @@

Usage and SDK Samples

paymentServices = [paymentService]) try: - api_response = api_instance.create_payment_service(xero_tenant_id, paymentServices) + api_response = api_instance.create_payment_service(xero_tenant_id, paymentServices, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createPaymentService: %s\n" % e) @@ -13186,6 +14664,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -13219,7 +14717,13 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/PaymentServices" }, - "example" : "{ \"PaymentServices\": [ { \"PaymentServiceName\": \"PayUpNow\", \"PaymentServiceUrl\": \"https://www.payupnow.com/\", \"PayNowText\": \"Time To Pay\" } ] }" + "example" : { + "PaymentServices" : [ { + "PaymentServiceName" : "PayUpNow", + "PaymentServiceUrl" : "https://www.payupnow.com/", + "PayNowText" : "Time To Pay" + } ] + } } }, "required" : true @@ -13269,6 +14773,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' summarize_errors = 'True' + idempotency_key = 'KEY_VALUE' date_value = dateutil.parser.parse('2020-10-10T00:00:00Z') invoice = Invoice( @@ -13287,7 +14792,7 @@

Usage and SDK Samples

payments = [payment]) try: - api_response = api_instance.create_payments(xero_tenant_id, payments, summarize_errors) + api_response = api_instance.create_payments(xero_tenant_id, payments, summarize_errors, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createPayments: %s\n" % e) @@ -13330,6 +14835,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -13363,7 +14888,19 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/Payments" }, - "example" : "{ \"Payments\": [ { \"Invoice\": { \"LineItems\": [], \"InvoiceID\": \"00000000-0000-0000-0000-000000000000\" }, \"Account\": { \"Code\": \"970\" }, \"Date\": \"2019-03-12\", \"Amount\": 1 } ] }" + "example" : { + "Payments" : [ { + "Invoice" : { + "LineItems" : [ ], + "InvoiceID" : "00000000-0000-0000-0000-000000000000" + }, + "Account" : { + "Code" : "970" + }, + "Date" : "2019-03-12", + "Amount" : 1 + } ] + } } }, "required" : true @@ -13441,6 +14978,7 @@

Usage and SDK Samples

xero_tenant_id = 'YOUR_XERO_TENANT_ID' prepayment_id = '00000000-0000-0000-0000-000000000000' summarize_errors = 'True' + idempotency_key = 'KEY_VALUE' curr_date = dateutil.parser.parse('2020-12-03T00:00:00Z') invoice = Invoice( @@ -13455,7 +14993,7 @@

Usage and SDK Samples

allocations = [allocation]) try: - api_response = api_instance.create_prepayment_allocations(xero_tenant_id, prepayment_id, allocations, summarize_errors) + api_response = api_instance.create_prepayment_allocations(xero_tenant_id, prepayment_id, allocations, summarize_errors, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createPrepaymentAllocations: %s\n" % e) @@ -13531,6 +15069,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -13564,7 +15122,16 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/Allocations" }, - "example" : "{ \"Allocations\": [ { \"Invoice\": { \"LineItems\": [], \"InvoiceID\": \"00000000-0000-0000-0000-000000000000\" }, \"Amount\": 1, \"Date\": \"2019-01-10\" } ] }" + "example" : { + "Allocations" : [ { + "Invoice" : { + "LineItems" : [ ], + "InvoiceID" : "00000000-0000-0000-0000-000000000000" + }, + "Amount" : 1, + "Date" : "2019-01-10" + } ] + } } }, "required" : true @@ -13641,6 +15208,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' prepayment_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' history_record = HistoryRecord( details = "Hello World") @@ -13649,7 +15217,7 @@

Usage and SDK Samples

history_records = [history_record]) try: - api_response = api_instance.create_prepayment_history(xero_tenant_id, prepayment_id, historyRecords) + api_response = api_instance.create_prepayment_history(xero_tenant_id, prepayment_id, historyRecords, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createPrepaymentHistory: %s\n" % e) @@ -13725,6 +15293,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -13758,7 +15346,11 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/HistoryRecords" }, - "example" : "{ \"HistoryRecords\": [ { \"Details\": \"Hello World\" } ] }" + "example" : { + "HistoryRecords" : [ { + "Details" : "Hello World" + } ] + } } }, "required" : true @@ -13809,13 +15401,14 @@

Usage and SDK Samples

xero_tenant_id = 'YOUR_XERO_TENANT_ID' purchase_order_id = '00000000-0000-0000-0000-000000000000' file_name = 'xero-dev.jpg' + idempotency_key = 'KEY_VALUE' path_to_upload = Path(__file__).resolve().parent.joinpath(fileName) open_file = open(path_to_upload, 'rb') body = open_file.read() try: - api_response = api_instance.create_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body) + api_response = api_instance.create_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createPurchaseOrderAttachmentByFileName: %s\n" % e) @@ -13914,6 +15507,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -13997,6 +15610,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' purchase_order_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' history_record = HistoryRecord( details = "Hello World") @@ -14005,7 +15619,7 @@

Usage and SDK Samples

history_records = [history_record]) try: - api_response = api_instance.create_purchase_order_history(xero_tenant_id, purchase_order_id, historyRecords) + api_response = api_instance.create_purchase_order_history(xero_tenant_id, purchase_order_id, historyRecords, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createPurchaseOrderHistory: %s\n" % e) @@ -14081,6 +15695,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -14114,7 +15748,11 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/HistoryRecords" }, - "example" : "{ \"HistoryRecords\": [ { \"Details\": \"Hello World\" } ] }" + "example" : { + "HistoryRecords" : [ { + "Details" : "Hello World" + } ] + } } }, "required" : true @@ -14164,6 +15802,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' summarize_errors = 'True' + idempotency_key = 'KEY_VALUE' date_value = dateutil.parser.parse('2020-12-03T00:00:00Z') contact = Contact( @@ -14187,7 +15826,7 @@

Usage and SDK Samples

purchase_orders = [purchase_order]) try: - api_response = api_instance.create_purchase_orders(xero_tenant_id, purchaseOrders, summarize_errors) + api_response = api_instance.create_purchase_orders(xero_tenant_id, purchaseOrders, summarize_errors, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createPurchaseOrders: %s\n" % e) @@ -14230,6 +15869,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -14263,7 +15922,20 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/PurchaseOrders" }, - "example" : "{ \"PurchaseOrders\": [ { \"Contact\": { \"ContactID\": \"00000000-0000-0000-0000-000000000000\" }, \"LineItems\": [ { \"Description\": \"Foobar\", \"Quantity\": 1, \"UnitAmount\": 20, \"AccountCode\": \"710\" } ], \"Date\": \"2019-03-13\" } ] }" + "example" : { + "PurchaseOrders" : [ { + "Contact" : { + "ContactID" : "00000000-0000-0000-0000-000000000000" + }, + "LineItems" : [ { + "Description" : "Foobar", + "Quantity" : 1, + "UnitAmount" : 20, + "AccountCode" : "710" + } ], + "Date" : "2019-03-13" + } ] + } } }, "required" : true @@ -14341,13 +16013,14 @@

Usage and SDK Samples

xero_tenant_id = 'YOUR_XERO_TENANT_ID' quote_id = '00000000-0000-0000-0000-000000000000' file_name = 'xero-dev.jpg' + idempotency_key = 'KEY_VALUE' path_to_upload = Path(__file__).resolve().parent.joinpath(fileName) open_file = open(path_to_upload, 'rb') body = open_file.read() try: - api_response = api_instance.create_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body) + api_response = api_instance.create_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createQuoteAttachmentByFileName: %s\n" % e) @@ -14446,6 +16119,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -14529,6 +16222,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' quote_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' history_record = HistoryRecord( details = "Hello World") @@ -14537,7 +16231,7 @@

Usage and SDK Samples

history_records = [history_record]) try: - api_response = api_instance.create_quote_history(xero_tenant_id, quote_id, historyRecords) + api_response = api_instance.create_quote_history(xero_tenant_id, quote_id, historyRecords, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createQuoteHistory: %s\n" % e) @@ -14613,6 +16307,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -14646,7 +16360,11 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/HistoryRecords" }, - "example" : "{ \"HistoryRecords\": [ { \"Details\": \"Hello World\" } ] }" + "example" : { + "HistoryRecords" : [ { + "Details" : "Hello World" + } ] + } } }, "required" : true @@ -14696,6 +16414,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' summarize_errors = 'True' + idempotency_key = 'KEY_VALUE' date_value = dateutil.parser.parse('2020-12-03T00:00:00Z') contact = Contact( @@ -14719,7 +16438,7 @@

Usage and SDK Samples

quotes = [quote]) try: - api_response = api_instance.create_quotes(xero_tenant_id, quotes, summarize_errors) + api_response = api_instance.create_quotes(xero_tenant_id, quotes, summarize_errors, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createQuotes: %s\n" % e) @@ -14762,6 +16481,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -14795,7 +16534,20 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/Quotes" }, - "example" : "{ \"Quotes\": [ { \"Contact\": { \"ContactID\": \"00000000-0000-0000-0000-000000000000\" }, \"LineItems\": [ { \"Description\": \"Foobar\", \"Quantity\": 1, \"UnitAmount\": 20, \"AccountCode\": \"12775\" } ], \"Date\": \"2020-02-01\" } ] }" + "example" : { + "Quotes" : [ { + "Contact" : { + "ContactID" : "00000000-0000-0000-0000-000000000000" + }, + "LineItems" : [ { + "Description" : "Foobar", + "Quantity" : 1, + "UnitAmount" : 20, + "AccountCode" : "12775" + } ], + "Date" : "2020-02-01" + } ] + } } }, "required" : true @@ -14871,6 +16623,7 @@

Usage and SDK Samples

def accounting_create_receipt(): api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' + idempotency_key = 'KEY_VALUE' contact = Contact( contact_id = "00000000-0000-0000-0000-000000000000") @@ -14898,7 +16651,7 @@

Usage and SDK Samples

receipts = [receipt]) try: - api_response = api_instance.create_receipt(xero_tenant_id, receipts, unitdp) + api_response = api_instance.create_receipt(xero_tenant_id, receipts, unitdp, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createReceipt: %s\n" % e) @@ -14941,6 +16694,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -14974,7 +16747,26 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/Receipts" }, - "example" : "{ \"Receipts\": [ { \"Contact\": { \"ContactID\": \"00000000-0000-0000-0000-000000000000\" }, \"Lineitems\": [ { \"Description\": \"Foobar\", \"Quantity\": 2, \"UnitAmount\": 20, \"AccountCode\": \"400\", \"TaxType\": \"NONE\", \"LineAmount\": 40 } ], \"User\": { \"UserID\": \"00000000-0000-0000-0000-000000000000\" }, \"LineAmountTypes\": \"NoTax\", \"Status\": \"DRAFT\" } ] }" + "example" : { + "Receipts" : [ { + "Contact" : { + "ContactID" : "00000000-0000-0000-0000-000000000000" + }, + "Lineitems" : [ { + "Description" : "Foobar", + "Quantity" : 2, + "UnitAmount" : 20, + "AccountCode" : "400", + "TaxType" : "NONE", + "LineAmount" : 40 + } ], + "User" : { + "UserID" : "00000000-0000-0000-0000-000000000000" + }, + "LineAmountTypes" : "NoTax", + "Status" : "DRAFT" + } ] + } } }, "required" : true @@ -15052,13 +16844,14 @@

Usage and SDK Samples

xero_tenant_id = 'YOUR_XERO_TENANT_ID' receipt_id = '00000000-0000-0000-0000-000000000000' file_name = 'xero-dev.jpg' + idempotency_key = 'KEY_VALUE' path_to_upload = Path(__file__).resolve().parent.joinpath(fileName) open_file = open(path_to_upload, 'rb') body = open_file.read() try: - api_response = api_instance.create_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body) + api_response = api_instance.create_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createReceiptAttachmentByFileName: %s\n" % e) @@ -15157,6 +16950,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -15240,6 +17053,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' receipt_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' history_record = HistoryRecord( details = "Hello World") @@ -15248,7 +17062,7 @@

Usage and SDK Samples

history_records = [history_record]) try: - api_response = api_instance.create_receipt_history(xero_tenant_id, receipt_id, historyRecords) + api_response = api_instance.create_receipt_history(xero_tenant_id, receipt_id, historyRecords, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createReceiptHistory: %s\n" % e) @@ -15324,6 +17138,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -15357,7 +17191,11 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/HistoryRecords" }, - "example" : "{ \"HistoryRecords\": [ { \"Details\": \"Hello World\" } ] }" + "example" : { + "HistoryRecords" : [ { + "Details" : "Hello World" + } ] + } } }, "required" : true @@ -15408,13 +17246,14 @@

Usage and SDK Samples

xero_tenant_id = 'YOUR_XERO_TENANT_ID' repeating_invoice_id = '00000000-0000-0000-0000-000000000000' file_name = 'xero-dev.jpg' + idempotency_key = 'KEY_VALUE' path_to_upload = Path(__file__).resolve().parent.joinpath(fileName) open_file = open(path_to_upload, 'rb') body = open_file.read() try: - api_response = api_instance.create_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body) + api_response = api_instance.create_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createRepeatingInvoiceAttachmentByFileName: %s\n" % e) @@ -15513,6 +17352,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -15596,6 +17455,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' repeating_invoice_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' history_record = HistoryRecord( details = "Hello World") @@ -15604,7 +17464,7 @@

Usage and SDK Samples

history_records = [history_record]) try: - api_response = api_instance.create_repeating_invoice_history(xero_tenant_id, repeating_invoice_id, historyRecords) + api_response = api_instance.create_repeating_invoice_history(xero_tenant_id, repeating_invoice_id, historyRecords, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->createRepeatingInvoiceHistory: %s\n" % e) @@ -15680,6 +17540,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -15713,7 +17593,11 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/HistoryRecords" }, - "example" : "{ \"HistoryRecords\": [ { \"Details\": \"Hello World\" } ] }" + "example" : { + "HistoryRecords" : [ { + "Details" : "Hello World" + } ] + } } }, "required" : true @@ -15723,11 +17607,11 @@

Parameters

-
-
+
+
-

createTaxRates

-

Creates one or more tax rates

+

createRepeatingInvoices

+

Creates one or more repeating invoice templates

@@ -15735,17 +17619,17 @@

createTaxRates


- 
/TaxRates
+ 
/RepeatingInvoices

Usage and SDK Samples

-
+ 
# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -15759,37 +17643,25 @@ 
Usage and SDK Samples

 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_create_tax_rates():
+def accounting_create_repeating_invoices():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-
-    tax_component = TaxComponent(
-        name = "State Tax",
-        rate = 2.25)
-    
-    taxComponent = []    
-    tax_components.append(tax_component)
-
-    tax_rate = TaxRate(
-        name = "CA State Tax",
-        taxComponents = taxComponents,
-
-    taxRates = TaxRates( 
-        tax_rates = [tax_rate])
+    summarize_errors = 'True'
+    idempotency_key = 'KEY_VALUE'
     
     try:
-        api_response = api_instance.create_tax_rates(xero_tenant_id, taxRates)
+        api_response = api_instance.create_repeating_invoices(xero_tenant_id, repeatingInvoices, summarize_errors, idempotency_key)
         print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->createTaxRates: %s\n" % e)
+ print("Exception when calling AccountingApi->createRepeatingInvoices: %s\n" % e)

Scopes

- - + +
accounting.settingsGrant read-write access to organisation and account settingsaccounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
@@ -15804,7 +17676,7 @@

Parameters

-
+
@@ -15821,6 +17693,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -15831,15 +17723,15 @@

Parameters

Description - taxRates * + repeatingInvoices *
- TaxRates + RepeatingInvoices
- TaxRates array with TaxRate object in body of request + RepeatingInvoices with an array of repeating invoice objects in body of request
@@ -15848,27 +17740,89 @@

Parameters

+
Query parameters
+ + + + + + + + + +
NameDescription
summarizeErrors + + +
+
+
+ + Boolean + + +
+If false return 200 OK and mix of successfully created objects and any with validation errors +
+
+
+
+
-
-
+
+
-

createTrackingCategory

-

Create tracking categories

+

createTaxRates

+

Creates one or more tax rates

@@ -15876,17 +17830,17 @@

createTrackingCategory


- 
/TrackingCategories
+ 
/TaxRates

Usage and SDK Samples

-
+ 
# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -15900,18 +17854,30 @@ 
Usage and SDK Samples

 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_create_tracking_category():
+def accounting_create_tax_rates():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    idempotency_key = 'KEY_VALUE'
 
-    trackingCategory = TrackingCategory(
-        name = "Foobar")
+    tax_component = TaxComponent(
+        name = "State Tax",
+        rate = 2.25)
+    
+    taxComponent = []    
+    tax_components.append(tax_component)
+
+    tax_rate = TaxRate(
+        name = "CA State Tax",
+        taxComponents = taxComponents,
+
+    taxRates = TaxRates( 
+        tax_rates = [tax_rate])
     
     try:
-        api_response = api_instance.create_tracking_category(xero_tenant_id, trackingCategory)
+        api_response = api_instance.create_tax_rates(xero_tenant_id, taxRates, idempotency_key)
         print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->createTrackingCategory: %s\n" % e)
+ print("Exception when calling AccountingApi->createTaxRates: %s\n" % e)

Scopes

@@ -15934,7 +17900,7 @@

Parameters

-
+
@@ -15951,6 +17917,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -15961,15 +17947,15 @@

Parameters

Description - trackingCategory * + taxRates *
- TrackingCategory + TaxRates
- TrackingCategory object in body of request + TaxRates array with TaxRate object in body of request
@@ -15978,13 +17964,21 @@

Parameters

-
-
+
+
-

deleteContactGroupContact

-

Deletes a specific contact from a contact group using a unique contact Id

+

deleteAccount

+

Deletes a chart of accounts

@@ -16294,17 +18340,17 @@

deleteContactGroupContact


- 
/ContactGroups/{ContactGroupID}/Contacts/{ContactID}
+ 
/Accounts/{AccountID}

Usage and SDK Samples

-
+ 
# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -16318,24 +18364,24 @@ 
Usage and SDK Samples

 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_delete_contact_group_contact():
+def accounting_delete_account():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    contact_group_id = '00000000-0000-0000-0000-000000000000'
-    contact_id = '00000000-0000-0000-0000-000000000000'
+    account_id = '00000000-0000-0000-0000-000000000000'
     
     try:
-        api_instance.delete_contact_group_contact(xero_tenant_id, contact_group_id, contact_id)
+        api_response = api_instance.delete_account(xero_tenant_id, account_id)
+        print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->deleteContactGroupContact: %s\n" % e)
+ print("Exception when calling AccountingApi->deleteAccount: %s\n" % e)

Scopes

- - + +
accounting.contactsGrant read-write access to contacts and contact groupsaccounting.settingsGrant read-write access to organisation and account settings
@@ -16346,37 +18392,11 @@

Parameters

Name Description - ContactGroupID* - - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Contact Group -
-
-
- Required -
-
-
- - - - ContactID* + AccountID* -
+
@@ -16387,7 +18407,7 @@

Parameters
-Unique identifier for a Contact +Unique identifier for Account object
@@ -16409,7 +18429,7 @@

Parameters

-
+
@@ -16432,11 +18452,11 @@

Parameters

-
-
+
+
-

deleteContactGroupContacts

-

Deletes all contacts from a specific contact group

+

deleteBankTransfer

+

Deletes a specific bank transfer

@@ -16444,17 +18464,17 @@

deleteContactGroupContacts


- 
/ContactGroups/{ContactGroupID}/Contacts
+ 
/BankTransfers/{BankTransferID}

Usage and SDK Samples

-
+ 
# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -16468,23 +18488,28 @@ 
Usage and SDK Samples

 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_delete_contact_group_contacts():
+def accounting_delete_bank_transfer():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    contact_group_id = '00000000-0000-0000-0000-000000000000'
+    bank_transfer_id = '00000000-0000-0000-0000-000000000000'
+    idempotency_key = 'KEY_VALUE'
+
+    bankTransferDeleteByUrlParam = BankTransferDeleteByUrlParam(
+        status = "DELETED")
     
     try:
-        api_instance.delete_contact_group_contacts(xero_tenant_id, contact_group_id)
+        api_response = api_instance.delete_bank_transfer(xero_tenant_id, bank_transfer_id, bankTransferDeleteByUrlParam, idempotency_key)
+        print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->deleteContactGroupContacts: %s\n" % e)
+ print("Exception when calling AccountingApi->deleteBankTransfer: %s\n" % e)

Scopes

- - + +
accounting.contactsGrant read-write access to contacts and contact groupsaccounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
@@ -16495,11 +18520,11 @@

Parameters

Name Description - ContactGroupID* + BankTransferID* -
+
@@ -16510,7 +18535,7 @@

Parameters
-Unique identifier for a Contact Group +Xero generated unique identifier for a bank transfer
@@ -16532,7 +18557,7 @@

Parameters

-
+
@@ -16551,138 +18576,73 @@

Parameters

- -
-
-
-
-
-
-

deleteItem

-

Deletes a specific item

-
-
-
-

-

-

-
- 
/Items/{ItemID}
-

-

Usage and SDK Samples

-

- -
- -
- 
# configure api_client for use with xero-python sdk client
-api_client = ApiClient(
-    Configuration(
-        debug=false,
-        oauth2_token=OAuth2Token(
-            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
-        ),
-    ),
-    pool_threads=1,
-)
-
-api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
-
-def accounting_delete_item():
-    api_instance = AccountingApi(api_client)
-    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    item_id = '00000000-0000-0000-0000-000000000000'
-    
-    try:
-        api_instance.delete_item(xero_tenant_id, item_id)
-    except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->deleteItem: %s\n" % e)
-
-
-

Scopes

- - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
-

Parameters

-
Path parameters
- - - - - - +
NameDescription
ItemID*
Idempotency-Key -
+
- UUID + String - - (uuid) -
-Unique identifier for an Item +This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
-
- Required -
-
Header parameters
+
Body parameters
- - + + - - +
Name Description
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
+
bankTransferDeleteByUrlParam * +
+
+ + BankTransferDeleteByUrlParam + +
+
+
+
+ Required +
-
-
-
+
+
-

deleteLinkedTransaction

-

Deletes a specific linked transactions (billable expenses)

+

deleteBankTransfers

+

Deletes one or more bank transfers

@@ -16690,17 +18650,17 @@

deleteLinkedTransaction


- 
/LinkedTransactions/{LinkedTransactionID}
+ 
/BankTransfers

Usage and SDK Samples

-
+ 
# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -16714,15 +18674,24 @@ 
Usage and SDK Samples

 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_delete_linked_transaction():
+def accounting_delete_bank_transfers():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    linked_transaction_id = '00000000-0000-0000-0000-000000000000'
+    summarize_errors = 'True'
+    idempotency_key = 'KEY_VALUE'
+
+    bankTransferDelete = BankTransferDelete(
+        bank_transfer_id = "00000000-0000-0000-0000-000000000000",
+        status = "DELETED")
+
+    bankTransfers = BankTransfers( 
+        bank_transfers = [bank_transfer])
     
     try:
-        api_instance.delete_linked_transaction(xero_tenant_id, linked_transaction_id)
+        api_response = api_instance.delete_bank_transfers(xero_tenant_id, bankTransfersDelete, summarize_errors, idempotency_key)
+        print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->deleteLinkedTransaction: %s\n" % e)
+ print("Exception when calling AccountingApi->deleteBankTransfers: %s\n" % e)

Scopes

@@ -16735,28 +18704,25 @@

Scopes

Parameters

-
Path parameters
+
Header parameters
- + + + + +
Name Description
LinkedTransactionID*
xero-tenant-id* -
+
- UUID + String - - (uuid) -
-Unique identifier for a LinkedTransaction +Xero identifier for Tenant
@@ -16765,33 +18731,95 @@

Parameters

Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
-
Header parameters
+
Body parameters
- + + +
Name Description
xero-tenant-id*
bankTransfersDelete * +
+
+ + BankTransfersDelete + +
+ BankTransfers with array of BankTransfer objects in request body +
+
+
+ Required +
+
+ +
+
Query parameters
+ + + + + + @@ -16801,11 +18829,11 @@

Parameters

-
-
+
+
-

deletePayment

-

Updates a specific payment for invoices and credit notes

+

deleteBatchPayment

+

Updates a specific batch payment for invoices and credit notes

@@ -16813,17 +18841,17 @@

deletePayment


- 
/Payments/{PaymentID}
+ 
/BatchPayments

Usage and SDK Samples

-
+ 
# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -16837,19 +18865,20 @@ 
Usage and SDK Samples

 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_delete_payment():
+def accounting_delete_batch_payment():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    payment_id = '00000000-0000-0000-0000-000000000000'
+    idempotency_key = 'KEY_VALUE'
 
-    paymentDelete = PaymentDelete(
+    batchPaymentDelete = BatchPaymentDelete(
         status = "DELETED")
+        batch_payment_id = "00000000-0000-0000-0000-000000000000")
     
     try:
-        api_response = api_instance.delete_payment(xero_tenant_id, payment_id, paymentDelete)
+        api_response = api_instance.delete_batch_payment(xero_tenant_id, batchPaymentDelete, idempotency_key)
         print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->deletePayment: %s\n" % e)
+ print("Exception when calling AccountingApi->deleteBatchPayment: %s\n" % e)

Scopes

@@ -16862,28 +18891,25 @@

Scopes

NameDescription
summarizeErrors -
+
- String + Boolean
-Xero identifier for Tenant +If false return 200 OK and mix of successfully created objects and any with validation errors
-
- Required -

Parameters

-
Path parameters
+
Header parameters
- + -
Name Description
PaymentID*
xero-tenant-id* -
+
- UUID + String - - (uuid) -
-Unique identifier for a Payment +Xero identifier for Tenant
@@ -16894,18 +18920,11 @@

Parameters
-
Header parameters
- - - - - - + @@ -16932,12 +18948,12 @@

Parameters

- + - + + + + +
NameDescription
xero-tenant-id*
Idempotency-Key -
+
@@ -16913,12 +18932,9 @@

Parameters
-Xero identifier for Tenant +This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
-
- Required -
Description
paymentDelete *batchPaymentDelete *
- PaymentDelete + BatchPaymentDelete
@@ -16952,9 +18968,12 @@

Parameters

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/PaymentDelete" + "$ref" : "#/components/schemas/BatchPaymentDelete" }, - "example" : "{ \"Payments\":[ { \"Status\":\"DELETED\" } ] }" + "example" : { + "BatchPaymentID" : "9bf296e9-0748-4d29-a3dc-24dde1098030", + "Status" : "DELETED" + } } }, "required" : true @@ -16964,11 +18983,11 @@

Parameters

-
-
+
+
-

deleteTrackingCategory

-

Deletes a specific tracking category

+

deleteBatchPaymentByUrlParam

+

Updates a specific batch payment for invoices and credit notes

@@ -16976,17 +18995,17 @@

deleteTrackingCategory


- 
/TrackingCategories/{TrackingCategoryID}
+ 
/BatchPayments/{BatchPaymentID}

Usage and SDK Samples

-
+ 
# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -17000,24 +19019,25 @@ 
Usage and SDK Samples

 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_delete_tracking_category():
+def accounting_delete_batch_payment_by_url_param():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    tracking_category_id = '00000000-0000-0000-0000-000000000000'
+    batch_payment_id = '00000000-0000-0000-0000-000000000000'
+    idempotency_key = 'KEY_VALUE'
     
     try:
-        api_response = api_instance.delete_tracking_category(xero_tenant_id, tracking_category_id)
+        api_response = api_instance.delete_batch_payment_by_url_param(xero_tenant_id, batch_payment_id, batchPaymentDeleteByUrlParam, idempotency_key)
         print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->deleteTrackingCategory: %s\n" % e)
+ print("Exception when calling AccountingApi->deleteBatchPaymentByUrlParam: %s\n" % e)

Scopes

- - + +
accounting.settingsGrant read-write access to organisation and account settingsaccounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
@@ -17028,11 +19048,11 @@

Parameters

Name Description
TrackingCategoryID*
BatchPaymentID* -
+
@@ -17043,7 +19063,7 @@

Parameters
-Unique identifier for a TrackingCategory +Unique identifier for BatchPayment
@@ -17065,7 +19085,7 @@

Parameters

 -
+
@@ -17082,17 +19102,75 @@

Parameters

Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
batchPaymentDeleteByUrlParam * +
+
+ + BatchPaymentDeleteByUrlParam + +
+ +
+
+
+ Required +
+
+ +
-
-
+
+
-

deleteTrackingOptions

-

Deletes a specific option for a specific tracking category

+

deleteContactGroupContact

+

Deletes a specific contact from a contact group using a unique contact Id

@@ -17100,17 +19178,17 @@

deleteTrackingOptions


- 
/TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID}
+ 
/ContactGroups/{ContactGroupID}/Contacts/{ContactID}

Usage and SDK Samples

-
+ 
# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -17124,25 +19202,24 @@ 
Usage and SDK Samples

 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_delete_tracking_options():
+def accounting_delete_contact_group_contact():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    tracking_category_id = '00000000-0000-0000-0000-000000000000'
-    tracking_option_id = '00000000-0000-0000-0000-000000000000'
+    contact_group_id = '00000000-0000-0000-0000-000000000000'
+    contact_id = '00000000-0000-0000-0000-000000000000'
     
     try:
-        api_response = api_instance.delete_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id)
-        print(api_response)
+        api_instance.delete_contact_group_contact(xero_tenant_id, contact_group_id, contact_id)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->deleteTrackingOptions: %s\n" % e)
+ print("Exception when calling AccountingApi->deleteContactGroupContact: %s\n" % e)

Scopes

- - + +
accounting.settingsGrant read-write access to organisation and account settingsaccounting.contactsGrant read-write access to contacts and contact groups
@@ -17153,11 +19230,11 @@

Parameters

Name Description - TrackingCategoryID* + ContactGroupID* -
+
@@ -17168,7 +19245,7 @@

Parameters
-Unique identifier for a TrackingCategory +Unique identifier for a Contact Group
@@ -17179,11 +19256,11 @@

Parameters

- TrackingOptionID* + ContactID* -
+
@@ -17194,7 +19271,7 @@

Parameters
-Unique identifier for a Tracking Option +Unique identifier for a Contact
@@ -17216,7 +19293,7 @@

Parameters

-
+
@@ -17239,11 +19316,11 @@

Parameters

-
-
+
+
-

emailInvoice

-

Sends a copy of a specific invoice to related contact via email

+

deleteContactGroupContacts

+

Deletes all contacts from a specific contact group

@@ -17251,17 +19328,17 @@

emailInvoice


- 
/Invoices/{InvoiceID}/Email
+ 
/ContactGroups/{ContactGroupID}/Contacts

Usage and SDK Samples

-
+ 
# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -17275,25 +19352,23 @@ 
Usage and SDK Samples

 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_email_invoice():
+def accounting_delete_contact_group_contacts():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    invoice_id = '00000000-0000-0000-0000-000000000000'
-
-    requestEmpty = RequestEmpty()
+    contact_group_id = '00000000-0000-0000-0000-000000000000'
     
     try:
-        api_instance.email_invoice(xero_tenant_id, invoice_id, requestEmpty)
+        api_instance.delete_contact_group_contacts(xero_tenant_id, contact_group_id)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->emailInvoice: %s\n" % e)
+ print("Exception when calling AccountingApi->deleteContactGroupContacts: %s\n" % e)

Scopes

- - + +
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoicesaccounting.contactsGrant read-write access to contacts and contact groups
@@ -17304,11 +19379,11 @@

Parameters

Name Description - InvoiceID* + ContactGroupID* -
+
@@ -17319,7 +19394,7 @@

Parameters
-Unique identifier for an Invoice +Unique identifier for a Contact Group
@@ -17341,7 +19416,7 @@

Parameters

-
+
@@ -17361,50 +19436,14 @@

Parameters

-
Body parameters
- - - - - - - -
NameDescription
requestEmpty * -
-
- - RequestEmpty - -
- -
-
-
- Required -
-
- -
-
-
+
+
-

getAccount

-

Retrieves a single chart of accounts by using a unique account Id

+

deleteCreditNoteAllocations

+

Deletes an Allocation from a Credit Note

@@ -17412,17 +19451,17 @@

getAccount


- 
/Accounts/{AccountID}
+ 
/CreditNotes/{CreditNoteID}/Allocations/{AllocationID}

Usage and SDK Samples

-
+ 
# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -17436,29 +19475,25 @@ 
Usage and SDK Samples

 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_get_account():
+def accounting_delete_credit_note_allocations():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    account_id = '00000000-0000-0000-0000-000000000000'
+    credit_note_id = '00000000-0000-0000-0000-000000000000'
+    allocation_id = '00000000-0000-0000-0000-000000000000'
     
     try:
-        api_response = api_instance.get_account(xero_tenant_id, account_id)
+        api_response = api_instance.delete_credit_note_allocations(xero_tenant_id, credit_note_id, allocation_id)
         print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->getAccount: %s\n" % e)
+ print("Exception when calling AccountingApi->deleteCreditNoteAllocations: %s\n" % e)

Scopes

- - - - - - - + +
accounting.settingsGrant read-write access to organisation and account settings
accounting.settings.readGrant read-only access to organisation and account settingsaccounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
@@ -17469,11 +19504,11 @@

Parameters

Name Description - AccountID* + CreditNoteID* -
+
@@ -17484,7 +19519,33 @@

Parameters
-Unique identifier for Account object +Unique identifier for a Credit Note +
+
+
+ Required +
+
+
+ + + + AllocationID* + + + +
+
+
+ + UUID + + + (uuid) + + +
+Unique identifier for Allocation object
@@ -17506,7 +19567,7 @@

Parameters

-
+
@@ -17529,11 +19590,11 @@

Parameters

-
-
+
+
-

getAccountAttachmentByFileName

-

Retrieves an attachment for a specific account by filename

+

deleteItem

+

Deletes a specific item

@@ -17541,17 +19602,17 @@

getAccountAttachmentByFileName


- 
/Accounts/{AccountID}/Attachments/{FileName}
+ 
/Items/{ItemID}

Usage and SDK Samples

-
+ 
# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -17565,31 +19626,23 @@ 
Usage and SDK Samples

 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_get_account_attachment_by_file_name():
+def accounting_delete_item():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    account_id = '00000000-0000-0000-0000-000000000000'
-    file_name = 'xero-dev.jpg'
-    content_type = 'image/jpg'
+    item_id = '00000000-0000-0000-0000-000000000000'
     
     try:
-        api_response = api_instance.get_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, content_type)
-        print(api_response)
+        api_instance.delete_item(xero_tenant_id, item_id)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->getAccountAttachmentByFileName: %s\n" % e)
+ print("Exception when calling AccountingApi->deleteItem: %s\n" % e)

Scopes

- - - - - - - + +
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachmentsaccounting.settingsGrant read-write access to organisation and account settings
@@ -17600,11 +19653,11 @@

Parameters

Name Description - AccountID* + ItemID* -
+
@@ -17615,7 +19668,7 @@

Parameters
-Unique identifier for Account object +Unique identifier for an Item
@@ -17626,11 +19679,18 @@

Parameters

- FileName* + +
Header parameters
+ + + + + +
NameDescription
xero-tenant-id* -
+
@@ -17638,7 +19698,7 @@

Parameters
-Name of the attachment +Xero identifier for Tenant
@@ -17650,25 +19710,88 @@

Parameters

-
Header parameters
+
+
+
+
+
+
+

deleteLinkedTransaction

+

Deletes a specific linked transactions (billable expenses)

+
+
+
+

+

+

+
+ 
/LinkedTransactions/{LinkedTransactionID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_linked_transaction():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    linked_transaction_id = '00000000-0000-0000-0000-000000000000'
+    
+    try:
+        api_instance.delete_linked_transaction(xero_tenant_id, linked_transaction_id)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->deleteLinkedTransaction: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
+

Parameters

+
Path parameters
- + - +
Name Description
xero-tenant-id*
LinkedTransactionID* -
+
- String + UUID + + (uuid) +
-Xero identifier for Tenant +Unique identifier for a LinkedTransaction
@@ -17679,11 +19802,18 @@

Parameters
contentType*
+
Header parameters
+ + + + + + - + - + - - - -
NameDescription
xero-tenant-id* -
+
@@ -17691,7 +19821,7 @@

Parameters
-The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf +Xero identifier for Tenant
@@ -17706,11 +19836,11 @@

Parameters

-
-
+
+
-

getAccountAttachmentById

-

Retrieves a specific attachment from a specific account using a unique attachment Id

+

deleteOverpaymentAllocations

+

Deletes an Allocation from an overpayment

@@ -17718,17 +19848,17 @@

getAccountAttachmentById


- 
/Accounts/{AccountID}/Attachments/{AttachmentID}
+ 
/Overpayments/{OverpaymentID}/Allocations/{AllocationID}

Usage and SDK Samples

-
+ 
# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -17742,31 +19872,25 @@ 
Usage and SDK Samples

 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_get_account_attachment_by_id():
+def accounting_delete_overpayment_allocations():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    account_id = '00000000-0000-0000-0000-000000000000'
-    attachment_id = '00000000-0000-0000-0000-000000000000'
-    content_type = 'image/jpg'
+    overpayment_id = '00000000-0000-0000-0000-000000000000'
+    allocation_id = '00000000-0000-0000-0000-000000000000'
     
     try:
-        api_response = api_instance.get_account_attachment_by_id(xero_tenant_id, account_id, attachment_id, content_type)
+        api_response = api_instance.delete_overpayment_allocations(xero_tenant_id, overpayment_id, allocation_id)
         print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->getAccountAttachmentById: %s\n" % e)
+ print("Exception when calling AccountingApi->deleteOverpaymentAllocations: %s\n" % e)

Scopes

- - - - - - - + +
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachmentsaccounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
@@ -17777,11 +19901,11 @@

Parameters

Name Description
AccountID*
OverpaymentID* -
+
@@ -17792,7 +19916,7 @@

Parameters
-Unique identifier for Account object +Unique identifier for a Overpayment
@@ -17803,11 +19927,11 @@

Parameters
AttachmentID*
AllocationID* -
+
@@ -17818,7 +19942,7 @@

Parameters
-Unique identifier for Attachment object +Unique identifier for Allocation object
@@ -17840,7 +19964,7 @@

Parameters

 -
+
@@ -17857,40 +19981,17 @@

Parameters

contentType* - - -
-
-
- - String - - -
-The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf -
-
-
- Required -
-
-
-
-
-
+
+
-

getAccountAttachments

-

Retrieves attachments for a specific accounts by using a unique account Id

+

deletePayment

+

Updates a specific payment for invoices and credit notes

@@ -17898,17 +19999,17 @@

getAccountAttachments


- 
/Accounts/{AccountID}/Attachments
+ 
/Payments/{PaymentID}

Usage and SDK Samples

-
+ 
# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -17922,29 +20023,28 @@ 
Usage and SDK Samples

 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_get_account_attachments():
+def accounting_delete_payment():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    account_id = '00000000-0000-0000-0000-000000000000'
+    payment_id = '00000000-0000-0000-0000-000000000000'
+    idempotency_key = 'KEY_VALUE'
+
+    paymentDelete = PaymentDelete(
+        status = "DELETED")
     
     try:
-        api_response = api_instance.get_account_attachments(xero_tenant_id, account_id)
+        api_response = api_instance.delete_payment(xero_tenant_id, payment_id, paymentDelete, idempotency_key)
         print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->getAccountAttachments: %s\n" % e)
+ print("Exception when calling AccountingApi->deletePayment: %s\n" % e)

Scopes

- - - - - - - + +
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachmentsaccounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
@@ -17955,11 +20055,11 @@

Parameters

Name Description - AccountID* + PaymentID* -
+
@@ -17970,7 +20070,1290 @@

Parameters
-Unique identifier for Account object +Unique identifier for a Payment +
+
+
+ Required +
+
+
+ + + + +
Header parameters
+ + + + + + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
paymentDelete * +
+
+ + PaymentDelete + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

deletePrepaymentAllocations

+

Deletes an Allocation from a Prepayment

+
+
+
+

+

+

+
+ 
/Prepayments/{PrepaymentID}/Allocations/{AllocationID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_prepayment_allocations():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    prepayment_id = '00000000-0000-0000-0000-000000000000'
+    allocation_id = '00000000-0000-0000-0000-000000000000'
+    
+    try:
+        api_response = api_instance.delete_prepayment_allocations(xero_tenant_id, prepayment_id, allocation_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->deletePrepaymentAllocations: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
PrepaymentID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Unique identifier for a PrePayment +
+
+
+ Required +
+
+
+
AllocationID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Unique identifier for Allocation object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

deleteTrackingCategory

+

Deletes a specific tracking category

+
+
+
+

+

+

+
+ 
/TrackingCategories/{TrackingCategoryID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_tracking_category():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    tracking_category_id = '00000000-0000-0000-0000-000000000000'
+    
+    try:
+        api_response = api_instance.delete_tracking_category(xero_tenant_id, tracking_category_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->deleteTrackingCategory: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
accounting.settingsGrant read-write access to organisation and account settings
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
TrackingCategoryID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Unique identifier for a TrackingCategory +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

deleteTrackingOptions

+

Deletes a specific option for a specific tracking category

+
+
+
+

+

+

+
+ 
/TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_tracking_options():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    tracking_category_id = '00000000-0000-0000-0000-000000000000'
+    tracking_option_id = '00000000-0000-0000-0000-000000000000'
+    
+    try:
+        api_response = api_instance.delete_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->deleteTrackingOptions: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
accounting.settingsGrant read-write access to organisation and account settings
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
TrackingCategoryID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Unique identifier for a TrackingCategory +
+
+
+ Required +
+
+
+
TrackingOptionID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Unique identifier for a Tracking Option +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

emailInvoice

+

Sends a copy of a specific invoice to related contact via email

+
+
+
+

+

+

+
+ 
/Invoices/{InvoiceID}/Email
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_email_invoice():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    invoice_id = '00000000-0000-0000-0000-000000000000'
+    idempotency_key = 'KEY_VALUE'
+
+    requestEmpty = RequestEmpty()
+    
+    try:
+        api_instance.email_invoice(xero_tenant_id, invoice_id, requestEmpty, idempotency_key)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->emailInvoice: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
InvoiceID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Unique identifier for an Invoice +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
requestEmpty * +
+
+ + RequestEmpty + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

getAccount

+

Retrieves a single chart of accounts by using a unique account Id

+
+
+
+

+

+

+
+ 
/Accounts/{AccountID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_account():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    account_id = '00000000-0000-0000-0000-000000000000'
+    
+    try:
+        api_response = api_instance.get_account(xero_tenant_id, account_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->getAccount: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
accounting.settingsGrant read-write access to organisation and account settings
accounting.settings.readGrant read-only access to organisation and account settings
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
AccountID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Unique identifier for Account object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getAccountAttachmentByFileName

+

Retrieves an attachment for a specific account by filename

+
+
+
+

+

+

+
+ 
/Accounts/{AccountID}/Attachments/{FileName}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_account_attachment_by_file_name():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    account_id = '00000000-0000-0000-0000-000000000000'
+    file_name = 'xero-dev.jpg'
+    content_type = 'image/jpg'
+    
+    try:
+        api_response = api_instance.get_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, content_type)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->getAccountAttachmentByFileName: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
AccountID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Unique identifier for Account object +
+
+
+ Required +
+
+
+
FileName* + + +
+
+
+ + String + + +
+Name of the attachment +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
contentType* + + +
+
+
+ + String + + +
+The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getAccountAttachmentById

+

Retrieves a specific attachment from a specific account using a unique attachment Id

+
+
+
+

+

+

+
+ 
/Accounts/{AccountID}/Attachments/{AttachmentID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_account_attachment_by_id():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    account_id = '00000000-0000-0000-0000-000000000000'
+    attachment_id = '00000000-0000-0000-0000-000000000000'
+    content_type = 'image/jpg'
+    
+    try:
+        api_response = api_instance.get_account_attachment_by_id(xero_tenant_id, account_id, attachment_id, content_type)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->getAccountAttachmentById: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
AccountID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Unique identifier for Account object +
+
+
+ Required +
+
+
+
AttachmentID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Unique identifier for Attachment object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
contentType* + + +
+
+
+ + String + + +
+The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getAccountAttachments

+

Retrieves attachments for a specific accounts by using a unique account Id

+
+
+
+

+

+

+
+ 
/Accounts/{AccountID}/Attachments
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_account_attachments():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    account_id = '00000000-0000-0000-0000-000000000000'
+    
+    try:
+        api_response = api_instance.get_account_attachments(xero_tenant_id, account_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->getAccountAttachments: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + + +
NameDescription
AccountID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Unique identifier for Account object
@@ -18867,9 +22250,10 @@

Usage and SDK Samples

if_modified_since = dateutil.parser.parse("2020-02-06T12:17:43.202-08:00") where = 'Status=="AUTHORISED"' order = 'Type ASC' + references = ["Ref1", "Ref2"] try: - api_response = api_instance.get_bank_transactions(xero_tenant_id, if_modified_since, where, order, page, unitdp) + api_response = api_instance.get_bank_transactions(xero_tenant_id, if_modified_since, where, order, page, unitdp, pageSize, references) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->getBankTransactions: %s\n" % e) @@ -19027,6 +22411,46 @@

Parameters

pageSize + + +
+
+
+ + Integer + + +
+Number of records to retrieve per page +
+
+
+
+
References + + +
+
+
+ + array[String] + + +
+Filter by a comma-separated list of References +
+
+
+
+
@@ -19445,7 +22869,187 @@

Parameters

-
+
+
+
+ + String + + +
+The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf +
+
+
+ Required +
+
+
+ + + + +
+
+
+
+
+
+

getBankTransferAttachmentById

+

Retrieves a specific attachment from a specific bank transfer using a unique attachment ID

+
+
+
+

+

+

+
+ 
/BankTransfers/{BankTransferID}/Attachments/{AttachmentID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_bank_transfer_attachment_by_id():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    bank_transfer_id = '00000000-0000-0000-0000-000000000000'
+    attachment_id = '00000000-0000-0000-0000-000000000000'
+    content_type = 'image/jpg'
+    
+    try:
+        api_response = api_instance.get_bank_transfer_attachment_by_id(xero_tenant_id, bank_transfer_id, attachment_id, content_type)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->getBankTransferAttachmentById: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
BankTransferID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Xero generated unique identifier for a bank transfer +
+
+
+ Required +
+
+
+
AttachmentID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Unique identifier for Attachment object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + - - - -
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
contentType* + + +
@@ -19468,11 +23072,11 @@

Parameters

-
-
+
+
-

getBankTransferAttachmentById

-

Retrieves a specific attachment from a specific bank transfer using a unique attachment ID

+

getBankTransferAttachments

+

Retrieves attachments from a specific bank transfer

@@ -19480,17 +23084,17 @@

getBankTransferAttachmentById


- 
/BankTransfers/{BankTransferID}/Attachments/{AttachmentID}
+ 
/BankTransfers/{BankTransferID}/Attachments

Usage and SDK Samples

-
+ 
# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -19504,18 +23108,16 @@ 
Usage and SDK Samples

 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_get_bank_transfer_attachment_by_id():
+def accounting_get_bank_transfer_attachments():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
     bank_transfer_id = '00000000-0000-0000-0000-000000000000'
-    attachment_id = '00000000-0000-0000-0000-000000000000'
-    content_type = 'image/jpg'
     
     try:
-        api_response = api_instance.get_bank_transfer_attachment_by_id(xero_tenant_id, bank_transfer_id, attachment_id, content_type)
+        api_response = api_instance.get_bank_transfer_attachments(xero_tenant_id, bank_transfer_id)
         print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->getBankTransferAttachmentById: %s\n" % e)
+ print("Exception when calling AccountingApi->getBankTransferAttachments: %s\n" % e)

Scopes

@@ -19543,7 +23145,7 @@

Parameters

 -
+
@@ -19563,32 +23165,6 @@

Parameters

AttachmentID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for Attachment object -
-
-
- Required -
-
-
-
@@ -19602,7 +23178,7 @@

Parameters

-
+
@@ -19619,40 +23195,17 @@

Parameters

- - - contentType* - - - -
-
-
- - String - - -
-The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf -
-
-
- Required -
-
-
-
-
-
+
+
-

getBankTransferAttachments

-

Retrieves attachments from a specific bank transfer

+

getBankTransferHistory

+

Retrieves history from a specific bank transfer using a unique bank transfer Id

@@ -19660,17 +23213,17 @@

getBankTransferAttachments


- 
/BankTransfers/{BankTransferID}/Attachments
+ 
/BankTransfers/{BankTransferID}/History

Usage and SDK Samples

-
+ 
# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -19684,29 +23237,29 @@ 
Usage and SDK Samples

 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_get_bank_transfer_attachments():
+def accounting_get_bank_transfer_history():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
     bank_transfer_id = '00000000-0000-0000-0000-000000000000'
     
     try:
-        api_response = api_instance.get_bank_transfer_attachments(xero_tenant_id, bank_transfer_id)
+        api_response = api_instance.get_bank_transfer_history(xero_tenant_id, bank_transfer_id)
         print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->getBankTransferAttachments: %s\n" % e)
+ print("Exception when calling AccountingApi->getBankTransferHistory: %s\n" % e)

Scopes

- - + + - - + +
accounting.attachmentsGrant read-write access to attachmentsaccounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.attachments.readGrant read-only access to attachmentsaccounting.transactions.readGrant read-only access to invoices
@@ -19721,7 +23274,7 @@

Parameters

-
+
@@ -19754,7 +23307,7 @@

Parameters

-
+
@@ -19777,11 +23330,11 @@

Parameters

-
-
+
+
-

getBankTransferHistory

-

Retrieves history from a specific bank transfer using a unique bank transfer Id

+

getBankTransfers

+

Retrieves all bank transfers

@@ -19789,17 +23342,17 @@

getBankTransferHistory


- 
/BankTransfers/{BankTransferID}/History
+ 
/BankTransfers

Usage and SDK Samples

-
+ 
# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -19813,16 +23366,19 @@ 
Usage and SDK Samples

 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_get_bank_transfer_history():
+def accounting_get_bank_transfers():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    bank_transfer_id = '00000000-0000-0000-0000-000000000000'
+    if_modified_since = dateutil.parser.parse("2020-02-06T12:17:43.202-08:00")
+    where = 'HasAttachments==true'
+    order = 'Amount ASC'
+    include_deleted = 'True'
     
     try:
-        api_response = api_instance.get_bank_transfer_history(xero_tenant_id, bank_transfer_id)
+        api_response = api_instance.get_bank_transfers(xero_tenant_id, if_modified_since, where, order, include_deleted)
         print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->getBankTransferHistory: %s\n" % e)
+ print("Exception when calling AccountingApi->getBankTransfers: %s\n" % e)

Scopes

@@ -19840,28 +23396,25 @@

Scopes

Parameters

-
Path parameters
+
Header parameters
- + + + + +
Name Description
BankTransferID*
xero-tenant-id* -
+
- UUID + String - - (uuid) -
-Xero generated unique identifier for a bank transfer +Xero identifier for Tenant
@@ -19870,20 +23423,43 @@

Parameters

If-Modified-Since + + +
+
+
+ + Date + + + (date-time) + + +
+Only records created or modified since this timestamp will be returned +
+
+
+
+
-
Header parameters
+
Query parameters
- + + + + + + + + + @@ -19906,11 +23519,11 @@

Parameters

-
-
+
+
-

getBankTransfers

-

Retrieves all bank transfers

+

getBatchPayment

+

Retrieves a specific batch payment using a unique batch payment Id

@@ -19918,17 +23531,17 @@

getBankTransfers


- 
/BankTransfers
+ 
/BatchPayments/{BatchPaymentID}

Usage and SDK Samples

-
+ 
# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -19942,18 +23555,16 @@ 
Usage and SDK Samples

 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_get_bank_transfers():
+def accounting_get_batch_payment():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    if_modified_since = dateutil.parser.parse("2020-02-06T12:17:43.202-08:00")
-    where = 'HasAttachments==true'
-    order = 'Amount ASC'
+    batch_payment_id = '00000000-0000-0000-0000-000000000000'
     
     try:
-        api_response = api_instance.get_bank_transfers(xero_tenant_id, if_modified_since, where, order)
+        api_response = api_instance.get_batch_payment(xero_tenant_id, batch_payment_id)
         print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->getBankTransfers: %s\n" % e)
+ print("Exception when calling AccountingApi->getBatchPayment: %s\n" % e)

Scopes

@@ -19971,25 +23582,28 @@

Scopes

Name Description
xero-tenant-id*
where -
+
@@ -19891,12 +23467,49 @@

Parameters
-Xero identifier for Tenant +Filter by an any element +
+
+
+
+
order + + +
+
+
+ + String + + +
+Order by an any element +
+
+
+
+
includeDeleted + + +
+
+
+ + Boolean + + +
+e.g. includeDeleted=true - Bank transfers with a status of DELETED will be included in the response
-
- Required -

Parameters

-
Header parameters
+
Path parameters
- + - - - -
Name Description
xero-tenant-id*
BatchPaymentID* -
+
- String + UUID + + (uuid) +
-Xero identifier for Tenant +Unique identifier for BatchPayment
@@ -19998,63 +23612,20 @@

Parameters

If-Modified-Since - - -
-
-
- - Date - - - (date-time) - - -
-Only records created or modified since this timestamp will be returned -
-
-
-
-
-
Query parameters
+
Header parameters
- - - - - + @@ -20774,7 +24348,7 @@

Scopes

- +
Name Description
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order
xero-tenant-id* -
+
@@ -20062,9 +23633,12 @@

Parameters
-Order by an any element +Xero identifier for Tenant
+
+ Required +
accounting.budgets.readGrant read-only access to read budgets
@@ -20953,7 +24527,7 @@

Scopes

accounting.budgets.read - + Grant read-only access to read budgets @@ -22382,12 +25956,12 @@

Usage and SDK Samples

where = 'ContactStatus=="ACTIVE"' order = 'Name ASC' ids = ["00000000-0000-0000-0000-000000000000"] - include_archived = 'true' - summary_only = 'true' - search_term = 'searchTerm=Joe Bloggs' + include_archived = 'True' + summary_only = 'True' + search_term = 'Joe Bloggs' try: - api_response = api_instance.get_contacts(xero_tenant_id, if_modified_since, where, order, ids, page, include_archived, summary_only, search_term) + api_response = api_instance.get_contacts(xero_tenant_id, if_modified_since, where, order, ids, page, include_archived, summary_only, search_term, pageSize) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->getContacts: %s\n" % e) @@ -22608,6 +26182,26 @@

Parameters

+ + + pageSize + + + +
+
+
+ + Integer + + +
+Number of records to retrieve per page +
+
+
+
+ @@ -23030,468 +26624,7 @@

Parameters

-
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
- - - - contentType* - - - -
-
-
- - String - - -
-The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf -
-
-
- Required -
-
-
- - - - -
-
-
-
-
-
-

getCreditNoteAttachmentById

-

Retrieves a specific attachment from a specific credit note using a unique attachment Id

-
-
-
-

-

-

-
- 
/CreditNotes/{CreditNoteID}/Attachments/{AttachmentID}
-

-

Usage and SDK Samples

-

- -
- -
- 
# configure api_client for use with xero-python sdk client
-api_client = ApiClient(
-    Configuration(
-        debug=false,
-        oauth2_token=OAuth2Token(
-            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
-        ),
-    ),
-    pool_threads=1,
-)
-
-api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
-
-def accounting_get_credit_note_attachment_by_id():
-    api_instance = AccountingApi(api_client)
-    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    credit_note_id = '00000000-0000-0000-0000-000000000000'
-    attachment_id = '00000000-0000-0000-0000-000000000000'
-    content_type = 'image/jpg'
-    
-    try:
-        api_response = api_instance.get_credit_note_attachment_by_id(xero_tenant_id, credit_note_id, attachment_id, content_type)
-        print(api_response)
-    except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->getCreditNoteAttachmentById: %s\n" % e)
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
CreditNoteID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Credit Note -
-
-
- Required -
-
-
-
AttachmentID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for Attachment object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
contentType* - - -
-
-
- - String - - -
-The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getCreditNoteAttachments

-

Retrieves attachments for a specific credit notes

-
-
-
-

-

-

-
- 
/CreditNotes/{CreditNoteID}/Attachments
-

-

Usage and SDK Samples

-

- -
- -
- 
# configure api_client for use with xero-python sdk client
-api_client = ApiClient(
-    Configuration(
-        debug=false,
-        oauth2_token=OAuth2Token(
-            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
-        ),
-    ),
-    pool_threads=1,
-)
-
-api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
-
-def accounting_get_credit_note_attachments():
-    api_instance = AccountingApi(api_client)
-    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    credit_note_id = '00000000-0000-0000-0000-000000000000'
-    
-    try:
-        api_response = api_instance.get_credit_note_attachments(xero_tenant_id, credit_note_id)
-        print(api_response)
-    except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->getCreditNoteAttachments: %s\n" % e)
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
CreditNoteID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Credit Note -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getCreditNoteHistory

-

Retrieves history records of a specific credit note

-
-
-
-

-

-

-
- 
/CreditNotes/{CreditNoteID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
# configure api_client for use with xero-python sdk client
-api_client = ApiClient(
-    Configuration(
-        debug=false,
-        oauth2_token=OAuth2Token(
-            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
-        ),
-    ),
-    pool_threads=1,
-)
-
-api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
-
-def accounting_get_credit_note_history():
-    api_instance = AccountingApi(api_client)
-    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    credit_note_id = '00000000-0000-0000-0000-000000000000'
-    
-    try:
-        api_response = api_instance.get_credit_note_history(xero_tenant_id, credit_note_id)
-        print(api_response)
-    except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->getCreditNoteHistory: %s\n" % e)
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
CreditNoteID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Credit Note -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - + + + +
NameDescription
xero-tenant-id* - - -
+
@@ -23508,17 +26641,40 @@

Parameters

contentType* + + +
+
+
+ + String + + +
+The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf +
+
+
+ Required +
+
+
+
-
-
+
+
-

getCreditNotes

-

Retrieves any credit notes

+

getCreditNoteAttachmentById

+

Retrieves a specific attachment from a specific credit note using a unique attachment Id

@@ -23526,17 +26682,17 @@

getCreditNotes


- 
/CreditNotes
+ 
/CreditNotes/{CreditNoteID}/Attachments/{AttachmentID}

Usage and SDK Samples

-
+ 
# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -23550,54 +26706,57 @@ 
Usage and SDK Samples

 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_get_credit_notes():
+def accounting_get_credit_note_attachment_by_id():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    if_modified_since = dateutil.parser.parse("2020-02-06T12:17:43.202-08:00")
-    where = 'Status=="DRAFT"'
-    order = 'CreditNoteNumber ASC'
+    credit_note_id = '00000000-0000-0000-0000-000000000000'
+    attachment_id = '00000000-0000-0000-0000-000000000000'
+    content_type = 'image/jpg'
     
     try:
-        api_response = api_instance.get_credit_notes(xero_tenant_id, if_modified_since, where, order, page, unitdp)
+        api_response = api_instance.get_credit_note_attachment_by_id(xero_tenant_id, credit_note_id, attachment_id, content_type)
         print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->getCreditNotes: %s\n" % e)
+ print("Exception when calling AccountingApi->getCreditNoteAttachmentById: %s\n" % e)

Scopes

- - + + - - + +
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoicesaccounting.attachmentsGrant read-write access to attachments
accounting.transactions.readGrant read-only access to invoicesaccounting.attachments.readGrant read-only access to attachments

Parameters

-
Header parameters
+
Path parameters
- + - +
Name Description
xero-tenant-id*
CreditNoteID* -
+
- String + UUID + + (uuid) +
-Xero identifier for Tenant +Unique identifier for a Credit Note
@@ -23608,41 +26767,44 @@

Parameters
If-Modified-Since
AttachmentID* -
+
- Date + UUID - (date-time) + (uuid)
-Only records created or modified since this timestamp will be returned +Unique identifier for Attachment object
+
+ Required +
-
Query parameters
+
Header parameters
- + - + - - - - - - - - @@ -23722,11 +26850,11 @@

Parameters

-
-
+
+
-

getCurrencies

-

Retrieves currencies for your Xero organisation

+

getCreditNoteAttachments

+

Retrieves attachments for a specific credit notes

@@ -23734,17 +26862,17 @@

getCurrencies


- 
/Currencies
+ 
/CreditNotes/{CreditNoteID}/Attachments

Usage and SDK Samples

-
+ 
# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -23758,53 +26886,55 @@ 
Usage and SDK Samples

 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_get_currencies():
+def accounting_get_credit_note_attachments():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    where = 'Code=="USD"'
-    order = 'Code ASC'
+    credit_note_id = '00000000-0000-0000-0000-000000000000'
     
     try:
-        api_response = api_instance.get_currencies(xero_tenant_id, where, order)
+        api_response = api_instance.get_credit_note_attachments(xero_tenant_id, credit_note_id)
         print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->getCurrencies: %s\n" % e)
+ print("Exception when calling AccountingApi->getCreditNoteAttachments: %s\n" % e)

Scopes

Name Description
where
xero-tenant-id* -
+
@@ -23650,19 +26812,22 @@

Parameters
-Filter by an any element +Xero identifier for Tenant
+
+ Required +
order
contentType* -
+
@@ -23670,49 +26835,12 @@

Parameters
-Order by an any element -
-
-
-
-
page - - -
-
-
- - Integer - - -
-e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note -
-
-
-
-
unitdp - - -
-
-
- - Integer - - -
-e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts +The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
+
+ Required +
- - + + - - + +
accounting.settingsGrant read-write access to organisation and account settingsaccounting.attachmentsGrant read-write access to attachments
accounting.settings.readGrant read-only access to organisation and account settingsaccounting.attachments.readGrant read-only access to attachments

Parameters

-
Header parameters
+
Path parameters
- +
Name Description
xero-tenant-id*
CreditNoteID* -
+
- String + UUID + + (uuid) +
-Xero identifier for Tenant +Unique identifier for a Credit Note
@@ -23816,37 +26946,17 @@

Parameters

-
Query parameters
+
Header parameters
- - - - - + @@ -23866,11 +26979,11 @@

Parameters

-
-
+
+
-

getEmployee

-

Retrieves a specific employee used in Xero payrun using a unique employee Id

+

getCreditNoteHistory

+

Retrieves history records of a specific credit note

@@ -23878,17 +26991,17 @@

getEmployee


- 
/Employees/{EmployeeID}
+ 
/CreditNotes/{CreditNoteID}/History

Usage and SDK Samples

-
+ 
# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -23902,29 +27015,29 @@ 
Usage and SDK Samples

 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_get_employee():
+def accounting_get_credit_note_history():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    employee_id = '00000000-0000-0000-0000-000000000000'
+    credit_note_id = '00000000-0000-0000-0000-000000000000'
     
     try:
-        api_response = api_instance.get_employee(xero_tenant_id, employee_id)
+        api_response = api_instance.get_credit_note_history(xero_tenant_id, credit_note_id)
         print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->getEmployee: %s\n" % e)
+ print("Exception when calling AccountingApi->getCreditNoteHistory: %s\n" % e)

Scopes

Name Description
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order
xero-tenant-id* -
+
@@ -23854,9 +26964,12 @@

Parameters
-Order by an any element +Xero identifier for Tenant
+
+ Required +
- - + + - - + +
accounting.settingsGrant read-write access to organisation and account settingsaccounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.settings.readGrant read-only access to organisation and account settingsaccounting.transactions.readGrant read-only access to invoices
@@ -23935,11 +27048,11 @@

Parameters

Name Description - EmployeeID* + CreditNoteID* -
+
@@ -23950,7 +27063,7 @@

Parameters
-Unique identifier for a Employee +Unique identifier for a Credit Note
@@ -23972,7 +27085,7 @@

Parameters

-
+
@@ -23995,11 +27108,11 @@

Parameters

-
-
+
+
-

getEmployees

-

Retrieves employees used in Xero payrun

+

getCreditNotes

+

Retrieves any credit notes

@@ -24007,17 +27120,17 @@

getEmployees


- 
/Employees
+ 
/CreditNotes

Usage and SDK Samples

-
+ 
# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -24031,31 +27144,31 @@ 
Usage and SDK Samples

 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_get_employees():
+def accounting_get_credit_notes():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
     if_modified_since = dateutil.parser.parse("2020-02-06T12:17:43.202-08:00")
-    where = 'Status=="ACTIVE"'
-    order = 'LastName ASC'
+    where = 'Status=="DRAFT"'
+    order = 'CreditNoteNumber ASC'
     
     try:
-        api_response = api_instance.get_employees(xero_tenant_id, if_modified_since, where, order)
+        api_response = api_instance.get_credit_notes(xero_tenant_id, if_modified_since, where, order, page, unitdp, pageSize)
         print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->getEmployees: %s\n" % e)
+ print("Exception when calling AccountingApi->getCreditNotes: %s\n" % e)

Scopes

- - + + - - + +
accounting.settingsGrant read-write access to organisation and account settingsaccounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.settings.readGrant read-only access to organisation and account settingsaccounting.transactions.readGrant read-only access to invoices
@@ -24070,7 +27183,7 @@

Parameters

-
+
@@ -24093,7 +27206,7 @@

Parameters

-
+
@@ -24123,7 +27236,211 @@

Parameters

-
+
+
+
+ + String + + +
+Filter by an any element +
+
+
+
+ + + + order + + + +
+
+
+ + String + + +
+Order by an any element +
+
+
+
+ + + + page + + + +
+
+
+ + Integer + + +
+e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note +
+
+
+
+ + + + unitdp + + + +
+
+
+ + Integer + + +
+e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts +
+
+
+
+ + + + pageSize + + + +
+
+
+ + Integer + + +
+Number of records to retrieve per page +
+
+
+
+ + + + +
+
+
+
+
+
+

getCurrencies

+

Retrieves currencies for your Xero organisation

+
+
+
+

+

+

+
+ 
/Currencies
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_currencies():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    where = 'Code=="USD"'
+    order = 'Code ASC'
+    
+    try:
+        api_response = api_instance.get_currencies(xero_tenant_id, where, order)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->getCurrencies: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
accounting.settingsGrant read-write access to organisation and account settings
accounting.settings.readGrant read-only access to organisation and account settings
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + + + + + + +
NameDescription
where + + +
@@ -24143,7 +27460,7 @@

Parameters

 -
+
@@ -25630,12 +28947,13 @@

Usage and SDK Samples

invoice_numbers = ["INV-001", "INV-002"] contact_ids = ["00000000-0000-0000-0000-000000000000"] statuses = ["DRAFT", "SUBMITTED"] - include_archived = 'true' - created_by_my_app = 'false' - summary_only = 'true' + include_archived = 'True' + created_by_my_app = 'False' + summary_only = 'True' + search_term = 'True' try: - api_response = api_instance.get_invoices(xero_tenant_id, if_modified_since, where, order, ids, invoice_numbers, contact_ids, statuses, page, include_archived, created_by_my_app, unitdp, summary_only) + api_response = api_instance.get_invoices(xero_tenant_id, if_modified_since, where, order, ids, invoice_numbers, contact_ids, statuses, page, include_archived, created_by_my_app, unitdp, summary_only, pageSize, search_term) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->getInvoices: %s\n" % e) @@ -25939,6 +29257,46 @@

Parameters

pageSize + + +
+
+
+ + Integer + + +
+Number of records to retrieve per page +
+
+
+
+
searchTerm + + +
+
+
+ + String + + +
+Search parameter that performs a case-insensitive text search across the fields e.g. InvoiceNumber, Reference. +
+
+
+
+
@@ -26536,6 +29894,126 @@

Parameters

+ + + +
+
+
+
+
+
+

getJournalByNumber

+

Retrieves a specific journal using a unique journal number.

+
+
+
+

+

+

+
+ 
/Journals/{JournalNumber}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_journal_by_number():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    
+    try:
+        api_response = api_instance.get_journal_by_number(xero_tenant_id, journal_number)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->getJournalByNumber: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
accounting.journals.readGrant read-only access to journals
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
JournalNumber* + + +
+
+
+ + Integer + + +
+Number of a Journal +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
@@ -26582,7 +30060,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' if_modified_since = dateutil.parser.parse("2020-02-06T12:17:43.202-08:00") - payments_only = 'true' + payments_only = 'True' try: api_response = api_instance.get_journals(xero_tenant_id, if_modified_since, offset, payments_only) @@ -27731,7 +31209,7 @@

Usage and SDK Samples

order = 'Date ASC' try: - api_response = api_instance.get_manual_journals(xero_tenant_id, if_modified_since, where, order, page) + api_response = api_instance.get_manual_journals(xero_tenant_id, if_modified_since, where, order, page, pageSize) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->getManualJournals: %s\n" % e) @@ -27869,6 +31347,26 @@

Parameters

+ + + pageSize + + + +
+
+
+ + Integer + + +
+Number of records to retrieve per page +
+
+
+
+ @@ -28752,9 +32250,10 @@

Usage and SDK Samples

if_modified_since = dateutil.parser.parse("2020-02-06T12:17:43.202-08:00") where = 'Status=="AUTHORISED"' order = 'Status ASC' + references = ["Ref1", "Ref2"] try: - api_response = api_instance.get_overpayments(xero_tenant_id, if_modified_since, where, order, page, unitdp) + api_response = api_instance.get_overpayments(xero_tenant_id, if_modified_since, where, order, page, unitdp, pageSize, references) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->getOverpayments: %s\n" % e) @@ -28912,6 +32411,46 @@

Parameters

+ + + pageSize + + + +
+
+
+ + Integer + + +
+Number of records to retrieve per page +
+
+
+
+ + + + References + + + +
+
+
+ + array[String] + + +
+Filter by a comma-separated list of References +
+
+
+
+ @@ -29310,7 +32849,7 @@

Usage and SDK Samples

order = 'Amount ASC' try: - api_response = api_instance.get_payments(xero_tenant_id, if_modified_since, where, order, page) + api_response = api_instance.get_payments(xero_tenant_id, if_modified_since, where, order, page, pageSize) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->getPayments: %s\n" % e) @@ -29448,6 +32987,26 @@

Parameters

+ + + pageSize + + + +
+
+
+ + Integer + + +
+Number of records to retrieve per page +
+
+
+
+ @@ -29754,9 +33313,11 @@

Usage and SDK Samples

if_modified_since = dateutil.parser.parse("2020-02-06T12:17:43.202-08:00") where = 'Status=="AUTHORISED"' order = 'Reference ASC' + invoice_numbers = ["INV-001", "INV-002"] + references = ["Ref1", "Ref2"] try: - api_response = api_instance.get_prepayments(xero_tenant_id, if_modified_since, where, order, page, unitdp) + api_response = api_instance.get_prepayments(xero_tenant_id, if_modified_since, where, order, page, unitdp, pageSize, invoice_numbers, references) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->getPrepayments: %s\n" % e) @@ -29888,7 +33449,7 @@

Parameters

-e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment +e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each prepayment
@@ -29914,6 +33475,66 @@

Parameters

+ + + pageSize + + + +
+
+
+ + Integer + + +
+Number of records to retrieve per page +
+
+
+
+ + + + InvoiceNumbers + + + +
+
+
+ + array[String] + + +
+Filter by a comma-separated list of InvoiceNumbers +
+
+
+
+ + + + References + + + +
+
+
+ + array[String] + + +
+Filter by a comma-separated list of References +
+
+
+
+ @@ -30172,6 +33793,183 @@

Parameters

+ + + + + +
+
+
+
+

getPurchaseOrderAttachmentByFileName

+

Retrieves a specific attachment for a specific purchase order by filename

+
+
+
+

+

+

+
+ 
/PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_purchase_order_attachment_by_file_name():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    purchase_order_id = '00000000-0000-0000-0000-000000000000'
+    file_name = 'xero-dev.jpg'
+    content_type = 'image/jpg'
+    
+    try:
+        api_response = api_instance.get_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, content_type)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->getPurchaseOrderAttachmentByFileName: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
PurchaseOrderID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Unique identifier for an Purchase Order +
+
+
+ Required +
+
+
+
FileName* + + +
+
+
+ + String + + +
+Name of the attachment +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
contentType* + + +
+
+
+ + String + + +
+The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf +
+
+
+ Required +
+
+
+
@@ -30788,7 +34586,7 @@

Usage and SDK Samples

order = 'PurchaseOrderNumber ASC' try: - api_response = api_instance.get_purchase_orders(xero_tenant_id, if_modified_since, status, date_from, date_to, order, page) + api_response = api_instance.get_purchase_orders(xero_tenant_id, if_modified_since, status, date_from, date_to, order, page, pageSize) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->getPurchaseOrders: %s\n" % e) @@ -30968,178 +34766,21 @@

Parameters

- -
-
-
-
-
-
-

getPurchaseOrder≠AttachmentByFileName

-

Retrieves a specific attachment for a specific purchase order by filename

-
-
-
-

-

-

-
- 
/PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
# configure api_client for use with xero-python sdk client
-api_client = ApiClient(
-    Configuration(
-        debug=false,
-        oauth2_token=OAuth2Token(
-            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
-        ),
-    ),
-    pool_threads=1,
-)
-
-api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
-
-def accounting_get_purchase_order≠attachment_by_file_name():
-    api_instance = AccountingApi(api_client)
-    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    purchase_order_id = '00000000-0000-0000-0000-000000000000'
-    file_name = 'xero-dev.jpg'
-    content_type = 'image/jpg'
-    
-    try:
-        api_response = api_instance.get_purchase_order≠attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, content_type)
-        print(api_response)
-    except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->getPurchaseOrder≠AttachmentByFileName: %s\n" % e)
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
PurchaseOrderID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Purchase Order -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - - + @@ -34633,8 +38274,8 @@

Usage and SDK Samples

timeframe = 'MONTH' tracking_option_id_1 = '00000000-0000-0000-0000-000000000000' tracking_option_id_2 = '00000000-0000-0000-0000-000000000000' - standard_layout = 'true' - payments_only = 'false' + standard_layout = 'True' + payments_only = 'False' try: api_response = api_instance.get_report_balance_sheet(xero_tenant_id, date, periods, timeframe, tracking_option_id_1, tracking_option_id_2, standard_layout, payments_only) @@ -35430,8 +39071,8 @@

Usage and SDK Samples

tracking_category_id_2 = '00000000-0000-0000-0000-000000000000' tracking_option_id = '00000000-0000-0000-0000-000000000000' tracking_option_id_2 = '00000000-0000-0000-0000-000000000000' - standard_layout = 'true' - payments_only = 'false' + standard_layout = 'True' + payments_only = 'False' try: api_response = api_instance.get_report_profit_and_loss(xero_tenant_id, from_date, to_date, periods, timeframe, tracking_category_id, tracking_category_id_2, tracking_option_id, tracking_option_id_2, standard_layout, payments_only) @@ -35795,19 +39436,161 @@

Parameters

- + + + + +
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
contentType*
pageSize -
+
- String + Integer
-The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf +Number of records to retrieve per page
-
- Required -
Name Description
reportYear
reportYear + + +
+
+
+ + String + + +
+The year of the 1099 report +
+
+
+
+
+
+
+
+
+
+
+

getReportTrialBalance

+

Retrieves report for trial balance

+
+
+
+

+

+

+
+ 
/Reports/TrialBalance
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_report_trial_balance():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    date = dateutil.parser.parse("2019-10-31")
+    payments_only = 'True'
+    
+    try:
+        api_response = api_instance.get_report_trial_balance(xero_tenant_id, date, payments_only)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->getReportTrialBalance: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
accounting.reports.readGrant read-only access to accounting reports
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + + - - -
NameDescription
date -
+
- String + date + + (date) +
-The year of the 1099 report +The date for the Trial Balance report e.g. 2018-03-31 +
+
+
+
+
paymentsOnly + + +
+
+
+ + Boolean + + +
+Return cash only basis for the Trial Balance report
@@ -35819,11 +39602,11 @@

Parameters

-
-
+
+
-

getReportTrialBalance

-

Retrieves report for trial balance

+

getReportsList

+

Retrieves a list of the organistaions unique reports that require a uuid to fetch

@@ -35831,17 +39614,17 @@

getReportTrialBalance


- 
/Reports/TrialBalance
+ 
/Reports

Usage and SDK Samples

-
+ 
# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -35855,17 +39638,15 @@ 
Usage and SDK Samples

 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_get_report_trial_balance():
+def accounting_get_reports_list():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    date = dateutil.parser.parse("2019-10-31")
-    payments_only = 'true'
     
     try:
-        api_response = api_instance.get_report_trial_balance(xero_tenant_id, date, payments_only)
+        api_response = api_instance.get_reports_list(xero_tenant_id)
         print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->getReportTrialBalance: %s\n" % e)
+ print("Exception when calling AccountingApi->getReportsList: %s\n" % e)

Scopes

@@ -35888,7 +39669,7 @@

Parameters

 -
+
@@ -35905,67 +39686,17 @@

Parameters

-
Query parameters
- - - - - - - - - - -
NameDescription
date - - -
-
-
- - date - - - (date) - - -
-The date for the Trial Balance report e.g. 2018-03-31 -
-
-
-
-
paymentsOnly - - -
-
-
- - Boolean - - -
-Return cash only basis for the Trial Balance report -
-
-
-
-
-
-
+
+
-

getReportsList

-

Retrieves a list of the organistaions unique reports that require a uuid to fetch

+

getTaxRateByTaxType

+

Retrieves a specific tax rate according to given TaxType code

@@ -35973,17 +39704,17 @@

getReportsList


- 
/Reports
+ 
/TaxRates/{TaxType}

Usage and SDK Samples

-
+ 
# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -35997,27 +39728,63 @@ 
Usage and SDK Samples

 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_get_reports_list():
+def accounting_get_tax_rate_by_tax_type():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    taxType = 'INPUT2'
     
     try:
-        api_response = api_instance.get_reports_list(xero_tenant_id)
+        api_response = api_instance.get_tax_rate_by_tax_type(xero_tenant_id, taxType)
         print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->getReportsList: %s\n" % e)
+ print("Exception when calling AccountingApi->getTaxRateByTaxType: %s\n" % e)

Scopes

- - + + + + + + +
accounting.reports.readGrant read-only access to accounting reportsaccounting.settingsGrant read-write access to organisation and account settings
accounting.settings.readGrant read-only access to organisation and account settings

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
TaxType* + + +
+
+
+ + String + + +
+A valid TaxType code +
+
+
+ Required +
+
+
+
Header parameters
@@ -36028,7 +39795,7 @@

Parameters

- - - -
-
+
@@ -36092,10 +39859,9 @@

Usage and SDK Samples

xero_tenant_id = 'YOUR_XERO_TENANT_ID' where = 'Status=="ACTIVE"' order = 'Name ASC' - tax_type = 'INPUT' try: - api_response = api_instance.get_tax_rates(xero_tenant_id, where, order, tax_type) + api_response = api_instance.get_tax_rates(xero_tenant_id, where, order) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->getTaxRates: %s\n" % e) @@ -36190,26 +39956,6 @@

Parameters

TaxType - - -
-
-
- - String - - -
-Filter by tax type -
-
-
-
-
@@ -36257,7 +40003,7 @@

Usage and SDK Samples

xero_tenant_id = 'YOUR_XERO_TENANT_ID' where = 'Status=="ACTIVE"' order = 'Name ASC' - include_archived = 'true' + include_archived = 'True' try: api_response = api_instance.get_tracking_categories(xero_tenant_id, where, order, include_archived) @@ -36846,6 +40592,7 @@

Usage and SDK Samples

def accounting_post_setup(): api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' + idempotency_key = 'KEY_VALUE' account = Account( code = "123", @@ -36867,7 +40614,7 @@

Usage and SDK Samples

conversion_balances = conversion_balances) try: - api_response = api_instance.post_setup(xero_tenant_id, setup) + api_response = api_instance.post_setup(xero_tenant_id, setup, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->postSetup: %s\n" % e) @@ -36910,6 +40657,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -36943,7 +40710,33 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/Setup" }, - "example" : "{ \"ConversionDate\": {}, \"ConversionBalances\": [], \"Accounts\": [ { \"Code\": \"200\", \"Name\": \"Sales\", \"Type\": \"SALES\", \"ReportingCode\": \"REV.TRA.GOO\" }, { \"Code\": \"400\", \"Name\": \"Advertising\", \"Type\": \"OVERHEADS\", \"ReportingCode\": \"EXP\" }, { \"Code\": \"610\", \"Name\": \"Accounts Receivable\", \"Type\": \"CURRENT\", \"SystemAccount\": \"DEBTORS\", \"ReportingCode\": \"ASS.CUR.REC.TRA\" }, { \"Code\": \"800\", \"Name\": \"Accounts Payable\", \"Type\": \"CURRLIAB\", \"SystemAccount\": \"CREDITORS\", \"ReportingCode\": \"LIA.CUR.PAY\" } ] }" + "example" : { + "ConversionDate" : { }, + "ConversionBalances" : [ ], + "Accounts" : [ { + "Code" : "200", + "Name" : "Sales", + "Type" : "SALES", + "ReportingCode" : "REV.TRA.GOO" + }, { + "Code" : "400", + "Name" : "Advertising", + "Type" : "OVERHEADS", + "ReportingCode" : "EXP" + }, { + "Code" : "610", + "Name" : "Accounts Receivable", + "Type" : "CURRENT", + "SystemAccount" : "DEBTORS", + "ReportingCode" : "ASS.CUR.REC.TRA" + }, { + "Code" : "800", + "Name" : "Accounts Payable", + "Type" : "CURRLIAB", + "SystemAccount" : "CREDITORS", + "ReportingCode" : "LIA.CUR.PAY" + } ] + } } }, "required" : true @@ -36993,6 +40786,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' account_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' account = Account( code = "123456", @@ -37005,7 +40799,7 @@

Usage and SDK Samples

accounts = [account]) try: - api_response = api_instance.update_account(xero_tenant_id, account_id, accounts) + api_response = api_instance.update_account(xero_tenant_id, account_id, accounts, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateAccount: %s\n" % e) @@ -37081,6 +40875,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -37114,7 +40928,22 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/Accounts" }, - "example" : "{ \"Accounts\":[ { \"Code\":\"123456\", \"Name\":\"BarFoo\", \"AccountID\":\"99ce6032-0678-4aa0-8148-240c75fee33a\", \"Type\":\"EXPENSE\", \"Description\":\"GoodBye World\", \"TaxType\":\"INPUT\", \"EnablePaymentsToAccount\":false, \"ShowInExpenseClaims\":false, \"Class\":\"EXPENSE\", \"ReportingCode\":\"EXP\", \"ReportingCodeName\":\"Expense\", \"UpdatedDateUTC\":\"2019-02-21T16:29:47.96-08:00\" } ] }" + "example" : { + "Accounts" : [ { + "Code" : "123456", + "Name" : "BarFoo", + "AccountID" : "99ce6032-0678-4aa0-8148-240c75fee33a", + "Type" : "EXPENSE", + "Description" : "GoodBye World", + "TaxType" : "INPUT", + "EnablePaymentsToAccount" : false, + "ShowInExpenseClaims" : false, + "Class" : "EXPENSE", + "ReportingCode" : "EXP", + "ReportingCodeName" : "Expense", + "UpdatedDateUTC" : "2019-02-21T16:29:47.96-08:00" + } ] + } } }, "required" : true @@ -37165,13 +40994,14 @@

Usage and SDK Samples

xero_tenant_id = 'YOUR_XERO_TENANT_ID' account_id = '00000000-0000-0000-0000-000000000000' file_name = 'xero-dev.jpg' + idempotency_key = 'KEY_VALUE' path_to_upload = Path(__file__).resolve().parent.joinpath(fileName) open_file = open(path_to_upload, 'rb') body = open_file.read() try: - api_response = api_instance.update_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body) + api_response = api_instance.update_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateAccountAttachmentByFileName: %s\n" % e) @@ -37270,6 +41100,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -37353,6 +41203,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' bank_transaction_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' contact = Contact( contact_id = "00000000-0000-0000-0000-000000000000") @@ -37380,7 +41231,7 @@

Usage and SDK Samples

bank_transactions = [bank_transaction]) try: - api_response = api_instance.update_bank_transaction(xero_tenant_id, bank_transaction_id, bankTransactions, unitdp) + api_response = api_instance.update_bank_transaction(xero_tenant_id, bank_transaction_id, bankTransactions, unitdp, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateBankTransaction: %s\n" % e) @@ -37456,6 +41307,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -37488,7 +41359,77 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/BankTransactions" }, - "example" : "{ \"BankTransactions\": [ { \"Type\": \"SPEND\", \"Contact\": { \"ContactID\": \"00000000-0000-0000-0000-000000000000\", \"ContactStatus\": \"ACTIVE\", \"Name\": \"Buzz Lightyear\", \"FirstName\": \"Buzz\", \"LastName\": \"Lightyear\", \"EmailAddress\": \"buzz.Lightyear@email.com\", \"ContactPersons\": [], \"BankAccountDetails\": \"\", \"Addresses\": [ { \"AddressType\": \"STREET\", \"City\": \"\", \"Region\": \"\", \"PostalCode\": \"\", \"Country\": \"\" }, { \"AddressType\": \"POBOX\", \"AddressLine1\": \"\", \"AddressLine2\": \"\", \"AddressLine3\": \"\", \"AddressLine4\": \"\", \"City\": \"Palo Alto\", \"Region\": \"CA\", \"PostalCode\": \"94020\", \"Country\": \"United States\" } ], \"Phones\": [ { \"PhoneType\": \"DEFAULT\", \"PhoneNumber\": \"847-1294\", \"PhoneAreaCode\": \"(626)\", \"PhoneCountryCode\": \"\" }, { \"PhoneType\": \"DDI\", \"PhoneNumber\": \"\", \"PhoneAreaCode\": \"\", \"PhoneCountryCode\": \"\" }, { \"PhoneType\": \"FAX\", \"PhoneNumber\": \"\", \"PhoneAreaCode\": \"\", \"PhoneCountryCode\": \"\" }, { \"PhoneType\": \"MOBILE\", \"PhoneNumber\": \"\", \"PhoneAreaCode\": \"\", \"PhoneCountryCode\": \"\" } ], \"UpdatedDateUTC\": \"2017-08-21T13:49:04.227-07:00\", \"ContactGroups\": [] }, \"Lineitems\": [], \"BankAccount\": { \"Code\": \"088\", \"Name\": \"Business Wells Fargo\", \"AccountID\": \"00000000-0000-0000-0000-000000000000\" }, \"IsReconciled\": false, \"Date\": \"2019-02-25\", \"Reference\": \"You just updated\", \"CurrencyCode\": \"USD\", \"CurrencyRate\": 1, \"Status\": \"AUTHORISED\", \"LineAmountTypes\": \"Inclusive\", \"TotalTax\": 1.74, \"BankTransactionID\": \"00000000-0000-0000-0000-000000000000\", \"UpdatedDateUTC\": \"2019-02-26T12:39:27.813-08:00\" } ] }" + "example" : { + "BankTransactions" : [ { + "Type" : "SPEND", + "Contact" : { + "ContactID" : "00000000-0000-0000-0000-000000000000", + "ContactStatus" : "ACTIVE", + "Name" : "Buzz Lightyear", + "FirstName" : "Buzz", + "LastName" : "Lightyear", + "EmailAddress" : "buzz.Lightyear@email.com", + "ContactPersons" : [ ], + "BankAccountDetails" : "", + "Addresses" : [ { + "AddressType" : "STREET", + "City" : "", + "Region" : "", + "PostalCode" : "", + "Country" : "" + }, { + "AddressType" : "POBOX", + "AddressLine1" : "", + "AddressLine2" : "", + "AddressLine3" : "", + "AddressLine4" : "", + "City" : "Palo Alto", + "Region" : "CA", + "PostalCode" : "94020", + "Country" : "United States" + } ], + "Phones" : [ { + "PhoneType" : "DEFAULT", + "PhoneNumber" : "847-1294", + "PhoneAreaCode" : "(626)", + "PhoneCountryCode" : "" + }, { + "PhoneType" : "DDI", + "PhoneNumber" : "", + "PhoneAreaCode" : "", + "PhoneCountryCode" : "" + }, { + "PhoneType" : "FAX", + "PhoneNumber" : "", + "PhoneAreaCode" : "", + "PhoneCountryCode" : "" + }, { + "PhoneType" : "MOBILE", + "PhoneNumber" : "", + "PhoneAreaCode" : "", + "PhoneCountryCode" : "" + } ], + "UpdatedDateUTC" : "2017-08-21T13:49:04.227-07:00", + "ContactGroups" : [ ] + }, + "Lineitems" : [ ], + "BankAccount" : { + "Code" : "088", + "Name" : "Business Wells Fargo", + "AccountID" : "00000000-0000-0000-0000-000000000000" + }, + "IsReconciled" : false, + "Date" : "2019-02-25", + "Reference" : "You just updated", + "CurrencyCode" : "USD", + "CurrencyRate" : 1, + "Status" : "AUTHORISED", + "LineAmountTypes" : "Inclusive", + "TotalTax" : 1.74, + "BankTransactionID" : "00000000-0000-0000-0000-000000000000", + "UpdatedDateUTC" : "2019-02-26T12:39:27.813-08:00" + } ] + } } }, "required" : true @@ -37566,13 +41507,14 @@

Usage and SDK Samples

xero_tenant_id = 'YOUR_XERO_TENANT_ID' bank_transaction_id = '00000000-0000-0000-0000-000000000000' file_name = 'xero-dev.jpg' + idempotency_key = 'KEY_VALUE' path_to_upload = Path(__file__).resolve().parent.joinpath(fileName) open_file = open(path_to_upload, 'rb') body = open_file.read() try: - api_response = api_instance.update_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body) + api_response = api_instance.update_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateBankTransactionAttachmentByFileName: %s\n" % e) @@ -37671,6 +41613,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -37755,13 +41717,14 @@

Usage and SDK Samples

xero_tenant_id = 'YOUR_XERO_TENANT_ID' bank_transfer_id = '00000000-0000-0000-0000-000000000000' file_name = 'xero-dev.jpg' + idempotency_key = 'KEY_VALUE' path_to_upload = Path(__file__).resolve().parent.joinpath(fileName) open_file = open(path_to_upload, 'rb') body = open_file.read() try: - api_response = api_instance.update_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body) + api_response = api_instance.update_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateBankTransferAttachmentByFileName: %s\n" % e) @@ -37860,6 +41823,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -37943,6 +41926,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' contact_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' contact = Contact( name = "Thanos", @@ -37952,7 +41936,7 @@

Usage and SDK Samples

contacts = [contact]) try: - api_response = api_instance.update_contact(xero_tenant_id, contact_id, contacts) + api_response = api_instance.update_contact(xero_tenant_id, contact_id, contacts, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateContact: %s\n" % e) @@ -38028,6 +42012,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -38061,7 +42065,12 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/Contacts" }, - "example" : "{ \"Contacts\": [{ \"ContactID\": \"00000000-0000-0000-0000-000000000000\", \"Name\": \"Thanos\" }]}" + "example" : { + "Contacts" : [ { + "ContactID" : "00000000-0000-0000-0000-000000000000", + "Name" : "Thanos" + } ] + } } }, "required" : true @@ -38112,13 +42121,14 @@

Usage and SDK Samples

xero_tenant_id = 'YOUR_XERO_TENANT_ID' contact_id = '00000000-0000-0000-0000-000000000000' file_name = 'xero-dev.jpg' + idempotency_key = 'KEY_VALUE' path_to_upload = Path(__file__).resolve().parent.joinpath(fileName) open_file = open(path_to_upload, 'rb') body = open_file.read() try: - api_response = api_instance.update_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body) + api_response = api_instance.update_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateContactAttachmentByFileName: %s\n" % e) @@ -38217,6 +42227,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -38300,6 +42330,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' contact_group_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' contact_group = ContactGroup( name = "Vendor") @@ -38308,7 +42339,7 @@

Usage and SDK Samples

contact_groups = [contact_group]) try: - api_response = api_instance.update_contact_group(xero_tenant_id, contact_group_id, contactGroups) + api_response = api_instance.update_contact_group(xero_tenant_id, contact_group_id, contactGroups, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateContactGroup: %s\n" % e) @@ -38384,6 +42415,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -38417,7 +42468,11 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/ContactGroups" }, - "example" : "{ \"ContactGroups\":[ { \"Name\":\"Suppliers\" } ] }" + "example" : { + "ContactGroups" : [ { + "Name" : "Suppliers" + } ] + } } }, "required" : true @@ -38467,6 +42522,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' credit_note_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' curr_date = dateutil.parser.parse('2020-12-03T00:00:00Z') contact = Contact( @@ -38493,7 +42549,7 @@

Usage and SDK Samples

credit_notes = [credit_note]) try: - api_response = api_instance.update_credit_note(xero_tenant_id, credit_note_id, creditNotes, unitdp) + api_response = api_instance.update_credit_note(xero_tenant_id, credit_note_id, creditNotes, unitdp, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateCreditNote: %s\n" % e) @@ -38569,6 +42625,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -38602,7 +42678,24 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/CreditNotes" }, - "example" : "{ \"CreditNotes\": [ { \"Type\": \"ACCPAYCREDIT\", \"Contact\": { \"ContactID\": \"430fa14a-f945-44d3-9f97-5df5e28441b8\" }, \"Date\": \"2019-01-05\", \"Status\": \"AUTHORISED\", \"Reference\": \"HelloWorld\", \"LineItems\": [ { \"Description\": \"Foobar\", \"Quantity\": 2, \"UnitAmount\": 20, \"AccountCode\": \"400\" } ] } ] }" + "example" : { + "CreditNotes" : [ { + "Type" : "ACCPAYCREDIT", + "Contact" : { + "ContactID" : "430fa14a-f945-44d3-9f97-5df5e28441b8" + }, + "Date" : "2019-01-05", + "Status" : "AUTHORISED", + "Reference" : "HelloWorld", + "SentToContact" : true, + "LineItems" : [ { + "Description" : "Foobar", + "Quantity" : 2, + "UnitAmount" : 20, + "AccountCode" : "400" + } ] + } ] + } } }, "required" : true @@ -38680,13 +42773,14 @@

Usage and SDK Samples

xero_tenant_id = 'YOUR_XERO_TENANT_ID' credit_note_id = '00000000-0000-0000-0000-000000000000' file_name = 'xero-dev.jpg' + idempotency_key = 'KEY_VALUE' path_to_upload = Path(__file__).resolve().parent.joinpath(fileName) open_file = open(path_to_upload, 'rb') body = open_file.read() try: - api_response = api_instance.update_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body) + api_response = api_instance.update_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateCreditNoteAttachmentByFileName: %s\n" % e) @@ -38785,6 +42879,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -38868,6 +42982,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' expense_claim_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' curr_date = dateutil.parser.parse('2020-12-03T00:00:00Z') user = User( @@ -38889,7 +43004,7 @@

Usage and SDK Samples

expense_claims = [expense_claim]) try: - api_response = api_instance.update_expense_claim(xero_tenant_id, expense_claim_id, expenseClaims) + api_response = api_instance.update_expense_claim(xero_tenant_id, expense_claim_id, expenseClaims, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateExpenseClaim: %s\n" % e) @@ -38948,7 +43063,206 @@

Parameters

-
+
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+ + + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ + + + +
Body parameters
+ + + + + + + +
NameDescription
expenseClaims * +
+
+ + ExpenseClaims + +
+ +
+
+
+ Required +
+
+ +
+ +
+
+
+
+
+

updateInvoice

+

Updates a specific sales invoices or purchase bills

+
+
+
+

+

+

+
+ 
/Invoices/{InvoiceID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_invoice():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    invoice_id = '00000000-0000-0000-0000-000000000000'
+    idempotency_key = 'KEY_VALUE'
+    allow_backorders = 'true'
+
+    invoice = Invoice(
+        reference = "I am Iron man")
+
+    invoices = Invoices( 
+        invoices = [invoice])
+    
+    try:
+        api_response = api_instance.update_invoice(xero_tenant_id, invoice_id, invoices, unitdp, idempotency_key, allow_backorders)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->updateInvoice: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
InvoiceID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Unique identifier for an Invoice +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + -
NameDescription
xero-tenant-id* + + +
@@ -38967,154 +43281,11 @@

Parameters
-
Body parameters
- - - - - - - -
NameDescription
expenseClaims * -
-
- - ExpenseClaims - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateInvoice

-

Updates a specific sales invoices or purchase bills

-
-
-
-

-

-

-
- 
/Invoices/{InvoiceID}
-

-

Usage and SDK Samples

-

- -
- -
- 
# configure api_client for use with xero-python sdk client
-api_client = ApiClient(
-    Configuration(
-        debug=false,
-        oauth2_token=OAuth2Token(
-            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
-        ),
-    ),
-    pool_threads=1,
-)
-
-api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
-
-def accounting_update_invoice():
-    api_instance = AccountingApi(api_client)
-    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    invoice_id = '00000000-0000-0000-0000-000000000000'
-
-    invoice = Invoice(
-        reference = "I am Iron man")
-
-    invoices = Invoices( 
-        invoices = [invoice])
-    
-    try:
-        api_response = api_instance.update_invoice(xero_tenant_id, invoice_id, invoices, unitdp)
-        print(api_response)
-    except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->updateInvoice: %s\n" % e)
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - + - - -
NameDescription
InvoiceID*
Idempotency-Key -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Invoice -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - @@ -39163,7 +43331,15 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/Invoices" }, - "example" : "{ \"Invoices\": [{ Reference: \"May the force be with you\", \"InvoiceID\": \"00000000-0000-0000-0000-000000000000\", \"LineItems\": [], \"Contact\": {}, \"Type\": \"ACCPAY\" }]}" + "example" : { + "Invoices" : [ { + "Reference" : "May the force be with you", + "InvoiceID" : "00000000-0000-0000-0000-000000000000", + "LineItems" : [ ], + "Contact" : { }, + "Type" : "ACCPAY" + } ] + } } }, "required" : true @@ -39194,6 +43370,26 @@

Parameters

+ + + +
NameDescription
xero-tenant-id* - - -
+
@@ -39122,12 +43293,9 @@

Parameters
-Xero identifier for Tenant +This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
-
- Required -
allowBackorders + + +
+
+
+ + Boolean + + +
+Allows an invoice to be created even when one or more line items contain tracked inventory where the invoice quantity would cause the available quantity to go negative +
+
+
+
+
@@ -39241,13 +43437,14 @@

Usage and SDK Samples

xero_tenant_id = 'YOUR_XERO_TENANT_ID' invoice_id = '00000000-0000-0000-0000-000000000000' file_name = 'xero-dev.jpg' + idempotency_key = 'KEY_VALUE' path_to_upload = Path(__file__).resolve().parent.joinpath(fileName) open_file = open(path_to_upload, 'rb') body = open_file.read() try: - api_response = api_instance.update_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body) + api_response = api_instance.update_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateInvoiceAttachmentByFileName: %s\n" % e) @@ -39346,6 +43543,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -39429,6 +43646,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' item_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' item = Item( code = "ItemCode123", @@ -39438,7 +43656,7 @@

Usage and SDK Samples

items = [item]) try: - api_response = api_instance.update_item(xero_tenant_id, item_id, items, unitdp) + api_response = api_instance.update_item(xero_tenant_id, item_id, items, unitdp, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateItem: %s\n" % e) @@ -39514,6 +43732,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -39546,7 +43784,12 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/Items" }, - "example" : "{ \"Items\": [ { \"Code\": \"ItemCode123\", \"Description\": \"Description 123\" } ] }" + "example" : { + "Items" : [ { + "Code" : "ItemCode123", + "Description" : "Description 123" + } ] + } } }, "required" : true @@ -39623,6 +43866,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' linked_transaction_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' linked_transaction = LinkedTransaction( source_line_item_id = "00000000-0000-0000-0000-000000000000", @@ -39632,7 +43876,7 @@

Usage and SDK Samples

linked_transactions = [linked_transaction]) try: - api_response = api_instance.update_linked_transaction(xero_tenant_id, linked_transaction_id, linkedTransactions) + api_response = api_instance.update_linked_transaction(xero_tenant_id, linked_transaction_id, linkedTransactions, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateLinkedTransaction: %s\n" % e) @@ -39708,6 +43952,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -39740,7 +44004,12 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/LinkedTransactions" }, - "example" : "{ \"LinkedTransactions\": [ { \"SourceTransactionID\": \"00000000-0000-0000-0000-000000000000\", \"SourceLineItemID\": \"00000000-0000-0000-0000-000000000000\" } ] }" + "example" : { + "LinkedTransactions" : [ { + "SourceTransactionID" : "00000000-0000-0000-0000-000000000000", + "SourceLineItemID" : "00000000-0000-0000-0000-000000000000" + } ] + } } }, "required" : true @@ -39790,18 +44059,19 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' manual_journal_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' date_value = dateutil.parser.parse('2020-12-03T00:00:00Z') manual_journal_lines = [] credit = ManualJournalLine( - line_amount = 100.0, + line_amount = -100.0, account_code = "400", description = "Hello there") manual_journal_lines.append(credit) debit = ManualJournalLine( - line_amount = -100.0, + line_amount = 100.0, account_code = "120", description = "Hello there") manual_journal_lines.append(debit) @@ -39815,7 +44085,7 @@

Usage and SDK Samples

manual_journals = [manual_journal]) try: - api_response = api_instance.update_manual_journal(xero_tenant_id, manual_journal_id, manualJournals) + api_response = api_instance.update_manual_journal(xero_tenant_id, manual_journal_id, manualJournals, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateManualJournal: %s\n" % e) @@ -39891,6 +44161,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -39923,7 +44213,13 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/ManualJournals" }, - "example" : "{ \"ManualJournals\": [ { \"Narration\": \"Hello Xero\", \"ManualJournalID\": \"00000000-0000-0000-0000-000000000000\", \"JournalLines\": [] } ] }" + "example" : { + "ManualJournals" : [ { + "Narration" : "Hello Xero", + "ManualJournalID" : "00000000-0000-0000-0000-000000000000", + "JournalLines" : [ ] + } ] + } } }, "required" : true @@ -39974,13 +44270,14 @@

Usage and SDK Samples

xero_tenant_id = 'YOUR_XERO_TENANT_ID' manual_journal_id = '00000000-0000-0000-0000-000000000000' file_name = 'xero-dev.jpg' + idempotency_key = 'KEY_VALUE' path_to_upload = Path(__file__).resolve().parent.joinpath(fileName) open_file = open(path_to_upload, 'rb') body = open_file.read() try: - api_response = api_instance.update_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body) + api_response = api_instance.update_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateManualJournalAttachmentByFileName: %s\n" % e) @@ -40079,6 +44376,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -40162,6 +44479,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' summarize_errors = 'True' + idempotency_key = 'KEY_VALUE' contact = Contact( contact_id = "00000000-0000-0000-0000-000000000000") @@ -40188,7 +44506,7 @@

Usage and SDK Samples

bank_transactions = [bank_transaction]) try: - api_response = api_instance.update_or_create_bank_transactions(xero_tenant_id, bankTransactions, summarize_errors, unitdp) + api_response = api_instance.update_or_create_bank_transactions(xero_tenant_id, bankTransactions, summarize_errors, unitdp, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateOrCreateBankTransactions: %s\n" % e) @@ -40231,6 +44549,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -40263,7 +44601,23 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/BankTransactions" }, - "example" : "{ \"BankTransactions\": [ { \"Type\": \"SPEND\", \"Contact\": { \"ContactID\": \"00000000-0000-0000-0000-000000000000\" }, \"Lineitems\": [ { \"Description\": \"Foobar\", \"Quantity\": 1, \"UnitAmount\": 20, \"AccountCode\": \"400\" } ], \"BankAccount\": { \"Code\": \"088\" } } ] }" + "example" : { + "BankTransactions" : [ { + "Type" : "SPEND", + "Contact" : { + "ContactID" : "00000000-0000-0000-0000-000000000000" + }, + "Lineitems" : [ { + "Description" : "Foobar", + "Quantity" : 1, + "UnitAmount" : 20, + "AccountCode" : "400" + } ], + "BankAccount" : { + "Code" : "088" + } + } ] + } } }, "required" : true @@ -40360,6 +44714,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' summarize_errors = 'True' + idempotency_key = 'KEY_VALUE' phone = Phone( phone_number = "555-1212", @@ -40377,7 +44732,7 @@

Usage and SDK Samples

contacts = [contact]) try: - api_response = api_instance.update_or_create_contacts(xero_tenant_id, contacts, summarize_errors) + api_response = api_instance.update_or_create_contacts(xero_tenant_id, contacts, summarize_errors, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateOrCreateContacts: %s\n" % e) @@ -40420,6 +44775,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -40452,7 +44827,27 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/Contacts" }, - "example" : "{ \"Contacts\": [ { \"Name\": \"Bruce Banner\", \"EmailAddress\": \"hulk@avengers.com\", \"Phones\": [ { \"PhoneType\": \"MOBILE\", \"PhoneNumber\": \"555-1212\", \"PhoneAreaCode\": \"415\" } ], \"PaymentTerms\": { \"Bills\": { \"Day\": 15, \"Type\": \"OFCURRENTMONTH\" }, \"Sales\": { \"Day\": 10, \"Type\": \"DAYSAFTERBILLMONTH\" } } } ] }" + "example" : { + "Contacts" : [ { + "Name" : "Bruce Banner", + "EmailAddress" : "hulk@avengers.com", + "Phones" : [ { + "PhoneType" : "MOBILE", + "PhoneNumber" : "555-1212", + "PhoneAreaCode" : "415" + } ], + "PaymentTerms" : { + "Bills" : { + "Day" : 15, + "Type" : "OFCURRENTMONTH" + }, + "Sales" : { + "Day" : 10, + "Type" : "DAYSAFTERBILLMONTH" + } + } + } ] + } } }, "required" : true @@ -40529,6 +44924,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' summarize_errors = 'True' + idempotency_key = 'KEY_VALUE' curr_date = dateutil.parser.parse('2020-12-03T00:00:00Z') contact = Contact( @@ -40553,7 +44949,7 @@

Usage and SDK Samples

credit_notes = [credit_note]) try: - api_response = api_instance.update_or_create_credit_notes(xero_tenant_id, creditNotes, summarize_errors, unitdp) + api_response = api_instance.update_or_create_credit_notes(xero_tenant_id, creditNotes, summarize_errors, unitdp, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateOrCreateCreditNotes: %s\n" % e) @@ -40596,6 +44992,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -40629,7 +45045,23 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/CreditNotes" }, - "example" : "{ \"CreditNotes\":[ { \"Type\":\"ACCPAYCREDIT\", \"Contact\":{ \"ContactID\":\"430fa14a-f945-44d3-9f97-5df5e28441b8\" }, \"Date\":\"2019-01-05\", \"Status\":\"AUTHORISED\", \"Reference\": \"HelloWorld\", \"LineItems\":[ { \"Description\":\"Foobar\", \"Quantity\":2.0, \"UnitAmount\":20.0, \"AccountCode\":\"400\" } ] } ] }" + "example" : { + "CreditNotes" : [ { + "Type" : "ACCPAYCREDIT", + "Contact" : { + "ContactID" : "430fa14a-f945-44d3-9f97-5df5e28441b8" + }, + "Date" : "2019-01-05", + "Status" : "AUTHORISED", + "Reference" : "HelloWorld", + "LineItems" : [ { + "Description" : "Foobar", + "Quantity" : 2.0, + "UnitAmount" : 20.0, + "AccountCode" : "400" + } ] + } ] + } } }, "required" : true @@ -40680,168 +45112,6 @@

Parameters

- - - - - -
-
-
-
-

updateOrCreateEmployees

-

Creates a single new employees used in Xero payrun

-
-
-
-

-

-

-
- 
/Employees
-

-

Usage and SDK Samples

-

- -
- -
- 
# configure api_client for use with xero-python sdk client
-api_client = ApiClient(
-    Configuration(
-        debug=false,
-        oauth2_token=OAuth2Token(
-            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
-        ),
-    ),
-    pool_threads=1,
-)
-
-api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
-
-def accounting_update_or_create_employees():
-    api_instance = AccountingApi(api_client)
-    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    summarize_errors = 'True'
-
-    employee = Employee(
-        first_name = "Nick",
-        last_name = "Fury")
-
-    employees = Employees( 
-        employees = [employee])
-    
-    try:
-        api_response = api_instance.update_or_create_employees(xero_tenant_id, employees, summarize_errors)
-        print(api_response)
-    except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->updateOrCreateEmployees: %s\n" % e)
-
-
-

Scopes

- - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
employees * -
-
- - Employees - -
- Employees with array of Employee object in body of request -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - -
NameDescription
summarizeErrors - - -
-
-
- - Boolean - - -
-If false return 200 OK and mix of successfully created objects and any with validation errors -
-
-
-
-
@@ -40888,6 +45158,8 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' summarize_errors = 'True' + idempotency_key = 'KEY_VALUE' + allow_backorders = 'true' date_value = dateutil.parser.parse('2020-10-10T00:00:00Z') due_date_value = dateutil.parser.parse('2020-10-28T00:00:00Z') @@ -40916,7 +45188,7 @@

Usage and SDK Samples

invoices = [invoice]) try: - api_response = api_instance.update_or_create_invoices(xero_tenant_id, invoices, summarize_errors, unitdp) + api_response = api_instance.update_or_create_invoices(xero_tenant_id, invoices, summarize_errors, unitdp, idempotency_key, allow_backorders) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateOrCreateInvoices: %s\n" % e) @@ -40959,6 +45231,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -40991,7 +45283,26 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/Invoices" }, - "example" : "{ \"Invoices\": [ { \"Type\": \"ACCREC\", \"Contact\": { \"ContactID\": \"430fa14a-f945-44d3-9f97-5df5e28441b8\" }, \"LineItems\": [ { \"Description\": \"Acme Tires\", \"Quantity\": 2, \"UnitAmount\": 20, \"AccountCode\": \"200\", \"TaxType\": \"NONE\", \"LineAmount\": 40 } ], \"Date\": \"2019-03-11\", \"DueDate\": \"2018-12-10\", \"Reference\": \"Website Design\", \"Status\": \"AUTHORISED\" } ] }" + "example" : { + "Invoices" : [ { + "Type" : "ACCREC", + "Contact" : { + "ContactID" : "430fa14a-f945-44d3-9f97-5df5e28441b8" + }, + "LineItems" : [ { + "Description" : "Acme Tires", + "Quantity" : 2, + "UnitAmount" : 20, + "AccountCode" : "200", + "TaxType" : "NONE", + "LineAmount" : 40 + } ], + "Date" : "2019-03-11", + "DueDate" : "2018-12-10", + "Reference" : "Website Design", + "Status" : "AUTHORISED" + } ] + } } }, "required" : true @@ -41042,6 +45353,26 @@

Parameters

+ + + allowBackorders + + + +
+
+
+ + Boolean + + +
+Allows an invoice to be created even when one or more line items contain tracked inventory where the invoice quantity would cause the available quantity to go negative +
+
+
+
+ @@ -41088,6 +45419,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' summarize_errors = 'True' + idempotency_key = 'KEY_VALUE' item = Item( code = "abcXYZ123", @@ -41098,7 +45430,7 @@

Usage and SDK Samples

items = [item]) try: - api_response = api_instance.update_or_create_items(xero_tenant_id, items, summarize_errors, unitdp) + api_response = api_instance.update_or_create_items(xero_tenant_id, items, summarize_errors, unitdp, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateOrCreateItems: %s\n" % e) @@ -41141,6 +45473,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -41173,7 +45525,13 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/Items" }, - "example" : "{ \"Items\": [ { \"Code\": \"ItemCode123\", \"Name\": \"ItemName XYZ\", \"Description\": \"Item Description ABC\" } ] }" + "example" : { + "Items" : [ { + "Code" : "ItemCode123", + "Name" : "ItemName XYZ", + "Description" : "Item Description ABC" + } ] + } } }, "required" : true @@ -41270,18 +45628,19 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' summarize_errors = 'True' + idempotency_key = 'KEY_VALUE' date_value = dateutil.parser.parse('2020-12-03T00:00:00Z') manual_journal_lines = [] credit = ManualJournalLine( - line_amount = 100.0, + line_amount = -100.0, account_code = "400", description = "Hello there") manual_journal_lines.append(credit) debit = ManualJournalLine( - line_amount = -100.0, + line_amount = 100.0, account_code = "120", description = "Hello there") manual_journal_lines.append(debit) @@ -41295,7 +45654,7 @@

Usage and SDK Samples

manual_journals = [manual_journal]) try: - api_response = api_instance.update_or_create_manual_journals(xero_tenant_id, manualJournals, summarize_errors) + api_response = api_instance.update_or_create_manual_journals(xero_tenant_id, manualJournals, summarize_errors, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateOrCreateManualJournals: %s\n" % e) @@ -41338,6 +45697,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -41371,7 +45750,25 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/ManualJournals" }, - "example" : "{ \"ManualJournals\": [ { \"Narration\": \"Journal Desc\", \"JournalLines\": [ { \"LineAmount\": 100, \"AccountCode\": \"400\", \"Description\": \"Money Movement\" }, { \"LineAmount\": -100, \"AccountCode\": \"400\", \"Description\": \"Prepayment of things\", \"Tracking\": [ { \"Name\": \"North\", \"Option\": \"Region\" } ] } ], \"Date\": \"2019-03-14\" } ] }" + "example" : { + "ManualJournals" : [ { + "Narration" : "Journal Desc", + "JournalLines" : [ { + "LineAmount" : 100, + "AccountCode" : "400", + "Description" : "Money Movement" + }, { + "LineAmount" : -100, + "AccountCode" : "400", + "Description" : "Prepayment of things", + "Tracking" : [ { + "Name" : "North", + "Option" : "Region" + } ] + } ], + "Date" : "2019-03-14" + } ] + } } }, "required" : true @@ -41448,6 +45845,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' summarize_errors = 'True' + idempotency_key = 'KEY_VALUE' date_value = dateutil.parser.parse('2020-12-03T00:00:00Z') contact = Contact( @@ -41471,7 +45869,7 @@

Usage and SDK Samples

purchase_orders = [purchase_order]) try: - api_response = api_instance.update_or_create_purchase_orders(xero_tenant_id, purchaseOrders, summarize_errors) + api_response = api_instance.update_or_create_purchase_orders(xero_tenant_id, purchaseOrders, summarize_errors, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateOrCreatePurchaseOrders: %s\n" % e) @@ -41514,6 +45912,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -41546,7 +45964,20 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/PurchaseOrders" }, - "example" : "{ \"PurchaseOrders\": [ { \"Contact\": { \"ContactID\": \"00000000-0000-0000-0000-000000000000\" }, \"LineItems\": [ { \"Description\": \"Foobar\", \"Quantity\": 1, \"UnitAmount\": 20, \"AccountCode\": \"710\" } ], \"Date\": \"2019-03-13\" } ] }" + "example" : { + "PurchaseOrders" : [ { + "Contact" : { + "ContactID" : "00000000-0000-0000-0000-000000000000" + }, + "LineItems" : [ { + "Description" : "Foobar", + "Quantity" : 1, + "UnitAmount" : 20, + "AccountCode" : "710" + } ], + "Date" : "2019-03-13" + } ] + } } }, "required" : true @@ -41623,6 +46054,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' summarize_errors = 'True' + idempotency_key = 'KEY_VALUE' date_value = dateutil.parser.parse('2020-12-03T00:00:00Z') contact = Contact( @@ -41646,7 +46078,7 @@

Usage and SDK Samples

quotes = [quote]) try: - api_response = api_instance.update_or_create_quotes(xero_tenant_id, quotes, summarize_errors) + api_response = api_instance.update_or_create_quotes(xero_tenant_id, quotes, summarize_errors, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateOrCreateQuotes: %s\n" % e) @@ -41689,6 +46121,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -41721,7 +46173,20 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/Quotes" }, - "example" : "{ \"Quotes\": [ { \"Contact\": { \"ContactID\": \"00000000-0000-0000-0000-000000000000\" }, \"LineItems\": [ { \"Description\": \"Foobar\", \"Quantity\": 1, \"UnitAmount\": 20, \"AccountCode\": \"12775\" } ], \"Date\": \"2020-02-01\" } ] }" + "example" : { + "Quotes" : [ { + "Contact" : { + "ContactID" : "00000000-0000-0000-0000-000000000000" + }, + "LineItems" : [ { + "Description" : "Foobar", + "Quantity" : 1, + "UnitAmount" : 20, + "AccountCode" : "12775" + } ], + "Date" : "2020-02-01" + } ] + } } }, "required" : true @@ -41752,6 +46217,217 @@

Parameters

+ + + + + +
+
+
+
+

updateOrCreateRepeatingInvoices

+

Creates or deletes one or more repeating invoice templates

+
+
+
+

+

+

+
+ 
/RepeatingInvoices
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_or_create_repeating_invoices():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    summarize_errors = 'True'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_response = api_instance.update_or_create_repeating_invoices(xero_tenant_id, repeatingInvoices, summarize_errors, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->updateOrCreateRepeatingInvoices: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
repeatingInvoices * +
+
+ + RepeatingInvoices + +
+ RepeatingInvoices with an array of repeating invoice objects in body of request +
+
+
+ Required +
+
+ +
+
Query parameters
+ + + + + + +
NameDescription
summarizeErrors + + +
+
+
+ + Boolean + + +
+If false return 200 OK and mix of successfully created objects and any with validation errors +
+
+
+
+
@@ -41798,6 +46474,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' purchase_order_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' purchase_order = PurchaseOrder( attentionTo = "Peter Parker") @@ -41806,7 +46483,7 @@

Usage and SDK Samples

purchase_orders = [purchase_order]) try: - api_response = api_instance.update_purchase_order(xero_tenant_id, purchase_order_id, purchaseOrders) + api_response = api_instance.update_purchase_order(xero_tenant_id, purchase_order_id, purchaseOrders, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updatePurchaseOrder: %s\n" % e) @@ -41882,6 +46559,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -41914,7 +46611,13 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/PurchaseOrders" }, - "example" : "{ \"PurchaseOrders\": [ { \"AttentionTo\": \"Peter Parker\", \"LineItems\": [], \"Contact\": {} } ] }" + "example" : { + "PurchaseOrders" : [ { + "AttentionTo" : "Peter Parker", + "LineItems" : [ ], + "Contact" : { } + } ] + } } }, "required" : true @@ -41965,13 +46668,14 @@

Usage and SDK Samples

xero_tenant_id = 'YOUR_XERO_TENANT_ID' purchase_order_id = '00000000-0000-0000-0000-000000000000' file_name = 'xero-dev.jpg' + idempotency_key = 'KEY_VALUE' path_to_upload = Path(__file__).resolve().parent.joinpath(fileName) open_file = open(path_to_upload, 'rb') body = open_file.read() try: - api_response = api_instance.update_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body) + api_response = api_instance.update_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updatePurchaseOrderAttachmentByFileName: %s\n" % e) @@ -42070,6 +46774,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -42153,6 +46877,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' quote_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' date_value = dateutil.parser.parse('2020-12-03T00:00:00Z') contact = Contact( @@ -42167,7 +46892,7 @@

Usage and SDK Samples

quotes = [quote]) try: - api_response = api_instance.update_quote(xero_tenant_id, quote_id, quotes) + api_response = api_instance.update_quote(xero_tenant_id, quote_id, quotes, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateQuote: %s\n" % e) @@ -42243,6 +46968,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -42275,7 +47020,15 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/Quotes" }, - "example" : "{ \"Quotes\": [ { \"Reference\": \"I am an update\", \"Contact\": { \"ContactID\": \"00000000-0000-0000-0000-000000000000\" }, \"Date\": \"2020-02-01\" } ] }" + "example" : { + "Quotes" : [ { + "Reference" : "I am an update", + "Contact" : { + "ContactID" : "00000000-0000-0000-0000-000000000000" + }, + "Date" : "2020-02-01" + } ] + } } }, "required" : true @@ -42326,13 +47079,14 @@

Usage and SDK Samples

xero_tenant_id = 'YOUR_XERO_TENANT_ID' quote_id = '00000000-0000-0000-0000-000000000000' file_name = 'xero-dev.jpg' + idempotency_key = 'KEY_VALUE' path_to_upload = Path(__file__).resolve().parent.joinpath(fileName) open_file = open(path_to_upload, 'rb') body = open_file.read() try: - api_response = api_instance.update_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body) + api_response = api_instance.update_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateQuoteAttachmentByFileName: %s\n" % e) @@ -42431,6 +47185,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -42514,6 +47288,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' receipt_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' dateValue = dateutil.parser.parse('2020-10-10T00:00:00Z') user = User( @@ -42528,7 +47303,7 @@

Usage and SDK Samples

receipts = [receipt]) try: - api_response = api_instance.update_receipt(xero_tenant_id, receipt_id, receipts, unitdp) + api_response = api_instance.update_receipt(xero_tenant_id, receipt_id, receipts, unitdp, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateReceipt: %s\n" % e) @@ -42604,6 +47379,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -42636,7 +47431,15 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/Receipts" }, - "example" : "{ \"Receipts\": [ { \"Lineitems\": [], \"User\": { \"UserID\": \"00000000-0000-0000-0000-000000000000\" }, \"Reference\": \"Foobar\" } ] }" + "example" : { + "Receipts" : [ { + "Lineitems" : [ ], + "User" : { + "UserID" : "00000000-0000-0000-0000-000000000000" + }, + "Reference" : "Foobar" + } ] + } } }, "required" : true @@ -42714,13 +47517,14 @@

Usage and SDK Samples

xero_tenant_id = 'YOUR_XERO_TENANT_ID' receipt_id = '00000000-0000-0000-0000-000000000000' file_name = 'xero-dev.jpg' + idempotency_key = 'KEY_VALUE' path_to_upload = Path(__file__).resolve().parent.joinpath(fileName) open_file = open(path_to_upload, 'rb') body = open_file.read() try: - api_response = api_instance.update_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body) + api_response = api_instance.update_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateReceiptAttachmentByFileName: %s\n" % e) @@ -42819,6 +47623,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -42856,6 +47680,233 @@

Parameters

} }, "required" : true +} + + + + +
+
+
+
+

updateRepeatingInvoice

+

Deletes a specific repeating invoice template

+
+
+
+

+

+

+
+ 
/RepeatingInvoices/{RepeatingInvoiceID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_repeating_invoice():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    repeating_invoice_id = '00000000-0000-0000-0000-000000000000'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_response = api_instance.update_repeating_invoice(xero_tenant_id, repeating_invoice_id, repeatingInvoices, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->updateRepeatingInvoice: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
RepeatingInvoiceID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Unique identifier for a Repeating Invoice +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
repeatingInvoices * +
+
+ + RepeatingInvoices + +
+ +
+
+
+ Required +
+
+
@@ -42903,13 +47954,14 @@

Usage and SDK Samples

xero_tenant_id = 'YOUR_XERO_TENANT_ID' repeating_invoice_id = '00000000-0000-0000-0000-000000000000' file_name = 'xero-dev.jpg' + idempotency_key = 'KEY_VALUE' path_to_upload = Path(__file__).resolve().parent.joinpath(fileName) open_file = open(path_to_upload, 'rb') body = open_file.read() try: - api_response = api_instance.update_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body) + api_response = api_instance.update_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateRepeatingInvoiceAttachmentByFileName: %s\n" % e) @@ -43008,6 +48060,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -43090,6 +48162,7 @@

Usage and SDK Samples

def accounting_update_tax_rate(): api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' + idempotency_key = 'KEY_VALUE' tax_component = TaxComponent( name = "State Tax", @@ -43106,7 +48179,7 @@

Usage and SDK Samples

tax_rates = [tax_rate]) try: - api_response = api_instance.update_tax_rate(xero_tenant_id, taxRates) + api_response = api_instance.update_tax_rate(xero_tenant_id, taxRates, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateTaxRate: %s\n" % e) @@ -43149,6 +48222,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -43181,7 +48274,17 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/TaxRates" }, - "example" : "{ \"TaxRates\": [ { \"Name\": \"State Tax NY\", \"TaxComponents\": [ { \"Name\": \"State Tax\", \"Rate\": 2.25 } ], \"Status\": \"DELETED\", \"ReportTaxType\": \"INPUT\" } ] }" + "example" : { + "TaxRates" : [ { + "Name" : "State Tax NY", + "TaxComponents" : [ { + "Name" : "State Tax", + "Rate" : 2.25 + } ], + "Status" : "DELETED", + "ReportTaxType" : "INPUT" + } ] + } } }, "required" : true @@ -43231,12 +48334,13 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' tracking_category_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' trackingCategory = TrackingCategory( name = "Foobar") try: - api_response = api_instance.update_tracking_category(xero_tenant_id, tracking_category_id, trackingCategory) + api_response = api_instance.update_tracking_category(xero_tenant_id, tracking_category_id, trackingCategory, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateTrackingCategory: %s\n" % e) @@ -43312,6 +48416,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -43344,7 +48468,9 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/TrackingCategory" }, - "example" : "{ \"Name\": \"Avengers\" }" + "example" : { + "Name" : "Avengers" + } } }, "required" : true @@ -43395,12 +48521,13 @@

Usage and SDK Samples

xero_tenant_id = 'YOUR_XERO_TENANT_ID' tracking_category_id = '00000000-0000-0000-0000-000000000000' tracking_option_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' trackingOption = TrackingOption( name = "Foobar") try: - api_response = api_instance.update_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id, trackingOption) + api_response = api_instance.update_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id, trackingOption, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateTrackingOptions: %s\n" % e) @@ -43502,6 +48629,26 @@

Parameters

+ + + Idempotency-Key + + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+ @@ -43534,7 +48681,9 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/TrackingOption" }, - "example" : "{ name: \"Vision\" }" + "example" : { + "name" : "Vision" + } } }, "required" : true diff --git a/docs/v1/appstore/index.html b/docs/v1/appstore/index.html new file mode 100644 index 00000000..2cc515de --- /dev/null +++ b/docs/v1/appstore/index.html @@ -0,0 +1,3620 @@ + + + + + Xero AppStore API + + + + + + xero-python AppStore SDK Docs + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ + +
+
+ +
+
+ +
+
+
+
+
+ +
+
+
+
+

Xero AppStore API

+
+
+
+ +
+
+

AppStore

+
+
+
+

getSubscription

+

Retrieves a subscription for a given subscriptionId

+
+
+
+

+

+

+
+ 
/subscriptions/{subscriptionId}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_subscription():
+    api_instance = AppStoreApi(api_client)
+    subscription_id = '00000000-0000-0000-0000-000000000000'
+    
+    try:
+        api_response = api_instance.get_subscription(subscription_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AppStoreApi->getSubscription: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
marketplace.billingGrant read-only access to fixed assets
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
subscriptionId* + + +
+
+
+ + UUID + + + (uuid) + + +
+Unique identifier for Subscription object +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getUsageRecords

+

Gets all usage records related to the subscription

+
+
+
+

+

+

+
+ 
/subscriptions/{subscriptionId}/usage-records
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_usage_records():
+    api_instance = AppStoreApi(api_client)
+    subscription_id = '00000000-0000-0000-0000-000000000000'
+    
+    try:
+        api_response = api_instance.get_usage_records(subscription_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AppStoreApi->getUsageRecords: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
marketplace.billingGrant read-only access to fixed assets
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
subscriptionId* + + +
+
+
+ + UUID + + + (uuid) + + +
+Unique identifier for Subscription object +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

postUsageRecords

+

Send metered usage belonging to this subscription and subscription item

+
+
+
+

+

+

+
+ 
/subscriptions/{subscriptionId}/items/{subscriptionItemId}/usage-records
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_post_usage_records():
+    api_instance = AppStoreApi(api_client)
+    subscription_id = '00000000-0000-0000-0000-000000000000'
+    subscription_item_id = '00000000-0000-0000-0000-000000000000'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_response = api_instance.post_usage_records(subscription_id, subscription_item_id, createUsageRecord, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AppStoreApi->postUsageRecords: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
marketplace.billingGrant read-only access to fixed assets
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
subscriptionId* + + +
+
+
+ + UUID + + + (uuid) + + +
+Unique identifier for Subscription object +
+
+
+ Required +
+
+
+
subscriptionItemId* + + +
+
+
+ + UUID + + + (uuid) + + +
+The unique identifier of the subscriptionItem +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
createUsageRecord * +
+
+ + CreateUsageRecord + +
+ Contains the quantity for the usage record to create +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

putUsageRecords

+

Update and existing metered usage belonging to this subscription and subscription item

+
+
+
+

+

+

+
+ 
/subscriptions/{subscriptionId}/items/{subscriptionItemId}/usage-records/{usageRecordId}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_put_usage_records():
+    api_instance = AppStoreApi(api_client)
+    subscription_id = '00000000-0000-0000-0000-000000000000'
+    subscription_item_id = '00000000-0000-0000-0000-000000000000'
+    usage_record_id = '00000000-0000-0000-0000-000000000000'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_response = api_instance.put_usage_records(subscription_id, subscription_item_id, usage_record_id, updateUsageRecord, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AppStoreApi->putUsageRecords: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
marketplace.billingGrant read-only access to fixed assets
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + + + + + +
NameDescription
subscriptionId* + + +
+
+
+ + UUID + + + (uuid) + + +
+Unique identifier for Subscription object +
+
+
+ Required +
+
+
+
subscriptionItemId* + + +
+
+
+ + UUID + + + (uuid) + + +
+The unique identifier of the subscriptionItem +
+
+
+ Required +
+
+
+
usageRecordId* + + +
+
+
+ + UUID + + + (uuid) + + +
+The unique identifier of the usage record +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
updateUsageRecord * +
+
+ + UpdateUsageRecord + +
+ Contains the quantity for the usage record to update +
+
+
+ Required +
+
+ +
+
+
+
+
+
+ +
+
+
+ + + + + + + + + + + + + + diff --git a/docs/v1/assets/index.html b/docs/v1/assets/index.html new file mode 100644 index 00000000..0d2a3f99 --- /dev/null +++ b/docs/v1/assets/index.html @@ -0,0 +1,4110 @@ + + + + + Xero Assets API + + + + + + xero-python Asset SDK Docs + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ + +
+
+ +
+
+ +
+
+
+
+
+ +
+
+
+
+

Xero Assets API

+
+
+
+ +
+
+

Asset

+
+
+
+

createAsset

+

adds a fixed asset

+
+
+
+

+

Adds an asset to the system

+

+
+ 
/Assets
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_asset():
+    api_instance = AssetApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    idempotency_key = 'KEY_VALUE'
+
+    asset = Asset(
+        asset_name = "Other Computer",
+        asset_number = "FA-00210",
+        status = "Draft")
+    
+    try:
+        api_response = api_instance.create_asset(xero_tenant_id, asset, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AssetApi->createAsset: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
assetsGrant read-write access to fixed assets
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
asset * +
+
+ + Asset + +
+ Fixed asset you are creating +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createAssetType

+

adds a fixed asset type

+
+
+
+

+

Adds an fixed asset type to the system

+

+
+ 
/AssetTypes
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_asset_type():
+    api_instance = AssetApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    idempotency_key = 'KEY_VALUE'
+
+    book_depreciation_setting = BookDepreciationSetting(
+        depreciation_method = "DiminishingValue100",
+        averaging_method = "ActualDays",
+        deprecitation_rate = 40,
+        depreciation_calculation_method = "None")
+
+    asset_type = AssetType(
+        asset_type_name = "Computer Equipment",
+        fixed_asset_account_id = "00000000-0000-0000-0000-000000000000",
+        depreciation_expense_account_id = "00000000-0000-0000-0000-000000000000",
+        accumulated_depreciation_account_id = "00000000-0000-0000-0000-000000000000",
+        book_depreciation_setting = book_depreciation_setting)
+    
+    try:
+        api_response = api_instance.create_asset_type(xero_tenant_id, assetType, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AssetApi->createAssetType: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
assetsGrant read-write access to fixed assets
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
assetType * +
+
+ + AssetType + +
+ Asset type to add +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

getAssetById

+

Retrieves fixed asset by id

+
+
+
+

+

By passing in the appropriate asset id, you can search for +a specific fixed asset in the system

+

+
+ 
/Assets/{id}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_asset_by_id():
+    api_instance = AssetApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    id = '00000000-0000-0000-0000-000000000000'
+    
+    try:
+        api_response = api_instance.get_asset_by_id(xero_tenant_id, id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AssetApi->getAssetById: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
assetsGrant read-write access to fixed assets
assets.readGrant read-only access to fixed assets
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
id* + + +
+
+
+ + UUID + + + (uuid) + + +
+fixed asset id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getAssetSettings

+

searches fixed asset settings

+
+
+
+

+

By passing in the appropriate options, you can search for available fixed asset types in the system

+

+
+ 
/Settings
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_asset_settings():
+    api_instance = AssetApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    
+    try:
+        api_response = api_instance.get_asset_settings(xero_tenant_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AssetApi->getAssetSettings: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
assetsGrant read-write access to fixed assets
assets.readGrant read-only access to fixed assets
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getAssetTypes

+

searches fixed asset types

+
+
+
+

+

By passing in the appropriate options, you can search for available fixed asset types in the system

+

+
+ 
/AssetTypes
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_asset_types():
+    api_instance = AssetApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    
+    try:
+        api_response = api_instance.get_asset_types(xero_tenant_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AssetApi->getAssetTypes: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
assetsGrant read-write access to fixed assets
assets.readGrant read-only access to fixed assets
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getAssets

+

searches fixed asset

+
+
+
+

+

By passing in the appropriate options, you can search for available fixed asset in the system

+

+
+ 
/Assets
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_assets():
+    api_instance = AssetApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    order_by = 'AssetName'
+    sort_direction = 'ASC'
+    filter_by = 'Company Car'
+    
+    try:
+        api_response = api_instance.get_assets(xero_tenant_id, status, page, page_size, order_by, sort_direction, filter_by)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AssetApi->getAssets: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
assetsGrant read-write access to fixed assets
assets.readGrant read-only access to fixed assets
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription
status* + + +
+
+
+ + AssetStatusQueryParam + + +
+Required when retrieving a collection of assets. See Asset Status Codes +
+
+
+ Required +
+
+
+
page + + +
+
+
+ + Integer + + +
+Results are paged. This specifies which page of the results to return. The default page is 1. +
+
+
+
+
pageSize + + +
+
+
+ + Integer + + +
+The number of records returned per page. By default the number of records returned is 10. +
+
+
+
+
orderBy + + +
+
+
+ + String + + +
+Requests can be ordered by AssetType, AssetName, AssetNumber, PurchaseDate and PurchasePrice. If the asset status is DISPOSED it also allows DisposalDate and DisposalPrice. +
+
+
+
+
sortDirection + + +
+
+
+ + String + + +
+ASC or DESC +
+
+
+
+
filterBy + + +
+
+
+ + String + + +
+A string that can be used to filter the list to only return assets containing the text. Checks it against the AssetName, AssetNumber, Description and AssetTypeName fields. +
+
+
+
+
+
+
+
+
+
+ +
+
+
+ + + + + + + + + + + + + + diff --git a/docs/v1/files/index.html b/docs/v1/files/index.html new file mode 100644 index 00000000..0aecdb04 --- /dev/null +++ b/docs/v1/files/index.html @@ -0,0 +1,5824 @@ + + + + + Xero Files API + + + + + + xero-python Files SDK Docs + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ + +
+
+ +
+
+ +
+
+
+
+ +
+
+
+

Xero Files API

+
+
+
+ +
+
+

Files

+
+
+
+

createFileAssociation

+

Creates a new file association

+
+
+
+

+

By passing in the appropriate options, you can create a new folder

+

+
+ 
/Files/{FileId}/Associations
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_file_association():
+    api_instance = FilesApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_response = api_instance.create_file_association(xero_tenant_id, file_id, association, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling FilesApi->createFileAssociation: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
filesGrant read-write access to files and folders
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
FileId* + + +
+
+
+ + UUID + + + (uuid) + + +
+File id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
association * +
+
+ + Association + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createFolder

+

Creates a new folder

+
+
+
+

+

By passing in the appropriate properties, you can create a new folder

+

+
+ 
/Folders
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_folder():
+    api_instance = FilesApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_response = api_instance.create_folder(xero_tenant_id, folder, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling FilesApi->createFolder: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
filesGrant read-write access to files and folders
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
folder * +
+
+ + Folder + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

deleteFile

+

Deletes a specific file

+
+
+
+

+

Delete a specific file

+

+
+ 
/Files/{FileId}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_file():
+    api_instance = FilesApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_instance.delete_file(xero_tenant_id, file_id)
+    except AccountingBadRequestException as e:
+        print("Exception when calling FilesApi->deleteFile: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
filesGrant read-write access to files and folders
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
FileId* + + +
+
+
+ + UUID + + + (uuid) + + +
+File id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

deleteFileAssociation

+

Deletes an existing file association

+
+
+
+

+

By passing in the appropriate options, you can create a new folder

+

+
+ 
/Files/{FileId}/Associations/{ObjectId}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_file_association():
+    api_instance = FilesApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    object_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_instance.delete_file_association(xero_tenant_id, file_id, object_id)
+    except AccountingBadRequestException as e:
+        print("Exception when calling FilesApi->deleteFileAssociation: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
filesGrant read-write access to files and folders
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
FileId* + + +
+
+
+ + UUID + + + (uuid) + + +
+File id for single object +
+
+
+ Required +
+
+
+
ObjectId* + + +
+
+
+ + UUID + + + (uuid) + + +
+Object id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

deleteFolder

+

Deletes a folder

+
+
+
+

+

By passing in the appropriate ID, you can delete a folder

+

+
+ 
/Folders/{FolderId}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_folder():
+    api_instance = FilesApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    folder_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_instance.delete_folder(xero_tenant_id, folder_id)
+    except AccountingBadRequestException as e:
+        print("Exception when calling FilesApi->deleteFolder: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
filesGrant read-write access to files and folders
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
FolderId* + + +
+
+
+ + UUID + + + (uuid) + + +
+Folder id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getAssociationsByObject

+

Retrieves an association object using a unique object ID

+
+
+
+

+

By passing in the appropriate options, you can retrieve an association

+

+
+ 
/Associations/{ObjectId}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_associations_by_object():
+    api_instance = FilesApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    object_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    sort = 'Associations/{ObjectId}?sort=CreatedDateUtc'
+    direction = 'Associations/{ObjectId}?sort=CreatedDateUtc&direction=DESC'
+    
+    try:
+        api_response = api_instance.get_associations_by_object(xero_tenant_id, object_id, pagesize, page, sort, direction)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling FilesApi->getAssociationsByObject: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
filesGrant read-write access to files and folders
files.readGrant read-only access to files and folders
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
ObjectId* + + +
+
+
+ + UUID + + + (uuid) + + +
+Object id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + + + + + + + + + + + + + +
NameDescription
pagesize + + +
+
+
+ + Integer + + +
+pass an optional page size value +
+
+
+
+
page + + +
+
+
+ + Integer + + +
+number of records to skip for pagination +
+
+
+
+
sort + + +
+
+
+ + String + + +
+values to sort by +
+
+
+
+
direction + + +
+
+
+ + String + + +
+direction to sort by +
+
+
+
+
+
+
+
+
+
+
+

getAssociationsCount

+

Retrieves a count of associations for a list of objects.

+
+
+
+

+

By passing in the appropriate options, you can retrieve the association count for objects

+

+
+ 
/Associations/Count
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_associations_count():
+    api_instance = FilesApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    objectIds = []
+    
+    try:
+        api_response = api_instance.get_associations_count(xero_tenant_id, objectIds)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling FilesApi->getAssociationsCount: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
filesGrant read-write access to files and folders
files.readGrant read-only access to files and folders
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + +
NameDescription
ObjectIds* + + +
+
+
+ + array[UUID] + + + (uuid) + + +
+A comma-separated list of object ids +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getFile

+

Retrieves a file by a unique file ID

+
+
+
+

+

+

+
+ 
/Files/{FileId}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_file():
+    api_instance = FilesApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_file(xero_tenant_id, file_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling FilesApi->getFile: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
filesGrant read-write access to files and folders
files.readGrant read-only access to files and folders
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
FileId* + + +
+
+
+ + UUID + + + (uuid) + + +
+File id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getFileAssociations

+

Retrieves a specific file associations

+
+
+
+

+

By passing in the appropriate options,

+

+
+ 
/Files/{FileId}/Associations
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_file_associations():
+    api_instance = FilesApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_file_associations(xero_tenant_id, file_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling FilesApi->getFileAssociations: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
filesGrant read-write access to files and folders
files.readGrant read-only access to files and folders
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
FileId* + + +
+
+
+ + UUID + + + (uuid) + + +
+File id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getFileContent

+

Retrieves the content of a specific file

+
+
+
+

+

By passing in the appropriate options, retrieve data for specific file

+

+
+ 
/Files/{FileId}/Content
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_file_content():
+    api_instance = FilesApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_file_content(xero_tenant_id, file_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling FilesApi->getFileContent: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
filesGrant read-write access to files and folders
files.readGrant read-only access to files and folders
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
FileId* + + +
+
+
+ + UUID + + + (uuid) + + +
+File id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getFiles

+

Retrieves files

+
+
+
+

+

+

+
+ 
/Files
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_files():
+    api_instance = FilesApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    sort = 'CreatedDateUTC'
+    direction = 'ASC'
+    
+    try:
+        api_response = api_instance.get_files(xero_tenant_id, pagesize, page, sort, direction)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling FilesApi->getFiles: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
filesGrant read-write access to files and folders
files.readGrant read-only access to files and folders
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + + + + + + + + + + + + + +
NameDescription
pagesize + + +
+
+
+ + Integer + + +
+pass an optional page size value +
+
+
+
+
page + + +
+
+
+ + Integer + + +
+number of records to skip for pagination +
+
+
+
+
sort + + +
+
+
+ + String + + +
+values to sort by +
+
+
+
+
direction + + +
+
+
+ + String + + +
+sort direction +
+
+
+
+
+
+
+
+
+
+
+

getFolder

+

Retrieves specific folder by using a unique folder ID

+
+
+
+

+

By passing in the appropriate ID, you can search for specific folder

+

+
+ 
/Folders/{FolderId}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_folder():
+    api_instance = FilesApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    folder_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_folder(xero_tenant_id, folder_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling FilesApi->getFolder: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
filesGrant read-write access to files and folders
files.readGrant read-only access to files and folders
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
FolderId* + + +
+
+
+ + UUID + + + (uuid) + + +
+Folder id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getFolders

+

Retrieves folders

+
+
+
+

+

By passing in the appropriate options, you can search for available folders

+

+
+ 
/Folders
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_folders():
+    api_instance = FilesApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    sort = 'CreatedDateUTC DESC'
+    
+    try:
+        api_response = api_instance.get_folders(xero_tenant_id, sort)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling FilesApi->getFolders: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
filesGrant read-write access to files and folders
files.readGrant read-only access to files and folders
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + +
NameDescription
sort + + +
+
+
+ + String + + +
+values to sort by +
+
+
+
+
+
+
+
+
+
+
+

getInbox

+

Retrieves inbox folder

+
+
+
+

+

Search for the user inbox

+

+
+ 
/Inbox
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_inbox():
+    api_instance = FilesApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    
+    try:
+        api_response = api_instance.get_inbox(xero_tenant_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling FilesApi->getInbox: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
filesGrant read-write access to files and folders
files.readGrant read-only access to files and folders
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

updateFile

+

Update a file

+
+
+
+

+

Updates file properties of a single file

+

+
+ 
/Files/{FileId}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_file():
+    api_instance = FilesApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_response = api_instance.update_file(xero_tenant_id, file_id, fileObject, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling FilesApi->updateFile: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
filesGrant read-write access to files and folders
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
FileId* + + +
+
+
+ + UUID + + + (uuid) + + +
+File id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
fileObject * +
+
+ + FileObject + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

updateFolder

+

Updates an existing folder

+
+
+
+

+

By passing in the appropriate ID and properties, you can update a folder

+

+
+ 
/Folders/{FolderId}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_folder():
+    api_instance = FilesApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    folder_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_response = api_instance.update_folder(xero_tenant_id, folder_id, folder, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling FilesApi->updateFolder: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
filesGrant read-write access to files and folders
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
FolderId* + + +
+
+
+ + UUID + + + (uuid) + + +
+Folder id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
folder * +
+
+ + Folder + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

uploadFile

+

Uploads a File to the inbox

+
+
+
+

+

+

+
+ 
/Files
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_upload_file():
+    api_instance = FilesApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    name = 'name_example'
+    filename = 'filename_example'
+    idempotency_key = 'KEY_VALUE'
+    mimeType = 'mimeType_example'
+    
+    try:
+        api_response = api_instance.upload_file(xero_tenant_id, body, name, filename, idempotency_key, mimeType)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling FilesApi->uploadFile: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
filesGrant read-write access to files and folders
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Form parameters
+ + + + + + + + + + + + + + + + + + + + + +
NameDescription
body* + + +
+
+
+ + byte[] + + + (byte) + + +
+ +
+
+
+ Required +
+
+
+
name* + + +
+
+
+ + String + + +
+exact name of the file you are uploading +
+
+
+ Required +
+
+
+
filename* + + +
+
+
+ + String + + +
+ +
+
+
+ Required +
+
+
+
mimeType + + +
+
+
+ + String + + +
+ +
+
+
+
+
+
+
+
+
+
+
+

uploadFileToFolder

+

Uploads a File to a specific folder

+
+
+
+

+

+

+
+ 
/Files/{FolderId}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_upload_file_to_folder():
+    api_instance = FilesApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    folder_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    name = 'name_example'
+    filename = 'filename_example'
+    idempotency_key = 'KEY_VALUE'
+    mimeType = 'mimeType_example'
+    
+    try:
+        api_response = api_instance.upload_file_to_folder(xero_tenant_id, folder_id, body, name, filename, idempotency_key, mimeType)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling FilesApi->uploadFileToFolder: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
filesGrant read-write access to files and folders
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
FolderId* + + +
+
+
+ + UUID + + + (uuid) + + +
+pass required folder id to save file to specific folder +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Form parameters
+ + + + + + + + + + + + + + + + + + + + + +
NameDescription
body* + + +
+
+
+ + byte[] + + + (byte) + + +
+ +
+
+
+ Required +
+
+
+
name* + + +
+
+
+ + String + + +
+exact name of the file you are uploading +
+
+
+ Required +
+
+
+
filename* + + +
+
+
+ + String + + +
+ +
+
+
+ Required +
+
+
+
mimeType + + +
+
+
+ + String + + +
+ +
+
+
+
+
+
+
+
+
+
+ +
+
+
+ + + + + + + + + + + + + + diff --git a/docs/v1/finance/index.html b/docs/v1/finance/index.html new file mode 100644 index 00000000..2066001b --- /dev/null +++ b/docs/v1/finance/index.html @@ -0,0 +1,5480 @@ + + + + + Xero Finance API + + + + + + xero-python Finance SDK Docs + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ + +
+
+ +
+
+ +
+
+
+
+ +
+
+
+

Xero Finance API

+
+
+
+ +
+
+

Finance

+
+
+
+

getBankStatementAccounting

+

Get Bank Statement Accounting

+
+
+
+

+

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.

+

+
+ 
/BankStatementsPlus/statements
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_bank_statement_accounting():
+    api_instance = FinanceApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    bank_account_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    from_date = '2020-07-01'
+    to_date = '2021-06-30'
+    summary_only = 'True'
+    
+    try:
+        api_response = api_instance.get_bank_statement_accounting(xero_tenant_id, bank_account_id, from_date, to_date, summary_only)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling FinanceApi->getBankStatementAccounting: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
finance.bankstatementsplus.readGrant read-only access to bank statements accounting data
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + + + + + + + + + + + + + +
NameDescription
BankAccountID* + + +
+
+
+ + UUID + + + (uuid) + + +
+

string, GUID

+

Bank account Id

+ +
+
+
+ Required +
+
+
+
FromDate* + + +
+
+
+ + String + + +
+

date, yyyy-MM-dd

+

Specifies the start date of the query period. +The maximum range of the query period is 12 months. If the specified query period is more than 12 months the request will be rejected.

+ +
+
+
+ Required +
+
+
+
ToDate* + + +
+
+
+ + String + + +
+

date, yyyy-MM-dd

+

Specifies the end date of the query period. +If the end date is a future date, the request will be rejected.

+ +
+
+
+ Required +
+
+
+
SummaryOnly + + +
+
+
+ + Boolean + + +
+

boolean, true/false

+

The default value is true if no parameter is provided.

+

In summary mode, the response will exclude the computation-heavy LineItems fields from bank transaction, invoice, credit note, prepayment and overpayment data, making the API calls quicker and more efficient.

+ +
+
+
+
+
+
+
+
+
+
+
+

getCashValidation

+

Get cash validation

+
+
+
+

+

Summarizes the total cash position for each account for an org

+

+
+ 
/CashValidation
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_cash_validation():
+    api_instance = FinanceApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    balance_date = '2021-09-15'
+    as_at_system_date = '2021-09-15'
+    begin_date = '2021-09-15'
+    
+    try:
+        api_response = api_instance.get_cash_validation(xero_tenant_id, balance_date, as_at_system_date, begin_date)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling FinanceApi->getCashValidation: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
finance.cashvalidation.readGrant read-only access to bank statement and reconcilation data
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + + + + + + + + + +
NameDescription
balanceDate + + +
+
+
+ + String + + +
+

date, yyyy-MM-dd

+

If no parameter is provided, the current date will be used.

+

The ‘balance date’ will return transactions based on the accounting date entered by the user. Transactions before the balanceDate will be included. +The user has discretion as to which accounting period the transaction relates to.

+

The ‘balance date’ will control the latest maximum date of transactions included in the aggregate numbers. Balance date does not affect the CurrentStatement object, as this will always return the most recent statement before asAtSystemDate (if specified)

+ +
+
+
+
+
asAtSystemDate + + +
+
+
+ + String + + +
+

date, yyyy-MM-dd

+

If no parameter is provided, the current date will be used.

+

The ‘as at’ date will return transactions based on the creation date. It reflects the date the transactions were entered into Xero, not the accounting date. +The ‘as at’ date can not be overridden by the user. This can be used to estimate a ‘historical frequency of reconciliation’.

+

The ‘as at’ date will affect the current statement in the response, as any candidate statements created after this date will be filtered out. Thus the current statement returned will be the most recent statement prior to the specified ‘as at’ date. Be aware that neither the begin date, nor the balance date, will affect the current statement.

+

Note; information is only presented when system architecture allows, meaning historical cash validation information will be an estimate. In addition, delete events are not aware of the ‘as at’ functionality in this endpoint, meaning that transactions deleted at the time the API is accessed will be considered to always have been deleted.

+ +
+
+
+
+
beginDate + + +
+
+
+ + String + + +
+

date, yyyy-MM-dd

+

If no parameter is provided, the aggregate results will be drawn from the user’s total history.

+

The ‘begin date’ will return transactions based on the accounting date entered by the user. Transactions after the beginDate will be included. +The user has discretion as to which accounting period the transaction relates to.

+ +
+
+
+
+
+
+
+
+
+
+
+

getFinancialStatementBalanceSheet

+

Get Balance Sheet report

+
+
+
+

+

The balance sheet report is a standard financial report which describes the financial position of an organisation at a point in time.

+

+
+ 
/FinancialStatements/BalanceSheet
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_financial_statement_balance_sheet():
+    api_instance = FinanceApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    balance_date = '2020-06-30'
+    
+    try:
+        api_response = api_instance.get_financial_statement_balance_sheet(xero_tenant_id, balance_date)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling FinanceApi->getFinancialStatementBalanceSheet: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
finance.statements.readGrant read-only access to finacial statements
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + +
NameDescription
balanceDate + + +
+
+
+ + String + + +
+

Specifies the date for balance sheet report.

+

Format yyyy-MM-dd. If no parameter is provided, the current date will be used.

+ +
+
+
+
+
+
+
+
+
+
+
+

getFinancialStatementCashflow

+

Get Cash flow report

+
+
+
+

+

The statement of cash flows - direct method, provides the year to date changes in operating, financing and investing cash flow activities for an organisation. Cashflow statement is not available in US region at this stage.

+

+
+ 
/FinancialStatements/Cashflow
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_financial_statement_cashflow():
+    api_instance = FinanceApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    start_date = '2020-09-15'
+    end_date = '2021-09-15'
+    
+    try:
+        api_response = api_instance.get_financial_statement_cashflow(xero_tenant_id, start_date, end_date)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling FinanceApi->getFinancialStatementCashflow: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
finance.statements.readGrant read-only access to finacial statements
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + + + + + +
NameDescription
startDate + + +
+
+
+ + String + + +
+

Date e.g. yyyy-MM-dd

+

Specifies the start date for cash flow report.

+

If no parameter is provided, the date of 12 months before the end date will be used.

+ +
+
+
+
+
endDate + + +
+
+
+ + String + + +
+

Date e.g. yyyy-MM-dd

+

Specifies the end date for cash flow report.

+

If no parameter is provided, the current date will be used.

+ +
+
+
+
+
+
+
+
+
+
+
+

getFinancialStatementContactsExpense

+

Get expense by contacts report

+
+
+
+

+

The expense by contact report provides a year to date profit and loss for customers and suppliers for a given organisation, including detailed contact information.

+

+
+ 
/FinancialStatements/contacts/expense
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_financial_statement_contacts_expense():
+    api_instance = FinanceApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    contact_ids = [["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000000"]]
+    include_manual_journals = 'True'
+    start_date = '2020-09-15'
+    end_date = '2020-09-15'
+    
+    try:
+        api_response = api_instance.get_financial_statement_contacts_expense(xero_tenant_id, contact_ids, include_manual_journals, start_date, end_date)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling FinanceApi->getFinancialStatementContactsExpense: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
finance.statements.readGrant read-only access to finacial statements
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + + + + + + + + + + + + + +
NameDescription
contactIds + + +
+
+
+ + array[UUID] + + + (uuid) + + +
+

Specifies the customer contacts to be included in the report.

+

If no parameter is provided, all customer contacts will be included

+ +
+
+
+
+
includeManualJournals + + +
+
+
+ + Boolean + + +
+

Specifies whether to include the manual journals in the report.

+

If no parameter is provided, manual journals will not be included.

+ +
+
+
+
+
startDate + + +
+
+
+ + String + + +
+

Date yyyy-MM-dd

+

Specifies the start date for the report.

+

If no parameter is provided, the date of 12 months before the end date will be used.

+

It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.

+ +
+
+
+
+
endDate + + +
+
+
+ + String + + +
+

Date yyyy-MM-dd

+

Specifies the end date for the report.

+

If no parameter is provided, the current date will be used.

+

It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.

+ +
+
+
+
+
+
+
+
+
+
+
+

getFinancialStatementContactsRevenue

+

Get revenue by contacts report

+
+
+
+

+

The revenue by contact report provides a year to date profit and loss for customers and suppliers for a given organisation, including detailed contact information.

+

+
+ 
/FinancialStatements/contacts/revenue
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_financial_statement_contacts_revenue():
+    api_instance = FinanceApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    contact_ids = [["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000000"]]
+    include_manual_journals = 'True'
+    start_date = '2020-09-15'
+    end_date = '2020-09-15'
+    
+    try:
+        api_response = api_instance.get_financial_statement_contacts_revenue(xero_tenant_id, contact_ids, include_manual_journals, start_date, end_date)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling FinanceApi->getFinancialStatementContactsRevenue: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
finance.statements.readGrant read-only access to finacial statements
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + + + + + + + + + + + + + +
NameDescription
contactIds + + +
+
+
+ + array[UUID] + + + (uuid) + + +
+

Specifies the customer contacts to be included in the report.

+

If no parameter is provided, all customer contacts will be included

+ +
+
+
+
+
includeManualJournals + + +
+
+
+ + Boolean + + +
+

Specifies whether to include the manual journals in the report.

+

If no parameter is provided, manual journals will not be included.

+ +
+
+
+
+
startDate + + +
+
+
+ + String + + +
+

Date yyyy-MM-dd

+

Specifies the start date for the report.

+

If no parameter is provided, the date of 12 months before the end date will be used.

+

It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.

+ +
+
+
+
+
endDate + + +
+
+
+ + String + + +
+

Date yyyy-MM-dd

+

Specifies the end date for the report.

+

If no parameter is provided, the current date will be used.

+

It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.

+ +
+
+
+
+
+
+
+
+
+
+
+

getFinancialStatementProfitAndLoss

+

Get Profit & Loss report

+
+
+
+

+

The profit and loss statement is a standard financial report providing detailed year to date income and expense detail for an organisation.

+

+
+ 
/FinancialStatements/ProfitAndLoss
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_financial_statement_profit_and_loss():
+    api_instance = FinanceApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    start_date = '2020-09-15'
+    end_date = '2021-09-15'
+    
+    try:
+        api_response = api_instance.get_financial_statement_profit_and_loss(xero_tenant_id, start_date, end_date)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling FinanceApi->getFinancialStatementProfitAndLoss: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
finance.statements.readGrant read-only access to finacial statements
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + + + + + +
NameDescription
startDate + + +
+
+
+ + String + + +
+

Date e.g. yyyy-MM-dd

+

Specifies the start date for profit and loss report

+

If no parameter is provided, the date of 12 months before the end date will be used.

+ +
+
+
+
+
endDate + + +
+
+
+ + String + + +
+

Date e.g. yyyy-MM-dd

+

Specifies the end date for profit and loss report

+

If no parameter is provided, the current date will be used.

+ +
+
+
+
+
+
+
+
+
+
+
+

getFinancialStatementTrialBalance

+

Get Trial Balance report

+
+
+
+

+

The trial balance provides a detailed list of all accounts of an organisation at a point in time, with revenue and expense items being year to date.

+

+
+ 
/FinancialStatements/TrialBalance
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_financial_statement_trial_balance():
+    api_instance = FinanceApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    end_date = '2021-09-15'
+    
+    try:
+        api_response = api_instance.get_financial_statement_trial_balance(xero_tenant_id, end_date)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling FinanceApi->getFinancialStatementTrialBalance: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
finance.statements.readGrant read-only access to finacial statements
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
xero-tenant-id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + +
NameDescription
endDate + + +
+
+
+ + String + + +
+

Date e.g. yyyy-MM-dd

+

Specifies the end date for trial balance report

+

If no parameter is provided, the current date will be used.

+ +
+
+
+
+
+
+
+
+
+
+ +
+
+
+ + + + + + + + + + + + + + diff --git a/docs/v1/payroll-au-v2/index.html b/docs/v1/payroll-au-v2/index.html new file mode 100644 index 00000000..fc98f311 --- /dev/null +++ b/docs/v1/payroll-au-v2/index.html @@ -0,0 +1,4468 @@ + + + + + Xero Payroll AU API 2.0 + + + + + + xero-python PayrollAuV2 SDK Docs + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ + +
+
+ +
+
+ +
+
+
+
+ +
+
+
+

Xero Payroll AU API 2.0

+
+
+
+ +
+
+

PayrollAuV2

+
+
+
+

approveTimesheet

+

Approves a specific timesheet

+
+
+
+

+

+

+
+ 
/Timesheets/{TimesheetID}/Approve
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_approve_timesheet():
+    api_instance = PayrollAuV2Api(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_response = api_instance.approve_timesheet(xero_tenant_id, timesheet_id, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuV2Api->approveTimesheet: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
TimesheetID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the timesheet +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
+
+
+
+
+
+

createTimesheet

+

Creates a new timesheet

+
+
+
+

+

+

+
+ 
/Timesheets
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_timesheet():
+    api_instance = PayrollAuV2Api(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    idempotency_key = 'KEY_VALUE'
+    start_date = dateutil.parser.parse('2020-10-28T00:00:00Z')
+    end_date = dateutil.parser.parse('2020-10-30T00:00:00Z')
+
+    timesheet = Timesheet(
+        payroll_calendar_id = "00000000-0000-0000-0000-000000000000",
+        employee_id = "00000000-0000-0000-0000-000000000000",
+        start_date = start_date,
+        end_date = end_date)
+    
+    try:
+        api_response = api_instance.create_timesheet(xero_tenant_id, timesheet, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuV2Api->createTimesheet: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
timesheet * +
+
+ + Timesheet + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createTimesheetLine

+

Creates a new timesheet line for a specific timesheet using a unique timesheet ID

+
+
+
+

+

+

+
+ 
/Timesheets/{TimesheetID}/Lines
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_timesheet_line():
+    api_instance = PayrollAuV2Api(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    idempotency_key = 'KEY_VALUE'
+    date = dateutil.parser.parse('2020-10-28T00:00:00Z')
+
+    timesheet_line = TimesheetLine(
+        timesheet_line_id = "00000000-0000-0000-0000-000000000000",
+        date = date,
+        earnings_rate_id = "00000000-0000-0000-0000-000000000000",
+        tracking_item_id = "00000000-0000-0000-0000-000000000000",
+        number_of_units = 6)
+    
+    try:
+        api_response = api_instance.create_timesheet_line(xero_tenant_id, timesheet_id, timesheetLine, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuV2Api->createTimesheetLine: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
TimesheetID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the timesheet +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
timesheetLine * +
+
+ + TimesheetLine + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

deleteTimesheet

+

Deletes a specific timesheet

+
+
+
+

+

+

+
+ 
/Timesheets/{TimesheetID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_timesheet():
+    api_instance = PayrollAuV2Api(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.delete_timesheet(xero_tenant_id, timesheet_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuV2Api->deleteTimesheet: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
TimesheetID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the timesheet +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

deleteTimesheetLine

+

Deletes a specific timesheet line

+
+
+
+

+

+

+
+ 
/Timesheets/{TimesheetID}/Lines/{TimesheetLineID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_timesheet_line():
+    api_instance = PayrollAuV2Api(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    timesheet_line_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.delete_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuV2Api->deleteTimesheetLine: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
TimesheetID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the timesheet +
+
+
+ Required +
+
+
+
TimesheetLineID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the timesheet line +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getTimesheet

+

Retrieve a specific timesheet by using a unique timesheet ID

+
+
+
+

+

+

+
+ 
/Timesheets/{TimesheetID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_timesheet():
+    api_instance = PayrollAuV2Api(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.get_timesheet(xero_tenant_id, timesheet_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuV2Api->getTimesheet: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
payroll.timesheets.readGrant read-only access to payroll timesheets
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
TimesheetID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the timesheet +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getTimesheets

+

Retrieves timesheets

+
+
+
+

+

+

+
+ 
/Timesheets
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_timesheets():
+    api_instance = PayrollAuV2Api(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    filter = 'employeeId==00000000-0000-0000-0000-000000000000,payrollCalendarId==00000000-0000-0000-0000-000000000000'
+    status = 'Draft'
+    start_date = '2019-01-02'
+    end_date = '2020-01-02'
+    sort = 'startDate'
+    
+    try:
+        api_response = api_instance.get_timesheets(xero_tenant_id, page, filter, status, start_date, end_date, sort)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuV2Api->getTimesheets: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
payroll.timesheets.readGrant read-only access to payroll timesheets
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription
page + + +
+
+
+ + Integer + + +
+Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. +
+
+
+
+
filter + + +
+
+
+ + String + + +
+Filter by employeeId and/or payrollCalendarId +
+
+
+
+
status + + +
+
+
+ + String + + +
+filter results by any timesheets with a matching timesheet status +
+
+
+
+
startDate + + +
+
+
+ + String + + +
+filter results by any timesheets with a startDate on or after the provided date +
+
+
+
+
endDate + + +
+
+
+ + String + + +
+filter results by any timesheets with a endDate on or before the provided date +
+
+
+
+
sort + + +
+
+
+ + String + + +
+sort the order of timesheets returned. The default is based on the timesheets createdDate, sorted oldest to newest. Currently, the only other option is to reverse the order based on the timesheets startDate, sorted newest to oldest. +
+
+
+
+
+
+
+
+
+
+
+

revertTimesheet

+

Reverts a specific timesheet to draft

+
+
+
+

+

+

+
+ 
/Timesheets/{TimesheetID}/RevertToDraft
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_revert_timesheet():
+    api_instance = PayrollAuV2Api(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_response = api_instance.revert_timesheet(xero_tenant_id, timesheet_id, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuV2Api->revertTimesheet: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
TimesheetID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the timesheet +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
+
+
+
+
+
+

updateTimesheetLine

+

Updates a specific timesheet line for a specific timesheet

+
+
+
+

+

+

+
+ 
/Timesheets/{TimesheetID}/Lines/{TimesheetLineID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_timesheet_line():
+    api_instance = PayrollAuV2Api(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    timesheet_line_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    idempotency_key = 'KEY_VALUE'
+    date = dateutil.parser.parse('2020-10-28T00:00:00Z')
+
+    timesheet_line = TimesheetLine(
+        timesheet_line_id = "00000000-0000-0000-0000-000000000000",
+        date = date,
+        earnings_rate_id = "00000000-0000-0000-0000-000000000000",
+        tracking_item_id = "00000000-0000-0000-0000-000000000000",
+        number_of_units = 6)
+    
+    try:
+        api_response = api_instance.update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheetLine, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuV2Api->updateTimesheetLine: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
TimesheetID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the timesheet +
+
+
+ Required +
+
+
+
TimesheetLineID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the timesheet line +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
timesheetLine * +
+
+ + TimesheetLine + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+ +
+
+
+ + + + + + + + + + + + + + diff --git a/docs/v1/payroll-au/index.html b/docs/v1/payroll-au/index.html new file mode 100644 index 00000000..d10d54ed --- /dev/null +++ b/docs/v1/payroll-au/index.html @@ -0,0 +1,10580 @@ + + + + + Xero Payroll AU API + + + + + + xero-python PayrollAu SDK Docs + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ + +
+
+ +
+
+ +
+
+
+
+ +
+
+
+

Xero Payroll AU API

+
+
+
+ +
+
+

PayrollAu

+
+
+
+

approveLeaveApplication

+

Approve a requested leave application by a unique leave application id

+
+
+
+

+

+

+
+ 
/LeaveApplications/{LeaveApplicationID}/approve
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_approve_leave_application():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    leave_application_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_response = api_instance.approve_leave_application(xero_tenant_id, leave_application_id, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->approveLeaveApplication: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
LeaveApplicationID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Leave Application id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
+
+
+
+
+
+

createEmployee

+

Creates a payroll employee

+
+
+
+

+

+

+
+ 
/Employees
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_employee():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    idempotency_key = 'KEY_VALUE'
+    date_of_birth = dateutil.parser.parse('2000-10-28T00:00:00Z')
+
+    home_address = HomeAddress(
+        address_line_1 = "123 Test st",
+        region = "VIC",
+        postal_code = 3000,
+        city = "Melbourne")
+
+    employee = Employee(
+        first_name = "Adam",
+        last_name = "Adamson",
+        date_of_birth = date_of_birth,
+        homeAddress = home_address)
+    
+    try:
+        api_response = api_instance.create_employee(xero_tenant_id, employee, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->createEmployee: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
employee * +
+
+ + array[Employee] + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createLeaveApplication

+

Creates a leave application

+
+
+
+

+

+

+
+ 
/LeaveApplications
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_leave_application():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    idempotency_key = 'KEY_VALUE'
+    start_date = dateutil.parser.parse('2020-10-28T00:00:00Z')
+    end_date = dateutil.parser.parse('2020-10-30T00:00:00Z')
+
+    leaveApplication = LeaveApplication(
+        employee_id = "00000000-0000-0000-0000-000000000000",
+        leave_type_id = "00000000-0000-0000-0000-000000000000",
+        title = "Annual Leave",
+        start_date = start_date,
+        end_date = end_date)
+    
+    try:
+        api_response = api_instance.create_leave_application(xero_tenant_id, leaveApplication, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->createLeaveApplication: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
leaveApplication * +
+
+ + array[LeaveApplication] + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createPayItem

+

Creates a pay item

+
+
+
+

+

+

+
+ 
/PayItems
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_pay_item():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    idempotency_key = 'KEY_VALUE'
+
+    earnings_rate = EarningsRate(
+        name = "Ordinary Hours 123",
+        account_code = "477",
+        type_of_units = "Hours",
+        is_exempt_from_tax = true,
+        is_exempt_from_super = true,
+        is_qualifying_earnings = false,
+        earningsType = "OVERTIMEEARNINGS")
+
+    deduction_type = DeductionType(
+        name = "Union Fees",
+        account_code = "826",
+        reduces_tax = true,
+        reduces_super = true)
+
+    leave_type = LeaveType(
+        name = "Annual Leave",
+        type_of_units = "Hours",
+        is_paid_leave = true,
+        show_on_payslip = true)
+
+    reimbursement_type = ReimbursementType(
+        name = "Annual Leave",
+        account_code = "850")
+    
+    earnings_rates = []    
+    earnings_rates.append(earnings_rate,
+    
+    deduction_types = []
+    
+    leave_types = []    
+    leave_types.append(leave_type)
+    
+    reimbursement_types = []    
+    reimbursement_types.append(reimbursement_type)
+
+    pay_item = PayItem(
+        earningsRates = earnings_rates,
+        deductionTypes = deduction_types,
+        leaveTypes = leave_types,
+        reimbursementTypes = reimbursement_types)
+    
+    try:
+        api_response = api_instance.create_pay_item(xero_tenant_id, payItem, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->createPayItem: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.settingsGrant read-write access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
payItem * +
+
+ + PayItem + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createPayRun

+

Creates a pay run

+
+
+
+

+

+

+
+ 
/PayRuns
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_pay_run():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    idempotency_key = 'KEY_VALUE'
+
+    pay_run = PayRun(
+        payroll_calendar_id = "00000000-0000-0000-0000-000000000000")
+    
+    try:
+        api_response = api_instance.create_pay_run(xero_tenant_id, payRun, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->createPayRun: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.payrunsGrant read-write access to payroll payruns
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
payRun * +
+
+ + array[PayRun] + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createPayrollCalendar

+

Creates a Payroll Calendar

+
+
+
+

+

+

+
+ 
/PayrollCalendars
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_payroll_calendar():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    idempotency_key = 'KEY_VALUE'
+    start_date = dateutil.parser.parse('2020-10-28T00:00:00Z')
+    payment_date = dateutil.parser.parse('2000-10-30T00:00:00Z')
+
+    payroll_calendar = PayrollCalendar(
+        name = "Weekly",
+        calendar_type = "WEEKLY",
+        start_date = start_date,
+        payment_date = payment_date)
+    
+    payroll_calendars = []    
+    payroll_calendars.append(payroll_calendar)
+    
+    try:
+        api_response = api_instance.create_payroll_calendar(xero_tenant_id, payrollCalendar, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->createPayrollCalendar: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.settingsGrant read-write access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
payrollCalendar * +
+
+ + array[PayrollCalendar] + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createSuperfund

+

Creates a superfund

+
+
+
+

+

+

+
+ 
/Superfunds
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_superfund():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    idempotency_key = 'KEY_VALUE'
+
+    super_fund = SuperFund(
+        type = "REGULATED",
+        USI = "40022701955002")
+    
+    try:
+        api_response = api_instance.create_superfund(xero_tenant_id, superFund, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->createSuperfund: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.settingsGrant read-write access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
superFund * +
+
+ + array[SuperFund] + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createTimesheet

+

Creates a timesheet

+
+
+
+

+

+

+
+ 
/Timesheets
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_timesheet():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    idempotency_key = 'KEY_VALUE'
+    start_date = dateutil.parser.parse('2020-10-23T00:00:00Z')
+    end_date = dateutil.parser.parse('2020-10-30T00:00:00Z')
+
+    timesheet = Timesheet(
+        employee_id = "00000000-0000-0000-0000-000000000000",
+        start_date = start_date,
+        end_date = end_date,
+        status = "DRAFT")
+    
+    try:
+        api_response = api_instance.create_timesheet(xero_tenant_id, timesheet, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->createTimesheet: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
timesheet * +
+
+ + array[Timesheet] + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

getEmployee

+

Retrieves an employee's detail by unique employee id

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employee():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_employee(xero_tenant_id, employee_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->getEmployee: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getEmployees

+

Searches payroll employees

+
+
+
+

+

+

+
+ 
/Employees
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employees():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    if_modified_since = dateutil.parser.parse("2020-02-06T12:17:43.202-08:00")
+    where = 'Status=="ACTIVE"'
+    order = 'EmailAddress%20DESC'
+    
+    try:
+        api_response = api_instance.get_employees(xero_tenant_id, if_modified_since, where, order, page)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->getEmployees: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
If-Modified-Since + + +
+
+
+ + Date + + + (date-time) + + +
+Only records created or modified since this timestamp will be returned +
+
+
+
+
+
Query parameters
+ + + + + + + + + + + + + + + + + +
NameDescription
where + + +
+
+
+ + String + + +
+Filter by an any element +
+
+
+
+
order + + +
+
+
+ + String + + +
+Order by an any element +
+
+
+
+
page + + +
+
+
+ + Integer + + +
+e.g. page=1 – Up to 100 employees will be returned in a single API call +
+
+
+
+
+
+
+
+
+
+
+

getLeaveApplication

+

Retrieves a leave application by a unique leave application id

+
+
+
+

+

+

+
+ 
/LeaveApplications/{LeaveApplicationID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_leave_application():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    leave_application_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_leave_application(xero_tenant_id, leave_application_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->getLeaveApplication: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
LeaveApplicationID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Leave Application id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getLeaveApplications

+

Retrieves leave applications

+
+
+
+

+

+

+
+ 
/LeaveApplications
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_leave_applications():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    if_modified_since = dateutil.parser.parse("2020-02-06T12:17:43.202-08:00")
+    where = 'Status=="ACTIVE"'
+    order = 'EmailAddress%20DESC'
+    
+    try:
+        api_response = api_instance.get_leave_applications(xero_tenant_id, if_modified_since, where, order, page)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->getLeaveApplications: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
If-Modified-Since + + +
+
+
+ + Date + + + (date-time) + + +
+Only records created or modified since this timestamp will be returned +
+
+
+
+
+
Query parameters
+ + + + + + + + + + + + + + + + + +
NameDescription
where + + +
+
+
+ + String + + +
+Filter by an any element +
+
+
+
+
order + + +
+
+
+ + String + + +
+Order by an any element +
+
+
+
+
page + + +
+
+
+ + Integer + + +
+e.g. page=1 – Up to 100 objects will be returned in a single API call +
+
+
+
+
+
+
+
+
+
+
+

getLeaveApplicationsV2

+

Retrieves leave applications including leave requests

+
+
+
+

+

+

+
+ 
/LeaveApplications/v2
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_leave_applications_v2():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    if_modified_since = dateutil.parser.parse("2020-02-06T12:17:43.202-08:00")
+    where = 'Status=="ACTIVE"'
+    order = 'EmailAddress%20DESC'
+    
+    try:
+        api_response = api_instance.get_leave_applications_v2(xero_tenant_id, if_modified_since, where, order, page)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->getLeaveApplicationsV2: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
If-Modified-Since + + +
+
+
+ + Date + + + (date-time) + + +
+Only records created or modified since this timestamp will be returned +
+
+
+
+
+
Query parameters
+ + + + + + + + + + + + + + + + + +
NameDescription
where + + +
+
+
+ + String + + +
+Filter by an any element +
+
+
+
+
order + + +
+
+
+ + String + + +
+Order by an any element +
+
+
+
+
page + + +
+
+
+ + Integer + + +
+e.g. page=1 – Up to 100 objects will be returned in a single API call +
+
+
+
+
+
+
+
+
+
+
+

getPayItems

+

Retrieves pay items

+
+
+
+

+

+

+
+ 
/PayItems
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_pay_items():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    if_modified_since = dateutil.parser.parse("2020-02-06T12:17:43.202-08:00")
+    where = 'Status=="ACTIVE"'
+    order = 'EmailAddress%20DESC'
+    
+    try:
+        api_response = api_instance.get_pay_items(xero_tenant_id, if_modified_since, where, order, page)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->getPayItems: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
If-Modified-Since + + +
+
+
+ + Date + + + (date-time) + + +
+Only records created or modified since this timestamp will be returned +
+
+
+
+
+
Query parameters
+ + + + + + + + + + + + + + + + + +
NameDescription
where + + +
+
+
+ + String + + +
+Filter by an any element +
+
+
+
+
order + + +
+
+
+ + String + + +
+Order by an any element +
+
+
+
+
page + + +
+
+
+ + Integer + + +
+e.g. page=1 – Up to 100 objects will be returned in a single API call +
+
+
+
+
+
+
+
+
+
+
+

getPayRun

+

Retrieves a pay run by using a unique pay run id

+
+
+
+

+

+

+
+ 
/PayRuns/{PayRunID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_pay_run():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    pay_run_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_pay_run(xero_tenant_id, pay_run_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->getPayRun: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.payrunsGrant read-write access to payroll payruns
payroll.payruns.readGrant read-only access to payroll payruns
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
PayRunID* + + +
+
+
+ + UUID + + + (uuid) + + +
+PayRun id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getPayRuns

+

Retrieves pay runs

+
+
+
+

+

+

+
+ 
/PayRuns
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_pay_runs():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    if_modified_since = dateutil.parser.parse("2020-02-06T12:17:43.202-08:00")
+    where = 'Status=="ACTIVE"'
+    order = 'EmailAddress%20DESC'
+    
+    try:
+        api_response = api_instance.get_pay_runs(xero_tenant_id, if_modified_since, where, order, page)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->getPayRuns: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.payrunsGrant read-write access to payroll payruns
payroll.payruns.readGrant read-only access to payroll payruns
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
If-Modified-Since + + +
+
+
+ + Date + + + (date-time) + + +
+Only records created or modified since this timestamp will be returned +
+
+
+
+
+
Query parameters
+ + + + + + + + + + + + + + + + + +
NameDescription
where + + +
+
+
+ + String + + +
+Filter by an any element +
+
+
+
+
order + + +
+
+
+ + String + + +
+Order by an any element +
+
+
+
+
page + + +
+
+
+ + Integer + + +
+e.g. page=1 – Up to 100 PayRuns will be returned in a single API call +
+
+
+
+
+
+
+
+
+
+
+

getPayrollCalendar

+

Retrieves payroll calendar by using a unique payroll calendar ID

+
+
+
+

+

+

+
+ 
/PayrollCalendars/{PayrollCalendarID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_payroll_calendar():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    payroll_calendar_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_payroll_calendar(xero_tenant_id, payroll_calendar_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->getPayrollCalendar: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
PayrollCalendarID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Payroll Calendar id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getPayrollCalendars

+

Retrieves payroll calendars

+
+
+
+

+

+

+
+ 
/PayrollCalendars
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_payroll_calendars():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    if_modified_since = dateutil.parser.parse("2020-02-06T12:17:43.202-08:00")
+    where = 'Status=="ACTIVE"'
+    order = 'EmailAddress%20DESC'
+    
+    try:
+        api_response = api_instance.get_payroll_calendars(xero_tenant_id, if_modified_since, where, order, page)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->getPayrollCalendars: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
If-Modified-Since + + +
+
+
+ + Date + + + (date-time) + + +
+Only records created or modified since this timestamp will be returned +
+
+
+
+
+
Query parameters
+ + + + + + + + + + + + + + + + + +
NameDescription
where + + +
+
+
+ + String + + +
+Filter by an any element +
+
+
+
+
order + + +
+
+
+ + String + + +
+Order by an any element +
+
+
+
+
page + + +
+
+
+ + Integer + + +
+e.g. page=1 – Up to 100 objects will be returned in a single API call +
+
+
+
+
+
+
+
+
+
+
+

getPayslip

+

Retrieves for a payslip by a unique payslip id

+
+
+
+

+

+

+
+ 
/Payslip/{PayslipID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_payslip():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    payslip_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_payslip(xero_tenant_id, payslip_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->getPayslip: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.payslipGrant read-write access to payroll payslips
payroll.payslip.readGrant read-only access to payroll payslips
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
PayslipID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Payslip id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getSettings

+

Retrieves payroll settings

+
+
+
+

+

+

+
+ 
/Settings
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_settings():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    
+    try:
+        api_response = api_instance.get_settings(xero_tenant_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->getSettings: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getSuperfund

+

Retrieves a superfund by using a unique superfund ID

+
+
+
+

+

+

+
+ 
/Superfunds/{SuperFundID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_superfund():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    super_fund_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_superfund(xero_tenant_id, super_fund_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->getSuperfund: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
SuperFundID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Superfund id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getSuperfundProducts

+

Retrieves superfund products

+
+
+
+

+

+

+
+ 
/SuperfundProducts
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_superfund_products():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    aBN = '40022701955'
+    uSI = 'OSF0001AU'
+    
+    try:
+        api_response = api_instance.get_superfund_products(xero_tenant_id, aBN, uSI)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->getSuperfundProducts: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + + + + + +
NameDescription
ABN + + +
+
+
+ + String + + +
+The ABN of the Regulated SuperFund +
+
+
+
+
USI + + +
+
+
+ + String + + +
+The USI of the Regulated SuperFund +
+
+
+
+
+
+
+
+
+
+
+

getSuperfunds

+

Retrieves superfunds

+
+
+
+

+

+

+
+ 
/Superfunds
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_superfunds():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    if_modified_since = dateutil.parser.parse("2020-02-06T12:17:43.202-08:00")
+    where = 'Status=="ACTIVE"'
+    order = 'EmailAddress%20DESC'
+    
+    try:
+        api_response = api_instance.get_superfunds(xero_tenant_id, if_modified_since, where, order, page)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->getSuperfunds: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
If-Modified-Since + + +
+
+
+ + Date + + + (date-time) + + +
+Only records created or modified since this timestamp will be returned +
+
+
+
+
+
Query parameters
+ + + + + + + + + + + + + + + + + +
NameDescription
where + + +
+
+
+ + String + + +
+Filter by an any element +
+
+
+
+
order + + +
+
+
+ + String + + +
+Order by an any element +
+
+
+
+
page + + +
+
+
+ + Integer + + +
+e.g. page=1 – Up to 100 SuperFunds will be returned in a single API call +
+
+
+
+
+
+
+
+
+
+
+

getTimesheet

+

Retrieves a timesheet by using a unique timesheet id

+
+
+
+

+

+

+
+ 
/Timesheets/{TimesheetID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_timesheet():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_timesheet(xero_tenant_id, timesheet_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->getTimesheet: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
payroll.timesheets.readGrant read-only access to payroll timesheets
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
TimesheetID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Timesheet id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getTimesheets

+

Retrieves timesheets

+
+
+
+

+

+

+
+ 
/Timesheets
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_timesheets():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    if_modified_since = dateutil.parser.parse("2020-02-06T12:17:43.202-08:00")
+    where = 'Status=="ACTIVE"'
+    order = 'EmailAddress%20DESC'
+    
+    try:
+        api_response = api_instance.get_timesheets(xero_tenant_id, if_modified_since, where, order, page)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->getTimesheets: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
payroll.timesheets.readGrant read-only access to payroll timesheets
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
If-Modified-Since + + +
+
+
+ + Date + + + (date-time) + + +
+Only records created or modified since this timestamp will be returned +
+
+
+
+
+
Query parameters
+ + + + + + + + + + + + + + + + + +
NameDescription
where + + +
+
+
+ + String + + +
+Filter by an any element +
+
+
+
+
order + + +
+
+
+ + String + + +
+Order by an any element +
+
+
+
+
page + + +
+
+
+ + Integer + + +
+e.g. page=1 – Up to 100 timesheets will be returned in a single API call +
+
+
+
+
+
+
+
+
+
+
+

rejectLeaveApplication

+

Reject a leave application by a unique leave application id

+
+
+
+

+

+

+
+ 
/LeaveApplications/{LeaveApplicationID}/reject
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_reject_leave_application():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    leave_application_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_response = api_instance.reject_leave_application(xero_tenant_id, leave_application_id, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->rejectLeaveApplication: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
LeaveApplicationID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Leave Application id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
+
+
+
+
+
+

updateEmployee

+

Updates an employee's detail

+
+
+
+

+

Update properties on a single employee

+

+
+ 
/Employees/{EmployeeID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_employee():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+    date_of_birth = dateutil.parser.parse('2000-10-28T00:00:00Z')
+
+    home_address = HomeAddress(
+        address_line_1 = "123 Test st",
+        region = "VIC",
+        postal_code = 3000,
+        city = "Melbourne")
+
+    employee = Employee(
+        first_name = "Adam",
+        last_name = "Adamson",
+        date_of_birth = date_of_birth,
+        homeAddress = home_address)
+    
+    try:
+        api_response = api_instance.update_employee(xero_tenant_id, employee_id, employee, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->updateEmployee: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
employee * +
+
+ + array[Employee] + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

updateLeaveApplication

+

Updates a specific leave application

+
+
+
+

+

+

+
+ 
/LeaveApplications/{LeaveApplicationID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_leave_application():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    leave_application_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+    start_date = dateutil.parser.parse('2020-10-28T00:00:00Z')
+    end_date = dateutil.parser.parse('2020-10-30T00:00:00Z')
+
+    leaveApplication = LeaveApplication(
+        employee_id = "00000000-0000-0000-0000-000000000000",
+        leave_type_id = "00000000-0000-0000-0000-000000000000",
+        title = "Annual Leave",
+        start_date = start_date,
+        end_date = end_date)
+    
+    try:
+        api_response = api_instance.update_leave_application(xero_tenant_id, leave_application_id, leaveApplication, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->updateLeaveApplication: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
LeaveApplicationID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Leave Application id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
leaveApplication * +
+
+ + array[LeaveApplication] + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

updatePayRun

+

Updates a pay run

+
+
+
+

+

Update properties on a single PayRun

+

+
+ 
/PayRuns/{PayRunID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_pay_run():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    pay_run_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+
+    pay_run = PayRun(
+        payroll_calendar_id = "00000000-0000-0000-0000-000000000000")
+    
+    try:
+        api_response = api_instance.update_pay_run(xero_tenant_id, pay_run_id, payRun, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->updatePayRun: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.payrunsGrant read-write access to payroll payruns
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
PayRunID* + + +
+
+
+ + UUID + + + (uuid) + + +
+PayRun id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
payRun * +
+
+ + array[PayRun] + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

updatePayslip

+

Updates a payslip

+
+
+
+

+

Update lines on a single payslips

+

+
+ 
/Payslip/{PayslipID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_payslip():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    payslip_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+
+    earnings_line = EarningsLine(
+        earnings_rate_id = "00000000-0000-0000-0000-000000000000",
+        rate_per_unit = 20,
+        number_of_units = 1)
+    
+    earnings_lines = []    
+    earnings_lines.append(earnings_line)
+
+    payslip_lines = PayslipLines(
+        earnings_lines = earningsLines)
+    
+    payslip_lines = []    
+    payslip_lines.append(payslip_line)
+    
+    try:
+        api_response = api_instance.update_payslip(xero_tenant_id, payslip_id, payslipLines, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->updatePayslip: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.payslipGrant read-write access to payroll payslips
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
PayslipID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Payslip id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
payslipLines * +
+
+ + array[PayslipLines] + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

updateSuperfund

+

Updates a superfund

+
+
+
+

+

Update properties on a single Superfund

+

+
+ 
/Superfunds/{SuperFundID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_superfund():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    super_fund_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+
+    super_fund = SuperFund(
+        type = "REGULATED",
+        USI = "40022701955002")
+    
+    try:
+        api_response = api_instance.update_superfund(xero_tenant_id, super_fund_id, superFund, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->updateSuperfund: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.settingsGrant read-write access to payroll settings
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
SuperFundID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Superfund id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
superFund * +
+
+ + array[SuperFund] + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

updateTimesheet

+

Updates a timesheet

+
+
+
+

+

Update properties on a single timesheet

+

+
+ 
/Timesheets/{TimesheetID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_timesheet():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+    start_date = dateutil.parser.parse('2020-10-23T00:00:00Z')
+    end_date = dateutil.parser.parse('2020-10-30T00:00:00Z')
+
+    timesheet = Timesheet(
+        employee_id = "00000000-0000-0000-0000-000000000000",
+        start_date = start_date,
+        end_date = end_date,
+        status = "DRAFT")
+    
+    try:
+        api_response = api_instance.update_timesheet(xero_tenant_id, timesheet_id, timesheet, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->updateTimesheet: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
TimesheetID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Timesheet id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
timesheet * +
+
+ + array[Timesheet] + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+ +
+
+
+ + + + + + + + + + + + + + diff --git a/docs/v1/payroll-nz/index.html b/docs/v1/payroll-nz/index.html new file mode 100644 index 00000000..d83b751a --- /dev/null +++ b/docs/v1/payroll-nz/index.html @@ -0,0 +1,17249 @@ + + + + + Xero Payroll NZ + + + + + + xero-python PayrollNz SDK Docs + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ + +
+
+ +
+
+ +
+
+
+
+
+ +
+
+
+
+

Xero Payroll NZ

+
+
+
+ +
+
+

PayrollNz

+
+
+
+

approveTimesheet

+

Approves a timesheet

+
+
+
+

+

+

+
+ 
/Timesheets/{TimesheetID}/Approve
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_approve_timesheet():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_response = api_instance.approve_timesheet(xero_tenant_id, timesheet_id, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->approveTimesheet: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
TimesheetID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the timesheet +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
+
+
+
+
+
+

createDeduction

+

Creates a new deduction for a specific employee

+
+
+
+

+

+

+
+ 
/Deductions
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_deduction():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    idempotency_key = 'KEY_VALUE'
+
+    deduction = Deduction(
+        deduction_name = "Deduction test",
+        deduction_category = deduction_category.NzOther,
+        liability_account_id = "00000000-0000-0000-0000-000000000000")
+    
+    try:
+        api_response = api_instance.create_deduction(xero_tenant_id, deduction, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->createDeduction: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.settingsGrant read-write access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
deduction * +
+
+ + Deduction + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createEarningsRate

+

Creates a new earnings rate

+
+
+
+

+

+

+
+ 
/EarningsRates
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_earnings_rate():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    idempotency_key = 'KEY_VALUE'
+
+    earnings_rate = EarningsRate(
+        earnings_type = "RegularEarnings",
+        rate_type = "RatePerUnit",
+        expense_account_ID = "00000000-0000-0000-0000-000000000000")
+    
+    try:
+        api_response = api_instance.create_earnings_rate(xero_tenant_id, earningsRate, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->createEarningsRate: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.settingsGrant read-write access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
earningsRate * +
+
+ + EarningsRate + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createEmployee

+

Creates an employees

+
+
+
+

+

+

+
+ 
/Employees
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_employee():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    idempotency_key = 'KEY_VALUE'
+    date_of_birth = dateutil.parser.parse('2000-10-28T00:00:00Z')
+
+    address = Address(
+        address_line_1 = "123 Test st",
+        city = "Rangiora",
+        post_code = "7400",
+        country_name = "NEW ZEALAND")
+
+    employee = Employee(
+        first_name = "Adam",
+        last_name = "Adamson",
+        date_of_birth = date_of_birth,
+        address = address)
+    
+    try:
+        api_response = api_instance.create_employee(xero_tenant_id, employee, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->createEmployee: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
employee * +
+
+ + Employee + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createEmployeeEarningsTemplate

+

Creates earnings template records for an employee

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/PayTemplates/Earnings
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_employee_earnings_template():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+
+    earnings_template = EarningsTemplate(
+        pay_template_earning_id = "00000000-0000-0000-0000-000000000000",
+        rate_per_unit = 14.25,
+        number_of_units = 35.5,
+        fixed_amount = 50,
+        earnings_rate_id = "00000000-0000-0000-0000-000000000000",
+        name = "Overtime Hours")
+    
+    earnings_templates = []    
+    earnings_templates.append(earnings_template)
+    
+    try:
+        api_response = api_instance.create_employee_earnings_template(xero_tenant_id, employee_id, earningsTemplate, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->createEmployeeEarningsTemplate: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
earningsTemplate * +
+
+ + EarningsTemplate + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createEmployeeLeave

+

Creates leave records for a specific employee

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/Leave
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_employee_leave():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+    start_date = dateutil.parser.parse('2020-10-28T00:00:00Z')
+    end_date = dateutil.parser.parse('2020-10-30T00:00:00Z')
+
+    employee_leave = EmployeeLeave(
+        leave_type_id = "00000000-0000-0000-0000-000000000000",
+        start_date = start_date,
+        end_date = end_date,
+        number_of_units = number_of_units,
+        number_of_units_taken = number_of_units_taken)
+    
+    try:
+        api_response = api_instance.create_employee_leave(xero_tenant_id, employee_id, employeeLeave, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->createEmployeeLeave: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
employeeLeave * +
+
+ + EmployeeLeave + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createEmployeeLeaveSetup

+

Creates a leave set-up for a specific employee. This is required before viewing, configuring and requesting leave for an employee

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/LeaveSetup
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_employee_leave_setup():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+
+    employee_leave_setup = EmployeeLeaveSetup(
+        include_holiday_pay = false,
+        holiday_pay_opening_balance = 10.5,
+        annual_leave_opening_balance = 25.89,
+        sick_leave_opening_balance = 10.5,
+        sick_leave_to_accrue_annually = 100.0,
+        sick_leave_maximum_to_accrue = 200.0,
+        sick_leave_schedule_of_accrual = "",
+        sick_leave_anniversary_date = ,
+        annual_leave_anniversary_date = )
+    
+    try:
+        api_response = api_instance.create_employee_leave_setup(xero_tenant_id, employee_id, employeeLeaveSetup, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->createEmployeeLeaveSetup: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
employeeLeaveSetup * +
+
+ + EmployeeLeaveSetup + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createEmployeeLeaveType

+

Creates leave type records for a specific employee

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/LeaveTypes
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_employee_leave_type():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+
+    employee_leave_type = EmployeeLeaveType(
+        leave_type_id = "00000000-0000-0000-0000-000000000000",
+        schedule_of_accrual = schedule_of_accrual::PERCENTAGEOFGROSSEARNINGS,
+        opening_balance = 5.25,
+        schedule_of_accrual_date = )
+    
+    try:
+        api_response = api_instance.create_employee_leave_type(xero_tenant_id, employee_id, employeeLeaveType, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->createEmployeeLeaveType: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
employeeLeaveType * +
+
+ + EmployeeLeaveType + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createEmployeeOpeningBalances

+

Creates opening balances for a specific employee

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/OpeningBalances
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_employee_opening_balances():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+    period_end_date = dateutil.parser.parse('2020-10-30T00:00:00Z')
+
+    employee_opening_balance = EmployeeOpeningBalance(
+        period_end_date = period_end_date,
+        days_paid = 5,
+        unpaid_weeks = 0,
+        gross_earnings = 1730.77)
+    
+    employee_opening_balances = []    
+    employee_opening_balances.append(employee_opening_balance)
+    
+    try:
+        api_response = api_instance.create_employee_opening_balances(xero_tenant_id, employee_id, employeeOpeningBalance, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->createEmployeeOpeningBalances: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
employeeOpeningBalance * +
+
+ + array[EmployeeOpeningBalance] + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createEmployeePaymentMethod

+

Creates a payment method for an employee

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/PaymentMethods
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_employee_payment_method():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+
+    bank_account = BankAccount(
+        account_name = "Charlotte Danes",
+        account_number = 123456,
+        sort_code = "123411")
+    
+    bank_accounts = []    
+    bank_accounts.append(bank_account)
+
+    payment_method = PaymentMethod(
+        bankAccounts = bankAccounts)
+    
+    try:
+        api_response = api_instance.create_employee_payment_method(xero_tenant_id, employee_id, paymentMethod, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->createEmployeePaymentMethod: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
paymentMethod * +
+
+ + PaymentMethod + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createEmployeeSalaryAndWage

+

Creates an employee salary and wage record

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/SalaryAndWages
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_employee_salary_and_wage():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+
+    salary_and_wage = SalaryAndWage(
+        earnings_rate_id = "00000000-0000-0000-0000-000000000000",
+        number_of_units_per_day = 0,
+        days_per_week = 0,
+        payment_type = payment_type_enum.Hourly)
+    
+    try:
+        api_response = api_instance.create_employee_salary_and_wage(xero_tenant_id, employee_id, salaryAndWage, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->createEmployeeSalaryAndWage: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
salaryAndWage * +
+
+ + SalaryAndWage + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createEmployeeWorkingPattern

+

Creates an employee working pattern

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/Working-Patterns
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_employee_working_pattern():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+    effective_from = dateutil.parser.parse('2020-10-28T00:00:00Z')
+
+    workingWeek = WorkingWeek(
+        monday = 8,
+        tuesday = 8,
+        wednesday = 8,
+        thursday = 8,
+        friday = 8,
+        saturday = 0,
+        sunday = 0)
+    
+    try:
+        api_response = api_instance.create_employee_working_pattern(xero_tenant_id, employee_id, employeeWorkingPatternWithWorkingWeeksRequest, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->createEmployeeWorkingPattern: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
employeeWorkingPatternWithWorkingWeeksRequest * +
+
+ + EmployeeWorkingPatternWithWorkingWeeksRequest + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createEmployment

+

Creates an employment detail for a specific employee

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/Employment
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_employment():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+    start_date = dateutil.parser.parse('2020-10-28T00:00:00Z')
+
+    employment = Employment(
+        payroll_calendar_id = "00000000-0000-0000-0000-000000000000",
+        start_date = start_date,
+        engagement_type = "",
+        fixed_term_end_date = )
+    
+    try:
+        api_response = api_instance.create_employment(xero_tenant_id, employee_id, employment, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->createEmployment: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
employment * +
+
+ + Employment + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createLeaveType

+

Creates a new leave type

+
+
+
+

+

+

+
+ 
/LeaveTypes
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_leave_type():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    idempotency_key = 'KEY_VALUE'
+
+    leave_type = LeaveType(
+        name = "LeaveType",
+        is_paid_leave = true,
+        show_on_payslip = true)
+    
+    try:
+        api_response = api_instance.create_leave_type(xero_tenant_id, leaveType, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->createLeaveType: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.settingsGrant read-write access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
leaveType * +
+
+ + LeaveType + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createMultipleEmployeeEarningsTemplate

+

Creates multiple employee earnings template records for a specific employee

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/PayTemplateEarnings
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_multiple_employee_earnings_template():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+
+    earnings_template = EarningsTemplate(
+        pay_template_earning_id = "00000000-0000-0000-0000-000000000000",
+        rate_per_unit = 14.25,
+        number_of_units = 35.5,
+        fixed_amount = 50,
+        earnings_rate_id = "00000000-0000-0000-0000-000000000000",
+        name = "Overtime Hours")
+    
+    earnings_templates = []    
+    earnings_templates.append(earnings_template)
+    
+    try:
+        api_response = api_instance.create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earningsTemplate, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->createMultipleEmployeeEarningsTemplate: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
earningsTemplate * +
+
+ + array[EarningsTemplate] + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createPayRun

+

Creates a pay run

+
+
+
+

+

+

+
+ 
/PayRuns
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_pay_run():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    idempotency_key = 'KEY_VALUE'
+
+    pay_run = PayRun(
+        pay_run_type = pay_run_type_enum.Scheduled,
+        payroll_calendar_id = "00000000-0000-0000-0000-000000000000")
+    
+    try:
+        api_response = api_instance.create_pay_run(xero_tenant_id, payRun, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->createPayRun: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.payrunsGrant read-write access to payroll payruns
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
payRun * +
+
+ + PayRun + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createPayRunCalendar

+

Creates a new payrun calendar

+
+
+
+

+

+

+
+ 
/PayRunCalendars
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_pay_run_calendar():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    idempotency_key = 'KEY_VALUE'
+    start_date = dateutil.parser.parse('2020-10-28T00:00:00Z')
+    payment_date = dateutil.parser.parse('2020-10-30T00:00:00Z')
+
+    pay_run_calendar = PayRunCalendar(
+        calendar_type = calendar_type.WEEKLY,
+        period_start_date = start_date,
+        payment_date = payment_date)
+    
+    try:
+        api_response = api_instance.create_pay_run_calendar(xero_tenant_id, payRunCalendar, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->createPayRunCalendar: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.settingsGrant read-write access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
payRunCalendar * +
+
+ + PayRunCalendar + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createReimbursement

+

Creates a new reimbursement

+
+
+
+

+

+

+
+ 
/Reimbursements
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_reimbursement():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    idempotency_key = 'KEY_VALUE'
+
+    reimbursement = Reimbursement(
+        name = "Test Reimbursement",
+        account_id = "00000000-0000-0000-0000-000000000000")
+        calculation_type = calculation_type_enum.FixedAmount,
+        reimbursement_category = reimbursement_category_enum.GST)
+    
+    try:
+        api_response = api_instance.create_reimbursement(xero_tenant_id, reimbursement, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->createReimbursement: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.settingsGrant read-write access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
reimbursement * +
+
+ + Reimbursement + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createSuperannuation

+

Creates a new superannuation

+
+
+
+

+

+

+
+ 
/Superannuations
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_superannuation():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    idempotency_key = 'KEY_VALUE'
+
+    benefit = Benefit(
+        category = "ComplyingFund",
+        calculation_type_nz = "PercentageOfTaxableEarnings",
+        liability_account_id = "00000000-0000-0000-0000-000000000000",
+        expense_account_id = "00000000-0000-0000-0000-000000000000",
+        percentage = 3,
+        standard_amount = 100)
+    
+    try:
+        api_response = api_instance.create_superannuation(xero_tenant_id, benefit, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->createSuperannuation: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.settingsGrant read-write access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
benefit * +
+
+ + Benefit + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createTimesheet

+

Creates a new timesheet

+
+
+
+

+

+

+
+ 
/Timesheets
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_timesheet():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    idempotency_key = 'KEY_VALUE'
+    start_date = dateutil.parser.parse('2020-10-28T00:00:00Z')
+    end_date = dateutil.parser.parse('2020-10-30T00:00:00Z')
+
+    timesheet = Timesheet(
+        payroll_calendar_id = "00000000-0000-0000-0000-000000000000",
+        employee_id = "00000000-0000-0000-0000-000000000000",
+        start_date = start_date,
+        end_date = end_date)
+    
+    try:
+        api_response = api_instance.create_timesheet(xero_tenant_id, timesheet, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->createTimesheet: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
timesheet * +
+
+ + Timesheet + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createTimesheetLine

+

Create a new timesheet line for a specific time sheet

+
+
+
+

+

+

+
+ 
/Timesheets/{TimesheetID}/Lines
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_timesheet_line():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    idempotency_key = 'KEY_VALUE'
+    date = dateutil.parser.parse('2020-10-28T00:00:00Z')
+
+    timesheet_line = TimesheetLine(
+        timesheet_line_id = "00000000-0000-0000-0000-000000000000",
+        date = date,
+        earnings_rate_id = "00000000-0000-0000-0000-000000000000",
+        tracking_item_id = "00000000-0000-0000-0000-000000000000",
+        number_of_units = 6)
+    
+    try:
+        api_response = api_instance.create_timesheet_line(xero_tenant_id, timesheet_id, timesheetLine, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->createTimesheetLine: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
TimesheetID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the timesheet +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
timesheetLine * +
+
+ + TimesheetLine + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

deleteEmployeeEarningsTemplate

+

Deletes an employee's earnings template record

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/PayTemplates/Earnings/{PayTemplateEarningID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_employee_earnings_template():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    pay_template_earning_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6'
+    
+    try:
+        api_response = api_instance.delete_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->deleteEmployeeEarningsTemplate: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
PayTemplateEarningID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Id for single pay template earnings object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

deleteEmployeeLeave

+

Deletes a leave record for a specific employee

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/Leave/{LeaveID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_employee_leave():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    leave_id = 'c4be24e5-e840-4c92-9eaa-2d86cd596314'
+    
+    try:
+        api_response = api_instance.delete_employee_leave(xero_tenant_id, employee_id, leave_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->deleteEmployeeLeave: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
LeaveID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Leave id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

deleteEmployeeSalaryAndWage

+

Deletes an employee's salary and wages record

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_employee_salary_and_wage():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    salary_and_wages_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6'
+    
+    try:
+        api_response = api_instance.delete_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->deleteEmployeeSalaryAndWage: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
SalaryAndWagesID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Id for single salary and wages object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

deleteEmployeeWorkingPattern

+

deletes employee's working patterns

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/Working-Patterns/{EmployeeWorkingPatternID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_employee_working_pattern():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    employee_working_pattern_id = '4ff1e5cc-9835-40d5-bb18-09f3b118db9c'
+    
+    try:
+        api_response = api_instance.delete_employee_working_pattern(xero_tenant_id, employee_id, employee_working_pattern_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->deleteEmployeeWorkingPattern: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
EmployeeWorkingPatternID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee working pattern id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

deleteTimesheet

+

Deletes a timesheet

+
+
+
+

+

+

+
+ 
/Timesheets/{TimesheetID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_timesheet():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.delete_timesheet(xero_tenant_id, timesheet_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->deleteTimesheet: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
TimesheetID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the timesheet +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

deleteTimesheetLine

+

Deletes a timesheet line for a specific timesheet

+
+
+
+

+

+

+
+ 
/Timesheets/{TimesheetID}/Lines/{TimesheetLineID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_timesheet_line():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    timesheet_line_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.delete_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->deleteTimesheetLine: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
TimesheetID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the timesheet +
+
+
+ Required +
+
+
+
TimesheetLineID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the timesheet line +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getDeduction

+

Retrieves a single deduction by using a unique deduction ID

+
+
+
+

+

+

+
+ 
/Deductions/{deductionId}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_deduction():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    deduction_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.get_deduction(xero_tenant_id, deduction_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getDeduction: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
deductionId* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the deduction +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getDeductions

+

Retrieves deductions for a specific employee

+
+
+
+

+

+

+
+ 
/Deductions
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_deductions():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    
+    try:
+        api_response = api_instance.get_deductions(xero_tenant_id, page)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getDeductions: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + +
NameDescription
page + + +
+
+
+ + Integer + + +
+Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. +
+
+
+
+
+
+
+
+
+
+
+

getEarningsRate

+

Retrieves a specific earnings rates by using a unique earnings rate id

+
+
+
+

+

+

+
+ 
/EarningsRates/{EarningsRateID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_earnings_rate():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    earnings_rate_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.get_earnings_rate(xero_tenant_id, earnings_rate_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getEarningsRate: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EarningsRateID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the earnings rate +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getEarningsRates

+

Retrieves earnings rates

+
+
+
+

+

+

+
+ 
/EarningsRates
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_earnings_rates():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    
+    try:
+        api_response = api_instance.get_earnings_rates(xero_tenant_id, page)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getEarningsRates: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + +
NameDescription
page + + +
+
+
+ + Integer + + +
+Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. +
+
+
+
+
+
+
+
+
+
+
+

getEmployee

+

Retrieves an employees using a unique employee ID

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employee():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_employee(xero_tenant_id, employee_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getEmployee: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getEmployeeLeaveBalances

+

Retrieves leave balances for a specific employee

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/LeaveBalances
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employee_leave_balances():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_employee_leave_balances(xero_tenant_id, employee_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getEmployeeLeaveBalances: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getEmployeeLeavePeriods

+

Retrieves leave periods for a specific employee

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/LeavePeriods
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employee_leave_periods():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    start_date = dateutil.parser.parse("2013-10-20")
+    end_date = dateutil.parser.parse("Johnson")
+    
+    try:
+        api_response = api_instance.get_employee_leave_periods(xero_tenant_id, employee_id, start_date, end_date)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getEmployeeLeavePeriods: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + + + + + +
NameDescription
startDate + + +
+
+
+ + date + + + (date) + + +
+Filter by start date +
+
+
+
+
endDate + + +
+
+
+ + date + + + (date) + + +
+Filter by end date +
+
+
+
+
+
+
+
+
+
+
+

getEmployeeLeaveTypes

+

Retrieves leave types for a specific employee

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/LeaveTypes
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employee_leave_types():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_employee_leave_types(xero_tenant_id, employee_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getEmployeeLeaveTypes: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getEmployeeLeaves

+

Retrieves leave records for a specific employee

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/Leave
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employee_leaves():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_employee_leaves(xero_tenant_id, employee_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getEmployeeLeaves: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getEmployeeOpeningBalances

+

Retrieves the opening balance for a specific employee

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/OpeningBalances
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employee_opening_balances():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_employee_opening_balances(xero_tenant_id, employee_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getEmployeeOpeningBalances: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getEmployeePayTemplates

+

Retrieves pay templates for a specific employee

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/PayTemplates
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employee_pay_templates():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_employee_pay_templates(xero_tenant_id, employee_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getEmployeePayTemplates: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getEmployeePaymentMethod

+

Retrieves available payment methods for a specific employee

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/PaymentMethods
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employee_payment_method():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_employee_payment_method(xero_tenant_id, employee_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getEmployeePaymentMethod: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getEmployeeSalaryAndWage

+

Retrieves an employee's salary and wages record by using a unique salary and wage ID

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employee_salary_and_wage():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    salary_and_wages_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6'
+    
+    try:
+        api_response = api_instance.get_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getEmployeeSalaryAndWage: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
SalaryAndWagesID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Id for single pay template earnings object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getEmployeeSalaryAndWages

+

Retrieves an employee's salary and wages

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/SalaryAndWages
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employee_salary_and_wages():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_employee_salary_and_wages(xero_tenant_id, employee_id, page)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getEmployeeSalaryAndWages: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + +
NameDescription
page + + +
+
+
+ + Integer + + +
+Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. +
+
+
+
+
+
+
+
+
+
+
+

getEmployeeTax

+

Retrieves tax records for a specific employee

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/Tax
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employee_tax():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_employee_tax(xero_tenant_id, employee_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getEmployeeTax: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getEmployeeWorkingPattern

+

Retrieves employee's working patterns

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/Working-Patterns/{EmployeeWorkingPatternID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employee_working_pattern():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    employee_working_pattern_id = '4ff1e5cc-9835-40d5-bb18-09f3b118db9c'
+    
+    try:
+        api_response = api_instance.get_employee_working_pattern(xero_tenant_id, employee_id, employee_working_pattern_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getEmployeeWorkingPattern: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
EmployeeWorkingPatternID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee working pattern id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getEmployeeWorkingPatterns

+

Retrieves employee's working patterns

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/Working-Patterns
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employee_working_patterns():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_employee_working_patterns(xero_tenant_id, employee_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getEmployeeWorkingPatterns: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getEmployees

+

Retrieves employees

+
+
+
+

+

+

+
+ 
/Employees
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employees():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    filter = 'firstName==John,lastName==Smith'
+    
+    try:
+        api_response = api_instance.get_employees(xero_tenant_id, filter, page)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getEmployees: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + + + + + +
NameDescription
filter + + +
+
+
+ + String + + +
+Filter by first name and/or lastname +
+
+
+
+
page + + +
+
+
+ + Integer + + +
+Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. +
+
+
+
+
+
+
+
+
+
+
+

getLeaveType

+

Retrieves a specific leave type by using a unique leave type ID

+
+
+
+

+

+

+
+ 
/LeaveTypes/{LeaveTypeID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_leave_type():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    leave_type_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.get_leave_type(xero_tenant_id, leave_type_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getLeaveType: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
LeaveTypeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the leave type +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getLeaveTypes

+

Retrieves leave types

+
+
+
+

+

+

+
+ 
/LeaveTypes
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_leave_types():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    active_only = 'True'
+    
+    try:
+        api_response = api_instance.get_leave_types(xero_tenant_id, page, active_only)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getLeaveTypes: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + + + + + +
NameDescription
page + + +
+
+
+ + Integer + + +
+Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. +
+
+
+
+
ActiveOnly + + +
+
+
+ + Boolean + + +
+Filters leave types by active status. By default the API returns all leave types. +
+
+
+
+
+
+
+
+
+
+
+

getPayRun

+

Retrieves a specific pay run by using a unique pay run ID

+
+
+
+

+

+

+
+ 
/PayRuns/{PayRunID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_pay_run():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    pay_run_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.get_pay_run(xero_tenant_id, pay_run_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getPayRun: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.payrunsGrant read-write access to payroll payruns
payroll.payruns.readGrant read-only access to payroll payruns
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
PayRunID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the pay run +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getPayRunCalendar

+

Retrieves a specific payrun calendar by using a unique payroll calendar ID

+
+
+
+

+

+

+
+ 
/PayRunCalendars/{PayrollCalendarID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_pay_run_calendar():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    payroll_calendar_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.get_pay_run_calendar(xero_tenant_id, payroll_calendar_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getPayRunCalendar: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
PayrollCalendarID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the payrun calendars +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getPayRunCalendars

+

Retrieves payrun calendars

+
+
+
+

+

+

+
+ 
/PayRunCalendars
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_pay_run_calendars():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    
+    try:
+        api_response = api_instance.get_pay_run_calendars(xero_tenant_id, page)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getPayRunCalendars: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + +
NameDescription
page + + +
+
+
+ + Integer + + +
+Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. +
+
+
+
+
+
+
+
+
+
+
+

getPayRuns

+

Retrieves pay runs

+
+
+
+

+

+

+
+ 
/PayRuns
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_pay_runs():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    status = 'status_example'
+    
+    try:
+        api_response = api_instance.get_pay_runs(xero_tenant_id, page, status)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getPayRuns: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.payrunsGrant read-write access to payroll payruns
payroll.payruns.readGrant read-only access to payroll payruns
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + + + + + +
NameDescription
page + + +
+
+
+ + Integer + + +
+Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. +
+
+
+
+
status + + +
+
+
+ + String + + +
+By default get payruns will return all the payruns for an organization. You can add GET https://api.xero.com/payroll.xro/2.0/payRuns?statu={PayRunStatus} to filter the payruns by status. +
+
+
+
+
+
+
+
+
+
+
+

getPaySlip

+

Retrieves a specific payslip by a unique pay slip ID

+
+
+
+

+

+

+
+ 
/PaySlips/{PaySlipID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_pay_slip():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    pay_slip_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.get_pay_slip(xero_tenant_id, pay_slip_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getPaySlip: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.payslipGrant read-write access to payroll payslips
payroll.payslip.readGrant read-only access to payroll payslips
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
PaySlipID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the payslip +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getPaySlips

+

Retrieves payslips

+
+
+
+

+

+

+
+ 
/PaySlips
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_pay_slips():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    pay_run_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.get_pay_slips(xero_tenant_id, pay_run_id, page)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getPaySlips: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.payslipGrant read-write access to payroll payslips
payroll.payslip.readGrant read-only access to payroll payslips
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + + + + + +
NameDescription
page + + +
+
+
+ + Integer + + +
+Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. +
+
+
+
+
PayRunID* + + +
+
+
+ + UUID + + + (uuid) + + +
+PayrunID which specifies the containing payrun of payslips to retrieve. By default, the API does not group payslips by payrun. +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getReimbursement

+

Retrieves a specific reimbursement by using a unique reimbursement ID

+
+
+
+

+

+

+
+ 
/Reimbursements/{ReimbursementID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_reimbursement():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    reimbursement_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.get_reimbursement(xero_tenant_id, reimbursement_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getReimbursement: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
ReimbursementID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the reimbursement +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getReimbursements

+

Retrieves reimbursements

+
+
+
+

+

+

+
+ 
/Reimbursements
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_reimbursements():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    
+    try:
+        api_response = api_instance.get_reimbursements(xero_tenant_id, page)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getReimbursements: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + +
NameDescription
page + + +
+
+
+ + Integer + + +
+Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. +
+
+
+
+
+
+
+
+
+
+
+

getSettings

+

Retrieves settings

+
+
+
+

+

+

+
+ 
/Settings
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_settings():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    
+    try:
+        api_response = api_instance.get_settings(xero_tenant_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getSettings: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getStatutoryDeduction

+

Retrieves a specific statutory deduction by using a unique statutory deductions id

+
+
+
+

+

+

+
+ 
/StatutoryDeductions/{id}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_statutory_deduction():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.get_statutory_deduction(xero_tenant_id, id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getStatutoryDeduction: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
id* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the statutory deduction +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getStatutoryDeductions

+

Retrieves statutory deductions

+
+
+
+

+

+

+
+ 
/StatutoryDeductions
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_statutory_deductions():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    
+    try:
+        api_response = api_instance.get_statutory_deductions(xero_tenant_id, page)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getStatutoryDeductions: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + +
NameDescription
page + + +
+
+
+ + Integer + + +
+Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. +
+
+
+
+
+
+
+
+
+
+
+

getSuperannuation

+

Retrieves a specific superannuation using a unique superannuation ID

+
+
+
+

+

+

+
+ 
/Superannuations/{SuperannuationID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_superannuation():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    superannuation_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.get_superannuation(xero_tenant_id, superannuation_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getSuperannuation: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
SuperannuationID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the superannuation +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getSuperannuations

+

Retrieves superannuations

+
+
+
+

+

+

+
+ 
/Superannuations
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_superannuations():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    
+    try:
+        api_response = api_instance.get_superannuations(xero_tenant_id, page)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getSuperannuations: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + +
NameDescription
page + + +
+
+
+ + Integer + + +
+Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. +
+
+
+
+
+
+
+
+
+
+
+

getTimesheet

+

Retrieves a specific timesheet by using a unique timesheet ID

+
+
+
+

+

+

+
+ 
/Timesheets/{TimesheetID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_timesheet():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.get_timesheet(xero_tenant_id, timesheet_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getTimesheet: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
payroll.timesheets.readGrant read-only access to payroll timesheets
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
TimesheetID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the timesheet +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getTimesheets

+

Retrieves timesheets

+
+
+
+

+

+

+
+ 
/Timesheets
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_timesheets():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    filter = 'employeeId==00000000-0000-0000-0000-000000000000,payrollCalendarId==00000000-0000-0000-0000-000000000000'
+    status = 'Draft'
+    start_date = '2019-01-02'
+    end_date = '2020-01-02'
+    sort = 'startDate'
+    
+    try:
+        api_response = api_instance.get_timesheets(xero_tenant_id, page, filter, status, start_date, end_date, sort)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getTimesheets: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
payroll.timesheets.readGrant read-only access to payroll timesheets
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription
page + + +
+
+
+ + Integer + + +
+Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. +
+
+
+
+
filter + + +
+
+
+ + String + + +
+Filter by employeeId and/or payrollCalendarId +
+
+
+
+
status + + +
+
+
+ + String + + +
+filter results by any timesheets with a matching timesheet status +
+
+
+
+
startDate + + +
+
+
+ + String + + +
+filter results by any timesheets with a startDate on or after the provided date +
+
+
+
+
endDate + + +
+
+
+ + String + + +
+filter results by any timesheets with a endDate on or before the provided date +
+
+
+
+
sort + + +
+
+
+ + String + + +
+sort the order of timesheets returned. The default is based on the timesheets createdDate, sorted oldest to newest. Currently, the only other option is to reverse the order based on the timesheets startDate, sorted newest to oldest. +
+
+
+
+
+
+
+
+
+
+
+

getTrackingCategories

+

Retrieves tracking categories

+
+
+
+

+

+

+
+ 
/Settings/TrackingCategories
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_tracking_categories():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    
+    try:
+        api_response = api_instance.get_tracking_categories(xero_tenant_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getTrackingCategories: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

revertTimesheet

+

Reverts a timesheet to draft

+
+
+
+

+

+

+
+ 
/Timesheets/{TimesheetID}/RevertToDraft
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_revert_timesheet():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_response = api_instance.revert_timesheet(xero_tenant_id, timesheet_id, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->revertTimesheet: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
TimesheetID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the timesheet +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
+
+
+
+
+
+

updateEmployee

+

Updates an existing employee

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_employee():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+    date_of_birth = dateutil.parser.parse('2000-10-28T00:00:00Z')
+
+    address = Address(
+        address_line_1 = "123 Test st",
+        city = "Rangiora",
+        post_code = "7400",
+        country_name = "NEW ZEALAND")
+
+    employee = Employee(
+        first_name = "Adam",
+        last_name = "Adamson",
+        date_of_birth = date_of_birth,
+        address = address)
+    
+    try:
+        api_response = api_instance.update_employee(xero_tenant_id, employee_id, employee, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->updateEmployee: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
employee * +
+
+ + Employee + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

updateEmployeeEarningsTemplate

+

Updates an earnings template records for an employee

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/PayTemplates/Earnings/{PayTemplateEarningID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_employee_earnings_template():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    pay_template_earning_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6'
+    idempotency_key = 'KEY_VALUE'
+
+    earnings_template = EarningsTemplate(
+        pay_template_earning_id = "00000000-0000-0000-0000-000000000000",
+        rate_per_unit = 14.25,
+        number_of_units = 35.5,
+        fixed_amount = 50,
+        earnings_rate_id = "00000000-0000-0000-0000-000000000000",
+        name = "Overtime Hours")
+    
+    earnings_templates = []    
+    earnings_templates.append(earnings_template)
+    
+    try:
+        api_response = api_instance.update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earningsTemplate, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->updateEmployeeEarningsTemplate: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
PayTemplateEarningID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Id for single pay template earnings object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
earningsTemplate * +
+
+ + EarningsTemplate + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

updateEmployeeLeave

+

Updates leave records for a specific employee

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/Leave/{LeaveID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_employee_leave():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    leave_id = 'c4be24e5-e840-4c92-9eaa-2d86cd596314'
+    idempotency_key = 'KEY_VALUE'
+    start_date = dateutil.parser.parse('2020-10-28T00:00:00Z')
+    end_date = dateutil.parser.parse('2020-10-30T00:00:00Z')
+
+    employee_leave = EmployeeLeave(
+        leave_type_id = "00000000-0000-0000-0000-000000000000",
+        start_date = start_date,
+        end_date = end_date)
+    
+    try:
+        api_response = api_instance.update_employee_leave(xero_tenant_id, employee_id, leave_id, employeeLeave, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->updateEmployeeLeave: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
LeaveID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Leave id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
employeeLeave * +
+
+ + EmployeeLeave + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

updateEmployeeSalaryAndWage

+

Updates an employee's salary and wages record

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_employee_salary_and_wage():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    salary_and_wages_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6'
+    idempotency_key = 'KEY_VALUE'
+
+    salary_and_wage = SalaryAndWage(
+        earnings_rate_id = "00000000-0000-0000-0000-000000000000",
+        number_of_units_per_day = 0,
+        days_per_week = 0,
+        payment_type = payment_type_enum.Hourly)
+    
+    try:
+        api_response = api_instance.update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salaryAndWage, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->updateEmployeeSalaryAndWage: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
SalaryAndWagesID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Id for single pay template earnings object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
salaryAndWage * +
+
+ + SalaryAndWage + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

updateEmployeeTax

+

Updates the tax records for a specific employee

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/Tax
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_employee_tax():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+    student_loan_as_at = dateutil.parser.parse('2020-10-30T00:00:00Z')
+
+    employee_tax = EmployeeTax(
+        ird_number = "111111111",
+        has_special_student_loan_rate = true,
+        special_student_loan_rate_percentage = 2,
+        is_eligible_for_kiwi_saver = true,
+        esct_rate_percentage = 17.5,
+        kiwi_saver_contributions = kiwi_saver_contributions_enum::MAKECONTRIBUTIONS,
+        kiwi_saver_employee_contribution_rate_percentage = 4,
+        kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage = 2,
+        tax_code = tax_code:::MSL,
+        has_student_loan_balance = true,
+        student_loan_balance = 30.0,
+        student_loan_as_at = student_loan_as_at)
+    
+    try:
+        api_response = api_instance.update_employee_tax(xero_tenant_id, employee_id, employeeTax, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->updateEmployeeTax: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
employeeTax * +
+
+ + EmployeeTax + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

updatePaySlipLineItems

+

Creates an employee pay slip

+
+
+
+

+

+

+
+ 
/PaySlips/{PaySlipID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_pay_slip_line_items():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    pay_slip_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    idempotency_key = 'KEY_VALUE'
+
+    earnings_line = EarningsLine(
+        earnings_line_id = "00000000-0000-0000-0000-000000000000",
+        earnings_rate_id = "00000000-0000-0000-0000-000000000000",
+        rate_per_unit = 14.25,
+        number_of_units = 35.5,
+        is_average_daily_pay_rate = true,
+        is_system_generated = true)
+    
+    earnings_lines = []    
+    earnings_lines.append(earnings_line)
+
+    pay_slip = PaySlip(
+        earningsLines = earnings_lines)
+    
+    try:
+        api_response = api_instance.update_pay_slip_line_items(xero_tenant_id, pay_slip_id, paySlip, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->updatePaySlipLineItems: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.payslipGrant read-write access to payroll payslips
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
PaySlipID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the payslip +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
paySlip * +
+
+ + PaySlip + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

updateTimesheetLine

+

Updates a timesheet line for a specific timesheet

+
+
+
+

+

+

+
+ 
/Timesheets/{TimesheetID}/Lines/{TimesheetLineID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_timesheet_line():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    timesheet_line_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    idempotency_key = 'KEY_VALUE'
+    date = dateutil.parser.parse('2020-10-28T00:00:00Z')
+
+    timesheet_line = TimesheetLine(
+        timesheet_line_id = "00000000-0000-0000-0000-000000000000",
+        date = date,
+        earnings_rate_id = "00000000-0000-0000-0000-000000000000",
+        tracking_item_id = "00000000-0000-0000-0000-000000000000",
+        number_of_units = 6)
+    
+    try:
+        api_response = api_instance.update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheetLine, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->updateTimesheetLine: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
TimesheetID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the timesheet +
+
+
+ Required +
+
+
+
TimesheetLineID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the timesheet line +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
timesheetLine * +
+
+ + TimesheetLine + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+ +
+
+
+ + + + + + + + + + + + + + diff --git a/docs/v1/payroll-uk/index.html b/docs/v1/payroll-uk/index.html new file mode 100644 index 00000000..c7c1528a --- /dev/null +++ b/docs/v1/payroll-uk/index.html @@ -0,0 +1,16365 @@ + + + + + Xero Payroll UK + + + + + + xero-python PayrollUk SDK Docs + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ + +
+
+ +
+
+ +
+
+
+
+
+ +
+
+
+
+

Xero Payroll UK

+
+
+
+ +
+
+

PayrollUk

+
+
+
+

approveTimesheet

+

Approves a specific timesheet

+
+
+
+

+

+

+
+ 
/Timesheets/{TimesheetID}/Approve
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_approve_timesheet():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_response = api_instance.approve_timesheet(xero_tenant_id, timesheet_id, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->approveTimesheet: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
TimesheetID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the timesheet +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
+
+
+
+
+
+

createBenefit

+

Creates a new employee benefit

+
+
+
+

+

+

+
+ 
/Benefits
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_benefit():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    idempotency_key = 'KEY_VALUE'
+
+    benefit = Benefit(
+        name = "Benefit Name",
+        expense_account_id = "00000000-0000-0000-0000-000000000000",
+        liability_account_id = "00000000-0000-0000-0000-000000000000",
+        is_calculating_on_qualifying_earnings = true)
+    
+    try:
+        api_response = api_instance.create_benefit(xero_tenant_id, benefit, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->createBenefit: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.settingsGrant read-write access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
benefit * +
+
+ + Benefit + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createDeduction

+

Creates a new deduction

+
+
+
+

+

+

+
+ 
/Deductions
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_deduction():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    idempotency_key = 'KEY_VALUE'
+
+    deduction = Deduction(
+        deduction_name = "Test Deduction",
+        deduction_category = deduction_category_enum::STAKEHOLDERPENSION,
+        liability_account_id = "00000000-0000-0000-0000-000000000000",
+        calculation_type = calculation_type_enum::PERCENTAGEOFGROSS)
+    
+    try:
+        api_response = api_instance.create_deduction(xero_tenant_id, deduction, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->createDeduction: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.settingsGrant read-write access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
deduction * +
+
+ + Deduction + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createEarningsRate

+

Creates a new earnings rate

+
+
+
+

+

+

+
+ 
/EarningsRates
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_earnings_rate():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    idempotency_key = 'KEY_VALUE'
+
+    earnings_rate = EarningsRate(
+        earnings_type = earnings_type_enum::REGULAREARNINGS,
+        rate_type = "RatePerUnit",
+        expense_account_id = "00000000-0000-0000-0000-000000000000",
+        type_of_units = "Type")
+    
+    try:
+        api_response = api_instance.create_earnings_rate(xero_tenant_id, earningsRate, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->createEarningsRate: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.settingsGrant read-write access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
earningsRate * +
+
+ + EarningsRate + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createEmployee

+

Creates employees

+
+
+
+

+

+

+
+ 
/Employees
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_employee():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    idempotency_key = 'KEY_VALUE'
+    date_of_birth = dateutil.parser.parse('2000-10-28T00:00:00Z')
+
+    address = Address(
+        address_line_1 = "123 Test st",
+        city = "Rangiora",
+        post_code = "7400",
+        country_name = "UNITED KINGDOM")
+
+    employee = Employee(
+        first_name = "Adam",
+        last_name = "Adamson",
+        date_of_birth = date_of_birth,
+        address = address)
+    
+    try:
+        api_response = api_instance.create_employee(xero_tenant_id, employee, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->createEmployee: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
employee * +
+
+ + Employee + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createEmployeeEarningsTemplate

+

Creates an earnings template records for a specific employee

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/PayTemplates/earnings
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_employee_earnings_template():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+
+    earnings_template = EarningsTemplate(
+        pay_template_earning_id = "00000000-0000-0000-0000-000000000000",
+        rate_per_unit = 14.25,
+        number_of_units = 35.5,
+        fixed_amount = 50,
+        earnings_rate_id = "00000000-0000-0000-0000-000000000000",
+        name = "Overtime Hours")
+    
+    earnings_templates = []    
+    earnings_templates.append(earnings_template)
+    
+    try:
+        api_response = api_instance.create_employee_earnings_template(xero_tenant_id, employee_id, earningsTemplate, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->createEmployeeEarningsTemplate: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
earningsTemplate * +
+
+ + EarningsTemplate + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createEmployeeLeave

+

Creates leave records for a specific employee

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/Leave
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_employee_leave():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+    start_date = dateutil.parser.parse('2020-10-28T00:00:00Z')
+    end_date = dateutil.parser.parse('2020-10-30T00:00:00Z')
+
+    employee_leave = EmployeeLeave(
+        leave_type_id = "00000000-0000-0000-0000-000000000000",
+        start_date = start_date,
+        end_date = end_date)
+    
+    try:
+        api_response = api_instance.create_employee_leave(xero_tenant_id, employee_id, employeeLeave, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->createEmployeeLeave: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
employeeLeave * +
+
+ + EmployeeLeave + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createEmployeeLeaveType

+

Creates employee leave type records

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/LeaveTypes
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_employee_leave_type():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+
+    employee_leave_type = EmployeeLeaveType(
+        leave_type_id = "00000000-0000-0000-0000-000000000000",
+        schedule_of_accrual = schedule_of_accrual::BEGINNINGOFCALENDARYEAR,
+        opening_balance = 5.25,
+        schedule_of_accrual_date = 2024-05-01)
+    
+    try:
+        api_response = api_instance.create_employee_leave_type(xero_tenant_id, employee_id, employeeLeaveType, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->createEmployeeLeaveType: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
employeeLeaveType * +
+
+ + EmployeeLeaveType + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createEmployeeOpeningBalances

+

Creates an opening balance for a specific employee

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/ukopeningbalances
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_employee_opening_balances():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+
+    employee_opening_balances = EmployeeOpeningBalances(
+        statutory_maternity_pay = 0.0,
+        statutory_adoption_pay = 100.0,
+        statutory_paternity_pay = 0.0,
+        statutory_shared_parental_pay = 0.0,
+        statutory_sick_pay = 0.0)
+    
+    try:
+        api_response = api_instance.create_employee_opening_balances(xero_tenant_id, employee_id, employeeOpeningBalances, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->createEmployeeOpeningBalances: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
employeeOpeningBalances * +
+
+ + EmployeeOpeningBalances + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createEmployeePaymentMethod

+

Creates an employee payment method

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/PaymentMethods
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_employee_payment_method():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+
+    bank_account = BankAccount(
+        account_name = "Charlotte Danes",
+        account_number = "123456",
+        sort_code = "123411")
+    
+    bank_accounts = []    
+    bank_accounts.append(bank_account)
+
+    payment_method = PaymentMethod(
+        bankAccounts = bankAccounts)
+    
+    try:
+        api_response = api_instance.create_employee_payment_method(xero_tenant_id, employee_id, paymentMethod, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->createEmployeePaymentMethod: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
paymentMethod * +
+
+ + PaymentMethod + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createEmployeeSalaryAndWage

+

Creates a salary and wage record for a specific employee

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/SalaryAndWages
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_employee_salary_and_wage():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+
+    salary_and_wage = SalaryAndWage(
+        earnings_rate_id = "00000000-0000-0000-0000-000000000000",
+        number_of_units_per_day = 0,
+        number_of_units_per_week = 0,
+        payment_type = payment_type_enum.Salary,
+        status = status_enum.Active)
+    
+    try:
+        api_response = api_instance.create_employee_salary_and_wage(xero_tenant_id, employee_id, salaryAndWage, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->createEmployeeSalaryAndWage: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
salaryAndWage * +
+
+ + SalaryAndWage + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createEmployeeStatutorySickLeave

+

Creates statutory sick leave records

+
+
+
+

+

+

+
+ 
/StatutoryLeaves/Sick
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_employee_statutory_sick_leave():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    idempotency_key = 'KEY_VALUE'
+    start_date = dateutil.parser.parse('2020-10-28T00:00:00Z')
+    end_date = dateutil.parser.parse('2020-10-30T00:00:00Z')
+
+    employee_statutory_sick_leave = EmployeeStatutorySickLeave(
+        is_pregnancy_related = true,
+        leave_type_id = "00000000-0000-0000-0000-000000000000",
+        start_date = start_date,
+        end_date = end_date)
+    
+    try:
+        api_response = api_instance.create_employee_statutory_sick_leave(xero_tenant_id, employeeStatutorySickLeave, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->createEmployeeStatutorySickLeave: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.settingsGrant read-write access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
employeeStatutorySickLeave * +
+
+ + EmployeeStatutorySickLeave + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createEmployment

+

Creates employment detail for a specific employee using a unique employee ID

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/Employment
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_employment():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+    start_date = dateutil.parser.parse('2020-10-28T00:00:00Z')
+
+    employment = Employment(
+        payroll_calendar_id = "00000000-0000-0000-0000-000000000000",
+        start_date = start_date)
+
+    ni_categories = NICategories(
+    
+    try:
+        api_response = api_instance.create_employment(xero_tenant_id, employee_id, employment, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->createEmployment: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
employment * +
+
+ + Employment + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createLeaveType

+

Creates a new leave type

+
+
+
+

+

+

+
+ 
/LeaveTypes
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_leave_type():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    idempotency_key = 'KEY_VALUE'
+
+    leave_type = LeaveType(
+        name = "LeaveType",
+        is_paid_leave = true,
+        show_on_payslip = true)
+    
+    try:
+        api_response = api_instance.create_leave_type(xero_tenant_id, leaveType, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->createLeaveType: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.settingsGrant read-write access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
leaveType * +
+
+ + LeaveType + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createMultipleEmployeeEarningsTemplate

+

Creates multiple earnings template records for a specific employee using a unique employee ID

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/paytemplateearnings
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_multiple_employee_earnings_template():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+
+    earnings_template = EarningsTemplate(
+        pay_template_earning_id = "00000000-0000-0000-0000-000000000000",
+        rate_per_unit = 14.25,
+        number_of_units = 35.5,
+        fixed_amount = 50,
+        earnings_rate_id = "00000000-0000-0000-0000-000000000000",
+        name = "Overtime Hours")
+    
+    earnings_templates = []    
+    earnings_templates.append(earnings_template)
+    
+    try:
+        api_response = api_instance.create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earningsTemplate, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->createMultipleEmployeeEarningsTemplate: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
earningsTemplate * +
+
+ + array[EarningsTemplate] + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createPayRunCalendar

+

Creates a new payrun calendar

+
+
+
+

+

+

+
+ 
/PayRunCalendars
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_pay_run_calendar():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    idempotency_key = 'KEY_VALUE'
+    start_date = dateutil.parser.parse('2020-10-28T00:00:00Z')
+    payment_date = dateutil.parser.parse('2020-10-30T00:00:00Z')
+
+    pay_run_calendar = PayRunCalendar(
+        calendar_type = calendar_type_enum.WEEKLY,
+        period_start_date = start_date,
+        payment_date = payment_date)
+    
+    try:
+        api_response = api_instance.create_pay_run_calendar(xero_tenant_id, payRunCalendar, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->createPayRunCalendar: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.settingsGrant read-write access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
payRunCalendar * +
+
+ + PayRunCalendar + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createReimbursement

+

Creates a new reimbursement

+
+
+
+

+

+

+
+ 
/Reimbursements
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_reimbursement():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    idempotency_key = 'KEY_VALUE'
+
+    reimbursement = Reimbursement(
+        name = "Test Reimbursement",
+        account_id = "00000000-0000-0000-0000-000000000000")
+    
+    try:
+        api_response = api_instance.create_reimbursement(xero_tenant_id, reimbursement, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->createReimbursement: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.settingsGrant read-write access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
reimbursement * +
+
+ + Reimbursement + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createTimesheet

+

Creates a new timesheet

+
+
+
+

+

+

+
+ 
/Timesheets
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_timesheet():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    idempotency_key = 'KEY_VALUE'
+    start_date = dateutil.parser.parse('2020-10-28T00:00:00Z')
+    end_date = dateutil.parser.parse('2020-10-30T00:00:00Z')
+
+    timesheet = Timesheet(
+        payroll_calendar_id = "00000000-0000-0000-0000-000000000000",
+        employee_id = "00000000-0000-0000-0000-000000000000",
+        start_date = start_date,
+        end_date = end_date)
+    
+    try:
+        api_response = api_instance.create_timesheet(xero_tenant_id, timesheet, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->createTimesheet: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
timesheet * +
+
+ + Timesheet + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createTimesheetLine

+

Creates a new timesheet line for a specific timesheet using a unique timesheet ID

+
+
+
+

+

+

+
+ 
/Timesheets/{TimesheetID}/Lines
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_timesheet_line():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    idempotency_key = 'KEY_VALUE'
+    date = dateutil.parser.parse('2020-10-28T00:00:00Z')
+
+    timesheet_line = TimesheetLine(
+        timesheet_line_id = "00000000-0000-0000-0000-000000000000",
+        date = date,
+        earnings_rate_id = "00000000-0000-0000-0000-000000000000",
+        tracking_item_id = "00000000-0000-0000-0000-000000000000",
+        number_of_units = 6)
+    
+    try:
+        api_response = api_instance.create_timesheet_line(xero_tenant_id, timesheet_id, timesheetLine, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->createTimesheetLine: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
TimesheetID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the timesheet +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
timesheetLine * +
+
+ + TimesheetLine + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

deleteEmployeeEarningsTemplate

+

Deletes a specific employee's earnings template record

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_employee_earnings_template():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    pay_template_earning_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6'
+    
+    try:
+        api_instance.delete_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->deleteEmployeeEarningsTemplate: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
PayTemplateEarningID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Id for single pay template earnings object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

deleteEmployeeLeave

+

Deletes a specific employee's leave record

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/Leave/{LeaveID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_employee_leave():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    leave_id = 'c4be24e5-e840-4c92-9eaa-2d86cd596314'
+    
+    try:
+        api_response = api_instance.delete_employee_leave(xero_tenant_id, employee_id, leave_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->deleteEmployeeLeave: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
LeaveID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Leave id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

deleteEmployeeSalaryAndWage

+

Deletes a salary and wages record for a specific employee

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_employee_salary_and_wage():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    salary_and_wages_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6'
+    
+    try:
+        api_instance.delete_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->deleteEmployeeSalaryAndWage: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
SalaryAndWagesID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Id for single salary and wages object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

deleteTimesheet

+

Deletes a specific timesheet

+
+
+
+

+

+

+
+ 
/Timesheets/{TimesheetID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_timesheet():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.delete_timesheet(xero_tenant_id, timesheet_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->deleteTimesheet: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
TimesheetID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the timesheet +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

deleteTimesheetLine

+

Deletes a specific timesheet line

+
+
+
+

+

+

+
+ 
/Timesheets/{TimesheetID}/Lines/{TimesheetLineID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_timesheet_line():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    timesheet_line_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.delete_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->deleteTimesheetLine: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
TimesheetID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the timesheet +
+
+
+ Required +
+
+
+
TimesheetLineID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the timesheet line +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getBenefit

+

Retrieves a specific benefit by using a unique benefit ID

+
+
+
+

+

+

+
+ 
/Benefits/{id}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_benefit():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.get_benefit(xero_tenant_id, id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getBenefit: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
id* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the benefit +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getBenefits

+

Retrieves employee benefits

+
+
+
+

+

+

+
+ 
/Benefits
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_benefits():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    
+    try:
+        api_response = api_instance.get_benefits(xero_tenant_id, page)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getBenefits: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + +
NameDescription
page + + +
+
+
+ + Integer + + +
+Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. +
+
+
+
+
+
+
+
+
+
+
+

getDeduction

+

Retrieves a specific deduction by using a unique deduction ID

+
+
+
+

+

+

+
+ 
/Deductions/{deductionId}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_deduction():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    deduction_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.get_deduction(xero_tenant_id, deduction_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getDeduction: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
deductionId* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the deduction +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getDeductions

+

Retrieves deductions

+
+
+
+

+

+

+
+ 
/Deductions
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_deductions():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    
+    try:
+        api_response = api_instance.get_deductions(xero_tenant_id, page)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getDeductions: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + +
NameDescription
page + + +
+
+
+ + Integer + + +
+Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. +
+
+
+
+
+
+
+
+
+
+
+

getEarningsOrder

+

Retrieves a specific earnings orders by using a unique earnings orders id

+
+
+
+

+

+

+
+ 
/EarningsOrders/{id}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_earnings_order():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.get_earnings_order(xero_tenant_id, id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getEarningsOrder: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
id* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the deduction +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getEarningsOrders

+

Retrieves earnings orders

+
+
+
+

+

+

+
+ 
/EarningsOrders
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_earnings_orders():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    
+    try:
+        api_response = api_instance.get_earnings_orders(xero_tenant_id, page)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getEarningsOrders: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + +
NameDescription
page + + +
+
+
+ + Integer + + +
+Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. +
+
+
+
+
+
+
+
+
+
+
+

getEarningsRate

+

Retrieves a specific earnings rates by using a unique earnings rate id

+
+
+
+

+

+

+
+ 
/EarningsRates/{EarningsRateID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_earnings_rate():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    earnings_rate_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.get_earnings_rate(xero_tenant_id, earnings_rate_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getEarningsRate: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EarningsRateID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the earnings rate +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getEarningsRates

+

Retrieves earnings rates

+
+
+
+

+

+

+
+ 
/EarningsRates
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_earnings_rates():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    
+    try:
+        api_response = api_instance.get_earnings_rates(xero_tenant_id, page)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getEarningsRates: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + +
NameDescription
page + + +
+
+
+ + Integer + + +
+Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. +
+
+
+
+
+
+
+
+
+
+
+

getEmployee

+

Retrieves specific employees by using a unique employee ID

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employee():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_employee(xero_tenant_id, employee_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getEmployee: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getEmployeeLeave

+

Retrieves a specific employee's leave record using a unique employee ID

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/Leave/{LeaveID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employee_leave():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    leave_id = 'c4be24e5-e840-4c92-9eaa-2d86cd596314'
+    
+    try:
+        api_response = api_instance.get_employee_leave(xero_tenant_id, employee_id, leave_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getEmployeeLeave: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
LeaveID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Leave id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getEmployeeLeaveBalances

+

Retrieves a specific employee's leave balances using a unique employee ID

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/LeaveBalances
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employee_leave_balances():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_employee_leave_balances(xero_tenant_id, employee_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getEmployeeLeaveBalances: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getEmployeeLeavePeriods

+

Retrieves a specific employee's leave periods using a unique employee ID

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/LeavePeriods
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employee_leave_periods():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '00000000-0000-0000-0000-000000000000'
+    start_date = dateutil.parser.parse("2013-10-20")
+    end_date = dateutil.parser.parse("2013-10-20")
+    
+    try:
+        api_response = api_instance.get_employee_leave_periods(xero_tenant_id, employee_id, start_date, end_date)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getEmployeeLeavePeriods: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + + + + + +
NameDescription
startDate + + +
+
+
+ + date + + + (date) + + +
+Filter by start date +
+
+
+
+
endDate + + +
+
+
+ + date + + + (date) + + +
+Filter by end date +
+
+
+
+
+
+
+
+
+
+
+

getEmployeeLeaveTypes

+

Retrieves a specific employee's leave types using a unique employee ID

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/LeaveTypes
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employee_leave_types():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_employee_leave_types(xero_tenant_id, employee_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getEmployeeLeaveTypes: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getEmployeeLeaves

+

Retrieves a specific employee's leave records using a unique employee ID

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/Leave
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employee_leaves():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_employee_leaves(xero_tenant_id, employee_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getEmployeeLeaves: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getEmployeeOpeningBalances

+

Retrieves a specific employee's openingbalances using a unique employee ID

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/ukopeningbalances
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employee_opening_balances():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_employee_opening_balances(xero_tenant_id, employee_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getEmployeeOpeningBalances: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getEmployeePayTemplate

+

Retrieves a specific employee pay templates using a unique employee ID

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/PayTemplates
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employee_pay_template():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_employee_pay_template(xero_tenant_id, employee_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getEmployeePayTemplate: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getEmployeePaymentMethod

+

Retrieves a specific employee's payment method using a unique employee ID

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/PaymentMethods
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employee_payment_method():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_employee_payment_method(xero_tenant_id, employee_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getEmployeePaymentMethod: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getEmployeeSalaryAndWage

+

Retrieves a specific salary and wages record for a specific employee using a unique salary and wage id

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employee_salary_and_wage():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    salary_and_wages_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6'
+    
+    try:
+        api_response = api_instance.get_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getEmployeeSalaryAndWage: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
SalaryAndWagesID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Id for single pay template earnings object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getEmployeeSalaryAndWages

+

Retrieves a specific employee's salary and wages by using a unique employee ID

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/SalaryAndWages
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employee_salary_and_wages():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_employee_salary_and_wages(xero_tenant_id, employee_id, page)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getEmployeeSalaryAndWages: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + +
NameDescription
page + + +
+
+
+ + Integer + + +
+Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. +
+
+
+
+
+
+
+
+
+
+
+

getEmployeeStatutoryLeaveBalances

+

Retrieves a specific employee's leave balances using a unique employee ID

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/StatutoryLeaveBalance
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employee_statutory_leave_balances():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    leave_type = 'sick'
+    as_of_date = dateutil.parser.parse("2013-10-20")
+    
+    try:
+        api_response = api_instance.get_employee_statutory_leave_balances(xero_tenant_id, employee_id, leave_type, as_of_date)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getEmployeeStatutoryLeaveBalances: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + + + + + +
NameDescription
LeaveType + + +
+
+
+ + String + + +
+Filter by the type of statutory leave +
+
+
+
+
AsOfDate + + +
+
+
+ + date + + + (date) + + +
+The date from which to calculate balance remaining. If not specified, current date UTC is used. +
+
+
+
+
+
+
+
+
+
+
+

getEmployeeStatutorySickLeave

+

Retrieves a statutory sick leave for an employee

+
+
+
+

+

+

+
+ 
/StatutoryLeaves/Sick/{StatutorySickLeaveID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employee_statutory_sick_leave():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    statutory_sick_leave_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_employee_statutory_sick_leave(xero_tenant_id, statutory_sick_leave_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getEmployeeStatutorySickLeave: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
StatutorySickLeaveID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Statutory sick leave id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getEmployeeTax

+

Retrieves tax records for a specific employee using a unique employee ID

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/Tax
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employee_tax():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_employee_tax(xero_tenant_id, employee_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getEmployeeTax: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getEmployees

+

Retrieves employees

+
+
+
+

+

+

+
+ 
/Employees
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employees():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    filter = 'firstName==John,lastName==Smith,isOffPayrollWorker==false'
+    
+    try:
+        api_response = api_instance.get_employees(xero_tenant_id, filter, page)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getEmployees: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + + + + + +
NameDescription
filter + + +
+
+
+ + String + + +
+Filter by first name, lastname, and/or whether they are an off-payroll worker +
+
+
+
+
page + + +
+
+
+ + Integer + + +
+Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. +
+
+
+
+
+
+
+
+
+
+
+

getLeaveType

+

Retrieves a specific leave type by using a unique leave type ID

+
+
+
+

+

+

+
+ 
/LeaveTypes/{LeaveTypeID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_leave_type():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    leave_type_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.get_leave_type(xero_tenant_id, leave_type_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getLeaveType: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
LeaveTypeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the leave type +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getLeaveTypes

+

Retrieves leave types

+
+
+
+

+

+

+
+ 
/LeaveTypes
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_leave_types():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    active_only = 'true'
+    
+    try:
+        api_response = api_instance.get_leave_types(xero_tenant_id, page, active_only)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getLeaveTypes: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + + + + + +
NameDescription
page + + +
+
+
+ + Integer + + +
+Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. +
+
+
+
+
ActiveOnly + + +
+
+
+ + Boolean + + +
+Filters leave types by active status. By default the API returns all leave types. +
+
+
+
+
+
+
+
+
+
+
+

getPayRun

+

Retrieves a specific pay run by using a unique pay run ID

+
+
+
+

+

+

+
+ 
/PayRuns/{PayRunID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_pay_run():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    pay_run_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.get_pay_run(xero_tenant_id, pay_run_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getPayRun: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.payrunsGrant read-write access to payroll payruns
payroll.payruns.readGrant read-only access to payroll payruns
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
PayRunID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the pay run +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getPayRunCalendar

+

Retrieves a specific payrun calendar by using a unique payrun calendar ID

+
+
+
+

+

+

+
+ 
/PayRunCalendars/{PayRunCalendarID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_pay_run_calendar():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    pay_run_calendar_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.get_pay_run_calendar(xero_tenant_id, pay_run_calendar_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getPayRunCalendar: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
PayRunCalendarID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the payrun calendars +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getPayRunCalendars

+

Retrieves payrun calendars

+
+
+
+

+

+

+
+ 
/PayRunCalendars
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_pay_run_calendars():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    
+    try:
+        api_response = api_instance.get_pay_run_calendars(xero_tenant_id, page)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getPayRunCalendars: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + +
NameDescription
page + + +
+
+
+ + Integer + + +
+Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. +
+
+
+
+
+
+
+
+
+
+
+

getPayRuns

+

Retrieves pay runs

+
+
+
+

+

+

+
+ 
/PayRuns
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_pay_runs():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    status = 'status_example'
+    
+    try:
+        api_response = api_instance.get_pay_runs(xero_tenant_id, page, status)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getPayRuns: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.payrunsGrant read-write access to payroll payruns
payroll.payruns.readGrant read-only access to payroll payruns
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + + + + + +
NameDescription
page + + +
+
+
+ + Integer + + +
+Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. +
+
+
+
+
status + + +
+
+
+ + String + + +
+By default get payruns will return all the payruns for an organization. You can add GET https://api.xero.com/payroll.xro/2.0/payRuns?statu={PayRunStatus} to filter the payruns by status. +
+
+
+
+
+
+
+
+
+
+
+

getPaySlip

+

Retrieves a specific payslip by using a unique payslip ID

+
+
+
+

+

+

+
+ 
/Payslips/{PayslipID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_pay_slip():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    payslip_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.get_pay_slip(xero_tenant_id, payslip_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getPaySlip: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.payslipGrant read-write access to payroll payslips
payroll.payslip.readGrant read-only access to payroll payslips
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
PayslipID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the payslip +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getPaySlips

+

Retrieves payslips

+
+
+
+

+

+

+
+ 
/Payslips
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_pay_slips():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    pay_run_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.get_pay_slips(xero_tenant_id, pay_run_id, page)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getPaySlips: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.payslipGrant read-write access to payroll payslips
payroll.payslip.readGrant read-only access to payroll payslips
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + + + + + +
NameDescription
page + + +
+
+
+ + Integer + + +
+Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. +
+
+
+
+
PayRunID* + + +
+
+
+ + UUID + + + (uuid) + + +
+PayrunID which specifies the containing payrun of payslips to retrieve. By default, the API does not group payslips by payrun. +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getReimbursement

+

Retrieves a specific reimbursement by using a unique reimbursement id

+
+
+
+

+

+

+
+ 
/Reimbursements/{ReimbursementID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_reimbursement():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    reimbursement_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.get_reimbursement(xero_tenant_id, reimbursement_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getReimbursement: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
ReimbursementID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the reimbursement +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getReimbursements

+

Retrieves reimbursements

+
+
+
+

+

+

+
+ 
/Reimbursements
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_reimbursements():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    
+    try:
+        api_response = api_instance.get_reimbursements(xero_tenant_id, page)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getReimbursements: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + +
NameDescription
page + + +
+
+
+ + Integer + + +
+Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. +
+
+
+
+
+
+
+
+
+
+
+

getSettings

+

Retrieves payroll settings

+
+
+
+

+

+

+
+ 
/Settings
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_settings():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    
+    try:
+        api_response = api_instance.get_settings(xero_tenant_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getSettings: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getStatutoryLeaveSummary

+

Retrieves a specific employee's summary of statutory leaves using a unique employee ID

+
+
+
+

+

+

+
+ 
/StatutoryLeaves/Summary/{EmployeeID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_statutory_leave_summary():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    active_only = 'true'
+    
+    try:
+        api_response = api_instance.get_statutory_leave_summary(xero_tenant_id, employee_id, active_only)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getStatutoryLeaveSummary: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + +
NameDescription
activeOnly + + +
+
+
+ + Boolean + + +
+Filter response with leaves that are currently active or yet to be taken. If not specified, all leaves (past, current, and future scheduled) are returned +
+
+
+
+
+
+
+
+
+
+
+

getTimesheet

+

Retrieve a specific timesheet by using a unique timesheet ID

+
+
+
+

+

+

+
+ 
/Timesheets/{TimesheetID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_timesheet():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.get_timesheet(xero_tenant_id, timesheet_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getTimesheet: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
payroll.timesheets.readGrant read-only access to payroll timesheets
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
TimesheetID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the timesheet +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getTimesheets

+

Retrieves timesheets

+
+
+
+

+

+

+
+ 
/Timesheets
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_timesheets():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    filter = 'employeeId==00000000-0000-0000-0000-000000000000,payrollCalendarId==00000000-0000-0000-0000-000000000000'
+    status = 'Draft'
+    start_date = '2019-01-02'
+    end_date = '2020-01-02'
+    sort = 'startDate'
+    
+    try:
+        api_response = api_instance.get_timesheets(xero_tenant_id, page, filter, status, start_date, end_date, sort)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getTimesheets: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
payroll.timesheets.readGrant read-only access to payroll timesheets
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription
page + + +
+
+
+ + Integer + + +
+Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. +
+
+
+
+
filter + + +
+
+
+ + String + + +
+Filter by employeeId and/or payrollCalendarId +
+
+
+
+
status + + +
+
+
+ + String + + +
+filter results by any timesheets with a matching timesheet status +
+
+
+
+
startDate + + +
+
+
+ + String + + +
+filter results by any timesheets with a startDate on or after the provided date +
+
+
+
+
endDate + + +
+
+
+ + String + + +
+filter results by any timesheets with a endDate on or before the provided date +
+
+
+
+
sort + + +
+
+
+ + String + + +
+sort the order of timesheets returned. The default is based on the timesheets createdDate, sorted oldest to newest. Currently, the only other option is to reverse the order based on the timesheets startDate, sorted newest to oldest. +
+
+
+
+
+
+
+
+
+
+
+

getTrackingCategories

+

Retrieves tracking categories

+
+
+
+

+

+

+
+ 
/Settings/trackingCategories
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_tracking_categories():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    
+    try:
+        api_response = api_instance.get_tracking_categories(xero_tenant_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->getTrackingCategories: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

revertTimesheet

+

Reverts a specific timesheet to draft

+
+
+
+

+

+

+
+ 
/Timesheets/{TimesheetID}/RevertToDraft
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_revert_timesheet():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_response = api_instance.revert_timesheet(xero_tenant_id, timesheet_id, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->revertTimesheet: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
TimesheetID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the timesheet +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
+
+
+
+
+
+

updateEmployee

+

Updates a specific employee's detail

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_employee():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+    date_of_birth = dateutil.parser.parse('2000-10-28T00:00:00Z')
+
+    address = Address(
+        address_line_1 = "123 Test st",
+        city = "Rangiora",
+        post_code = "7400",
+        country_name = "NEW ZEALAND")
+
+    employee = Employee(
+        first_name = "Adam",
+        last_name = "Adamson",
+        date_of_birth = date_of_birth,
+        address = address)
+    
+    try:
+        api_response = api_instance.update_employee(xero_tenant_id, employee_id, employee, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->updateEmployee: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
employee * +
+
+ + Employee + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

updateEmployeeEarningsTemplate

+

Updates a specific employee's earnings template records

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_employee_earnings_template():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    pay_template_earning_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6'
+    idempotency_key = 'KEY_VALUE'
+
+    earnings_template = EarningsTemplate(
+        pay_template_earning_id = "00000000-0000-0000-0000-000000000000",
+        rate_per_unit = 14.25,
+        number_of_units = 35.5,
+        fixed_amount = 50,
+        earnings_rate_id = "00000000-0000-0000-0000-000000000000",
+        name = "Overtime Hours")
+    
+    earnings_templates = []    
+    earnings_templates.append(earnings_template)
+    
+    try:
+        api_response = api_instance.update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earningsTemplate, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->updateEmployeeEarningsTemplate: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
PayTemplateEarningID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Id for single pay template earnings object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
earningsTemplate * +
+
+ + EarningsTemplate + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

updateEmployeeLeave

+

Updates a specific employee's leave records

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/Leave/{LeaveID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_employee_leave():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    leave_id = 'c4be24e5-e840-4c92-9eaa-2d86cd596314'
+    idempotency_key = 'KEY_VALUE'
+    start_date = dateutil.parser.parse('2020-10-28T00:00:00Z')
+    end_date = dateutil.parser.parse('2020-10-30T00:00:00Z')
+
+    employee_leave = EmployeeLeave(
+        leave_type_id = "00000000-0000-0000-0000-000000000000",
+        start_date = start_date,
+        end_date = end_date)
+    
+    try:
+        api_response = api_instance.update_employee_leave(xero_tenant_id, employee_id, leave_id, employeeLeave, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->updateEmployeeLeave: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
LeaveID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Leave id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
employeeLeave * +
+
+ + EmployeeLeave + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

updateEmployeeOpeningBalances

+

Updates a specific employee's opening balances

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/ukopeningbalances
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_employee_opening_balances():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+
+    employee_opening_balances = EmployeeOpeningBalances(
+        statutory_maternity_pay = 0.0,
+        statutory_adoption_pay = 100.0,
+        statutory_paternity_pay = 0.0,
+        statutory_shared_parental_pay = 0.0,
+        statutory_sick_pay = 0.0)
+    
+    try:
+        api_response = api_instance.update_employee_opening_balances(xero_tenant_id, employee_id, employeeOpeningBalances, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->updateEmployeeOpeningBalances: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
employeeOpeningBalances * +
+
+ + EmployeeOpeningBalances + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

updateEmployeeSalaryAndWage

+

Updates salary and wages record for a specific employee

+
+
+
+

+

+

+
+ 
/Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_employee_salary_and_wage():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    salary_and_wages_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6'
+    idempotency_key = 'KEY_VALUE'
+
+    salary_and_wage = SalaryAndWage(
+        earnings_rate_id = "00000000-0000-0000-0000-000000000000",
+        number_of_units_per_day = 0,
+        number_of_units_per_week = 0,
+        payment_type = payment_type_enum.Salary,
+        status = status_enum.Active)
+    
+    try:
+        api_response = api_instance.update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salaryAndWage, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->updateEmployeeSalaryAndWage: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.employeesGrant read-write access to payroll employees
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
EmployeeID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Employee id for single object +
+
+
+ Required +
+
+
+
SalaryAndWagesID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Id for single pay template earnings object +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
salaryAndWage * +
+
+ + SalaryAndWage + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

updateTimesheetLine

+

Updates a specific timesheet line for a specific timesheet

+
+
+
+

+

+

+
+ 
/Timesheets/{TimesheetID}/Lines/{TimesheetLineID}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_timesheet_line():
+    api_instance = PayrollUkApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    timesheet_line_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    idempotency_key = 'KEY_VALUE'
+    date = dateutil.parser.parse('2020-10-28T00:00:00Z')
+
+    timesheet_line = TimesheetLine(
+        timesheet_line_id = "00000000-0000-0000-0000-000000000000",
+        date = date,
+        earnings_rate_id = "00000000-0000-0000-0000-000000000000",
+        tracking_item_id = "00000000-0000-0000-0000-000000000000",
+        number_of_units = 6)
+    
+    try:
+        api_response = api_instance.update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheetLine, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollUkApi->updateTimesheetLine: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
payroll.timesheetsGrant read-write access to payroll timesheets
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
TimesheetID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the timesheet +
+
+
+ Required +
+
+
+
TimesheetLineID* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier for the timesheet line +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
timesheetLine * +
+
+ + TimesheetLine + +
+ +
+
+
+ Required +
+
+ +
+
+
+
+
+
+ +
+
+
+ + + + + + + + + + + + + + diff --git a/docs/v1/projects/index.html b/docs/v1/projects/index.html new file mode 100644 index 00000000..075f297b --- /dev/null +++ b/docs/v1/projects/index.html @@ -0,0 +1,6263 @@ + + + + + Xero Projects API + + + + + + xero-python Project SDK Docs + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ + +
+
+ +
+
+ +
+
+
+
+
+ +
+
+
+
+

Xero Projects API

+
+
+
+ +
+
+

Project

+
+
+
+

createProject

+

Create one or more new projects

+
+
+
+

+

+

+
+ 
/Projects
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_project():
+    api_instance = ProjectApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_response = api_instance.create_project(xero_tenant_id, projectCreateOrUpdate, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling ProjectApi->createProject: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
projectsGrant read-write access to projects
+

Parameters

+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
projectCreateOrUpdate * +
+
+ + ProjectCreateOrUpdate + +
+ Create a new project with ProjectCreateOrUpdate object +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createTask

+

Allows you to create a task

+
+
+
+

+

Allows you to create a specific task

+

+
+ 
/Projects/{projectId}/Tasks
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_task():
+    api_instance = ProjectApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_response = api_instance.create_task(xero_tenant_id, project_id, taskCreateOrUpdate, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling ProjectApi->createTask: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
projectsGrant read-write access to projects
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
projectId* + + +
+
+
+ + UUID + + + (uuid) + + +
+You can create a task on a specified projectId +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
taskCreateOrUpdate * +
+
+ + TaskCreateOrUpdate + +
+ The task object you are creating +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

createTimeEntry

+

Creates a time entry for a specific project

+
+
+
+

+

Allows you to create a specific task

+

+
+ 
/Projects/{projectId}/Time
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_time_entry():
+    api_instance = ProjectApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_response = api_instance.create_time_entry(xero_tenant_id, project_id, timeEntryCreateOrUpdate, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling ProjectApi->createTimeEntry: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
projectsGrant read-write access to projects
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
projectId* + + +
+
+
+ + UUID + + + (uuid) + + +
+You can specify an individual project by appending the projectId to the endpoint +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
timeEntryCreateOrUpdate * +
+
+ + TimeEntryCreateOrUpdate + +
+ The time entry object you are creating +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

deleteTask

+

Allows you to delete a task

+
+
+
+

+

Allows you to delete a specific task

+

+
+ 
/Projects/{projectId}/Tasks/{taskId}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_task():
+    api_instance = ProjectApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    task_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_instance.delete_task(xero_tenant_id, project_id, task_id)
+    except AccountingBadRequestException as e:
+        print("Exception when calling ProjectApi->deleteTask: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
projectsGrant read-write access to projects
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
projectId* + + +
+
+
+ + UUID + + + (uuid) + + +
+You can specify an individual project by appending the projectId to the endpoint +
+
+
+ Required +
+
+
+
taskId* + + +
+
+
+ + UUID + + + (uuid) + + +
+You can specify an individual task by appending the id to the endpoint +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

deleteTimeEntry

+

Deletes a time entry for a specific project

+
+
+
+

+

Allows you to delete a specific time entry

+

+
+ 
/Projects/{projectId}/Time/{timeEntryId}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_time_entry():
+    api_instance = ProjectApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    time_entry_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_instance.delete_time_entry(xero_tenant_id, project_id, time_entry_id)
+    except AccountingBadRequestException as e:
+        print("Exception when calling ProjectApi->deleteTimeEntry: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
projectsGrant read-write access to projects
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
projectId* + + +
+
+
+ + UUID + + + (uuid) + + +
+You can specify an individual project by appending the projectId to the endpoint +
+
+
+ Required +
+
+
+
timeEntryId* + + +
+
+
+ + UUID + + + (uuid) + + +
+You can specify an individual task by appending the id to the endpoint +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getProject

+

Retrieves a single project

+
+
+
+

+

Allows you to retrieve a specific project using the projectId

+

+
+ 
/Projects/{projectId}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_project():
+    api_instance = ProjectApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.get_project(xero_tenant_id, project_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling ProjectApi->getProject: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
projectsGrant read-write access to projects
projects.readGrant read-only access to projects
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
projectId* + + +
+
+
+ + UUID + + + (uuid) + + +
+You can specify an individual project by appending the projectId to the endpoint +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getProjectUsers

+

Retrieves a list of all project users

+
+
+
+

+

Allows you to retrieve the users on a projects.

+

+
+ 
/ProjectsUsers
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_project_users():
+    api_instance = ProjectApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    
+    try:
+        api_response = api_instance.get_project_users(xero_tenant_id, page, page_size)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling ProjectApi->getProjectUsers: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
projectsGrant read-write access to projects
projects.readGrant read-only access to projects
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + + + + + +
NameDescription
page + + +
+
+
+ + Integer + + +
+set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. +
+
+
+
+
pageSize + + +
+
+
+ + Integer + + +
+Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. +
+
+
+
+
+
+
+
+
+
+
+

getProjects

+

Retrieves all projects

+
+
+
+

+

Allows you to retrieve, create and update projects.

+

+
+ 
/Projects
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_projects():
+    api_instance = ProjectApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    project_ids = []
+    contact_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    states = 'states_example'
+    
+    try:
+        api_response = api_instance.get_projects(xero_tenant_id, project_ids, contact_id, states, page, page_size)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling ProjectApi->getProjects: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
projectsGrant read-write access to projects
projects.readGrant read-only access to projects
+

Parameters

+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription
projectIds + + +
+
+
+ + array[UUID] + + + (uuid) + + +
+Search for all projects that match a comma separated list of projectIds +
+
+
+
+
contactID + + +
+
+
+ + UUID + + + (uuid) + + +
+Filter for projects for a specific contact +
+
+
+
+
states + + +
+
+
+ + String + + +
+Filter for projects in a particular state (INPROGRESS or CLOSED) +
+
+
+
+
page + + +
+
+
+ + Integer + + +
+set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. +
+
+
+
+
pageSize + + +
+
+
+ + Integer + + +
+Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. +
+
+
+
+
+
+
+
+
+
+
+

getTask

+

Retrieves a single project task

+
+
+
+

+

Allows you to retrieve a specific project

+

+
+ 
/Projects/{projectId}/Tasks/{taskId}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_task():
+    api_instance = ProjectApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    task_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.get_task(xero_tenant_id, project_id, task_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling ProjectApi->getTask: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
projectsGrant read-write access to projects
projects.readGrant read-only access to projects
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
projectId* + + +
+
+
+ + UUID + + + (uuid) + + +
+You can specify an individual project by appending the projectId to the endpoint +
+
+
+ Required +
+
+
+
taskId* + + +
+
+
+ + UUID + + + (uuid) + + +
+You can specify an individual task by appending the taskId to the endpoint, i.e. GET https://.../tasks/{taskID} +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

getTasks

+

Retrieves all project tasks

+
+
+
+

+

Allows you to retrieve a specific project

+

+
+ 
/Projects/{projectId}/Tasks
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_tasks():
+    api_instance = ProjectApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    task_ids = 'taskIds_example'
+    
+    try:
+        api_response = api_instance.get_tasks(xero_tenant_id, project_id, page, page_size, task_ids, charge_type)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling ProjectApi->getTasks: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
projectsGrant read-write access to projects
projects.readGrant read-only access to projects
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
projectId* + + +
+
+
+ + UUID + + + (uuid) + + +
+You can specify an individual project by appending the projectId to the endpoint +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + + + + + + + + + + + + + +
NameDescription
page + + +
+
+
+ + Integer + + +
+Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. +
+
+
+
+
pageSize + + +
+
+
+ + Integer + + +
+Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. +
+
+
+
+
taskIds + + +
+
+
+ + String + + +
+Search for all tasks that match a comma separated list of taskIds, i.e. GET https://.../tasks?taskIds={taskID},{taskID} +
+
+
+
+
chargeType + + +
+
+
+ + ChargeType + + +
+ +
+
+
+
+
+
+
+
+
+
+
+

getTimeEntries

+

Retrieves all time entries associated with a specific project

+
+
+
+

+

Allows you to retrieve the time entries associated with a specific project

+

+
+ 
/Projects/{projectId}/Time
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_time_entries():
+    api_instance = ProjectApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    task_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    invoice_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    contact_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    states = []
+    is_chargeable = 'true'
+    date_after_utc = dateutil.parser.parse("2013-10-20T19:20:30+01:00")
+    date_before_utc = dateutil.parser.parse("2013-10-20T19:20:30+01:00")
+    
+    try:
+        api_response = api_instance.get_time_entries(xero_tenant_id, project_id, user_id, task_id, invoice_id, contact_id, page, page_size, states, is_chargeable, date_after_utc, date_before_utc)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling ProjectApi->getTimeEntries: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
projectsGrant read-write access to projects
projects.readGrant read-only access to projects
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
projectId* + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier of the project, that the task (which the time entry is logged against) belongs to. +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
Query parameters
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription
userId + + +
+
+
+ + UUID + + + (uuid) + + +
+The xero user identifier of the person who logged time. +
+
+
+
+
taskId + + +
+
+
+ + UUID + + + (uuid) + + +
+Identifier of the task that time entry is logged against. +
+
+
+
+
invoiceId + + +
+
+
+ + UUID + + + (uuid) + + +
+Finds all time entries for this invoice. +
+
+
+
+
contactId + + +
+
+
+ + UUID + + + (uuid) + + +
+Finds all time entries for this contact identifier. +
+
+
+
+
page + + +
+
+
+ + Integer + + +
+Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. +
+
+
+
+
pageSize + + +
+
+
+ + Integer + + +
+Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. +
+
+
+
+
states + + +
+
+
+ + array[String] + + +
+Comma-separated list of states to find. Will find all time entries that are in the status of whatever is specified. +
+
+
+
+
isChargeable + + +
+
+
+ + Boolean + + +
+Finds all time entries which relate to tasks with the charge type TIME or FIXED. +
+
+
+
+
dateAfterUtc + + +
+
+
+ + Date + + + (date-time) + + +
+ISO 8601 UTC date. Finds all time entries on or after this date filtered on the dateUtc field. +
+
+
+
+
dateBeforeUtc + + +
+
+
+ + Date + + + (date-time) + + +
+ISO 8601 UTC date. Finds all time entries on or before this date filtered on the dateUtc field. +
+
+
+
+
+
+
+
+
+
+
+

getTimeEntry

+

Retrieves a single time entry for a specific project

+
+
+
+

+

Allows you to get a single time entry in a project

+

+
+ 
/Projects/{projectId}/Time/{timeEntryId}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_time_entry():
+    api_instance = ProjectApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    time_entry_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.get_time_entry(xero_tenant_id, project_id, time_entry_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling ProjectApi->getTimeEntry: %s\n" % e)
+
+
+

Scopes

+ + + + + + + + + + + + +
projectsGrant read-write access to projects
projects.readGrant read-only access to projects
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
projectId* + + +
+
+
+ + UUID + + + (uuid) + + +
+You can specify an individual project by appending the projectId to the endpoint +
+
+
+ Required +
+
+
+
timeEntryId* + + +
+
+
+ + UUID + + + (uuid) + + +
+You can specify an individual time entry by appending the id to the endpoint +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
+
+
+
+
+
+
+

patchProject

+

creates a project for the specified contact

+
+
+
+

+

Allows you to update a specific projects.

+

+
+ 
/Projects/{projectId}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_patch_project():
+    api_instance = ProjectApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_instance.patch_project(xero_tenant_id, project_id, projectPatch, idempotency_key)
+    except AccountingBadRequestException as e:
+        print("Exception when calling ProjectApi->patchProject: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
projectsGrant read-write access to projects
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
projectId* + + +
+
+
+ + UUID + + + (uuid) + + +
+You can specify an individual project by appending the projectId to the endpoint +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
projectPatch * +
+
+ + ProjectPatch + +
+ Update the status of an existing Project +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

updateProject

+

Updates a specific project

+
+
+
+

+

Allows you to update a specific projects.

+

+
+ 
/Projects/{projectId}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_project():
+    api_instance = ProjectApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_instance.update_project(xero_tenant_id, project_id, projectCreateOrUpdate, idempotency_key)
+    except AccountingBadRequestException as e:
+        print("Exception when calling ProjectApi->updateProject: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
projectsGrant read-write access to projects
+

Parameters

+
Path parameters
+ + + + + + + + + +
NameDescription
projectId* + + +
+
+
+ + UUID + + + (uuid) + + +
+You can specify an individual project by appending the projectId to the endpoint +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
projectCreateOrUpdate * +
+
+ + ProjectCreateOrUpdate + +
+ Request of type ProjectCreateOrUpdate +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

updateTask

+

Allows you to update a task

+
+
+
+

+

Allows you to update a specific task

+

+
+ 
/Projects/{projectId}/Tasks/{taskId}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_task():
+    api_instance = ProjectApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    task_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_instance.update_task(xero_tenant_id, project_id, task_id, taskCreateOrUpdate, idempotency_key)
+    except AccountingBadRequestException as e:
+        print("Exception when calling ProjectApi->updateTask: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
projectsGrant read-write access to projects
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
projectId* + + +
+
+
+ + UUID + + + (uuid) + + +
+You can specify an individual project by appending the projectId to the endpoint +
+
+
+ Required +
+
+
+
taskId* + + +
+
+
+ + UUID + + + (uuid) + + +
+You can specify an individual task by appending the id to the endpoint +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
taskCreateOrUpdate * +
+
+ + TaskCreateOrUpdate + +
+ The task object you are updating +
+
+
+ Required +
+
+ +
+
+
+
+
+
+
+

updateTimeEntry

+

Updates a time entry for a specific project

+
+
+
+

+

Allows you to update time entry in a project

+

+
+ 
/Projects/{projectId}/Time/{timeEntryId}
+

+

Usage and SDK Samples

+

+ +
+ +
+ 
# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_time_entry():
+    api_instance = ProjectApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    time_entry_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_instance.update_time_entry(xero_tenant_id, project_id, time_entry_id, timeEntryCreateOrUpdate, idempotency_key)
+    except AccountingBadRequestException as e:
+        print("Exception when calling ProjectApi->updateTimeEntry: %s\n" % e)
+
+
+

Scopes

+ + + + + + + +
projectsGrant read-write access to projects
+

Parameters

+
Path parameters
+ + + + + + + + + + + + + +
NameDescription
projectId* + + +
+
+
+ + UUID + + + (uuid) + + +
+You can specify an individual project by appending the projectId to the endpoint +
+
+
+ Required +
+
+
+
timeEntryId* + + +
+
+
+ + UUID + + + (uuid) + + +
+You can specify an individual time entry by appending the id to the endpoint +
+
+
+ Required +
+
+
+
+
Header parameters
+ + + + + + + + + + + + + +
NameDescription
Xero-Tenant-Id* + + +
+
+
+ + String + + +
+Xero identifier for Tenant +
+
+
+ Required +
+
+
+
Idempotency-Key + + +
+
+
+ + String + + +
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +
+
+
+
+
+
Body parameters
+ + + + + + + +
NameDescription
timeEntryCreateOrUpdate * +
+
+ + TimeEntryCreateOrUpdate + +
+ The time entry object you are updating +
+
+
+ Required +
+
+ +
+
+
+
+
+
+ +
+
+
+ + + + + + + + + + + + + + diff --git a/requirements.txt b/requirements.txt index 11231fa7..f1163e77 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,3 +2,4 @@ python-dateutil>=2.7 urllib3 certifi +setuptools>=75.1.0 diff --git a/setup.cfg b/setup.cfg index 9adf01c8..89acffda 100644 --- a/setup.cfg +++ b/setup.cfg @@ -5,6 +5,7 @@ universal = 1 # Recommend matching the black line length (default 88), # rather than using the flake8 default of 79: max-line-length = 88 +ignore = E741, E501, F401, W503 exclude= cassettes, extend-ignore = diff --git a/setup.py b/setup.py index 7f293aea..4229c0da 100644 --- a/setup.py +++ b/setup.py @@ -20,7 +20,7 @@ def load_requirements(file_name): def read_file(filename): - with open(filename) as fp: + with open(filename, encoding="utf-8") as fp: return fp.read() @@ -48,5 +48,5 @@ def read_file(filename): keywords="xero python sdk API oAuth", name="xero_python", packages=find_packages(include=["xero_python", "xero_python.*"]), - version="1.13.1", + version="15.1.0", ) diff --git a/tests/accounting/api/cassettes/test_invoice_attachment_upload_and_download.yaml b/tests/accounting/api/cassettes/test_invoice_attachment_upload_and_download.yaml index e4e38d94..f7279277 100644 --- a/tests/accounting/api/cassettes/test_invoice_attachment_upload_and_download.yaml +++ b/tests/accounting/api/cassettes/test_invoice_attachment_upload_and_download.yaml @@ -3191,7 +3191,7 @@ interactions: \"OK\",\r\n \"ProviderName\": \"python-sdk\",\r\n \"DateTimeUTC\": \"\\/Date(1588633398797)\\/\",\r\n \ \"Attachments\": [\r\n {\r\n \"AttachmentID\": \"40fa0d97-8b94-4948-b299-4bcbe73dafc3\",\r\n \ \"FileName\": \"inv-0032.pdf\",\r\n \"Url\": \"https://api.xero.com/api.xro/2.0/Invoices/22b3fab4-ef56-4d70-a110-a7cc3c1a26cd/Attachments/inv-0032.pdf\",\r\n - \ \"MimeType\": \"application/pdf\",\r\n \"ContentLength\": 54574\r\n + \ \"MimeType\": \"application/pdf\",\r\n \"ContentLength\": 54574,\r\n \"IncludeOnline\": true \ }\r\n ]\r\n}" headers: Cache-Control: @@ -3244,7 +3244,7 @@ interactions: \"OK\",\r\n \"ProviderName\": \"python-sdk\",\r\n \"DateTimeUTC\": \"\\/Date(1588633399616)\\/\",\r\n \ \"Attachments\": [\r\n {\r\n \"AttachmentID\": \"40fa0d97-8b94-4948-b299-4bcbe73dafc3\",\r\n \ \"FileName\": \"inv-0032.pdf\",\r\n \"Url\": \"https://api.xero.com/api.xro/2.0/Invoices/22b3fab4-ef56-4d70-a110-a7cc3c1a26cd/Attachments/inv-0032.pdf\",\r\n - \ \"MimeType\": \"application/pdf\",\r\n \"ContentLength\": 54574\r\n + \ \"MimeType\": \"application/pdf\",\r\n \"ContentLength\": 54574,\r\n \"IncludeOnline\": true \ }\r\n ]\r\n}" headers: Cache-Control: diff --git a/tests/accounting/api/test_accounting_api.py b/tests/accounting/api/test_accounting_api.py index 393d4055..4927e630 100644 --- a/tests/accounting/api/test_accounting_api.py +++ b/tests/accounting/api/test_accounting_api.py @@ -31,6 +31,7 @@ Attachment, ) from xero_python.api_client import ApiClient +from xero_python.assets import Pagination from xero_python.rest import RESTClientObject @@ -43,7 +44,7 @@ def accounting_api(api_client): def sandbox_accounting_api(api_client): return AccountingApi( api_client=api_client, - base_url="https://xero-accounting.getsandbox.com/api.xro/2.0", + base_url="http://127.0.0.1:4010", ) @@ -86,19 +87,19 @@ def test_invoice_attachment_upload_and_download( ): """This is a full integration test, tested steps are: - 1. get first page of invoices - 2. choose first invoice - 3. upload test pdf file as invoice attachment - 4. confirm the invoice has new attachment - 5. download uploaded pdf file + 1. get first page of invoices + 2. choose first invoice + 3. upload test pdf file as invoice attachment + 4. confirm the invoice has new attachment + 5. download uploaded pdf file """ # 1. get first page of invoices - invoices = accounting_api.get_invoices(xero_tenant_id, page=1) - assert isinstance(invoices, Invoices) - assert len(invoices.invoices) + invoiceResponse = accounting_api.get_invoices(xero_tenant_id, page=1) + assert isinstance(invoiceResponse, Invoices) + assert len(invoiceResponse.invoices) # 2. choose first invoice - invoice = invoices.invoices[0] + invoice = invoiceResponse.invoices[0] assert isinstance(invoice, Invoice) # 3. upload test pdf file as invoice attachment include_online = True @@ -339,31 +340,27 @@ def test_get_account_attachments(sandbox_accounting_api: AccountingApi, xero_ten def test_get_invoices(sandbox_accounting_api: AccountingApi, xero_tenant_id): # Given sandbox API, tenant id, and hardcoded test invoices data # When getting all invoices - result = sandbox_accounting_api.get_invoices(xero_tenant_id) + result: Invoices = sandbox_accounting_api.get_invoices(xero_tenant_id) # Then expect correct invoices received - expected = Invoices( + expected = Invoices ( invoices=[ Invoice( - amount_credited=Decimal("0.00"), - amount_due=Decimal("0.00"), - amount_paid=Decimal("0.00"), + amount_credited = Decimal(0), + amount_due = Decimal(0), + amount_paid= Decimal(0), contact=Contact( + addresses=[], + contact_groups=[], contact_id="a3675fc4-f8dd-4f03-ba5b-f1870566bcd7", + contact_persons=[], has_attachments=False, has_validation_errors=False, name="Barney Rubble-83203", - addresses=[], - contact_groups=[], - contact_persons=[], phones=[], ), credit_notes=[], - line_items=[], - overpayments=[], - payments=[], - prepayments=[], currency_code=CurrencyCode.NZD, - currency_rate=Decimal("1.000000"), + currency_rate=Decimal(1), date=datetime.date(2018, 10, 20), due_date=datetime.date(2018, 12, 30), has_attachments=False, @@ -372,37 +369,38 @@ def test_get_invoices(sandbox_accounting_api: AccountingApi, xero_tenant_id): invoice_number="INV-0001", is_discounted=False, line_amount_types=LineAmountTypes.EXCLUSIVE, + line_items=[], + overpayments=[], + payments=[], + prepayments=[], reference="Red Fish, Blue Fish", + repeating_invoice_id="428c0d75-909f-4b04-8403-a48dc27283b0", sent_to_contact=True, status="VOIDED", - sub_total=Decimal("40.00"), - total=Decimal("40.00"), - total_tax=Decimal("0.00"), + sub_total=Decimal(40), + total=Decimal(40), + total_tax=Decimal(0), type="ACCREC", - updated_date_utc=datetime.datetime( - 2018, 11, 2, 16, 31, 30, 160000, tzinfo=tz.UTC - ), + updated_date_utc=datetime.datetime(2018, 11, 2, 16, 31, 30, 160000, tzinfo=tz.UTC), + updated_date_utc_string="2018-11-02T16:31:30Z", ), Invoice( - amount_credited=Decimal("0.00"), - amount_due=Decimal("0.00"), - amount_paid=Decimal("46.00"), + amount_credited=Decimal(0), + amount_due=Decimal(0), + amount_paid=Decimal(46), contact=Contact( + addresses=[], + contact_groups=[], contact_id="a3675fc4-f8dd-4f03-ba5b-f1870566bcd7", + contact_persons=[], has_attachments=False, has_validation_errors=False, name="Barney Rubble-83203", - addresses=[], - contact_groups=[], - contact_persons=[], phones=[], ), credit_notes=[], - line_items=[], - overpayments=[], - prepayments=[], currency_code=CurrencyCode.NZD, - currency_rate=Decimal("1.000000"), + currency_rate=Decimal(1), date=datetime.date(2018, 10, 20), due_date=datetime.date(2018, 12, 30), fully_paid_on_date=datetime.date(2018, 11, 29), @@ -412,70 +410,77 @@ def test_get_invoices(sandbox_accounting_api: AccountingApi, xero_tenant_id): invoice_number="INV-0002", is_discounted=False, line_amount_types=LineAmountTypes.EXCLUSIVE, + line_items=[], + overpayments=[], payments=[ Payment( - amount=Decimal("46.00"), - currency_rate=Decimal("1.000000"), + amount=Decimal(46), + currency_rate=Decimal(1), date=datetime.date(2018, 11, 29), has_account=False, has_validation_errors=False, payment_id="99ea7f6b-c513-4066-bc27-b7c65dcd76c2", ) - ], + ], + prepayments=[], reference="Red Fish, Blue Fish", + #repeating_invoice_id="428c0d75-909f-4b04-8403-a48dc27283b0", sent_to_contact=True, status="PAID", - sub_total=Decimal("40.00"), - total=Decimal("46.00"), - total_tax=Decimal("6.00"), + sub_total=Decimal(40), + total=Decimal(46), + total_tax=Decimal(6), type="ACCREC", - updated_date_utc=datetime.datetime( - 2018, 11, 2, 16, 36, 32, 690000, tzinfo=tz.UTC - ), + updated_date_utc=datetime.datetime(2018, 11, 2, 16, 36, 32, 690000, tzinfo=tz.UTC), + updated_date_utc_string="2018-11-02T16:36:32Z", ), Invoice( - amount_credited=Decimal("0.00"), - amount_due=Decimal("115.00"), - amount_paid=Decimal("0.00"), + amount_credited=Decimal(0), + amount_due=Decimal(115), + amount_paid=Decimal(0), contact=Contact( + addresses=[], + contact_groups=[], contact_id="a3675fc4-f8dd-4f03-ba5b-f1870566bcd7", + contact_persons=[], has_attachments=False, has_validation_errors=False, name="Barney Rubble-83203", - addresses=[], - contact_groups=[], - contact_persons=[], phones=[], ), credit_notes=[], - line_items=[], - overpayments=[], - payments=[], - prepayments=[], currency_code=CurrencyCode.NZD, - currency_rate=Decimal("1.000000"), + currency_rate=Decimal(1), date=datetime.date(2018, 11, 2), due_date=datetime.date(2018, 11, 7), has_attachments=False, has_errors=False, - invoice_id="7ef31b20-de17-4312-8382-412f869b1510", invoice_number="INV-0003", + invoice_id="7ef31b20-de17-4312-8382-412f869b1510", is_discounted=False, line_amount_types=LineAmountTypes.EXCLUSIVE, + line_items=[], + overpayments=[], + payments=[], + prepayments=[], reference="", status="AUTHORISED", - sub_total=Decimal("100.00"), - total=Decimal("115.00"), - total_tax=Decimal("15.00"), + sub_total=Decimal(100), + total=Decimal(115), + total_tax=Decimal(15), type="ACCREC", - updated_date_utc=datetime.datetime( - 2018, 11, 2, 16, 37, 28, 927000, tzinfo=tz.UTC - ), - ), - ] + updated_date_utc=datetime.datetime(2018, 11, 2, 16, 37, 28, 927000, tzinfo=tz.UTC), + updated_date_utc_string="2018-11-02T16:37:28Z" + ) + ], + pagination= Pagination( + item_count= 3, + page = 1, + page_count= 1, + page_size= 100 + ) ) - assert result == expected - + assert str(result) == str(expected) @pytest.mark.sandbox def test_get_invoice_history(sandbox_accounting_api: AccountingApi, xero_tenant_id): @@ -484,7 +489,22 @@ def test_get_invoice_history(sandbox_accounting_api: AccountingApi, xero_tenant_ # When getting invoice history result = sandbox_accounting_api.get_invoice_history(xero_tenant_id, invoice_id) # Then expect invoice history to be received - expected = HistoryRecords() # todo confirm empty response from sandbox is correct + expected = HistoryRecords( + [ + HistoryRecord( + changes="Attached a file", + date_utc= datetime.datetime(2018, 11, 8, 15, 1, 21, 470000, tzinfo=tz.UTC), + details= "Attached the file sample2.jpg through the Xero API using Xero API Partner", + user="System Generated", + ), + HistoryRecord( + changes="Credit Applied", + date_utc=datetime.datetime(2016, 10, 17, 20, 46, 1, 173000, tzinfo=tz.UTC), + details="Bank transfer from Business Wells Fargo to My Savings on November 12, 2016 for 20.00.", + user="System Generated", + ) + ] + ) assert result == expected @@ -612,6 +632,7 @@ def test_update_or_create_invoices( updated_date_utc=datetime.datetime( 2019, 3, 11, 17, 58, 46, 117000, tzinfo=tz.UTC ), + updated_date_utc_string="2019-03-11T17:58:46Z", ) ] ) @@ -646,7 +667,12 @@ def test_create_invoice_history(sandbox_accounting_api: AccountingApi, xero_tena xero_tenant_id, invoice_id, history_records ) # Then expect created invoice history records - expected = HistoryRecords() # todo confirm empty response from sandbox is correct + expected = HistoryRecords( + [HistoryRecord( + date_utc=datetime.datetime(2019, 2, 23, 5, 23, 20, 362000, tzinfo=tz.UTC), + details="Hello World" + )] + ) assert result == expected diff --git a/tests/conftest.py b/tests/conftest.py index 049d4057..9c76c301 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -127,6 +127,7 @@ def oauth2_token( "token_type": "Bearer", } + @pytest.fixture() def oauth2_token_without_id_token( xero_access_token, diff --git a/tests/identity/api/cassettes/test_get_connections.yaml b/tests/identity/api/cassettes/test_get_connections.yaml index 663d49bb..53636d1f 100644 --- a/tests/identity/api/cassettes/test_get_connections.yaml +++ b/tests/identity/api/cassettes/test_get_connections.yaml @@ -11,7 +11,7 @@ interactions: User-Agent: - xero-python (0.1.0) method: GET - uri: https://api.xero.com/connections + uri: https://api.xero.com/Connections response: body: string: '[{"id":"f4a87932-0878-4884-abcf-73191dd810ba","tenantId":"a46fcb6f-2773-40c4-a119-8aa08bca1e8e","tenantType":"ORGANISATION","createdDateUtc":"2020-03-18T21:20:07.7179250","updatedDateUtc":"2020-03-30T05:15:13.3513620"}]' diff --git a/tests/test_api_client/test_deserializer.py b/tests/test_api_client/test_deserializer.py index 63aa013e..9c851a8a 100644 --- a/tests/test_api_client/test_deserializer.py +++ b/tests/test_api_client/test_deserializer.py @@ -161,7 +161,7 @@ def test_deserialize_bool(data, expected): assert result == expected -@pytest.mark.parametrize("data", [None, "", "1", "0", 1, 0]) +@pytest.mark.parametrize("data", ["", "1", "0", 1, 0]) def test_deserialize_bool_error(data): # given data type bool data_type = "bool" @@ -189,7 +189,7 @@ def test_deserialize_date(data, expected): assert result == expected -@pytest.mark.parametrize("data", [None, "", "2019-oo-01"]) +@pytest.mark.parametrize("data", ["", "2019-oo-01"]) def test_deserialize_date_error(data): # given data type date data_type = "date" @@ -268,7 +268,7 @@ def test_deserialize_datetime(data, expected): assert result == expected -@pytest.mark.parametrize("data", [None, "", "invalid"]) +@pytest.mark.parametrize("data", ["", "invalid"]) def test_deserialize_datetime_error(data): # given data type datetime data_type = "datetime" @@ -349,7 +349,7 @@ def __init__(self, **kwargs): deserialize.assert_any_call("str", "short description", None) -@pytest.mark.parametrize("data", [None, "", 1, True]) +@pytest.mark.parametrize("data", ["", 1, True]) def test_deserialize_model_error(data): # given test model and invalid test data class Model: diff --git a/tests/test_api_client/test_oauth2.py b/tests/test_api_client/test_oauth2.py index 490af0c6..cc2eb2c1 100644 --- a/tests/test_api_client/test_oauth2.py +++ b/tests/test_api_client/test_oauth2.py @@ -151,6 +151,49 @@ def test_auth2_refresh_access_token(): assert oauth2_token.access_token == new_token["access_token"] assert oauth2_token.refresh_token == new_token["refresh_token"] +def test_auth2_refresh_access_token_having_scope_as_string(): + # given OAuth2Token with expired access_token + api_client = FakeClass() + api_client.set_oauth2_token = FakeMethod() + refresh_token = "refresh-token-value" + scope = ( + "email profile openid accounting.reports.read " + "accounting.attachments.read accounting.settings " + "accounting.settings.read accounting.attachments " + "accounting.transactions accounting.journals.read " + "accounting.transactions.read accounting.contacts " + "accounting.contacts.read offline_access" + ) + new_token = { + "id_token": "new-id-token-value", + "access_token": "new-access-token-value", + "expires_in": 1800, + "expires_at": time.time() + 1800, + "token_type": "Bearer", + "refresh_token": "new-refresh-token-value", + "scope": scope, + } + oauth2_token = OAuth2Token(client_id="client_id", client_secret="client_secret") + oauth2_token.refresh_token = refresh_token + oauth2_token.scope = scope + oauth2_token.fetch_access_token = FakeMethod(return_value=new_token) + # When refreshing access_token + assert oauth2_token.refresh_access_token(api_client=api_client) + # Then expected set new token function called + assert len(oauth2_token.fetch_access_token.calls) == 1 + assert len(api_client.set_oauth2_token.calls) == 1 + call_args, call_kwargs = api_client.set_oauth2_token.calls[0] + assert call_args == (new_token,) + assert call_kwargs == {} + # Then expected new valid access and refresh tokens set on oauth2_token + assert oauth2_token.expires_at == new_token["expires_at"] + assert oauth2_token.is_access_token_valid() + assert oauth2_token.id_token == new_token["id_token"] + assert oauth2_token.expires_in == new_token["expires_in"] + assert oauth2_token.token_type == new_token["token_type"] + assert oauth2_token.scope == new_token["scope"] + assert oauth2_token.access_token == new_token["access_token"] + assert oauth2_token.refresh_token == new_token["refresh_token"] def test_auth2_fetch_access_token(): # Given OAuth2Token with valid refresh_token @@ -205,6 +248,7 @@ def test_auth2_call_refresh_token_api(oauth2_refresh_token): assert call_kwargs == {} assert new_token is token + def test_auth2_call_refresh_token_api_without_id_token(oauth2_token_without_id_token): # Given valid refresh token and client credentials without using OpenID scope (id_token absent) oauth2_token = OAuth2Token() diff --git a/tests/utils/start-prism.sh b/tests/utils/start-prism.sh new file mode 100755 index 00000000..be7c09e3 --- /dev/null +++ b/tests/utils/start-prism.sh @@ -0,0 +1,12 @@ +#!/bin/bash +branchName=${1:-"master"} + +prism mock https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/refs/heads/$branchName/xero_accounting.yaml --host 127.0.0.1 --port 4010 & +prism mock https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/refs/heads/$branchName/xero-app-store.yaml --host 127.0.0.1 --port 4011 & +prism mock https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/refs/heads/$branchName/xero_assets.yaml --host 127.0.0.1 --port 4012 & +prism mock https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/refs/heads/$branchName/xero_bankfeeds.yaml --host 127.0.0.1 --port 4013 & +prism mock https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/refs/heads/$branchName/xero-finance.yaml --host 127.0.0.1 --port 4014 & +prism mock https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/refs/heads/$branchName/xero-payroll-uk.yaml --host 127.0.0.1 --port 4015 & +prism mock https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/refs/heads/$branchName/xero-payroll-nz.yaml --host 127.0.0.1 --port 4016 & +prism mock https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/refs/heads/$branchName/xero-payroll-au.yaml --host 127.0.0.1 --port 4017 & +prism mock https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/refs/heads/$branchName/xero-projects.yaml --host 127.0.0.1 --port 4018 diff --git a/xero_python/__init__.py b/xero_python/__init__.py index 6029a9c0..3d1a4fec 100644 --- a/xero_python/__init__.py +++ b/xero_python/__init__.py @@ -2,4 +2,4 @@ __author__ = """Xero Developer API""" __email__ = "api@xero.com" -__version__ = "1.13.1" +__version__ = "15.1.0" diff --git a/xero_python/accounting/__init__.py b/xero_python/accounting/__init__.py index 44640aee..5773b7c3 100644 --- a/xero_python/accounting/__init__.py +++ b/xero_python/accounting/__init__.py @@ -3,12 +3,12 @@ # flake8: noqa """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -37,8 +37,17 @@ from xero_python.accounting.models.bank_transaction import BankTransaction from xero_python.accounting.models.bank_transactions import BankTransactions from xero_python.accounting.models.bank_transfer import BankTransfer +from xero_python.accounting.models.bank_transfer_delete import BankTransferDelete +from xero_python.accounting.models.bank_transfer_delete_by_url_param import ( + BankTransferDeleteByUrlParam, +) from xero_python.accounting.models.bank_transfers import BankTransfers +from xero_python.accounting.models.bank_transfers_delete import BankTransfersDelete from xero_python.accounting.models.batch_payment import BatchPayment +from xero_python.accounting.models.batch_payment_delete import BatchPaymentDelete +from xero_python.accounting.models.batch_payment_delete_by_url_param import ( + BatchPaymentDeleteByUrlParam, +) from xero_python.accounting.models.batch_payment_details import BatchPaymentDetails from xero_python.accounting.models.batch_payments import BatchPayments from xero_python.accounting.models.bill import Bill @@ -81,6 +90,7 @@ ImportSummaryOrganisation, ) from xero_python.accounting.models.invoice import Invoice +from xero_python.accounting.models.invoice_address import InvoiceAddress from xero_python.accounting.models.invoice_reminder import InvoiceReminder from xero_python.accounting.models.invoice_reminders import InvoiceReminders from xero_python.accounting.models.invoices import Invoices @@ -104,6 +114,7 @@ from xero_python.accounting.models.organisations import Organisations from xero_python.accounting.models.overpayment import Overpayment from xero_python.accounting.models.overpayments import Overpayments +from xero_python.accounting.models.pagination import Pagination from xero_python.accounting.models.payment import Payment from xero_python.accounting.models.payment_delete import PaymentDelete from xero_python.accounting.models.payment_service import PaymentService @@ -139,6 +150,7 @@ from xero_python.accounting.models.sales_tracking_category import SalesTrackingCategory from xero_python.accounting.models.schedule import Schedule from xero_python.accounting.models.setup import Setup +from xero_python.accounting.models.tax_breakdown_component import TaxBreakdownComponent from xero_python.accounting.models.tax_component import TaxComponent from xero_python.accounting.models.tax_rate import TaxRate from xero_python.accounting.models.tax_rates import TaxRates @@ -149,6 +161,7 @@ from xero_python.accounting.models.tracking_category import TrackingCategory from xero_python.accounting.models.tracking_option import TrackingOption from xero_python.accounting.models.tracking_options import TrackingOptions +from xero_python.accounting.models.tracking_reference import TrackingReference from xero_python.accounting.models.user import User from xero_python.accounting.models.users import Users from xero_python.accounting.models.validation_error import ValidationError diff --git a/xero_python/accounting/api/accounting_api.py b/xero_python/accounting/api/accounting_api.py index a1e2a277..1bc445e5 100644 --- a/xero_python/accounting/api/accounting_api.py +++ b/xero_python/accounting/api/accounting_api.py @@ -1,5 +1,16 @@ # coding: utf-8 +import importlib +import re # noqa: F401 + +from xero_python import exceptions +from xero_python.api_client import ApiClient, ModelFinder + +try: + from .exception_handler import translate_status_exception +except ImportError: + translate_status_exception = exceptions.translate_status_exception + """ Xero Accounting API @@ -10,20 +21,9 @@ """ """ - OpenAPI spec version: 2.19.3 + OpenAPI spec version: 16.2.0 """ -import importlib -import re # noqa: F401 - -from xero_python import exceptions -from xero_python.api_client import ApiClient, ModelFinder - -try: - from .exception_handler import translate_status_exception -except ImportError: - translate_status_exception = exceptions.translate_status_exception - class empty: """empty object to mark optional parameter not set""" @@ -60,6 +60,7 @@ def create_account( self, xero_tenant_id, account, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -68,6 +69,7 @@ def create_account( OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param Account account: Account object in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -96,6 +98,9 @@ def create_account( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -141,6 +146,7 @@ def create_account_attachment_by_file_name( account_id, file_name, body, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -151,6 +157,7 @@ def create_account_attachment_by_file_name( :param str account_id: Unique identifier for Account object (required) :param str file_name: Name of the attachment (required) :param str body: Byte array of file in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -194,6 +201,9 @@ def create_account_attachment_by_file_name( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -241,6 +251,7 @@ def create_bank_transaction_attachment_by_file_name( bank_transaction_id, file_name, body, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -251,6 +262,7 @@ def create_bank_transaction_attachment_by_file_name( :param str bank_transaction_id: Xero generated unique identifier for a bank transaction (required) :param str file_name: Name of the attachment (required) :param str body: Byte array of file in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -294,6 +306,9 @@ def create_bank_transaction_attachment_by_file_name( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -342,6 +357,7 @@ def create_bank_transaction_history_record( xero_tenant_id, bank_transaction_id, history_records, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -351,6 +367,7 @@ def create_bank_transaction_history_record( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str bank_transaction_id: Xero generated unique identifier for a bank transaction (required) :param HistoryRecords history_records: HistoryRecords containing an array of HistoryRecord objects in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -387,6 +404,9 @@ def create_bank_transaction_history_record( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -434,6 +454,7 @@ def create_bank_transactions( bank_transactions, summarize_errors=empty, unitdp=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -444,6 +465,7 @@ def create_bank_transactions( :param BankTransactions bank_transactions: BankTransactions with an array of BankTransaction objects in body of request (required) :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -478,6 +500,9 @@ def create_bank_transactions( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -521,6 +546,7 @@ def create_bank_transfer( self, xero_tenant_id, bank_transfers, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -529,6 +555,7 @@ def create_bank_transfer( OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param BankTransfers bank_transfers: BankTransfers with array of BankTransfer objects in request body (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -557,6 +584,9 @@ def create_bank_transfer( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -602,6 +632,7 @@ def create_bank_transfer_attachment_by_file_name( bank_transfer_id, file_name, body, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -612,6 +643,7 @@ def create_bank_transfer_attachment_by_file_name( :param str bank_transfer_id: Xero generated unique identifier for a bank transfer (required) :param str file_name: Name of the attachment (required) :param str body: Byte array of file in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -655,6 +687,9 @@ def create_bank_transfer_attachment_by_file_name( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -703,6 +738,7 @@ def create_bank_transfer_history_record( xero_tenant_id, bank_transfer_id, history_records, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -712,6 +748,7 @@ def create_bank_transfer_history_record( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str bank_transfer_id: Xero generated unique identifier for a bank transfer (required) :param HistoryRecords history_records: HistoryRecords containing an array of HistoryRecord objects in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -748,6 +785,9 @@ def create_bank_transfer_history_record( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -794,6 +834,7 @@ def create_batch_payment( xero_tenant_id, batch_payments, summarize_errors=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -803,6 +844,7 @@ def create_batch_payment( :param str xero_tenant_id: Xero identifier for Tenant (required) :param BatchPayments batch_payments: BatchPayments with an array of Payments in body of request (required) :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -834,6 +876,9 @@ def create_batch_payment( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -878,6 +923,7 @@ def create_batch_payment_history_record( xero_tenant_id, batch_payment_id, history_records, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -887,6 +933,7 @@ def create_batch_payment_history_record( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str batch_payment_id: Unique identifier for BatchPayment (required) :param HistoryRecords history_records: HistoryRecords containing an array of HistoryRecord objects in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -923,6 +970,9 @@ def create_batch_payment_history_record( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -968,7 +1018,8 @@ def create_branding_theme_payment_services( self, xero_tenant_id, branding_theme_id, - payment_service, + payment_services, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -977,7 +1028,8 @@ def create_branding_theme_payment_services( OAuth2 scope: paymentservices :param str xero_tenant_id: Xero identifier for Tenant (required) :param str branding_theme_id: Unique identifier for a Branding Theme (required) - :param PaymentService payment_service: PaymentService object in body of request (required) + :param PaymentServices payment_services: PaymentServices array with PaymentService object in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -996,10 +1048,10 @@ def create_branding_theme_payment_services( "Missing the required parameter `branding_theme_id` " "when calling `create_branding_theme_payment_services`" ) - # verify the required parameter 'payment_service' is set - if payment_service is None: + # verify the required parameter 'payment_services' is set + if payment_services is None: raise ValueError( - "Missing the required parameter `payment_service` " + "Missing the required parameter `payment_services` " "when calling `create_branding_theme_payment_services`" ) @@ -1014,10 +1066,13 @@ def create_branding_theme_payment_services( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] - body_params = payment_service + body_params = payment_services # HTTP header `Accept` header_params["Accept"] = self.api_client.select_header_accept( ["application/json"] @@ -1061,6 +1116,7 @@ def create_contact_attachment_by_file_name( contact_id, file_name, body, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1071,6 +1127,7 @@ def create_contact_attachment_by_file_name( :param str contact_id: Unique identifier for a Contact (required) :param str file_name: Name of the attachment (required) :param str body: Byte array of file in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1114,6 +1171,9 @@ def create_contact_attachment_by_file_name( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1159,6 +1219,7 @@ def create_contact_group( self, xero_tenant_id, contact_groups, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1167,6 +1228,7 @@ def create_contact_group( OAuth2 scope: accounting.contacts :param str xero_tenant_id: Xero identifier for Tenant (required) :param ContactGroups contact_groups: ContactGroups with an array of names in request body (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1195,6 +1257,9 @@ def create_contact_group( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1239,6 +1304,7 @@ def create_contact_group_contacts( xero_tenant_id, contact_group_id, contacts, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1248,6 +1314,7 @@ def create_contact_group_contacts( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str contact_group_id: Unique identifier for a Contact Group (required) :param Contacts contacts: Contacts with array of contacts specifying the ContactID to be added to ContactGroup in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1284,6 +1351,9 @@ def create_contact_group_contacts( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1330,6 +1400,7 @@ def create_contact_history( xero_tenant_id, contact_id, history_records, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1339,6 +1410,7 @@ def create_contact_history( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str contact_id: Unique identifier for a Contact (required) :param HistoryRecords history_records: HistoryRecords containing an array of HistoryRecord objects in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1375,6 +1447,9 @@ def create_contact_history( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1419,6 +1494,7 @@ def create_contacts( xero_tenant_id, contacts, summarize_errors=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1428,6 +1504,7 @@ def create_contacts( :param str xero_tenant_id: Xero identifier for Tenant (required) :param Contacts contacts: Contacts with an array of Contact objects to create in body of request (required) :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1459,6 +1536,9 @@ def create_contacts( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1504,6 +1584,7 @@ def create_credit_note_allocation( credit_note_id, allocations, summarize_errors=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1514,6 +1595,7 @@ def create_credit_note_allocation( :param str credit_note_id: Unique identifier for a Credit Note (required) :param Allocations allocations: Allocations with array of Allocation object in body of request. (required) :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1553,6 +1635,9 @@ def create_credit_note_allocation( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1601,6 +1686,7 @@ def create_credit_note_attachment_by_file_name( file_name, body, include_online=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1612,6 +1698,7 @@ def create_credit_note_attachment_by_file_name( :param str file_name: Name of the attachment (required) :param str body: Byte array of file in body of request (required) :param bool include_online: Allows an attachment to be seen by the end customer within their online invoice + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1658,6 +1745,9 @@ def create_credit_note_attachment_by_file_name( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1706,6 +1796,7 @@ def create_credit_note_history( xero_tenant_id, credit_note_id, history_records, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1715,6 +1806,7 @@ def create_credit_note_history( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str credit_note_id: Unique identifier for a Credit Note (required) :param HistoryRecords history_records: HistoryRecords containing an array of HistoryRecord objects in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1751,6 +1843,9 @@ def create_credit_note_history( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1796,6 +1891,7 @@ def create_credit_notes( credit_notes, summarize_errors=empty, unitdp=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1806,6 +1902,7 @@ def create_credit_notes( :param CreditNotes credit_notes: Credit Notes with array of CreditNote object in body of request (required) :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1840,6 +1937,9 @@ def create_credit_notes( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1883,6 +1983,7 @@ def create_currency( self, xero_tenant_id, currency, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1891,6 +1992,7 @@ def create_currency( OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param Currency currency: Currency object in the body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1919,6 +2021,9 @@ def create_currency( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1958,95 +2063,12 @@ def create_currency( except exceptions.HTTPStatusException as error: raise translate_status_exception(error, self, "create_currency") - def create_employees( - self, - xero_tenant_id, - employees, - summarize_errors=empty, - _return_http_data_only=True, - _preload_content=True, - _request_timeout=None, - ): - """Creates new employees used in Xero payrun # noqa: E501 - OAuth2 scope: accounting.settings - :param str xero_tenant_id: Xero identifier for Tenant (required) - :param Employees employees: Employees with array of Employee object in body of request (required) - :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors - :param bool _return_http_data_only: return received data only - :param bool _preload_content: load received data in models - :param bool _request_timeout: maximum wait time for response - :return: Employees - """ - - # verify the required parameter 'xero_tenant_id' is set - if xero_tenant_id is None: - raise ValueError( - "Missing the required parameter `xero_tenant_id` " - "when calling `create_employees`" - ) - # verify the required parameter 'employees' is set - if employees is None: - raise ValueError( - "Missing the required parameter `employees` " - "when calling `create_employees`" - ) - - collection_formats = {} - path_params = {} - - query_params = [] - - if summarize_errors is not empty: - query_params.append(("summarizeErrors", summarize_errors)) - - header_params = { - "xero-tenant-id": xero_tenant_id, - } - - local_var_files = {} - form_params = [] - - body_params = employees - # HTTP header `Accept` - header_params["Accept"] = self.api_client.select_header_accept( - ["application/json"] - ) - - # HTTP header `Content-Type` - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json"] - ) - - # Authentication setting - auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees") - - try: - return self.api_client.call_api( - url, - "PUT", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type="Employees", - response_model_finder=self.get_model_finder(), - auth_settings=auth_settings, - _return_http_data_only=_return_http_data_only, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - collection_formats=collection_formats, - ) - except exceptions.HTTPStatusException as error: - raise translate_status_exception(error, self, "create_employees") - def create_expense_claim_history( self, xero_tenant_id, expense_claim_id, history_records, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -2056,6 +2078,7 @@ def create_expense_claim_history( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str expense_claim_id: Unique identifier for a ExpenseClaim (required) :param HistoryRecords history_records: HistoryRecords containing an array of HistoryRecord objects in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -2092,6 +2115,9 @@ def create_expense_claim_history( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -2137,6 +2163,7 @@ def create_expense_claims( self, xero_tenant_id, expense_claims, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -2145,6 +2172,7 @@ def create_expense_claims( OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param ExpenseClaims expense_claims: ExpenseClaims with array of ExpenseClaim object in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -2173,6 +2201,9 @@ def create_expense_claims( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -2219,6 +2250,7 @@ def create_invoice_attachment_by_file_name( file_name, body, include_online=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -2230,6 +2262,7 @@ def create_invoice_attachment_by_file_name( :param str file_name: Name of the attachment (required) :param str body: Byte array of file in body of request (required) :param bool include_online: Allows an attachment to be seen by the end customer within their online invoice + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -2276,6 +2309,9 @@ def create_invoice_attachment_by_file_name( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -2322,6 +2358,7 @@ def create_invoice_history( xero_tenant_id, invoice_id, history_records, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -2331,6 +2368,7 @@ def create_invoice_history( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str invoice_id: Unique identifier for an Invoice (required) :param HistoryRecords history_records: HistoryRecords containing an array of HistoryRecord objects in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -2367,6 +2405,9 @@ def create_invoice_history( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -2412,6 +2453,8 @@ def create_invoices( invoices, summarize_errors=empty, unitdp=empty, + idempotency_key=empty, + allow_backorders=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -2422,6 +2465,8 @@ def create_invoices( :param Invoices invoices: Invoices with an array of invoice objects in body of request (required) :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + :param bool allow_backorders: Allows an invoice to be created even when one or more line items contain tracked inventory where the invoice quantity would cause the available quantity to go negative :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -2452,10 +2497,16 @@ def create_invoices( if unitdp is not empty: query_params.append(("unitdp", unitdp)) + if allow_backorders is not empty: + query_params.append(("allowBackorders", allow_backorders)) + header_params = { "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -2500,6 +2551,7 @@ def create_item_history( xero_tenant_id, item_id, history_records, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -2509,6 +2561,7 @@ def create_item_history( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str item_id: Unique identifier for an Item (required) :param HistoryRecords history_records: HistoryRecords containing an array of HistoryRecord objects in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -2545,6 +2598,9 @@ def create_item_history( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -2590,6 +2646,7 @@ def create_items( items, summarize_errors=empty, unitdp=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -2600,6 +2657,7 @@ def create_items( :param Items items: Items with an array of Item objects in body of request (required) :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -2633,6 +2691,9 @@ def create_items( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -2676,6 +2737,7 @@ def create_linked_transaction( self, xero_tenant_id, linked_transaction, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -2684,6 +2746,7 @@ def create_linked_transaction( OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param LinkedTransaction linked_transaction: LinkedTransaction object in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -2712,6 +2775,9 @@ def create_linked_transaction( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -2757,6 +2823,7 @@ def create_manual_journal_attachment_by_file_name( manual_journal_id, file_name, body, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -2767,6 +2834,7 @@ def create_manual_journal_attachment_by_file_name( :param str manual_journal_id: Unique identifier for a ManualJournal (required) :param str file_name: Name of the attachment (required) :param str body: Byte array of file in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -2810,6 +2878,9 @@ def create_manual_journal_attachment_by_file_name( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -2858,6 +2929,7 @@ def create_manual_journal_history_record( xero_tenant_id, manual_journal_id, history_records, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -2867,6 +2939,7 @@ def create_manual_journal_history_record( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str manual_journal_id: Unique identifier for a ManualJournal (required) :param HistoryRecords history_records: HistoryRecords containing an array of HistoryRecord objects in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -2903,6 +2976,9 @@ def create_manual_journal_history_record( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -2949,6 +3025,7 @@ def create_manual_journals( xero_tenant_id, manual_journals, summarize_errors=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -2958,6 +3035,7 @@ def create_manual_journals( :param str xero_tenant_id: Xero identifier for Tenant (required) :param ManualJournals manual_journals: ManualJournals array with ManualJournal object in body of request (required) :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -2989,6 +3067,9 @@ def create_manual_journals( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -3034,6 +3115,7 @@ def create_overpayment_allocations( overpayment_id, allocations, summarize_errors=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -3044,6 +3126,7 @@ def create_overpayment_allocations( :param str overpayment_id: Unique identifier for a Overpayment (required) :param Allocations allocations: Allocations array with Allocation object in body of request (required) :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -3083,6 +3166,9 @@ def create_overpayment_allocations( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -3129,6 +3215,7 @@ def create_overpayment_history( xero_tenant_id, overpayment_id, history_records, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -3138,6 +3225,7 @@ def create_overpayment_history( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str overpayment_id: Unique identifier for a Overpayment (required) :param HistoryRecords history_records: HistoryRecords containing an array of HistoryRecord objects in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -3174,6 +3262,9 @@ def create_overpayment_history( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -3217,6 +3308,7 @@ def create_payment( self, xero_tenant_id, payment, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -3225,6 +3317,7 @@ def create_payment( OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param Payment payment: Request body with a single Payment object (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -3253,6 +3346,9 @@ def create_payment( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -3297,6 +3393,7 @@ def create_payment_history( xero_tenant_id, payment_id, history_records, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -3306,6 +3403,7 @@ def create_payment_history( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str payment_id: Unique identifier for a Payment (required) :param HistoryRecords history_records: HistoryRecords containing an array of HistoryRecord objects in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -3342,6 +3440,9 @@ def create_payment_history( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -3385,6 +3486,7 @@ def create_payment_service( self, xero_tenant_id, payment_services, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -3393,6 +3495,7 @@ def create_payment_service( OAuth2 scope: paymentservices :param str xero_tenant_id: Xero identifier for Tenant (required) :param PaymentServices payment_services: PaymentServices array with PaymentService object in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -3421,6 +3524,9 @@ def create_payment_service( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -3465,6 +3571,7 @@ def create_payments( xero_tenant_id, payments, summarize_errors=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -3474,6 +3581,7 @@ def create_payments( :param str xero_tenant_id: Xero identifier for Tenant (required) :param Payments payments: Payments array with Payment object in body of request (required) :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -3505,6 +3613,9 @@ def create_payments( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -3550,6 +3661,7 @@ def create_prepayment_allocations( prepayment_id, allocations, summarize_errors=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -3560,6 +3672,7 @@ def create_prepayment_allocations( :param str prepayment_id: Unique identifier for a PrePayment (required) :param Allocations allocations: Allocations with an array of Allocation object in body of request (required) :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -3599,6 +3712,9 @@ def create_prepayment_allocations( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -3645,6 +3761,7 @@ def create_prepayment_history( xero_tenant_id, prepayment_id, history_records, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -3654,6 +3771,7 @@ def create_prepayment_history( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str prepayment_id: Unique identifier for a PrePayment (required) :param HistoryRecords history_records: HistoryRecords containing an array of HistoryRecord objects in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -3690,6 +3808,9 @@ def create_prepayment_history( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -3735,6 +3856,7 @@ def create_purchase_order_attachment_by_file_name( purchase_order_id, file_name, body, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -3745,6 +3867,7 @@ def create_purchase_order_attachment_by_file_name( :param str purchase_order_id: Unique identifier for an Purchase Order (required) :param str file_name: Name of the attachment (required) :param str body: Byte array of file in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -3788,6 +3911,9 @@ def create_purchase_order_attachment_by_file_name( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -3836,6 +3962,7 @@ def create_purchase_order_history( xero_tenant_id, purchase_order_id, history_records, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -3845,6 +3972,7 @@ def create_purchase_order_history( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str purchase_order_id: Unique identifier for an Purchase Order (required) :param HistoryRecords history_records: HistoryRecords containing an array of HistoryRecord objects in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -3881,6 +4009,9 @@ def create_purchase_order_history( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -3927,6 +4058,7 @@ def create_purchase_orders( xero_tenant_id, purchase_orders, summarize_errors=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -3936,6 +4068,7 @@ def create_purchase_orders( :param str xero_tenant_id: Xero identifier for Tenant (required) :param PurchaseOrders purchase_orders: PurchaseOrders with an array of PurchaseOrder object in body of request (required) :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -3967,6 +4100,9 @@ def create_purchase_orders( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -4012,6 +4148,7 @@ def create_quote_attachment_by_file_name( quote_id, file_name, body, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -4022,6 +4159,7 @@ def create_quote_attachment_by_file_name( :param str quote_id: Unique identifier for an Quote (required) :param str file_name: Name of the attachment (required) :param str body: Byte array of file in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -4065,6 +4203,9 @@ def create_quote_attachment_by_file_name( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -4111,6 +4252,7 @@ def create_quote_history( xero_tenant_id, quote_id, history_records, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -4120,6 +4262,7 @@ def create_quote_history( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str quote_id: Unique identifier for an Quote (required) :param HistoryRecords history_records: HistoryRecords containing an array of HistoryRecord objects in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -4156,6 +4299,9 @@ def create_quote_history( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -4200,6 +4346,7 @@ def create_quotes( xero_tenant_id, quotes, summarize_errors=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -4209,6 +4356,7 @@ def create_quotes( :param str xero_tenant_id: Xero identifier for Tenant (required) :param Quotes quotes: Quotes with an array of Quote object in body of request (required) :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -4240,6 +4388,9 @@ def create_quotes( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -4284,6 +4435,7 @@ def create_receipt( xero_tenant_id, receipts, unitdp=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -4293,6 +4445,7 @@ def create_receipt( :param str xero_tenant_id: Xero identifier for Tenant (required) :param Receipts receipts: Receipts with an array of Receipt object in body of request (required) :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -4324,6 +4477,9 @@ def create_receipt( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -4369,6 +4525,7 @@ def create_receipt_attachment_by_file_name( receipt_id, file_name, body, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -4379,6 +4536,7 @@ def create_receipt_attachment_by_file_name( :param str receipt_id: Unique identifier for a Receipt (required) :param str file_name: Name of the attachment (required) :param str body: Byte array of file in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -4422,6 +4580,9 @@ def create_receipt_attachment_by_file_name( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -4468,6 +4629,7 @@ def create_receipt_history( xero_tenant_id, receipt_id, history_records, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -4477,6 +4639,7 @@ def create_receipt_history( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str receipt_id: Unique identifier for a Receipt (required) :param HistoryRecords history_records: HistoryRecords containing an array of HistoryRecord objects in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -4513,6 +4676,9 @@ def create_receipt_history( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -4558,6 +4724,7 @@ def create_repeating_invoice_attachment_by_file_name( repeating_invoice_id, file_name, body, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -4568,6 +4735,7 @@ def create_repeating_invoice_attachment_by_file_name( :param str repeating_invoice_id: Unique identifier for a Repeating Invoice (required) :param str file_name: Name of the attachment (required) :param str body: Byte array of file in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -4611,6 +4779,9 @@ def create_repeating_invoice_attachment_by_file_name( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -4659,6 +4830,7 @@ def create_repeating_invoice_history( xero_tenant_id, repeating_invoice_id, history_records, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -4668,6 +4840,7 @@ def create_repeating_invoice_history( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str repeating_invoice_id: Unique identifier for a Repeating Invoice (required) :param HistoryRecords history_records: HistoryRecords containing an array of HistoryRecord objects in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -4704,6 +4877,9 @@ def create_repeating_invoice_history( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -4745,10 +4921,100 @@ def create_repeating_invoice_history( error, self, "create_repeating_invoice_history" ) + def create_repeating_invoices( + self, + xero_tenant_id, + repeating_invoices, + summarize_errors=empty, + idempotency_key=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Creates one or more repeating invoice templates # noqa: E501 + OAuth2 scope: accounting.transactions + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param RepeatingInvoices repeating_invoices: RepeatingInvoices with an array of repeating invoice objects in body of request (required) + :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: RepeatingInvoices + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `create_repeating_invoices`" + ) + # verify the required parameter 'repeating_invoices' is set + if repeating_invoices is None: + raise ValueError( + "Missing the required parameter `repeating_invoices` " + "when calling `create_repeating_invoices`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + if summarize_errors is not empty: + query_params.append(("summarizeErrors", summarize_errors)) + + header_params = { + "xero-tenant-id": xero_tenant_id, + } + + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + + local_var_files = {} + form_params = [] + + body_params = repeating_invoices + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/RepeatingInvoices") + + try: + return self.api_client.call_api( + url, + "PUT", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="RepeatingInvoices", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "create_repeating_invoices") + def create_tax_rates( self, xero_tenant_id, tax_rates, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -4757,6 +5023,7 @@ def create_tax_rates( OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param TaxRates tax_rates: TaxRates array with TaxRate object in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -4785,6 +5052,9 @@ def create_tax_rates( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -4828,6 +5098,7 @@ def create_tracking_category( self, xero_tenant_id, tracking_category, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -4836,6 +5107,7 @@ def create_tracking_category( OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param TrackingCategory tracking_category: TrackingCategory object in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -4864,6 +5136,9 @@ def create_tracking_category( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -4908,6 +5183,7 @@ def create_tracking_options( xero_tenant_id, tracking_category_id, tracking_option, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -4917,6 +5193,7 @@ def create_tracking_options( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str tracking_category_id: Unique identifier for a TrackingCategory (required) :param TrackingOption tracking_option: TrackingOption object in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -4953,6 +5230,9 @@ def create_tracking_options( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -5068,49 +5348,50 @@ def delete_account( except exceptions.HTTPStatusException as error: raise translate_status_exception(error, self, "delete_account") - def delete_contact_group_contact( + def delete_bank_transfer( self, xero_tenant_id, - contact_group_id, - contact_id, + bank_transfer_id, + bank_transfer_delete_by_url_param, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, ): - """Deletes a specific contact from a contact group using a unique contact Id # noqa: E501 - OAuth2 scope: accounting.contacts + """Deletes a specific bank transfer # noqa: E501 + OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) - :param str contact_group_id: Unique identifier for a Contact Group (required) - :param str contact_id: Unique identifier for a Contact (required) + :param str bank_transfer_id: Xero generated unique identifier for a bank transfer (required) + :param BankTransferDeleteByUrlParam bank_transfer_delete_by_url_param: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response - :return: None + :return: BankTransfers """ # verify the required parameter 'xero_tenant_id' is set if xero_tenant_id is None: raise ValueError( "Missing the required parameter `xero_tenant_id` " - "when calling `delete_contact_group_contact`" + "when calling `delete_bank_transfer`" ) - # verify the required parameter 'contact_group_id' is set - if contact_group_id is None: + # verify the required parameter 'bank_transfer_id' is set + if bank_transfer_id is None: raise ValueError( - "Missing the required parameter `contact_group_id` " - "when calling `delete_contact_group_contact`" + "Missing the required parameter `bank_transfer_id` " + "when calling `delete_bank_transfer`" ) - # verify the required parameter 'contact_id' is set - if contact_id is None: + # verify the required parameter 'bank_transfer_delete_by_url_param' is set + if bank_transfer_delete_by_url_param is None: raise ValueError( - "Missing the required parameter `contact_id` " - "when calling `delete_contact_group_contact`" + "Missing the required parameter `bank_transfer_delete_by_url_param` " + "when calling `delete_bank_transfer`" ) collection_formats = {} path_params = { - "ContactGroupID": contact_group_id, - "ContactID": contact_id, + "BankTransferID": bank_transfer_id, } query_params = [] @@ -5119,10 +5400,372 @@ def delete_contact_group_contact( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] - body_params = None + body_params = bank_transfer_delete_by_url_param + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/BankTransfers/{BankTransferID}") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="BankTransfers", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "delete_bank_transfer") + + def delete_bank_transfers( + self, + xero_tenant_id, + bank_transfers_delete, + summarize_errors=empty, + idempotency_key=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Deletes one or more bank transfers # noqa: E501 + OAuth2 scope: accounting.transactions + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param BankTransfersDelete bank_transfers_delete: BankTransfers with array of BankTransfer objects in request body (required) + :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: BankTransfers + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `delete_bank_transfers`" + ) + # verify the required parameter 'bank_transfers_delete' is set + if bank_transfers_delete is None: + raise ValueError( + "Missing the required parameter `bank_transfers_delete` " + "when calling `delete_bank_transfers`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + if summarize_errors is not empty: + query_params.append(("summarizeErrors", summarize_errors)) + + header_params = { + "xero-tenant-id": xero_tenant_id, + } + + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + + local_var_files = {} + form_params = [] + + body_params = bank_transfers_delete + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/BankTransfers") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="BankTransfers", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "delete_bank_transfers") + + def delete_batch_payment( + self, + xero_tenant_id, + batch_payment_delete, + idempotency_key=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Updates a specific batch payment for invoices and credit notes # noqa: E501 + OAuth2 scope: accounting.transactions + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param BatchPaymentDelete batch_payment_delete: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: BatchPayments + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `delete_batch_payment`" + ) + # verify the required parameter 'batch_payment_delete' is set + if batch_payment_delete is None: + raise ValueError( + "Missing the required parameter `batch_payment_delete` " + "when calling `delete_batch_payment`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + header_params = { + "xero-tenant-id": xero_tenant_id, + } + + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + + local_var_files = {} + form_params = [] + + body_params = batch_payment_delete + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/BatchPayments") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="BatchPayments", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "delete_batch_payment") + + def delete_batch_payment_by_url_param( + self, + xero_tenant_id, + batch_payment_id, + batch_payment_delete_by_url_param, + idempotency_key=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Updates a specific batch payment for invoices and credit notes # noqa: E501 + OAuth2 scope: accounting.transactions + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str batch_payment_id: Unique identifier for BatchPayment (required) + :param BatchPaymentDeleteByUrlParam batch_payment_delete_by_url_param: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: BatchPayments + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `delete_batch_payment_by_url_param`" + ) + # verify the required parameter 'batch_payment_id' is set + if batch_payment_id is None: + raise ValueError( + "Missing the required parameter `batch_payment_id` " + "when calling `delete_batch_payment_by_url_param`" + ) + # verify the required parameter 'batch_payment_delete_by_url_param' is set + if batch_payment_delete_by_url_param is None: + raise ValueError( + "Missing the required parameter `batch_payment_delete_by_url_param` " + "when calling `delete_batch_payment_by_url_param`" + ) + + collection_formats = {} + path_params = { + "BatchPaymentID": batch_payment_id, + } + + query_params = [] + + header_params = { + "xero-tenant-id": xero_tenant_id, + } + + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + + local_var_files = {} + form_params = [] + + body_params = batch_payment_delete_by_url_param + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/BatchPayments/{BatchPaymentID}") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="BatchPayments", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception( + error, self, "delete_batch_payment_by_url_param" + ) + + def delete_contact_group_contact( + self, + xero_tenant_id, + contact_group_id, + contact_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Deletes a specific contact from a contact group using a unique contact Id # noqa: E501 + OAuth2 scope: accounting.contacts + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str contact_group_id: Unique identifier for a Contact Group (required) + :param str contact_id: Unique identifier for a Contact (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: None + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `delete_contact_group_contact`" + ) + # verify the required parameter 'contact_group_id' is set + if contact_group_id is None: + raise ValueError( + "Missing the required parameter `contact_group_id` " + "when calling `delete_contact_group_contact`" + ) + # verify the required parameter 'contact_id' is set + if contact_id is None: + raise ValueError( + "Missing the required parameter `contact_id` " + "when calling `delete_contact_group_contact`" + ) + + collection_formats = {} + path_params = { + "ContactGroupID": contact_group_id, + "ContactID": contact_id, + } + + query_params = [] + + header_params = { + "xero-tenant-id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None # HTTP header `Accept` header_params["Accept"] = self.api_client.select_header_accept( ["application/json"] @@ -5230,6 +5873,95 @@ def delete_contact_group_contacts( error, self, "delete_contact_group_contacts" ) + def delete_credit_note_allocations( + self, + xero_tenant_id, + credit_note_id, + allocation_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Deletes an Allocation from a Credit Note # noqa: E501 + OAuth2 scope: accounting.transactions + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str credit_note_id: Unique identifier for a Credit Note (required) + :param str allocation_id: Unique identifier for Allocation object (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: Allocation + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `delete_credit_note_allocations`" + ) + # verify the required parameter 'credit_note_id' is set + if credit_note_id is None: + raise ValueError( + "Missing the required parameter `credit_note_id` " + "when calling `delete_credit_note_allocations`" + ) + # verify the required parameter 'allocation_id' is set + if allocation_id is None: + raise ValueError( + "Missing the required parameter `allocation_id` " + "when calling `delete_credit_note_allocations`" + ) + + collection_formats = {} + path_params = { + "CreditNoteID": credit_note_id, + "AllocationID": allocation_id, + } + + query_params = [] + + header_params = { + "xero-tenant-id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url( + "/CreditNotes/{CreditNoteID}/Allocations/{AllocationID}" + ) + + try: + return self.api_client.call_api( + url, + "DELETE", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="Allocation", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception( + error, self, "delete_credit_note_allocations" + ) + def delete_item( self, xero_tenant_id, @@ -5381,11 +6113,101 @@ def delete_linked_transaction( except exceptions.HTTPStatusException as error: raise translate_status_exception(error, self, "delete_linked_transaction") + def delete_overpayment_allocations( + self, + xero_tenant_id, + overpayment_id, + allocation_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Deletes an Allocation from an overpayment # noqa: E501 + OAuth2 scope: accounting.transactions + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str overpayment_id: Unique identifier for a Overpayment (required) + :param str allocation_id: Unique identifier for Allocation object (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: Allocation + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `delete_overpayment_allocations`" + ) + # verify the required parameter 'overpayment_id' is set + if overpayment_id is None: + raise ValueError( + "Missing the required parameter `overpayment_id` " + "when calling `delete_overpayment_allocations`" + ) + # verify the required parameter 'allocation_id' is set + if allocation_id is None: + raise ValueError( + "Missing the required parameter `allocation_id` " + "when calling `delete_overpayment_allocations`" + ) + + collection_formats = {} + path_params = { + "OverpaymentID": overpayment_id, + "AllocationID": allocation_id, + } + + query_params = [] + + header_params = { + "xero-tenant-id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url( + "/Overpayments/{OverpaymentID}/Allocations/{AllocationID}" + ) + + try: + return self.api_client.call_api( + url, + "DELETE", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="Allocation", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception( + error, self, "delete_overpayment_allocations" + ) + def delete_payment( self, xero_tenant_id, payment_id, payment_delete, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -5395,6 +6217,7 @@ def delete_payment( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str payment_id: Unique identifier for a Payment (required) :param PaymentDelete payment_delete: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -5431,6 +6254,9 @@ def delete_payment( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -5447,19 +6273,106 @@ def delete_payment( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Payments/{PaymentID}") + url = self.get_resource_url("/Payments/{PaymentID}") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="Payments", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "delete_payment") + + def delete_prepayment_allocations( + self, + xero_tenant_id, + prepayment_id, + allocation_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Deletes an Allocation from a Prepayment # noqa: E501 + OAuth2 scope: accounting.transactions + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str prepayment_id: Unique identifier for a PrePayment (required) + :param str allocation_id: Unique identifier for Allocation object (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: Allocation + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `delete_prepayment_allocations`" + ) + # verify the required parameter 'prepayment_id' is set + if prepayment_id is None: + raise ValueError( + "Missing the required parameter `prepayment_id` " + "when calling `delete_prepayment_allocations`" + ) + # verify the required parameter 'allocation_id' is set + if allocation_id is None: + raise ValueError( + "Missing the required parameter `allocation_id` " + "when calling `delete_prepayment_allocations`" + ) + + collection_formats = {} + path_params = { + "PrepaymentID": prepayment_id, + "AllocationID": allocation_id, + } + + query_params = [] + + header_params = { + "xero-tenant-id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url( + "/Prepayments/{PrepaymentID}/Allocations/{AllocationID}" + ) try: return self.api_client.call_api( url, - "POST", + "DELETE", path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type="Payments", + response_type="Allocation", response_model_finder=self.get_model_finder(), auth_settings=auth_settings, _return_http_data_only=_return_http_data_only, @@ -5468,7 +6381,9 @@ def delete_payment( collection_formats=collection_formats, ) except exceptions.HTTPStatusException as error: - raise translate_status_exception(error, self, "delete_payment") + raise translate_status_exception( + error, self, "delete_prepayment_allocations" + ) def delete_tracking_category( self, @@ -5638,6 +6553,7 @@ def email_invoice( xero_tenant_id, invoice_id, request_empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -5647,6 +6563,7 @@ def email_invoice( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str invoice_id: Unique identifier for an Invoice (required) :param RequestEmpty request_empty: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -5683,6 +6600,9 @@ def email_invoice( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -6510,6 +7430,8 @@ def get_bank_transactions( order=empty, page=empty, unitdp=empty, + page_size=empty, + references=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -6522,6 +7444,8 @@ def get_bank_transactions( :param str order: Order by an any element :param int page: Up to 100 bank transactions will be returned in a single API call with line items details :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param int page_size: Number of records to retrieve per page + :param list[str] references: Filter by a comma-separated list of References :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -6535,7 +7459,9 @@ def get_bank_transactions( "when calling `get_bank_transactions`" ) - collection_formats = {} + collection_formats = { + "References": "csv", + } path_params = {} query_params = [] @@ -6552,6 +7478,12 @@ def get_bank_transactions( if unitdp is not empty: query_params.append(("unitdp", unitdp)) + if page_size is not empty: + query_params.append(("pageSize", page_size)) + + if references is not empty: + query_params.append(("References", references)) + header_params = { "xero-tenant-id": xero_tenant_id, } @@ -7103,6 +8035,7 @@ def get_bank_transfers( if_modified_since=empty, where=empty, order=empty, + include_deleted=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -7113,6 +8046,7 @@ def get_bank_transfers( :param datetime if_modified_since: Only records created or modified since this timestamp will be returned :param str where: Filter by an any element :param str order: Order by an any element + :param bool include_deleted: e.g. includeDeleted=true - Bank transfers with a status of DELETED will be included in the response :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -7137,6 +8071,9 @@ def get_bank_transfers( if order is not empty: query_params.append(("order", order)) + if include_deleted is not empty: + query_params.append(("includeDeleted", include_deleted)) + header_params = { "xero-tenant-id": xero_tenant_id, } @@ -7178,6 +8115,82 @@ def get_bank_transfers( except exceptions.HTTPStatusException as error: raise translate_status_exception(error, self, "get_bank_transfers") + def get_batch_payment( + self, + xero_tenant_id, + batch_payment_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Retrieves a specific batch payment using a unique batch payment Id # noqa: E501 + OAuth2 scope: accounting.transactions, accounting.transactions.read + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str batch_payment_id: Unique identifier for BatchPayment (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: BatchPayments + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_batch_payment`" + ) + # verify the required parameter 'batch_payment_id' is set + if batch_payment_id is None: + raise ValueError( + "Missing the required parameter `batch_payment_id` " + "when calling `get_batch_payment`" + ) + + collection_formats = {} + path_params = { + "BatchPaymentID": batch_payment_id, + } + + query_params = [] + + header_params = { + "xero-tenant-id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/BatchPayments/{BatchPaymentID}") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="BatchPayments", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_batch_payment") + def get_batch_payment_history( self, xero_tenant_id, @@ -8461,6 +9474,7 @@ def get_contacts( include_archived=empty, summary_only=empty, search_term=empty, + page_size=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -8476,6 +9490,7 @@ def get_contacts( :param bool include_archived: e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response :param bool summary_only: Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. :param str search_term: Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields. + :param int page_size: Number of records to retrieve per page :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -8517,6 +9532,9 @@ def get_contacts( if search_term is not empty: query_params.append(("searchTerm", search_term)) + if page_size is not empty: + query_params.append(("pageSize", page_size)) + header_params = { "xero-tenant-id": xero_tenant_id, } @@ -8950,175 +9968,8 @@ def get_credit_note_attachments( query_params = [] header_params = { - "xero-tenant-id": xero_tenant_id, - } - - local_var_files = {} - form_params = [] - - body_params = None - # HTTP header `Accept` - header_params["Accept"] = self.api_client.select_header_accept( - ["application/json"] - ) - - # Authentication setting - auth_settings = ["OAuth2"] - url = self.get_resource_url("/CreditNotes/{CreditNoteID}/Attachments") - - try: - return self.api_client.call_api( - url, - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type="Attachments", - response_model_finder=self.get_model_finder(), - auth_settings=auth_settings, - _return_http_data_only=_return_http_data_only, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - collection_formats=collection_formats, - ) - except exceptions.HTTPStatusException as error: - raise translate_status_exception(error, self, "get_credit_note_attachments") - - def get_credit_note_history( - self, - xero_tenant_id, - credit_note_id, - _return_http_data_only=True, - _preload_content=True, - _request_timeout=None, - ): - """Retrieves history records of a specific credit note # noqa: E501 - OAuth2 scope: accounting.transactions, accounting.transactions.read - :param str xero_tenant_id: Xero identifier for Tenant (required) - :param str credit_note_id: Unique identifier for a Credit Note (required) - :param bool _return_http_data_only: return received data only - :param bool _preload_content: load received data in models - :param bool _request_timeout: maximum wait time for response - :return: HistoryRecords - """ - - # verify the required parameter 'xero_tenant_id' is set - if xero_tenant_id is None: - raise ValueError( - "Missing the required parameter `xero_tenant_id` " - "when calling `get_credit_note_history`" - ) - # verify the required parameter 'credit_note_id' is set - if credit_note_id is None: - raise ValueError( - "Missing the required parameter `credit_note_id` " - "when calling `get_credit_note_history`" - ) - - collection_formats = {} - path_params = { - "CreditNoteID": credit_note_id, - } - - query_params = [] - - header_params = { - "xero-tenant-id": xero_tenant_id, - } - - local_var_files = {} - form_params = [] - - body_params = None - # HTTP header `Accept` - header_params["Accept"] = self.api_client.select_header_accept( - ["application/json"] - ) - - # Authentication setting - auth_settings = ["OAuth2"] - url = self.get_resource_url("/CreditNotes/{CreditNoteID}/History") - - try: - return self.api_client.call_api( - url, - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type="HistoryRecords", - response_model_finder=self.get_model_finder(), - auth_settings=auth_settings, - _return_http_data_only=_return_http_data_only, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - collection_formats=collection_formats, - ) - except exceptions.HTTPStatusException as error: - raise translate_status_exception(error, self, "get_credit_note_history") - - def get_credit_notes( - self, - xero_tenant_id, - if_modified_since=empty, - where=empty, - order=empty, - page=empty, - unitdp=empty, - _return_http_data_only=True, - _preload_content=True, - _request_timeout=None, - ): - """Retrieves any credit notes # noqa: E501 - OAuth2 scope: accounting.transactions, accounting.transactions.read - :param str xero_tenant_id: Xero identifier for Tenant (required) - :param datetime if_modified_since: Only records created or modified since this timestamp will be returned - :param str where: Filter by an any element - :param str order: Order by an any element - :param int page: e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note - :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts - :param bool _return_http_data_only: return received data only - :param bool _preload_content: load received data in models - :param bool _request_timeout: maximum wait time for response - :return: CreditNotes - """ - - # verify the required parameter 'xero_tenant_id' is set - if xero_tenant_id is None: - raise ValueError( - "Missing the required parameter `xero_tenant_id` " - "when calling `get_credit_notes`" - ) - - collection_formats = {} - path_params = {} - - query_params = [] - - if where is not empty: - query_params.append(("where", where)) - - if order is not empty: - query_params.append(("order", order)) - - if page is not empty: - query_params.append(("page", page)) - - if unitdp is not empty: - query_params.append(("unitdp", unitdp)) - - header_params = { - "xero-tenant-id": xero_tenant_id, - } - - if if_modified_since is not empty: - header_params["If-Modified-Since"] = if_modified_since + "xero-tenant-id": xero_tenant_id, + } local_var_files = {} form_params = [] @@ -9131,7 +9982,7 @@ def get_credit_notes( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/CreditNotes") + url = self.get_resource_url("/CreditNotes/{CreditNoteID}/Attachments") try: return self.api_client.call_api( @@ -9143,7 +9994,7 @@ def get_credit_notes( body=body_params, post_params=form_params, files=local_var_files, - response_type="CreditNotes", + response_type="Attachments", response_model_finder=self.get_model_finder(), auth_settings=auth_settings, _return_http_data_only=_return_http_data_only, @@ -9152,46 +10003,46 @@ def get_credit_notes( collection_formats=collection_formats, ) except exceptions.HTTPStatusException as error: - raise translate_status_exception(error, self, "get_credit_notes") + raise translate_status_exception(error, self, "get_credit_note_attachments") - def get_currencies( + def get_credit_note_history( self, xero_tenant_id, - where=empty, - order=empty, + credit_note_id, _return_http_data_only=True, _preload_content=True, _request_timeout=None, ): - """Retrieves currencies for your Xero organisation # noqa: E501 - OAuth2 scope: accounting.settings, accounting.settings.read + """Retrieves history records of a specific credit note # noqa: E501 + OAuth2 scope: accounting.transactions, accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) - :param str where: Filter by an any element - :param str order: Order by an any element + :param str credit_note_id: Unique identifier for a Credit Note (required) :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response - :return: Currencies + :return: HistoryRecords """ # verify the required parameter 'xero_tenant_id' is set if xero_tenant_id is None: raise ValueError( "Missing the required parameter `xero_tenant_id` " - "when calling `get_currencies`" + "when calling `get_credit_note_history`" + ) + # verify the required parameter 'credit_note_id' is set + if credit_note_id is None: + raise ValueError( + "Missing the required parameter `credit_note_id` " + "when calling `get_credit_note_history`" ) collection_formats = {} - path_params = {} + path_params = { + "CreditNoteID": credit_note_id, + } query_params = [] - if where is not empty: - query_params.append(("where", where)) - - if order is not empty: - query_params.append(("order", order)) - header_params = { "xero-tenant-id": xero_tenant_id, } @@ -9207,7 +10058,7 @@ def get_currencies( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Currencies") + url = self.get_resource_url("/CreditNotes/{CreditNoteID}/History") try: return self.api_client.call_api( @@ -9219,7 +10070,7 @@ def get_currencies( body=body_params, post_params=form_params, files=local_var_files, - response_type="Currencies", + response_type="HistoryRecords", response_model_finder=self.get_model_finder(), auth_settings=auth_settings, _return_http_data_only=_return_http_data_only, @@ -9228,50 +10079,70 @@ def get_currencies( collection_formats=collection_formats, ) except exceptions.HTTPStatusException as error: - raise translate_status_exception(error, self, "get_currencies") + raise translate_status_exception(error, self, "get_credit_note_history") - def get_employee( + def get_credit_notes( self, xero_tenant_id, - employee_id, + if_modified_since=empty, + where=empty, + order=empty, + page=empty, + unitdp=empty, + page_size=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, ): - """Retrieves a specific employee used in Xero payrun using a unique employee Id # noqa: E501 - OAuth2 scope: accounting.settings, accounting.settings.read + """Retrieves any credit notes # noqa: E501 + OAuth2 scope: accounting.transactions, accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) - :param str employee_id: Unique identifier for a Employee (required) + :param datetime if_modified_since: Only records created or modified since this timestamp will be returned + :param str where: Filter by an any element + :param str order: Order by an any element + :param int page: e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note + :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param int page_size: Number of records to retrieve per page :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response - :return: Employees + :return: CreditNotes """ # verify the required parameter 'xero_tenant_id' is set if xero_tenant_id is None: raise ValueError( "Missing the required parameter `xero_tenant_id` " - "when calling `get_employee`" - ) - # verify the required parameter 'employee_id' is set - if employee_id is None: - raise ValueError( - "Missing the required parameter `employee_id` " - "when calling `get_employee`" + "when calling `get_credit_notes`" ) collection_formats = {} - path_params = { - "EmployeeID": employee_id, - } + path_params = {} query_params = [] + if where is not empty: + query_params.append(("where", where)) + + if order is not empty: + query_params.append(("order", order)) + + if page is not empty: + query_params.append(("page", page)) + + if unitdp is not empty: + query_params.append(("unitdp", unitdp)) + + if page_size is not empty: + query_params.append(("pageSize", page_size)) + header_params = { "xero-tenant-id": xero_tenant_id, } + if if_modified_since is not empty: + header_params["If-Modified-Since"] = if_modified_since + local_var_files = {} form_params = [] @@ -9283,7 +10154,7 @@ def get_employee( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeID}") + url = self.get_resource_url("/CreditNotes") try: return self.api_client.call_api( @@ -9295,7 +10166,7 @@ def get_employee( body=body_params, post_params=form_params, files=local_var_files, - response_type="Employees", + response_type="CreditNotes", response_model_finder=self.get_model_finder(), auth_settings=auth_settings, _return_http_data_only=_return_http_data_only, @@ -9304,35 +10175,33 @@ def get_employee( collection_formats=collection_formats, ) except exceptions.HTTPStatusException as error: - raise translate_status_exception(error, self, "get_employee") + raise translate_status_exception(error, self, "get_credit_notes") - def get_employees( + def get_currencies( self, xero_tenant_id, - if_modified_since=empty, where=empty, order=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, ): - """Retrieves employees used in Xero payrun # noqa: E501 + """Retrieves currencies for your Xero organisation # noqa: E501 OAuth2 scope: accounting.settings, accounting.settings.read :param str xero_tenant_id: Xero identifier for Tenant (required) - :param datetime if_modified_since: Only records created or modified since this timestamp will be returned :param str where: Filter by an any element :param str order: Order by an any element :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response - :return: Employees + :return: Currencies """ # verify the required parameter 'xero_tenant_id' is set if xero_tenant_id is None: raise ValueError( "Missing the required parameter `xero_tenant_id` " - "when calling `get_employees`" + "when calling `get_currencies`" ) collection_formats = {} @@ -9350,9 +10219,6 @@ def get_employees( "xero-tenant-id": xero_tenant_id, } - if if_modified_since is not empty: - header_params["If-Modified-Since"] = if_modified_since - local_var_files = {} form_params = [] @@ -9364,7 +10230,7 @@ def get_employees( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees") + url = self.get_resource_url("/Currencies") try: return self.api_client.call_api( @@ -9376,7 +10242,7 @@ def get_employees( body=body_params, post_params=form_params, files=local_var_files, - response_type="Employees", + response_type="Currencies", response_model_finder=self.get_model_finder(), auth_settings=auth_settings, _return_http_data_only=_return_http_data_only, @@ -9385,7 +10251,7 @@ def get_employees( collection_formats=collection_formats, ) except exceptions.HTTPStatusException as error: - raise translate_status_exception(error, self, "get_employees") + raise translate_status_exception(error, self, "get_currencies") def get_expense_claim( self, @@ -10202,6 +11068,8 @@ def get_invoices( created_by_my_app=empty, unitdp=empty, summary_only=empty, + page_size=empty, + search_term=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -10221,6 +11089,8 @@ def get_invoices( :param bool created_by_my_app: When set to true you'll only retrieve Invoices created by your app :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts :param bool summary_only: Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. + :param int page_size: Number of records to retrieve per page + :param str search_term: Search parameter that performs a case-insensitive text search across the fields e.g. InvoiceNumber, Reference. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -10277,6 +11147,12 @@ def get_invoices( if summary_only is not empty: query_params.append(("summaryOnly", summary_only)) + if page_size is not empty: + query_params.append(("pageSize", page_size)) + + if search_term is not empty: + query_params.append(("searchTerm", search_term)) + header_params = { "xero-tenant-id": xero_tenant_id, } @@ -10636,6 +11512,82 @@ def get_journal( except exceptions.HTTPStatusException as error: raise translate_status_exception(error, self, "get_journal") + def get_journal_by_number( + self, + xero_tenant_id, + journal_number, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Retrieves a specific journal using a unique journal number. # noqa: E501 + OAuth2 scope: accounting.journals.read + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param int journal_number: Number of a Journal (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: Journals + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_journal_by_number`" + ) + # verify the required parameter 'journal_number' is set + if journal_number is None: + raise ValueError( + "Missing the required parameter `journal_number` " + "when calling `get_journal_by_number`" + ) + + collection_formats = {} + path_params = { + "JournalNumber": journal_number, + } + + query_params = [] + + header_params = { + "xero-tenant-id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Journals/{JournalNumber}") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="Journals", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_journal_by_number") + def get_journals( self, xero_tenant_id, @@ -11246,6 +12198,7 @@ def get_manual_journals( where=empty, order=empty, page=empty, + page_size=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -11257,6 +12210,7 @@ def get_manual_journals( :param str where: Filter by an any element :param str order: Order by an any element :param int page: e.g. page=1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment + :param int page_size: Number of records to retrieve per page :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -11284,6 +12238,9 @@ def get_manual_journals( if page is not empty: query_params.append(("page", page)) + if page_size is not empty: + query_params.append(("pageSize", page_size)) + header_params = { "xero-tenant-id": xero_tenant_id, } @@ -11847,6 +12804,8 @@ def get_overpayments( order=empty, page=empty, unitdp=empty, + page_size=empty, + references=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -11859,6 +12818,8 @@ def get_overpayments( :param str order: Order by an any element :param int page: e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param int page_size: Number of records to retrieve per page + :param list[str] references: Filter by a comma-separated list of References :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -11872,7 +12833,9 @@ def get_overpayments( "when calling `get_overpayments`" ) - collection_formats = {} + collection_formats = { + "References": "csv", + } path_params = {} query_params = [] @@ -11889,6 +12852,12 @@ def get_overpayments( if unitdp is not empty: query_params.append(("unitdp", unitdp)) + if page_size is not empty: + query_params.append(("pageSize", page_size)) + + if references is not empty: + query_params.append(("References", references)) + header_params = { "xero-tenant-id": xero_tenant_id, } @@ -12155,6 +13124,7 @@ def get_payments( where=empty, order=empty, page=empty, + page_size=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -12166,6 +13136,7 @@ def get_payments( :param str where: Filter by an any element :param str order: Order by an any element :param int page: Up to 100 payments will be returned in a single API call + :param int page_size: Number of records to retrieve per page :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -12193,6 +13164,9 @@ def get_payments( if page is not empty: query_params.append(("page", page)) + if page_size is not empty: + query_params.append(("pageSize", page_size)) + header_params = { "xero-tenant-id": xero_tenant_id, } @@ -12394,6 +13368,9 @@ def get_prepayments( order=empty, page=empty, unitdp=empty, + page_size=empty, + invoice_numbers=empty, + references=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -12404,8 +13381,11 @@ def get_prepayments( :param datetime if_modified_since: Only records created or modified since this timestamp will be returned :param str where: Filter by an any element :param str order: Order by an any element - :param int page: e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment + :param int page: e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each prepayment :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param int page_size: Number of records to retrieve per page + :param list[str] invoice_numbers: Filter by a comma-separated list of InvoiceNumbers + :param list[str] references: Filter by a comma-separated list of References :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -12419,7 +13399,10 @@ def get_prepayments( "when calling `get_prepayments`" ) - collection_formats = {} + collection_formats = { + "InvoiceNumbers": "csv", + "References": "csv", + } path_params = {} query_params = [] @@ -12436,6 +13419,15 @@ def get_prepayments( if unitdp is not empty: query_params.append(("unitdp", unitdp)) + if page_size is not empty: + query_params.append(("pageSize", page_size)) + + if invoice_numbers is not empty: + query_params.append(("InvoiceNumbers", invoice_numbers)) + + if references is not empty: + query_params.append(("References", references)) + header_params = { "xero-tenant-id": xero_tenant_id, } @@ -13066,6 +14058,7 @@ def get_purchase_orders( date_to=empty, order=empty, page=empty, + page_size=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -13079,6 +14072,7 @@ def get_purchase_orders( :param str date_to: Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31 :param str order: Order by an any element :param int page: To specify a page, append the page parameter to the URL e.g. ?page=1. If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g ?page=2 and continuing this process until no more results are returned. + :param int page_size: Number of records to retrieve per page :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -13112,6 +14106,9 @@ def get_purchase_orders( if page is not empty: query_params.append(("page", page)) + if page_size is not empty: + query_params.append(("pageSize", page_size)) + header_params = { "xero-tenant-id": xero_tenant_id, } @@ -15701,12 +16698,87 @@ def get_reports_list( except exceptions.HTTPStatusException as error: raise translate_status_exception(error, self, "get_reports_list") + def get_tax_rate_by_tax_type( + self, + xero_tenant_id, + tax_type, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Retrieves a specific tax rate according to given TaxType code # noqa: E501 + OAuth2 scope: accounting.settings, accounting.settings.read + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str tax_type: A valid TaxType code (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: TaxRates + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_tax_rate_by_tax_type`" + ) + # verify the required parameter 'tax_type' is set + if tax_type is None: + raise ValueError( + "Missing the required parameter `tax_type` " + "when calling `get_tax_rate_by_tax_type`" + ) + + collection_formats = {} + path_params = { + "TaxType": tax_type, + } + + query_params = [] + + header_params = { + "xero-tenant-id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/TaxRates/{TaxType}") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="TaxRates", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_tax_rate_by_tax_type") + def get_tax_rates( self, xero_tenant_id, where=empty, order=empty, - tax_type=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -15716,7 +16788,6 @@ def get_tax_rates( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str where: Filter by an any element :param str order: Order by an any element - :param str tax_type: Filter by tax type :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -15741,9 +16812,6 @@ def get_tax_rates( if order is not empty: query_params.append(("order", order)) - if tax_type is not empty: - query_params.append(("TaxType", tax_type)) - header_params = { "xero-tenant-id": xero_tenant_id, } @@ -16099,6 +17167,7 @@ def post_setup( self, xero_tenant_id, setup, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -16107,6 +17176,7 @@ def post_setup( OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param Setup setup: Object including an accounts array, a conversion balances array and a conversion date object in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -16134,6 +17204,9 @@ def post_setup( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -16178,6 +17251,7 @@ def update_account( xero_tenant_id, account_id, accounts, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -16187,6 +17261,7 @@ def update_account( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str account_id: Unique identifier for Account object (required) :param Accounts accounts: Request of type Accounts array with one Account (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -16223,6 +17298,9 @@ def update_account( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -16268,6 +17346,7 @@ def update_account_attachment_by_file_name( account_id, file_name, body, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -16278,6 +17357,7 @@ def update_account_attachment_by_file_name( :param str account_id: Unique identifier for Account object (required) :param str file_name: Name of the attachment (required) :param str body: Byte array of file in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -16321,6 +17401,9 @@ def update_account_attachment_by_file_name( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -16368,6 +17451,7 @@ def update_bank_transaction( bank_transaction_id, bank_transactions, unitdp=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -16378,6 +17462,7 @@ def update_bank_transaction( :param str bank_transaction_id: Xero generated unique identifier for a bank transaction (required) :param BankTransactions bank_transactions: (required) :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -16417,6 +17502,9 @@ def update_bank_transaction( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -16462,6 +17550,7 @@ def update_bank_transaction_attachment_by_file_name( bank_transaction_id, file_name, body, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -16472,6 +17561,7 @@ def update_bank_transaction_attachment_by_file_name( :param str bank_transaction_id: Xero generated unique identifier for a bank transaction (required) :param str file_name: Name of the attachment (required) :param str body: Byte array of file in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -16515,6 +17605,9 @@ def update_bank_transaction_attachment_by_file_name( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -16564,6 +17657,7 @@ def update_bank_transfer_attachment_by_file_name( bank_transfer_id, file_name, body, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -16574,6 +17668,7 @@ def update_bank_transfer_attachment_by_file_name( :param str bank_transfer_id: Xero generated unique identifier for a bank transfer (required) :param str file_name: Name of the attachment (required) :param str body: Byte array of file in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -16617,6 +17712,9 @@ def update_bank_transfer_attachment_by_file_name( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -16665,6 +17763,7 @@ def update_contact( xero_tenant_id, contact_id, contacts, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -16674,6 +17773,7 @@ def update_contact( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str contact_id: Unique identifier for a Contact (required) :param Contacts contacts: an array of Contacts containing single Contact object with properties to update (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -16710,6 +17810,9 @@ def update_contact( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -16755,6 +17858,7 @@ def update_contact_attachment_by_file_name( contact_id, file_name, body, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -16765,6 +17869,7 @@ def update_contact_attachment_by_file_name( :param str contact_id: Unique identifier for a Contact (required) :param str file_name: Name of the attachment (required) :param str body: Byte array of file in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -16808,6 +17913,9 @@ def update_contact_attachment_by_file_name( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -16854,6 +17962,7 @@ def update_contact_group( xero_tenant_id, contact_group_id, contact_groups, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -16863,6 +17972,7 @@ def update_contact_group( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str contact_group_id: Unique identifier for a Contact Group (required) :param ContactGroups contact_groups: an array of Contact groups with Name of specific group to update (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -16899,6 +18009,9 @@ def update_contact_group( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -16944,6 +18057,7 @@ def update_credit_note( credit_note_id, credit_notes, unitdp=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -16954,6 +18068,7 @@ def update_credit_note( :param str credit_note_id: Unique identifier for a Credit Note (required) :param CreditNotes credit_notes: an array of Credit Notes containing credit note details to update (required) :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -16993,6 +18108,9 @@ def update_credit_note( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -17038,6 +18156,7 @@ def update_credit_note_attachment_by_file_name( credit_note_id, file_name, body, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -17048,6 +18167,7 @@ def update_credit_note_attachment_by_file_name( :param str credit_note_id: Unique identifier for a Credit Note (required) :param str file_name: Name of the attachment (required) :param str body: Byte array of file in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -17091,6 +18211,9 @@ def update_credit_note_attachment_by_file_name( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -17139,6 +18262,7 @@ def update_expense_claim( xero_tenant_id, expense_claim_id, expense_claims, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -17148,6 +18272,7 @@ def update_expense_claim( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str expense_claim_id: Unique identifier for a ExpenseClaim (required) :param ExpenseClaims expense_claims: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -17184,6 +18309,9 @@ def update_expense_claim( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -17229,6 +18357,8 @@ def update_invoice( invoice_id, invoices, unitdp=empty, + idempotency_key=empty, + allow_backorders=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -17239,6 +18369,8 @@ def update_invoice( :param str invoice_id: Unique identifier for an Invoice (required) :param Invoices invoices: (required) :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + :param bool allow_backorders: Allows an invoice to be created even when one or more line items contain tracked inventory where the invoice quantity would cause the available quantity to go negative :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -17274,10 +18406,16 @@ def update_invoice( if unitdp is not empty: query_params.append(("unitdp", unitdp)) + if allow_backorders is not empty: + query_params.append(("allowBackorders", allow_backorders)) + header_params = { "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -17323,6 +18461,7 @@ def update_invoice_attachment_by_file_name( invoice_id, file_name, body, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -17333,6 +18472,7 @@ def update_invoice_attachment_by_file_name( :param str invoice_id: Unique identifier for an Invoice (required) :param str file_name: Name of the attachment (required) :param str body: Byte array of file in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -17376,6 +18516,9 @@ def update_invoice_attachment_by_file_name( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -17423,6 +18566,7 @@ def update_item( item_id, items, unitdp=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -17433,6 +18577,7 @@ def update_item( :param str item_id: Unique identifier for an Item (required) :param Items items: (required) :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -17470,6 +18615,9 @@ def update_item( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -17514,6 +18662,7 @@ def update_linked_transaction( xero_tenant_id, linked_transaction_id, linked_transactions, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -17523,6 +18672,7 @@ def update_linked_transaction( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str linked_transaction_id: Unique identifier for a LinkedTransaction (required) :param LinkedTransactions linked_transactions: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -17559,6 +18709,9 @@ def update_linked_transaction( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -17603,6 +18756,7 @@ def update_manual_journal( xero_tenant_id, manual_journal_id, manual_journals, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -17612,6 +18766,7 @@ def update_manual_journal( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str manual_journal_id: Unique identifier for a ManualJournal (required) :param ManualJournals manual_journals: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -17648,6 +18803,9 @@ def update_manual_journal( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -17693,6 +18851,7 @@ def update_manual_journal_attachment_by_file_name( manual_journal_id, file_name, body, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -17703,6 +18862,7 @@ def update_manual_journal_attachment_by_file_name( :param str manual_journal_id: Unique identifier for a ManualJournal (required) :param str file_name: Name of the attachment (required) :param str body: Byte array of file in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -17746,6 +18906,9 @@ def update_manual_journal_attachment_by_file_name( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -17795,6 +18958,7 @@ def update_or_create_bank_transactions( bank_transactions, summarize_errors=empty, unitdp=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -17805,6 +18969,7 @@ def update_or_create_bank_transactions( :param BankTransactions bank_transactions: (required) :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -17839,6 +19004,9 @@ def update_or_create_bank_transactions( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -17885,6 +19053,7 @@ def update_or_create_contacts( xero_tenant_id, contacts, summarize_errors=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -17894,6 +19063,7 @@ def update_or_create_contacts( :param str xero_tenant_id: Xero identifier for Tenant (required) :param Contacts contacts: (required) :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -17925,6 +19095,9 @@ def update_or_create_contacts( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -17970,6 +19143,7 @@ def update_or_create_credit_notes( credit_notes, summarize_errors=empty, unitdp=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -17980,6 +19154,7 @@ def update_or_create_credit_notes( :param CreditNotes credit_notes: an array of Credit Notes with a single CreditNote object. (required) :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -18014,6 +19189,9 @@ def update_or_create_credit_notes( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -18055,96 +19233,14 @@ def update_or_create_credit_notes( error, self, "update_or_create_credit_notes" ) - def update_or_create_employees( - self, - xero_tenant_id, - employees, - summarize_errors=empty, - _return_http_data_only=True, - _preload_content=True, - _request_timeout=None, - ): - """Creates a single new employees used in Xero payrun # noqa: E501 - OAuth2 scope: accounting.settings - :param str xero_tenant_id: Xero identifier for Tenant (required) - :param Employees employees: Employees with array of Employee object in body of request (required) - :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors - :param bool _return_http_data_only: return received data only - :param bool _preload_content: load received data in models - :param bool _request_timeout: maximum wait time for response - :return: Employees - """ - - # verify the required parameter 'xero_tenant_id' is set - if xero_tenant_id is None: - raise ValueError( - "Missing the required parameter `xero_tenant_id` " - "when calling `update_or_create_employees`" - ) - # verify the required parameter 'employees' is set - if employees is None: - raise ValueError( - "Missing the required parameter `employees` " - "when calling `update_or_create_employees`" - ) - - collection_formats = {} - path_params = {} - - query_params = [] - - if summarize_errors is not empty: - query_params.append(("summarizeErrors", summarize_errors)) - - header_params = { - "xero-tenant-id": xero_tenant_id, - } - - local_var_files = {} - form_params = [] - - body_params = employees - # HTTP header `Accept` - header_params["Accept"] = self.api_client.select_header_accept( - ["application/json"] - ) - - # HTTP header `Content-Type` - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json"] - ) - - # Authentication setting - auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees") - - try: - return self.api_client.call_api( - url, - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type="Employees", - response_model_finder=self.get_model_finder(), - auth_settings=auth_settings, - _return_http_data_only=_return_http_data_only, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - collection_formats=collection_formats, - ) - except exceptions.HTTPStatusException as error: - raise translate_status_exception(error, self, "update_or_create_employees") - def update_or_create_invoices( self, xero_tenant_id, invoices, summarize_errors=empty, unitdp=empty, + idempotency_key=empty, + allow_backorders=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -18155,6 +19251,8 @@ def update_or_create_invoices( :param Invoices invoices: (required) :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + :param bool allow_backorders: Allows an invoice to be created even when one or more line items contain tracked inventory where the invoice quantity would cause the available quantity to go negative :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -18185,10 +19283,16 @@ def update_or_create_invoices( if unitdp is not empty: query_params.append(("unitdp", unitdp)) + if allow_backorders is not empty: + query_params.append(("allowBackorders", allow_backorders)) + header_params = { "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -18234,6 +19338,7 @@ def update_or_create_items( items, summarize_errors=empty, unitdp=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -18244,6 +19349,7 @@ def update_or_create_items( :param Items items: (required) :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -18278,6 +19384,9 @@ def update_or_create_items( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -18322,6 +19431,7 @@ def update_or_create_manual_journals( xero_tenant_id, manual_journals, summarize_errors=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -18331,6 +19441,7 @@ def update_or_create_manual_journals( :param str xero_tenant_id: Xero identifier for Tenant (required) :param ManualJournals manual_journals: ManualJournals array with ManualJournal object in body of request (required) :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -18362,6 +19473,9 @@ def update_or_create_manual_journals( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -18408,6 +19522,7 @@ def update_or_create_purchase_orders( xero_tenant_id, purchase_orders, summarize_errors=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -18417,6 +19532,7 @@ def update_or_create_purchase_orders( :param str xero_tenant_id: Xero identifier for Tenant (required) :param PurchaseOrders purchase_orders: (required) :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -18448,6 +19564,9 @@ def update_or_create_purchase_orders( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -18494,6 +19613,7 @@ def update_or_create_quotes( xero_tenant_id, quotes, summarize_errors=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -18503,6 +19623,7 @@ def update_or_create_quotes( :param str xero_tenant_id: Xero identifier for Tenant (required) :param Quotes quotes: (required) :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -18534,6 +19655,9 @@ def update_or_create_quotes( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -18573,11 +19697,103 @@ def update_or_create_quotes( except exceptions.HTTPStatusException as error: raise translate_status_exception(error, self, "update_or_create_quotes") + def update_or_create_repeating_invoices( + self, + xero_tenant_id, + repeating_invoices, + summarize_errors=empty, + idempotency_key=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Creates or deletes one or more repeating invoice templates # noqa: E501 + OAuth2 scope: accounting.transactions + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param RepeatingInvoices repeating_invoices: RepeatingInvoices with an array of repeating invoice objects in body of request (required) + :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: RepeatingInvoices + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `update_or_create_repeating_invoices`" + ) + # verify the required parameter 'repeating_invoices' is set + if repeating_invoices is None: + raise ValueError( + "Missing the required parameter `repeating_invoices` " + "when calling `update_or_create_repeating_invoices`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + if summarize_errors is not empty: + query_params.append(("summarizeErrors", summarize_errors)) + + header_params = { + "xero-tenant-id": xero_tenant_id, + } + + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + + local_var_files = {} + form_params = [] + + body_params = repeating_invoices + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/RepeatingInvoices") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="RepeatingInvoices", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception( + error, self, "update_or_create_repeating_invoices" + ) + def update_purchase_order( self, xero_tenant_id, purchase_order_id, purchase_orders, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -18587,6 +19803,7 @@ def update_purchase_order( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str purchase_order_id: Unique identifier for an Purchase Order (required) :param PurchaseOrders purchase_orders: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -18623,6 +19840,9 @@ def update_purchase_order( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -18668,6 +19888,7 @@ def update_purchase_order_attachment_by_file_name( purchase_order_id, file_name, body, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -18678,6 +19899,7 @@ def update_purchase_order_attachment_by_file_name( :param str purchase_order_id: Unique identifier for an Purchase Order (required) :param str file_name: Name of the attachment (required) :param str body: Byte array of file in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -18721,6 +19943,9 @@ def update_purchase_order_attachment_by_file_name( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -18769,6 +19994,7 @@ def update_quote( xero_tenant_id, quote_id, quotes, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -18778,6 +20004,7 @@ def update_quote( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str quote_id: Unique identifier for an Quote (required) :param Quotes quotes: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -18813,6 +20040,9 @@ def update_quote( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -18858,6 +20088,7 @@ def update_quote_attachment_by_file_name( quote_id, file_name, body, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -18868,6 +20099,7 @@ def update_quote_attachment_by_file_name( :param str quote_id: Unique identifier for an Quote (required) :param str file_name: Name of the attachment (required) :param str body: Byte array of file in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -18911,6 +20143,9 @@ def update_quote_attachment_by_file_name( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -18958,6 +20193,7 @@ def update_receipt( receipt_id, receipts, unitdp=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -18968,6 +20204,7 @@ def update_receipt( :param str receipt_id: Unique identifier for a Receipt (required) :param Receipts receipts: (required) :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -19007,6 +20244,9 @@ def update_receipt( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -19052,6 +20292,7 @@ def update_receipt_attachment_by_file_name( receipt_id, file_name, body, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -19062,6 +20303,7 @@ def update_receipt_attachment_by_file_name( :param str receipt_id: Unique identifier for a Receipt (required) :param str file_name: Name of the attachment (required) :param str body: Byte array of file in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -19105,6 +20347,9 @@ def update_receipt_attachment_by_file_name( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -19146,12 +20391,107 @@ def update_receipt_attachment_by_file_name( error, self, "update_receipt_attachment_by_file_name" ) + def update_repeating_invoice( + self, + xero_tenant_id, + repeating_invoice_id, + repeating_invoices, + idempotency_key=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Deletes a specific repeating invoice template # noqa: E501 + OAuth2 scope: accounting.transactions + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str repeating_invoice_id: Unique identifier for a Repeating Invoice (required) + :param RepeatingInvoices repeating_invoices: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: RepeatingInvoices + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `update_repeating_invoice`" + ) + # verify the required parameter 'repeating_invoice_id' is set + if repeating_invoice_id is None: + raise ValueError( + "Missing the required parameter `repeating_invoice_id` " + "when calling `update_repeating_invoice`" + ) + # verify the required parameter 'repeating_invoices' is set + if repeating_invoices is None: + raise ValueError( + "Missing the required parameter `repeating_invoices` " + "when calling `update_repeating_invoice`" + ) + + collection_formats = {} + path_params = { + "RepeatingInvoiceID": repeating_invoice_id, + } + + query_params = [] + + header_params = { + "xero-tenant-id": xero_tenant_id, + } + + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + + local_var_files = {} + form_params = [] + + body_params = repeating_invoices + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/RepeatingInvoices/{RepeatingInvoiceID}") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="RepeatingInvoices", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "update_repeating_invoice") + def update_repeating_invoice_attachment_by_file_name( self, xero_tenant_id, repeating_invoice_id, file_name, body, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -19162,6 +20502,7 @@ def update_repeating_invoice_attachment_by_file_name( :param str repeating_invoice_id: Unique identifier for a Repeating Invoice (required) :param str file_name: Name of the attachment (required) :param str body: Byte array of file in body of request (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -19205,6 +20546,9 @@ def update_repeating_invoice_attachment_by_file_name( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -19252,6 +20596,7 @@ def update_tax_rate( self, xero_tenant_id, tax_rates, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -19260,6 +20605,7 @@ def update_tax_rate( OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param TaxRates tax_rates: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -19288,6 +20634,9 @@ def update_tax_rate( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -19332,6 +20681,7 @@ def update_tracking_category( xero_tenant_id, tracking_category_id, tracking_category, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -19341,6 +20691,7 @@ def update_tracking_category( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str tracking_category_id: Unique identifier for a TrackingCategory (required) :param TrackingCategory tracking_category: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -19377,6 +20728,9 @@ def update_tracking_category( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -19422,6 +20776,7 @@ def update_tracking_options( tracking_category_id, tracking_option_id, tracking_option, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -19432,6 +20787,7 @@ def update_tracking_options( :param str tracking_category_id: Unique identifier for a TrackingCategory (required) :param str tracking_option_id: Unique identifier for a Tracking Option (required) :param TrackingOption tracking_option: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -19475,6 +20831,9 @@ def update_tracking_options( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] diff --git a/xero_python/accounting/docs/Account.md b/xero_python/accounting/docs/Account.md index 7e64ef88..18d4145e 100644 --- a/xero_python/accounting/docs/Account.md +++ b/xero_python/accounting/docs/Account.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **description** | **str** | Description of the Account. Valid for all types of accounts except bank accounts (max length = 4000) | [optional] **bank_account_type** | **str** | For bank accounts only. See Bank Account types | [optional] **currency_code** | [**CurrencyCode**](CurrencyCode.md) | | [optional] -**tax_type** | **str** | The tax type from TaxRates | [optional] +**tax_type** | **str** | The tax type from taxRates | [optional] **enable_payments_to_account** | **bool** | Boolean – describes whether account can have payments applied to it | [optional] **show_in_expense_claims** | **bool** | Boolean – describes whether account code is available for use with expense claims | [optional] **_class** | **str** | See Account Class Types | [optional] diff --git a/xero_python/accounting/docs/AccountingApi.md b/xero_python/accounting/docs/AccountingApi.md index 6a3d6689..60538fa0 100644 --- a/xero_python/accounting/docs/AccountingApi.md +++ b/xero_python/accounting/docs/AccountingApi.md @@ -25,7 +25,6 @@ Method | HTTP request | Description [**create_credit_note_history**](AccountingApi.md#create_credit_note_history) | **PUT** /CreditNotes/{CreditNoteID}/History | Retrieves history records of a specific credit note [**create_credit_notes**](AccountingApi.md#create_credit_notes) | **PUT** /CreditNotes | Creates a new credit note [**create_currency**](AccountingApi.md#create_currency) | **PUT** /Currencies | Create a new currency for a Xero organisation -[**create_employees**](AccountingApi.md#create_employees) | **PUT** /Employees | Creates new employees used in Xero payrun [**create_expense_claim_history**](AccountingApi.md#create_expense_claim_history) | **PUT** /ExpenseClaims/{ExpenseClaimID}/History | Creates a history record for a specific expense claim [**create_expense_claims**](AccountingApi.md#create_expense_claims) | **PUT** /ExpenseClaims | Creates expense claims [**create_invoice_attachment_by_file_name**](AccountingApi.md#create_invoice_attachment_by_file_name) | **PUT** /Invoices/{InvoiceID}/Attachments/{FileName} | Creates an attachment for a specific invoice or purchase bill by filename @@ -56,15 +55,23 @@ Method | HTTP request | Description [**create_receipt_history**](AccountingApi.md#create_receipt_history) | **PUT** /Receipts/{ReceiptID}/History | Creates a history record for a specific receipt [**create_repeating_invoice_attachment_by_file_name**](AccountingApi.md#create_repeating_invoice_attachment_by_file_name) | **PUT** /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName} | Creates an attachment from a specific repeating invoices by file name [**create_repeating_invoice_history**](AccountingApi.md#create_repeating_invoice_history) | **PUT** /RepeatingInvoices/{RepeatingInvoiceID}/History | Creates a history record for a specific repeating invoice +[**create_repeating_invoices**](AccountingApi.md#create_repeating_invoices) | **PUT** /RepeatingInvoices | Creates one or more repeating invoice templates [**create_tax_rates**](AccountingApi.md#create_tax_rates) | **PUT** /TaxRates | Creates one or more tax rates [**create_tracking_category**](AccountingApi.md#create_tracking_category) | **PUT** /TrackingCategories | Create tracking categories [**create_tracking_options**](AccountingApi.md#create_tracking_options) | **PUT** /TrackingCategories/{TrackingCategoryID}/Options | Creates options for a specific tracking category [**delete_account**](AccountingApi.md#delete_account) | **DELETE** /Accounts/{AccountID} | Deletes a chart of accounts +[**delete_bank_transfer**](AccountingApi.md#delete_bank_transfer) | **POST** /BankTransfers/{BankTransferID} | Deletes a specific bank transfer +[**delete_bank_transfers**](AccountingApi.md#delete_bank_transfers) | **POST** /BankTransfers | Deletes one or more bank transfers +[**delete_batch_payment**](AccountingApi.md#delete_batch_payment) | **POST** /BatchPayments | Updates a specific batch payment for invoices and credit notes +[**delete_batch_payment_by_url_param**](AccountingApi.md#delete_batch_payment_by_url_param) | **POST** /BatchPayments/{BatchPaymentID} | Updates a specific batch payment for invoices and credit notes [**delete_contact_group_contact**](AccountingApi.md#delete_contact_group_contact) | **DELETE** /ContactGroups/{ContactGroupID}/Contacts/{ContactID} | Deletes a specific contact from a contact group using a unique contact Id [**delete_contact_group_contacts**](AccountingApi.md#delete_contact_group_contacts) | **DELETE** /ContactGroups/{ContactGroupID}/Contacts | Deletes all contacts from a specific contact group +[**delete_credit_note_allocations**](AccountingApi.md#delete_credit_note_allocations) | **DELETE** /CreditNotes/{CreditNoteID}/Allocations/{AllocationID} | Deletes an Allocation from a Credit Note [**delete_item**](AccountingApi.md#delete_item) | **DELETE** /Items/{ItemID} | Deletes a specific item [**delete_linked_transaction**](AccountingApi.md#delete_linked_transaction) | **DELETE** /LinkedTransactions/{LinkedTransactionID} | Deletes a specific linked transactions (billable expenses) +[**delete_overpayment_allocations**](AccountingApi.md#delete_overpayment_allocations) | **DELETE** /Overpayments/{OverpaymentID}/Allocations/{AllocationID} | Deletes an Allocation from an overpayment [**delete_payment**](AccountingApi.md#delete_payment) | **POST** /Payments/{PaymentID} | Updates a specific payment for invoices and credit notes +[**delete_prepayment_allocations**](AccountingApi.md#delete_prepayment_allocations) | **DELETE** /Prepayments/{PrepaymentID}/Allocations/{AllocationID} | Deletes an Allocation from a Prepayment [**delete_tracking_category**](AccountingApi.md#delete_tracking_category) | **DELETE** /TrackingCategories/{TrackingCategoryID} | Deletes a specific tracking category [**delete_tracking_options**](AccountingApi.md#delete_tracking_options) | **DELETE** /TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID} | Deletes a specific option for a specific tracking category [**email_invoice**](AccountingApi.md#email_invoice) | **POST** /Invoices/{InvoiceID}/Email | Sends a copy of a specific invoice to related contact via email @@ -85,6 +92,7 @@ Method | HTTP request | Description [**get_bank_transfer_attachments**](AccountingApi.md#get_bank_transfer_attachments) | **GET** /BankTransfers/{BankTransferID}/Attachments | Retrieves attachments from a specific bank transfer [**get_bank_transfer_history**](AccountingApi.md#get_bank_transfer_history) | **GET** /BankTransfers/{BankTransferID}/History | Retrieves history from a specific bank transfer using a unique bank transfer Id [**get_bank_transfers**](AccountingApi.md#get_bank_transfers) | **GET** /BankTransfers | Retrieves all bank transfers +[**get_batch_payment**](AccountingApi.md#get_batch_payment) | **GET** /BatchPayments/{BatchPaymentID} | Retrieves a specific batch payment using a unique batch payment Id [**get_batch_payment_history**](AccountingApi.md#get_batch_payment_history) | **GET** /BatchPayments/{BatchPaymentID}/History | Retrieves history from a specific batch payment [**get_batch_payments**](AccountingApi.md#get_batch_payments) | **GET** /BatchPayments | Retrieves either one or many batch payments for invoices [**get_branding_theme**](AccountingApi.md#get_branding_theme) | **GET** /BrandingThemes/{BrandingThemeID} | Retrieves a specific branding theme using a unique branding theme Id @@ -110,8 +118,6 @@ Method | HTTP request | Description [**get_credit_note_history**](AccountingApi.md#get_credit_note_history) | **GET** /CreditNotes/{CreditNoteID}/History | Retrieves history records of a specific credit note [**get_credit_notes**](AccountingApi.md#get_credit_notes) | **GET** /CreditNotes | Retrieves any credit notes [**get_currencies**](AccountingApi.md#get_currencies) | **GET** /Currencies | Retrieves currencies for your Xero organisation -[**get_employee**](AccountingApi.md#get_employee) | **GET** /Employees/{EmployeeID} | Retrieves a specific employee used in Xero payrun using a unique employee Id -[**get_employees**](AccountingApi.md#get_employees) | **GET** /Employees | Retrieves employees used in Xero payrun [**get_expense_claim**](AccountingApi.md#get_expense_claim) | **GET** /ExpenseClaims/{ExpenseClaimID} | Retrieves a specific expense claim using a unique expense claim Id [**get_expense_claim_history**](AccountingApi.md#get_expense_claim_history) | **GET** /ExpenseClaims/{ExpenseClaimID}/History | Retrieves history records of a specific expense claim [**get_expense_claims**](AccountingApi.md#get_expense_claims) | **GET** /ExpenseClaims | Retrieves expense claims @@ -127,6 +133,7 @@ Method | HTTP request | Description [**get_item_history**](AccountingApi.md#get_item_history) | **GET** /Items/{ItemID}/History | Retrieves history for a specific item [**get_items**](AccountingApi.md#get_items) | **GET** /Items | Retrieves items [**get_journal**](AccountingApi.md#get_journal) | **GET** /Journals/{JournalID} | Retrieves a specific journal using a unique journal Id. +[**get_journal_by_number**](AccountingApi.md#get_journal_by_number) | **GET** /Journals/{JournalNumber} | Retrieves a specific journal using a unique journal number. [**get_journals**](AccountingApi.md#get_journals) | **GET** /Journals | Retrieves journals [**get_linked_transaction**](AccountingApi.md#get_linked_transaction) | **GET** /LinkedTransactions/{LinkedTransactionID} | Retrieves a specific linked transaction (billable expenses) using a unique linked transaction Id [**get_linked_transactions**](AccountingApi.md#get_linked_transactions) | **GET** /LinkedTransactions | Retrieves linked transactions (billable expenses) @@ -188,6 +195,7 @@ Method | HTTP request | Description [**get_report_ten_ninety_nine**](AccountingApi.md#get_report_ten_ninety_nine) | **GET** /Reports/TenNinetyNine | Retrieve reports for 1099 [**get_report_trial_balance**](AccountingApi.md#get_report_trial_balance) | **GET** /Reports/TrialBalance | Retrieves report for trial balance [**get_reports_list**](AccountingApi.md#get_reports_list) | **GET** /Reports | Retrieves a list of the organistaions unique reports that require a uuid to fetch +[**get_tax_rate_by_tax_type**](AccountingApi.md#get_tax_rate_by_tax_type) | **GET** /TaxRates/{TaxType} | Retrieves a specific tax rate according to given TaxType code [**get_tax_rates**](AccountingApi.md#get_tax_rates) | **GET** /TaxRates | Retrieves tax rates [**get_tracking_categories**](AccountingApi.md#get_tracking_categories) | **GET** /TrackingCategories | Retrieves tracking categories and options [**get_tracking_category**](AccountingApi.md#get_tracking_category) | **GET** /TrackingCategories/{TrackingCategoryID} | Retrieves specific tracking categories and options using a unique tracking category Id @@ -214,18 +222,19 @@ Method | HTTP request | Description [**update_or_create_bank_transactions**](AccountingApi.md#update_or_create_bank_transactions) | **POST** /BankTransactions | Updates or creates one or more spent or received money transaction [**update_or_create_contacts**](AccountingApi.md#update_or_create_contacts) | **POST** /Contacts | Updates or creates one or more contacts in a Xero organisation [**update_or_create_credit_notes**](AccountingApi.md#update_or_create_credit_notes) | **POST** /CreditNotes | Updates or creates one or more credit notes -[**update_or_create_employees**](AccountingApi.md#update_or_create_employees) | **POST** /Employees | Creates a single new employees used in Xero payrun [**update_or_create_invoices**](AccountingApi.md#update_or_create_invoices) | **POST** /Invoices | Updates or creates one or more sales invoices or purchase bills [**update_or_create_items**](AccountingApi.md#update_or_create_items) | **POST** /Items | Updates or creates one or more items [**update_or_create_manual_journals**](AccountingApi.md#update_or_create_manual_journals) | **POST** /ManualJournals | Updates or creates a single manual journal [**update_or_create_purchase_orders**](AccountingApi.md#update_or_create_purchase_orders) | **POST** /PurchaseOrders | Updates or creates one or more purchase orders [**update_or_create_quotes**](AccountingApi.md#update_or_create_quotes) | **POST** /Quotes | Updates or creates one or more quotes +[**update_or_create_repeating_invoices**](AccountingApi.md#update_or_create_repeating_invoices) | **POST** /RepeatingInvoices | Creates or deletes one or more repeating invoice templates [**update_purchase_order**](AccountingApi.md#update_purchase_order) | **POST** /PurchaseOrders/{PurchaseOrderID} | Updates a specific purchase order [**update_purchase_order_attachment_by_file_name**](AccountingApi.md#update_purchase_order_attachment_by_file_name) | **POST** /PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName} | Updates a specific attachment for a specific purchase order by filename [**update_quote**](AccountingApi.md#update_quote) | **POST** /Quotes/{QuoteID} | Updates a specific quote [**update_quote_attachment_by_file_name**](AccountingApi.md#update_quote_attachment_by_file_name) | **POST** /Quotes/{QuoteID}/Attachments/{FileName} | Updates a specific attachment from a specific quote by filename [**update_receipt**](AccountingApi.md#update_receipt) | **POST** /Receipts/{ReceiptID} | Updates a specific draft expense claim receipts [**update_receipt_attachment_by_file_name**](AccountingApi.md#update_receipt_attachment_by_file_name) | **POST** /Receipts/{ReceiptID}/Attachments/{FileName} | Updates a specific attachment on a specific expense claim receipts by file name +[**update_repeating_invoice**](AccountingApi.md#update_repeating_invoice) | **POST** /RepeatingInvoices/{RepeatingInvoiceID} | Deletes a specific repeating invoice template [**update_repeating_invoice_attachment_by_file_name**](AccountingApi.md#update_repeating_invoice_attachment_by_file_name) | **POST** /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName} | Updates a specific attachment from a specific repeating invoices by file name [**update_tax_rate**](AccountingApi.md#update_tax_rate) | **POST** /TaxRates | Updates tax rates [**update_tracking_category**](AccountingApi.md#update_tracking_category) | **POST** /TrackingCategories/{TrackingCategoryID} | Updates a specific tracking category @@ -233,7 +242,7 @@ Method | HTTP request | Description # **create_account** -> Accounts create_account(xero_tenant_id, account) +> Accounts create_account(xero_tenant_id, account, idempotency_key=idempotency_key) Creates a new chart of accounts @@ -264,10 +273,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -account = { "Code":"123456", "Name":"Foobar", "Type":"EXPENSE", "Description":"Hello World" } # Account | Account object in body of request +account = {"Code":"123456","Name":"Foobar","Type":"EXPENSE","Description":"Hello World"} # Account | Account object in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a new chart of accounts - api_response = api_instance.create_account(xero_tenant_id, account) + api_response = api_instance.create_account(xero_tenant_id, account, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_account: %s\n" % e) @@ -279,6 +289,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **account** | [**Account**](Account.md)| Account object in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -296,7 +307,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_account_attachment_by_file_name** -> Attachments create_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body) +> Attachments create_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body, idempotency_key=idempotency_key) Creates an attachment on a specific account @@ -330,9 +341,10 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant account_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for Account object file_name = 'xero-dev.jpg' # str | Name of the attachment body = 'body_example' # str | Byte array of file in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates an attachment on a specific account - api_response = api_instance.create_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body) + api_response = api_instance.create_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_account_attachment_by_file_name: %s\n" % e) @@ -346,6 +358,7 @@ Name | Type | Description | Notes **account_id** | [**str**](.md)| Unique identifier for Account object | **file_name** | **str**| Name of the attachment | **body** | **str**| Byte array of file in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -363,7 +376,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_bank_transaction_attachment_by_file_name** -> Attachments create_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body) +> Attachments create_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body, idempotency_key=idempotency_key) Creates an attachment for a specific bank transaction by filename @@ -397,9 +410,10 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant bank_transaction_id = '00000000-0000-0000-0000-000000000000' # str | Xero generated unique identifier for a bank transaction file_name = 'xero-dev.jpg' # str | Name of the attachment body = 'body_example' # str | Byte array of file in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates an attachment for a specific bank transaction by filename - api_response = api_instance.create_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body) + api_response = api_instance.create_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_bank_transaction_attachment_by_file_name: %s\n" % e) @@ -413,6 +427,7 @@ Name | Type | Description | Notes **bank_transaction_id** | [**str**](.md)| Xero generated unique identifier for a bank transaction | **file_name** | **str**| Name of the attachment | **body** | **str**| Byte array of file in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -430,7 +445,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_bank_transaction_history_record** -> HistoryRecords create_bank_transaction_history_record(xero_tenant_id, bank_transaction_id, history_records) +> HistoryRecords create_bank_transaction_history_record(xero_tenant_id, bank_transaction_id, history_records, idempotency_key=idempotency_key) Creates a history record for a specific bank transactions @@ -462,10 +477,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant bank_transaction_id = '00000000-0000-0000-0000-000000000000' # str | Xero generated unique identifier for a bank transaction -history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +history_records = {"HistoryRecords":[{"Details":"Hello World"}]} # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a history record for a specific bank transactions - api_response = api_instance.create_bank_transaction_history_record(xero_tenant_id, bank_transaction_id, history_records) + api_response = api_instance.create_bank_transaction_history_record(xero_tenant_id, bank_transaction_id, history_records, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_bank_transaction_history_record: %s\n" % e) @@ -478,6 +494,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **bank_transaction_id** | [**str**](.md)| Xero generated unique identifier for a bank transaction | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -495,7 +512,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_bank_transactions** -> BankTransactions create_bank_transactions(xero_tenant_id, bank_transactions, summarize_errors=summarize_errors, unitdp=unitdp) +> BankTransactions create_bank_transactions(xero_tenant_id, bank_transactions, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key) Creates one or more spent or received money transaction @@ -526,12 +543,13 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -bank_transactions = { bankTransactions: [{ type: BankTransaction.TypeEnum.SPEND, contact: { contactID: "00000000-0000-0000-0000-000000000000" }, lineItems: [{ description: "Foobar", quantity: 1.0, unitAmount: 20.0, accountCode: "000" } ], bankAccount: { code: "000" }}]} # BankTransactions | BankTransactions with an array of BankTransaction objects in body of request +bank_transactions = {"bankTransactions":[{"type":"BankTransaction.TypeEnum.SPEND","contact":{"contactID":"00000000-0000-0000-0000-000000000000"},"lineItems":[{"description":"Foobar","quantity":1.0,"unitAmount":20.0,"accountCode":"000"}],"bankAccount":{"code":"000"}}]} # BankTransactions | BankTransactions with an array of BankTransaction objects in body of request summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates one or more spent or received money transaction - api_response = api_instance.create_bank_transactions(xero_tenant_id, bank_transactions, summarize_errors=summarize_errors, unitdp=unitdp) + api_response = api_instance.create_bank_transactions(xero_tenant_id, bank_transactions, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_bank_transactions: %s\n" % e) @@ -545,6 +563,7 @@ Name | Type | Description | Notes **bank_transactions** | [**BankTransactions**](BankTransactions.md)| BankTransactions with an array of BankTransaction objects in body of request | **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -562,7 +581,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_bank_transfer** -> BankTransfers create_bank_transfer(xero_tenant_id, bank_transfers) +> BankTransfers create_bank_transfer(xero_tenant_id, bank_transfers, idempotency_key=idempotency_key) Creates a bank transfer @@ -593,10 +612,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -bank_transfers = { "BankTransfers": [ { "FromBankAccount": { "Code": "090", "Name": "My Savings", "AccountID": "00000000-0000-0000-0000-000000000000", "Type": "BANK", "BankAccountNumber": "123455", "Status": "ACTIVE", "BankAccountType": "BANK", "CurrencyCode": "USD", "TaxType": "NONE", "EnablePaymentsToAccount": false, "ShowInExpenseClaims": false, "Class": "ASSET", "ReportingCode": "ASS", "ReportingCodeName": "Assets", "HasAttachments": false, "UpdatedDateUTC": "2016-10-17T13:45:33.993-07:00" }, "ToBankAccount": { "Code": "088", "Name": "Business Wells Fargo", "AccountID": "00000000-0000-0000-0000-000000000000", "Type": "BANK", "BankAccountNumber": "123455", "Status": "ACTIVE", "BankAccountType": "BANK", "CurrencyCode": "USD", "TaxType": "NONE", "EnablePaymentsToAccount": false, "ShowInExpenseClaims": false, "Class": "ASSET", "ReportingCode": "ASS", "ReportingCodeName": "Assets", "HasAttachments": false, "UpdatedDateUTC": "2016-06-03T08:31:14.517-07:00" }, "Amount": "50.00", "FromIsReconciled": true, "ToIsReconciled": true, "Reference": "Sub 098801" } ] } # BankTransfers | BankTransfers with array of BankTransfer objects in request body +bank_transfers = {"BankTransfers":[{"FromBankAccount":{"Code":"090","Name":"My Savings","AccountID":"00000000-0000-0000-0000-000000000000","Type":"BANK","BankAccountNumber":"123455","Status":"ACTIVE","BankAccountType":"BANK","CurrencyCode":"USD","TaxType":"NONE","EnablePaymentsToAccount":false,"ShowInExpenseClaims":false,"Class":"ASSET","ReportingCode":"ASS","ReportingCodeName":"Assets","HasAttachments":false,"UpdatedDateUTC":"2016-10-17T13:45:33.993-07:00"},"ToBankAccount":{"Code":"088","Name":"Business Wells Fargo","AccountID":"00000000-0000-0000-0000-000000000000","Type":"BANK","BankAccountNumber":"123455","Status":"ACTIVE","BankAccountType":"BANK","CurrencyCode":"USD","TaxType":"NONE","EnablePaymentsToAccount":false,"ShowInExpenseClaims":false,"Class":"ASSET","ReportingCode":"ASS","ReportingCodeName":"Assets","HasAttachments":false,"UpdatedDateUTC":"2016-06-03T08:31:14.517-07:00"},"Amount":"50.00","FromIsReconciled":true,"ToIsReconciled":true,"Reference":"Sub 098801","FromTracking":[{"TrackingCategoryID":"e2f2f732-e92a-4f3a-9c4d-ee4da0182a13","TrackingOptionID":"cd0a4b7e-3c6b-4b3c-8e2a-1f2d3c4b5a69"}],"ToTracking":[{"TrackingCategoryID":"e2f2f732-e92a-4f3a-9c4d-ee4da0182a13","TrackingOptionID":"9f8e7d6c-5b4a-3c2d-1e0f-a9b8c7d6e5f4"}]}]} # BankTransfers | BankTransfers with array of BankTransfer objects in request body +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a bank transfer - api_response = api_instance.create_bank_transfer(xero_tenant_id, bank_transfers) + api_response = api_instance.create_bank_transfer(xero_tenant_id, bank_transfers, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_bank_transfer: %s\n" % e) @@ -608,6 +628,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **bank_transfers** | [**BankTransfers**](BankTransfers.md)| BankTransfers with array of BankTransfer objects in request body | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -625,7 +646,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_bank_transfer_attachment_by_file_name** -> Attachments create_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body) +> Attachments create_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body, idempotency_key=idempotency_key) @@ -659,8 +680,9 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant bank_transfer_id = '00000000-0000-0000-0000-000000000000' # str | Xero generated unique identifier for a bank transfer file_name = 'xero-dev.jpg' # str | Name of the attachment body = 'body_example' # str | Byte array of file in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: - api_response = api_instance.create_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body) + api_response = api_instance.create_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_bank_transfer_attachment_by_file_name: %s\n" % e) @@ -674,6 +696,7 @@ Name | Type | Description | Notes **bank_transfer_id** | [**str**](.md)| Xero generated unique identifier for a bank transfer | **file_name** | **str**| Name of the attachment | **body** | **str**| Byte array of file in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -691,7 +714,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_bank_transfer_history_record** -> HistoryRecords create_bank_transfer_history_record(xero_tenant_id, bank_transfer_id, history_records) +> HistoryRecords create_bank_transfer_history_record(xero_tenant_id, bank_transfer_id, history_records, idempotency_key=idempotency_key) Creates a history record for a specific bank transfer @@ -723,10 +746,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant bank_transfer_id = '00000000-0000-0000-0000-000000000000' # str | Xero generated unique identifier for a bank transfer -history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +history_records = {"HistoryRecords":[{"Details":"Hello World"}]} # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a history record for a specific bank transfer - api_response = api_instance.create_bank_transfer_history_record(xero_tenant_id, bank_transfer_id, history_records) + api_response = api_instance.create_bank_transfer_history_record(xero_tenant_id, bank_transfer_id, history_records, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_bank_transfer_history_record: %s\n" % e) @@ -739,6 +763,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **bank_transfer_id** | [**str**](.md)| Xero generated unique identifier for a bank transfer | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -756,7 +781,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_batch_payment** -> BatchPayments create_batch_payment(xero_tenant_id, batch_payments, summarize_errors=summarize_errors) +> BatchPayments create_batch_payment(xero_tenant_id, batch_payments, summarize_errors=summarize_errors, idempotency_key=idempotency_key) Creates one or many batch payments for invoices @@ -787,11 +812,12 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -batch_payments = { "BatchPayments": [ { "Account": { "AccountID": "00000000-0000-0000-0000-000000000000" }, "Reference": "ref", "Date": "2018-08-01", "Payments": [ { "Account": { "Code": "001" }, "Date": "2019-12-31", "Amount": 500, "Invoice": { "InvoiceID": "00000000-0000-0000-0000-000000000000", "LineItems": [], "Contact": {}, "Type": "ACCPAY" } } ] } ] } # BatchPayments | BatchPayments with an array of Payments in body of request +batch_payments = {"BatchPayments":[{"Account":{"AccountID":"00000000-0000-0000-0000-000000000000"},"Reference":"ref","Date":"2018-08-01","Payments":[{"Account":{"Code":"001"},"Date":"2019-12-31","Amount":500,"Invoice":{"InvoiceID":"00000000-0000-0000-0000-000000000000","LineItems":[],"Contact":{},"Type":"ACCPAY"}}]}]} # BatchPayments | BatchPayments with an array of Payments in body of request summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates one or many batch payments for invoices - api_response = api_instance.create_batch_payment(xero_tenant_id, batch_payments, summarize_errors=summarize_errors) + api_response = api_instance.create_batch_payment(xero_tenant_id, batch_payments, summarize_errors=summarize_errors, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_batch_payment: %s\n" % e) @@ -804,6 +830,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **batch_payments** | [**BatchPayments**](BatchPayments.md)| BatchPayments with an array of Payments in body of request | **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -821,7 +848,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_batch_payment_history_record** -> HistoryRecords create_batch_payment_history_record(xero_tenant_id, batch_payment_id, history_records) +> HistoryRecords create_batch_payment_history_record(xero_tenant_id, batch_payment_id, history_records, idempotency_key=idempotency_key) Creates a history record for a specific batch payment @@ -853,10 +880,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant batch_payment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for BatchPayment -history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +history_records = {"HistoryRecords":[{"Details":"Hello World"}]} # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a history record for a specific batch payment - api_response = api_instance.create_batch_payment_history_record(xero_tenant_id, batch_payment_id, history_records) + api_response = api_instance.create_batch_payment_history_record(xero_tenant_id, batch_payment_id, history_records, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_batch_payment_history_record: %s\n" % e) @@ -869,6 +897,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **batch_payment_id** | [**str**](.md)| Unique identifier for BatchPayment | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -886,7 +915,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_branding_theme_payment_services** -> PaymentServices create_branding_theme_payment_services(xero_tenant_id, branding_theme_id, payment_service) +> PaymentServices create_branding_theme_payment_services(xero_tenant_id, branding_theme_id, payment_services, idempotency_key=idempotency_key) Creates a new custom payment service for a specific branding theme @@ -918,10 +947,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant branding_theme_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Branding Theme -payment_service = { "PaymentServiceID": "00000000-0000-0000-0000-000000000000", "PaymentServiceName": "Payments Service", "PaymentServiceUrl": "https://www.paymentservice.com/", "PayNowText": "Pay Now" } # PaymentService | PaymentService object in body of request +payment_services = {"PaymentServices":[{"PaymentServiceID":"54b3b4f6-0443-4fba-bcd1-61ec0c35ca55","PaymentServiceName":"PayUpNow","PaymentServiceUrl":"https://www.payupnow.com/","PaymentServiceType":"Custom","PayNowText":"Time To Pay"}]} # PaymentServices | PaymentServices array with PaymentService object in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a new custom payment service for a specific branding theme - api_response = api_instance.create_branding_theme_payment_services(xero_tenant_id, branding_theme_id, payment_service) + api_response = api_instance.create_branding_theme_payment_services(xero_tenant_id, branding_theme_id, payment_services, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_branding_theme_payment_services: %s\n" % e) @@ -933,7 +963,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **branding_theme_id** | [**str**](.md)| Unique identifier for a Branding Theme | - **payment_service** | [**PaymentService**](PaymentService.md)| PaymentService object in body of request | + **payment_services** | [**PaymentServices**](PaymentServices.md)| PaymentServices array with PaymentService object in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -951,7 +982,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_contact_attachment_by_file_name** -> Attachments create_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body) +> Attachments create_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body, idempotency_key=idempotency_key) @@ -985,8 +1016,9 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant contact_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Contact file_name = 'xero-dev.jpg' # str | Name of the attachment body = 'body_example' # str | Byte array of file in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: - api_response = api_instance.create_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body) + api_response = api_instance.create_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_contact_attachment_by_file_name: %s\n" % e) @@ -1000,6 +1032,7 @@ Name | Type | Description | Notes **contact_id** | [**str**](.md)| Unique identifier for a Contact | **file_name** | **str**| Name of the attachment | **body** | **str**| Byte array of file in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1017,7 +1050,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_contact_group** -> ContactGroups create_contact_group(xero_tenant_id, contact_groups) +> ContactGroups create_contact_group(xero_tenant_id, contact_groups, idempotency_key=idempotency_key) Creates a contact group @@ -1048,10 +1081,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -contact_groups = { "ContactGroups": [{ "Name": "VIPs" }]} # ContactGroups | ContactGroups with an array of names in request body +contact_groups = {"ContactGroups":[{"Name":"VIPs"}]} # ContactGroups | ContactGroups with an array of names in request body +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a contact group - api_response = api_instance.create_contact_group(xero_tenant_id, contact_groups) + api_response = api_instance.create_contact_group(xero_tenant_id, contact_groups, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_contact_group: %s\n" % e) @@ -1063,6 +1097,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **contact_groups** | [**ContactGroups**](ContactGroups.md)| ContactGroups with an array of names in request body | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1080,7 +1115,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_contact_group_contacts** -> Contacts create_contact_group_contacts(xero_tenant_id, contact_group_id, contacts) +> Contacts create_contact_group_contacts(xero_tenant_id, contact_group_id, contacts, idempotency_key=idempotency_key) Creates contacts to a specific contact group @@ -1112,10 +1147,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant contact_group_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Contact Group -contacts = { "Contacts": [ { "ContactID": "a3675fc4-f8dd-4f03-ba5b-f1870566bcd7" }, { "ContactID": "4e1753b9-018a-4775-b6aa-1bc7871cfee3" } ] } # Contacts | Contacts with array of contacts specifying the ContactID to be added to ContactGroup in body of request +contacts = {"Contacts":[{"ContactID":"a3675fc4-f8dd-4f03-ba5b-f1870566bcd7"},{"ContactID":"4e1753b9-018a-4775-b6aa-1bc7871cfee3"}]} # Contacts | Contacts with array of contacts specifying the ContactID to be added to ContactGroup in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates contacts to a specific contact group - api_response = api_instance.create_contact_group_contacts(xero_tenant_id, contact_group_id, contacts) + api_response = api_instance.create_contact_group_contacts(xero_tenant_id, contact_group_id, contacts, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_contact_group_contacts: %s\n" % e) @@ -1128,6 +1164,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **contact_group_id** | [**str**](.md)| Unique identifier for a Contact Group | **contacts** | [**Contacts**](Contacts.md)| Contacts with array of contacts specifying the ContactID to be added to ContactGroup in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1145,7 +1182,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_contact_history** -> HistoryRecords create_contact_history(xero_tenant_id, contact_id, history_records) +> HistoryRecords create_contact_history(xero_tenant_id, contact_id, history_records, idempotency_key=idempotency_key) Creates a new history record for a specific contact @@ -1177,10 +1214,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant contact_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Contact -history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +history_records = {"HistoryRecords":[{"Details":"Hello World"}]} # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a new history record for a specific contact - api_response = api_instance.create_contact_history(xero_tenant_id, contact_id, history_records) + api_response = api_instance.create_contact_history(xero_tenant_id, contact_id, history_records, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_contact_history: %s\n" % e) @@ -1193,6 +1231,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **contact_id** | [**str**](.md)| Unique identifier for a Contact | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1210,7 +1249,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_contacts** -> Contacts create_contacts(xero_tenant_id, contacts, summarize_errors=summarize_errors) +> Contacts create_contacts(xero_tenant_id, contacts, summarize_errors=summarize_errors, idempotency_key=idempotency_key) Creates multiple contacts (bulk) in a Xero organisation @@ -1241,11 +1280,12 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -contacts = { "Id": "e997d6d7-6dad-4458-beb8-d9c1bf7f2edf", "Status": "OK", "ProviderName": "Xero API Partner", "DateTimeUTC": "/Date(1551399321121)/", "Contacts": [ { "ContactID": "3ff6d40c-af9a-40a3-89ce-3c1556a25591", "ContactStatus": "ACTIVE", "Name": "Foo9987", "EmailAddress": "sid32476@blah.com", "BankAccountDetails": "", "Addresses": [ { "AddressType": "STREET", "City": "", "Region": "", "PostalCode": "", "Country": "" }, { "AddressType": "POBOX", "City": "", "Region": "", "PostalCode": "", "Country": "" } ], "Phones": [ { "PhoneType": "DEFAULT", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "DDI", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "FAX", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "MOBILE", "PhoneNumber": "555-1212", "PhoneAreaCode": "415", "PhoneCountryCode": "" } ], "UpdatedDateUTC": "/Date(1551399321043+0000)/", "ContactGroups": [], "IsSupplier": false, "IsCustomer": false, "SalesTrackingCategories": [], "PurchasesTrackingCategories": [], "PaymentTerms": { "Bills": { "Day": 15, "Type": "OFCURRENTMONTH" }, "Sales": { "Day": 10, "Type": "DAYSAFTERBILLMONTH" } }, "ContactPersons": [], "HasValidationErrors": false } ] } # Contacts | Contacts with an array of Contact objects to create in body of request +contacts = {"Contacts":[{"ContactID":"3ff6d40c-af9a-40a3-89ce-3c1556a25591","ContactStatus":"ACTIVE","Name":"Foo9987","EmailAddress":"sid32476@blah.com","BankAccountDetails":"","Addresses":[{"AddressType":"STREET","City":"","Region":"","PostalCode":"","Country":""},{"AddressType":"POBOX","City":"","Region":"","PostalCode":"","Country":""}],"Phones":[{"PhoneType":"DEFAULT","PhoneNumber":"","PhoneAreaCode":"","PhoneCountryCode":""},{"PhoneType":"DDI","PhoneNumber":"","PhoneAreaCode":"","PhoneCountryCode":""},{"PhoneType":"FAX","PhoneNumber":"","PhoneAreaCode":"","PhoneCountryCode":""},{"PhoneType":"MOBILE","PhoneNumber":"555-1212","PhoneAreaCode":"415","PhoneCountryCode":""}],"UpdatedDateUTC":"/Date(1551399321043+0000)/","ContactGroups":[],"IsSupplier":false,"IsCustomer":false,"SalesTrackingCategories":[],"PurchasesTrackingCategories":[],"PaymentTerms":{"Bills":{"Day":15,"Type":"OFCURRENTMONTH"},"Sales":{"Day":10,"Type":"DAYSAFTERBILLMONTH"}},"ContactPersons":[]}]} # Contacts | Contacts with an array of Contact objects to create in body of request summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates multiple contacts (bulk) in a Xero organisation - api_response = api_instance.create_contacts(xero_tenant_id, contacts, summarize_errors=summarize_errors) + api_response = api_instance.create_contacts(xero_tenant_id, contacts, summarize_errors=summarize_errors, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_contacts: %s\n" % e) @@ -1258,6 +1298,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **contacts** | [**Contacts**](Contacts.md)| Contacts with an array of Contact objects to create in body of request | **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1275,7 +1316,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_credit_note_allocation** -> Allocations create_credit_note_allocation(xero_tenant_id, credit_note_id, allocations, summarize_errors=summarize_errors) +> Allocations create_credit_note_allocation(xero_tenant_id, credit_note_id, allocations, summarize_errors=summarize_errors, idempotency_key=idempotency_key) Creates allocation for a specific credit note @@ -1307,11 +1348,12 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant credit_note_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Credit Note -allocations = { "Allocations": [ { "Invoice": { "LineItems": [], "InvoiceID": "c45720a1-ade3-4a38-a064-d15489be6841" }, "Amount": 1, "Date": "2019-03-05" } ] } # Allocations | Allocations with array of Allocation object in body of request. +allocations = {"Allocations":[{"Invoice":{"LineItems":[],"InvoiceID":"c45720a1-ade3-4a38-a064-d15489be6841"},"Amount":1,"Date":"2019-03-05"}]} # Allocations | Allocations with array of Allocation object in body of request. summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates allocation for a specific credit note - api_response = api_instance.create_credit_note_allocation(xero_tenant_id, credit_note_id, allocations, summarize_errors=summarize_errors) + api_response = api_instance.create_credit_note_allocation(xero_tenant_id, credit_note_id, allocations, summarize_errors=summarize_errors, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_credit_note_allocation: %s\n" % e) @@ -1325,6 +1367,7 @@ Name | Type | Description | Notes **credit_note_id** | [**str**](.md)| Unique identifier for a Credit Note | **allocations** | [**Allocations**](Allocations.md)| Allocations with array of Allocation object in body of request. | **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1342,7 +1385,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_credit_note_attachment_by_file_name** -> Attachments create_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body, include_online=include_online) +> Attachments create_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body, include_online=include_online, idempotency_key=idempotency_key) Creates an attachment for a specific credit note @@ -1377,9 +1420,10 @@ credit_note_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifie file_name = 'xero-dev.jpg' # str | Name of the attachment body = 'body_example' # str | Byte array of file in body of request include_online = False # bool | Allows an attachment to be seen by the end customer within their online invoice (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates an attachment for a specific credit note - api_response = api_instance.create_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body, include_online=include_online) + api_response = api_instance.create_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body, include_online=include_online, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_credit_note_attachment_by_file_name: %s\n" % e) @@ -1394,6 +1438,7 @@ Name | Type | Description | Notes **file_name** | **str**| Name of the attachment | **body** | **str**| Byte array of file in body of request | **include_online** | **bool**| Allows an attachment to be seen by the end customer within their online invoice | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1411,7 +1456,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_credit_note_history** -> HistoryRecords create_credit_note_history(xero_tenant_id, credit_note_id, history_records) +> HistoryRecords create_credit_note_history(xero_tenant_id, credit_note_id, history_records, idempotency_key=idempotency_key) Retrieves history records of a specific credit note @@ -1443,10 +1488,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant credit_note_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Credit Note -history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +history_records = {"HistoryRecords":[{"Details":"Hello World"}]} # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Retrieves history records of a specific credit note - api_response = api_instance.create_credit_note_history(xero_tenant_id, credit_note_id, history_records) + api_response = api_instance.create_credit_note_history(xero_tenant_id, credit_note_id, history_records, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_credit_note_history: %s\n" % e) @@ -1459,6 +1505,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **credit_note_id** | [**str**](.md)| Unique identifier for a Credit Note | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1476,7 +1523,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_credit_notes** -> CreditNotes create_credit_notes(xero_tenant_id, credit_notes, summarize_errors=summarize_errors, unitdp=unitdp) +> CreditNotes create_credit_notes(xero_tenant_id, credit_notes, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key) Creates a new credit note @@ -1507,12 +1554,13 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -credit_notes = { "CreditNotes":[ { "Type":"ACCPAYCREDIT", "Contact":{ "ContactID":"430fa14a-f945-44d3-9f97-5df5e28441b8" }, "Date":"2019-01-05", "LineItems":[ { "Description":"Foobar", "Quantity":2.0, "UnitAmount":20.0, "AccountCode":"400" } ] } ] } # CreditNotes | Credit Notes with array of CreditNote object in body of request +credit_notes = {"CreditNotes":[{"Type":"ACCPAYCREDIT","Contact":{"ContactID":"430fa14a-f945-44d3-9f97-5df5e28441b8"},"Date":"2019-01-05","LineItems":[{"Description":"Foobar","Quantity":2.0,"UnitAmount":20.0,"AccountCode":"400"}]}]} # CreditNotes | Credit Notes with array of CreditNote object in body of request summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a new credit note - api_response = api_instance.create_credit_notes(xero_tenant_id, credit_notes, summarize_errors=summarize_errors, unitdp=unitdp) + api_response = api_instance.create_credit_notes(xero_tenant_id, credit_notes, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_credit_notes: %s\n" % e) @@ -1526,6 +1574,7 @@ Name | Type | Description | Notes **credit_notes** | [**CreditNotes**](CreditNotes.md)| Credit Notes with array of CreditNote object in body of request | **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1543,7 +1592,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_currency** -> Currencies create_currency(xero_tenant_id, currency) +> Currencies create_currency(xero_tenant_id, currency, idempotency_key=idempotency_key) Create a new currency for a Xero organisation @@ -1574,10 +1623,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -currency = { "Code": "USD", "Description": "United States Dollar" } # Currency | Currency object in the body of request +currency = {"Code":"USD","Description":"United States Dollar"} # Currency | Currency object in the body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Create a new currency for a Xero organisation - api_response = api_instance.create_currency(xero_tenant_id, currency) + api_response = api_instance.create_currency(xero_tenant_id, currency, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_currency: %s\n" % e) @@ -1589,6 +1639,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **currency** | [**Currency**](Currency.md)| Currency object in the body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1605,73 +1656,8 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_employees** -> Employees create_employees(xero_tenant_id, employees, summarize_errors=summarize_errors) - -Creates new employees used in Xero payrun - -### Example - -* OAuth Authentication (OAuth2): -```python -from xero_python.api_client import Configuration, ApiClient -from xero_python.api_client.oauth2 import OAuth2Token -from xero_python.exceptions import ApiException -from xero_python.accounting import AccountingApi -from pprint import pprint - -# Configure OAuth2 access token for authorization: OAuth2 -# simplified version, `xero_oauth2_token` represents permanent global token storage -xero_oauth2_token = {} # set to valid xero oauth2 token dictionary -# create client configuration with client id and client secret for automatic token refresh -api_config = Configuration(oauth2_token=OAuth2Token( - client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" -)) -# configure xero-python sdk client -api_client = ApiClient( - api_config, - oauth2_token_saver=lambda x: xero_oauth2_token.update(x), - oauth2_token_getter=lambda : xero_oauth2_token -) -# create an instance of the API class -api_instance = AccountingApi(api_client) - -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -employees = { "Employees": [ { "FirstName": "Nick", "LastName": "Fury", "ExternalLink": { "Url": "http://twitter.com/#!/search/Nick+Fury" } } ] } # Employees | Employees with array of Employee object in body of request -summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) -try: - # Creates new employees used in Xero payrun - api_response = api_instance.create_employees(xero_tenant_id, employees, summarize_errors=summarize_errors) - pprint(api_response) -except ApiException as e: - print("Exception when calling AccountingApi->create_employees: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **xero_tenant_id** | **str**| Xero identifier for Tenant | - **employees** | [**Employees**](Employees.md)| Employees with array of Employee object in body of request | - **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] - -### Return type - -[**Employees**](Employees.md) - -### Authorization - -[OAuth2](../README.md#OAuth2) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - # **create_expense_claim_history** -> HistoryRecords create_expense_claim_history(xero_tenant_id, expense_claim_id, history_records) +> HistoryRecords create_expense_claim_history(xero_tenant_id, expense_claim_id, history_records, idempotency_key=idempotency_key) Creates a history record for a specific expense claim @@ -1703,10 +1689,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant expense_claim_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a ExpenseClaim -history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +history_records = {"HistoryRecords":[{"Details":"Hello World"}]} # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a history record for a specific expense claim - api_response = api_instance.create_expense_claim_history(xero_tenant_id, expense_claim_id, history_records) + api_response = api_instance.create_expense_claim_history(xero_tenant_id, expense_claim_id, history_records, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_expense_claim_history: %s\n" % e) @@ -1719,6 +1706,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **expense_claim_id** | [**str**](.md)| Unique identifier for a ExpenseClaim | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1736,7 +1724,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_expense_claims** -> ExpenseClaims create_expense_claims(xero_tenant_id, expense_claims) +> ExpenseClaims create_expense_claims(xero_tenant_id, expense_claims, idempotency_key=idempotency_key) Creates expense claims @@ -1767,10 +1755,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -expense_claims = { "ExpenseClaims": [ { "Status": "SUBMITTED", "User": { "UserID": "d1164823-0ac1-41ad-987b-b4e30fe0b273" }, "Receipts": [ { "Lineitems": [], "ReceiptID": "dc1c7f6d-0a4c-402f-acac-551d62ce5816" } ] } ] } # ExpenseClaims | ExpenseClaims with array of ExpenseClaim object in body of request +expense_claims = {"ExpenseClaims":[{"Status":"SUBMITTED","User":{"UserID":"d1164823-0ac1-41ad-987b-b4e30fe0b273"},"Receipts":[{"Lineitems":[],"ReceiptID":"dc1c7f6d-0a4c-402f-acac-551d62ce5816"}]}]} # ExpenseClaims | ExpenseClaims with array of ExpenseClaim object in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates expense claims - api_response = api_instance.create_expense_claims(xero_tenant_id, expense_claims) + api_response = api_instance.create_expense_claims(xero_tenant_id, expense_claims, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_expense_claims: %s\n" % e) @@ -1782,6 +1771,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **expense_claims** | [**ExpenseClaims**](ExpenseClaims.md)| ExpenseClaims with array of ExpenseClaim object in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1799,7 +1789,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_invoice_attachment_by_file_name** -> Attachments create_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body, include_online=include_online) +> Attachments create_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body, include_online=include_online, idempotency_key=idempotency_key) Creates an attachment for a specific invoice or purchase bill by filename @@ -1834,9 +1824,10 @@ invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier fo file_name = 'xero-dev.jpg' # str | Name of the attachment body = 'body_example' # str | Byte array of file in body of request include_online = False # bool | Allows an attachment to be seen by the end customer within their online invoice (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates an attachment for a specific invoice or purchase bill by filename - api_response = api_instance.create_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body, include_online=include_online) + api_response = api_instance.create_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body, include_online=include_online, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_invoice_attachment_by_file_name: %s\n" % e) @@ -1851,6 +1842,7 @@ Name | Type | Description | Notes **file_name** | **str**| Name of the attachment | **body** | **str**| Byte array of file in body of request | **include_online** | **bool**| Allows an attachment to be seen by the end customer within their online invoice | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1868,7 +1860,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_invoice_history** -> HistoryRecords create_invoice_history(xero_tenant_id, invoice_id, history_records) +> HistoryRecords create_invoice_history(xero_tenant_id, invoice_id, history_records, idempotency_key=idempotency_key) Creates a history record for a specific invoice @@ -1900,10 +1892,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Invoice -history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +history_records = {"HistoryRecords":[{"Details":"Hello World"}]} # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a history record for a specific invoice - api_response = api_instance.create_invoice_history(xero_tenant_id, invoice_id, history_records) + api_response = api_instance.create_invoice_history(xero_tenant_id, invoice_id, history_records, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_invoice_history: %s\n" % e) @@ -1916,6 +1909,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **invoice_id** | [**str**](.md)| Unique identifier for an Invoice | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1933,7 +1927,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_invoices** -> Invoices create_invoices(xero_tenant_id, invoices, summarize_errors=summarize_errors, unitdp=unitdp) +> Invoices create_invoices(xero_tenant_id, invoices, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key, allow_backorders=allow_backorders) Creates one or more sales invoices or purchase bills @@ -1964,12 +1958,14 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -invoices = { "Invoices": [ { "Type": "ACCREC", "Contact": { "ContactID": "430fa14a-f945-44d3-9f97-5df5e28441b8" }, "LineItems": [ { "Description": "Acme Tires", "Quantity": 2, "UnitAmount": 20, "AccountCode": "200", "TaxType": "NONE", "LineAmount": 40 } ], "Date": "2019-03-11", "DueDate": "2018-12-10", "Reference": "Website Design", "Status": "AUTHORISED" } ] } # Invoices | Invoices with an array of invoice objects in body of request +invoices = {"Invoices":[{"Type":"ACCREC","Contact":{"ContactID":"430fa14a-f945-44d3-9f97-5df5e28441b8"},"LineItems":[{"Description":"Acme Tires","Quantity":2,"UnitAmount":20,"AccountCode":"200","TaxType":"NONE","LineAmount":40}],"Date":"2019-03-11","DueDate":"2018-12-10","Reference":"Website Design","Status":"AUTHORISED"}]} # Invoices | Invoices with an array of invoice objects in body of request summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) +allow_backorders = true # bool | Allows an invoice to be created even when one or more line items contain tracked inventory where the invoice quantity would cause the available quantity to go negative (optional) try: # Creates one or more sales invoices or purchase bills - api_response = api_instance.create_invoices(xero_tenant_id, invoices, summarize_errors=summarize_errors, unitdp=unitdp) + api_response = api_instance.create_invoices(xero_tenant_id, invoices, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key, allow_backorders=allow_backorders) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_invoices: %s\n" % e) @@ -1983,6 +1979,8 @@ Name | Type | Description | Notes **invoices** | [**Invoices**](Invoices.md)| Invoices with an array of invoice objects in body of request | **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] + **allow_backorders** | **bool**| Allows an invoice to be created even when one or more line items contain tracked inventory where the invoice quantity would cause the available quantity to go negative | [optional] ### Return type @@ -2000,7 +1998,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_item_history** -> HistoryRecords create_item_history(xero_tenant_id, item_id, history_records) +> HistoryRecords create_item_history(xero_tenant_id, item_id, history_records, idempotency_key=idempotency_key) Creates a history record for a specific item @@ -2032,10 +2030,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant item_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Item -history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +history_records = {"HistoryRecords":[{"Details":"Hello World"}]} # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a history record for a specific item - api_response = api_instance.create_item_history(xero_tenant_id, item_id, history_records) + api_response = api_instance.create_item_history(xero_tenant_id, item_id, history_records, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_item_history: %s\n" % e) @@ -2048,6 +2047,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **item_id** | [**str**](.md)| Unique identifier for an Item | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2065,7 +2065,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_items** -> Items create_items(xero_tenant_id, items, summarize_errors=summarize_errors, unitdp=unitdp) +> Items create_items(xero_tenant_id, items, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key) Creates one or more items @@ -2096,12 +2096,13 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -items = { "Items": [ { "Code": "code123", "Name": "Item Name XYZ", "Description": "Foobar", "InventoryAssetAccountCode": "140", "PurchaseDetails": { "COGSAccountCode": "500" } } ] } # Items | Items with an array of Item objects in body of request +items = {"Items":[{"Code":"code123","Name":"Item Name XYZ","Description":"Foobar","InventoryAssetAccountCode":"140","PurchaseDetails":{"COGSAccountCode":"500"}}]} # Items | Items with an array of Item objects in body of request summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates one or more items - api_response = api_instance.create_items(xero_tenant_id, items, summarize_errors=summarize_errors, unitdp=unitdp) + api_response = api_instance.create_items(xero_tenant_id, items, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_items: %s\n" % e) @@ -2115,6 +2116,7 @@ Name | Type | Description | Notes **items** | [**Items**](Items.md)| Items with an array of Item objects in body of request | **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2132,7 +2134,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_linked_transaction** -> LinkedTransactions create_linked_transaction(xero_tenant_id, linked_transaction) +> LinkedTransactions create_linked_transaction(xero_tenant_id, linked_transaction, idempotency_key=idempotency_key) Creates linked transactions (billable expenses) @@ -2163,10 +2165,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -linked_transaction = { "LinkedTransactions": [ { "SourceTransactionID": "a848644a-f20f-4630-98c3-386bd7505631", "SourceLineItemID": "b0df260d-3cc8-4ced-9bd6-41924f624ed3" } ] } # LinkedTransaction | LinkedTransaction object in body of request +linked_transaction = {"LinkedTransactions":[{"SourceTransactionID":"a848644a-f20f-4630-98c3-386bd7505631","SourceLineItemID":"b0df260d-3cc8-4ced-9bd6-41924f624ed3"}]} # LinkedTransaction | LinkedTransaction object in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates linked transactions (billable expenses) - api_response = api_instance.create_linked_transaction(xero_tenant_id, linked_transaction) + api_response = api_instance.create_linked_transaction(xero_tenant_id, linked_transaction, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_linked_transaction: %s\n" % e) @@ -2178,6 +2181,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **linked_transaction** | [**LinkedTransaction**](LinkedTransaction.md)| LinkedTransaction object in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2195,7 +2199,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_manual_journal_attachment_by_file_name** -> Attachments create_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body) +> Attachments create_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body, idempotency_key=idempotency_key) Creates a specific attachment for a specific manual journal by file name @@ -2229,9 +2233,10 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant manual_journal_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a ManualJournal file_name = 'xero-dev.jpg' # str | Name of the attachment body = 'body_example' # str | Byte array of file in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a specific attachment for a specific manual journal by file name - api_response = api_instance.create_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body) + api_response = api_instance.create_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_manual_journal_attachment_by_file_name: %s\n" % e) @@ -2245,6 +2250,7 @@ Name | Type | Description | Notes **manual_journal_id** | [**str**](.md)| Unique identifier for a ManualJournal | **file_name** | **str**| Name of the attachment | **body** | **str**| Byte array of file in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2262,7 +2268,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_manual_journal_history_record** -> HistoryRecords create_manual_journal_history_record(xero_tenant_id, manual_journal_id, history_records) +> HistoryRecords create_manual_journal_history_record(xero_tenant_id, manual_journal_id, history_records, idempotency_key=idempotency_key) Creates a history record for a specific manual journal @@ -2294,10 +2300,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant manual_journal_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a ManualJournal -history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +history_records = {"HistoryRecords":[{"Details":"Hello World"}]} # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a history record for a specific manual journal - api_response = api_instance.create_manual_journal_history_record(xero_tenant_id, manual_journal_id, history_records) + api_response = api_instance.create_manual_journal_history_record(xero_tenant_id, manual_journal_id, history_records, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_manual_journal_history_record: %s\n" % e) @@ -2310,6 +2317,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **manual_journal_id** | [**str**](.md)| Unique identifier for a ManualJournal | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2327,7 +2335,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_manual_journals** -> ManualJournals create_manual_journals(xero_tenant_id, manual_journals, summarize_errors=summarize_errors) +> ManualJournals create_manual_journals(xero_tenant_id, manual_journals, summarize_errors=summarize_errors, idempotency_key=idempotency_key) Creates one or more manual journals @@ -2358,11 +2366,12 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -manual_journals = { "ManualJournals": [ { "Narration": "Journal Desc", "JournalLines": [ { "LineAmount": 100, "AccountCode": "400", "Description": "Money Movement" }, { "LineAmount": -100, "AccountCode": "400", "Description": "Prepayment of things", "Tracking": [ { "Name": "North", "Option": "Region" } ] } ], "Date": "2019-03-14" } ] } # ManualJournals | ManualJournals array with ManualJournal object in body of request +manual_journals = {"ManualJournals":[{"Narration":"Journal Desc","JournalLines":[{"LineAmount":100,"AccountCode":"400","Description":"Money Movement"},{"LineAmount":-100,"AccountCode":"400","Description":"Prepayment of things","Tracking":[{"Name":"North","Option":"Region"}]}],"Date":"2019-03-14"}]} # ManualJournals | ManualJournals array with ManualJournal object in body of request summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates one or more manual journals - api_response = api_instance.create_manual_journals(xero_tenant_id, manual_journals, summarize_errors=summarize_errors) + api_response = api_instance.create_manual_journals(xero_tenant_id, manual_journals, summarize_errors=summarize_errors, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_manual_journals: %s\n" % e) @@ -2375,6 +2384,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **manual_journals** | [**ManualJournals**](ManualJournals.md)| ManualJournals array with ManualJournal object in body of request | **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2392,7 +2402,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_overpayment_allocations** -> Allocations create_overpayment_allocations(xero_tenant_id, overpayment_id, allocations, summarize_errors=summarize_errors) +> Allocations create_overpayment_allocations(xero_tenant_id, overpayment_id, allocations, summarize_errors=summarize_errors, idempotency_key=idempotency_key) Creates a single allocation for a specific overpayment @@ -2424,11 +2434,12 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant overpayment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Overpayment -allocations = { "Allocations": [ { "Invoice": { "InvoiceID": "00000000-0000-0000-0000-000000000000", "LineItems": [], "Contact": {}, "Type": "ACCPAY" }, "Amount": 10.00, "Date": "2019-03-12" } ] } # Allocations | Allocations array with Allocation object in body of request +allocations = {"Allocations":[{"Invoice":{"InvoiceID":"00000000-0000-0000-0000-000000000000","LineItems":[],"Contact":{},"Type":"ACCPAY"},"Amount":10.0,"Date":"2019-03-12"}]} # Allocations | Allocations array with Allocation object in body of request summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a single allocation for a specific overpayment - api_response = api_instance.create_overpayment_allocations(xero_tenant_id, overpayment_id, allocations, summarize_errors=summarize_errors) + api_response = api_instance.create_overpayment_allocations(xero_tenant_id, overpayment_id, allocations, summarize_errors=summarize_errors, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_overpayment_allocations: %s\n" % e) @@ -2442,6 +2453,7 @@ Name | Type | Description | Notes **overpayment_id** | [**str**](.md)| Unique identifier for a Overpayment | **allocations** | [**Allocations**](Allocations.md)| Allocations array with Allocation object in body of request | **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2459,7 +2471,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_overpayment_history** -> HistoryRecords create_overpayment_history(xero_tenant_id, overpayment_id, history_records) +> HistoryRecords create_overpayment_history(xero_tenant_id, overpayment_id, history_records, idempotency_key=idempotency_key) Creates a history record for a specific overpayment @@ -2491,10 +2503,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant overpayment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Overpayment -history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +history_records = {"HistoryRecords":[{"Details":"Hello World"}]} # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a history record for a specific overpayment - api_response = api_instance.create_overpayment_history(xero_tenant_id, overpayment_id, history_records) + api_response = api_instance.create_overpayment_history(xero_tenant_id, overpayment_id, history_records, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_overpayment_history: %s\n" % e) @@ -2507,6 +2520,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **overpayment_id** | [**str**](.md)| Unique identifier for a Overpayment | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2524,7 +2538,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_payment** -> Payments create_payment(xero_tenant_id, payment) +> Payments create_payment(xero_tenant_id, payment, idempotency_key=idempotency_key) Creates a single payment for invoice or credit notes @@ -2555,10 +2569,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -payment = { "Payments": [ { "Invoice": { "LineItems": [], "InvoiceID": "00000000-0000-0000-0000-000000000000" }, "Account": { "Code": "970" }, "Date": "2019-03-12", "Amount": 1 } ] } # Payment | Request body with a single Payment object +payment = {"Payments":[{"Invoice":{"LineItems":[],"InvoiceID":"00000000-0000-0000-0000-000000000000"},"Account":{"Code":"970"},"Date":"2019-03-12","Amount":1}]} # Payment | Request body with a single Payment object +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a single payment for invoice or credit notes - api_response = api_instance.create_payment(xero_tenant_id, payment) + api_response = api_instance.create_payment(xero_tenant_id, payment, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_payment: %s\n" % e) @@ -2570,6 +2585,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **payment** | [**Payment**](Payment.md)| Request body with a single Payment object | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2587,7 +2603,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_payment_history** -> HistoryRecords create_payment_history(xero_tenant_id, payment_id, history_records) +> HistoryRecords create_payment_history(xero_tenant_id, payment_id, history_records, idempotency_key=idempotency_key) Creates a history record for a specific payment @@ -2619,10 +2635,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant payment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Payment -history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +history_records = {"HistoryRecords":[{"Details":"Hello World"}]} # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a history record for a specific payment - api_response = api_instance.create_payment_history(xero_tenant_id, payment_id, history_records) + api_response = api_instance.create_payment_history(xero_tenant_id, payment_id, history_records, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_payment_history: %s\n" % e) @@ -2635,6 +2652,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **payment_id** | [**str**](.md)| Unique identifier for a Payment | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2652,7 +2670,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_payment_service** -> PaymentServices create_payment_service(xero_tenant_id, payment_services) +> PaymentServices create_payment_service(xero_tenant_id, payment_services, idempotency_key=idempotency_key) Creates a payment service @@ -2683,10 +2701,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -payment_services = { "PaymentServices": [ { "PaymentServiceName": "PayUpNow", "PaymentServiceUrl": "https://www.payupnow.com/", "PayNowText": "Time To Pay" } ] } # PaymentServices | PaymentServices array with PaymentService object in body of request +payment_services = {"PaymentServices":[{"PaymentServiceName":"PayUpNow","PaymentServiceUrl":"https://www.payupnow.com/","PayNowText":"Time To Pay"}]} # PaymentServices | PaymentServices array with PaymentService object in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a payment service - api_response = api_instance.create_payment_service(xero_tenant_id, payment_services) + api_response = api_instance.create_payment_service(xero_tenant_id, payment_services, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_payment_service: %s\n" % e) @@ -2698,6 +2717,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **payment_services** | [**PaymentServices**](PaymentServices.md)| PaymentServices array with PaymentService object in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2715,7 +2735,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_payments** -> Payments create_payments(xero_tenant_id, payments, summarize_errors=summarize_errors) +> Payments create_payments(xero_tenant_id, payments, summarize_errors=summarize_errors, idempotency_key=idempotency_key) Creates multiple payments for invoices or credit notes @@ -2746,11 +2766,12 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -payments = { "Payments": [ { "Invoice": { "LineItems": [], "InvoiceID": "00000000-0000-0000-0000-000000000000" }, "Account": { "Code": "970" }, "Date": "2019-03-12", "Amount": 1 } ] } # Payments | Payments array with Payment object in body of request +payments = {"Payments":[{"Invoice":{"LineItems":[],"InvoiceID":"00000000-0000-0000-0000-000000000000"},"Account":{"Code":"970"},"Date":"2019-03-12","Amount":1}]} # Payments | Payments array with Payment object in body of request summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates multiple payments for invoices or credit notes - api_response = api_instance.create_payments(xero_tenant_id, payments, summarize_errors=summarize_errors) + api_response = api_instance.create_payments(xero_tenant_id, payments, summarize_errors=summarize_errors, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_payments: %s\n" % e) @@ -2763,6 +2784,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **payments** | [**Payments**](Payments.md)| Payments array with Payment object in body of request | **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2780,7 +2802,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_prepayment_allocations** -> Allocations create_prepayment_allocations(xero_tenant_id, prepayment_id, allocations, summarize_errors=summarize_errors) +> Allocations create_prepayment_allocations(xero_tenant_id, prepayment_id, allocations, summarize_errors=summarize_errors, idempotency_key=idempotency_key) Allows you to create an Allocation for prepayments @@ -2812,11 +2834,12 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant prepayment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a PrePayment -allocations = { "Allocations": [ { "Invoice": { "LineItems": [], "InvoiceID": "00000000-0000-0000-0000-000000000000" }, "Amount": 1, "Date": "2019-01-10" } ] } # Allocations | Allocations with an array of Allocation object in body of request +allocations = {"Allocations":[{"Invoice":{"LineItems":[],"InvoiceID":"00000000-0000-0000-0000-000000000000"},"Amount":1,"Date":"2019-01-10"}]} # Allocations | Allocations with an array of Allocation object in body of request summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Allows you to create an Allocation for prepayments - api_response = api_instance.create_prepayment_allocations(xero_tenant_id, prepayment_id, allocations, summarize_errors=summarize_errors) + api_response = api_instance.create_prepayment_allocations(xero_tenant_id, prepayment_id, allocations, summarize_errors=summarize_errors, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_prepayment_allocations: %s\n" % e) @@ -2830,6 +2853,7 @@ Name | Type | Description | Notes **prepayment_id** | [**str**](.md)| Unique identifier for a PrePayment | **allocations** | [**Allocations**](Allocations.md)| Allocations with an array of Allocation object in body of request | **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2847,7 +2871,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_prepayment_history** -> HistoryRecords create_prepayment_history(xero_tenant_id, prepayment_id, history_records) +> HistoryRecords create_prepayment_history(xero_tenant_id, prepayment_id, history_records, idempotency_key=idempotency_key) Creates a history record for a specific prepayment @@ -2879,10 +2903,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant prepayment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a PrePayment -history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +history_records = {"HistoryRecords":[{"Details":"Hello World"}]} # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a history record for a specific prepayment - api_response = api_instance.create_prepayment_history(xero_tenant_id, prepayment_id, history_records) + api_response = api_instance.create_prepayment_history(xero_tenant_id, prepayment_id, history_records, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_prepayment_history: %s\n" % e) @@ -2895,6 +2920,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **prepayment_id** | [**str**](.md)| Unique identifier for a PrePayment | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2912,7 +2938,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_purchase_order_attachment_by_file_name** -> Attachments create_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body) +> Attachments create_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body, idempotency_key=idempotency_key) Creates attachment for a specific purchase order @@ -2946,9 +2972,10 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant purchase_order_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Purchase Order file_name = 'xero-dev.jpg' # str | Name of the attachment body = 'body_example' # str | Byte array of file in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates attachment for a specific purchase order - api_response = api_instance.create_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body) + api_response = api_instance.create_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_purchase_order_attachment_by_file_name: %s\n" % e) @@ -2962,6 +2989,7 @@ Name | Type | Description | Notes **purchase_order_id** | [**str**](.md)| Unique identifier for an Purchase Order | **file_name** | **str**| Name of the attachment | **body** | **str**| Byte array of file in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2979,7 +3007,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_purchase_order_history** -> HistoryRecords create_purchase_order_history(xero_tenant_id, purchase_order_id, history_records) +> HistoryRecords create_purchase_order_history(xero_tenant_id, purchase_order_id, history_records, idempotency_key=idempotency_key) Creates a history record for a specific purchase orders @@ -3011,10 +3039,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant purchase_order_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Purchase Order -history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +history_records = {"HistoryRecords":[{"Details":"Hello World"}]} # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a history record for a specific purchase orders - api_response = api_instance.create_purchase_order_history(xero_tenant_id, purchase_order_id, history_records) + api_response = api_instance.create_purchase_order_history(xero_tenant_id, purchase_order_id, history_records, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_purchase_order_history: %s\n" % e) @@ -3027,6 +3056,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **purchase_order_id** | [**str**](.md)| Unique identifier for an Purchase Order | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3044,7 +3074,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_purchase_orders** -> PurchaseOrders create_purchase_orders(xero_tenant_id, purchase_orders, summarize_errors=summarize_errors) +> PurchaseOrders create_purchase_orders(xero_tenant_id, purchase_orders, summarize_errors=summarize_errors, idempotency_key=idempotency_key) Creates one or more purchase orders @@ -3075,11 +3105,12 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -purchase_orders = { "PurchaseOrders": [ { "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "LineItems": [ { "Description": "Foobar", "Quantity": 1, "UnitAmount": 20, "AccountCode": "710" } ], "Date": "2019-03-13" } ] } # PurchaseOrders | PurchaseOrders with an array of PurchaseOrder object in body of request +purchase_orders = {"PurchaseOrders":[{"Contact":{"ContactID":"00000000-0000-0000-0000-000000000000"},"LineItems":[{"Description":"Foobar","Quantity":1,"UnitAmount":20,"AccountCode":"710"}],"Date":"2019-03-13"}]} # PurchaseOrders | PurchaseOrders with an array of PurchaseOrder object in body of request summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates one or more purchase orders - api_response = api_instance.create_purchase_orders(xero_tenant_id, purchase_orders, summarize_errors=summarize_errors) + api_response = api_instance.create_purchase_orders(xero_tenant_id, purchase_orders, summarize_errors=summarize_errors, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_purchase_orders: %s\n" % e) @@ -3092,6 +3123,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **purchase_orders** | [**PurchaseOrders**](PurchaseOrders.md)| PurchaseOrders with an array of PurchaseOrder object in body of request | **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3109,7 +3141,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_quote_attachment_by_file_name** -> Attachments create_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body) +> Attachments create_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body, idempotency_key=idempotency_key) Creates attachment for a specific quote @@ -3143,9 +3175,10 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant quote_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Quote file_name = 'xero-dev.jpg' # str | Name of the attachment body = 'body_example' # str | Byte array of file in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates attachment for a specific quote - api_response = api_instance.create_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body) + api_response = api_instance.create_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_quote_attachment_by_file_name: %s\n" % e) @@ -3159,6 +3192,7 @@ Name | Type | Description | Notes **quote_id** | [**str**](.md)| Unique identifier for an Quote | **file_name** | **str**| Name of the attachment | **body** | **str**| Byte array of file in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3176,7 +3210,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_quote_history** -> HistoryRecords create_quote_history(xero_tenant_id, quote_id, history_records) +> HistoryRecords create_quote_history(xero_tenant_id, quote_id, history_records, idempotency_key=idempotency_key) Creates a history record for a specific quote @@ -3208,10 +3242,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant quote_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Quote -history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +history_records = {"HistoryRecords":[{"Details":"Hello World"}]} # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a history record for a specific quote - api_response = api_instance.create_quote_history(xero_tenant_id, quote_id, history_records) + api_response = api_instance.create_quote_history(xero_tenant_id, quote_id, history_records, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_quote_history: %s\n" % e) @@ -3224,6 +3259,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **quote_id** | [**str**](.md)| Unique identifier for an Quote | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3241,7 +3277,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_quotes** -> Quotes create_quotes(xero_tenant_id, quotes, summarize_errors=summarize_errors) +> Quotes create_quotes(xero_tenant_id, quotes, summarize_errors=summarize_errors, idempotency_key=idempotency_key) Create one or more quotes @@ -3272,11 +3308,12 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -quotes = { "Quotes": [ { "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "LineItems": [ { "Description": "Foobar", "Quantity": 1, "UnitAmount": 20, "AccountCode": "12775" } ], "Date": "2020-02-01" } ] } # Quotes | Quotes with an array of Quote object in body of request +quotes = {"Quotes":[{"Contact":{"ContactID":"00000000-0000-0000-0000-000000000000"},"LineItems":[{"Description":"Foobar","Quantity":1,"UnitAmount":20,"AccountCode":"12775"}],"Date":"2020-02-01"}]} # Quotes | Quotes with an array of Quote object in body of request summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Create one or more quotes - api_response = api_instance.create_quotes(xero_tenant_id, quotes, summarize_errors=summarize_errors) + api_response = api_instance.create_quotes(xero_tenant_id, quotes, summarize_errors=summarize_errors, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_quotes: %s\n" % e) @@ -3289,6 +3326,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **quotes** | [**Quotes**](Quotes.md)| Quotes with an array of Quote object in body of request | **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3306,7 +3344,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_receipt** -> Receipts create_receipt(xero_tenant_id, receipts, unitdp=unitdp) +> Receipts create_receipt(xero_tenant_id, receipts, unitdp=unitdp, idempotency_key=idempotency_key) Creates draft expense claim receipts for any user @@ -3337,11 +3375,12 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -receipts = { "Receipts": [ { "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "Lineitems": [ { "Description": "Foobar", "Quantity": 2, "UnitAmount": 20, "AccountCode": "400", "TaxType": "NONE", "LineAmount": 40 } ], "User": { "UserID": "00000000-0000-0000-0000-000000000000" }, "LineAmountTypes": "NoTax", "Status": "DRAFT" } ] } # Receipts | Receipts with an array of Receipt object in body of request +receipts = {"Receipts":[{"Contact":{"ContactID":"00000000-0000-0000-0000-000000000000"},"Lineitems":[{"Description":"Foobar","Quantity":2,"UnitAmount":20,"AccountCode":"400","TaxType":"NONE","LineAmount":40}],"User":{"UserID":"00000000-0000-0000-0000-000000000000"},"LineAmountTypes":"NoTax","Status":"DRAFT"}]} # Receipts | Receipts with an array of Receipt object in body of request unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates draft expense claim receipts for any user - api_response = api_instance.create_receipt(xero_tenant_id, receipts, unitdp=unitdp) + api_response = api_instance.create_receipt(xero_tenant_id, receipts, unitdp=unitdp, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_receipt: %s\n" % e) @@ -3354,6 +3393,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **receipts** | [**Receipts**](Receipts.md)| Receipts with an array of Receipt object in body of request | **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3371,7 +3411,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_receipt_attachment_by_file_name** -> Attachments create_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body) +> Attachments create_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body, idempotency_key=idempotency_key) Creates an attachment on a specific expense claim receipts by file name @@ -3405,9 +3445,10 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant receipt_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Receipt file_name = 'xero-dev.jpg' # str | Name of the attachment body = 'body_example' # str | Byte array of file in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates an attachment on a specific expense claim receipts by file name - api_response = api_instance.create_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body) + api_response = api_instance.create_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_receipt_attachment_by_file_name: %s\n" % e) @@ -3421,6 +3462,7 @@ Name | Type | Description | Notes **receipt_id** | [**str**](.md)| Unique identifier for a Receipt | **file_name** | **str**| Name of the attachment | **body** | **str**| Byte array of file in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3438,7 +3480,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_receipt_history** -> HistoryRecords create_receipt_history(xero_tenant_id, receipt_id, history_records) +> HistoryRecords create_receipt_history(xero_tenant_id, receipt_id, history_records, idempotency_key=idempotency_key) Creates a history record for a specific receipt @@ -3470,10 +3512,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant receipt_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Receipt -history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +history_records = {"HistoryRecords":[{"Details":"Hello World"}]} # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a history record for a specific receipt - api_response = api_instance.create_receipt_history(xero_tenant_id, receipt_id, history_records) + api_response = api_instance.create_receipt_history(xero_tenant_id, receipt_id, history_records, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_receipt_history: %s\n" % e) @@ -3486,6 +3529,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **receipt_id** | [**str**](.md)| Unique identifier for a Receipt | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3503,7 +3547,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_repeating_invoice_attachment_by_file_name** -> Attachments create_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body) +> Attachments create_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body, idempotency_key=idempotency_key) Creates an attachment from a specific repeating invoices by file name @@ -3537,9 +3581,10 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant repeating_invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Repeating Invoice file_name = 'xero-dev.jpg' # str | Name of the attachment body = 'body_example' # str | Byte array of file in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates an attachment from a specific repeating invoices by file name - api_response = api_instance.create_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body) + api_response = api_instance.create_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_repeating_invoice_attachment_by_file_name: %s\n" % e) @@ -3553,6 +3598,7 @@ Name | Type | Description | Notes **repeating_invoice_id** | [**str**](.md)| Unique identifier for a Repeating Invoice | **file_name** | **str**| Name of the attachment | **body** | **str**| Byte array of file in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3570,7 +3616,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_repeating_invoice_history** -> HistoryRecords create_repeating_invoice_history(xero_tenant_id, repeating_invoice_id, history_records) +> HistoryRecords create_repeating_invoice_history(xero_tenant_id, repeating_invoice_id, history_records, idempotency_key=idempotency_key) Creates a history record for a specific repeating invoice @@ -3602,10 +3648,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant repeating_invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Repeating Invoice -history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +history_records = {"HistoryRecords":[{"Details":"Hello World"}]} # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a history record for a specific repeating invoice - api_response = api_instance.create_repeating_invoice_history(xero_tenant_id, repeating_invoice_id, history_records) + api_response = api_instance.create_repeating_invoice_history(xero_tenant_id, repeating_invoice_id, history_records, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_repeating_invoice_history: %s\n" % e) @@ -3618,6 +3665,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **repeating_invoice_id** | [**str**](.md)| Unique identifier for a Repeating Invoice | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3634,8 +3682,75 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **create_repeating_invoices** +> RepeatingInvoices create_repeating_invoices(xero_tenant_id, repeating_invoices, summarize_errors=summarize_errors, idempotency_key=idempotency_key) + +Creates one or more repeating invoice templates + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.accounting import AccountingApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = AccountingApi(api_client) + +xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant +repeating_invoices = {"RepeatingInvoices":[{"Schedule":{"Period":1,"Unit":"MONTHLY","DueDate":10,"DueDateType":"OFFOLLOWINGMONTH","StartDate":"/Date(1555286400000+0000)/"},"Type":"ACCREC","Reference":"[Week]","ApprovedForSending":false,"SendCopy":false,"MarkAsSent":false,"IncludePDF":false,"Contact":{"ContactID":"430fa14a-f945-44d3-9f97-5df5e28441b8","Name":"Liam Gallagher"},"Status":"AUTHORISED","LineAmountTypes":"Exclusive","LineItems":[{"Description":"Guitars Fender Strat","UnitAmount":5000.0,"TaxType":"OUTPUT2","TaxAmount":750.0,"LineAmount":5000.0,"AccountCode":"200","Tracking":[],"Quantity":1.0,"LineItemID":"13a8353c-d2af-4d5b-920c-438449f08900","DiscountEnteredAsPercent":true}],"CurrencyCode":"NZD"}]} # RepeatingInvoices | RepeatingInvoices with an array of repeating invoice objects in body of request +summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) +try: + # Creates one or more repeating invoice templates + api_response = api_instance.create_repeating_invoices(xero_tenant_id, repeating_invoices, summarize_errors=summarize_errors, idempotency_key=idempotency_key) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountingApi->create_repeating_invoices: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **repeating_invoices** | [**RepeatingInvoices**](RepeatingInvoices.md)| RepeatingInvoices with an array of repeating invoice objects in body of request | + **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] + +### Return type + +[**RepeatingInvoices**](RepeatingInvoices.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **create_tax_rates** -> TaxRates create_tax_rates(xero_tenant_id, tax_rates) +> TaxRates create_tax_rates(xero_tenant_id, tax_rates, idempotency_key=idempotency_key) Creates one or more tax rates @@ -3666,10 +3781,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -tax_rates = { "TaxRates": [ { "Name": "CA State Tax", "TaxComponents": [ { "Name": "State Tax", "Rate": 2.25 } ] } ] } # TaxRates | TaxRates array with TaxRate object in body of request +tax_rates = {"TaxRates":[{"Name":"CA State Tax","TaxComponents":[{"Name":"State Tax","Rate":2.25}]}]} # TaxRates | TaxRates array with TaxRate object in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates one or more tax rates - api_response = api_instance.create_tax_rates(xero_tenant_id, tax_rates) + api_response = api_instance.create_tax_rates(xero_tenant_id, tax_rates, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_tax_rates: %s\n" % e) @@ -3681,6 +3797,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **tax_rates** | [**TaxRates**](TaxRates.md)| TaxRates array with TaxRate object in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3698,7 +3815,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_tracking_category** -> TrackingCategories create_tracking_category(xero_tenant_id, tracking_category) +> TrackingCategories create_tracking_category(xero_tenant_id, tracking_category, idempotency_key=idempotency_key) Create tracking categories @@ -3729,10 +3846,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -tracking_category = { name: "FooBar" } # TrackingCategory | TrackingCategory object in body of request +tracking_category = {"name":"FooBar"} # TrackingCategory | TrackingCategory object in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Create tracking categories - api_response = api_instance.create_tracking_category(xero_tenant_id, tracking_category) + api_response = api_instance.create_tracking_category(xero_tenant_id, tracking_category, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_tracking_category: %s\n" % e) @@ -3744,6 +3862,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **tracking_category** | [**TrackingCategory**](TrackingCategory.md)| TrackingCategory object in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3761,7 +3880,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_tracking_options** -> TrackingOptions create_tracking_options(xero_tenant_id, tracking_category_id, tracking_option) +> TrackingOptions create_tracking_options(xero_tenant_id, tracking_category_id, tracking_option, idempotency_key=idempotency_key) Creates options for a specific tracking category @@ -3793,10 +3912,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant tracking_category_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a TrackingCategory -tracking_option = { name: " Bar" } # TrackingOption | TrackingOption object in body of request +tracking_option = {"name":" Bar"} # TrackingOption | TrackingOption object in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates options for a specific tracking category - api_response = api_instance.create_tracking_options(xero_tenant_id, tracking_category_id, tracking_option) + api_response = api_instance.create_tracking_options(xero_tenant_id, tracking_category_id, tracking_option, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_tracking_options: %s\n" % e) @@ -3809,6 +3929,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **tracking_category_id** | [**str**](.md)| Unique identifier for a TrackingCategory | **tracking_option** | [**TrackingOption**](TrackingOption.md)| TrackingOption object in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3888,10 +4009,10 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_contact_group_contact** -> delete_contact_group_contact(xero_tenant_id, contact_group_id, contact_id) +# **delete_bank_transfer** +> BankTransfers delete_bank_transfer(xero_tenant_id, bank_transfer_id, bank_transfer_delete_by_url_param, idempotency_key=idempotency_key) -Deletes a specific contact from a contact group using a unique contact Id +Deletes a specific bank transfer ### Example @@ -3901,7 +4022,7 @@ from xero_python.api_client import Configuration, ApiClient from xero_python.api_client.oauth2 import OAuth2Token from xero_python.exceptions import ApiException from xero_python.accounting import AccountingApi - +from pprint import pprint # Configure OAuth2 access token for authorization: OAuth2 # simplified version, `xero_oauth2_token` represents permanent global token storage @@ -3920,13 +4041,15 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -contact_group_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Contact Group -contact_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Contact +bank_transfer_id = '00000000-0000-0000-0000-000000000000' # str | Xero generated unique identifier for a bank transfer +bank_transfer_delete_by_url_param = {"Status":"DELETED"} # BankTransferDeleteByUrlParam | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: - # Deletes a specific contact from a contact group using a unique contact Id - api_instance.delete_contact_group_contact(xero_tenant_id, contact_group_id, contact_id) + # Deletes a specific bank transfer + api_response = api_instance.delete_bank_transfer(xero_tenant_id, bank_transfer_id, bank_transfer_delete_by_url_param, idempotency_key=idempotency_key) + pprint(api_response) except ApiException as e: - print("Exception when calling AccountingApi->delete_contact_group_contact: %s\n" % e) + print("Exception when calling AccountingApi->delete_bank_transfer: %s\n" % e) ``` ### Parameters @@ -3934,12 +4057,13 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | - **contact_group_id** | [**str**](.md)| Unique identifier for a Contact Group | - **contact_id** | [**str**](.md)| Unique identifier for a Contact | + **bank_transfer_id** | [**str**](.md)| Xero generated unique identifier for a bank transfer | + **bank_transfer_delete_by_url_param** | [**BankTransferDeleteByUrlParam**](BankTransferDeleteByUrlParam.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type -void (empty response body) +[**BankTransfers**](BankTransfers.md) ### Authorization @@ -3947,15 +4071,15 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: Not defined + - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_contact_group_contacts** -> delete_contact_group_contacts(xero_tenant_id, contact_group_id) +# **delete_bank_transfers** +> BankTransfers delete_bank_transfers(xero_tenant_id, bank_transfers_delete, summarize_errors=summarize_errors, idempotency_key=idempotency_key) -Deletes all contacts from a specific contact group +Deletes one or more bank transfers ### Example @@ -3965,7 +4089,7 @@ from xero_python.api_client import Configuration, ApiClient from xero_python.api_client.oauth2 import OAuth2Token from xero_python.exceptions import ApiException from xero_python.accounting import AccountingApi - +from pprint import pprint # Configure OAuth2 access token for authorization: OAuth2 # simplified version, `xero_oauth2_token` represents permanent global token storage @@ -3984,12 +4108,15 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -contact_group_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Contact Group +bank_transfers_delete = {"BankTransfers":[{"BankTransferID":"6221458a-ef7a-4d5f-9b1c-1b96ce03833c","Status":"DELETED"},{"BankTransferID":"9f0153d5-617c-4903-887b-3875807aa27a","Status":"DELETED"}]} # BankTransfersDelete | BankTransfers with array of BankTransfer objects in request body +summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: - # Deletes all contacts from a specific contact group - api_instance.delete_contact_group_contacts(xero_tenant_id, contact_group_id) + # Deletes one or more bank transfers + api_response = api_instance.delete_bank_transfers(xero_tenant_id, bank_transfers_delete, summarize_errors=summarize_errors, idempotency_key=idempotency_key) + pprint(api_response) except ApiException as e: - print("Exception when calling AccountingApi->delete_contact_group_contacts: %s\n" % e) + print("Exception when calling AccountingApi->delete_bank_transfers: %s\n" % e) ``` ### Parameters @@ -3997,11 +4124,13 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | - **contact_group_id** | [**str**](.md)| Unique identifier for a Contact Group | + **bank_transfers_delete** | [**BankTransfersDelete**](BankTransfersDelete.md)| BankTransfers with array of BankTransfer objects in request body | + **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type -void (empty response body) +[**BankTransfers**](BankTransfers.md) ### Authorization @@ -4009,15 +4138,15 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined + - **Content-Type**: application/json + - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_item** -> delete_item(xero_tenant_id, item_id) +# **delete_batch_payment** +> BatchPayments delete_batch_payment(xero_tenant_id, batch_payment_delete, idempotency_key=idempotency_key) -Deletes a specific item +Updates a specific batch payment for invoices and credit notes ### Example @@ -4027,7 +4156,7 @@ from xero_python.api_client import Configuration, ApiClient from xero_python.api_client.oauth2 import OAuth2Token from xero_python.exceptions import ApiException from xero_python.accounting import AccountingApi - +from pprint import pprint # Configure OAuth2 access token for authorization: OAuth2 # simplified version, `xero_oauth2_token` represents permanent global token storage @@ -4046,12 +4175,14 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -item_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Item +batch_payment_delete = {"BatchPaymentID":"9bf296e9-0748-4d29-a3dc-24dde1098030","Status":"DELETED"} # BatchPaymentDelete | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: - # Deletes a specific item - api_instance.delete_item(xero_tenant_id, item_id) + # Updates a specific batch payment for invoices and credit notes + api_response = api_instance.delete_batch_payment(xero_tenant_id, batch_payment_delete, idempotency_key=idempotency_key) + pprint(api_response) except ApiException as e: - print("Exception when calling AccountingApi->delete_item: %s\n" % e) + print("Exception when calling AccountingApi->delete_batch_payment: %s\n" % e) ``` ### Parameters @@ -4059,11 +4190,12 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | - **item_id** | [**str**](.md)| Unique identifier for an Item | + **batch_payment_delete** | [**BatchPaymentDelete**](BatchPaymentDelete.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type -void (empty response body) +[**BatchPayments**](BatchPayments.md) ### Authorization @@ -4071,15 +4203,15 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: Not defined + - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_linked_transaction** -> delete_linked_transaction(xero_tenant_id, linked_transaction_id) +# **delete_batch_payment_by_url_param** +> BatchPayments delete_batch_payment_by_url_param(xero_tenant_id, batch_payment_id, batch_payment_delete_by_url_param, idempotency_key=idempotency_key) -Deletes a specific linked transactions (billable expenses) +Updates a specific batch payment for invoices and credit notes ### Example @@ -4089,7 +4221,7 @@ from xero_python.api_client import Configuration, ApiClient from xero_python.api_client.oauth2 import OAuth2Token from xero_python.exceptions import ApiException from xero_python.accounting import AccountingApi - +from pprint import pprint # Configure OAuth2 access token for authorization: OAuth2 # simplified version, `xero_oauth2_token` represents permanent global token storage @@ -4108,12 +4240,15 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -linked_transaction_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a LinkedTransaction +batch_payment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for BatchPayment +batch_payment_delete_by_url_param = {"Status":"DELETED"} # BatchPaymentDeleteByUrlParam | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: - # Deletes a specific linked transactions (billable expenses) - api_instance.delete_linked_transaction(xero_tenant_id, linked_transaction_id) + # Updates a specific batch payment for invoices and credit notes + api_response = api_instance.delete_batch_payment_by_url_param(xero_tenant_id, batch_payment_id, batch_payment_delete_by_url_param, idempotency_key=idempotency_key) + pprint(api_response) except ApiException as e: - print("Exception when calling AccountingApi->delete_linked_transaction: %s\n" % e) + print("Exception when calling AccountingApi->delete_batch_payment_by_url_param: %s\n" % e) ``` ### Parameters @@ -4121,11 +4256,13 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | - **linked_transaction_id** | [**str**](.md)| Unique identifier for a LinkedTransaction | + **batch_payment_id** | [**str**](.md)| Unique identifier for BatchPayment | + **batch_payment_delete_by_url_param** | [**BatchPaymentDeleteByUrlParam**](BatchPaymentDeleteByUrlParam.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type -void (empty response body) +[**BatchPayments**](BatchPayments.md) ### Authorization @@ -4133,15 +4270,15 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: Not defined + - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_payment** -> Payments delete_payment(xero_tenant_id, payment_id, payment_delete) +# **delete_contact_group_contact** +> delete_contact_group_contact(xero_tenant_id, contact_group_id, contact_id) -Updates a specific payment for invoices and credit notes +Deletes a specific contact from a contact group using a unique contact Id ### Example @@ -4151,7 +4288,7 @@ from xero_python.api_client import Configuration, ApiClient from xero_python.api_client.oauth2 import OAuth2Token from xero_python.exceptions import ApiException from xero_python.accounting import AccountingApi -from pprint import pprint + # Configure OAuth2 access token for authorization: OAuth2 # simplified version, `xero_oauth2_token` represents permanent global token storage @@ -4170,14 +4307,13 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -payment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Payment -payment_delete = { "Payments":[ { "Status":"DELETED" } ] } # PaymentDelete | +contact_group_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Contact Group +contact_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Contact try: - # Updates a specific payment for invoices and credit notes - api_response = api_instance.delete_payment(xero_tenant_id, payment_id, payment_delete) - pprint(api_response) + # Deletes a specific contact from a contact group using a unique contact Id + api_instance.delete_contact_group_contact(xero_tenant_id, contact_group_id, contact_id) except ApiException as e: - print("Exception when calling AccountingApi->delete_payment: %s\n" % e) + print("Exception when calling AccountingApi->delete_contact_group_contact: %s\n" % e) ``` ### Parameters @@ -4185,12 +4321,12 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | - **payment_id** | [**str**](.md)| Unique identifier for a Payment | - **payment_delete** | [**PaymentDelete**](PaymentDelete.md)| | + **contact_group_id** | [**str**](.md)| Unique identifier for a Contact Group | + **contact_id** | [**str**](.md)| Unique identifier for a Contact | ### Return type -[**Payments**](Payments.md) +void (empty response body) ### Authorization @@ -4198,15 +4334,15 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_tracking_category** -> TrackingCategories delete_tracking_category(xero_tenant_id, tracking_category_id) +# **delete_contact_group_contacts** +> delete_contact_group_contacts(xero_tenant_id, contact_group_id) -Deletes a specific tracking category +Deletes all contacts from a specific contact group ### Example @@ -4216,7 +4352,7 @@ from xero_python.api_client import Configuration, ApiClient from xero_python.api_client.oauth2 import OAuth2Token from xero_python.exceptions import ApiException from xero_python.accounting import AccountingApi -from pprint import pprint + # Configure OAuth2 access token for authorization: OAuth2 # simplified version, `xero_oauth2_token` represents permanent global token storage @@ -4235,13 +4371,12 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -tracking_category_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a TrackingCategory +contact_group_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Contact Group try: - # Deletes a specific tracking category - api_response = api_instance.delete_tracking_category(xero_tenant_id, tracking_category_id) - pprint(api_response) + # Deletes all contacts from a specific contact group + api_instance.delete_contact_group_contacts(xero_tenant_id, contact_group_id) except ApiException as e: - print("Exception when calling AccountingApi->delete_tracking_category: %s\n" % e) + print("Exception when calling AccountingApi->delete_contact_group_contacts: %s\n" % e) ``` ### Parameters @@ -4249,11 +4384,11 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | - **tracking_category_id** | [**str**](.md)| Unique identifier for a TrackingCategory | + **contact_group_id** | [**str**](.md)| Unique identifier for a Contact Group | ### Return type -[**TrackingCategories**](TrackingCategories.md) +void (empty response body) ### Authorization @@ -4262,14 +4397,14 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: Not defined [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_tracking_options** -> TrackingOptions delete_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id) +# **delete_credit_note_allocations** +> Allocation delete_credit_note_allocations(xero_tenant_id, credit_note_id, allocation_id) -Deletes a specific option for a specific tracking category +Deletes an Allocation from a Credit Note ### Example @@ -4298,14 +4433,14 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -tracking_category_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a TrackingCategory -tracking_option_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Tracking Option +credit_note_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Credit Note +allocation_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for Allocation object try: - # Deletes a specific option for a specific tracking category - api_response = api_instance.delete_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id) + # Deletes an Allocation from a Credit Note + api_response = api_instance.delete_credit_note_allocations(xero_tenant_id, credit_note_id, allocation_id) pprint(api_response) except ApiException as e: - print("Exception when calling AccountingApi->delete_tracking_options: %s\n" % e) + print("Exception when calling AccountingApi->delete_credit_note_allocations: %s\n" % e) ``` ### Parameters @@ -4313,12 +4448,12 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | - **tracking_category_id** | [**str**](.md)| Unique identifier for a TrackingCategory | - **tracking_option_id** | [**str**](.md)| Unique identifier for a Tracking Option | + **credit_note_id** | [**str**](.md)| Unique identifier for a Credit Note | + **allocation_id** | [**str**](.md)| Unique identifier for Allocation object | ### Return type -[**TrackingOptions**](TrackingOptions.md) +[**Allocation**](Allocation.md) ### Authorization @@ -4331,10 +4466,10 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **email_invoice** -> email_invoice(xero_tenant_id, invoice_id, request_empty) +# **delete_item** +> delete_item(xero_tenant_id, item_id) -Sends a copy of a specific invoice to related contact via email +Deletes a specific item ### Example @@ -4363,13 +4498,463 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Invoice -request_empty = {} # RequestEmpty | +item_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Item try: - # Sends a copy of a specific invoice to related contact via email - api_instance.email_invoice(xero_tenant_id, invoice_id, request_empty) + # Deletes a specific item + api_instance.delete_item(xero_tenant_id, item_id) except ApiException as e: - print("Exception when calling AccountingApi->email_invoice: %s\n" % e) + print("Exception when calling AccountingApi->delete_item: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **item_id** | [**str**](.md)| Unique identifier for an Item | + +### Return type + +void (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_linked_transaction** +> delete_linked_transaction(xero_tenant_id, linked_transaction_id) + +Deletes a specific linked transactions (billable expenses) + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.accounting import AccountingApi + + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = AccountingApi(api_client) + +xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant +linked_transaction_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a LinkedTransaction +try: + # Deletes a specific linked transactions (billable expenses) + api_instance.delete_linked_transaction(xero_tenant_id, linked_transaction_id) +except ApiException as e: + print("Exception when calling AccountingApi->delete_linked_transaction: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **linked_transaction_id** | [**str**](.md)| Unique identifier for a LinkedTransaction | + +### Return type + +void (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_overpayment_allocations** +> Allocation delete_overpayment_allocations(xero_tenant_id, overpayment_id, allocation_id) + +Deletes an Allocation from an overpayment + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.accounting import AccountingApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = AccountingApi(api_client) + +xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant +overpayment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Overpayment +allocation_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for Allocation object +try: + # Deletes an Allocation from an overpayment + api_response = api_instance.delete_overpayment_allocations(xero_tenant_id, overpayment_id, allocation_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountingApi->delete_overpayment_allocations: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **overpayment_id** | [**str**](.md)| Unique identifier for a Overpayment | + **allocation_id** | [**str**](.md)| Unique identifier for Allocation object | + +### Return type + +[**Allocation**](Allocation.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_payment** +> Payments delete_payment(xero_tenant_id, payment_id, payment_delete, idempotency_key=idempotency_key) + +Updates a specific payment for invoices and credit notes + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.accounting import AccountingApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = AccountingApi(api_client) + +xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant +payment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Payment +payment_delete = {"Payments":[{"Status":"DELETED"}]} # PaymentDelete | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) +try: + # Updates a specific payment for invoices and credit notes + api_response = api_instance.delete_payment(xero_tenant_id, payment_id, payment_delete, idempotency_key=idempotency_key) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountingApi->delete_payment: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **payment_id** | [**str**](.md)| Unique identifier for a Payment | + **payment_delete** | [**PaymentDelete**](PaymentDelete.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] + +### Return type + +[**Payments**](Payments.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_prepayment_allocations** +> Allocation delete_prepayment_allocations(xero_tenant_id, prepayment_id, allocation_id) + +Deletes an Allocation from a Prepayment + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.accounting import AccountingApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = AccountingApi(api_client) + +xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant +prepayment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a PrePayment +allocation_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for Allocation object +try: + # Deletes an Allocation from a Prepayment + api_response = api_instance.delete_prepayment_allocations(xero_tenant_id, prepayment_id, allocation_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountingApi->delete_prepayment_allocations: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **prepayment_id** | [**str**](.md)| Unique identifier for a PrePayment | + **allocation_id** | [**str**](.md)| Unique identifier for Allocation object | + +### Return type + +[**Allocation**](Allocation.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_tracking_category** +> TrackingCategories delete_tracking_category(xero_tenant_id, tracking_category_id) + +Deletes a specific tracking category + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.accounting import AccountingApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = AccountingApi(api_client) + +xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant +tracking_category_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a TrackingCategory +try: + # Deletes a specific tracking category + api_response = api_instance.delete_tracking_category(xero_tenant_id, tracking_category_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountingApi->delete_tracking_category: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **tracking_category_id** | [**str**](.md)| Unique identifier for a TrackingCategory | + +### Return type + +[**TrackingCategories**](TrackingCategories.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_tracking_options** +> TrackingOptions delete_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id) + +Deletes a specific option for a specific tracking category + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.accounting import AccountingApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = AccountingApi(api_client) + +xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant +tracking_category_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a TrackingCategory +tracking_option_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Tracking Option +try: + # Deletes a specific option for a specific tracking category + api_response = api_instance.delete_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountingApi->delete_tracking_options: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **tracking_category_id** | [**str**](.md)| Unique identifier for a TrackingCategory | + **tracking_option_id** | [**str**](.md)| Unique identifier for a Tracking Option | + +### Return type + +[**TrackingOptions**](TrackingOptions.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **email_invoice** +> email_invoice(xero_tenant_id, invoice_id, request_empty, idempotency_key=idempotency_key) + +Sends a copy of a specific invoice to related contact via email + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.accounting import AccountingApi + + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = AccountingApi(api_client) + +xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant +invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Invoice +request_empty = {} # RequestEmpty | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) +try: + # Sends a copy of a specific invoice to related contact via email + api_instance.email_invoice(xero_tenant_id, invoice_id, request_empty, idempotency_key=idempotency_key) +except ApiException as e: + print("Exception when calling AccountingApi->email_invoice: %s\n" % e) ``` ### Parameters @@ -4379,6 +4964,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **invoice_id** | [**str**](.md)| Unique identifier for an Invoice | **request_empty** | [**RequestEmpty**](RequestEmpty.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4985,7 +5571,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_bank_transactions** -> BankTransactions get_bank_transactions(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp) +> BankTransactions get_bank_transactions(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp, page_size=page_size, references=references) Retrieves any spent or received money transactions @@ -5021,9 +5607,11 @@ where = 'Status==\"AUTHORISED\"' # str | Filter by an any element (optional) order = 'Type ASC' # str | Order by an any element (optional) page = 1 # int | Up to 100 bank transactions will be returned in a single API call with line items details (optional) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +page_size = 100 # int | Number of records to retrieve per page (optional) +references = ['"Ref1", "Ref2"'] # list[str] | Filter by a comma-separated list of References (optional) try: # Retrieves any spent or received money transactions - api_response = api_instance.get_bank_transactions(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp) + api_response = api_instance.get_bank_transactions(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp, page_size=page_size, references=references) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->get_bank_transactions: %s\n" % e) @@ -5039,6 +5627,8 @@ Name | Type | Description | Notes **order** | **str**| Order by an any element | [optional] **page** | **int**| Up to 100 bank transactions will be returned in a single API call with line items details | [optional] **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **page_size** | **int**| Number of records to retrieve per page | [optional] + **references** | [**list[str]**](str.md)| Filter by a comma-separated list of References | [optional] ### Return type @@ -5442,7 +6032,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_bank_transfers** -> BankTransfers get_bank_transfers(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order) +> BankTransfers get_bank_transfers(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, include_deleted=include_deleted) Retrieves all bank transfers @@ -5476,9 +6066,10 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant if_modified_since = '2020-02-06T12:17:43.202-08:00' # datetime | Only records created or modified since this timestamp will be returned (optional) where = 'HasAttachments==true' # str | Filter by an any element (optional) order = 'Amount ASC' # str | Order by an any element (optional) +include_deleted = true # bool | e.g. includeDeleted=true - Bank transfers with a status of DELETED will be included in the response (optional) try: # Retrieves all bank transfers - api_response = api_instance.get_bank_transfers(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order) + api_response = api_instance.get_bank_transfers(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, include_deleted=include_deleted) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->get_bank_transfers: %s\n" % e) @@ -5492,6 +6083,7 @@ Name | Type | Description | Notes **if_modified_since** | **datetime**| Only records created or modified since this timestamp will be returned | [optional] **where** | **str**| Filter by an any element | [optional] **order** | **str**| Order by an any element | [optional] + **include_deleted** | **bool**| e.g. includeDeleted=true - Bank transfers with a status of DELETED will be included in the response | [optional] ### Return type @@ -5508,6 +6100,69 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_batch_payment** +> BatchPayments get_batch_payment(xero_tenant_id, batch_payment_id) + +Retrieves a specific batch payment using a unique batch payment Id + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.accounting import AccountingApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = AccountingApi(api_client) + +xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant +batch_payment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for BatchPayment +try: + # Retrieves a specific batch payment using a unique batch payment Id + api_response = api_instance.get_batch_payment(xero_tenant_id, batch_payment_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountingApi->get_batch_payment: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **batch_payment_id** | [**str**](.md)| Unique identifier for BatchPayment | + +### Return type + +[**BatchPayments**](BatchPayments.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **get_batch_payment_history** > HistoryRecords get_batch_payment_history(xero_tenant_id, batch_payment_id) @@ -6537,7 +7192,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_contacts** -> Contacts get_contacts(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, i_ds=i_ds, page=page, include_archived=include_archived, summary_only=summary_only, search_term=search_term) +> Contacts get_contacts(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, i_ds=i_ds, page=page, include_archived=include_archived, summary_only=summary_only, search_term=search_term, page_size=page_size) Retrieves all contacts in a Xero organisation @@ -6573,12 +7228,13 @@ where = 'ContactStatus=="ACTIVE"' # str | Filter by an any element (op order = 'Name ASC' # str | Order by an any element (optional) i_ds = ['"00000000-0000-0000-0000-000000000000"'] # list[str] | Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call. (optional) page = 1 # int | e.g. page=1 - Up to 100 contacts will be returned in a single API call. (optional) -include_archived = True # bool | e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response (optional) +include_archived = true # bool | e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response (optional) summary_only = False # bool | Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. (optional) (default to False) -search_term = 'searchTerm=Joe Bloggs' # str | Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields. (optional) +search_term = 'Joe Bloggs' # str | Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields. (optional) +page_size = 100 # int | Number of records to retrieve per page (optional) try: # Retrieves all contacts in a Xero organisation - api_response = api_instance.get_contacts(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, i_ds=i_ds, page=page, include_archived=include_archived, summary_only=summary_only, search_term=search_term) + api_response = api_instance.get_contacts(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, i_ds=i_ds, page=page, include_archived=include_archived, summary_only=summary_only, search_term=search_term, page_size=page_size) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->get_contacts: %s\n" % e) @@ -6597,6 +7253,7 @@ Name | Type | Description | Notes **include_archived** | **bool**| e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response | [optional] **summary_only** | **bool**| Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. | [optional] [default to False] **search_term** | **str**| Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields. | [optional] + **page_size** | **int**| Number of records to retrieve per page | [optional] ### Return type @@ -7002,7 +7659,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_credit_notes** -> CreditNotes get_credit_notes(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp) +> CreditNotes get_credit_notes(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp, page_size=page_size) Retrieves any credit notes @@ -7035,147 +7692,16 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant if_modified_since = '2020-02-06T12:17:43.202-08:00' # datetime | Only records created or modified since this timestamp will be returned (optional) where = 'Status==\"DRAFT\"' # str | Filter by an any element (optional) -order = 'CreditNoteNumber ASC' # str | Order by an any element (optional) -page = 1 # int | e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note (optional) -unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) -try: - # Retrieves any credit notes - api_response = api_instance.get_credit_notes(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp) - pprint(api_response) -except ApiException as e: - print("Exception when calling AccountingApi->get_credit_notes: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **xero_tenant_id** | **str**| Xero identifier for Tenant | - **if_modified_since** | **datetime**| Only records created or modified since this timestamp will be returned | [optional] - **where** | **str**| Filter by an any element | [optional] - **order** | **str**| Order by an any element | [optional] - **page** | **int**| e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note | [optional] - **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] - -### Return type - -[**CreditNotes**](CreditNotes.md) - -### Authorization - -[OAuth2](../README.md#OAuth2) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_currencies** -> Currencies get_currencies(xero_tenant_id, where=where, order=order) - -Retrieves currencies for your Xero organisation - -### Example - -* OAuth Authentication (OAuth2): -```python -from xero_python.api_client import Configuration, ApiClient -from xero_python.api_client.oauth2 import OAuth2Token -from xero_python.exceptions import ApiException -from xero_python.accounting import AccountingApi -from pprint import pprint - -# Configure OAuth2 access token for authorization: OAuth2 -# simplified version, `xero_oauth2_token` represents permanent global token storage -xero_oauth2_token = {} # set to valid xero oauth2 token dictionary -# create client configuration with client id and client secret for automatic token refresh -api_config = Configuration(oauth2_token=OAuth2Token( - client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" -)) -# configure xero-python sdk client -api_client = ApiClient( - api_config, - oauth2_token_saver=lambda x: xero_oauth2_token.update(x), - oauth2_token_getter=lambda : xero_oauth2_token -) -# create an instance of the API class -api_instance = AccountingApi(api_client) - -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -where = 'Code==\"USD\"' # str | Filter by an any element (optional) -order = 'Code ASC' # str | Order by an any element (optional) -try: - # Retrieves currencies for your Xero organisation - api_response = api_instance.get_currencies(xero_tenant_id, where=where, order=order) - pprint(api_response) -except ApiException as e: - print("Exception when calling AccountingApi->get_currencies: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **xero_tenant_id** | **str**| Xero identifier for Tenant | - **where** | **str**| Filter by an any element | [optional] - **order** | **str**| Order by an any element | [optional] - -### Return type - -[**Currencies**](Currencies.md) - -### Authorization - -[OAuth2](../README.md#OAuth2) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_employee** -> Employees get_employee(xero_tenant_id, employee_id) - -Retrieves a specific employee used in Xero payrun using a unique employee Id - -### Example - -* OAuth Authentication (OAuth2): -```python -from xero_python.api_client import Configuration, ApiClient -from xero_python.api_client.oauth2 import OAuth2Token -from xero_python.exceptions import ApiException -from xero_python.accounting import AccountingApi -from pprint import pprint - -# Configure OAuth2 access token for authorization: OAuth2 -# simplified version, `xero_oauth2_token` represents permanent global token storage -xero_oauth2_token = {} # set to valid xero oauth2 token dictionary -# create client configuration with client id and client secret for automatic token refresh -api_config = Configuration(oauth2_token=OAuth2Token( - client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" -)) -# configure xero-python sdk client -api_client = ApiClient( - api_config, - oauth2_token_saver=lambda x: xero_oauth2_token.update(x), - oauth2_token_getter=lambda : xero_oauth2_token -) -# create an instance of the API class -api_instance = AccountingApi(api_client) - -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -employee_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Employee +order = 'CreditNoteNumber ASC' # str | Order by an any element (optional) +page = 1 # int | e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note (optional) +unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +page_size = 100 # int | Number of records to retrieve per page (optional) try: - # Retrieves a specific employee used in Xero payrun using a unique employee Id - api_response = api_instance.get_employee(xero_tenant_id, employee_id) + # Retrieves any credit notes + api_response = api_instance.get_credit_notes(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp, page_size=page_size) pprint(api_response) except ApiException as e: - print("Exception when calling AccountingApi->get_employee: %s\n" % e) + print("Exception when calling AccountingApi->get_credit_notes: %s\n" % e) ``` ### Parameters @@ -7183,11 +7709,16 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | - **employee_id** | [**str**](.md)| Unique identifier for a Employee | + **if_modified_since** | **datetime**| Only records created or modified since this timestamp will be returned | [optional] + **where** | **str**| Filter by an any element | [optional] + **order** | **str**| Order by an any element | [optional] + **page** | **int**| e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note | [optional] + **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **page_size** | **int**| Number of records to retrieve per page | [optional] ### Return type -[**Employees**](Employees.md) +[**CreditNotes**](CreditNotes.md) ### Authorization @@ -7200,10 +7731,10 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_employees** -> Employees get_employees(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order) +# **get_currencies** +> Currencies get_currencies(xero_tenant_id, where=where, order=order) -Retrieves employees used in Xero payrun +Retrieves currencies for your Xero organisation ### Example @@ -7232,15 +7763,14 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -if_modified_since = '2020-02-06T12:17:43.202-08:00' # datetime | Only records created or modified since this timestamp will be returned (optional) -where = 'Status==\"ACTIVE\"' # str | Filter by an any element (optional) -order = 'LastName ASC' # str | Order by an any element (optional) +where = 'Code==\"USD\"' # str | Filter by an any element (optional) +order = 'Code ASC' # str | Order by an any element (optional) try: - # Retrieves employees used in Xero payrun - api_response = api_instance.get_employees(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order) + # Retrieves currencies for your Xero organisation + api_response = api_instance.get_currencies(xero_tenant_id, where=where, order=order) pprint(api_response) except ApiException as e: - print("Exception when calling AccountingApi->get_employees: %s\n" % e) + print("Exception when calling AccountingApi->get_currencies: %s\n" % e) ``` ### Parameters @@ -7248,13 +7778,12 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | - **if_modified_since** | **datetime**| Only records created or modified since this timestamp will be returned | [optional] **where** | **str**| Filter by an any element | [optional] **order** | **str**| Order by an any element | [optional] ### Return type -[**Employees**](Employees.md) +[**Currencies**](Currencies.md) ### Authorization @@ -7910,7 +8439,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_invoices** -> Invoices get_invoices(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, i_ds=i_ds, invoice_numbers=invoice_numbers, contact_i_ds=contact_i_ds, statuses=statuses, page=page, include_archived=include_archived, created_by_my_app=created_by_my_app, unitdp=unitdp, summary_only=summary_only) +> Invoices get_invoices(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, i_ds=i_ds, invoice_numbers=invoice_numbers, contact_i_ds=contact_i_ds, statuses=statuses, page=page, include_archived=include_archived, created_by_my_app=created_by_my_app, unitdp=unitdp, summary_only=summary_only, page_size=page_size, search_term=search_term) Retrieves sales invoices or purchase bills @@ -7949,13 +8478,15 @@ invoice_numbers = ['"INV-001", "INV-002"'] # list[str] | Fil contact_i_ds = ['"00000000-0000-0000-0000-000000000000"'] # list[str] | Filter by a comma-separated list of ContactIDs. (optional) statuses = ['"DRAFT", "SUBMITTED"'] # list[str] | 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. (optional) page = 1 # int | e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice (optional) -include_archived = True # bool | e.g. includeArchived=true - Invoices with a status of ARCHIVED will be included in the response (optional) +include_archived = true # bool | e.g. includeArchived=true - Invoices with a status of ARCHIVED will be included in the response (optional) created_by_my_app = false # bool | When set to true you'll only retrieve Invoices created by your app (optional) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) summary_only = False # bool | Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. (optional) (default to False) +page_size = 100 # int | Number of records to retrieve per page (optional) +search_term = 'SearchTerm=REF12' # str | Search parameter that performs a case-insensitive text search across the fields e.g. InvoiceNumber, Reference. (optional) try: # Retrieves sales invoices or purchase bills - api_response = api_instance.get_invoices(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, i_ds=i_ds, invoice_numbers=invoice_numbers, contact_i_ds=contact_i_ds, statuses=statuses, page=page, include_archived=include_archived, created_by_my_app=created_by_my_app, unitdp=unitdp, summary_only=summary_only) + api_response = api_instance.get_invoices(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, i_ds=i_ds, invoice_numbers=invoice_numbers, contact_i_ds=contact_i_ds, statuses=statuses, page=page, include_archived=include_archived, created_by_my_app=created_by_my_app, unitdp=unitdp, summary_only=summary_only, page_size=page_size, search_term=search_term) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->get_invoices: %s\n" % e) @@ -7978,6 +8509,8 @@ Name | Type | Description | Notes **created_by_my_app** | **bool**| When set to true you'll only retrieve Invoices created by your app | [optional] **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] **summary_only** | **bool**| Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. | [optional] [default to False] + **page_size** | **int**| Number of records to retrieve per page | [optional] + **search_term** | **str**| Search parameter that performs a case-insensitive text search across the fields e.g. InvoiceNumber, Reference. | [optional] ### Return type @@ -8254,6 +8787,69 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_journal_by_number** +> Journals get_journal_by_number(xero_tenant_id, journal_number) + +Retrieves a specific journal using a unique journal number. + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.accounting import AccountingApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = AccountingApi(api_client) + +xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant +journal_number = 1000 # int | Number of a Journal +try: + # Retrieves a specific journal using a unique journal number. + api_response = api_instance.get_journal_by_number(xero_tenant_id, journal_number) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountingApi->get_journal_by_number: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **journal_number** | **int**| Number of a Journal | + +### Return type + +[**Journals**](Journals.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **get_journals** > Journals get_journals(xero_tenant_id, if_modified_since=if_modified_since, offset=offset, payments_only=payments_only) @@ -8288,7 +8884,7 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant if_modified_since = '2020-02-06T12:17:43.202-08:00' # datetime | Only records created or modified since this timestamp will be returned (optional) offset = 10 # int | Offset by a specified journal number. e.g. journals with a JournalNumber greater than the offset will be returned (optional) -payments_only = True # bool | Filter to retrieve journals on a cash basis. Journals are returned on an accrual basis by default. (optional) +payments_only = true # bool | Filter to retrieve journals on a cash basis. Journals are returned on an accrual basis by default. (optional) try: # Retrieves journals api_response = api_instance.get_journals(xero_tenant_id, if_modified_since=if_modified_since, offset=offset, payments_only=payments_only) @@ -8718,7 +9314,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_manual_journals** -> ManualJournals get_manual_journals(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) +> ManualJournals get_manual_journals(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, page_size=page_size) Retrieves manual journals @@ -8753,9 +9349,10 @@ if_modified_since = '2020-02-06T12:17:43.202-08:00' # datetime | Only records cr where = 'Status==\"DRAFT\"' # str | Filter by an any element (optional) order = 'Date ASC' # str | Order by an any element (optional) page = 1 # int | e.g. page=1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment (optional) +page_size = 100 # int | Number of records to retrieve per page (optional) try: # Retrieves manual journals - api_response = api_instance.get_manual_journals(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) + api_response = api_instance.get_manual_journals(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, page_size=page_size) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->get_manual_journals: %s\n" % e) @@ -8770,6 +9367,7 @@ Name | Type | Description | Notes **where** | **str**| Filter by an any element | [optional] **order** | **str**| Order by an any element | [optional] **page** | **int**| e.g. page=1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment | [optional] + **page_size** | **int**| Number of records to retrieve per page | [optional] ### Return type @@ -9224,7 +9822,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_overpayments** -> Overpayments get_overpayments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp) +> Overpayments get_overpayments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp, page_size=page_size, references=references) Retrieves overpayments @@ -9260,9 +9858,11 @@ where = 'Status==\"AUTHORISED\"' # str | Filter by an any element (optional) order = 'Status ASC' # str | Order by an any element (optional) page = 1 # int | e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment (optional) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +page_size = 100 # int | Number of records to retrieve per page (optional) +references = ['"Ref1", "Ref2"'] # list[str] | Filter by a comma-separated list of References (optional) try: # Retrieves overpayments - api_response = api_instance.get_overpayments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp) + api_response = api_instance.get_overpayments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp, page_size=page_size, references=references) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->get_overpayments: %s\n" % e) @@ -9278,6 +9878,8 @@ Name | Type | Description | Notes **order** | **str**| Order by an any element | [optional] **page** | **int**| e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment | [optional] **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **page_size** | **int**| Number of records to retrieve per page | [optional] + **references** | [**list[str]**](str.md)| Filter by a comma-separated list of References | [optional] ### Return type @@ -9482,7 +10084,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_payments** -> Payments get_payments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) +> Payments get_payments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, page_size=page_size) Retrieves payments for invoices and credit notes @@ -9517,9 +10119,10 @@ if_modified_since = '2020-02-06T12:17:43.202-08:00' # datetime | Only records cr where = 'Status==\"AUTHORISED\"' # str | Filter by an any element (optional) order = 'Amount ASC' # str | Order by an any element (optional) page = 1 # int | Up to 100 payments will be returned in a single API call (optional) +page_size = 100 # int | Number of records to retrieve per page (optional) try: # Retrieves payments for invoices and credit notes - api_response = api_instance.get_payments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) + api_response = api_instance.get_payments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, page_size=page_size) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->get_payments: %s\n" % e) @@ -9534,6 +10137,7 @@ Name | Type | Description | Notes **where** | **str**| Filter by an any element | [optional] **order** | **str**| Order by an any element | [optional] **page** | **int**| Up to 100 payments will be returned in a single API call | [optional] + **page_size** | **int**| Number of records to retrieve per page | [optional] ### Return type @@ -9677,7 +10281,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_prepayments** -> Prepayments get_prepayments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp) +> Prepayments get_prepayments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp, page_size=page_size, invoice_numbers=invoice_numbers, references=references) Retrieves prepayments @@ -9711,11 +10315,14 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant if_modified_since = '2020-02-06T12:17:43.202-08:00' # datetime | Only records created or modified since this timestamp will be returned (optional) where = 'Status==\"AUTHORISED\"' # str | Filter by an any element (optional) order = 'Reference ASC' # str | Order by an any element (optional) -page = 1 # int | e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment (optional) +page = 1 # int | e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each prepayment (optional) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +page_size = 100 # int | Number of records to retrieve per page (optional) +invoice_numbers = ['"INV-001", "INV-002"'] # list[str] | Filter by a comma-separated list of InvoiceNumbers (optional) +references = ['"Ref1", "Ref2"'] # list[str] | Filter by a comma-separated list of References (optional) try: # Retrieves prepayments - api_response = api_instance.get_prepayments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp) + api_response = api_instance.get_prepayments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp, page_size=page_size, invoice_numbers=invoice_numbers, references=references) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->get_prepayments: %s\n" % e) @@ -9729,8 +10336,11 @@ Name | Type | Description | Notes **if_modified_since** | **datetime**| Only records created or modified since this timestamp will be returned | [optional] **where** | **str**| Filter by an any element | [optional] **order** | **str**| Order by an any element | [optional] - **page** | **int**| e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment | [optional] + **page** | **int**| e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each prepayment | [optional] **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **page_size** | **int**| Number of records to retrieve per page | [optional] + **invoice_numbers** | [**list[str]**](str.md)| Filter by a comma-separated list of InvoiceNumbers | [optional] + **references** | [**list[str]**](str.md)| Filter by a comma-separated list of References | [optional] ### Return type @@ -10197,7 +10807,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_purchase_orders** -> PurchaseOrders get_purchase_orders(xero_tenant_id, if_modified_since=if_modified_since, status=status, date_from=date_from, date_to=date_to, order=order, page=page) +> PurchaseOrders get_purchase_orders(xero_tenant_id, if_modified_since=if_modified_since, status=status, date_from=date_from, date_to=date_to, order=order, page=page, page_size=page_size) Retrieves purchase orders @@ -10234,9 +10844,10 @@ date_from = '2019-12-01' # str | Filter by purchase order date (e.g. GET https:/ date_to = '2019-12-31' # str | Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31 (optional) order = 'PurchaseOrderNumber ASC' # str | Order by an any element (optional) page = 1 # int | To specify a page, append the page parameter to the URL e.g. ?page=1. If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g ?page=2 and continuing this process until no more results are returned. (optional) +page_size = 100 # int | Number of records to retrieve per page (optional) try: # Retrieves purchase orders - api_response = api_instance.get_purchase_orders(xero_tenant_id, if_modified_since=if_modified_since, status=status, date_from=date_from, date_to=date_to, order=order, page=page) + api_response = api_instance.get_purchase_orders(xero_tenant_id, if_modified_since=if_modified_since, status=status, date_from=date_from, date_to=date_to, order=order, page=page, page_size=page_size) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->get_purchase_orders: %s\n" % e) @@ -10253,6 +10864,7 @@ Name | Type | Description | Notes **date_to** | **str**| Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31 | [optional] **order** | **str**| Order by an any element | [optional] **page** | **int**| To specify a page, append the page parameter to the URL e.g. ?page=1. If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g ?page=2 and continuing this process until no more results are returned. | [optional] + **page_size** | **int**| Number of records to retrieve per page | [optional] ### Return type @@ -12259,8 +12871,71 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_tax_rate_by_tax_type** +> TaxRates get_tax_rate_by_tax_type(xero_tenant_id, tax_type) + +Retrieves a specific tax rate according to given TaxType code + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.accounting import AccountingApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = AccountingApi(api_client) + +xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant +tax_type = 'INPUT2' # str | A valid TaxType code +try: + # Retrieves a specific tax rate according to given TaxType code + api_response = api_instance.get_tax_rate_by_tax_type(xero_tenant_id, tax_type) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountingApi->get_tax_rate_by_tax_type: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **tax_type** | **str**| A valid TaxType code | + +### Return type + +[**TaxRates**](TaxRates.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **get_tax_rates** -> TaxRates get_tax_rates(xero_tenant_id, where=where, order=order, tax_type=tax_type) +> TaxRates get_tax_rates(xero_tenant_id, where=where, order=order) Retrieves tax rates @@ -12293,10 +12968,9 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant where = 'Status==\"ACTIVE\"' # str | Filter by an any element (optional) order = 'Name ASC' # str | Order by an any element (optional) -tax_type = 'INPUT' # str | Filter by tax type (optional) try: # Retrieves tax rates - api_response = api_instance.get_tax_rates(xero_tenant_id, where=where, order=order, tax_type=tax_type) + api_response = api_instance.get_tax_rates(xero_tenant_id, where=where, order=order) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->get_tax_rates: %s\n" % e) @@ -12309,7 +12983,6 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **where** | **str**| Filter by an any element | [optional] **order** | **str**| Order by an any element | [optional] - **tax_type** | **str**| Filter by tax type | [optional] ### Return type @@ -12360,7 +13033,7 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant where = 'Status==\"ACTIVE\"' # str | Filter by an any element (optional) order = 'Name ASC' # str | Order by an any element (optional) -include_archived = True # bool | e.g. includeArchived=true - Categories and options with a status of ARCHIVED will be included in the response (optional) +include_archived = true # bool | e.g. includeArchived=true - Categories and options with a status of ARCHIVED will be included in the response (optional) try: # Retrieves tracking categories and options api_response = api_instance.get_tracking_categories(xero_tenant_id, where=where, order=order, include_archived=include_archived) @@ -12587,7 +13260,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **post_setup** -> ImportSummaryObject post_setup(xero_tenant_id, setup) +> ImportSummaryObject post_setup(xero_tenant_id, setup, idempotency_key=idempotency_key) Sets the chart of accounts, the conversion date and conversion balances @@ -12618,10 +13291,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -setup = { "ConversionDate": {}, "ConversionBalances": [], "Accounts": [ { "Code": "200", "Name": "Sales", "Type": "SALES", "ReportingCode": "REV.TRA.GOO" }, { "Code": "400", "Name": "Advertising", "Type": "OVERHEADS", "ReportingCode": "EXP" }, { "Code": "610", "Name": "Accounts Receivable", "Type": "CURRENT", "SystemAccount": "DEBTORS", "ReportingCode": "ASS.CUR.REC.TRA" }, { "Code": "800", "Name": "Accounts Payable", "Type": "CURRLIAB", "SystemAccount": "CREDITORS", "ReportingCode": "LIA.CUR.PAY" } ] } # Setup | Object including an accounts array, a conversion balances array and a conversion date object in body of request +setup = {"ConversionDate":{},"ConversionBalances":[],"Accounts":[{"Code":"200","Name":"Sales","Type":"SALES","ReportingCode":"REV.TRA.GOO"},{"Code":"400","Name":"Advertising","Type":"OVERHEADS","ReportingCode":"EXP"},{"Code":"610","Name":"Accounts Receivable","Type":"CURRENT","SystemAccount":"DEBTORS","ReportingCode":"ASS.CUR.REC.TRA"},{"Code":"800","Name":"Accounts Payable","Type":"CURRLIAB","SystemAccount":"CREDITORS","ReportingCode":"LIA.CUR.PAY"}]} # Setup | Object including an accounts array, a conversion balances array and a conversion date object in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Sets the chart of accounts, the conversion date and conversion balances - api_response = api_instance.post_setup(xero_tenant_id, setup) + api_response = api_instance.post_setup(xero_tenant_id, setup, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->post_setup: %s\n" % e) @@ -12633,6 +13307,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **setup** | [**Setup**](Setup.md)| Object including an accounts array, a conversion balances array and a conversion date object in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -12650,7 +13325,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_account** -> Accounts update_account(xero_tenant_id, account_id, accounts) +> Accounts update_account(xero_tenant_id, account_id, accounts, idempotency_key=idempotency_key) Updates a chart of accounts @@ -12682,10 +13357,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant account_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for Account object -accounts = { "Accounts":[ { "Code":"123456", "Name":"BarFoo", "AccountID":"99ce6032-0678-4aa0-8148-240c75fee33a", "Type":"EXPENSE", "Description":"GoodBye World", "TaxType":"INPUT", "EnablePaymentsToAccount":false, "ShowInExpenseClaims":false, "Class":"EXPENSE", "ReportingCode":"EXP", "ReportingCodeName":"Expense", "UpdatedDateUTC":"2019-02-21T16:29:47.96-08:00" } ] } # Accounts | Request of type Accounts array with one Account +accounts = {"Accounts":[{"Code":"123456","Name":"BarFoo","AccountID":"99ce6032-0678-4aa0-8148-240c75fee33a","Type":"EXPENSE","Description":"GoodBye World","TaxType":"INPUT","EnablePaymentsToAccount":false,"ShowInExpenseClaims":false,"Class":"EXPENSE","ReportingCode":"EXP","ReportingCodeName":"Expense","UpdatedDateUTC":"2019-02-21T16:29:47.96-08:00"}]} # Accounts | Request of type Accounts array with one Account +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a chart of accounts - api_response = api_instance.update_account(xero_tenant_id, account_id, accounts) + api_response = api_instance.update_account(xero_tenant_id, account_id, accounts, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_account: %s\n" % e) @@ -12698,6 +13374,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **account_id** | [**str**](.md)| Unique identifier for Account object | **accounts** | [**Accounts**](Accounts.md)| Request of type Accounts array with one Account | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -12715,7 +13392,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_account_attachment_by_file_name** -> Attachments update_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body) +> Attachments update_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body, idempotency_key=idempotency_key) Updates attachment on a specific account by filename @@ -12749,9 +13426,10 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant account_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for Account object file_name = 'xero-dev.jpg' # str | Name of the attachment body = 'body_example' # str | Byte array of file in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates attachment on a specific account by filename - api_response = api_instance.update_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body) + api_response = api_instance.update_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_account_attachment_by_file_name: %s\n" % e) @@ -12765,6 +13443,7 @@ Name | Type | Description | Notes **account_id** | [**str**](.md)| Unique identifier for Account object | **file_name** | **str**| Name of the attachment | **body** | **str**| Byte array of file in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -12782,7 +13461,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_bank_transaction** -> BankTransactions update_bank_transaction(xero_tenant_id, bank_transaction_id, bank_transactions, unitdp=unitdp) +> BankTransactions update_bank_transaction(xero_tenant_id, bank_transaction_id, bank_transactions, unitdp=unitdp, idempotency_key=idempotency_key) Updates a single spent or received money transaction @@ -12814,11 +13493,12 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant bank_transaction_id = '00000000-0000-0000-0000-000000000000' # str | Xero generated unique identifier for a bank transaction -bank_transactions = { "BankTransactions": [ { "Type": "SPEND", "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000", "ContactStatus": "ACTIVE", "Name": "Buzz Lightyear", "FirstName": "Buzz", "LastName": "Lightyear", "EmailAddress": "buzz.Lightyear@email.com", "ContactPersons": [], "BankAccountDetails": "", "Addresses": [ { "AddressType": "STREET", "City": "", "Region": "", "PostalCode": "", "Country": "" }, { "AddressType": "POBOX", "AddressLine1": "", "AddressLine2": "", "AddressLine3": "", "AddressLine4": "", "City": "Palo Alto", "Region": "CA", "PostalCode": "94020", "Country": "United States" } ], "Phones": [ { "PhoneType": "DEFAULT", "PhoneNumber": "847-1294", "PhoneAreaCode": "(626)", "PhoneCountryCode": "" }, { "PhoneType": "DDI", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "FAX", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "MOBILE", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" } ], "UpdatedDateUTC": "2017-08-21T13:49:04.227-07:00", "ContactGroups": [] }, "Lineitems": [], "BankAccount": { "Code": "088", "Name": "Business Wells Fargo", "AccountID": "00000000-0000-0000-0000-000000000000" }, "IsReconciled": false, "Date": "2019-02-25", "Reference": "You just updated", "CurrencyCode": "USD", "CurrencyRate": 1, "Status": "AUTHORISED", "LineAmountTypes": "Inclusive", "TotalTax": 1.74, "BankTransactionID": "00000000-0000-0000-0000-000000000000", "UpdatedDateUTC": "2019-02-26T12:39:27.813-08:00" } ] } # BankTransactions | +bank_transactions = {"BankTransactions":[{"Type":"SPEND","Contact":{"ContactID":"00000000-0000-0000-0000-000000000000","ContactStatus":"ACTIVE","Name":"Buzz Lightyear","FirstName":"Buzz","LastName":"Lightyear","EmailAddress":"buzz.Lightyear@email.com","ContactPersons":[],"BankAccountDetails":"","Addresses":[{"AddressType":"STREET","City":"","Region":"","PostalCode":"","Country":""},{"AddressType":"POBOX","AddressLine1":"","AddressLine2":"","AddressLine3":"","AddressLine4":"","City":"Palo Alto","Region":"CA","PostalCode":"94020","Country":"United States"}],"Phones":[{"PhoneType":"DEFAULT","PhoneNumber":"847-1294","PhoneAreaCode":"(626)","PhoneCountryCode":""},{"PhoneType":"DDI","PhoneNumber":"","PhoneAreaCode":"","PhoneCountryCode":""},{"PhoneType":"FAX","PhoneNumber":"","PhoneAreaCode":"","PhoneCountryCode":""},{"PhoneType":"MOBILE","PhoneNumber":"","PhoneAreaCode":"","PhoneCountryCode":""}],"UpdatedDateUTC":"2017-08-21T13:49:04.227-07:00","ContactGroups":[]},"Lineitems":[],"BankAccount":{"Code":"088","Name":"Business Wells Fargo","AccountID":"00000000-0000-0000-0000-000000000000"},"IsReconciled":false,"Date":"2019-02-25","Reference":"You just updated","CurrencyCode":"USD","CurrencyRate":1,"Status":"AUTHORISED","LineAmountTypes":"Inclusive","TotalTax":1.74,"BankTransactionID":"00000000-0000-0000-0000-000000000000","UpdatedDateUTC":"2019-02-26T12:39:27.813-08:00"}]} # BankTransactions | unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a single spent or received money transaction - api_response = api_instance.update_bank_transaction(xero_tenant_id, bank_transaction_id, bank_transactions, unitdp=unitdp) + api_response = api_instance.update_bank_transaction(xero_tenant_id, bank_transaction_id, bank_transactions, unitdp=unitdp, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_bank_transaction: %s\n" % e) @@ -12832,6 +13512,7 @@ Name | Type | Description | Notes **bank_transaction_id** | [**str**](.md)| Xero generated unique identifier for a bank transaction | **bank_transactions** | [**BankTransactions**](BankTransactions.md)| | **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -12849,7 +13530,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_bank_transaction_attachment_by_file_name** -> Attachments update_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body) +> Attachments update_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body, idempotency_key=idempotency_key) Updates a specific attachment from a specific bank transaction by filename @@ -12883,9 +13564,10 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant bank_transaction_id = '00000000-0000-0000-0000-000000000000' # str | Xero generated unique identifier for a bank transaction file_name = 'xero-dev.jpg' # str | Name of the attachment body = 'body_example' # str | Byte array of file in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a specific attachment from a specific bank transaction by filename - api_response = api_instance.update_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body) + api_response = api_instance.update_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_bank_transaction_attachment_by_file_name: %s\n" % e) @@ -12899,6 +13581,7 @@ Name | Type | Description | Notes **bank_transaction_id** | [**str**](.md)| Xero generated unique identifier for a bank transaction | **file_name** | **str**| Name of the attachment | **body** | **str**| Byte array of file in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -12916,7 +13599,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_bank_transfer_attachment_by_file_name** -> Attachments update_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body) +> Attachments update_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body, idempotency_key=idempotency_key) @@ -12950,8 +13633,9 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant bank_transfer_id = '00000000-0000-0000-0000-000000000000' # str | Xero generated unique identifier for a bank transfer file_name = 'xero-dev.jpg' # str | Name of the attachment body = 'body_example' # str | Byte array of file in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: - api_response = api_instance.update_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body) + api_response = api_instance.update_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_bank_transfer_attachment_by_file_name: %s\n" % e) @@ -12965,6 +13649,7 @@ Name | Type | Description | Notes **bank_transfer_id** | [**str**](.md)| Xero generated unique identifier for a bank transfer | **file_name** | **str**| Name of the attachment | **body** | **str**| Byte array of file in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -12982,7 +13667,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_contact** -> Contacts update_contact(xero_tenant_id, contact_id, contacts) +> Contacts update_contact(xero_tenant_id, contact_id, contacts, idempotency_key=idempotency_key) Updates a specific contact in a Xero organisation @@ -13014,10 +13699,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant contact_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Contact -contacts = { "Contacts": [{ "ContactID": "00000000-0000-0000-0000-000000000000", "Name": "Thanos" }]} # Contacts | an array of Contacts containing single Contact object with properties to update +contacts = {"Contacts":[{"ContactID":"00000000-0000-0000-0000-000000000000","Name":"Thanos"}]} # Contacts | an array of Contacts containing single Contact object with properties to update +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a specific contact in a Xero organisation - api_response = api_instance.update_contact(xero_tenant_id, contact_id, contacts) + api_response = api_instance.update_contact(xero_tenant_id, contact_id, contacts, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_contact: %s\n" % e) @@ -13030,6 +13716,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **contact_id** | [**str**](.md)| Unique identifier for a Contact | **contacts** | [**Contacts**](Contacts.md)| an array of Contacts containing single Contact object with properties to update | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13047,7 +13734,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_contact_attachment_by_file_name** -> Attachments update_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body) +> Attachments update_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body, idempotency_key=idempotency_key) @@ -13081,8 +13768,9 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant contact_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Contact file_name = 'xero-dev.jpg' # str | Name of the attachment body = 'body_example' # str | Byte array of file in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: - api_response = api_instance.update_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body) + api_response = api_instance.update_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_contact_attachment_by_file_name: %s\n" % e) @@ -13096,6 +13784,7 @@ Name | Type | Description | Notes **contact_id** | [**str**](.md)| Unique identifier for a Contact | **file_name** | **str**| Name of the attachment | **body** | **str**| Byte array of file in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13113,7 +13802,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_contact_group** -> ContactGroups update_contact_group(xero_tenant_id, contact_group_id, contact_groups) +> ContactGroups update_contact_group(xero_tenant_id, contact_group_id, contact_groups, idempotency_key=idempotency_key) Updates a specific contact group @@ -13145,10 +13834,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant contact_group_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Contact Group -contact_groups = { "ContactGroups":[ { "Name":"Suppliers" } ] } # ContactGroups | an array of Contact groups with Name of specific group to update +contact_groups = {"ContactGroups":[{"Name":"Suppliers"}]} # ContactGroups | an array of Contact groups with Name of specific group to update +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a specific contact group - api_response = api_instance.update_contact_group(xero_tenant_id, contact_group_id, contact_groups) + api_response = api_instance.update_contact_group(xero_tenant_id, contact_group_id, contact_groups, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_contact_group: %s\n" % e) @@ -13161,6 +13851,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **contact_group_id** | [**str**](.md)| Unique identifier for a Contact Group | **contact_groups** | [**ContactGroups**](ContactGroups.md)| an array of Contact groups with Name of specific group to update | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13178,7 +13869,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_credit_note** -> CreditNotes update_credit_note(xero_tenant_id, credit_note_id, credit_notes, unitdp=unitdp) +> CreditNotes update_credit_note(xero_tenant_id, credit_note_id, credit_notes, unitdp=unitdp, idempotency_key=idempotency_key) Updates a specific credit note @@ -13210,11 +13901,12 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant credit_note_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Credit Note -credit_notes = { "CreditNotes": [ { "Type": "ACCPAYCREDIT", "Contact": { "ContactID": "430fa14a-f945-44d3-9f97-5df5e28441b8" }, "Date": "2019-01-05", "Status": "AUTHORISED", "Reference": "HelloWorld", "LineItems": [ { "Description": "Foobar", "Quantity": 2, "UnitAmount": 20, "AccountCode": "400" } ] } ] } # CreditNotes | an array of Credit Notes containing credit note details to update +credit_notes = {"CreditNotes":[{"Type":"ACCPAYCREDIT","Contact":{"ContactID":"430fa14a-f945-44d3-9f97-5df5e28441b8"},"Date":"2019-01-05","Status":"AUTHORISED","Reference":"HelloWorld","SentToContact":true,"LineItems":[{"Description":"Foobar","Quantity":2,"UnitAmount":20,"AccountCode":"400"}]}]} # CreditNotes | an array of Credit Notes containing credit note details to update unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a specific credit note - api_response = api_instance.update_credit_note(xero_tenant_id, credit_note_id, credit_notes, unitdp=unitdp) + api_response = api_instance.update_credit_note(xero_tenant_id, credit_note_id, credit_notes, unitdp=unitdp, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_credit_note: %s\n" % e) @@ -13228,6 +13920,7 @@ Name | Type | Description | Notes **credit_note_id** | [**str**](.md)| Unique identifier for a Credit Note | **credit_notes** | [**CreditNotes**](CreditNotes.md)| an array of Credit Notes containing credit note details to update | **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13245,7 +13938,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_credit_note_attachment_by_file_name** -> Attachments update_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body) +> Attachments update_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body, idempotency_key=idempotency_key) Updates attachments on a specific credit note by file name @@ -13279,9 +13972,10 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant credit_note_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Credit Note file_name = 'xero-dev.jpg' # str | Name of the attachment body = 'body_example' # str | Byte array of file in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates attachments on a specific credit note by file name - api_response = api_instance.update_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body) + api_response = api_instance.update_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_credit_note_attachment_by_file_name: %s\n" % e) @@ -13295,6 +13989,7 @@ Name | Type | Description | Notes **credit_note_id** | [**str**](.md)| Unique identifier for a Credit Note | **file_name** | **str**| Name of the attachment | **body** | **str**| Byte array of file in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13312,7 +14007,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_expense_claim** -> ExpenseClaims update_expense_claim(xero_tenant_id, expense_claim_id, expense_claims) +> ExpenseClaims update_expense_claim(xero_tenant_id, expense_claim_id, expense_claims, idempotency_key=idempotency_key) Updates a specific expense claims @@ -13344,10 +14039,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant expense_claim_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a ExpenseClaim -expense_claims = { "ExpenseClaims": [ { "Status": "SUBMITTED", "User": { "UserID": "d1164823-0ac1-41ad-987b-b4e30fe0b273" }, "Receipts": [ { "Lineitems": [], "ReceiptID": "dc1c7f6d-0a4c-402f-acac-551d62ce5816" } ] } ] } # ExpenseClaims | +expense_claims = {"ExpenseClaims":[{"Status":"SUBMITTED","User":{"UserID":"d1164823-0ac1-41ad-987b-b4e30fe0b273"},"Receipts":[{"Lineitems":[],"ReceiptID":"dc1c7f6d-0a4c-402f-acac-551d62ce5816"}]}]} # ExpenseClaims | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a specific expense claims - api_response = api_instance.update_expense_claim(xero_tenant_id, expense_claim_id, expense_claims) + api_response = api_instance.update_expense_claim(xero_tenant_id, expense_claim_id, expense_claims, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_expense_claim: %s\n" % e) @@ -13360,6 +14056,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **expense_claim_id** | [**str**](.md)| Unique identifier for a ExpenseClaim | **expense_claims** | [**ExpenseClaims**](ExpenseClaims.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13377,7 +14074,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_invoice** -> Invoices update_invoice(xero_tenant_id, invoice_id, invoices, unitdp=unitdp) +> Invoices update_invoice(xero_tenant_id, invoice_id, invoices, unitdp=unitdp, idempotency_key=idempotency_key, allow_backorders=allow_backorders) Updates a specific sales invoices or purchase bills @@ -13409,11 +14106,13 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Invoice -invoices = { "Invoices": [{ Reference: "May the force be with you", "InvoiceID": "00000000-0000-0000-0000-000000000000", "LineItems": [], "Contact": {}, "Type": "ACCPAY" }]} # Invoices | +invoices = {"Invoices":[{"Reference":"May the force be with you","InvoiceID":"00000000-0000-0000-0000-000000000000","LineItems":[],"Contact":{},"Type":"ACCPAY"}]} # Invoices | unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) +allow_backorders = true # bool | Allows an invoice to be created even when one or more line items contain tracked inventory where the invoice quantity would cause the available quantity to go negative (optional) try: # Updates a specific sales invoices or purchase bills - api_response = api_instance.update_invoice(xero_tenant_id, invoice_id, invoices, unitdp=unitdp) + api_response = api_instance.update_invoice(xero_tenant_id, invoice_id, invoices, unitdp=unitdp, idempotency_key=idempotency_key, allow_backorders=allow_backorders) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_invoice: %s\n" % e) @@ -13427,6 +14126,8 @@ Name | Type | Description | Notes **invoice_id** | [**str**](.md)| Unique identifier for an Invoice | **invoices** | [**Invoices**](Invoices.md)| | **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] + **allow_backorders** | **bool**| Allows an invoice to be created even when one or more line items contain tracked inventory where the invoice quantity would cause the available quantity to go negative | [optional] ### Return type @@ -13444,7 +14145,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_invoice_attachment_by_file_name** -> Attachments update_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body) +> Attachments update_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body, idempotency_key=idempotency_key) Updates an attachment from a specific invoices or purchase bill by filename @@ -13478,9 +14179,10 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Invoice file_name = 'xero-dev.jpg' # str | Name of the attachment body = 'body_example' # str | Byte array of file in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates an attachment from a specific invoices or purchase bill by filename - api_response = api_instance.update_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body) + api_response = api_instance.update_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_invoice_attachment_by_file_name: %s\n" % e) @@ -13494,6 +14196,7 @@ Name | Type | Description | Notes **invoice_id** | [**str**](.md)| Unique identifier for an Invoice | **file_name** | **str**| Name of the attachment | **body** | **str**| Byte array of file in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13511,7 +14214,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_item** -> Items update_item(xero_tenant_id, item_id, items, unitdp=unitdp) +> Items update_item(xero_tenant_id, item_id, items, unitdp=unitdp, idempotency_key=idempotency_key) Updates a specific item @@ -13543,11 +14246,12 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant item_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Item -items = { "Items": [ { "Code": "ItemCode123", "Description": "Description 123" } ] } # Items | +items = {"Items":[{"Code":"ItemCode123","Description":"Description 123"}]} # Items | unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a specific item - api_response = api_instance.update_item(xero_tenant_id, item_id, items, unitdp=unitdp) + api_response = api_instance.update_item(xero_tenant_id, item_id, items, unitdp=unitdp, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_item: %s\n" % e) @@ -13561,6 +14265,7 @@ Name | Type | Description | Notes **item_id** | [**str**](.md)| Unique identifier for an Item | **items** | [**Items**](Items.md)| | **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13578,7 +14283,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_linked_transaction** -> LinkedTransactions update_linked_transaction(xero_tenant_id, linked_transaction_id, linked_transactions) +> LinkedTransactions update_linked_transaction(xero_tenant_id, linked_transaction_id, linked_transactions, idempotency_key=idempotency_key) Updates a specific linked transactions (billable expenses) @@ -13610,10 +14315,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant linked_transaction_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a LinkedTransaction -linked_transactions = { "LinkedTransactions": [ { "SourceTransactionID": "00000000-0000-0000-0000-000000000000", "SourceLineItemID": "00000000-0000-0000-0000-000000000000" } ] } # LinkedTransactions | +linked_transactions = {"LinkedTransactions":[{"SourceTransactionID":"00000000-0000-0000-0000-000000000000","SourceLineItemID":"00000000-0000-0000-0000-000000000000"}]} # LinkedTransactions | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a specific linked transactions (billable expenses) - api_response = api_instance.update_linked_transaction(xero_tenant_id, linked_transaction_id, linked_transactions) + api_response = api_instance.update_linked_transaction(xero_tenant_id, linked_transaction_id, linked_transactions, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_linked_transaction: %s\n" % e) @@ -13626,6 +14332,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **linked_transaction_id** | [**str**](.md)| Unique identifier for a LinkedTransaction | **linked_transactions** | [**LinkedTransactions**](LinkedTransactions.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13643,7 +14350,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_manual_journal** -> ManualJournals update_manual_journal(xero_tenant_id, manual_journal_id, manual_journals) +> ManualJournals update_manual_journal(xero_tenant_id, manual_journal_id, manual_journals, idempotency_key=idempotency_key) Updates a specific manual journal @@ -13675,10 +14382,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant manual_journal_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a ManualJournal -manual_journals = { "ManualJournals": [ { "Narration": "Hello Xero", "ManualJournalID": "00000000-0000-0000-0000-000000000000", "JournalLines": [] } ] } # ManualJournals | +manual_journals = {"ManualJournals":[{"Narration":"Hello Xero","ManualJournalID":"00000000-0000-0000-0000-000000000000","JournalLines":[]}]} # ManualJournals | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a specific manual journal - api_response = api_instance.update_manual_journal(xero_tenant_id, manual_journal_id, manual_journals) + api_response = api_instance.update_manual_journal(xero_tenant_id, manual_journal_id, manual_journals, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_manual_journal: %s\n" % e) @@ -13691,6 +14399,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **manual_journal_id** | [**str**](.md)| Unique identifier for a ManualJournal | **manual_journals** | [**ManualJournals**](ManualJournals.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13708,7 +14417,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_manual_journal_attachment_by_file_name** -> Attachments update_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body) +> Attachments update_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body, idempotency_key=idempotency_key) Updates a specific attachment from a specific manual journal by file name @@ -13742,9 +14451,10 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant manual_journal_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a ManualJournal file_name = 'xero-dev.jpg' # str | Name of the attachment body = 'body_example' # str | Byte array of file in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a specific attachment from a specific manual journal by file name - api_response = api_instance.update_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body) + api_response = api_instance.update_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_manual_journal_attachment_by_file_name: %s\n" % e) @@ -13758,6 +14468,7 @@ Name | Type | Description | Notes **manual_journal_id** | [**str**](.md)| Unique identifier for a ManualJournal | **file_name** | **str**| Name of the attachment | **body** | **str**| Byte array of file in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13775,7 +14486,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_or_create_bank_transactions** -> BankTransactions update_or_create_bank_transactions(xero_tenant_id, bank_transactions, summarize_errors=summarize_errors, unitdp=unitdp) +> BankTransactions update_or_create_bank_transactions(xero_tenant_id, bank_transactions, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key) Updates or creates one or more spent or received money transaction @@ -13806,12 +14517,13 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -bank_transactions = { "BankTransactions": [ { "Type": "SPEND", "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "Lineitems": [ { "Description": "Foobar", "Quantity": 1, "UnitAmount": 20, "AccountCode": "400" } ], "BankAccount": { "Code": "088" } } ] } # BankTransactions | +bank_transactions = {"BankTransactions":[{"Type":"SPEND","Contact":{"ContactID":"00000000-0000-0000-0000-000000000000"},"Lineitems":[{"Description":"Foobar","Quantity":1,"UnitAmount":20,"AccountCode":"400"}],"BankAccount":{"Code":"088"}}]} # BankTransactions | summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates or creates one or more spent or received money transaction - api_response = api_instance.update_or_create_bank_transactions(xero_tenant_id, bank_transactions, summarize_errors=summarize_errors, unitdp=unitdp) + api_response = api_instance.update_or_create_bank_transactions(xero_tenant_id, bank_transactions, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_or_create_bank_transactions: %s\n" % e) @@ -13825,6 +14537,7 @@ Name | Type | Description | Notes **bank_transactions** | [**BankTransactions**](BankTransactions.md)| | **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13842,7 +14555,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_or_create_contacts** -> Contacts update_or_create_contacts(xero_tenant_id, contacts, summarize_errors=summarize_errors) +> Contacts update_or_create_contacts(xero_tenant_id, contacts, summarize_errors=summarize_errors, idempotency_key=idempotency_key) Updates or creates one or more contacts in a Xero organisation @@ -13873,11 +14586,12 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -contacts = { "Contacts": [ { "Name": "Bruce Banner", "EmailAddress": "hulk@avengers.com", "Phones": [ { "PhoneType": "MOBILE", "PhoneNumber": "555-1212", "PhoneAreaCode": "415" } ], "PaymentTerms": { "Bills": { "Day": 15, "Type": "OFCURRENTMONTH" }, "Sales": { "Day": 10, "Type": "DAYSAFTERBILLMONTH" } } } ] } # Contacts | +contacts = {"Contacts":[{"Name":"Bruce Banner","EmailAddress":"hulk@avengers.com","Phones":[{"PhoneType":"MOBILE","PhoneNumber":"555-1212","PhoneAreaCode":"415"}],"PaymentTerms":{"Bills":{"Day":15,"Type":"OFCURRENTMONTH"},"Sales":{"Day":10,"Type":"DAYSAFTERBILLMONTH"}}}]} # Contacts | summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates or creates one or more contacts in a Xero organisation - api_response = api_instance.update_or_create_contacts(xero_tenant_id, contacts, summarize_errors=summarize_errors) + api_response = api_instance.update_or_create_contacts(xero_tenant_id, contacts, summarize_errors=summarize_errors, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_or_create_contacts: %s\n" % e) @@ -13890,6 +14604,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **contacts** | [**Contacts**](Contacts.md)| | **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13907,7 +14622,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_or_create_credit_notes** -> CreditNotes update_or_create_credit_notes(xero_tenant_id, credit_notes, summarize_errors=summarize_errors, unitdp=unitdp) +> CreditNotes update_or_create_credit_notes(xero_tenant_id, credit_notes, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key) Updates or creates one or more credit notes @@ -13938,12 +14653,13 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -credit_notes = { "CreditNotes":[ { "Type":"ACCPAYCREDIT", "Contact":{ "ContactID":"430fa14a-f945-44d3-9f97-5df5e28441b8" }, "Date":"2019-01-05", "Status":"AUTHORISED", "Reference": "HelloWorld", "LineItems":[ { "Description":"Foobar", "Quantity":2.0, "UnitAmount":20.0, "AccountCode":"400" } ] } ] } # CreditNotes | an array of Credit Notes with a single CreditNote object. +credit_notes = {"CreditNotes":[{"Type":"ACCPAYCREDIT","Contact":{"ContactID":"430fa14a-f945-44d3-9f97-5df5e28441b8"},"Date":"2019-01-05","Status":"AUTHORISED","Reference":"HelloWorld","LineItems":[{"Description":"Foobar","Quantity":2.0,"UnitAmount":20.0,"AccountCode":"400"}]}]} # CreditNotes | an array of Credit Notes with a single CreditNote object. summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates or creates one or more credit notes - api_response = api_instance.update_or_create_credit_notes(xero_tenant_id, credit_notes, summarize_errors=summarize_errors, unitdp=unitdp) + api_response = api_instance.update_or_create_credit_notes(xero_tenant_id, credit_notes, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_or_create_credit_notes: %s\n" % e) @@ -13957,6 +14673,7 @@ Name | Type | Description | Notes **credit_notes** | [**CreditNotes**](CreditNotes.md)| an array of Credit Notes with a single CreditNote object. | **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13973,10 +14690,10 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **update_or_create_employees** -> Employees update_or_create_employees(xero_tenant_id, employees, summarize_errors=summarize_errors) +# **update_or_create_invoices** +> Invoices update_or_create_invoices(xero_tenant_id, invoices, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key, allow_backorders=allow_backorders) -Creates a single new employees used in Xero payrun +Updates or creates one or more sales invoices or purchase bills ### Example @@ -14005,14 +14722,17 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -employees = { "Employees": [ { "FirstName": "Nick", "LastName": "Fury", "ExternalLink": { "Url": "http://twitter.com/#!/search/Nick+Fury" } } ] } # Employees | Employees with array of Employee object in body of request +invoices = {"Invoices":[{"Type":"ACCREC","Contact":{"ContactID":"430fa14a-f945-44d3-9f97-5df5e28441b8"},"LineItems":[{"Description":"Acme Tires","Quantity":2,"UnitAmount":20,"AccountCode":"200","TaxType":"NONE","LineAmount":40}],"Date":"2019-03-11","DueDate":"2018-12-10","Reference":"Website Design","Status":"AUTHORISED"}]} # Invoices | summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) +allow_backorders = true # bool | Allows an invoice to be created even when one or more line items contain tracked inventory where the invoice quantity would cause the available quantity to go negative (optional) try: - # Creates a single new employees used in Xero payrun - api_response = api_instance.update_or_create_employees(xero_tenant_id, employees, summarize_errors=summarize_errors) + # Updates or creates one or more sales invoices or purchase bills + api_response = api_instance.update_or_create_invoices(xero_tenant_id, invoices, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key, allow_backorders=allow_backorders) pprint(api_response) except ApiException as e: - print("Exception when calling AccountingApi->update_or_create_employees: %s\n" % e) + print("Exception when calling AccountingApi->update_or_create_invoices: %s\n" % e) ``` ### Parameters @@ -14020,12 +14740,15 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | - **employees** | [**Employees**](Employees.md)| Employees with array of Employee object in body of request | + **invoices** | [**Invoices**](Invoices.md)| | **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] + **allow_backorders** | **bool**| Allows an invoice to be created even when one or more line items contain tracked inventory where the invoice quantity would cause the available quantity to go negative | [optional] ### Return type -[**Employees**](Employees.md) +[**Invoices**](Invoices.md) ### Authorization @@ -14038,10 +14761,10 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **update_or_create_invoices** -> Invoices update_or_create_invoices(xero_tenant_id, invoices, summarize_errors=summarize_errors, unitdp=unitdp) +# **update_or_create_items** +> Items update_or_create_items(xero_tenant_id, items, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key) -Updates or creates one or more sales invoices or purchase bills +Updates or creates one or more items ### Example @@ -14070,15 +14793,16 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -invoices = { "Invoices": [ { "Type": "ACCREC", "Contact": { "ContactID": "430fa14a-f945-44d3-9f97-5df5e28441b8" }, "LineItems": [ { "Description": "Acme Tires", "Quantity": 2, "UnitAmount": 20, "AccountCode": "200", "TaxType": "NONE", "LineAmount": 40 } ], "Date": "2019-03-11", "DueDate": "2018-12-10", "Reference": "Website Design", "Status": "AUTHORISED" } ] } # Invoices | +items = {"Items":[{"Code":"ItemCode123","Name":"ItemName XYZ","Description":"Item Description ABC"}]} # Items | summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: - # Updates or creates one or more sales invoices or purchase bills - api_response = api_instance.update_or_create_invoices(xero_tenant_id, invoices, summarize_errors=summarize_errors, unitdp=unitdp) + # Updates or creates one or more items + api_response = api_instance.update_or_create_items(xero_tenant_id, items, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: - print("Exception when calling AccountingApi->update_or_create_invoices: %s\n" % e) + print("Exception when calling AccountingApi->update_or_create_items: %s\n" % e) ``` ### Parameters @@ -14086,13 +14810,14 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | - **invoices** | [**Invoices**](Invoices.md)| | + **items** | [**Items**](Items.md)| | **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type -[**Invoices**](Invoices.md) +[**Items**](Items.md) ### Authorization @@ -14105,10 +14830,10 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **update_or_create_items** -> Items update_or_create_items(xero_tenant_id, items, summarize_errors=summarize_errors, unitdp=unitdp) +# **update_or_create_manual_journals** +> ManualJournals update_or_create_manual_journals(xero_tenant_id, manual_journals, summarize_errors=summarize_errors, idempotency_key=idempotency_key) -Updates or creates one or more items +Updates or creates a single manual journal ### Example @@ -14137,15 +14862,15 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -items = { "Items": [ { "Code": "ItemCode123", "Name": "ItemName XYZ", "Description": "Item Description ABC" } ] } # Items | +manual_journals = {"ManualJournals":[{"Narration":"Journal Desc","JournalLines":[{"LineAmount":100,"AccountCode":"400","Description":"Money Movement"},{"LineAmount":-100,"AccountCode":"400","Description":"Prepayment of things","Tracking":[{"Name":"North","Option":"Region"}]}],"Date":"2019-03-14"}]} # ManualJournals | ManualJournals array with ManualJournal object in body of request summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) -unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: - # Updates or creates one or more items - api_response = api_instance.update_or_create_items(xero_tenant_id, items, summarize_errors=summarize_errors, unitdp=unitdp) + # Updates or creates a single manual journal + api_response = api_instance.update_or_create_manual_journals(xero_tenant_id, manual_journals, summarize_errors=summarize_errors, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: - print("Exception when calling AccountingApi->update_or_create_items: %s\n" % e) + print("Exception when calling AccountingApi->update_or_create_manual_journals: %s\n" % e) ``` ### Parameters @@ -14153,13 +14878,13 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | - **items** | [**Items**](Items.md)| | + **manual_journals** | [**ManualJournals**](ManualJournals.md)| ManualJournals array with ManualJournal object in body of request | **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] - **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type -[**Items**](Items.md) +[**ManualJournals**](ManualJournals.md) ### Authorization @@ -14172,10 +14897,10 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **update_or_create_manual_journals** -> ManualJournals update_or_create_manual_journals(xero_tenant_id, manual_journals, summarize_errors=summarize_errors) +# **update_or_create_purchase_orders** +> PurchaseOrders update_or_create_purchase_orders(xero_tenant_id, purchase_orders, summarize_errors=summarize_errors, idempotency_key=idempotency_key) -Updates or creates a single manual journal +Updates or creates one or more purchase orders ### Example @@ -14204,14 +14929,15 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -manual_journals = { "ManualJournals": [ { "Narration": "Journal Desc", "JournalLines": [ { "LineAmount": 100, "AccountCode": "400", "Description": "Money Movement" }, { "LineAmount": -100, "AccountCode": "400", "Description": "Prepayment of things", "Tracking": [ { "Name": "North", "Option": "Region" } ] } ], "Date": "2019-03-14" } ] } # ManualJournals | ManualJournals array with ManualJournal object in body of request +purchase_orders = {"PurchaseOrders":[{"Contact":{"ContactID":"00000000-0000-0000-0000-000000000000"},"LineItems":[{"Description":"Foobar","Quantity":1,"UnitAmount":20,"AccountCode":"710"}],"Date":"2019-03-13"}]} # PurchaseOrders | summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: - # Updates or creates a single manual journal - api_response = api_instance.update_or_create_manual_journals(xero_tenant_id, manual_journals, summarize_errors=summarize_errors) + # Updates or creates one or more purchase orders + api_response = api_instance.update_or_create_purchase_orders(xero_tenant_id, purchase_orders, summarize_errors=summarize_errors, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: - print("Exception when calling AccountingApi->update_or_create_manual_journals: %s\n" % e) + print("Exception when calling AccountingApi->update_or_create_purchase_orders: %s\n" % e) ``` ### Parameters @@ -14219,12 +14945,13 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | - **manual_journals** | [**ManualJournals**](ManualJournals.md)| ManualJournals array with ManualJournal object in body of request | + **purchase_orders** | [**PurchaseOrders**](PurchaseOrders.md)| | **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type -[**ManualJournals**](ManualJournals.md) +[**PurchaseOrders**](PurchaseOrders.md) ### Authorization @@ -14237,10 +14964,10 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **update_or_create_purchase_orders** -> PurchaseOrders update_or_create_purchase_orders(xero_tenant_id, purchase_orders, summarize_errors=summarize_errors) +# **update_or_create_quotes** +> Quotes update_or_create_quotes(xero_tenant_id, quotes, summarize_errors=summarize_errors, idempotency_key=idempotency_key) -Updates or creates one or more purchase orders +Updates or creates one or more quotes ### Example @@ -14269,14 +14996,15 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -purchase_orders = { "PurchaseOrders": [ { "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "LineItems": [ { "Description": "Foobar", "Quantity": 1, "UnitAmount": 20, "AccountCode": "710" } ], "Date": "2019-03-13" } ] } # PurchaseOrders | +quotes = {"Quotes":[{"Contact":{"ContactID":"00000000-0000-0000-0000-000000000000"},"LineItems":[{"Description":"Foobar","Quantity":1,"UnitAmount":20,"AccountCode":"12775"}],"Date":"2020-02-01"}]} # Quotes | summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: - # Updates or creates one or more purchase orders - api_response = api_instance.update_or_create_purchase_orders(xero_tenant_id, purchase_orders, summarize_errors=summarize_errors) + # Updates or creates one or more quotes + api_response = api_instance.update_or_create_quotes(xero_tenant_id, quotes, summarize_errors=summarize_errors, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: - print("Exception when calling AccountingApi->update_or_create_purchase_orders: %s\n" % e) + print("Exception when calling AccountingApi->update_or_create_quotes: %s\n" % e) ``` ### Parameters @@ -14284,12 +15012,13 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | - **purchase_orders** | [**PurchaseOrders**](PurchaseOrders.md)| | + **quotes** | [**Quotes**](Quotes.md)| | **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type -[**PurchaseOrders**](PurchaseOrders.md) +[**Quotes**](Quotes.md) ### Authorization @@ -14302,10 +15031,10 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **update_or_create_quotes** -> Quotes update_or_create_quotes(xero_tenant_id, quotes, summarize_errors=summarize_errors) +# **update_or_create_repeating_invoices** +> RepeatingInvoices update_or_create_repeating_invoices(xero_tenant_id, repeating_invoices, summarize_errors=summarize_errors, idempotency_key=idempotency_key) -Updates or creates one or more quotes +Creates or deletes one or more repeating invoice templates ### Example @@ -14334,14 +15063,15 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -quotes = { "Quotes": [ { "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "LineItems": [ { "Description": "Foobar", "Quantity": 1, "UnitAmount": 20, "AccountCode": "12775" } ], "Date": "2020-02-01" } ] } # Quotes | +repeating_invoices = {"RepeatingInvoices":[{"Schedule":{"Period":1,"Unit":"MONTHLY","DueDate":10,"DueDateType":"OFFOLLOWINGMONTH","StartDate":"/Date(1555286400000+0000)/"},"Type":"ACCREC","Reference":"[Week]","ApprovedForSending":false,"SendCopy":false,"MarkAsSent":false,"IncludePDF":false,"Contact":{"ContactID":"430fa14a-f945-44d3-9f97-5df5e28441b8","Name":"Liam Gallagher"},"Status":"AUTHORISED","LineAmountTypes":"Exclusive","LineItems":[{"Description":"Guitars Fender Strat","UnitAmount":5000.0,"TaxType":"OUTPUT2","TaxAmount":750.0,"LineAmount":5000.0,"AccountCode":"200","Tracking":[],"Quantity":1.0,"LineItemID":"13a8353c-d2af-4d5b-920c-438449f08900","DiscountEnteredAsPercent":true}],"CurrencyCode":"NZD"}]} # RepeatingInvoices | RepeatingInvoices with an array of repeating invoice objects in body of request summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: - # Updates or creates one or more quotes - api_response = api_instance.update_or_create_quotes(xero_tenant_id, quotes, summarize_errors=summarize_errors) + # Creates or deletes one or more repeating invoice templates + api_response = api_instance.update_or_create_repeating_invoices(xero_tenant_id, repeating_invoices, summarize_errors=summarize_errors, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: - print("Exception when calling AccountingApi->update_or_create_quotes: %s\n" % e) + print("Exception when calling AccountingApi->update_or_create_repeating_invoices: %s\n" % e) ``` ### Parameters @@ -14349,12 +15079,13 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | - **quotes** | [**Quotes**](Quotes.md)| | + **repeating_invoices** | [**RepeatingInvoices**](RepeatingInvoices.md)| RepeatingInvoices with an array of repeating invoice objects in body of request | **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type -[**Quotes**](Quotes.md) +[**RepeatingInvoices**](RepeatingInvoices.md) ### Authorization @@ -14368,7 +15099,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_purchase_order** -> PurchaseOrders update_purchase_order(xero_tenant_id, purchase_order_id, purchase_orders) +> PurchaseOrders update_purchase_order(xero_tenant_id, purchase_order_id, purchase_orders, idempotency_key=idempotency_key) Updates a specific purchase order @@ -14400,10 +15131,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant purchase_order_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Purchase Order -purchase_orders = { "PurchaseOrders": [ { "AttentionTo": "Peter Parker", "LineItems": [], "Contact": {} } ] } # PurchaseOrders | +purchase_orders = {"PurchaseOrders":[{"AttentionTo":"Peter Parker","LineItems":[],"Contact":{}}]} # PurchaseOrders | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a specific purchase order - api_response = api_instance.update_purchase_order(xero_tenant_id, purchase_order_id, purchase_orders) + api_response = api_instance.update_purchase_order(xero_tenant_id, purchase_order_id, purchase_orders, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_purchase_order: %s\n" % e) @@ -14416,6 +15148,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **purchase_order_id** | [**str**](.md)| Unique identifier for an Purchase Order | **purchase_orders** | [**PurchaseOrders**](PurchaseOrders.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14433,7 +15166,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_purchase_order_attachment_by_file_name** -> Attachments update_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body) +> Attachments update_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body, idempotency_key=idempotency_key) Updates a specific attachment for a specific purchase order by filename @@ -14467,9 +15200,10 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant purchase_order_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Purchase Order file_name = 'xero-dev.jpg' # str | Name of the attachment body = 'body_example' # str | Byte array of file in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a specific attachment for a specific purchase order by filename - api_response = api_instance.update_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body) + api_response = api_instance.update_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_purchase_order_attachment_by_file_name: %s\n" % e) @@ -14483,6 +15217,7 @@ Name | Type | Description | Notes **purchase_order_id** | [**str**](.md)| Unique identifier for an Purchase Order | **file_name** | **str**| Name of the attachment | **body** | **str**| Byte array of file in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14500,7 +15235,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_quote** -> Quotes update_quote(xero_tenant_id, quote_id, quotes) +> Quotes update_quote(xero_tenant_id, quote_id, quotes, idempotency_key=idempotency_key) Updates a specific quote @@ -14532,10 +15267,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant quote_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Quote -quotes = { "Quotes": [ { "Reference": "I am an update", "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "Date": "2020-02-01" } ] } # Quotes | +quotes = {"Quotes":[{"Reference":"I am an update","Contact":{"ContactID":"00000000-0000-0000-0000-000000000000"},"Date":"2020-02-01"}]} # Quotes | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a specific quote - api_response = api_instance.update_quote(xero_tenant_id, quote_id, quotes) + api_response = api_instance.update_quote(xero_tenant_id, quote_id, quotes, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_quote: %s\n" % e) @@ -14548,6 +15284,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **quote_id** | [**str**](.md)| Unique identifier for an Quote | **quotes** | [**Quotes**](Quotes.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14565,7 +15302,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_quote_attachment_by_file_name** -> Attachments update_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body) +> Attachments update_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body, idempotency_key=idempotency_key) Updates a specific attachment from a specific quote by filename @@ -14599,9 +15336,10 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant quote_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Quote file_name = 'xero-dev.jpg' # str | Name of the attachment body = 'body_example' # str | Byte array of file in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a specific attachment from a specific quote by filename - api_response = api_instance.update_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body) + api_response = api_instance.update_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_quote_attachment_by_file_name: %s\n" % e) @@ -14615,6 +15353,7 @@ Name | Type | Description | Notes **quote_id** | [**str**](.md)| Unique identifier for an Quote | **file_name** | **str**| Name of the attachment | **body** | **str**| Byte array of file in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14632,7 +15371,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_receipt** -> Receipts update_receipt(xero_tenant_id, receipt_id, receipts, unitdp=unitdp) +> Receipts update_receipt(xero_tenant_id, receipt_id, receipts, unitdp=unitdp, idempotency_key=idempotency_key) Updates a specific draft expense claim receipts @@ -14664,11 +15403,12 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant receipt_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Receipt -receipts = { "Receipts": [ { "Lineitems": [], "User": { "UserID": "00000000-0000-0000-0000-000000000000" }, "Reference": "Foobar" } ] } # Receipts | +receipts = {"Receipts":[{"Lineitems":[],"User":{"UserID":"00000000-0000-0000-0000-000000000000"},"Reference":"Foobar"}]} # Receipts | unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a specific draft expense claim receipts - api_response = api_instance.update_receipt(xero_tenant_id, receipt_id, receipts, unitdp=unitdp) + api_response = api_instance.update_receipt(xero_tenant_id, receipt_id, receipts, unitdp=unitdp, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_receipt: %s\n" % e) @@ -14682,6 +15422,7 @@ Name | Type | Description | Notes **receipt_id** | [**str**](.md)| Unique identifier for a Receipt | **receipts** | [**Receipts**](Receipts.md)| | **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14699,7 +15440,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_receipt_attachment_by_file_name** -> Attachments update_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body) +> Attachments update_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body, idempotency_key=idempotency_key) Updates a specific attachment on a specific expense claim receipts by file name @@ -14733,9 +15474,10 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant receipt_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Receipt file_name = 'xero-dev.jpg' # str | Name of the attachment body = 'body_example' # str | Byte array of file in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a specific attachment on a specific expense claim receipts by file name - api_response = api_instance.update_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body) + api_response = api_instance.update_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_receipt_attachment_by_file_name: %s\n" % e) @@ -14749,6 +15491,7 @@ Name | Type | Description | Notes **receipt_id** | [**str**](.md)| Unique identifier for a Receipt | **file_name** | **str**| Name of the attachment | **body** | **str**| Byte array of file in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14765,8 +15508,75 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **update_repeating_invoice** +> RepeatingInvoices update_repeating_invoice(xero_tenant_id, repeating_invoice_id, repeating_invoices, idempotency_key=idempotency_key) + +Deletes a specific repeating invoice template + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.accounting import AccountingApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = AccountingApi(api_client) + +xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant +repeating_invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Repeating Invoice +repeating_invoices = {"Schedule":{"Period":1,"Unit":"MONTHLY","DueDate":10,"DueDateType":"OFFOLLOWINGMONTH","StartDate":"/Date(1555286400000+0000)/","EndDate":"/Date(1569801600000+0000)/","NextScheduledDate":"/Date(1555286400000+0000)/"},"RepeatingInvoiceID":"428c0d75-909f-4b04-8403-a48dc27283b0","Type":"ACCREC","Reference":"[Week]","HasAttachments":true,"ApprovedForSending":false,"SendCopy":false,"MarkAsSent":false,"IncludePDF":false,"ID":"428c0d75-909f-4b04-8403-a48dc27283b0","Contact":{"ContactID":"430fa14a-f945-44d3-9f97-5df5e28441b8","Name":"Liam Gallagher","Addresses":[],"Phones":[],"ContactGroups":[],"ContactPersons":[],"HasValidationErrors":false},"Status":"DELETED","LineAmountTypes":"Exclusive","LineItems":[{"Description":"Guitars Fender Strat","UnitAmount":5000.0,"TaxType":"OUTPUT2","TaxAmount":750.0,"LineAmount":5000.0,"AccountCode":"200","Tracking":[],"Quantity":1.0,"LineItemID":"13a8353c-d2af-4d5b-920c-438449f08900","DiscountEnteredAsPercent":true}],"SubTotal":5000.0,"TotalTax":750.0,"Total":5750.0,"CurrencyCode":"NZD"} # RepeatingInvoices | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) +try: + # Deletes a specific repeating invoice template + api_response = api_instance.update_repeating_invoice(xero_tenant_id, repeating_invoice_id, repeating_invoices, idempotency_key=idempotency_key) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountingApi->update_repeating_invoice: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **repeating_invoice_id** | [**str**](.md)| Unique identifier for a Repeating Invoice | + **repeating_invoices** | [**RepeatingInvoices**](RepeatingInvoices.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] + +### Return type + +[**RepeatingInvoices**](RepeatingInvoices.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **update_repeating_invoice_attachment_by_file_name** -> Attachments update_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body) +> Attachments update_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body, idempotency_key=idempotency_key) Updates a specific attachment from a specific repeating invoices by file name @@ -14800,9 +15610,10 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant repeating_invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Repeating Invoice file_name = 'xero-dev.jpg' # str | Name of the attachment body = 'body_example' # str | Byte array of file in body of request +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a specific attachment from a specific repeating invoices by file name - api_response = api_instance.update_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body) + api_response = api_instance.update_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_repeating_invoice_attachment_by_file_name: %s\n" % e) @@ -14816,6 +15627,7 @@ Name | Type | Description | Notes **repeating_invoice_id** | [**str**](.md)| Unique identifier for a Repeating Invoice | **file_name** | **str**| Name of the attachment | **body** | **str**| Byte array of file in body of request | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14833,7 +15645,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_tax_rate** -> TaxRates update_tax_rate(xero_tenant_id, tax_rates) +> TaxRates update_tax_rate(xero_tenant_id, tax_rates, idempotency_key=idempotency_key) Updates tax rates @@ -14864,10 +15676,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -tax_rates = { "TaxRates": [ { "Name": "State Tax NY", "TaxComponents": [ { "Name": "State Tax", "Rate": 2.25 } ], "Status": "DELETED", "ReportTaxType": "INPUT" } ] } # TaxRates | +tax_rates = {"TaxRates":[{"Name":"State Tax NY","TaxComponents":[{"Name":"State Tax","Rate":2.25}],"Status":"DELETED","ReportTaxType":"INPUT"}]} # TaxRates | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates tax rates - api_response = api_instance.update_tax_rate(xero_tenant_id, tax_rates) + api_response = api_instance.update_tax_rate(xero_tenant_id, tax_rates, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_tax_rate: %s\n" % e) @@ -14879,6 +15692,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **tax_rates** | [**TaxRates**](TaxRates.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14896,7 +15710,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_tracking_category** -> TrackingCategories update_tracking_category(xero_tenant_id, tracking_category_id, tracking_category) +> TrackingCategories update_tracking_category(xero_tenant_id, tracking_category_id, tracking_category, idempotency_key=idempotency_key) Updates a specific tracking category @@ -14928,10 +15742,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant tracking_category_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a TrackingCategory -tracking_category = { "Name": "Avengers" } # TrackingCategory | +tracking_category = {"Name":"Avengers"} # TrackingCategory | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a specific tracking category - api_response = api_instance.update_tracking_category(xero_tenant_id, tracking_category_id, tracking_category) + api_response = api_instance.update_tracking_category(xero_tenant_id, tracking_category_id, tracking_category, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_tracking_category: %s\n" % e) @@ -14944,6 +15759,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **tracking_category_id** | [**str**](.md)| Unique identifier for a TrackingCategory | **tracking_category** | [**TrackingCategory**](TrackingCategory.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14961,7 +15777,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_tracking_options** -> TrackingOptions update_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id, tracking_option) +> TrackingOptions update_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id, tracking_option, idempotency_key=idempotency_key) Updates a specific option for a specific tracking category @@ -14994,10 +15810,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant tracking_category_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a TrackingCategory tracking_option_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Tracking Option -tracking_option = { name: "Vision" } # TrackingOption | +tracking_option = {"name":"Vision"} # TrackingOption | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a specific option for a specific tracking category - api_response = api_instance.update_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id, tracking_option) + api_response = api_instance.update_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id, tracking_option, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_tracking_options: %s\n" % e) @@ -15011,6 +15828,7 @@ Name | Type | Description | Notes **tracking_category_id** | [**str**](.md)| Unique identifier for a TrackingCategory | **tracking_option_id** | [**str**](.md)| Unique identifier for a Tracking Option | **tracking_option** | [**TrackingOption**](TrackingOption.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type diff --git a/xero_python/accounting/docs/Allocation.md b/xero_python/accounting/docs/Allocation.md index d6b94be1..b5c0870b 100644 --- a/xero_python/accounting/docs/Allocation.md +++ b/xero_python/accounting/docs/Allocation.md @@ -3,12 +3,14 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**allocation_id** | **str** | Xero generated unique identifier | [optional] **invoice** | [**Invoice**](Invoice.md) | | **overpayment** | [**Overpayment**](Overpayment.md) | | [optional] **prepayment** | [**Prepayment**](Prepayment.md) | | [optional] **credit_note** | [**CreditNote**](CreditNote.md) | | [optional] **amount** | **float** | the amount being applied to the invoice | **date** | **date** | the date the allocation is applied YYYY-MM-DD. | +**is_deleted** | **bool** | A flag that returns true when the allocation is succesfully deleted | [optional] **status_attribute_string** | **str** | A string to indicate if a invoice status | [optional] **validation_errors** | [**list[ValidationError]**](ValidationError.md) | Displays array of validation error messages from the API | [optional] diff --git a/xero_python/accounting/docs/BankTransactions.md b/xero_python/accounting/docs/BankTransactions.md index ad29843e..c24be2e1 100644 --- a/xero_python/accounting/docs/BankTransactions.md +++ b/xero_python/accounting/docs/BankTransactions.md @@ -3,6 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**warnings** | [**list[ValidationError]**](ValidationError.md) | Displays array of warning messages from the API | [optional] **bank_transactions** | [**list[BankTransaction]**](BankTransaction.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/docs/BankTransfer.md b/xero_python/accounting/docs/BankTransfer.md index e91569c5..3473b5e3 100644 --- a/xero_python/accounting/docs/BankTransfer.md +++ b/xero_python/accounting/docs/BankTransfer.md @@ -16,6 +16,9 @@ Name | Type | Description | Notes **reference** | **str** | Reference for the transactions. | [optional] **has_attachments** | **bool** | Boolean to indicate if a Bank Transfer has an attachment | [optional] [default to False] **created_date_utc** | **datetime** | UTC timestamp of creation date of bank transfer | [optional] +**status** | **str** | AUTHORISED or DELETED (read-only). New bank transfers will have a status of AUTHORISED. | [optional] +**from_tracking** | [**list[TrackingReference]**](TrackingReference.md) | Optional Tracking Category for the source account – see Tracking. A bank transfer can have a maximum of 2 tracking categories per account. | [optional] +**to_tracking** | [**list[TrackingReference]**](TrackingReference.md) | Optional Tracking Category for the destination account – see Tracking. A bank transfer can have a maximum of 2 tracking categories per account. | [optional] **validation_errors** | [**list[ValidationError]**](ValidationError.md) | Displays array of validation error messages from the API | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/file/docs/InlineObject1.md b/xero_python/accounting/docs/BankTransferDelete.md similarity index 56% rename from xero_python/file/docs/InlineObject1.md rename to xero_python/accounting/docs/BankTransferDelete.md index 56b51edf..1b096e5d 100644 --- a/xero_python/file/docs/InlineObject1.md +++ b/xero_python/accounting/docs/BankTransferDelete.md @@ -1,12 +1,10 @@ -# InlineObject1 +# BankTransferDelete ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**body** | **str** | | [optional] -**name** | **str** | exact name of the file you are uploading | [optional] -**filename** | **str** | | [optional] -**mime_type** | **str** | | [optional] +**bank_transfer_id** | **str** | The Xero identifier for a bank transfer | +**status** | **str** | The status of the bank transfer. | [default to 'DELETED'] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/finance/docs/LockHistoryResponse.md b/xero_python/accounting/docs/BankTransferDeleteByUrlParam.md similarity index 50% rename from xero_python/finance/docs/LockHistoryResponse.md rename to xero_python/accounting/docs/BankTransferDeleteByUrlParam.md index 5428149b..b82e5a62 100644 --- a/xero_python/finance/docs/LockHistoryResponse.md +++ b/xero_python/accounting/docs/BankTransferDeleteByUrlParam.md @@ -1,11 +1,9 @@ -# LockHistoryResponse +# BankTransferDeleteByUrlParam ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**organisation_id** | **str** | The requested Organisation to which the data pertains | [optional] -**end_date** | **date** | The end date of the report | [optional] -**lock_dates** | [**list[LockHistoryModel]**](LockHistoryModel.md) | | [optional] +**status** | **str** | The status of the bank transfer. | [default to 'DELETED'] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/docs/BankTransfersDelete.md b/xero_python/accounting/docs/BankTransfersDelete.md new file mode 100644 index 00000000..7f26b2b5 --- /dev/null +++ b/xero_python/accounting/docs/BankTransfersDelete.md @@ -0,0 +1,10 @@ +# BankTransfersDelete + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bank_transfers** | [**list[BankTransferDelete]**](BankTransferDelete.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/accounting/docs/BatchPayment.md b/xero_python/accounting/docs/BatchPayment.md index 527a54dc..52b41030 100644 --- a/xero_python/accounting/docs/BatchPayment.md +++ b/xero_python/accounting/docs/BatchPayment.md @@ -16,9 +16,9 @@ Name | Type | Description | Notes **payments** | [**list[Payment]**](Payment.md) | An array of payments | [optional] **type** | **str** | PAYBATCH for bill payments or RECBATCH for sales invoice payments (read-only) | [optional] **status** | **str** | AUTHORISED or DELETED (read-only). New batch payments will have a status of AUTHORISED. It is not possible to delete batch payments via the API. | [optional] -**total_amount** | **str** | The total of the payments that make up the batch (read-only) | [optional] +**total_amount** | **float** | The total of the payments that make up the batch (read-only) | [optional] **updated_date_utc** | **datetime** | UTC timestamp of last update to the payment | [optional] -**is_reconciled** | **str** | Booelan that tells you if the batch payment has been reconciled (read-only) | [optional] +**is_reconciled** | **bool** | Booelan that tells you if the batch payment has been reconciled (read-only) | [optional] **validation_errors** | [**list[ValidationError]**](ValidationError.md) | Displays array of validation error messages from the API | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/docs/BatchPaymentDelete.md b/xero_python/accounting/docs/BatchPaymentDelete.md new file mode 100644 index 00000000..9d04c92e --- /dev/null +++ b/xero_python/accounting/docs/BatchPaymentDelete.md @@ -0,0 +1,11 @@ +# BatchPaymentDelete + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**batch_payment_id** | **str** | The Xero generated unique identifier for the bank transaction (read-only) | +**status** | **str** | The status of the batch payment. | [default to 'DELETED'] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/accounting/docs/BatchPaymentDeleteByUrlParam.md b/xero_python/accounting/docs/BatchPaymentDeleteByUrlParam.md new file mode 100644 index 00000000..4d9daee5 --- /dev/null +++ b/xero_python/accounting/docs/BatchPaymentDeleteByUrlParam.md @@ -0,0 +1,10 @@ +# BatchPaymentDeleteByUrlParam + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **str** | The status of the batch payment. | [default to 'DELETED'] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/accounting/docs/Contact.md b/xero_python/accounting/docs/Contact.md index 5f9a2bed..fc887ed5 100644 --- a/xero_python/accounting/docs/Contact.md +++ b/xero_python/accounting/docs/Contact.md @@ -13,10 +13,10 @@ Name | Type | Description | Notes **last_name** | **str** | Last name of contact person (max length = 255) | [optional] **company_number** | **str** | Company registration number (max length = 50) | [optional] **email_address** | **str** | Email address of contact person (umlauts not supported) (max length = 255) | [optional] -**skype_user_name** | **str** | Skype user name of contact | [optional] **contact_persons** | [**list[ContactPerson]**](ContactPerson.md) | See contact persons | [optional] **bank_account_details** | **str** | Bank account number of contact | [optional] **tax_number** | **str** | Tax number of contact – this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50) | [optional] +**tax_number_type** | **str** | Identifier of the regional type of tax number, such as US, UK, or other regional tax identifiers | [optional] **accounts_receivable_tax_type** | **str** | The tax type from TaxRates | [optional] **accounts_payable_tax_type** | **str** | The tax type from TaxRates | [optional] **addresses** | [**list[Address]**](Address.md) | Store certain address types for a contact – see address types | [optional] diff --git a/xero_python/accounting/docs/Contacts.md b/xero_python/accounting/docs/Contacts.md index 9f86c925..e9d7da7c 100644 --- a/xero_python/accounting/docs/Contacts.md +++ b/xero_python/accounting/docs/Contacts.md @@ -3,6 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**warnings** | [**list[ValidationError]**](ValidationError.md) | Displays array of warning messages from the API | [optional] **contacts** | [**list[Contact]**](Contact.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/docs/CreditNote.md b/xero_python/accounting/docs/CreditNote.md index a36c6472..9543791b 100644 --- a/xero_python/accounting/docs/CreditNote.md +++ b/xero_python/accounting/docs/CreditNote.md @@ -16,12 +16,13 @@ Name | Type | Description | Notes **cis_deduction** | **float** | CIS deduction for UK contractors | [optional] **cis_rate** | **float** | CIS Deduction rate for the organisation | [optional] **updated_date_utc** | **datetime** | UTC timestamp of last update to the credit note | [optional] +**updated_date_utc_string** | **str** | UTC ISO-8601 formatted timestamp of last update to the credit note | [optional] **currency_code** | [**CurrencyCode**](CurrencyCode.md) | | [optional] **fully_paid_on_date** | **date** | Date when credit note was fully paid(UTC format) | [optional] **credit_note_id** | **str** | Xero generated unique identifier | [optional] **credit_note_number** | **str** | ACCRECCREDIT – Unique alpha numeric code identifying credit note (when missing will auto-generate from your Organisation Invoice Settings) | [optional] **reference** | **str** | ACCRECCREDIT only – additional reference number | [optional] -**sent_to_contact** | **bool** | boolean to indicate if a credit note has been sent to a contact via the Xero app (currently read only) | [optional] +**sent_to_contact** | **bool** | Boolean to set whether the credit note in the Xero app should be marked as “sent”. This can be set only on credit notes that have been approved | [optional] **currency_rate** | **float** | The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used | [optional] **remaining_credit** | **float** | The remaining credit balance on the Credit Note | [optional] **allocations** | [**list[Allocation]**](Allocation.md) | See Allocations | [optional] @@ -33,6 +34,7 @@ Name | Type | Description | Notes **has_errors** | **bool** | A boolean to indicate if a credit note has an validation errors | [optional] [default to False] **validation_errors** | [**list[ValidationError]**](ValidationError.md) | Displays array of validation error messages from the API | [optional] **warnings** | [**list[ValidationError]**](ValidationError.md) | Displays array of warning messages from the API | [optional] +**invoice_addresses** | [**list[InvoiceAddress]**](InvoiceAddress.md) | An array of addresses used to auto calculate sales tax | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/docs/CreditNotes.md b/xero_python/accounting/docs/CreditNotes.md index acee29ef..69cd8f2b 100644 --- a/xero_python/accounting/docs/CreditNotes.md +++ b/xero_python/accounting/docs/CreditNotes.md @@ -3,6 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**warnings** | [**list[ValidationError]**](ValidationError.md) | Displays array of warning messages from the API | [optional] **credit_notes** | [**list[CreditNote]**](CreditNote.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/docs/Invoice.md b/xero_python/accounting/docs/Invoice.md index 021d8428..ef5dc756 100644 --- a/xero_python/accounting/docs/Invoice.md +++ b/xero_python/accounting/docs/Invoice.md @@ -36,13 +36,15 @@ Name | Type | Description | Notes **amount_paid** | **float** | Sum of payments received for invoice | [optional] **fully_paid_on_date** | **date** | The date the invoice was fully paid. Only returned on fully paid invoices | [optional] **amount_credited** | **float** | Sum of all credit notes, over-payments and pre-payments applied to invoice | [optional] -**updated_date_utc** | **datetime** | Last modified date UTC format | [optional] +**updated_date_utc** | **datetime** | UTC timestamp of last update to the invoice | [optional] +**updated_date_utc_string** | **str** | UTC ISO-8601 formatted timestamp of last update to the invoice | [optional] **credit_notes** | [**list[CreditNote]**](CreditNote.md) | Details of credit notes that have been applied to an invoice | [optional] **attachments** | [**list[Attachment]**](Attachment.md) | Displays array of attachments from the API | [optional] **has_errors** | **bool** | A boolean to indicate if a invoice has an validation errors | [optional] [default to False] **status_attribute_string** | **str** | A string to indicate if a invoice status | [optional] **validation_errors** | [**list[ValidationError]**](ValidationError.md) | Displays array of validation error messages from the API | [optional] **warnings** | [**list[ValidationError]**](ValidationError.md) | Displays array of warning messages from the API | [optional] +**invoice_addresses** | [**list[InvoiceAddress]**](InvoiceAddress.md) | An array of addresses used to auto calculate sales tax | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/docs/InvoiceAddress.md b/xero_python/accounting/docs/InvoiceAddress.md new file mode 100644 index 00000000..eed4697f --- /dev/null +++ b/xero_python/accounting/docs/InvoiceAddress.md @@ -0,0 +1,18 @@ +# InvoiceAddress + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**invoice_address_type** | **str** | Indicates whether the address is defined as origin (FROM) or destination (TO) | [optional] +**address_line1** | **str** | First line of a physical address | [optional] +**address_line2** | **str** | Second line of a physical address | [optional] +**address_line3** | **str** | Third line of a physical address | [optional] +**address_line4** | **str** | Fourth line of a physical address | [optional] +**city** | **str** | City of a physical address | [optional] +**region** | **str** | Region or state of a physical address | [optional] +**postal_code** | **str** | Postal code of a physical address | [optional] +**country** | **str** | Country of a physical address | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/accounting/docs/Invoices.md b/xero_python/accounting/docs/Invoices.md index d507179e..3b56eb42 100644 --- a/xero_python/accounting/docs/Invoices.md +++ b/xero_python/accounting/docs/Invoices.md @@ -3,6 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**warnings** | [**list[ValidationError]**](ValidationError.md) | Displays array of warning messages from the API | [optional] **invoices** | [**list[Invoice]**](Invoice.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/docs/Item.md b/xero_python/accounting/docs/Item.md index 2666df71..afc2811a 100644 --- a/xero_python/accounting/docs/Item.md +++ b/xero_python/accounting/docs/Item.md @@ -14,7 +14,9 @@ Name | Type | Description | Notes **sales_details** | [**Purchase**](Purchase.md) | | [optional] **is_tracked_as_inventory** | **bool** | True for items that are tracked as inventory. An item will be tracked as inventory if the InventoryAssetAccountCode and COGSAccountCode are set. | [optional] **total_cost_pool** | **float** | The value of the item on hand. Calculated using average cost accounting. | [optional] -**quantity_on_hand** | **float** | The quantity of the item on hand | [optional] +**quantity_on_hand** | **float** | The quantity of the item on hand. This will be 0 if `QuantityOnBackOrder` is greater than 0. | [optional] +**quantity_available** | **float** | The quantity of the item available. This is equal to `QuantityOnHand` - `QuantityOnBackOrder`. This value will be negative if `QuantityOnBackOrder` is greater than 0. | [optional] +**quantity_on_back_order** | **float** | The quantity of the item on backorder. This will be 0 if `QuantityOnHand` is greater than 0. | [optional] **updated_date_utc** | **datetime** | Last modified date in UTC format | [optional] **item_id** | **str** | The Xero identifier for an Item | [optional] **status_attribute_string** | **str** | Status of object | [optional] diff --git a/xero_python/accounting/docs/JournalLine.md b/xero_python/accounting/docs/JournalLine.md index 862d265f..257f8c64 100644 --- a/xero_python/accounting/docs/JournalLine.md +++ b/xero_python/accounting/docs/JournalLine.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **net_amount** | **float** | Net amount of journal line. This will be a positive value for a debit and negative for a credit | [optional] **gross_amount** | **float** | Gross amount of journal line (NetAmount + TaxAmount). | [optional] **tax_amount** | **float** | Total tax on a journal line | [optional] -**tax_type** | **str** | The tax type from TaxRates | [optional] +**tax_type** | **str** | The tax type from taxRates | [optional] **tax_name** | **str** | see TaxRates | [optional] **tracking_categories** | [**list[TrackingCategory]**](TrackingCategory.md) | Optional Tracking Category – see Tracking. Any JournalLine can have a maximum of 2 <TrackingCategory> elements. | [optional] diff --git a/xero_python/accounting/docs/Journals.md b/xero_python/accounting/docs/Journals.md index bf3c0631..4b94daa2 100644 --- a/xero_python/accounting/docs/Journals.md +++ b/xero_python/accounting/docs/Journals.md @@ -3,6 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**warnings** | [**list[ValidationError]**](ValidationError.md) | Displays array of warning messages from the API | [optional] **journals** | [**list[Journal]**](Journal.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/docs/LineItem.md b/xero_python/accounting/docs/LineItem.md index 5613e8f6..118279a7 100644 --- a/xero_python/accounting/docs/LineItem.md +++ b/xero_python/accounting/docs/LineItem.md @@ -13,11 +13,14 @@ Name | Type | Description | Notes **tax_type** | **str** | The tax type from TaxRates | [optional] **tax_amount** | **float** | The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. This value can be overriden if the calculated <TaxAmount> is not correct. | [optional] **item** | [**LineItemItem**](LineItemItem.md) | | [optional] -**line_amount** | **float** | If you wish to omit either of 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 a DiscountRate has been used . i.e LineAmount = Quantity * Unit Amount * ((100 – DiscountRate)/100) | [optional] +**line_amount** | **float** | 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 | [optional] **tracking** | [**list[LineItemTracking]**](LineItemTracking.md) | Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 <TrackingCategory> elements. | [optional] **discount_rate** | **float** | 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 | [optional] -**discount_amount** | **float** | Discount amount being applied to a line item. Only supported on ACCREC invoices - ACCPAY invoices and credit notes in Xero do not support discounts. | [optional] +**discount_amount** | **float** | Discount amount being applied to a line item. Only supported on ACCREC invoices and quotes. ACCPAY invoices and credit notes in Xero do not support discounts. | [optional] **repeating_invoice_id** | **str** | The Xero identifier for a Repeating Invoice | [optional] +**taxability** | **str** | The type of taxability | [optional] +**sales_tax_code_id** | **float** | The ID of the sales tax code | [optional] +**tax_breakdown** | [**list[TaxBreakdownComponent]**](TaxBreakdownComponent.md) | An array of tax components defined for this line item | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/docs/ManualJournals.md b/xero_python/accounting/docs/ManualJournals.md index 9d0bec5a..1072787d 100644 --- a/xero_python/accounting/docs/ManualJournals.md +++ b/xero_python/accounting/docs/ManualJournals.md @@ -3,6 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**warnings** | [**list[ValidationError]**](ValidationError.md) | Displays array of warning messages from the API | [optional] **manual_journals** | [**list[ManualJournal]**](ManualJournal.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/docs/Overpayment.md b/xero_python/accounting/docs/Overpayment.md index d5f7f095..2e00b63f 100644 --- a/xero_python/accounting/docs/Overpayment.md +++ b/xero_python/accounting/docs/Overpayment.md @@ -13,6 +13,7 @@ Name | Type | Description | Notes **total_tax** | **float** | The total tax on the overpayment | [optional] **total** | **float** | The total of the overpayment (subtotal + total tax) | [optional] **updated_date_utc** | **datetime** | UTC timestamp of last update to the overpayment | [optional] +**updated_date_utc_string** | **str** | UTC ISO-8601 formatted timestamp of last update to the overpayment | [optional] **currency_code** | [**CurrencyCode**](CurrencyCode.md) | | [optional] **overpayment_id** | **str** | Xero generated unique identifier | [optional] **currency_rate** | **float** | The currency rate for a multicurrency overpayment. If no rate is specified, the XE.com day rate is used | [optional] @@ -21,6 +22,7 @@ Name | Type | Description | Notes **applied_amount** | **float** | The amount of applied to an invoice | [optional] **payments** | [**list[Payment]**](Payment.md) | See Payments | [optional] **has_attachments** | **bool** | boolean to indicate if a overpayment has an attachment | [optional] [default to False] +**reference** | **str** | An optional description for Overpayment | [optional] **attachments** | [**list[Attachment]**](Attachment.md) | See Attachments | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/docs/Overpayments.md b/xero_python/accounting/docs/Overpayments.md index ae7f3ed9..85042a86 100644 --- a/xero_python/accounting/docs/Overpayments.md +++ b/xero_python/accounting/docs/Overpayments.md @@ -3,6 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**warnings** | [**list[ValidationError]**](ValidationError.md) | Displays array of warning messages from the API | [optional] **overpayments** | [**list[Overpayment]**](Overpayment.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/docs/Pagination.md b/xero_python/accounting/docs/Pagination.md new file mode 100644 index 00000000..7d4aa488 --- /dev/null +++ b/xero_python/accounting/docs/Pagination.md @@ -0,0 +1,13 @@ +# Pagination + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**page** | **int** | | [optional] +**page_size** | **int** | | [optional] +**page_count** | **int** | | [optional] +**item_count** | **int** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/accounting/docs/Payment.md b/xero_python/accounting/docs/Payment.md index f387655b..0755deef 100644 --- a/xero_python/accounting/docs/Payment.md +++ b/xero_python/accounting/docs/Payment.md @@ -9,6 +9,7 @@ Name | Type | Description | Notes **overpayment** | [**Overpayment**](Overpayment.md) | | [optional] **invoice_number** | **str** | Number of invoice or credit note you are applying payment to e.g.INV-4003 | [optional] **credit_note_number** | **str** | Number of invoice or credit note you are applying payment to e.g. INV-4003 | [optional] +**batch_payment** | [**BatchPayment**](BatchPayment.md) | | [optional] **account** | [**Account**](Account.md) | | [optional] **code** | **str** | Code of account you are using to make the payment e.g. 001 (note- not all accounts have a code value) | [optional] **date** | **date** | Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06 | [optional] @@ -20,6 +21,7 @@ Name | Type | Description | Notes **status** | **str** | The status of the payment. | [optional] **payment_type** | **str** | See Payment Types. | [optional] **updated_date_utc** | **datetime** | UTC timestamp of last update to the payment | [optional] +**updated_date_utc_string** | **str** | UTC ISO-8601 formatted timestamp of last update to the payment | [optional] **payment_id** | **str** | The Xero identifier for an Payment e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9 | [optional] **batch_payment_id** | **str** | Present if the payment was created as part of a batch. | [optional] **bank_account_number** | **str** | The suppliers bank account number the payment is being made to | [optional] @@ -29,6 +31,7 @@ Name | Type | Description | Notes **has_validation_errors** | **bool** | A boolean to indicate if a contact has an validation errors | [optional] [default to False] **status_attribute_string** | **str** | A string to indicate if a invoice status | [optional] **validation_errors** | [**list[ValidationError]**](ValidationError.md) | Displays array of validation error messages from the API | [optional] +**warnings** | [**list[ValidationError]**](ValidationError.md) | Displays array of warning messages from the API | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/docs/Payments.md b/xero_python/accounting/docs/Payments.md index fc8b44df..768a9ea6 100644 --- a/xero_python/accounting/docs/Payments.md +++ b/xero_python/accounting/docs/Payments.md @@ -3,6 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**warnings** | [**list[ValidationError]**](ValidationError.md) | Displays array of warning messages from the API | [optional] **payments** | [**list[Payment]**](Payment.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/docs/Prepayment.md b/xero_python/accounting/docs/Prepayment.md index 2168254a..ba1f131c 100644 --- a/xero_python/accounting/docs/Prepayment.md +++ b/xero_python/accounting/docs/Prepayment.md @@ -13,9 +13,12 @@ Name | Type | Description | Notes **total_tax** | **float** | The total tax on the prepayment | [optional] **total** | **float** | The total of the prepayment(subtotal + total tax) | [optional] **reference** | **str** | Returns Invoice number field. Reference field isn't available. | [optional] +**invoice_number** | **str** | Returns Invoice number for prepayment receive document only. | [optional] **updated_date_utc** | **datetime** | UTC timestamp of last update to the prepayment | [optional] +**updated_date_utc_string** | **str** | UTC ISO-8601 formatted timestamp of last update to the prepayment | [optional] **currency_code** | [**CurrencyCode**](CurrencyCode.md) | | [optional] **prepayment_id** | **str** | Xero generated unique identifier | [optional] +**branding_theme_id** | **str** | The unique identifier of the branding template applied to a receive prepayment | [optional] **currency_rate** | **float** | The currency rate for a multicurrency prepayment. If no rate is specified, the XE.com day rate is used | [optional] **remaining_credit** | **float** | The remaining credit balance on the prepayment | [optional] **allocations** | [**list[Allocation]**](Allocation.md) | See Allocations | [optional] diff --git a/xero_python/accounting/docs/Prepayments.md b/xero_python/accounting/docs/Prepayments.md index 3fe6af19..f30ec4b7 100644 --- a/xero_python/accounting/docs/Prepayments.md +++ b/xero_python/accounting/docs/Prepayments.md @@ -3,6 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**warnings** | [**list[ValidationError]**](ValidationError.md) | Displays array of warning messages from the API | [optional] **prepayments** | [**list[Prepayment]**](Prepayment.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/docs/PurchaseOrders.md b/xero_python/accounting/docs/PurchaseOrders.md index 466fd9ad..a8568046 100644 --- a/xero_python/accounting/docs/PurchaseOrders.md +++ b/xero_python/accounting/docs/PurchaseOrders.md @@ -3,6 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**warnings** | [**list[ValidationError]**](ValidationError.md) | Displays array of warning messages from the API | [optional] **purchase_orders** | [**list[PurchaseOrder]**](PurchaseOrder.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/docs/RepeatingInvoice.md b/xero_python/accounting/docs/RepeatingInvoice.md index 172a5e54..1d9eb724 100644 --- a/xero_python/accounting/docs/RepeatingInvoice.md +++ b/xero_python/accounting/docs/RepeatingInvoice.md @@ -17,8 +17,12 @@ Name | Type | Description | Notes **total** | **float** | Total of Invoice tax inclusive (i.e. SubTotal + TotalTax) | [optional] **repeating_invoice_id** | **str** | Xero generated unique identifier for repeating invoice template | [optional] **id** | **str** | Xero generated unique identifier for repeating invoice template | [optional] -**has_attachments** | **bool** | boolean to indicate if an invoice has an attachment | [optional] [default to False] +**has_attachments** | **bool** | Boolean to indicate if an invoice has an attachment | [optional] [default to False] **attachments** | [**list[Attachment]**](Attachment.md) | Displays array of attachments from the API | [optional] +**approved_for_sending** | **bool** | Boolean to indicate whether the invoice has been approved for sending | [optional] [default to False] +**send_copy** | **bool** | Boolean to indicate whether a copy is sent to sender's email | [optional] [default to False] +**mark_as_sent** | **bool** | Boolean to indicate whether the invoice in the Xero app displays as \"sent\" | [optional] [default to False] +**include_pdf** | **bool** | Boolean to indicate whether to include PDF attachment | [optional] [default to False] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/docs/TaxBreakdownComponent.md b/xero_python/accounting/docs/TaxBreakdownComponent.md new file mode 100644 index 00000000..51e0f905 --- /dev/null +++ b/xero_python/accounting/docs/TaxBreakdownComponent.md @@ -0,0 +1,19 @@ +# TaxBreakdownComponent + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tax_component_id** | **str** | The unique ID number of this component | [optional] +**type** | **str** | The type of the jurisdiction | [optional] +**name** | **str** | The name of the jurisdiction | [optional] +**tax_percentage** | **float** | The percentage of the tax | [optional] +**tax_amount** | **float** | The amount of the tax | [optional] +**taxable_amount** | **float** | The amount that is taxable | [optional] +**non_taxable_amount** | **float** | The amount that is not taxable | [optional] +**exempt_amount** | **float** | The amount that is exempt | [optional] +**state_assigned_no** | **str** | The state assigned number of the jurisdiction | [optional] +**jurisdiction_region** | **str** | Name identifying the region within the country | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/accounting/docs/TenNinetyNineContact.md b/xero_python/accounting/docs/TenNinetyNineContact.md index 1f366ca9..c819d556 100644 --- a/xero_python/accounting/docs/TenNinetyNineContact.md +++ b/xero_python/accounting/docs/TenNinetyNineContact.md @@ -25,6 +25,9 @@ Name | Type | Description | Notes **street_address** | **str** | Contact address on 1099 Form | [optional] **tax_id** | **str** | Contact tax id on 1099 Form | [optional] **contact_id** | **str** | Contact contact id | [optional] +**legal_name** | **str** | Contact legal name | [optional] +**business_name** | **str** | Contact business name | [optional] +**federal_tax_classification** | **str** | Contact federal tax classification | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/docs/TenNinteyNineContact.md b/xero_python/accounting/docs/TenNinteyNineContact.md deleted file mode 100644 index a6e9037b..00000000 --- a/xero_python/accounting/docs/TenNinteyNineContact.md +++ /dev/null @@ -1,31 +0,0 @@ -# TenNinteyNineContact - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**box1** | **float** | Box 1 on 1099 Form | [optional] -**box2** | **float** | Box 2 on 1099 Form | [optional] -**box3** | **float** | Box 3 on 1099 Form | [optional] -**box4** | **float** | Box 4 on 1099 Form | [optional] -**box5** | **float** | Box 5 on 1099 Form | [optional] -**box6** | **float** | Box 6 on 1099 Form | [optional] -**box7** | **float** | Box 7 on 1099 Form | [optional] -**box8** | **float** | Box 8 on 1099 Form | [optional] -**box9** | **float** | Box 9 on 1099 Form | [optional] -**box10** | **float** | Box 10 on 1099 Form | [optional] -**box11** | **float** | Box 11 on 1099 Form | [optional] -**box13** | **float** | Box 13 on 1099 Form | [optional] -**box14** | **float** | Box 14 on 1099 Form | [optional] -**name** | **str** | Contact name on 1099 Form | [optional] -**federal_tax_id_type** | **str** | Contact Fed Tax ID type | [optional] -**city** | **str** | Contact city on 1099 Form | [optional] -**zip** | **str** | Contact zip on 1099 Form | [optional] -**state** | **str** | Contact State on 1099 Form | [optional] -**email** | **str** | Contact email on 1099 Form | [optional] -**street_address** | **str** | Contact address on 1099 Form | [optional] -**tax_id** | **str** | Contact tax id on 1099 Form | [optional] -**contact_id** | **str** | Contact contact id | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/xero_python/accounting/docs/TrackingReference.md b/xero_python/accounting/docs/TrackingReference.md new file mode 100644 index 00000000..bfdf135f --- /dev/null +++ b/xero_python/accounting/docs/TrackingReference.md @@ -0,0 +1,13 @@ +# TrackingReference + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tracking_category_id** | **str** | The Xero identifier for a tracking category | +**tracking_option_id** | **str** | The Xero identifier for a tracking category option | +**name** | **str** | The name of the tracking category | [optional] +**option** | **str** | See Tracking Options | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/accounting/models/__init__.py b/xero_python/accounting/models/__init__.py index 3de0d697..57d6c565 100644 --- a/xero_python/accounting/models/__init__.py +++ b/xero_python/accounting/models/__init__.py @@ -2,12 +2,12 @@ # flake8: noqa """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -32,8 +32,17 @@ from xero_python.accounting.models.bank_transaction import BankTransaction from xero_python.accounting.models.bank_transactions import BankTransactions from xero_python.accounting.models.bank_transfer import BankTransfer +from xero_python.accounting.models.bank_transfer_delete import BankTransferDelete +from xero_python.accounting.models.bank_transfer_delete_by_url_param import ( + BankTransferDeleteByUrlParam, +) from xero_python.accounting.models.bank_transfers import BankTransfers +from xero_python.accounting.models.bank_transfers_delete import BankTransfersDelete from xero_python.accounting.models.batch_payment import BatchPayment +from xero_python.accounting.models.batch_payment_delete import BatchPaymentDelete +from xero_python.accounting.models.batch_payment_delete_by_url_param import ( + BatchPaymentDeleteByUrlParam, +) from xero_python.accounting.models.batch_payment_details import BatchPaymentDetails from xero_python.accounting.models.batch_payments import BatchPayments from xero_python.accounting.models.bill import Bill @@ -76,6 +85,7 @@ ImportSummaryOrganisation, ) from xero_python.accounting.models.invoice import Invoice +from xero_python.accounting.models.invoice_address import InvoiceAddress from xero_python.accounting.models.invoice_reminder import InvoiceReminder from xero_python.accounting.models.invoice_reminders import InvoiceReminders from xero_python.accounting.models.invoices import Invoices @@ -99,6 +109,7 @@ from xero_python.accounting.models.organisations import Organisations from xero_python.accounting.models.overpayment import Overpayment from xero_python.accounting.models.overpayments import Overpayments +from xero_python.accounting.models.pagination import Pagination from xero_python.accounting.models.payment import Payment from xero_python.accounting.models.payment_delete import PaymentDelete from xero_python.accounting.models.payment_service import PaymentService @@ -134,6 +145,7 @@ from xero_python.accounting.models.sales_tracking_category import SalesTrackingCategory from xero_python.accounting.models.schedule import Schedule from xero_python.accounting.models.setup import Setup +from xero_python.accounting.models.tax_breakdown_component import TaxBreakdownComponent from xero_python.accounting.models.tax_component import TaxComponent from xero_python.accounting.models.tax_rate import TaxRate from xero_python.accounting.models.tax_rates import TaxRates @@ -144,6 +156,7 @@ from xero_python.accounting.models.tracking_category import TrackingCategory from xero_python.accounting.models.tracking_option import TrackingOption from xero_python.accounting.models.tracking_options import TrackingOptions +from xero_python.accounting.models.tracking_reference import TrackingReference from xero_python.accounting.models.user import User from xero_python.accounting.models.users import Users from xero_python.accounting.models.validation_error import ValidationError diff --git a/xero_python/accounting/models/account.py b/xero_python/accounting/models/account.py index 999f9670..9304f3db 100644 --- a/xero_python/accounting/models/account.py +++ b/xero_python/accounting/models/account.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -400,7 +400,7 @@ def currency_code(self, currency_code): def tax_type(self): """Gets the tax_type of this Account. # noqa: E501 - The tax type from TaxRates # noqa: E501 + The tax type from taxRates # noqa: E501 :return: The tax_type of this Account. # noqa: E501 :rtype: str @@ -411,7 +411,7 @@ def tax_type(self): def tax_type(self, tax_type): """Sets the tax_type of this Account. - The tax type from TaxRates # noqa: E501 + The tax type from taxRates # noqa: E501 :param tax_type: The tax_type of this Account. # noqa: E501 :type: str diff --git a/xero_python/accounting/models/account_type.py b/xero_python/accounting/models/account_type.py index a98ef206..14c31565 100644 --- a/xero_python/accounting/models/account_type.py +++ b/xero_python/accounting/models/account_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -41,8 +41,4 @@ class AccountType(Enum): REVENUE = "REVENUE" SALES = "SALES" TERMLIAB = "TERMLIAB" - PAYGLIABILITY = "PAYGLIABILITY" PAYG = "PAYG" - SUPERANNUATIONEXPENSE = "SUPERANNUATIONEXPENSE" - SUPERANNUATIONLIABILITY = "SUPERANNUATIONLIABILITY" - WAGESEXPENSE = "WAGESEXPENSE" diff --git a/xero_python/accounting/models/accounts.py b/xero_python/accounting/models/accounts.py index 4760a7da..dc0aaac8 100644 --- a/xero_python/accounting/models/accounts.py +++ b/xero_python/accounting/models/accounts.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/accounts_payable.py b/xero_python/accounting/models/accounts_payable.py index 38a3283f..02ff86e0 100644 --- a/xero_python/accounting/models/accounts_payable.py +++ b/xero_python/accounting/models/accounts_payable.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/accounts_receivable.py b/xero_python/accounting/models/accounts_receivable.py index 16c9da8a..c805a11f 100644 --- a/xero_python/accounting/models/accounts_receivable.py +++ b/xero_python/accounting/models/accounts_receivable.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/action.py b/xero_python/accounting/models/action.py index e6d2e9b4..b8cc6ccb 100644 --- a/xero_python/accounting/models/action.py +++ b/xero_python/accounting/models/action.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/actions.py b/xero_python/accounting/models/actions.py index 03cbc5fe..b5761dbd 100644 --- a/xero_python/accounting/models/actions.py +++ b/xero_python/accounting/models/actions.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/address.py b/xero_python/accounting/models/address.py index 29eb30c4..301ea029 100644 --- a/xero_python/accounting/models/address.py +++ b/xero_python/accounting/models/address.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/address_for_organisation.py b/xero_python/accounting/models/address_for_organisation.py index 02096169..7cfd2699 100644 --- a/xero_python/accounting/models/address_for_organisation.py +++ b/xero_python/accounting/models/address_for_organisation.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/allocation.py b/xero_python/accounting/models/allocation.py index 200a6e7d..aed149e2 100644 --- a/xero_python/accounting/models/allocation.py +++ b/xero_python/accounting/models/allocation.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -30,50 +30,60 @@ class Allocation(BaseModel): and the value is json key in definition. """ openapi_types = { + "allocation_id": "str", "invoice": "Invoice", "overpayment": "Overpayment", "prepayment": "Prepayment", "credit_note": "CreditNote", "amount": "float", "date": "date[ms-format]", + "is_deleted": "bool", "status_attribute_string": "str", "validation_errors": "list[ValidationError]", } attribute_map = { + "allocation_id": "AllocationID", "invoice": "Invoice", "overpayment": "Overpayment", "prepayment": "Prepayment", "credit_note": "CreditNote", "amount": "Amount", "date": "Date", + "is_deleted": "IsDeleted", "status_attribute_string": "StatusAttributeString", "validation_errors": "ValidationErrors", } def __init__( self, + allocation_id=None, invoice=None, overpayment=None, prepayment=None, credit_note=None, amount=None, date=None, + is_deleted=None, status_attribute_string=None, validation_errors=None, ): # noqa: E501 """Allocation - a model defined in OpenAPI""" # noqa: E501 + self._allocation_id = None self._invoice = None self._overpayment = None self._prepayment = None self._credit_note = None self._amount = None self._date = None + self._is_deleted = None self._status_attribute_string = None self._validation_errors = None self.discriminator = None + if allocation_id is not None: + self.allocation_id = allocation_id self.invoice = invoice if overpayment is not None: self.overpayment = overpayment @@ -83,11 +93,36 @@ def __init__( self.credit_note = credit_note self.amount = amount self.date = date + if is_deleted is not None: + self.is_deleted = is_deleted if status_attribute_string is not None: self.status_attribute_string = status_attribute_string if validation_errors is not None: self.validation_errors = validation_errors + @property + def allocation_id(self): + """Gets the allocation_id of this Allocation. # noqa: E501 + + Xero generated unique identifier # noqa: E501 + + :return: The allocation_id of this Allocation. # noqa: E501 + :rtype: str + """ + return self._allocation_id + + @allocation_id.setter + def allocation_id(self, allocation_id): + """Sets the allocation_id of this Allocation. + + Xero generated unique identifier # noqa: E501 + + :param allocation_id: The allocation_id of this Allocation. # noqa: E501 + :type: str + """ + + self._allocation_id = allocation_id + @property def invoice(self): """Gets the invoice of this Allocation. # noqa: E501 @@ -230,6 +265,29 @@ def date(self, date): self._date = date + @property + def is_deleted(self): + """Gets the is_deleted of this Allocation. # noqa: E501 + + A flag that returns true when the allocation is succesfully deleted # noqa: E501 + + :return: The is_deleted of this Allocation. # noqa: E501 + :rtype: bool + """ + return self._is_deleted + + @is_deleted.setter + def is_deleted(self, is_deleted): + """Sets the is_deleted of this Allocation. + + A flag that returns true when the allocation is succesfully deleted # noqa: E501 + + :param is_deleted: The is_deleted of this Allocation. # noqa: E501 + :type: bool + """ + + self._is_deleted = is_deleted + @property def status_attribute_string(self): """Gets the status_attribute_string of this Allocation. # noqa: E501 diff --git a/xero_python/accounting/models/allocations.py b/xero_python/accounting/models/allocations.py index 8af6bcac..cec2ff3a 100644 --- a/xero_python/accounting/models/allocations.py +++ b/xero_python/accounting/models/allocations.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/attachment.py b/xero_python/accounting/models/attachment.py index 36f982ae..6949b967 100644 --- a/xero_python/accounting/models/attachment.py +++ b/xero_python/accounting/models/attachment.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/attachments.py b/xero_python/accounting/models/attachments.py index e920289c..d64b48c6 100644 --- a/xero_python/accounting/models/attachments.py +++ b/xero_python/accounting/models/attachments.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/balance_details.py b/xero_python/accounting/models/balance_details.py index 028d43ef..2a91e677 100644 --- a/xero_python/accounting/models/balance_details.py +++ b/xero_python/accounting/models/balance_details.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/balances.py b/xero_python/accounting/models/balances.py index d881b5ee..e2d34a4d 100644 --- a/xero_python/accounting/models/balances.py +++ b/xero_python/accounting/models/balances.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/bank_transaction.py b/xero_python/accounting/models/bank_transaction.py index b0a1c45f..c32b8922 100644 --- a/xero_python/accounting/models/bank_transaction.py +++ b/xero_python/accounting/models/bank_transaction.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/bank_transactions.py b/xero_python/accounting/models/bank_transactions.py index b7bc4f39..0a3d949d 100644 --- a/xero_python/accounting/models/bank_transactions.py +++ b/xero_python/accounting/models/bank_transactions.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -29,19 +29,79 @@ class BankTransactions(BaseModel): attribute_map (dict): The key is attribute name and the value is json key in definition. """ - openapi_types = {"bank_transactions": "list[BankTransaction]"} - - attribute_map = {"bank_transactions": "BankTransactions"} - - def __init__(self, bank_transactions=None): # noqa: E501 + openapi_types = { + "pagination": "Pagination", + "warnings": "list[ValidationError]", + "bank_transactions": "list[BankTransaction]", + } + + attribute_map = { + "pagination": "pagination", + "warnings": "Warnings", + "bank_transactions": "BankTransactions", + } + + def __init__( + self, pagination=None, warnings=None, bank_transactions=None + ): # noqa: E501 """BankTransactions - a model defined in OpenAPI""" # noqa: E501 + self._pagination = None + self._warnings = None self._bank_transactions = None self.discriminator = None + if pagination is not None: + self.pagination = pagination + if warnings is not None: + self.warnings = warnings if bank_transactions is not None: self.bank_transactions = bank_transactions + @property + def pagination(self): + """Gets the pagination of this BankTransactions. # noqa: E501 + + + :return: The pagination of this BankTransactions. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this BankTransactions. + + + :param pagination: The pagination of this BankTransactions. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def warnings(self): + """Gets the warnings of this BankTransactions. # noqa: E501 + + Displays array of warning messages from the API # noqa: E501 + + :return: The warnings of this BankTransactions. # noqa: E501 + :rtype: list[ValidationError] + """ + return self._warnings + + @warnings.setter + def warnings(self, warnings): + """Sets the warnings of this BankTransactions. + + Displays array of warning messages from the API # noqa: E501 + + :param warnings: The warnings of this BankTransactions. # noqa: E501 + :type: list[ValidationError] + """ + + self._warnings = warnings + @property def bank_transactions(self): """Gets the bank_transactions of this BankTransactions. # noqa: E501 diff --git a/xero_python/accounting/models/bank_transfer.py b/xero_python/accounting/models/bank_transfer.py index ff1fe8e5..a0f88d73 100644 --- a/xero_python/accounting/models/bank_transfer.py +++ b/xero_python/accounting/models/bank_transfer.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -43,6 +43,9 @@ class BankTransfer(BaseModel): "reference": "str", "has_attachments": "bool", "created_date_utc": "datetime[ms-format]", + "status": "str", + "from_tracking": "list[TrackingReference]", + "to_tracking": "list[TrackingReference]", "validation_errors": "list[ValidationError]", } @@ -60,6 +63,9 @@ class BankTransfer(BaseModel): "reference": "Reference", "has_attachments": "HasAttachments", "created_date_utc": "CreatedDateUTC", + "status": "Status", + "from_tracking": "FromTracking", + "to_tracking": "ToTracking", "validation_errors": "ValidationErrors", } @@ -78,6 +84,9 @@ def __init__( reference=None, has_attachments=False, created_date_utc=None, + status=None, + from_tracking=None, + to_tracking=None, validation_errors=None, ): # noqa: E501 """BankTransfer - a model defined in OpenAPI""" # noqa: E501 @@ -95,6 +104,9 @@ def __init__( self._reference = None self._has_attachments = None self._created_date_utc = None + self._status = None + self._from_tracking = None + self._to_tracking = None self._validation_errors = None self.discriminator = None @@ -121,6 +133,12 @@ def __init__( self.has_attachments = has_attachments if created_date_utc is not None: self.created_date_utc = created_date_utc + if status is not None: + self.status = status + if from_tracking is not None: + self.from_tracking = from_tracking + if to_tracking is not None: + self.to_tracking = to_tracking if validation_errors is not None: self.validation_errors = validation_errors @@ -431,6 +449,84 @@ def created_date_utc(self, created_date_utc): self._created_date_utc = created_date_utc + @property + def status(self): + """Gets the status of this BankTransfer. # noqa: E501 + + AUTHORISED or DELETED (read-only). New bank transfers will have a status of AUTHORISED. # noqa: E501 + + :return: The status of this BankTransfer. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this BankTransfer. + + AUTHORISED or DELETED (read-only). New bank transfers will have a status of AUTHORISED. # noqa: E501 + + :param status: The status of this BankTransfer. # noqa: E501 + :type: str + """ + allowed_values = ["AUTHORISED", "DELETED", "None"] # noqa: E501 + + if status: + if status not in allowed_values: + raise ValueError( + "Invalid value for `status` ({0}), must be one of {1}".format( # noqa: E501 + status, allowed_values + ) + ) + + self._status = status + + @property + def from_tracking(self): + """Gets the from_tracking of this BankTransfer. # noqa: E501 + + Optional Tracking Category for the source account – see Tracking. A bank transfer can have a maximum of 2 tracking categories per account. # noqa: E501 + + :return: The from_tracking of this BankTransfer. # noqa: E501 + :rtype: list[TrackingReference] + """ + return self._from_tracking + + @from_tracking.setter + def from_tracking(self, from_tracking): + """Sets the from_tracking of this BankTransfer. + + Optional Tracking Category for the source account – see Tracking. A bank transfer can have a maximum of 2 tracking categories per account. # noqa: E501 + + :param from_tracking: The from_tracking of this BankTransfer. # noqa: E501 + :type: list[TrackingReference] + """ + + self._from_tracking = from_tracking + + @property + def to_tracking(self): + """Gets the to_tracking of this BankTransfer. # noqa: E501 + + Optional Tracking Category for the destination account – see Tracking. A bank transfer can have a maximum of 2 tracking categories per account. # noqa: E501 + + :return: The to_tracking of this BankTransfer. # noqa: E501 + :rtype: list[TrackingReference] + """ + return self._to_tracking + + @to_tracking.setter + def to_tracking(self, to_tracking): + """Sets the to_tracking of this BankTransfer. + + Optional Tracking Category for the destination account – see Tracking. A bank transfer can have a maximum of 2 tracking categories per account. # noqa: E501 + + :param to_tracking: The to_tracking of this BankTransfer. # noqa: E501 + :type: list[TrackingReference] + """ + + self._to_tracking = to_tracking + @property def validation_errors(self): """Gets the validation_errors of this BankTransfer. # noqa: E501 diff --git a/xero_python/accounting/models/bank_transfer_delete.py b/xero_python/accounting/models/bank_transfer_delete.py new file mode 100644 index 00000000..eac03713 --- /dev/null +++ b/xero_python/accounting/models/bank_transfer_delete.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" +Xero Accounting API + +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class BankTransferDelete(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = {"bank_transfer_id": "str", "status": "str"} + + attribute_map = {"bank_transfer_id": "BankTransferID", "status": "Status"} + + def __init__(self, bank_transfer_id=None, status="DELETED"): # noqa: E501 + """BankTransferDelete - a model defined in OpenAPI""" # noqa: E501 + + self._bank_transfer_id = None + self._status = None + self.discriminator = None + + self.bank_transfer_id = bank_transfer_id + self.status = status + + @property + def bank_transfer_id(self): + """Gets the bank_transfer_id of this BankTransferDelete. # noqa: E501 + + The Xero identifier for a bank transfer # noqa: E501 + + :return: The bank_transfer_id of this BankTransferDelete. # noqa: E501 + :rtype: str + """ + return self._bank_transfer_id + + @bank_transfer_id.setter + def bank_transfer_id(self, bank_transfer_id): + """Sets the bank_transfer_id of this BankTransferDelete. + + The Xero identifier for a bank transfer # noqa: E501 + + :param bank_transfer_id: The bank_transfer_id of this BankTransferDelete. # noqa: E501 + :type: str + """ + if bank_transfer_id is None: + raise ValueError( + "Invalid value for `bank_transfer_id`, must not be `None`" + ) # noqa: E501 + + self._bank_transfer_id = bank_transfer_id + + @property + def status(self): + """Gets the status of this BankTransferDelete. # noqa: E501 + + The status of the bank transfer. # noqa: E501 + + :return: The status of this BankTransferDelete. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this BankTransferDelete. + + The status of the bank transfer. # noqa: E501 + + :param status: The status of this BankTransferDelete. # noqa: E501 + :type: str + """ + if status is None: + raise ValueError( + "Invalid value for `status`, must not be `None`" + ) # noqa: E501 + + self._status = status diff --git a/xero_python/accounting/models/bank_transfer_delete_by_url_param.py b/xero_python/accounting/models/bank_transfer_delete_by_url_param.py new file mode 100644 index 00000000..117622be --- /dev/null +++ b/xero_python/accounting/models/bank_transfer_delete_by_url_param.py @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" +Xero Accounting API + +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class BankTransferDeleteByUrlParam(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = {"status": "str"} + + attribute_map = {"status": "Status"} + + def __init__(self, status="DELETED"): # noqa: E501 + """BankTransferDeleteByUrlParam - a model defined in OpenAPI""" # noqa: E501 + + self._status = None + self.discriminator = None + + self.status = status + + @property + def status(self): + """Gets the status of this BankTransferDeleteByUrlParam. # noqa: E501 + + The status of the bank transfer. # noqa: E501 + + :return: The status of this BankTransferDeleteByUrlParam. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this BankTransferDeleteByUrlParam. + + The status of the bank transfer. # noqa: E501 + + :param status: The status of this BankTransferDeleteByUrlParam. # noqa: E501 + :type: str + """ + if status is None: + raise ValueError( + "Invalid value for `status`, must not be `None`" + ) # noqa: E501 + + self._status = status diff --git a/xero_python/accounting/models/bank_transfers.py b/xero_python/accounting/models/bank_transfers.py index d711bed9..f707853b 100644 --- a/xero_python/accounting/models/bank_transfers.py +++ b/xero_python/accounting/models/bank_transfers.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/bank_transfers_delete.py b/xero_python/accounting/models/bank_transfers_delete.py new file mode 100644 index 00000000..76d38094 --- /dev/null +++ b/xero_python/accounting/models/bank_transfers_delete.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" +Xero Accounting API + +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class BankTransfersDelete(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = {"bank_transfers": "list[BankTransferDelete]"} + + attribute_map = {"bank_transfers": "BankTransfers"} + + def __init__(self, bank_transfers=None): # noqa: E501 + """BankTransfersDelete - a model defined in OpenAPI""" # noqa: E501 + + self._bank_transfers = None + self.discriminator = None + + if bank_transfers is not None: + self.bank_transfers = bank_transfers + + @property + def bank_transfers(self): + """Gets the bank_transfers of this BankTransfersDelete. # noqa: E501 + + + :return: The bank_transfers of this BankTransfersDelete. # noqa: E501 + :rtype: list[BankTransferDelete] + """ + return self._bank_transfers + + @bank_transfers.setter + def bank_transfers(self, bank_transfers): + """Sets the bank_transfers of this BankTransfersDelete. + + + :param bank_transfers: The bank_transfers of this BankTransfersDelete. # noqa: E501 + :type: list[BankTransferDelete] + """ + + self._bank_transfers = bank_transfers diff --git a/xero_python/accounting/models/batch_payment.py b/xero_python/accounting/models/batch_payment.py index 4cfddad7..8c37817b 100644 --- a/xero_python/accounting/models/batch_payment.py +++ b/xero_python/accounting/models/batch_payment.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -43,9 +43,9 @@ class BatchPayment(BaseModel): "payments": "list[Payment]", "type": "str", "status": "str", - "total_amount": "str", + "total_amount": "float", "updated_date_utc": "datetime[ms-format]", - "is_reconciled": "str", + "is_reconciled": "bool", "validation_errors": "list[ValidationError]", } @@ -486,7 +486,7 @@ def total_amount(self): The total of the payments that make up the batch (read-only) # noqa: E501 :return: The total_amount of this BatchPayment. # noqa: E501 - :rtype: str + :rtype: float """ return self._total_amount @@ -497,7 +497,7 @@ def total_amount(self, total_amount): The total of the payments that make up the batch (read-only) # noqa: E501 :param total_amount: The total_amount of this BatchPayment. # noqa: E501 - :type: str + :type: float """ self._total_amount = total_amount @@ -532,7 +532,7 @@ def is_reconciled(self): Booelan that tells you if the batch payment has been reconciled (read-only) # noqa: E501 :return: The is_reconciled of this BatchPayment. # noqa: E501 - :rtype: str + :rtype: bool """ return self._is_reconciled @@ -543,7 +543,7 @@ def is_reconciled(self, is_reconciled): Booelan that tells you if the batch payment has been reconciled (read-only) # noqa: E501 :param is_reconciled: The is_reconciled of this BatchPayment. # noqa: E501 - :type: str + :type: bool """ self._is_reconciled = is_reconciled diff --git a/xero_python/accounting/models/batch_payment_delete.py b/xero_python/accounting/models/batch_payment_delete.py new file mode 100644 index 00000000..96ecbd61 --- /dev/null +++ b/xero_python/accounting/models/batch_payment_delete.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" +Xero Accounting API + +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class BatchPaymentDelete(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = {"batch_payment_id": "str", "status": "str"} + + attribute_map = {"batch_payment_id": "BatchPaymentID", "status": "Status"} + + def __init__(self, batch_payment_id=None, status="DELETED"): # noqa: E501 + """BatchPaymentDelete - a model defined in OpenAPI""" # noqa: E501 + + self._batch_payment_id = None + self._status = None + self.discriminator = None + + self.batch_payment_id = batch_payment_id + self.status = status + + @property + def batch_payment_id(self): + """Gets the batch_payment_id of this BatchPaymentDelete. # noqa: E501 + + The Xero generated unique identifier for the bank transaction (read-only) # noqa: E501 + + :return: The batch_payment_id of this BatchPaymentDelete. # noqa: E501 + :rtype: str + """ + return self._batch_payment_id + + @batch_payment_id.setter + def batch_payment_id(self, batch_payment_id): + """Sets the batch_payment_id of this BatchPaymentDelete. + + The Xero generated unique identifier for the bank transaction (read-only) # noqa: E501 + + :param batch_payment_id: The batch_payment_id of this BatchPaymentDelete. # noqa: E501 + :type: str + """ + if batch_payment_id is None: + raise ValueError( + "Invalid value for `batch_payment_id`, must not be `None`" + ) # noqa: E501 + + self._batch_payment_id = batch_payment_id + + @property + def status(self): + """Gets the status of this BatchPaymentDelete. # noqa: E501 + + The status of the batch payment. # noqa: E501 + + :return: The status of this BatchPaymentDelete. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this BatchPaymentDelete. + + The status of the batch payment. # noqa: E501 + + :param status: The status of this BatchPaymentDelete. # noqa: E501 + :type: str + """ + if status is None: + raise ValueError( + "Invalid value for `status`, must not be `None`" + ) # noqa: E501 + + self._status = status diff --git a/xero_python/accounting/models/batch_payment_delete_by_url_param.py b/xero_python/accounting/models/batch_payment_delete_by_url_param.py new file mode 100644 index 00000000..3a5ebeb6 --- /dev/null +++ b/xero_python/accounting/models/batch_payment_delete_by_url_param.py @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" +Xero Accounting API + +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class BatchPaymentDeleteByUrlParam(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = {"status": "str"} + + attribute_map = {"status": "Status"} + + def __init__(self, status="DELETED"): # noqa: E501 + """BatchPaymentDeleteByUrlParam - a model defined in OpenAPI""" # noqa: E501 + + self._status = None + self.discriminator = None + + self.status = status + + @property + def status(self): + """Gets the status of this BatchPaymentDeleteByUrlParam. # noqa: E501 + + The status of the batch payment. # noqa: E501 + + :return: The status of this BatchPaymentDeleteByUrlParam. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this BatchPaymentDeleteByUrlParam. + + The status of the batch payment. # noqa: E501 + + :param status: The status of this BatchPaymentDeleteByUrlParam. # noqa: E501 + :type: str + """ + if status is None: + raise ValueError( + "Invalid value for `status`, must not be `None`" + ) # noqa: E501 + + self._status = status diff --git a/xero_python/accounting/models/batch_payment_details.py b/xero_python/accounting/models/batch_payment_details.py index 26ede767..0bf18b4d 100644 --- a/xero_python/accounting/models/batch_payment_details.py +++ b/xero_python/accounting/models/batch_payment_details.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/batch_payments.py b/xero_python/accounting/models/batch_payments.py index 6bf51304..92d525d4 100644 --- a/xero_python/accounting/models/batch_payments.py +++ b/xero_python/accounting/models/batch_payments.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/bill.py b/xero_python/accounting/models/bill.py index e061e8d0..5f350f41 100644 --- a/xero_python/accounting/models/bill.py +++ b/xero_python/accounting/models/bill.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/branding_theme.py b/xero_python/accounting/models/branding_theme.py index aed92601..2ed4cb08 100644 --- a/xero_python/accounting/models/branding_theme.py +++ b/xero_python/accounting/models/branding_theme.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/branding_themes.py b/xero_python/accounting/models/branding_themes.py index 70b20a1f..3fcb6063 100644 --- a/xero_python/accounting/models/branding_themes.py +++ b/xero_python/accounting/models/branding_themes.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/budget.py b/xero_python/accounting/models/budget.py index d1c1db28..3cc5d61a 100644 --- a/xero_python/accounting/models/budget.py +++ b/xero_python/accounting/models/budget.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/budget_balance.py b/xero_python/accounting/models/budget_balance.py index e139a42b..7537de9f 100644 --- a/xero_python/accounting/models/budget_balance.py +++ b/xero_python/accounting/models/budget_balance.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/budget_line.py b/xero_python/accounting/models/budget_line.py index 0c311919..6df261db 100644 --- a/xero_python/accounting/models/budget_line.py +++ b/xero_python/accounting/models/budget_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/budget_lines.py b/xero_python/accounting/models/budget_lines.py deleted file mode 100644 index 632f2639..00000000 --- a/xero_python/accounting/models/budget_lines.py +++ /dev/null @@ -1,161 +0,0 @@ -# coding: utf-8 - -""" - Xero Accounting API - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - Contact: api@xero.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 - -from xero_python.models import BaseModel - - -class BudgetLines(BaseModel): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - """ - Attributes: - openapi_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - openapi_types = { - "period": "date[ms-format]", - "amount": "int", - "unit_amount": "int", - "notes": "str", - } - - attribute_map = { - "period": "Period", - "amount": "Amount", - "unit_amount": "UnitAmount", - "notes": "Notes", - } - - def __init__( - self, period=None, amount=None, unit_amount=None, notes=None - ): # noqa: E501 - """BudgetLines - a model defined in OpenAPI""" # noqa: E501 - - self._period = None - self._amount = None - self._unit_amount = None - self._notes = None - self.discriminator = None - - if period is not None: - self.period = period - if amount is not None: - self.amount = amount - if unit_amount is not None: - self.unit_amount = unit_amount - if notes is not None: - self.notes = notes - - @property - def period(self): - """Gets the period of this BudgetLines. # noqa: E501 - - Period the amount applies to (e.g. “2019-08”) # noqa: E501 - - :return: The period of this BudgetLines. # noqa: E501 - :rtype: date - """ - return self._period - - @period.setter - def period(self, period): - """Sets the period of this BudgetLines. - - Period the amount applies to (e.g. “2019-08”) # noqa: E501 - - :param period: The period of this BudgetLines. # noqa: E501 - :type: date - """ - - self._period = period - - @property - def amount(self): - """Gets the amount of this BudgetLines. # noqa: E501 - - LineItem Quantity # noqa: E501 - - :return: The amount of this BudgetLines. # noqa: E501 - :rtype: int - """ - return self._amount - - @amount.setter - def amount(self, amount): - """Sets the amount of this BudgetLines. - - LineItem Quantity # noqa: E501 - - :param amount: The amount of this BudgetLines. # noqa: E501 - :type: int - """ - - self._amount = amount - - @property - def unit_amount(self): - """Gets the unit_amount of this BudgetLines. # noqa: E501 - - Budgeted amount # noqa: E501 - - :return: The unit_amount of this BudgetLines. # noqa: E501 - :rtype: int - """ - return self._unit_amount - - @unit_amount.setter - def unit_amount(self, unit_amount): - """Sets the unit_amount of this BudgetLines. - - Budgeted amount # noqa: E501 - - :param unit_amount: The unit_amount of this BudgetLines. # noqa: E501 - :type: int - """ - - self._unit_amount = unit_amount - - @property - def notes(self): - """Gets the notes of this BudgetLines. # noqa: E501 - - Any footnotes associated with this balance # noqa: E501 - - :return: The notes of this BudgetLines. # noqa: E501 - :rtype: str - """ - return self._notes - - @notes.setter - def notes(self, notes): - """Sets the notes of this BudgetLines. - - Any footnotes associated with this balance # noqa: E501 - - :param notes: The notes of this BudgetLines. # noqa: E501 - :type: str - """ - if notes is not None and len(notes) > 255: - raise ValueError( - "Invalid value for `notes`, " - "length must be less than or equal to `255`" - ) # noqa: E501 - - self._notes = notes diff --git a/xero_python/accounting/models/budgets.py b/xero_python/accounting/models/budgets.py index f42d49dc..c9b62827 100644 --- a/xero_python/accounting/models/budgets.py +++ b/xero_python/accounting/models/budgets.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/cis_org_setting.py b/xero_python/accounting/models/cis_org_setting.py index e0dfafd9..cee742cd 100644 --- a/xero_python/accounting/models/cis_org_setting.py +++ b/xero_python/accounting/models/cis_org_setting.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/cis_org_settings.py b/xero_python/accounting/models/cis_org_settings.py index fd731399..c10eebeb 100644 --- a/xero_python/accounting/models/cis_org_settings.py +++ b/xero_python/accounting/models/cis_org_settings.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/cis_setting.py b/xero_python/accounting/models/cis_setting.py index 8783c1ea..51ea3b32 100644 --- a/xero_python/accounting/models/cis_setting.py +++ b/xero_python/accounting/models/cis_setting.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/cis_settings.py b/xero_python/accounting/models/cis_settings.py index 46e0e6e3..8099e4dd 100644 --- a/xero_python/accounting/models/cis_settings.py +++ b/xero_python/accounting/models/cis_settings.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/contact.py b/xero_python/accounting/models/contact.py index a41d1e29..93415060 100644 --- a/xero_python/accounting/models/contact.py +++ b/xero_python/accounting/models/contact.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -40,10 +40,10 @@ class Contact(BaseModel): "last_name": "str", "company_number": "str", "email_address": "str", - "skype_user_name": "str", "contact_persons": "list[ContactPerson]", "bank_account_details": "str", "tax_number": "str", + "tax_number_type": "str", "accounts_receivable_tax_type": "str", "accounts_payable_tax_type": "str", "addresses": "list[Address]", @@ -86,10 +86,10 @@ class Contact(BaseModel): "last_name": "LastName", "company_number": "CompanyNumber", "email_address": "EmailAddress", - "skype_user_name": "SkypeUserName", "contact_persons": "ContactPersons", "bank_account_details": "BankAccountDetails", "tax_number": "TaxNumber", + "tax_number_type": "TaxNumberType", "accounts_receivable_tax_type": "AccountsReceivableTaxType", "accounts_payable_tax_type": "AccountsPayableTaxType", "addresses": "Addresses", @@ -133,10 +133,10 @@ def __init__( last_name=None, company_number=None, email_address=None, - skype_user_name=None, contact_persons=None, bank_account_details=None, tax_number=None, + tax_number_type=None, accounts_receivable_tax_type=None, accounts_payable_tax_type=None, addresses=None, @@ -179,10 +179,10 @@ def __init__( self._last_name = None self._company_number = None self._email_address = None - self._skype_user_name = None self._contact_persons = None self._bank_account_details = None self._tax_number = None + self._tax_number_type = None self._accounts_receivable_tax_type = None self._accounts_payable_tax_type = None self._addresses = None @@ -234,14 +234,14 @@ def __init__( self.company_number = company_number if email_address is not None: self.email_address = email_address - if skype_user_name is not None: - self.skype_user_name = skype_user_name if contact_persons is not None: self.contact_persons = contact_persons if bank_account_details is not None: self.bank_account_details = bank_account_details if tax_number is not None: self.tax_number = tax_number + if tax_number_type is not None: + self.tax_number_type = tax_number_type if accounts_receivable_tax_type is not None: self.accounts_receivable_tax_type = accounts_receivable_tax_type if accounts_payable_tax_type is not None: @@ -575,29 +575,6 @@ def email_address(self, email_address): self._email_address = email_address - @property - def skype_user_name(self): - """Gets the skype_user_name of this Contact. # noqa: E501 - - Skype user name of contact # noqa: E501 - - :return: The skype_user_name of this Contact. # noqa: E501 - :rtype: str - """ - return self._skype_user_name - - @skype_user_name.setter - def skype_user_name(self, skype_user_name): - """Sets the skype_user_name of this Contact. - - Skype user name of contact # noqa: E501 - - :param skype_user_name: The skype_user_name of this Contact. # noqa: E501 - :type: str - """ - - self._skype_user_name = skype_user_name - @property def contact_persons(self): """Gets the contact_persons of this Contact. # noqa: E501 @@ -672,6 +649,38 @@ def tax_number(self, tax_number): self._tax_number = tax_number + @property + def tax_number_type(self): + """Gets the tax_number_type of this Contact. # noqa: E501 + + Identifier of the regional type of tax number, such as US, UK, or other regional tax identifiers # noqa: E501 + + :return: The tax_number_type of this Contact. # noqa: E501 + :rtype: str + """ + return self._tax_number_type + + @tax_number_type.setter + def tax_number_type(self, tax_number_type): + """Sets the tax_number_type of this Contact. + + Identifier of the regional type of tax number, such as US, UK, or other regional tax identifiers # noqa: E501 + + :param tax_number_type: The tax_number_type of this Contact. # noqa: E501 + :type: str + """ + allowed_values = ["SSN", "EIN", "ITIN", "ATIN", "None"] # noqa: E501 + + if tax_number_type: + if tax_number_type not in allowed_values: + raise ValueError( + "Invalid value for `tax_number_type` ({0}), must be one of {1}".format( # noqa: E501 + tax_number_type, allowed_values + ) + ) + + self._tax_number_type = tax_number_type + @property def accounts_receivable_tax_type(self): """Gets the accounts_receivable_tax_type of this Contact. # noqa: E501 diff --git a/xero_python/accounting/models/contact_group.py b/xero_python/accounting/models/contact_group.py index 9cd69113..a8b6e56e 100644 --- a/xero_python/accounting/models/contact_group.py +++ b/xero_python/accounting/models/contact_group.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/contact_groups.py b/xero_python/accounting/models/contact_groups.py index bce51bcd..86941a0c 100644 --- a/xero_python/accounting/models/contact_groups.py +++ b/xero_python/accounting/models/contact_groups.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/contact_person.py b/xero_python/accounting/models/contact_person.py index c15cc088..a4579ce0 100644 --- a/xero_python/accounting/models/contact_person.py +++ b/xero_python/accounting/models/contact_person.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/contacts.py b/xero_python/accounting/models/contacts.py index 3c282333..654a6128 100644 --- a/xero_python/accounting/models/contacts.py +++ b/xero_python/accounting/models/contacts.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -29,19 +29,77 @@ class Contacts(BaseModel): attribute_map (dict): The key is attribute name and the value is json key in definition. """ - openapi_types = {"contacts": "list[Contact]"} - - attribute_map = {"contacts": "Contacts"} - - def __init__(self, contacts=None): # noqa: E501 + openapi_types = { + "pagination": "Pagination", + "warnings": "list[ValidationError]", + "contacts": "list[Contact]", + } + + attribute_map = { + "pagination": "pagination", + "warnings": "Warnings", + "contacts": "Contacts", + } + + def __init__(self, pagination=None, warnings=None, contacts=None): # noqa: E501 """Contacts - a model defined in OpenAPI""" # noqa: E501 + self._pagination = None + self._warnings = None self._contacts = None self.discriminator = None + if pagination is not None: + self.pagination = pagination + if warnings is not None: + self.warnings = warnings if contacts is not None: self.contacts = contacts + @property + def pagination(self): + """Gets the pagination of this Contacts. # noqa: E501 + + + :return: The pagination of this Contacts. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this Contacts. + + + :param pagination: The pagination of this Contacts. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def warnings(self): + """Gets the warnings of this Contacts. # noqa: E501 + + Displays array of warning messages from the API # noqa: E501 + + :return: The warnings of this Contacts. # noqa: E501 + :rtype: list[ValidationError] + """ + return self._warnings + + @warnings.setter + def warnings(self, warnings): + """Sets the warnings of this Contacts. + + Displays array of warning messages from the API # noqa: E501 + + :param warnings: The warnings of this Contacts. # noqa: E501 + :type: list[ValidationError] + """ + + self._warnings = warnings + @property def contacts(self): """Gets the contacts of this Contacts. # noqa: E501 diff --git a/xero_python/accounting/models/conversion_balances.py b/xero_python/accounting/models/conversion_balances.py index 25c218a8..6980d7b1 100644 --- a/xero_python/accounting/models/conversion_balances.py +++ b/xero_python/accounting/models/conversion_balances.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/conversion_date.py b/xero_python/accounting/models/conversion_date.py index dd2ed01a..d12cdd87 100644 --- a/xero_python/accounting/models/conversion_date.py +++ b/xero_python/accounting/models/conversion_date.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/country_code.py b/xero_python/accounting/models/country_code.py index 92225ce1..378672e5 100644 --- a/xero_python/accounting/models/country_code.py +++ b/xero_python/accounting/models/country_code.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/credit_note.py b/xero_python/accounting/models/credit_note.py index e9967365..f115d24d 100644 --- a/xero_python/accounting/models/credit_note.py +++ b/xero_python/accounting/models/credit_note.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -43,6 +43,7 @@ class CreditNote(BaseModel): "cis_deduction": "float", "cis_rate": "float", "updated_date_utc": "datetime[ms-format]", + "updated_date_utc_string": "str", "currency_code": "CurrencyCode", "fully_paid_on_date": "date[ms-format]", "credit_note_id": "str", @@ -60,6 +61,7 @@ class CreditNote(BaseModel): "has_errors": "bool", "validation_errors": "list[ValidationError]", "warnings": "list[ValidationError]", + "invoice_addresses": "list[InvoiceAddress]", } attribute_map = { @@ -76,6 +78,7 @@ class CreditNote(BaseModel): "cis_deduction": "CISDeduction", "cis_rate": "CISRate", "updated_date_utc": "UpdatedDateUTC", + "updated_date_utc_string": "UpdatedDateUTCString", "currency_code": "CurrencyCode", "fully_paid_on_date": "FullyPaidOnDate", "credit_note_id": "CreditNoteID", @@ -93,6 +96,7 @@ class CreditNote(BaseModel): "has_errors": "HasErrors", "validation_errors": "ValidationErrors", "warnings": "Warnings", + "invoice_addresses": "InvoiceAddresses", } def __init__( @@ -110,6 +114,7 @@ def __init__( cis_deduction=None, cis_rate=None, updated_date_utc=None, + updated_date_utc_string=None, currency_code=None, fully_paid_on_date=None, credit_note_id=None, @@ -127,6 +132,7 @@ def __init__( has_errors=False, validation_errors=None, warnings=None, + invoice_addresses=None, ): # noqa: E501 """CreditNote - a model defined in OpenAPI""" # noqa: E501 @@ -143,6 +149,7 @@ def __init__( self._cis_deduction = None self._cis_rate = None self._updated_date_utc = None + self._updated_date_utc_string = None self._currency_code = None self._fully_paid_on_date = None self._credit_note_id = None @@ -160,6 +167,7 @@ def __init__( self._has_errors = None self._validation_errors = None self._warnings = None + self._invoice_addresses = None self.discriminator = None if type is not None: @@ -188,6 +196,8 @@ def __init__( self.cis_rate = cis_rate if updated_date_utc is not None: self.updated_date_utc = updated_date_utc + if updated_date_utc_string is not None: + self.updated_date_utc_string = updated_date_utc_string if currency_code is not None: self.currency_code = currency_code if fully_paid_on_date is not None: @@ -222,6 +232,8 @@ def __init__( self.validation_errors = validation_errors if warnings is not None: self.warnings = warnings + if invoice_addresses is not None: + self.invoice_addresses = invoice_addresses @property def type(self): @@ -544,6 +556,29 @@ def updated_date_utc(self, updated_date_utc): self._updated_date_utc = updated_date_utc + @property + def updated_date_utc_string(self): + """Gets the updated_date_utc_string of this CreditNote. # noqa: E501 + + UTC ISO-8601 formatted timestamp of last update to the credit note # noqa: E501 + + :return: The updated_date_utc_string of this CreditNote. # noqa: E501 + :rtype: str + """ + return self._updated_date_utc_string + + @updated_date_utc_string.setter + def updated_date_utc_string(self, updated_date_utc_string): + """Sets the updated_date_utc_string of this CreditNote. + + UTC ISO-8601 formatted timestamp of last update to the credit note # noqa: E501 + + :param updated_date_utc_string: The updated_date_utc_string of this CreditNote. # noqa: E501 + :type: str + """ + + self._updated_date_utc_string = updated_date_utc_string + @property def currency_code(self): """Gets the currency_code of this CreditNote. # noqa: E501 @@ -661,7 +696,7 @@ def reference(self, reference): def sent_to_contact(self): """Gets the sent_to_contact of this CreditNote. # noqa: E501 - boolean to indicate if a credit note has been sent to a contact via the Xero app (currently read only) # noqa: E501 + Boolean to set whether the credit note in the Xero app should be marked as “sent”. This can be set only on credit notes that have been approved # noqa: E501 :return: The sent_to_contact of this CreditNote. # noqa: E501 :rtype: bool @@ -672,7 +707,7 @@ def sent_to_contact(self): def sent_to_contact(self, sent_to_contact): """Sets the sent_to_contact of this CreditNote. - boolean to indicate if a credit note has been sent to a contact via the Xero app (currently read only) # noqa: E501 + Boolean to set whether the credit note in the Xero app should be marked as “sent”. This can be set only on credit notes that have been approved # noqa: E501 :param sent_to_contact: The sent_to_contact of this CreditNote. # noqa: E501 :type: bool @@ -932,3 +967,26 @@ def warnings(self, warnings): """ self._warnings = warnings + + @property + def invoice_addresses(self): + """Gets the invoice_addresses of this CreditNote. # noqa: E501 + + An array of addresses used to auto calculate sales tax # noqa: E501 + + :return: The invoice_addresses of this CreditNote. # noqa: E501 + :rtype: list[InvoiceAddress] + """ + return self._invoice_addresses + + @invoice_addresses.setter + def invoice_addresses(self, invoice_addresses): + """Sets the invoice_addresses of this CreditNote. + + An array of addresses used to auto calculate sales tax # noqa: E501 + + :param invoice_addresses: The invoice_addresses of this CreditNote. # noqa: E501 + :type: list[InvoiceAddress] + """ + + self._invoice_addresses = invoice_addresses diff --git a/xero_python/accounting/models/credit_notes.py b/xero_python/accounting/models/credit_notes.py index 68464a16..70ae1003 100644 --- a/xero_python/accounting/models/credit_notes.py +++ b/xero_python/accounting/models/credit_notes.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -29,19 +29,77 @@ class CreditNotes(BaseModel): attribute_map (dict): The key is attribute name and the value is json key in definition. """ - openapi_types = {"credit_notes": "list[CreditNote]"} - - attribute_map = {"credit_notes": "CreditNotes"} - - def __init__(self, credit_notes=None): # noqa: E501 + openapi_types = { + "pagination": "Pagination", + "warnings": "list[ValidationError]", + "credit_notes": "list[CreditNote]", + } + + attribute_map = { + "pagination": "pagination", + "warnings": "Warnings", + "credit_notes": "CreditNotes", + } + + def __init__(self, pagination=None, warnings=None, credit_notes=None): # noqa: E501 """CreditNotes - a model defined in OpenAPI""" # noqa: E501 + self._pagination = None + self._warnings = None self._credit_notes = None self.discriminator = None + if pagination is not None: + self.pagination = pagination + if warnings is not None: + self.warnings = warnings if credit_notes is not None: self.credit_notes = credit_notes + @property + def pagination(self): + """Gets the pagination of this CreditNotes. # noqa: E501 + + + :return: The pagination of this CreditNotes. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this CreditNotes. + + + :param pagination: The pagination of this CreditNotes. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def warnings(self): + """Gets the warnings of this CreditNotes. # noqa: E501 + + Displays array of warning messages from the API # noqa: E501 + + :return: The warnings of this CreditNotes. # noqa: E501 + :rtype: list[ValidationError] + """ + return self._warnings + + @warnings.setter + def warnings(self, warnings): + """Sets the warnings of this CreditNotes. + + Displays array of warning messages from the API # noqa: E501 + + :param warnings: The warnings of this CreditNotes. # noqa: E501 + :type: list[ValidationError] + """ + + self._warnings = warnings + @property def credit_notes(self): """Gets the credit_notes of this CreditNotes. # noqa: E501 diff --git a/xero_python/accounting/models/currencies.py b/xero_python/accounting/models/currencies.py index da5d13d8..ea088c0e 100644 --- a/xero_python/accounting/models/currencies.py +++ b/xero_python/accounting/models/currencies.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/currency.py b/xero_python/accounting/models/currency.py index b9c2b578..44b65757 100644 --- a/xero_python/accounting/models/currency.py +++ b/xero_python/accounting/models/currency.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/currency_code.py b/xero_python/accounting/models/currency_code.py index 8db1c6d8..c408077d 100644 --- a/xero_python/accounting/models/currency_code.py +++ b/xero_python/accounting/models/currency_code.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -53,6 +53,7 @@ class CurrencyCode(Enum): CAD = "CAD" CDF = "CDF" CHF = "CHF" + CLF = "CLF" CLP = "CLP" CNY = "CNY" COP = "COP" @@ -65,6 +66,7 @@ class CurrencyCode(Enum): DKK = "DKK" DOP = "DOP" DZD = "DZD" + EEK = "EEK" EGP = "EGP" ERN = "ERN" ETB = "ETB" @@ -73,7 +75,6 @@ class CurrencyCode(Enum): FKP = "FKP" GBP = "GBP" GEL = "GEL" - GGP = "GGP" GHS = "GHS" GIP = "GIP" GMD = "GMD" @@ -87,12 +88,10 @@ class CurrencyCode(Enum): HUF = "HUF" IDR = "IDR" ILS = "ILS" - IMP = "IMP" INR = "INR" IQD = "IQD" IRR = "IRR" ISK = "ISK" - JEP = "JEP" JMD = "JMD" JOD = "JOD" JPY = "JPY" @@ -111,6 +110,7 @@ class CurrencyCode(Enum): LRD = "LRD" LSL = "LSL" LTL = "LTL" + LVL = "LVL" LYD = "LYD" MAD = "MAD" MDL = "MDL" @@ -119,11 +119,13 @@ class CurrencyCode(Enum): MMK = "MMK" MNT = "MNT" MOP = "MOP" + MRO = "MRO" MRU = "MRU" MUR = "MUR" MVR = "MVR" MWK = "MWK" MXN = "MXN" + MXV = "MXV" MYR = "MYR" MZN = "MZN" NAD = "NAD" @@ -152,11 +154,13 @@ class CurrencyCode(Enum): SEK = "SEK" SGD = "SGD" SHP = "SHP" + SKK = "SKK" + SLE = "SLE" SLL = "SLL" SOS = "SOS" - SPL = "SPL" SRD = "SRD" - STN = "STN" + STN = "STD" + STD = "STN" SVC = "SVC" SYP = "SYP" SZL = "SZL" @@ -167,7 +171,6 @@ class CurrencyCode(Enum): TOP = "TOP" TRY_LIRA = "TRY" TTD = "TTD" - TVD = "TVD" TWD = "TWD" TZS = "TZS" UAH = "UAH" @@ -176,12 +179,12 @@ class CurrencyCode(Enum): UYU = "UYU" UZS = "UZS" VEF = "VEF" + VES = "VES" VND = "VND" VUV = "VUV" WST = "WST" XAF = "XAF" XCD = "XCD" - XDR = "XDR" XOF = "XOF" XPF = "XPF" YER = "YER" @@ -189,4 +192,3 @@ class CurrencyCode(Enum): ZMW = "ZMW" ZMK = "ZMK" ZWD = "ZWD" - EMPTY_CURRENCY = "" diff --git a/xero_python/accounting/models/element.py b/xero_python/accounting/models/element.py index 03ac5c8b..e1839d63 100644 --- a/xero_python/accounting/models/element.py +++ b/xero_python/accounting/models/element.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/employee.py b/xero_python/accounting/models/employee.py index 3dc407e8..9620048b 100644 --- a/xero_python/accounting/models/employee.py +++ b/xero_python/accounting/models/employee.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/employees.py b/xero_python/accounting/models/employees.py index df589850..e4d2ded2 100644 --- a/xero_python/accounting/models/employees.py +++ b/xero_python/accounting/models/employees.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/error.py b/xero_python/accounting/models/error.py index a6ade5ff..2f45e1fd 100644 --- a/xero_python/accounting/models/error.py +++ b/xero_python/accounting/models/error.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/expense_claim.py b/xero_python/accounting/models/expense_claim.py index 2bef393e..5b098361 100644 --- a/xero_python/accounting/models/expense_claim.py +++ b/xero_python/accounting/models/expense_claim.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/expense_claims.py b/xero_python/accounting/models/expense_claims.py index 9059e32f..f22b4802 100644 --- a/xero_python/accounting/models/expense_claims.py +++ b/xero_python/accounting/models/expense_claims.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/external_link.py b/xero_python/accounting/models/external_link.py index 03255533..d9407093 100644 --- a/xero_python/accounting/models/external_link.py +++ b/xero_python/accounting/models/external_link.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/history_record.py b/xero_python/accounting/models/history_record.py index ac050085..26dca8ab 100644 --- a/xero_python/accounting/models/history_record.py +++ b/xero_python/accounting/models/history_record.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/history_records.py b/xero_python/accounting/models/history_records.py index 4f582690..bd89d097 100644 --- a/xero_python/accounting/models/history_records.py +++ b/xero_python/accounting/models/history_records.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/import_summary.py b/xero_python/accounting/models/import_summary.py index 9671b738..9fa3f1a3 100644 --- a/xero_python/accounting/models/import_summary.py +++ b/xero_python/accounting/models/import_summary.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/import_summary_accounts.py b/xero_python/accounting/models/import_summary_accounts.py index d5b90723..407111f6 100644 --- a/xero_python/accounting/models/import_summary_accounts.py +++ b/xero_python/accounting/models/import_summary_accounts.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/import_summary_object.py b/xero_python/accounting/models/import_summary_object.py index cf53020b..08b8a84e 100644 --- a/xero_python/accounting/models/import_summary_object.py +++ b/xero_python/accounting/models/import_summary_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/import_summary_organisation.py b/xero_python/accounting/models/import_summary_organisation.py index 4f019e37..cb9bee67 100644 --- a/xero_python/accounting/models/import_summary_organisation.py +++ b/xero_python/accounting/models/import_summary_organisation.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/invoice.py b/xero_python/accounting/models/invoice.py index ce7cacab..a55901af 100644 --- a/xero_python/accounting/models/invoice.py +++ b/xero_python/accounting/models/invoice.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -64,12 +64,14 @@ class Invoice(BaseModel): "fully_paid_on_date": "date[ms-format]", "amount_credited": "float", "updated_date_utc": "datetime[ms-format]", + "updated_date_utc_string": "str", "credit_notes": "list[CreditNote]", "attachments": "list[Attachment]", "has_errors": "bool", "status_attribute_string": "str", "validation_errors": "list[ValidationError]", "warnings": "list[ValidationError]", + "invoice_addresses": "list[InvoiceAddress]", } attribute_map = { @@ -107,12 +109,14 @@ class Invoice(BaseModel): "fully_paid_on_date": "FullyPaidOnDate", "amount_credited": "AmountCredited", "updated_date_utc": "UpdatedDateUTC", + "updated_date_utc_string": "UpdatedDateUTCString", "credit_notes": "CreditNotes", "attachments": "Attachments", "has_errors": "HasErrors", "status_attribute_string": "StatusAttributeString", "validation_errors": "ValidationErrors", "warnings": "Warnings", + "invoice_addresses": "InvoiceAddresses", } def __init__( @@ -151,12 +155,14 @@ def __init__( fully_paid_on_date=None, amount_credited=None, updated_date_utc=None, + updated_date_utc_string=None, credit_notes=None, attachments=None, has_errors=False, status_attribute_string=None, validation_errors=None, warnings=None, + invoice_addresses=None, ): # noqa: E501 """Invoice - a model defined in OpenAPI""" # noqa: E501 @@ -194,12 +200,14 @@ def __init__( self._fully_paid_on_date = None self._amount_credited = None self._updated_date_utc = None + self._updated_date_utc_string = None self._credit_notes = None self._attachments = None self._has_errors = None self._status_attribute_string = None self._validation_errors = None self._warnings = None + self._invoice_addresses = None self.discriminator = None if type is not None: @@ -270,6 +278,8 @@ def __init__( self.amount_credited = amount_credited if updated_date_utc is not None: self.updated_date_utc = updated_date_utc + if updated_date_utc_string is not None: + self.updated_date_utc_string = updated_date_utc_string if credit_notes is not None: self.credit_notes = credit_notes if attachments is not None: @@ -282,6 +292,8 @@ def __init__( self.validation_errors = validation_errors if warnings is not None: self.warnings = warnings + if invoice_addresses is not None: + self.invoice_addresses = invoice_addresses @property def type(self): @@ -1081,7 +1093,7 @@ def amount_credited(self, amount_credited): def updated_date_utc(self): """Gets the updated_date_utc of this Invoice. # noqa: E501 - Last modified date UTC format # noqa: E501 + UTC timestamp of last update to the invoice # noqa: E501 :return: The updated_date_utc of this Invoice. # noqa: E501 :rtype: datetime @@ -1092,7 +1104,7 @@ def updated_date_utc(self): def updated_date_utc(self, updated_date_utc): """Sets the updated_date_utc of this Invoice. - Last modified date UTC format # noqa: E501 + UTC timestamp of last update to the invoice # noqa: E501 :param updated_date_utc: The updated_date_utc of this Invoice. # noqa: E501 :type: datetime @@ -1100,6 +1112,29 @@ def updated_date_utc(self, updated_date_utc): self._updated_date_utc = updated_date_utc + @property + def updated_date_utc_string(self): + """Gets the updated_date_utc_string of this Invoice. # noqa: E501 + + UTC ISO-8601 formatted timestamp of last update to the invoice # noqa: E501 + + :return: The updated_date_utc_string of this Invoice. # noqa: E501 + :rtype: str + """ + return self._updated_date_utc_string + + @updated_date_utc_string.setter + def updated_date_utc_string(self, updated_date_utc_string): + """Sets the updated_date_utc_string of this Invoice. + + UTC ISO-8601 formatted timestamp of last update to the invoice # noqa: E501 + + :param updated_date_utc_string: The updated_date_utc_string of this Invoice. # noqa: E501 + :type: str + """ + + self._updated_date_utc_string = updated_date_utc_string + @property def credit_notes(self): """Gets the credit_notes of this Invoice. # noqa: E501 @@ -1237,3 +1272,26 @@ def warnings(self, warnings): """ self._warnings = warnings + + @property + def invoice_addresses(self): + """Gets the invoice_addresses of this Invoice. # noqa: E501 + + An array of addresses used to auto calculate sales tax # noqa: E501 + + :return: The invoice_addresses of this Invoice. # noqa: E501 + :rtype: list[InvoiceAddress] + """ + return self._invoice_addresses + + @invoice_addresses.setter + def invoice_addresses(self, invoice_addresses): + """Sets the invoice_addresses of this Invoice. + + An array of addresses used to auto calculate sales tax # noqa: E501 + + :param invoice_addresses: The invoice_addresses of this Invoice. # noqa: E501 + :type: list[InvoiceAddress] + """ + + self._invoice_addresses = invoice_addresses diff --git a/xero_python/accounting/models/invoice_address.py b/xero_python/accounting/models/invoice_address.py new file mode 100644 index 00000000..2494673b --- /dev/null +++ b/xero_python/accounting/models/invoice_address.py @@ -0,0 +1,314 @@ +# coding: utf-8 + +""" +Xero Accounting API + +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class InvoiceAddress(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "invoice_address_type": "str", + "address_line1": "str", + "address_line2": "str", + "address_line3": "str", + "address_line4": "str", + "city": "str", + "region": "str", + "postal_code": "str", + "country": "str", + } + + attribute_map = { + "invoice_address_type": "InvoiceAddressType", + "address_line1": "AddressLine1", + "address_line2": "AddressLine2", + "address_line3": "AddressLine3", + "address_line4": "AddressLine4", + "city": "City", + "region": "Region", + "postal_code": "PostalCode", + "country": "Country", + } + + def __init__( + self, + invoice_address_type=None, + address_line1=None, + address_line2=None, + address_line3=None, + address_line4=None, + city=None, + region=None, + postal_code=None, + country=None, + ): # noqa: E501 + """InvoiceAddress - a model defined in OpenAPI""" # noqa: E501 + + self._invoice_address_type = None + self._address_line1 = None + self._address_line2 = None + self._address_line3 = None + self._address_line4 = None + self._city = None + self._region = None + self._postal_code = None + self._country = None + self.discriminator = None + + if invoice_address_type is not None: + self.invoice_address_type = invoice_address_type + if address_line1 is not None: + self.address_line1 = address_line1 + if address_line2 is not None: + self.address_line2 = address_line2 + if address_line3 is not None: + self.address_line3 = address_line3 + if address_line4 is not None: + self.address_line4 = address_line4 + if city is not None: + self.city = city + if region is not None: + self.region = region + if postal_code is not None: + self.postal_code = postal_code + if country is not None: + self.country = country + + @property + def invoice_address_type(self): + """Gets the invoice_address_type of this InvoiceAddress. # noqa: E501 + + Indicates whether the address is defined as origin (FROM) or destination (TO) # noqa: E501 + + :return: The invoice_address_type of this InvoiceAddress. # noqa: E501 + :rtype: str + """ + return self._invoice_address_type + + @invoice_address_type.setter + def invoice_address_type(self, invoice_address_type): + """Sets the invoice_address_type of this InvoiceAddress. + + Indicates whether the address is defined as origin (FROM) or destination (TO) # noqa: E501 + + :param invoice_address_type: The invoice_address_type of this InvoiceAddress. # noqa: E501 + :type: str + """ + allowed_values = ["FROM", "TO", "None"] # noqa: E501 + + if invoice_address_type: + if invoice_address_type not in allowed_values: + raise ValueError( + "Invalid value for `invoice_address_type` ({0}), must be one of {1}".format( # noqa: E501 + invoice_address_type, allowed_values + ) + ) + + self._invoice_address_type = invoice_address_type + + @property + def address_line1(self): + """Gets the address_line1 of this InvoiceAddress. # noqa: E501 + + First line of a physical address # noqa: E501 + + :return: The address_line1 of this InvoiceAddress. # noqa: E501 + :rtype: str + """ + return self._address_line1 + + @address_line1.setter + def address_line1(self, address_line1): + """Sets the address_line1 of this InvoiceAddress. + + First line of a physical address # noqa: E501 + + :param address_line1: The address_line1 of this InvoiceAddress. # noqa: E501 + :type: str + """ + + self._address_line1 = address_line1 + + @property + def address_line2(self): + """Gets the address_line2 of this InvoiceAddress. # noqa: E501 + + Second line of a physical address # noqa: E501 + + :return: The address_line2 of this InvoiceAddress. # noqa: E501 + :rtype: str + """ + return self._address_line2 + + @address_line2.setter + def address_line2(self, address_line2): + """Sets the address_line2 of this InvoiceAddress. + + Second line of a physical address # noqa: E501 + + :param address_line2: The address_line2 of this InvoiceAddress. # noqa: E501 + :type: str + """ + + self._address_line2 = address_line2 + + @property + def address_line3(self): + """Gets the address_line3 of this InvoiceAddress. # noqa: E501 + + Third line of a physical address # noqa: E501 + + :return: The address_line3 of this InvoiceAddress. # noqa: E501 + :rtype: str + """ + return self._address_line3 + + @address_line3.setter + def address_line3(self, address_line3): + """Sets the address_line3 of this InvoiceAddress. + + Third line of a physical address # noqa: E501 + + :param address_line3: The address_line3 of this InvoiceAddress. # noqa: E501 + :type: str + """ + + self._address_line3 = address_line3 + + @property + def address_line4(self): + """Gets the address_line4 of this InvoiceAddress. # noqa: E501 + + Fourth line of a physical address # noqa: E501 + + :return: The address_line4 of this InvoiceAddress. # noqa: E501 + :rtype: str + """ + return self._address_line4 + + @address_line4.setter + def address_line4(self, address_line4): + """Sets the address_line4 of this InvoiceAddress. + + Fourth line of a physical address # noqa: E501 + + :param address_line4: The address_line4 of this InvoiceAddress. # noqa: E501 + :type: str + """ + + self._address_line4 = address_line4 + + @property + def city(self): + """Gets the city of this InvoiceAddress. # noqa: E501 + + City of a physical address # noqa: E501 + + :return: The city of this InvoiceAddress. # noqa: E501 + :rtype: str + """ + return self._city + + @city.setter + def city(self, city): + """Sets the city of this InvoiceAddress. + + City of a physical address # noqa: E501 + + :param city: The city of this InvoiceAddress. # noqa: E501 + :type: str + """ + + self._city = city + + @property + def region(self): + """Gets the region of this InvoiceAddress. # noqa: E501 + + Region or state of a physical address # noqa: E501 + + :return: The region of this InvoiceAddress. # noqa: E501 + :rtype: str + """ + return self._region + + @region.setter + def region(self, region): + """Sets the region of this InvoiceAddress. + + Region or state of a physical address # noqa: E501 + + :param region: The region of this InvoiceAddress. # noqa: E501 + :type: str + """ + + self._region = region + + @property + def postal_code(self): + """Gets the postal_code of this InvoiceAddress. # noqa: E501 + + Postal code of a physical address # noqa: E501 + + :return: The postal_code of this InvoiceAddress. # noqa: E501 + :rtype: str + """ + return self._postal_code + + @postal_code.setter + def postal_code(self, postal_code): + """Sets the postal_code of this InvoiceAddress. + + Postal code of a physical address # noqa: E501 + + :param postal_code: The postal_code of this InvoiceAddress. # noqa: E501 + :type: str + """ + + self._postal_code = postal_code + + @property + def country(self): + """Gets the country of this InvoiceAddress. # noqa: E501 + + Country of a physical address # noqa: E501 + + :return: The country of this InvoiceAddress. # noqa: E501 + :rtype: str + """ + return self._country + + @country.setter + def country(self, country): + """Sets the country of this InvoiceAddress. + + Country of a physical address # noqa: E501 + + :param country: The country of this InvoiceAddress. # noqa: E501 + :type: str + """ + + self._country = country diff --git a/xero_python/accounting/models/invoice_reminder.py b/xero_python/accounting/models/invoice_reminder.py index 367c526b..83f4930a 100644 --- a/xero_python/accounting/models/invoice_reminder.py +++ b/xero_python/accounting/models/invoice_reminder.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/invoice_reminders.py b/xero_python/accounting/models/invoice_reminders.py index 981b831e..84c3bb26 100644 --- a/xero_python/accounting/models/invoice_reminders.py +++ b/xero_python/accounting/models/invoice_reminders.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/invoices.py b/xero_python/accounting/models/invoices.py index 9f46a2b0..0d4f27d8 100644 --- a/xero_python/accounting/models/invoices.py +++ b/xero_python/accounting/models/invoices.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -29,19 +29,77 @@ class Invoices(BaseModel): attribute_map (dict): The key is attribute name and the value is json key in definition. """ - openapi_types = {"invoices": "list[Invoice]"} - - attribute_map = {"invoices": "Invoices"} - - def __init__(self, invoices=None): # noqa: E501 + openapi_types = { + "pagination": "Pagination", + "warnings": "list[ValidationError]", + "invoices": "list[Invoice]", + } + + attribute_map = { + "pagination": "pagination", + "warnings": "Warnings", + "invoices": "Invoices", + } + + def __init__(self, pagination=None, warnings=None, invoices=None): # noqa: E501 """Invoices - a model defined in OpenAPI""" # noqa: E501 + self._pagination = None + self._warnings = None self._invoices = None self.discriminator = None + if pagination is not None: + self.pagination = pagination + if warnings is not None: + self.warnings = warnings if invoices is not None: self.invoices = invoices + @property + def pagination(self): + """Gets the pagination of this Invoices. # noqa: E501 + + + :return: The pagination of this Invoices. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this Invoices. + + + :param pagination: The pagination of this Invoices. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def warnings(self): + """Gets the warnings of this Invoices. # noqa: E501 + + Displays array of warning messages from the API # noqa: E501 + + :return: The warnings of this Invoices. # noqa: E501 + :rtype: list[ValidationError] + """ + return self._warnings + + @warnings.setter + def warnings(self, warnings): + """Sets the warnings of this Invoices. + + Displays array of warning messages from the API # noqa: E501 + + :param warnings: The warnings of this Invoices. # noqa: E501 + :type: list[ValidationError] + """ + + self._warnings = warnings + @property def invoices(self): """Gets the invoices of this Invoices. # noqa: E501 diff --git a/xero_python/accounting/models/item.py b/xero_python/accounting/models/item.py index 3b20fc26..33c76626 100644 --- a/xero_python/accounting/models/item.py +++ b/xero_python/accounting/models/item.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -42,6 +42,8 @@ class Item(BaseModel): "is_tracked_as_inventory": "bool", "total_cost_pool": "float", "quantity_on_hand": "float", + "quantity_available": "float", + "quantity_on_back_order": "float", "updated_date_utc": "datetime[ms-format]", "item_id": "str", "status_attribute_string": "str", @@ -61,6 +63,8 @@ class Item(BaseModel): "is_tracked_as_inventory": "IsTrackedAsInventory", "total_cost_pool": "TotalCostPool", "quantity_on_hand": "QuantityOnHand", + "quantity_available": "QuantityAvailable", + "quantity_on_back_order": "QuantityOnBackOrder", "updated_date_utc": "UpdatedDateUTC", "item_id": "ItemID", "status_attribute_string": "StatusAttributeString", @@ -81,6 +85,8 @@ def __init__( is_tracked_as_inventory=None, total_cost_pool=None, quantity_on_hand=None, + quantity_available=None, + quantity_on_back_order=None, updated_date_utc=None, item_id=None, status_attribute_string=None, @@ -100,6 +106,8 @@ def __init__( self._is_tracked_as_inventory = None self._total_cost_pool = None self._quantity_on_hand = None + self._quantity_available = None + self._quantity_on_back_order = None self._updated_date_utc = None self._item_id = None self._status_attribute_string = None @@ -129,6 +137,10 @@ def __init__( self.total_cost_pool = total_cost_pool if quantity_on_hand is not None: self.quantity_on_hand = quantity_on_hand + if quantity_available is not None: + self.quantity_available = quantity_available + if quantity_on_back_order is not None: + self.quantity_on_back_order = quantity_on_back_order if updated_date_utc is not None: self.updated_date_utc = updated_date_utc if item_id is not None: @@ -413,7 +425,7 @@ def total_cost_pool(self, total_cost_pool): def quantity_on_hand(self): """Gets the quantity_on_hand of this Item. # noqa: E501 - The quantity of the item on hand # noqa: E501 + The quantity of the item on hand. This will be 0 if `QuantityOnBackOrder` is greater than 0. # noqa: E501 :return: The quantity_on_hand of this Item. # noqa: E501 :rtype: float @@ -424,7 +436,7 @@ def quantity_on_hand(self): def quantity_on_hand(self, quantity_on_hand): """Sets the quantity_on_hand of this Item. - The quantity of the item on hand # noqa: E501 + The quantity of the item on hand. This will be 0 if `QuantityOnBackOrder` is greater than 0. # noqa: E501 :param quantity_on_hand: The quantity_on_hand of this Item. # noqa: E501 :type: float @@ -432,6 +444,52 @@ def quantity_on_hand(self, quantity_on_hand): self._quantity_on_hand = quantity_on_hand + @property + def quantity_available(self): + """Gets the quantity_available of this Item. # noqa: E501 + + The quantity of the item available. This is equal to `QuantityOnHand` - `QuantityOnBackOrder`. This value will be negative if `QuantityOnBackOrder` is greater than 0. # noqa: E501 + + :return: The quantity_available of this Item. # noqa: E501 + :rtype: float + """ + return self._quantity_available + + @quantity_available.setter + def quantity_available(self, quantity_available): + """Sets the quantity_available of this Item. + + The quantity of the item available. This is equal to `QuantityOnHand` - `QuantityOnBackOrder`. This value will be negative if `QuantityOnBackOrder` is greater than 0. # noqa: E501 + + :param quantity_available: The quantity_available of this Item. # noqa: E501 + :type: float + """ + + self._quantity_available = quantity_available + + @property + def quantity_on_back_order(self): + """Gets the quantity_on_back_order of this Item. # noqa: E501 + + The quantity of the item on backorder. This will be 0 if `QuantityOnHand` is greater than 0. # noqa: E501 + + :return: The quantity_on_back_order of this Item. # noqa: E501 + :rtype: float + """ + return self._quantity_on_back_order + + @quantity_on_back_order.setter + def quantity_on_back_order(self, quantity_on_back_order): + """Sets the quantity_on_back_order of this Item. + + The quantity of the item on backorder. This will be 0 if `QuantityOnHand` is greater than 0. # noqa: E501 + + :param quantity_on_back_order: The quantity_on_back_order of this Item. # noqa: E501 + :type: float + """ + + self._quantity_on_back_order = quantity_on_back_order + @property def updated_date_utc(self): """Gets the updated_date_utc of this Item. # noqa: E501 diff --git a/xero_python/accounting/models/items.py b/xero_python/accounting/models/items.py index 587a54b1..b1f87dc4 100644 --- a/xero_python/accounting/models/items.py +++ b/xero_python/accounting/models/items.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/journal.py b/xero_python/accounting/models/journal.py index bf78d7b5..bcb30445 100644 --- a/xero_python/accounting/models/journal.py +++ b/xero_python/accounting/models/journal.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/journal_line.py b/xero_python/accounting/models/journal_line.py index 2e26b518..bcaee171 100644 --- a/xero_python/accounting/models/journal_line.py +++ b/xero_python/accounting/models/journal_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -324,7 +324,7 @@ def tax_amount(self, tax_amount): def tax_type(self): """Gets the tax_type of this JournalLine. # noqa: E501 - The tax type from TaxRates # noqa: E501 + The tax type from taxRates # noqa: E501 :return: The tax_type of this JournalLine. # noqa: E501 :rtype: str @@ -335,7 +335,7 @@ def tax_type(self): def tax_type(self, tax_type): """Sets the tax_type of this JournalLine. - The tax type from TaxRates # noqa: E501 + The tax type from taxRates # noqa: E501 :param tax_type: The tax_type of this JournalLine. # noqa: E501 :type: str diff --git a/xero_python/accounting/models/journals.py b/xero_python/accounting/models/journals.py index ef4524e8..d16342a4 100644 --- a/xero_python/accounting/models/journals.py +++ b/xero_python/accounting/models/journals.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -29,19 +29,45 @@ class Journals(BaseModel): attribute_map (dict): The key is attribute name and the value is json key in definition. """ - openapi_types = {"journals": "list[Journal]"} + openapi_types = {"warnings": "list[ValidationError]", "journals": "list[Journal]"} - attribute_map = {"journals": "Journals"} + attribute_map = {"warnings": "Warnings", "journals": "Journals"} - def __init__(self, journals=None): # noqa: E501 + def __init__(self, warnings=None, journals=None): # noqa: E501 """Journals - a model defined in OpenAPI""" # noqa: E501 + self._warnings = None self._journals = None self.discriminator = None + if warnings is not None: + self.warnings = warnings if journals is not None: self.journals = journals + @property + def warnings(self): + """Gets the warnings of this Journals. # noqa: E501 + + Displays array of warning messages from the API # noqa: E501 + + :return: The warnings of this Journals. # noqa: E501 + :rtype: list[ValidationError] + """ + return self._warnings + + @warnings.setter + def warnings(self, warnings): + """Sets the warnings of this Journals. + + Displays array of warning messages from the API # noqa: E501 + + :param warnings: The warnings of this Journals. # noqa: E501 + :type: list[ValidationError] + """ + + self._warnings = warnings + @property def journals(self): """Gets the journals of this Journals. # noqa: E501 diff --git a/xero_python/accounting/models/line_amount_types.py b/xero_python/accounting/models/line_amount_types.py index ac8f66ea..230c57ac 100644 --- a/xero_python/accounting/models/line_amount_types.py +++ b/xero_python/accounting/models/line_amount_types.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/line_item.py b/xero_python/accounting/models/line_item.py index 335c7bac..c2164199 100644 --- a/xero_python/accounting/models/line_item.py +++ b/xero_python/accounting/models/line_item.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -45,6 +45,9 @@ class LineItem(BaseModel): "discount_rate": "float", "discount_amount": "float", "repeating_invoice_id": "str", + "taxability": "str", + "sales_tax_code_id": "float", + "tax_breakdown": "list[TaxBreakdownComponent]", } attribute_map = { @@ -63,6 +66,9 @@ class LineItem(BaseModel): "discount_rate": "DiscountRate", "discount_amount": "DiscountAmount", "repeating_invoice_id": "RepeatingInvoiceID", + "taxability": "Taxability", + "sales_tax_code_id": "SalesTaxCodeId", + "tax_breakdown": "TaxBreakdown", } def __init__( @@ -82,6 +88,9 @@ def __init__( discount_rate=None, discount_amount=None, repeating_invoice_id=None, + taxability=None, + sales_tax_code_id=None, + tax_breakdown=None, ): # noqa: E501 """LineItem - a model defined in OpenAPI""" # noqa: E501 @@ -100,6 +109,9 @@ def __init__( self._discount_rate = None self._discount_amount = None self._repeating_invoice_id = None + self._taxability = None + self._sales_tax_code_id = None + self._tax_breakdown = None self.discriminator = None if line_item_id is not None: @@ -132,6 +144,12 @@ def __init__( self.discount_amount = discount_amount if repeating_invoice_id is not None: self.repeating_invoice_id = repeating_invoice_id + if taxability is not None: + self.taxability = taxability + if sales_tax_code_id is not None: + self.sales_tax_code_id = sales_tax_code_id + if tax_breakdown is not None: + self.tax_breakdown = tax_breakdown @property def line_item_id(self): @@ -365,7 +383,7 @@ def item(self, item): def line_amount(self): """Gets the line_amount of this LineItem. # noqa: E501 - If you wish to omit either of the or you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if a DiscountRate has been used . i.e LineAmount = Quantity * Unit Amount * ((100 – DiscountRate)/100) # noqa: E501 + 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 # noqa: E501 :return: The line_amount of this LineItem. # noqa: E501 :rtype: float @@ -376,7 +394,7 @@ def line_amount(self): def line_amount(self, line_amount): """Sets the line_amount of this LineItem. - If you wish to omit either of the or you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if a DiscountRate has been used . i.e LineAmount = Quantity * Unit Amount * ((100 – DiscountRate)/100) # noqa: E501 + 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 # noqa: E501 :param line_amount: The line_amount of this LineItem. # noqa: E501 :type: float @@ -434,7 +452,7 @@ def discount_rate(self, discount_rate): def discount_amount(self): """Gets the discount_amount of this LineItem. # noqa: E501 - Discount amount being applied to a line item. Only supported on ACCREC invoices - ACCPAY invoices and credit notes in Xero do not support discounts. # noqa: E501 + Discount amount being applied to a line item. Only supported on ACCREC invoices and quotes. ACCPAY invoices and credit notes in Xero do not support discounts. # noqa: E501 :return: The discount_amount of this LineItem. # noqa: E501 :rtype: float @@ -445,7 +463,7 @@ def discount_amount(self): def discount_amount(self, discount_amount): """Sets the discount_amount of this LineItem. - Discount amount being applied to a line item. Only supported on ACCREC invoices - ACCPAY invoices and credit notes in Xero do not support discounts. # noqa: E501 + Discount amount being applied to a line item. Only supported on ACCREC invoices and quotes. ACCPAY invoices and credit notes in Xero do not support discounts. # noqa: E501 :param discount_amount: The discount_amount of this LineItem. # noqa: E501 :type: float @@ -475,3 +493,88 @@ def repeating_invoice_id(self, repeating_invoice_id): """ self._repeating_invoice_id = repeating_invoice_id + + @property + def taxability(self): + """Gets the taxability of this LineItem. # noqa: E501 + + The type of taxability # noqa: E501 + + :return: The taxability of this LineItem. # noqa: E501 + :rtype: str + """ + return self._taxability + + @taxability.setter + def taxability(self, taxability): + """Sets the taxability of this LineItem. + + The type of taxability # noqa: E501 + + :param taxability: The taxability of this LineItem. # noqa: E501 + :type: str + """ + allowed_values = [ + "TAXABLE", + "NON_TAXABLE", + "EXEMPT", + "PART_TAXABLE", + "NOT_APPLICABLE", + "None", + ] # noqa: E501 + + if taxability: + if taxability not in allowed_values: + raise ValueError( + "Invalid value for `taxability` ({0}), must be one of {1}".format( # noqa: E501 + taxability, allowed_values + ) + ) + + self._taxability = taxability + + @property + def sales_tax_code_id(self): + """Gets the sales_tax_code_id of this LineItem. # noqa: E501 + + The ID of the sales tax code # noqa: E501 + + :return: The sales_tax_code_id of this LineItem. # noqa: E501 + :rtype: float + """ + return self._sales_tax_code_id + + @sales_tax_code_id.setter + def sales_tax_code_id(self, sales_tax_code_id): + """Sets the sales_tax_code_id of this LineItem. + + The ID of the sales tax code # noqa: E501 + + :param sales_tax_code_id: The sales_tax_code_id of this LineItem. # noqa: E501 + :type: float + """ + + self._sales_tax_code_id = sales_tax_code_id + + @property + def tax_breakdown(self): + """Gets the tax_breakdown of this LineItem. # noqa: E501 + + An array of tax components defined for this line item # noqa: E501 + + :return: The tax_breakdown of this LineItem. # noqa: E501 + :rtype: list[TaxBreakdownComponent] + """ + return self._tax_breakdown + + @tax_breakdown.setter + def tax_breakdown(self, tax_breakdown): + """Sets the tax_breakdown of this LineItem. + + An array of tax components defined for this line item # noqa: E501 + + :param tax_breakdown: The tax_breakdown of this LineItem. # noqa: E501 + :type: list[TaxBreakdownComponent] + """ + + self._tax_breakdown = tax_breakdown diff --git a/xero_python/accounting/models/line_item_item.py b/xero_python/accounting/models/line_item_item.py index d0d8d826..09abb729 100644 --- a/xero_python/accounting/models/line_item_item.py +++ b/xero_python/accounting/models/line_item_item.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/line_item_tracking.py b/xero_python/accounting/models/line_item_tracking.py index f00e9043..fb994907 100644 --- a/xero_python/accounting/models/line_item_tracking.py +++ b/xero_python/accounting/models/line_item_tracking.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/linked_transaction.py b/xero_python/accounting/models/linked_transaction.py index c5ca46a1..29644d73 100644 --- a/xero_python/accounting/models/linked_transaction.py +++ b/xero_python/accounting/models/linked_transaction.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/linked_transactions.py b/xero_python/accounting/models/linked_transactions.py index 9cc8d14b..aa9e4f28 100644 --- a/xero_python/accounting/models/linked_transactions.py +++ b/xero_python/accounting/models/linked_transactions.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/manual_journal.py b/xero_python/accounting/models/manual_journal.py index 0a103d32..0684dbac 100644 --- a/xero_python/accounting/models/manual_journal.py +++ b/xero_python/accounting/models/manual_journal.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/manual_journal_line.py b/xero_python/accounting/models/manual_journal_line.py index e3adcb8f..15b64a7e 100644 --- a/xero_python/accounting/models/manual_journal_line.py +++ b/xero_python/accounting/models/manual_journal_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/manual_journals.py b/xero_python/accounting/models/manual_journals.py index 823ba3d6..8d0ac4b2 100644 --- a/xero_python/accounting/models/manual_journals.py +++ b/xero_python/accounting/models/manual_journals.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -29,19 +29,79 @@ class ManualJournals(BaseModel): attribute_map (dict): The key is attribute name and the value is json key in definition. """ - openapi_types = {"manual_journals": "list[ManualJournal]"} - - attribute_map = {"manual_journals": "ManualJournals"} - - def __init__(self, manual_journals=None): # noqa: E501 + openapi_types = { + "pagination": "Pagination", + "warnings": "list[ValidationError]", + "manual_journals": "list[ManualJournal]", + } + + attribute_map = { + "pagination": "pagination", + "warnings": "Warnings", + "manual_journals": "ManualJournals", + } + + def __init__( + self, pagination=None, warnings=None, manual_journals=None + ): # noqa: E501 """ManualJournals - a model defined in OpenAPI""" # noqa: E501 + self._pagination = None + self._warnings = None self._manual_journals = None self.discriminator = None + if pagination is not None: + self.pagination = pagination + if warnings is not None: + self.warnings = warnings if manual_journals is not None: self.manual_journals = manual_journals + @property + def pagination(self): + """Gets the pagination of this ManualJournals. # noqa: E501 + + + :return: The pagination of this ManualJournals. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this ManualJournals. + + + :param pagination: The pagination of this ManualJournals. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def warnings(self): + """Gets the warnings of this ManualJournals. # noqa: E501 + + Displays array of warning messages from the API # noqa: E501 + + :return: The warnings of this ManualJournals. # noqa: E501 + :rtype: list[ValidationError] + """ + return self._warnings + + @warnings.setter + def warnings(self, warnings): + """Sets the warnings of this ManualJournals. + + Displays array of warning messages from the API # noqa: E501 + + :param warnings: The warnings of this ManualJournals. # noqa: E501 + :type: list[ValidationError] + """ + + self._warnings = warnings + @property def manual_journals(self): """Gets the manual_journals of this ManualJournals. # noqa: E501 diff --git a/xero_python/accounting/models/online_invoice.py b/xero_python/accounting/models/online_invoice.py index 00f786b8..da925fc5 100644 --- a/xero_python/accounting/models/online_invoice.py +++ b/xero_python/accounting/models/online_invoice.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/online_invoices.py b/xero_python/accounting/models/online_invoices.py index fa7f4f8b..a7a4217a 100644 --- a/xero_python/accounting/models/online_invoices.py +++ b/xero_python/accounting/models/online_invoices.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/organisation.py b/xero_python/accounting/models/organisation.py index d40b2a5b..5ed48720 100644 --- a/xero_python/accounting/models/organisation.py +++ b/xero_python/accounting/models/organisation.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -434,6 +434,14 @@ def organisation_type(self, organisation_type): "SOLE_TRADER", "SUPERANNUATION_FUND", "TRUST", + "PERSONAL", + "SINGLEMEMBERLLC", + "CCORPORATIONLLC", + "PARTNERSHIPLLC", + "SCORPORATIONLLC", + "LLC", + "NOTLLC", + "UNSPECIFIED", "None", ] # noqa: E501 @@ -911,6 +919,14 @@ def organisation_entity_type(self, organisation_entity_type): "SOLE_TRADER", "SUPERANNUATION_FUND", "TRUST", + "PERSONAL", + "SINGLEMEMBERLLC", + "CCORPORATIONLLC", + "PARTNERSHIPLLC", + "SCORPORATIONLLC", + "LLC", + "NOTLLC", + "UNSPECIFIED", "None", ] # noqa: E501 @@ -979,6 +995,18 @@ def _class(self, _class): "LEDGER", "GST_CASHBOOK", "NON_GST_CASHBOOK", + "ULTIMATE", + "LITE", + "ULTIMATE_10", + "ULTIMATE_20", + "ULTIMATE_50", + "ULTIMATE_100", + "IGNITE", + "GROW", + "COMPREHENSIVE", + "SIMPLE", + "BASICLITE", + "ULTRA", "None", ] # noqa: E501 diff --git a/xero_python/accounting/models/organisations.py b/xero_python/accounting/models/organisations.py index fef4b42d..77885ed3 100644 --- a/xero_python/accounting/models/organisations.py +++ b/xero_python/accounting/models/organisations.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/overpayment.py b/xero_python/accounting/models/overpayment.py index 0fb57edd..bd8c1995 100644 --- a/xero_python/accounting/models/overpayment.py +++ b/xero_python/accounting/models/overpayment.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -40,6 +40,7 @@ class Overpayment(BaseModel): "total_tax": "float", "total": "float", "updated_date_utc": "datetime[ms-format]", + "updated_date_utc_string": "str", "currency_code": "CurrencyCode", "overpayment_id": "str", "currency_rate": "float", @@ -48,6 +49,7 @@ class Overpayment(BaseModel): "applied_amount": "float", "payments": "list[Payment]", "has_attachments": "bool", + "reference": "str", "attachments": "list[Attachment]", } @@ -62,6 +64,7 @@ class Overpayment(BaseModel): "total_tax": "TotalTax", "total": "Total", "updated_date_utc": "UpdatedDateUTC", + "updated_date_utc_string": "UpdatedDateUTCString", "currency_code": "CurrencyCode", "overpayment_id": "OverpaymentID", "currency_rate": "CurrencyRate", @@ -70,6 +73,7 @@ class Overpayment(BaseModel): "applied_amount": "AppliedAmount", "payments": "Payments", "has_attachments": "HasAttachments", + "reference": "Reference", "attachments": "Attachments", } @@ -85,6 +89,7 @@ def __init__( total_tax=None, total=None, updated_date_utc=None, + updated_date_utc_string=None, currency_code=None, overpayment_id=None, currency_rate=None, @@ -93,6 +98,7 @@ def __init__( applied_amount=None, payments=None, has_attachments=False, + reference=None, attachments=None, ): # noqa: E501 """Overpayment - a model defined in OpenAPI""" # noqa: E501 @@ -107,6 +113,7 @@ def __init__( self._total_tax = None self._total = None self._updated_date_utc = None + self._updated_date_utc_string = None self._currency_code = None self._overpayment_id = None self._currency_rate = None @@ -115,6 +122,7 @@ def __init__( self._applied_amount = None self._payments = None self._has_attachments = None + self._reference = None self._attachments = None self.discriminator = None @@ -138,6 +146,8 @@ def __init__( self.total = total if updated_date_utc is not None: self.updated_date_utc = updated_date_utc + if updated_date_utc_string is not None: + self.updated_date_utc_string = updated_date_utc_string if currency_code is not None: self.currency_code = currency_code if overpayment_id is not None: @@ -154,6 +164,8 @@ def __init__( self.payments = payments if has_attachments is not None: self.has_attachments = has_attachments + if reference is not None: + self.reference = reference if attachments is not None: self.attachments = attachments @@ -406,6 +418,29 @@ def updated_date_utc(self, updated_date_utc): self._updated_date_utc = updated_date_utc + @property + def updated_date_utc_string(self): + """Gets the updated_date_utc_string of this Overpayment. # noqa: E501 + + UTC ISO-8601 formatted timestamp of last update to the overpayment # noqa: E501 + + :return: The updated_date_utc_string of this Overpayment. # noqa: E501 + :rtype: str + """ + return self._updated_date_utc_string + + @updated_date_utc_string.setter + def updated_date_utc_string(self, updated_date_utc_string): + """Sets the updated_date_utc_string of this Overpayment. + + UTC ISO-8601 formatted timestamp of last update to the overpayment # noqa: E501 + + :param updated_date_utc_string: The updated_date_utc_string of this Overpayment. # noqa: E501 + :type: str + """ + + self._updated_date_utc_string = updated_date_utc_string + @property def currency_code(self): """Gets the currency_code of this Overpayment. # noqa: E501 @@ -588,6 +623,29 @@ def has_attachments(self, has_attachments): self._has_attachments = has_attachments + @property + def reference(self): + """Gets the reference of this Overpayment. # noqa: E501 + + An optional description for Overpayment # noqa: E501 + + :return: The reference of this Overpayment. # noqa: E501 + :rtype: str + """ + return self._reference + + @reference.setter + def reference(self, reference): + """Sets the reference of this Overpayment. + + An optional description for Overpayment # noqa: E501 + + :param reference: The reference of this Overpayment. # noqa: E501 + :type: str + """ + + self._reference = reference + @property def attachments(self): """Gets the attachments of this Overpayment. # noqa: E501 diff --git a/xero_python/accounting/models/overpayments.py b/xero_python/accounting/models/overpayments.py index 356a6a96..7b4c85c5 100644 --- a/xero_python/accounting/models/overpayments.py +++ b/xero_python/accounting/models/overpayments.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -29,19 +29,77 @@ class Overpayments(BaseModel): attribute_map (dict): The key is attribute name and the value is json key in definition. """ - openapi_types = {"overpayments": "list[Overpayment]"} - - attribute_map = {"overpayments": "Overpayments"} - - def __init__(self, overpayments=None): # noqa: E501 + openapi_types = { + "pagination": "Pagination", + "warnings": "list[ValidationError]", + "overpayments": "list[Overpayment]", + } + + attribute_map = { + "pagination": "pagination", + "warnings": "Warnings", + "overpayments": "Overpayments", + } + + def __init__(self, pagination=None, warnings=None, overpayments=None): # noqa: E501 """Overpayments - a model defined in OpenAPI""" # noqa: E501 + self._pagination = None + self._warnings = None self._overpayments = None self.discriminator = None + if pagination is not None: + self.pagination = pagination + if warnings is not None: + self.warnings = warnings if overpayments is not None: self.overpayments = overpayments + @property + def pagination(self): + """Gets the pagination of this Overpayments. # noqa: E501 + + + :return: The pagination of this Overpayments. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this Overpayments. + + + :param pagination: The pagination of this Overpayments. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def warnings(self): + """Gets the warnings of this Overpayments. # noqa: E501 + + Displays array of warning messages from the API # noqa: E501 + + :return: The warnings of this Overpayments. # noqa: E501 + :rtype: list[ValidationError] + """ + return self._warnings + + @warnings.setter + def warnings(self, warnings): + """Sets the warnings of this Overpayments. + + Displays array of warning messages from the API # noqa: E501 + + :param warnings: The warnings of this Overpayments. # noqa: E501 + :type: list[ValidationError] + """ + + self._warnings = warnings + @property def overpayments(self): """Gets the overpayments of this Overpayments. # noqa: E501 diff --git a/xero_python/accounting/models/pagination.py b/xero_python/accounting/models/pagination.py new file mode 100644 index 00000000..424267d3 --- /dev/null +++ b/xero_python/accounting/models/pagination.py @@ -0,0 +1,148 @@ +# coding: utf-8 + +""" +Xero Accounting API + +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class Pagination(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "page": "int", + "page_size": "int", + "page_count": "int", + "item_count": "int", + } + + attribute_map = { + "page": "page", + "page_size": "pageSize", + "page_count": "pageCount", + "item_count": "itemCount", + } + + def __init__( + self, page=None, page_size=None, page_count=None, item_count=None + ): # noqa: E501 + """Pagination - a model defined in OpenAPI""" # noqa: E501 + + self._page = None + self._page_size = None + self._page_count = None + self._item_count = None + self.discriminator = None + + if page is not None: + self.page = page + if page_size is not None: + self.page_size = page_size + if page_count is not None: + self.page_count = page_count + if item_count is not None: + self.item_count = item_count + + @property + def page(self): + """Gets the page of this Pagination. # noqa: E501 + + + :return: The page of this Pagination. # noqa: E501 + :rtype: int + """ + return self._page + + @page.setter + def page(self, page): + """Sets the page of this Pagination. + + + :param page: The page of this Pagination. # noqa: E501 + :type: int + """ + + self._page = page + + @property + def page_size(self): + """Gets the page_size of this Pagination. # noqa: E501 + + + :return: The page_size of this Pagination. # noqa: E501 + :rtype: int + """ + return self._page_size + + @page_size.setter + def page_size(self, page_size): + """Sets the page_size of this Pagination. + + + :param page_size: The page_size of this Pagination. # noqa: E501 + :type: int + """ + + self._page_size = page_size + + @property + def page_count(self): + """Gets the page_count of this Pagination. # noqa: E501 + + + :return: The page_count of this Pagination. # noqa: E501 + :rtype: int + """ + return self._page_count + + @page_count.setter + def page_count(self, page_count): + """Sets the page_count of this Pagination. + + + :param page_count: The page_count of this Pagination. # noqa: E501 + :type: int + """ + + self._page_count = page_count + + @property + def item_count(self): + """Gets the item_count of this Pagination. # noqa: E501 + + + :return: The item_count of this Pagination. # noqa: E501 + :rtype: int + """ + return self._item_count + + @item_count.setter + def item_count(self, item_count): + """Sets the item_count of this Pagination. + + + :param item_count: The item_count of this Pagination. # noqa: E501 + :type: int + """ + + self._item_count = item_count diff --git a/xero_python/accounting/models/payment.py b/xero_python/accounting/models/payment.py index f6f5aa12..66031bdb 100644 --- a/xero_python/accounting/models/payment.py +++ b/xero_python/accounting/models/payment.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -36,6 +36,7 @@ class Payment(BaseModel): "overpayment": "Overpayment", "invoice_number": "str", "credit_note_number": "str", + "batch_payment": "BatchPayment", "account": "Account", "code": "str", "date": "date[ms-format]", @@ -47,6 +48,7 @@ class Payment(BaseModel): "status": "str", "payment_type": "str", "updated_date_utc": "datetime[ms-format]", + "updated_date_utc_string": "str", "payment_id": "str", "batch_payment_id": "str", "bank_account_number": "str", @@ -56,6 +58,7 @@ class Payment(BaseModel): "has_validation_errors": "bool", "status_attribute_string": "str", "validation_errors": "list[ValidationError]", + "warnings": "list[ValidationError]", } attribute_map = { @@ -65,6 +68,7 @@ class Payment(BaseModel): "overpayment": "Overpayment", "invoice_number": "InvoiceNumber", "credit_note_number": "CreditNoteNumber", + "batch_payment": "BatchPayment", "account": "Account", "code": "Code", "date": "Date", @@ -76,6 +80,7 @@ class Payment(BaseModel): "status": "Status", "payment_type": "PaymentType", "updated_date_utc": "UpdatedDateUTC", + "updated_date_utc_string": "UpdatedDateUTCString", "payment_id": "PaymentID", "batch_payment_id": "BatchPaymentID", "bank_account_number": "BankAccountNumber", @@ -85,6 +90,7 @@ class Payment(BaseModel): "has_validation_errors": "HasValidationErrors", "status_attribute_string": "StatusAttributeString", "validation_errors": "ValidationErrors", + "warnings": "Warnings", } def __init__( @@ -95,6 +101,7 @@ def __init__( overpayment=None, invoice_number=None, credit_note_number=None, + batch_payment=None, account=None, code=None, date=None, @@ -106,6 +113,7 @@ def __init__( status=None, payment_type=None, updated_date_utc=None, + updated_date_utc_string=None, payment_id=None, batch_payment_id=None, bank_account_number=None, @@ -115,6 +123,7 @@ def __init__( has_validation_errors=False, status_attribute_string=None, validation_errors=None, + warnings=None, ): # noqa: E501 """Payment - a model defined in OpenAPI""" # noqa: E501 @@ -124,6 +133,7 @@ def __init__( self._overpayment = None self._invoice_number = None self._credit_note_number = None + self._batch_payment = None self._account = None self._code = None self._date = None @@ -135,6 +145,7 @@ def __init__( self._status = None self._payment_type = None self._updated_date_utc = None + self._updated_date_utc_string = None self._payment_id = None self._batch_payment_id = None self._bank_account_number = None @@ -144,6 +155,7 @@ def __init__( self._has_validation_errors = None self._status_attribute_string = None self._validation_errors = None + self._warnings = None self.discriminator = None if invoice is not None: @@ -158,6 +170,8 @@ def __init__( self.invoice_number = invoice_number if credit_note_number is not None: self.credit_note_number = credit_note_number + if batch_payment is not None: + self.batch_payment = batch_payment if account is not None: self.account = account if code is not None: @@ -180,6 +194,8 @@ def __init__( self.payment_type = payment_type if updated_date_utc is not None: self.updated_date_utc = updated_date_utc + if updated_date_utc_string is not None: + self.updated_date_utc_string = updated_date_utc_string if payment_id is not None: self.payment_id = payment_id if batch_payment_id is not None: @@ -198,6 +214,8 @@ def __init__( self.status_attribute_string = status_attribute_string if validation_errors is not None: self.validation_errors = validation_errors + if warnings is not None: + self.warnings = warnings @property def invoice(self): @@ -329,6 +347,27 @@ def credit_note_number(self, credit_note_number): self._credit_note_number = credit_note_number + @property + def batch_payment(self): + """Gets the batch_payment of this Payment. # noqa: E501 + + + :return: The batch_payment of this Payment. # noqa: E501 + :rtype: BatchPayment + """ + return self._batch_payment + + @batch_payment.setter + def batch_payment(self, batch_payment): + """Sets the batch_payment of this Payment. + + + :param batch_payment: The batch_payment of this Payment. # noqa: E501 + :type: BatchPayment + """ + + self._batch_payment = batch_payment + @property def account(self): """Gets the account of this Payment. # noqa: E501 @@ -608,6 +647,29 @@ def updated_date_utc(self, updated_date_utc): self._updated_date_utc = updated_date_utc + @property + def updated_date_utc_string(self): + """Gets the updated_date_utc_string of this Payment. # noqa: E501 + + UTC ISO-8601 formatted timestamp of last update to the payment # noqa: E501 + + :return: The updated_date_utc_string of this Payment. # noqa: E501 + :rtype: str + """ + return self._updated_date_utc_string + + @updated_date_utc_string.setter + def updated_date_utc_string(self, updated_date_utc_string): + """Sets the updated_date_utc_string of this Payment. + + UTC ISO-8601 formatted timestamp of last update to the payment # noqa: E501 + + :param updated_date_utc_string: The updated_date_utc_string of this Payment. # noqa: E501 + :type: str + """ + + self._updated_date_utc_string = updated_date_utc_string + @property def payment_id(self): """Gets the payment_id of this Payment. # noqa: E501 @@ -814,3 +876,26 @@ def validation_errors(self, validation_errors): """ self._validation_errors = validation_errors + + @property + def warnings(self): + """Gets the warnings of this Payment. # noqa: E501 + + Displays array of warning messages from the API # noqa: E501 + + :return: The warnings of this Payment. # noqa: E501 + :rtype: list[ValidationError] + """ + return self._warnings + + @warnings.setter + def warnings(self, warnings): + """Sets the warnings of this Payment. + + Displays array of warning messages from the API # noqa: E501 + + :param warnings: The warnings of this Payment. # noqa: E501 + :type: list[ValidationError] + """ + + self._warnings = warnings diff --git a/xero_python/accounting/models/payment_delete.py b/xero_python/accounting/models/payment_delete.py index b18f5f3c..e7f48de7 100644 --- a/xero_python/accounting/models/payment_delete.py +++ b/xero_python/accounting/models/payment_delete.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/payment_service.py b/xero_python/accounting/models/payment_service.py index c63579a4..eb9574f7 100644 --- a/xero_python/accounting/models/payment_service.py +++ b/xero_python/accounting/models/payment_service.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/payment_services.py b/xero_python/accounting/models/payment_services.py index 4ae75dec..84082184 100644 --- a/xero_python/accounting/models/payment_services.py +++ b/xero_python/accounting/models/payment_services.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/payment_term.py b/xero_python/accounting/models/payment_term.py index 8ca4ca64..370db2d7 100644 --- a/xero_python/accounting/models/payment_term.py +++ b/xero_python/accounting/models/payment_term.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/payment_term_type.py b/xero_python/accounting/models/payment_term_type.py index 7a1e4895..937113c2 100644 --- a/xero_python/accounting/models/payment_term_type.py +++ b/xero_python/accounting/models/payment_term_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/payments.py b/xero_python/accounting/models/payments.py index 7ecdc156..b3dd87e2 100644 --- a/xero_python/accounting/models/payments.py +++ b/xero_python/accounting/models/payments.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -29,19 +29,77 @@ class Payments(BaseModel): attribute_map (dict): The key is attribute name and the value is json key in definition. """ - openapi_types = {"payments": "list[Payment]"} - - attribute_map = {"payments": "Payments"} - - def __init__(self, payments=None): # noqa: E501 + openapi_types = { + "pagination": "Pagination", + "warnings": "list[ValidationError]", + "payments": "list[Payment]", + } + + attribute_map = { + "pagination": "pagination", + "warnings": "Warnings", + "payments": "Payments", + } + + def __init__(self, pagination=None, warnings=None, payments=None): # noqa: E501 """Payments - a model defined in OpenAPI""" # noqa: E501 + self._pagination = None + self._warnings = None self._payments = None self.discriminator = None + if pagination is not None: + self.pagination = pagination + if warnings is not None: + self.warnings = warnings if payments is not None: self.payments = payments + @property + def pagination(self): + """Gets the pagination of this Payments. # noqa: E501 + + + :return: The pagination of this Payments. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this Payments. + + + :param pagination: The pagination of this Payments. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def warnings(self): + """Gets the warnings of this Payments. # noqa: E501 + + Displays array of warning messages from the API # noqa: E501 + + :return: The warnings of this Payments. # noqa: E501 + :rtype: list[ValidationError] + """ + return self._warnings + + @warnings.setter + def warnings(self, warnings): + """Sets the warnings of this Payments. + + Displays array of warning messages from the API # noqa: E501 + + :param warnings: The warnings of this Payments. # noqa: E501 + :type: list[ValidationError] + """ + + self._warnings = warnings + @property def payments(self): """Gets the payments of this Payments. # noqa: E501 diff --git a/xero_python/accounting/models/phone.py b/xero_python/accounting/models/phone.py index 54830d27..06947983 100644 --- a/xero_python/accounting/models/phone.py +++ b/xero_python/accounting/models/phone.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/prepayment.py b/xero_python/accounting/models/prepayment.py index 1f27fa10..9f93e9c5 100644 --- a/xero_python/accounting/models/prepayment.py +++ b/xero_python/accounting/models/prepayment.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -40,9 +40,12 @@ class Prepayment(BaseModel): "total_tax": "float", "total": "float", "reference": "str", + "invoice_number": "str", "updated_date_utc": "datetime[ms-format]", + "updated_date_utc_string": "str", "currency_code": "CurrencyCode", "prepayment_id": "str", + "branding_theme_id": "str", "currency_rate": "float", "remaining_credit": "float", "allocations": "list[Allocation]", @@ -63,9 +66,12 @@ class Prepayment(BaseModel): "total_tax": "TotalTax", "total": "Total", "reference": "Reference", + "invoice_number": "InvoiceNumber", "updated_date_utc": "UpdatedDateUTC", + "updated_date_utc_string": "UpdatedDateUTCString", "currency_code": "CurrencyCode", "prepayment_id": "PrepaymentID", + "branding_theme_id": "BrandingThemeID", "currency_rate": "CurrencyRate", "remaining_credit": "RemainingCredit", "allocations": "Allocations", @@ -87,9 +93,12 @@ def __init__( total_tax=None, total=None, reference=None, + invoice_number=None, updated_date_utc=None, + updated_date_utc_string=None, currency_code=None, prepayment_id=None, + branding_theme_id=None, currency_rate=None, remaining_credit=None, allocations=None, @@ -110,9 +119,12 @@ def __init__( self._total_tax = None self._total = None self._reference = None + self._invoice_number = None self._updated_date_utc = None + self._updated_date_utc_string = None self._currency_code = None self._prepayment_id = None + self._branding_theme_id = None self._currency_rate = None self._remaining_credit = None self._allocations = None @@ -142,12 +154,18 @@ def __init__( self.total = total if reference is not None: self.reference = reference + if invoice_number is not None: + self.invoice_number = invoice_number if updated_date_utc is not None: self.updated_date_utc = updated_date_utc + if updated_date_utc_string is not None: + self.updated_date_utc_string = updated_date_utc_string if currency_code is not None: self.currency_code = currency_code if prepayment_id is not None: self.prepayment_id = prepayment_id + if branding_theme_id is not None: + self.branding_theme_id = branding_theme_id if currency_rate is not None: self.currency_rate = currency_rate if remaining_credit is not None: @@ -413,6 +431,29 @@ def reference(self, reference): self._reference = reference + @property + def invoice_number(self): + """Gets the invoice_number of this Prepayment. # noqa: E501 + + Returns Invoice number for prepayment receive document only. # noqa: E501 + + :return: The invoice_number of this Prepayment. # noqa: E501 + :rtype: str + """ + return self._invoice_number + + @invoice_number.setter + def invoice_number(self, invoice_number): + """Sets the invoice_number of this Prepayment. + + Returns Invoice number for prepayment receive document only. # noqa: E501 + + :param invoice_number: The invoice_number of this Prepayment. # noqa: E501 + :type: str + """ + + self._invoice_number = invoice_number + @property def updated_date_utc(self): """Gets the updated_date_utc of this Prepayment. # noqa: E501 @@ -436,6 +477,29 @@ def updated_date_utc(self, updated_date_utc): self._updated_date_utc = updated_date_utc + @property + def updated_date_utc_string(self): + """Gets the updated_date_utc_string of this Prepayment. # noqa: E501 + + UTC ISO-8601 formatted timestamp of last update to the prepayment # noqa: E501 + + :return: The updated_date_utc_string of this Prepayment. # noqa: E501 + :rtype: str + """ + return self._updated_date_utc_string + + @updated_date_utc_string.setter + def updated_date_utc_string(self, updated_date_utc_string): + """Sets the updated_date_utc_string of this Prepayment. + + UTC ISO-8601 formatted timestamp of last update to the prepayment # noqa: E501 + + :param updated_date_utc_string: The updated_date_utc_string of this Prepayment. # noqa: E501 + :type: str + """ + + self._updated_date_utc_string = updated_date_utc_string + @property def currency_code(self): """Gets the currency_code of this Prepayment. # noqa: E501 @@ -480,6 +544,29 @@ def prepayment_id(self, prepayment_id): self._prepayment_id = prepayment_id + @property + def branding_theme_id(self): + """Gets the branding_theme_id of this Prepayment. # noqa: E501 + + The unique identifier of the branding template applied to a receive prepayment # noqa: E501 + + :return: The branding_theme_id of this Prepayment. # noqa: E501 + :rtype: str + """ + return self._branding_theme_id + + @branding_theme_id.setter + def branding_theme_id(self, branding_theme_id): + """Sets the branding_theme_id of this Prepayment. + + The unique identifier of the branding template applied to a receive prepayment # noqa: E501 + + :param branding_theme_id: The branding_theme_id of this Prepayment. # noqa: E501 + :type: str + """ + + self._branding_theme_id = branding_theme_id + @property def currency_rate(self): """Gets the currency_rate of this Prepayment. # noqa: E501 diff --git a/xero_python/accounting/models/prepayments.py b/xero_python/accounting/models/prepayments.py index ffbc8869..b26f49d9 100644 --- a/xero_python/accounting/models/prepayments.py +++ b/xero_python/accounting/models/prepayments.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -29,19 +29,77 @@ class Prepayments(BaseModel): attribute_map (dict): The key is attribute name and the value is json key in definition. """ - openapi_types = {"prepayments": "list[Prepayment]"} - - attribute_map = {"prepayments": "Prepayments"} - - def __init__(self, prepayments=None): # noqa: E501 + openapi_types = { + "pagination": "Pagination", + "warnings": "list[ValidationError]", + "prepayments": "list[Prepayment]", + } + + attribute_map = { + "pagination": "pagination", + "warnings": "Warnings", + "prepayments": "Prepayments", + } + + def __init__(self, pagination=None, warnings=None, prepayments=None): # noqa: E501 """Prepayments - a model defined in OpenAPI""" # noqa: E501 + self._pagination = None + self._warnings = None self._prepayments = None self.discriminator = None + if pagination is not None: + self.pagination = pagination + if warnings is not None: + self.warnings = warnings if prepayments is not None: self.prepayments = prepayments + @property + def pagination(self): + """Gets the pagination of this Prepayments. # noqa: E501 + + + :return: The pagination of this Prepayments. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this Prepayments. + + + :param pagination: The pagination of this Prepayments. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def warnings(self): + """Gets the warnings of this Prepayments. # noqa: E501 + + Displays array of warning messages from the API # noqa: E501 + + :return: The warnings of this Prepayments. # noqa: E501 + :rtype: list[ValidationError] + """ + return self._warnings + + @warnings.setter + def warnings(self, warnings): + """Sets the warnings of this Prepayments. + + Displays array of warning messages from the API # noqa: E501 + + :param warnings: The warnings of this Prepayments. # noqa: E501 + :type: list[ValidationError] + """ + + self._warnings = warnings + @property def prepayments(self): """Gets the prepayments of this Prepayments. # noqa: E501 diff --git a/xero_python/accounting/models/purchase.py b/xero_python/accounting/models/purchase.py index 3b59da58..12ef033a 100644 --- a/xero_python/accounting/models/purchase.py +++ b/xero_python/accounting/models/purchase.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/purchase_order.py b/xero_python/accounting/models/purchase_order.py index 18ae1ace..9afb666f 100644 --- a/xero_python/accounting/models/purchase_order.py +++ b/xero_python/accounting/models/purchase_order.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/purchase_orders.py b/xero_python/accounting/models/purchase_orders.py index 0d31143e..3c5b8c94 100644 --- a/xero_python/accounting/models/purchase_orders.py +++ b/xero_python/accounting/models/purchase_orders.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -29,19 +29,79 @@ class PurchaseOrders(BaseModel): attribute_map (dict): The key is attribute name and the value is json key in definition. """ - openapi_types = {"purchase_orders": "list[PurchaseOrder]"} - - attribute_map = {"purchase_orders": "PurchaseOrders"} - - def __init__(self, purchase_orders=None): # noqa: E501 + openapi_types = { + "pagination": "Pagination", + "warnings": "list[ValidationError]", + "purchase_orders": "list[PurchaseOrder]", + } + + attribute_map = { + "pagination": "pagination", + "warnings": "Warnings", + "purchase_orders": "PurchaseOrders", + } + + def __init__( + self, pagination=None, warnings=None, purchase_orders=None + ): # noqa: E501 """PurchaseOrders - a model defined in OpenAPI""" # noqa: E501 + self._pagination = None + self._warnings = None self._purchase_orders = None self.discriminator = None + if pagination is not None: + self.pagination = pagination + if warnings is not None: + self.warnings = warnings if purchase_orders is not None: self.purchase_orders = purchase_orders + @property + def pagination(self): + """Gets the pagination of this PurchaseOrders. # noqa: E501 + + + :return: The pagination of this PurchaseOrders. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this PurchaseOrders. + + + :param pagination: The pagination of this PurchaseOrders. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def warnings(self): + """Gets the warnings of this PurchaseOrders. # noqa: E501 + + Displays array of warning messages from the API # noqa: E501 + + :return: The warnings of this PurchaseOrders. # noqa: E501 + :rtype: list[ValidationError] + """ + return self._warnings + + @warnings.setter + def warnings(self, warnings): + """Sets the warnings of this PurchaseOrders. + + Displays array of warning messages from the API # noqa: E501 + + :param warnings: The warnings of this PurchaseOrders. # noqa: E501 + :type: list[ValidationError] + """ + + self._warnings = warnings + @property def purchase_orders(self): """Gets the purchase_orders of this PurchaseOrders. # noqa: E501 diff --git a/xero_python/accounting/models/quote.py b/xero_python/accounting/models/quote.py index 13c1e7f5..60e1cf8b 100644 --- a/xero_python/accounting/models/quote.py +++ b/xero_python/accounting/models/quote.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/quote_line_amount_types.py b/xero_python/accounting/models/quote_line_amount_types.py index d2d30d94..bcf85ddb 100644 --- a/xero_python/accounting/models/quote_line_amount_types.py +++ b/xero_python/accounting/models/quote_line_amount_types.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/quote_status_codes.py b/xero_python/accounting/models/quote_status_codes.py index 544f5fbc..4735be62 100644 --- a/xero_python/accounting/models/quote_status_codes.py +++ b/xero_python/accounting/models/quote_status_codes.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/quotes.py b/xero_python/accounting/models/quotes.py index fefb8098..c5230081 100644 --- a/xero_python/accounting/models/quotes.py +++ b/xero_python/accounting/models/quotes.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/receipt.py b/xero_python/accounting/models/receipt.py index b5222558..77bdbafa 100644 --- a/xero_python/accounting/models/receipt.py +++ b/xero_python/accounting/models/receipt.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/receipts.py b/xero_python/accounting/models/receipts.py index 6f777231..fd0a9bc4 100644 --- a/xero_python/accounting/models/receipts.py +++ b/xero_python/accounting/models/receipts.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/repeating_invoice.py b/xero_python/accounting/models/repeating_invoice.py index 072582b9..4e075954 100644 --- a/xero_python/accounting/models/repeating_invoice.py +++ b/xero_python/accounting/models/repeating_invoice.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -46,6 +46,10 @@ class RepeatingInvoice(BaseModel): "id": "str", "has_attachments": "bool", "attachments": "list[Attachment]", + "approved_for_sending": "bool", + "send_copy": "bool", + "mark_as_sent": "bool", + "include_pdf": "bool", } attribute_map = { @@ -65,6 +69,10 @@ class RepeatingInvoice(BaseModel): "id": "ID", "has_attachments": "HasAttachments", "attachments": "Attachments", + "approved_for_sending": "ApprovedForSending", + "send_copy": "SendCopy", + "mark_as_sent": "MarkAsSent", + "include_pdf": "IncludePDF", } def __init__( @@ -85,6 +93,10 @@ def __init__( id=None, has_attachments=False, attachments=None, + approved_for_sending=False, + send_copy=False, + mark_as_sent=False, + include_pdf=False, ): # noqa: E501 """RepeatingInvoice - a model defined in OpenAPI""" # noqa: E501 @@ -104,6 +116,10 @@ def __init__( self._id = None self._has_attachments = None self._attachments = None + self._approved_for_sending = None + self._send_copy = None + self._mark_as_sent = None + self._include_pdf = None self.discriminator = None if type is not None: @@ -138,6 +154,14 @@ def __init__( self.has_attachments = has_attachments if attachments is not None: self.attachments = attachments + if approved_for_sending is not None: + self.approved_for_sending = approved_for_sending + if send_copy is not None: + self.send_copy = send_copy + if mark_as_sent is not None: + self.mark_as_sent = mark_as_sent + if include_pdf is not None: + self.include_pdf = include_pdf @property def type(self): @@ -475,7 +499,7 @@ def id(self, id): def has_attachments(self): """Gets the has_attachments of this RepeatingInvoice. # noqa: E501 - boolean to indicate if an invoice has an attachment # noqa: E501 + Boolean to indicate if an invoice has an attachment # noqa: E501 :return: The has_attachments of this RepeatingInvoice. # noqa: E501 :rtype: bool @@ -486,7 +510,7 @@ def has_attachments(self): def has_attachments(self, has_attachments): """Sets the has_attachments of this RepeatingInvoice. - boolean to indicate if an invoice has an attachment # noqa: E501 + Boolean to indicate if an invoice has an attachment # noqa: E501 :param has_attachments: The has_attachments of this RepeatingInvoice. # noqa: E501 :type: bool @@ -516,3 +540,95 @@ def attachments(self, attachments): """ self._attachments = attachments + + @property + def approved_for_sending(self): + """Gets the approved_for_sending of this RepeatingInvoice. # noqa: E501 + + Boolean to indicate whether the invoice has been approved for sending # noqa: E501 + + :return: The approved_for_sending of this RepeatingInvoice. # noqa: E501 + :rtype: bool + """ + return self._approved_for_sending + + @approved_for_sending.setter + def approved_for_sending(self, approved_for_sending): + """Sets the approved_for_sending of this RepeatingInvoice. + + Boolean to indicate whether the invoice has been approved for sending # noqa: E501 + + :param approved_for_sending: The approved_for_sending of this RepeatingInvoice. # noqa: E501 + :type: bool + """ + + self._approved_for_sending = approved_for_sending + + @property + def send_copy(self): + """Gets the send_copy of this RepeatingInvoice. # noqa: E501 + + Boolean to indicate whether a copy is sent to sender's email # noqa: E501 + + :return: The send_copy of this RepeatingInvoice. # noqa: E501 + :rtype: bool + """ + return self._send_copy + + @send_copy.setter + def send_copy(self, send_copy): + """Sets the send_copy of this RepeatingInvoice. + + Boolean to indicate whether a copy is sent to sender's email # noqa: E501 + + :param send_copy: The send_copy of this RepeatingInvoice. # noqa: E501 + :type: bool + """ + + self._send_copy = send_copy + + @property + def mark_as_sent(self): + """Gets the mark_as_sent of this RepeatingInvoice. # noqa: E501 + + Boolean to indicate whether the invoice in the Xero app displays as \"sent\" # noqa: E501 + + :return: The mark_as_sent of this RepeatingInvoice. # noqa: E501 + :rtype: bool + """ + return self._mark_as_sent + + @mark_as_sent.setter + def mark_as_sent(self, mark_as_sent): + """Sets the mark_as_sent of this RepeatingInvoice. + + Boolean to indicate whether the invoice in the Xero app displays as \"sent\" # noqa: E501 + + :param mark_as_sent: The mark_as_sent of this RepeatingInvoice. # noqa: E501 + :type: bool + """ + + self._mark_as_sent = mark_as_sent + + @property + def include_pdf(self): + """Gets the include_pdf of this RepeatingInvoice. # noqa: E501 + + Boolean to indicate whether to include PDF attachment # noqa: E501 + + :return: The include_pdf of this RepeatingInvoice. # noqa: E501 + :rtype: bool + """ + return self._include_pdf + + @include_pdf.setter + def include_pdf(self, include_pdf): + """Sets the include_pdf of this RepeatingInvoice. + + Boolean to indicate whether to include PDF attachment # noqa: E501 + + :param include_pdf: The include_pdf of this RepeatingInvoice. # noqa: E501 + :type: bool + """ + + self._include_pdf = include_pdf diff --git a/xero_python/accounting/models/repeating_invoices.py b/xero_python/accounting/models/repeating_invoices.py index 8bf075d8..af835ab0 100644 --- a/xero_python/accounting/models/repeating_invoices.py +++ b/xero_python/accounting/models/repeating_invoices.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/report.py b/xero_python/accounting/models/report.py index 9a598b27..8ea2575a 100644 --- a/xero_python/accounting/models/report.py +++ b/xero_python/accounting/models/report.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/report_attribute.py b/xero_python/accounting/models/report_attribute.py index 9596b5bb..8e46716a 100644 --- a/xero_python/accounting/models/report_attribute.py +++ b/xero_python/accounting/models/report_attribute.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/report_cell.py b/xero_python/accounting/models/report_cell.py index 2a261c3a..65b0f207 100644 --- a/xero_python/accounting/models/report_cell.py +++ b/xero_python/accounting/models/report_cell.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/report_fields.py b/xero_python/accounting/models/report_fields.py index f0463eb8..1efca96f 100644 --- a/xero_python/accounting/models/report_fields.py +++ b/xero_python/accounting/models/report_fields.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/report_row.py b/xero_python/accounting/models/report_row.py index a8fabdb4..6c40dfe3 100644 --- a/xero_python/accounting/models/report_row.py +++ b/xero_python/accounting/models/report_row.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/report_rows.py b/xero_python/accounting/models/report_rows.py index ddeb0065..0ed709ab 100644 --- a/xero_python/accounting/models/report_rows.py +++ b/xero_python/accounting/models/report_rows.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/report_with_row.py b/xero_python/accounting/models/report_with_row.py index 27c40ee3..10f943c7 100644 --- a/xero_python/accounting/models/report_with_row.py +++ b/xero_python/accounting/models/report_with_row.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/report_with_rows.py b/xero_python/accounting/models/report_with_rows.py index e82c741a..d45f0f6d 100644 --- a/xero_python/accounting/models/report_with_rows.py +++ b/xero_python/accounting/models/report_with_rows.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/reports.py b/xero_python/accounting/models/reports.py index a2258e8e..b8221e34 100644 --- a/xero_python/accounting/models/reports.py +++ b/xero_python/accounting/models/reports.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/request_empty.py b/xero_python/accounting/models/request_empty.py index 05d2a175..07313043 100644 --- a/xero_python/accounting/models/request_empty.py +++ b/xero_python/accounting/models/request_empty.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/row_type.py b/xero_python/accounting/models/row_type.py index ab3af3cb..6347776e 100644 --- a/xero_python/accounting/models/row_type.py +++ b/xero_python/accounting/models/row_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/sales_tracking_category.py b/xero_python/accounting/models/sales_tracking_category.py index deddf4b0..418a9cec 100644 --- a/xero_python/accounting/models/sales_tracking_category.py +++ b/xero_python/accounting/models/sales_tracking_category.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/schedule.py b/xero_python/accounting/models/schedule.py index 12658049..19c714ee 100644 --- a/xero_python/accounting/models/schedule.py +++ b/xero_python/accounting/models/schedule.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/setup.py b/xero_python/accounting/models/setup.py index d598cff6..d11b47bc 100644 --- a/xero_python/accounting/models/setup.py +++ b/xero_python/accounting/models/setup.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/tax_breakdown_component.py b/xero_python/accounting/models/tax_breakdown_component.py new file mode 100644 index 00000000..67a2d8da --- /dev/null +++ b/xero_python/accounting/models/tax_breakdown_component.py @@ -0,0 +1,350 @@ +# coding: utf-8 + +""" +Xero Accounting API + +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class TaxBreakdownComponent(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "tax_component_id": "str", + "type": "str", + "name": "str", + "tax_percentage": "float", + "tax_amount": "float", + "taxable_amount": "float", + "non_taxable_amount": "float", + "exempt_amount": "float", + "state_assigned_no": "str", + "jurisdiction_region": "str", + } + + attribute_map = { + "tax_component_id": "TaxComponentId", + "type": "Type", + "name": "Name", + "tax_percentage": "TaxPercentage", + "tax_amount": "TaxAmount", + "taxable_amount": "TaxableAmount", + "non_taxable_amount": "NonTaxableAmount", + "exempt_amount": "ExemptAmount", + "state_assigned_no": "StateAssignedNo", + "jurisdiction_region": "JurisdictionRegion", + } + + def __init__( + self, + tax_component_id=None, + type=None, + name=None, + tax_percentage=None, + tax_amount=None, + taxable_amount=None, + non_taxable_amount=None, + exempt_amount=None, + state_assigned_no=None, + jurisdiction_region=None, + ): # noqa: E501 + """TaxBreakdownComponent - a model defined in OpenAPI""" # noqa: E501 + + self._tax_component_id = None + self._type = None + self._name = None + self._tax_percentage = None + self._tax_amount = None + self._taxable_amount = None + self._non_taxable_amount = None + self._exempt_amount = None + self._state_assigned_no = None + self._jurisdiction_region = None + self.discriminator = None + + if tax_component_id is not None: + self.tax_component_id = tax_component_id + if type is not None: + self.type = type + if name is not None: + self.name = name + if tax_percentage is not None: + self.tax_percentage = tax_percentage + if tax_amount is not None: + self.tax_amount = tax_amount + if taxable_amount is not None: + self.taxable_amount = taxable_amount + if non_taxable_amount is not None: + self.non_taxable_amount = non_taxable_amount + if exempt_amount is not None: + self.exempt_amount = exempt_amount + if state_assigned_no is not None: + self.state_assigned_no = state_assigned_no + if jurisdiction_region is not None: + self.jurisdiction_region = jurisdiction_region + + @property + def tax_component_id(self): + """Gets the tax_component_id of this TaxBreakdownComponent. # noqa: E501 + + The unique ID number of this component # noqa: E501 + + :return: The tax_component_id of this TaxBreakdownComponent. # noqa: E501 + :rtype: str + """ + return self._tax_component_id + + @tax_component_id.setter + def tax_component_id(self, tax_component_id): + """Sets the tax_component_id of this TaxBreakdownComponent. + + The unique ID number of this component # noqa: E501 + + :param tax_component_id: The tax_component_id of this TaxBreakdownComponent. # noqa: E501 + :type: str + """ + + self._tax_component_id = tax_component_id + + @property + def type(self): + """Gets the type of this TaxBreakdownComponent. # noqa: E501 + + The type of the jurisdiction # noqa: E501 + + :return: The type of this TaxBreakdownComponent. # noqa: E501 + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this TaxBreakdownComponent. + + The type of the jurisdiction # noqa: E501 + + :param type: The type of this TaxBreakdownComponent. # noqa: E501 + :type: str + """ + allowed_values = [ + "SYSGST/USCOUNTRY", + "SYSGST/USSTATE", + "SYSGST/USCOUNTY", + "SYSGST/USCITY", + "SYSGST/USSPECIAL", + "None", + ] # noqa: E501 + + if type: + if type not in allowed_values: + raise ValueError( + "Invalid value for `type` ({0}), must be one of {1}".format( # noqa: E501 + type, allowed_values + ) + ) + + self._type = type + + @property + def name(self): + """Gets the name of this TaxBreakdownComponent. # noqa: E501 + + The name of the jurisdiction # noqa: E501 + + :return: The name of this TaxBreakdownComponent. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this TaxBreakdownComponent. + + The name of the jurisdiction # noqa: E501 + + :param name: The name of this TaxBreakdownComponent. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def tax_percentage(self): + """Gets the tax_percentage of this TaxBreakdownComponent. # noqa: E501 + + The percentage of the tax # noqa: E501 + + :return: The tax_percentage of this TaxBreakdownComponent. # noqa: E501 + :rtype: float + """ + return self._tax_percentage + + @tax_percentage.setter + def tax_percentage(self, tax_percentage): + """Sets the tax_percentage of this TaxBreakdownComponent. + + The percentage of the tax # noqa: E501 + + :param tax_percentage: The tax_percentage of this TaxBreakdownComponent. # noqa: E501 + :type: float + """ + + self._tax_percentage = tax_percentage + + @property + def tax_amount(self): + """Gets the tax_amount of this TaxBreakdownComponent. # noqa: E501 + + The amount of the tax # noqa: E501 + + :return: The tax_amount of this TaxBreakdownComponent. # noqa: E501 + :rtype: float + """ + return self._tax_amount + + @tax_amount.setter + def tax_amount(self, tax_amount): + """Sets the tax_amount of this TaxBreakdownComponent. + + The amount of the tax # noqa: E501 + + :param tax_amount: The tax_amount of this TaxBreakdownComponent. # noqa: E501 + :type: float + """ + + self._tax_amount = tax_amount + + @property + def taxable_amount(self): + """Gets the taxable_amount of this TaxBreakdownComponent. # noqa: E501 + + The amount that is taxable # noqa: E501 + + :return: The taxable_amount of this TaxBreakdownComponent. # noqa: E501 + :rtype: float + """ + return self._taxable_amount + + @taxable_amount.setter + def taxable_amount(self, taxable_amount): + """Sets the taxable_amount of this TaxBreakdownComponent. + + The amount that is taxable # noqa: E501 + + :param taxable_amount: The taxable_amount of this TaxBreakdownComponent. # noqa: E501 + :type: float + """ + + self._taxable_amount = taxable_amount + + @property + def non_taxable_amount(self): + """Gets the non_taxable_amount of this TaxBreakdownComponent. # noqa: E501 + + The amount that is not taxable # noqa: E501 + + :return: The non_taxable_amount of this TaxBreakdownComponent. # noqa: E501 + :rtype: float + """ + return self._non_taxable_amount + + @non_taxable_amount.setter + def non_taxable_amount(self, non_taxable_amount): + """Sets the non_taxable_amount of this TaxBreakdownComponent. + + The amount that is not taxable # noqa: E501 + + :param non_taxable_amount: The non_taxable_amount of this TaxBreakdownComponent. # noqa: E501 + :type: float + """ + + self._non_taxable_amount = non_taxable_amount + + @property + def exempt_amount(self): + """Gets the exempt_amount of this TaxBreakdownComponent. # noqa: E501 + + The amount that is exempt # noqa: E501 + + :return: The exempt_amount of this TaxBreakdownComponent. # noqa: E501 + :rtype: float + """ + return self._exempt_amount + + @exempt_amount.setter + def exempt_amount(self, exempt_amount): + """Sets the exempt_amount of this TaxBreakdownComponent. + + The amount that is exempt # noqa: E501 + + :param exempt_amount: The exempt_amount of this TaxBreakdownComponent. # noqa: E501 + :type: float + """ + + self._exempt_amount = exempt_amount + + @property + def state_assigned_no(self): + """Gets the state_assigned_no of this TaxBreakdownComponent. # noqa: E501 + + The state assigned number of the jurisdiction # noqa: E501 + + :return: The state_assigned_no of this TaxBreakdownComponent. # noqa: E501 + :rtype: str + """ + return self._state_assigned_no + + @state_assigned_no.setter + def state_assigned_no(self, state_assigned_no): + """Sets the state_assigned_no of this TaxBreakdownComponent. + + The state assigned number of the jurisdiction # noqa: E501 + + :param state_assigned_no: The state_assigned_no of this TaxBreakdownComponent. # noqa: E501 + :type: str + """ + + self._state_assigned_no = state_assigned_no + + @property + def jurisdiction_region(self): + """Gets the jurisdiction_region of this TaxBreakdownComponent. # noqa: E501 + + Name identifying the region within the country # noqa: E501 + + :return: The jurisdiction_region of this TaxBreakdownComponent. # noqa: E501 + :rtype: str + """ + return self._jurisdiction_region + + @jurisdiction_region.setter + def jurisdiction_region(self, jurisdiction_region): + """Sets the jurisdiction_region of this TaxBreakdownComponent. + + Name identifying the region within the country # noqa: E501 + + :param jurisdiction_region: The jurisdiction_region of this TaxBreakdownComponent. # noqa: E501 + :type: str + """ + + self._jurisdiction_region = jurisdiction_region diff --git a/xero_python/accounting/models/tax_component.py b/xero_python/accounting/models/tax_component.py index 1da4b857..4e924e78 100644 --- a/xero_python/accounting/models/tax_component.py +++ b/xero_python/accounting/models/tax_component.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/tax_rate.py b/xero_python/accounting/models/tax_rate.py index e7a1308e..a5e304aa 100644 --- a/xero_python/accounting/models/tax_rate.py +++ b/xero_python/accounting/models/tax_rate.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -317,6 +317,31 @@ def report_tax_type(self, report_tax_type): "ZRINPUT", "BADDEBT", "OTHERINPUT", + "BADDEBTRELIEF", + "IGDSINPUT3", + "SROVR", + "TOURISTREFUND", + "TXRCN33", + "TXRCRE", + "TXRCESS", + "TXRCTS", + "CAPEXINPUT", + "UNDEFINED", + "CAPEXOUTPUT", + "ZEROEXPOUTPUT", + "GOODSIMPORT", + "NONEINPUT", + "NOTREPORTED", + "SROVRRS", + "SROVRLVG", + "SRLVG", + "IM", + "IMESS", + "IMN33", + "IMRE", + "BADDEBTRECOVERY", + "USSALESTAX", + "BLINPUT3", "None", ] # noqa: E501 diff --git a/xero_python/accounting/models/tax_rates.py b/xero_python/accounting/models/tax_rates.py index e67d36ed..a6fa868f 100644 --- a/xero_python/accounting/models/tax_rates.py +++ b/xero_python/accounting/models/tax_rates.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/tax_type.py b/xero_python/accounting/models/tax_type.py index 7a35e1db..440ffcba 100644 --- a/xero_python/accounting/models/tax_type.py +++ b/xero_python/accounting/models/tax_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -83,3 +83,67 @@ class TaxType(Enum): DRCHARGE20 = "DRCHARGE20" DRCHARGESUPPLY5 = "DRCHARGESUPPLY5" DRCHARGE5 = "DRCHARGE5" + BADDEBTRELIEF = "BADDEBTRELIEF" + IGDSINPUT3 = "IGDSINPUT3" + SROVR = "SROVR" + TOURISTREFUND = "TOURISTREFUND" + TXRCN33 = "TXRCN33" + TXRCRE = "TXRCRE" + TXRCESS = "TXRCESS" + TXRCTS = "TXRCTS" + OUTPUTY23 = "OUTPUTY23" + DSOUTPUTY23 = "DSOUTPUTY23" + INPUTY23 = "INPUTY23" + IMINPUT2Y23 = "IMINPUT2Y23" + IGDSINPUT2Y23 = "IGDSINPUT2Y23" + TXPETINPUTY23 = "TXPETINPUTY23" + TXESSINPUTY23 = "TXESSINPUTY23" + TXN33INPUTY23 = "TXN33INPUTY23" + TXREINPUTY23 = "TXREINPUTY23" + TXCAY23 = "TXCAY23" + BADDEBTRELIEFY23 = "BADDEBTRELIEFY23" + IGDSINPUT3Y23 = "IGDSINPUT3Y23" + SROVRRSY23 = "SROVRRSY23" + SROVRLVGY23 = "SROVRLVGY23" + SRLVGY23 = "SRLVGY23" + TXRCN33Y23 = "TXRCN33Y23" + TXRCREY23 = "TXRCREY23" + TXRCESSY23 = "TXRCESSY23" + TXRCTSY23 = "TXRCTSY23" + IM = "IM" + IMY23 = "IMY23" + IMESS = "IMESS" + IMESSY23 = "IMESSY23" + IMN33 = "IMN33" + IMN33Y23 = "IMN33Y23" + IMRE = "IMRE" + IMREY23 = "IMREY23" + BADDEBTRECOVERY = "BADDEBTRECOVERY" + BADDEBTRECOVERYY23 = "BADDEBTRECOVERYY23" + OUTPUTY24 = "OUTPUTY24" + DSOUTPUTY24 = "DSOUTPUTY24" + INPUTY24 = "INPUTY24" + IGDSINPUT2Y24 = "IGDSINPUT2Y24" + TXPETINPUTY24 = "TXPETINPUTY24" + TXESSINPUTY24 = "TXESSINPUTY24" + TXN33INPUTY24 = "TXN33INPUTY24" + TXREINPUTY24 = "TXREINPUTY24" + TXCAY24 = "TXCAY24" + BADDEBTRELIEFY24 = "BADDEBTRELIEFY24" + IGDSINPUT3Y24 = "IGDSINPUT3Y24" + SROVRRSY24 = "SROVRRSY24" + SROVRLVGY24 = "SROVRLVGY24" + SRLVGY24 = "SRLVGY24" + TXRCTSY24 = "TXRCTSY24" + TXRCESSY24 = "TXRCESSY24" + TXRCN33Y24 = "TXRCN33Y24" + TXRCREY24 = "TXRCREY24" + IMY24 = "IMY24" + IMESSY24 = "IMESSY24" + IMN33Y24 = "IMN33Y24" + IMREY24 = "IMREY24" + BADDEBTRECOVERYY24 = "BADDEBTRECOVERYY24" + OSOUTPUT2 = "OSOUTPUT2" + BLINPUT3 = "BLINPUT3" + BLINPUT3Y23 = "BLINPUT3Y23" + BLINPUT3Y24 = "BLINPUT3Y24" diff --git a/xero_python/accounting/models/ten_ninety_nine_contact.py b/xero_python/accounting/models/ten_ninety_nine_contact.py index d01c81ca..5d0db7c4 100644 --- a/xero_python/accounting/models/ten_ninety_nine_contact.py +++ b/xero_python/accounting/models/ten_ninety_nine_contact.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -52,6 +52,9 @@ class TenNinetyNineContact(BaseModel): "street_address": "str", "tax_id": "str", "contact_id": "str", + "legal_name": "str", + "business_name": "str", + "federal_tax_classification": "str", } attribute_map = { @@ -77,6 +80,9 @@ class TenNinetyNineContact(BaseModel): "street_address": "StreetAddress", "tax_id": "TaxID", "contact_id": "ContactId", + "legal_name": "LegalName", + "business_name": "BusinessName", + "federal_tax_classification": "FederalTaxClassification", } def __init__( @@ -103,6 +109,9 @@ def __init__( street_address=None, tax_id=None, contact_id=None, + legal_name=None, + business_name=None, + federal_tax_classification=None, ): # noqa: E501 """TenNinetyNineContact - a model defined in OpenAPI""" # noqa: E501 @@ -128,6 +137,9 @@ def __init__( self._street_address = None self._tax_id = None self._contact_id = None + self._legal_name = None + self._business_name = None + self._federal_tax_classification = None self.discriminator = None if box1 is not None: @@ -174,6 +186,12 @@ def __init__( self.tax_id = tax_id if contact_id is not None: self.contact_id = contact_id + if legal_name is not None: + self.legal_name = legal_name + if business_name is not None: + self.business_name = business_name + if federal_tax_classification is not None: + self.federal_tax_classification = federal_tax_classification @property def box1(self): @@ -680,3 +698,90 @@ def contact_id(self, contact_id): """ self._contact_id = contact_id + + @property + def legal_name(self): + """Gets the legal_name of this TenNinetyNineContact. # noqa: E501 + + Contact legal name # noqa: E501 + + :return: The legal_name of this TenNinetyNineContact. # noqa: E501 + :rtype: str + """ + return self._legal_name + + @legal_name.setter + def legal_name(self, legal_name): + """Sets the legal_name of this TenNinetyNineContact. + + Contact legal name # noqa: E501 + + :param legal_name: The legal_name of this TenNinetyNineContact. # noqa: E501 + :type: str + """ + + self._legal_name = legal_name + + @property + def business_name(self): + """Gets the business_name of this TenNinetyNineContact. # noqa: E501 + + Contact business name # noqa: E501 + + :return: The business_name of this TenNinetyNineContact. # noqa: E501 + :rtype: str + """ + return self._business_name + + @business_name.setter + def business_name(self, business_name): + """Sets the business_name of this TenNinetyNineContact. + + Contact business name # noqa: E501 + + :param business_name: The business_name of this TenNinetyNineContact. # noqa: E501 + :type: str + """ + + self._business_name = business_name + + @property + def federal_tax_classification(self): + """Gets the federal_tax_classification of this TenNinetyNineContact. # noqa: E501 + + Contact federal tax classification # noqa: E501 + + :return: The federal_tax_classification of this TenNinetyNineContact. # noqa: E501 + :rtype: str + """ + return self._federal_tax_classification + + @federal_tax_classification.setter + def federal_tax_classification(self, federal_tax_classification): + """Sets the federal_tax_classification of this TenNinetyNineContact. + + Contact federal tax classification # noqa: E501 + + :param federal_tax_classification: The federal_tax_classification of this TenNinetyNineContact. # noqa: E501 + :type: str + """ + allowed_values = [ + "SOLE_PROPRIETOR", + "PARTNERSHIP", + "TRUST_OR_ESTATE", + "NONPROFIT", + "C_CORP", + "S_CORP", + "OTHER", + "None", + ] # noqa: E501 + + if federal_tax_classification: + if federal_tax_classification not in allowed_values: + raise ValueError( + "Invalid value for `federal_tax_classification` ({0}), must be one of {1}".format( # noqa: E501 + federal_tax_classification, allowed_values + ) + ) + + self._federal_tax_classification = federal_tax_classification diff --git a/xero_python/accounting/models/ten_nintey_nine_contact.py b/xero_python/accounting/models/ten_nintey_nine_contact.py deleted file mode 100644 index acc632a3..00000000 --- a/xero_python/accounting/models/ten_nintey_nine_contact.py +++ /dev/null @@ -1,683 +0,0 @@ -# coding: utf-8 - -""" - Accounting API - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - OpenAPI spec version: 2.2.7 - Contact: api@xero.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 - -from xero_python.models import BaseModel - - -class TenNinteyNineContact(BaseModel): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - """ - Attributes: - openapi_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - openapi_types = { - "box1": "float", - "box2": "float", - "box3": "float", - "box4": "float", - "box5": "float", - "box6": "float", - "box7": "float", - "box8": "float", - "box9": "float", - "box10": "float", - "box11": "float", - "box13": "float", - "box14": "float", - "name": "str", - "federal_tax_id_type": "str", - "city": "str", - "zip": "str", - "state": "str", - "email": "str", - "street_address": "str", - "tax_id": "str", - "contact_id": "str", - } - - attribute_map = { - "box1": "Box1", - "box2": "Box2", - "box3": "Box3", - "box4": "Box4", - "box5": "Box5", - "box6": "Box6", - "box7": "Box7", - "box8": "Box8", - "box9": "Box9", - "box10": "Box10", - "box11": "Box11", - "box13": "Box13", - "box14": "Box14", - "name": "Name", - "federal_tax_id_type": "FederalTaxIDType", - "city": "City", - "zip": "Zip", - "state": "State", - "email": "Email", - "street_address": "StreetAddress", - "tax_id": "TaxID", - "contact_id": "ContactId", - } - - def __init__( - self, - box1=None, - box2=None, - box3=None, - box4=None, - box5=None, - box6=None, - box7=None, - box8=None, - box9=None, - box10=None, - box11=None, - box13=None, - box14=None, - name=None, - federal_tax_id_type=None, - city=None, - zip=None, - state=None, - email=None, - street_address=None, - tax_id=None, - contact_id=None, - ): # noqa: E501 - """TenNinteyNineContact - a model defined in OpenAPI""" # noqa: E501 - - self._box1 = None - self._box2 = None - self._box3 = None - self._box4 = None - self._box5 = None - self._box6 = None - self._box7 = None - self._box8 = None - self._box9 = None - self._box10 = None - self._box11 = None - self._box13 = None - self._box14 = None - self._name = None - self._federal_tax_id_type = None - self._city = None - self._zip = None - self._state = None - self._email = None - self._street_address = None - self._tax_id = None - self._contact_id = None - self.discriminator = None - - if box1 is not None: - self.box1 = box1 - if box2 is not None: - self.box2 = box2 - if box3 is not None: - self.box3 = box3 - if box4 is not None: - self.box4 = box4 - if box5 is not None: - self.box5 = box5 - if box6 is not None: - self.box6 = box6 - if box7 is not None: - self.box7 = box7 - if box8 is not None: - self.box8 = box8 - if box9 is not None: - self.box9 = box9 - if box10 is not None: - self.box10 = box10 - if box11 is not None: - self.box11 = box11 - if box13 is not None: - self.box13 = box13 - if box14 is not None: - self.box14 = box14 - if name is not None: - self.name = name - if federal_tax_id_type is not None: - self.federal_tax_id_type = federal_tax_id_type - if city is not None: - self.city = city - if zip is not None: - self.zip = zip - if state is not None: - self.state = state - if email is not None: - self.email = email - if street_address is not None: - self.street_address = street_address - if tax_id is not None: - self.tax_id = tax_id - if contact_id is not None: - self.contact_id = contact_id - - @property - def box1(self): - """Gets the box1 of this TenNinteyNineContact. # noqa: E501 - - Box 1 on 1099 Form # noqa: E501 - - :return: The box1 of this TenNinteyNineContact. # noqa: E501 - :rtype: float - """ - return self._box1 - - @box1.setter - def box1(self, box1): - """Sets the box1 of this TenNinteyNineContact. - - Box 1 on 1099 Form # noqa: E501 - - :param box1: The box1 of this TenNinteyNineContact. # noqa: E501 - :type: float - """ - - self._box1 = box1 - - @property - def box2(self): - """Gets the box2 of this TenNinteyNineContact. # noqa: E501 - - Box 2 on 1099 Form # noqa: E501 - - :return: The box2 of this TenNinteyNineContact. # noqa: E501 - :rtype: float - """ - return self._box2 - - @box2.setter - def box2(self, box2): - """Sets the box2 of this TenNinteyNineContact. - - Box 2 on 1099 Form # noqa: E501 - - :param box2: The box2 of this TenNinteyNineContact. # noqa: E501 - :type: float - """ - - self._box2 = box2 - - @property - def box3(self): - """Gets the box3 of this TenNinteyNineContact. # noqa: E501 - - Box 3 on 1099 Form # noqa: E501 - - :return: The box3 of this TenNinteyNineContact. # noqa: E501 - :rtype: float - """ - return self._box3 - - @box3.setter - def box3(self, box3): - """Sets the box3 of this TenNinteyNineContact. - - Box 3 on 1099 Form # noqa: E501 - - :param box3: The box3 of this TenNinteyNineContact. # noqa: E501 - :type: float - """ - - self._box3 = box3 - - @property - def box4(self): - """Gets the box4 of this TenNinteyNineContact. # noqa: E501 - - Box 4 on 1099 Form # noqa: E501 - - :return: The box4 of this TenNinteyNineContact. # noqa: E501 - :rtype: float - """ - return self._box4 - - @box4.setter - def box4(self, box4): - """Sets the box4 of this TenNinteyNineContact. - - Box 4 on 1099 Form # noqa: E501 - - :param box4: The box4 of this TenNinteyNineContact. # noqa: E501 - :type: float - """ - - self._box4 = box4 - - @property - def box5(self): - """Gets the box5 of this TenNinteyNineContact. # noqa: E501 - - Box 5 on 1099 Form # noqa: E501 - - :return: The box5 of this TenNinteyNineContact. # noqa: E501 - :rtype: float - """ - return self._box5 - - @box5.setter - def box5(self, box5): - """Sets the box5 of this TenNinteyNineContact. - - Box 5 on 1099 Form # noqa: E501 - - :param box5: The box5 of this TenNinteyNineContact. # noqa: E501 - :type: float - """ - - self._box5 = box5 - - @property - def box6(self): - """Gets the box6 of this TenNinteyNineContact. # noqa: E501 - - Box 6 on 1099 Form # noqa: E501 - - :return: The box6 of this TenNinteyNineContact. # noqa: E501 - :rtype: float - """ - return self._box6 - - @box6.setter - def box6(self, box6): - """Sets the box6 of this TenNinteyNineContact. - - Box 6 on 1099 Form # noqa: E501 - - :param box6: The box6 of this TenNinteyNineContact. # noqa: E501 - :type: float - """ - - self._box6 = box6 - - @property - def box7(self): - """Gets the box7 of this TenNinteyNineContact. # noqa: E501 - - Box 7 on 1099 Form # noqa: E501 - - :return: The box7 of this TenNinteyNineContact. # noqa: E501 - :rtype: float - """ - return self._box7 - - @box7.setter - def box7(self, box7): - """Sets the box7 of this TenNinteyNineContact. - - Box 7 on 1099 Form # noqa: E501 - - :param box7: The box7 of this TenNinteyNineContact. # noqa: E501 - :type: float - """ - - self._box7 = box7 - - @property - def box8(self): - """Gets the box8 of this TenNinteyNineContact. # noqa: E501 - - Box 8 on 1099 Form # noqa: E501 - - :return: The box8 of this TenNinteyNineContact. # noqa: E501 - :rtype: float - """ - return self._box8 - - @box8.setter - def box8(self, box8): - """Sets the box8 of this TenNinteyNineContact. - - Box 8 on 1099 Form # noqa: E501 - - :param box8: The box8 of this TenNinteyNineContact. # noqa: E501 - :type: float - """ - - self._box8 = box8 - - @property - def box9(self): - """Gets the box9 of this TenNinteyNineContact. # noqa: E501 - - Box 9 on 1099 Form # noqa: E501 - - :return: The box9 of this TenNinteyNineContact. # noqa: E501 - :rtype: float - """ - return self._box9 - - @box9.setter - def box9(self, box9): - """Sets the box9 of this TenNinteyNineContact. - - Box 9 on 1099 Form # noqa: E501 - - :param box9: The box9 of this TenNinteyNineContact. # noqa: E501 - :type: float - """ - - self._box9 = box9 - - @property - def box10(self): - """Gets the box10 of this TenNinteyNineContact. # noqa: E501 - - Box 10 on 1099 Form # noqa: E501 - - :return: The box10 of this TenNinteyNineContact. # noqa: E501 - :rtype: float - """ - return self._box10 - - @box10.setter - def box10(self, box10): - """Sets the box10 of this TenNinteyNineContact. - - Box 10 on 1099 Form # noqa: E501 - - :param box10: The box10 of this TenNinteyNineContact. # noqa: E501 - :type: float - """ - - self._box10 = box10 - - @property - def box11(self): - """Gets the box11 of this TenNinteyNineContact. # noqa: E501 - - Box 11 on 1099 Form # noqa: E501 - - :return: The box11 of this TenNinteyNineContact. # noqa: E501 - :rtype: float - """ - return self._box11 - - @box11.setter - def box11(self, box11): - """Sets the box11 of this TenNinteyNineContact. - - Box 11 on 1099 Form # noqa: E501 - - :param box11: The box11 of this TenNinteyNineContact. # noqa: E501 - :type: float - """ - - self._box11 = box11 - - @property - def box13(self): - """Gets the box13 of this TenNinteyNineContact. # noqa: E501 - - Box 13 on 1099 Form # noqa: E501 - - :return: The box13 of this TenNinteyNineContact. # noqa: E501 - :rtype: float - """ - return self._box13 - - @box13.setter - def box13(self, box13): - """Sets the box13 of this TenNinteyNineContact. - - Box 13 on 1099 Form # noqa: E501 - - :param box13: The box13 of this TenNinteyNineContact. # noqa: E501 - :type: float - """ - - self._box13 = box13 - - @property - def box14(self): - """Gets the box14 of this TenNinteyNineContact. # noqa: E501 - - Box 14 on 1099 Form # noqa: E501 - - :return: The box14 of this TenNinteyNineContact. # noqa: E501 - :rtype: float - """ - return self._box14 - - @box14.setter - def box14(self, box14): - """Sets the box14 of this TenNinteyNineContact. - - Box 14 on 1099 Form # noqa: E501 - - :param box14: The box14 of this TenNinteyNineContact. # noqa: E501 - :type: float - """ - - self._box14 = box14 - - @property - def name(self): - """Gets the name of this TenNinteyNineContact. # noqa: E501 - - Contact name on 1099 Form # noqa: E501 - - :return: The name of this TenNinteyNineContact. # noqa: E501 - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """Sets the name of this TenNinteyNineContact. - - Contact name on 1099 Form # noqa: E501 - - :param name: The name of this TenNinteyNineContact. # noqa: E501 - :type: str - """ - - self._name = name - - @property - def federal_tax_id_type(self): - """Gets the federal_tax_id_type of this TenNinteyNineContact. # noqa: E501 - - Contact Fed Tax ID type # noqa: E501 - - :return: The federal_tax_id_type of this TenNinteyNineContact. # noqa: E501 - :rtype: str - """ - return self._federal_tax_id_type - - @federal_tax_id_type.setter - def federal_tax_id_type(self, federal_tax_id_type): - """Sets the federal_tax_id_type of this TenNinteyNineContact. - - Contact Fed Tax ID type # noqa: E501 - - :param federal_tax_id_type: The federal_tax_id_type of this TenNinteyNineContact. # noqa: E501 - :type: str - """ - - self._federal_tax_id_type = federal_tax_id_type - - @property - def city(self): - """Gets the city of this TenNinteyNineContact. # noqa: E501 - - Contact city on 1099 Form # noqa: E501 - - :return: The city of this TenNinteyNineContact. # noqa: E501 - :rtype: str - """ - return self._city - - @city.setter - def city(self, city): - """Sets the city of this TenNinteyNineContact. - - Contact city on 1099 Form # noqa: E501 - - :param city: The city of this TenNinteyNineContact. # noqa: E501 - :type: str - """ - - self._city = city - - @property - def zip(self): - """Gets the zip of this TenNinteyNineContact. # noqa: E501 - - Contact zip on 1099 Form # noqa: E501 - - :return: The zip of this TenNinteyNineContact. # noqa: E501 - :rtype: str - """ - return self._zip - - @zip.setter - def zip(self, zip): - """Sets the zip of this TenNinteyNineContact. - - Contact zip on 1099 Form # noqa: E501 - - :param zip: The zip of this TenNinteyNineContact. # noqa: E501 - :type: str - """ - - self._zip = zip - - @property - def state(self): - """Gets the state of this TenNinteyNineContact. # noqa: E501 - - Contact State on 1099 Form # noqa: E501 - - :return: The state of this TenNinteyNineContact. # noqa: E501 - :rtype: str - """ - return self._state - - @state.setter - def state(self, state): - """Sets the state of this TenNinteyNineContact. - - Contact State on 1099 Form # noqa: E501 - - :param state: The state of this TenNinteyNineContact. # noqa: E501 - :type: str - """ - - self._state = state - - @property - def email(self): - """Gets the email of this TenNinteyNineContact. # noqa: E501 - - Contact email on 1099 Form # noqa: E501 - - :return: The email of this TenNinteyNineContact. # noqa: E501 - :rtype: str - """ - return self._email - - @email.setter - def email(self, email): - """Sets the email of this TenNinteyNineContact. - - Contact email on 1099 Form # noqa: E501 - - :param email: The email of this TenNinteyNineContact. # noqa: E501 - :type: str - """ - - self._email = email - - @property - def street_address(self): - """Gets the street_address of this TenNinteyNineContact. # noqa: E501 - - Contact address on 1099 Form # noqa: E501 - - :return: The street_address of this TenNinteyNineContact. # noqa: E501 - :rtype: str - """ - return self._street_address - - @street_address.setter - def street_address(self, street_address): - """Sets the street_address of this TenNinteyNineContact. - - Contact address on 1099 Form # noqa: E501 - - :param street_address: The street_address of this TenNinteyNineContact. # noqa: E501 - :type: str - """ - - self._street_address = street_address - - @property - def tax_id(self): - """Gets the tax_id of this TenNinteyNineContact. # noqa: E501 - - Contact tax id on 1099 Form # noqa: E501 - - :return: The tax_id of this TenNinteyNineContact. # noqa: E501 - :rtype: str - """ - return self._tax_id - - @tax_id.setter - def tax_id(self, tax_id): - """Sets the tax_id of this TenNinteyNineContact. - - Contact tax id on 1099 Form # noqa: E501 - - :param tax_id: The tax_id of this TenNinteyNineContact. # noqa: E501 - :type: str - """ - - self._tax_id = tax_id - - @property - def contact_id(self): - """Gets the contact_id of this TenNinteyNineContact. # noqa: E501 - - Contact contact id # noqa: E501 - - :return: The contact_id of this TenNinteyNineContact. # noqa: E501 - :rtype: str - """ - return self._contact_id - - @contact_id.setter - def contact_id(self, contact_id): - """Sets the contact_id of this TenNinteyNineContact. - - Contact contact id # noqa: E501 - - :param contact_id: The contact_id of this TenNinteyNineContact. # noqa: E501 - :type: str - """ - - self._contact_id = contact_id diff --git a/xero_python/accounting/models/time_zone.py b/xero_python/accounting/models/time_zone.py index 32191523..673b3e33 100644 --- a/xero_python/accounting/models/time_zone.py +++ b/xero_python/accounting/models/time_zone.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -24,112 +24,144 @@ class TimeZone(Enum): allowed enum values """ - MOROCCOSTANDARDTIME = "MOROCCOSTANDARDTIME" - UTC = "UTC" - GMTSTANDARDTIME = "GMTSTANDARDTIME" - GREENWICHSTANDARDTIME = "GREENWICHSTANDARDTIME" - WEUROPESTANDARDTIME = "WEUROPESTANDARDTIME" - CENTRALEUROPESTANDARDTIME = "CENTRALEUROPESTANDARDTIME" - ROMANCESTANDARDTIME = "ROMANCESTANDARDTIME" - CENTRALEUROPEANSTANDARDTIME = "CENTRALEUROPEANSTANDARDTIME" - WCENTRALAFRICASTANDARDTIME = "WCENTRALAFRICASTANDARDTIME" - NAMIBIASTANDARDTIME = "NAMIBIASTANDARDTIME" - JORDANSTANDARDTIME = "JORDANSTANDARDTIME" - GTBSTANDARDTIME = "GTBSTANDARDTIME" - MIDDLEEASTSTANDARDTIME = "MIDDLEEASTSTANDARDTIME" - EGYPTSTANDARDTIME = "EGYPTSTANDARDTIME" - SYRIASTANDARDTIME = "SYRIASTANDARDTIME" - EEUROPESTANDARDTIME = "EEUROPESTANDARDTIME" - SOUTHAFRICASTANDARDTIME = "SOUTHAFRICASTANDARDTIME" - FLESTANDARDTIME = "FLESTANDARDTIME" - TURKEYSTANDARDTIME = "TURKEYSTANDARDTIME" - ISRAELSTANDARDTIME = "ISRAELSTANDARDTIME" - KALININGRADSTANDARDTIME = "KALININGRADSTANDARDTIME" - LIBYASTANDARDTIME = "LIBYASTANDARDTIME" + AFGHANISTANSTANDARDTIME = "AFGHANISTANSTANDARDTIME" + ALASKANSTANDARDTIME = "ALASKANSTANDARDTIME" + ALEUTIANSTANDARDTIME = "ALEUTIANSTANDARDTIME" + ALTAISTANDARDTIME = "ALTAISTANDARDTIME" + ARABIANSTANDARDTIME = "ARABIANSTANDARDTIME" ARABICSTANDARDTIME = "ARABICSTANDARDTIME" ARABSTANDARDTIME = "ARABSTANDARDTIME" - BELARUSSTANDARDTIME = "BELARUSSTANDARDTIME" - RUSSIANSTANDARDTIME = "RUSSIANSTANDARDTIME" - EAFRICASTANDARDTIME = "EAFRICASTANDARDTIME" - IRANSTANDARDTIME = "IRANSTANDARDTIME" - ARABIANSTANDARDTIME = "ARABIANSTANDARDTIME" + ARGENTINASTANDARDTIME = "ARGENTINASTANDARDTIME" + ASTRAKHANSTANDARDTIME = "ASTRAKHANSTANDARDTIME" + ATLANTICSTANDARDTIME = "ATLANTICSTANDARDTIME" + AUSCENTRALSTANDARDTIME = "AUSCENTRALSTANDARDTIME" + AUSCENTRALWSTANDARDTIME = "AUSCENTRALWSTANDARDTIME" + AUSEASTERNSTANDARDTIME = "AUSEASTERNSTANDARDTIME" AZERBAIJANSTANDARDTIME = "AZERBAIJANSTANDARDTIME" - RUSSIATIMEZONE3 = "RUSSIATIMEZONE3" - MAURITIUSSTANDARDTIME = "MAURITIUSSTANDARDTIME" - GEORGIANSTANDARDTIME = "GEORGIANSTANDARDTIME" + AZORESSTANDARDTIME = "AZORESSTANDARDTIME" + BAHIASTANDARDTIME = "BAHIASTANDARDTIME" + BANGLADESHSTANDARDTIME = "BANGLADESHSTANDARDTIME" + BELARUSSTANDARDTIME = "BELARUSSTANDARDTIME" + BOUGAINVILLESTANDARDTIME = "BOUGAINVILLESTANDARDTIME" + CANADACENTRALSTANDARDTIME = "CANADACENTRALSTANDARDTIME" + CAPEVERDESTANDARDTIME = "CAPEVERDESTANDARDTIME" CAUCASUSSTANDARDTIME = "CAUCASUSSTANDARDTIME" - AFGHANISTANSTANDARDTIME = "AFGHANISTANSTANDARDTIME" - WESTASIASTANDARDTIME = "WESTASIASTANDARDTIME" - EKATERINBURGSTANDARDTIME = "EKATERINBURGSTANDARDTIME" - PAKISTANSTANDARDTIME = "PAKISTANSTANDARDTIME" - INDIASTANDARDTIME = "INDIASTANDARDTIME" - SRILANKASTANDARDTIME = "SRILANKASTANDARDTIME" - NEPALSTANDARDTIME = "NEPALSTANDARDTIME" + CENAUSTRALIASTANDARDTIME = "CENAUSTRALIASTANDARDTIME" + CENTRALAMERICASTANDARDTIME = "CENTRALAMERICASTANDARDTIME" CENTRALASIASTANDARDTIME = "CENTRALASIASTANDARDTIME" - BANGLADESHSTANDARDTIME = "BANGLADESHSTANDARDTIME" - NCENTRALASIASTANDARDTIME = "NCENTRALASIASTANDARDTIME" - MYANMARSTANDARDTIME = "MYANMARSTANDARDTIME" - SEASIASTANDARDTIME = "SEASIASTANDARDTIME" - NORTHASIASTANDARDTIME = "NORTHASIASTANDARDTIME" + CENTRALBRAZILIANSTANDARDTIME = "CENTRALBRAZILIANSTANDARDTIME" + CENTRALEUROPEANSTANDARDTIME = "CENTRALEUROPEANSTANDARDTIME" + CENTRALEUROPESTANDARDTIME = "CENTRALEUROPESTANDARDTIME" + CENTRALPACIFICSTANDARDTIME = "CENTRALPACIFICSTANDARDTIME" + CENTRALSTANDARDTIME = "CENTRALSTANDARDTIME" + CENTRALSTANDARDTIME_MEXICO_ = "CENTRALSTANDARDTIME(MEXICO)" + CHATHAMISLANDSSTANDARDTIME = "CHATHAMISLANDSSTANDARDTIME" CHINASTANDARDTIME = "CHINASTANDARDTIME" - NORTHASIAEASTSTANDARDTIME = "NORTHASIAEASTSTANDARDTIME" - SINGAPORESTANDARDTIME = "SINGAPORESTANDARDTIME" - WAUSTRALIASTANDARDTIME = "WAUSTRALIASTANDARDTIME" - TAIPEISTANDARDTIME = "TAIPEISTANDARDTIME" - ULAANBAATARSTANDARDTIME = "ULAANBAATARSTANDARDTIME" - TOKYOSTANDARDTIME = "TOKYOSTANDARDTIME" - KOREASTANDARDTIME = "KOREASTANDARDTIME" - YAKUTSKSTANDARDTIME = "YAKUTSKSTANDARDTIME" - CENAUSTRALIASTANDARDTIME = "CENAUSTRALIASTANDARDTIME" - AUSCENTRALSTANDARDTIME = "AUSCENTRALSTANDARDTIME" + CUBASTANDARDTIME = "CUBASTANDARDTIME" + DATELINESTANDARDTIME = "DATELINESTANDARDTIME" + EAFRICASTANDARDTIME = "EAFRICASTANDARDTIME" + EASTERISLANDSTANDARDTIME = "EASTERISLANDSTANDARDTIME" + EASTERNSTANDARDTIME = "EASTERNSTANDARDTIME" + EASTERNSTANDARDTIME_MEXICO_ = "EASTERNSTANDARDTIME(MEXICO)" EAUSTRALIASTANDARDTIME = "EAUSTRALIASTANDARDTIME" - AUSEASTERNSTANDARDTIME = "AUSEASTERNSTANDARDTIME" - WESTPACIFICSTANDARDTIME = "WESTPACIFICSTANDARDTIME" - TASMANIASTANDARDTIME = "TASMANIASTANDARDTIME" - MAGADANSTANDARDTIME = "MAGADANSTANDARDTIME" - VLADIVOSTOKSTANDARDTIME = "VLADIVOSTOKSTANDARDTIME" - RUSSIATIMEZONE10 = "RUSSIATIMEZONE10" - CENTRALPACIFICSTANDARDTIME = "CENTRALPACIFICSTANDARDTIME" - RUSSIATIMEZONE11 = "RUSSIATIMEZONE11" - NEWZEALANDSTANDARDTIME = "NEWZEALANDSTANDARDTIME" - UTC_12 = "UTC+12" - UTC_13 = "UTC+13" + EEUROPESTANDARDTIME = "EEUROPESTANDARDTIME" + EGYPTSTANDARDTIME = "EGYPTSTANDARDTIME" + EKATERINBURGSTANDARDTIME = "EKATERINBURGSTANDARDTIME" + ESOUTHAMERICASTANDARDTIME = "ESOUTHAMERICASTANDARDTIME" FIJISTANDARDTIME = "FIJISTANDARDTIME" + FLESTANDARDTIME = "FLESTANDARDTIME" + GEORGIANSTANDARDTIME = "GEORGIANSTANDARDTIME" + GMTSTANDARDTIME = "GMTSTANDARDTIME" + GREENLANDSTANDARDTIME = "GREENLANDSTANDARDTIME" + GREENWICHSTANDARDTIME = "GREENWICHSTANDARDTIME" + GTBSTANDARDTIME = "GTBSTANDARDTIME" + HAITISTANDARDTIME = "HAITISTANDARDTIME" + HAWAIIANSTANDARDTIME = "HAWAIIANSTANDARDTIME" + INDIASTANDARDTIME = "INDIASTANDARDTIME" + IRANSTANDARDTIME = "IRANSTANDARDTIME" + ISRAELSTANDARDTIME = "ISRAELSTANDARDTIME" + JORDANSTANDARDTIME = "JORDANSTANDARDTIME" + KALININGRADSTANDARDTIME = "KALININGRADSTANDARDTIME" KAMCHATKASTANDARDTIME = "KAMCHATKASTANDARDTIME" - TONGASTANDARDTIME = "TONGASTANDARDTIME" - SAMOASTANDARDTIME = "SAMOASTANDARDTIME" + KOREASTANDARDTIME = "KOREASTANDARDTIME" + LIBYASTANDARDTIME = "LIBYASTANDARDTIME" LINEISLANDSSTANDARDTIME = "LINEISLANDSSTANDARDTIME" - AZORESSTANDARDTIME = "AZORESSTANDARDTIME" - CAPEVERDESTANDARDTIME = "CAPEVERDESTANDARDTIME" - UTC02 = "UTC02" + LORDHOWESTANDARDTIME = "LORDHOWESTANDARDTIME" + MAGADANSTANDARDTIME = "MAGADANSTANDARDTIME" + MAGALLANESSTANDARDTIME = "MAGALLANESSTANDARDTIME" + MARQUESASSTANDARDTIME = "MARQUESASSTANDARDTIME" + MAURITIUSSTANDARDTIME = "MAURITIUSSTANDARDTIME" MIDATLANTICSTANDARDTIME = "MIDATLANTICSTANDARDTIME" - ESOUTHAMERICASTANDARDTIME = "ESOUTHAMERICASTANDARDTIME" - ARGENTINASTANDARDTIME = "ARGENTINASTANDARDTIME" - SAEASTERNSTANDARDTIME = "SAEASTERNSTANDARDTIME" - GREENLANDSTANDARDTIME = "GREENLANDSTANDARDTIME" + MIDDLEEASTSTANDARDTIME = "MIDDLEEASTSTANDARDTIME" MONTEVIDEOSTANDARDTIME = "MONTEVIDEOSTANDARDTIME" - BAHIASTANDARDTIME = "BAHIASTANDARDTIME" + MOROCCOSTANDARDTIME = "MOROCCOSTANDARDTIME" + MOUNTAINSTANDARDTIME = "MOUNTAINSTANDARDTIME" + MOUNTAINSTANDARDTIME_MEXICO_ = "MOUNTAINSTANDARDTIME(MEXICO)" + MYANMARSTANDARDTIME = "MYANMARSTANDARDTIME" + NAMIBIASTANDARDTIME = "NAMIBIASTANDARDTIME" + NCENTRALASIASTANDARDTIME = "NCENTRALASIASTANDARDTIME" + NEPALSTANDARDTIME = "NEPALSTANDARDTIME" NEWFOUNDLANDSTANDARDTIME = "NEWFOUNDLANDSTANDARDTIME" - PARAGUAYSTANDARDTIME = "PARAGUAYSTANDARDTIME" - ATLANTICSTANDARDTIME = "ATLANTICSTANDARDTIME" - CENTRALBRAZILIANSTANDARDTIME = "CENTRALBRAZILIANSTANDARDTIME" - SAWESTERNSTANDARDTIME = "SAWESTERNSTANDARDTIME" + NEWZEALANDSTANDARDTIME = "NEWZEALANDSTANDARDTIME" + NORFOLKSTANDARDTIME = "NORFOLKSTANDARDTIME" + NORTHASIAEASTSTANDARDTIME = "NORTHASIAEASTSTANDARDTIME" + NORTHASIASTANDARDTIME = "NORTHASIASTANDARDTIME" + NORTHKOREASTANDARDTIME = "NORTHKOREASTANDARDTIME" + OMSKSTANDARDTIME = "OMSKSTANDARDTIME" PACIFICSASTANDARDTIME = "PACIFICSASTANDARDTIME" - VENEZUELASTANDARDTIME = "VENEZUELASTANDARDTIME" + PACIFICSTANDARDTIME = "PACIFICSTANDARDTIME" + PACIFICSTANDARDTIME_MEXICO_ = "PACIFICSTANDARDTIME(MEXICO)" + PAKISTANSTANDARDTIME = "PAKISTANSTANDARDTIME" + PARAGUAYSTANDARDTIME = "PARAGUAYSTANDARDTIME" + QYZYLORDASTANDARDTIME = "QYZYLORDASTANDARDTIME" + ROMANCESTANDARDTIME = "ROMANCESTANDARDTIME" + RUSSIANSTANDARDTIME = "RUSSIANSTANDARDTIME" + RUSSIATIMEZONE10 = "RUSSIATIMEZONE10" + RUSSIATIMEZONE11 = "RUSSIATIMEZONE11" + RUSSIATIMEZONE3 = "RUSSIATIMEZONE3" + SAEASTERNSTANDARDTIME = "SAEASTERNSTANDARDTIME" + SAINTPIERRESTANDARDTIME = "SAINTPIERRESTANDARDTIME" + SAKHALINSTANDARDTIME = "SAKHALINSTANDARDTIME" + SAMOASTANDARDTIME = "SAMOASTANDARDTIME" + SAOTOMESTANDARDTIME = "SAOTOMESTANDARDTIME" SAPACIFICSTANDARDTIME = "SAPACIFICSTANDARDTIME" - EASTERNSTANDARDTIME = "EASTERNSTANDARDTIME" + SARATOVSTANDARDTIME = "SARATOVSTANDARDTIME" + SAWESTERNSTANDARDTIME = "SAWESTERNSTANDARDTIME" + SEASIASTANDARDTIME = "SEASIASTANDARDTIME" + SINGAPORESTANDARDTIME = "SINGAPORESTANDARDTIME" + SOUTHAFRICASTANDARDTIME = "SOUTHAFRICASTANDARDTIME" + SOUTHSUDANSTANDARDTIME = "SOUTHSUDANSTANDARDTIME" + SRILANKASTANDARDTIME = "SRILANKASTANDARDTIME" + SUDANSTANDARDTIME = "SUDANSTANDARDTIME" + SYRIASTANDARDTIME = "SYRIASTANDARDTIME" + TAIPEISTANDARDTIME = "TAIPEISTANDARDTIME" + TASMANIASTANDARDTIME = "TASMANIASTANDARDTIME" + TOCANTINSSTANDARDTIME = "TOCANTINSSTANDARDTIME" + TOKYOSTANDARDTIME = "TOKYOSTANDARDTIME" + TOMSKSTANDARDTIME = "TOMSKSTANDARDTIME" + TONGASTANDARDTIME = "TONGASTANDARDTIME" + TRANSBAIKALSTANDARDTIME = "TRANSBAIKALSTANDARDTIME" + TURKEYSTANDARDTIME = "TURKEYSTANDARDTIME" + TURKSANDCAICOSSTANDARDTIME = "TURKSANDCAICOSSTANDARDTIME" + ULAANBAATARSTANDARDTIME = "ULAANBAATARSTANDARDTIME" USEASTERNSTANDARDTIME = "USEASTERNSTANDARDTIME" - CENTRALAMERICASTANDARDTIME = "CENTRALAMERICASTANDARDTIME" - CENTRALSTANDARDTIME = "CENTRALSTANDARDTIME" - CENTRALSTANDARDTIME_MEXICO_ = "CENTRALSTANDARDTIME(MEXICO)" - CANADACENTRALSTANDARDTIME = "CANADACENTRALSTANDARDTIME" USMOUNTAINSTANDARDTIME = "USMOUNTAINSTANDARDTIME" - MOUNTAINSTANDARDTIME_MEXICO_ = "MOUNTAINSTANDARDTIME(MEXICO)" - MOUNTAINSTANDARDTIME = "MOUNTAINSTANDARDTIME" - PACIFICSTANDARDTIME_MEXICO_ = "PACIFICSTANDARDTIME(MEXICO)" - PACIFICSTANDARDTIME = "PACIFICSTANDARDTIME" - ALASKANSTANDARDTIME = "ALASKANSTANDARDTIME" - HAWAIIANSTANDARDTIME = "HAWAIIANSTANDARDTIME" + UTC = "UTC" + UTC_12 = "UTC+12" + UTC_13 = "UTC+13" + UTC02 = "UTC02" + UTC08 = "UTC08" + UTC09 = "UTC09" UTC11 = "UTC11" - DATELINESTANDARDTIME = "DATELINESTANDARDTIME" - EASTERISLANDSTANDARDTIME = "EASTERISLANDSTANDARDTIME" + VENEZUELASTANDARDTIME = "VENEZUELASTANDARDTIME" + VLADIVOSTOKSTANDARDTIME = "VLADIVOSTOKSTANDARDTIME" + VOLGOGRADSTANDARDTIME = "VOLGOGRADSTANDARDTIME" + WAUSTRALIASTANDARDTIME = "WAUSTRALIASTANDARDTIME" + WCENTRALAFRICASTANDARDTIME = "WCENTRALAFRICASTANDARDTIME" + WESTASIASTANDARDTIME = "WESTASIASTANDARDTIME" + WESTBANKSTANDARDTIME = "WESTBANKSTANDARDTIME" + WESTPACIFICSTANDARDTIME = "WESTPACIFICSTANDARDTIME" + WEUROPESTANDARDTIME = "WEUROPESTANDARDTIME" + WMONGOLIASTANDARDTIME = "WMONGOLIASTANDARDTIME" + YAKUTSKSTANDARDTIME = "YAKUTSKSTANDARDTIME" + YUKONSTANDARDTIME = "YUKONSTANDARDTIME" diff --git a/xero_python/accounting/models/tracking_categories.py b/xero_python/accounting/models/tracking_categories.py index b3e0c11b..baeb6251 100644 --- a/xero_python/accounting/models/tracking_categories.py +++ b/xero_python/accounting/models/tracking_categories.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/tracking_category.py b/xero_python/accounting/models/tracking_category.py index af4d61ba..161f40e3 100644 --- a/xero_python/accounting/models/tracking_category.py +++ b/xero_python/accounting/models/tracking_category.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/tracking_option.py b/xero_python/accounting/models/tracking_option.py index 3d76ca94..a603f922 100644 --- a/xero_python/accounting/models/tracking_option.py +++ b/xero_python/accounting/models/tracking_option.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/tracking_options.py b/xero_python/accounting/models/tracking_options.py index 3508b2d0..1b2dc609 100644 --- a/xero_python/accounting/models/tracking_options.py +++ b/xero_python/accounting/models/tracking_options.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/tracking_reference.py b/xero_python/accounting/models/tracking_reference.py new file mode 100644 index 00000000..ac9d3b63 --- /dev/null +++ b/xero_python/accounting/models/tracking_reference.py @@ -0,0 +1,167 @@ +# coding: utf-8 + +""" +Xero Accounting API + +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class TrackingReference(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "tracking_category_id": "str", + "tracking_option_id": "str", + "name": "str", + "option": "str", + } + + attribute_map = { + "tracking_category_id": "TrackingCategoryID", + "tracking_option_id": "TrackingOptionID", + "name": "Name", + "option": "Option", + } + + def __init__( + self, tracking_category_id=None, tracking_option_id=None, name=None, option=None + ): # noqa: E501 + """TrackingReference - a model defined in OpenAPI""" # noqa: E501 + + self._tracking_category_id = None + self._tracking_option_id = None + self._name = None + self._option = None + self.discriminator = None + + self.tracking_category_id = tracking_category_id + self.tracking_option_id = tracking_option_id + if name is not None: + self.name = name + if option is not None: + self.option = option + + @property + def tracking_category_id(self): + """Gets the tracking_category_id of this TrackingReference. # noqa: E501 + + The Xero identifier for a tracking category # noqa: E501 + + :return: The tracking_category_id of this TrackingReference. # noqa: E501 + :rtype: str + """ + return self._tracking_category_id + + @tracking_category_id.setter + def tracking_category_id(self, tracking_category_id): + """Sets the tracking_category_id of this TrackingReference. + + The Xero identifier for a tracking category # noqa: E501 + + :param tracking_category_id: The tracking_category_id of this TrackingReference. # noqa: E501 + :type: str + """ + if tracking_category_id is None: + raise ValueError( + "Invalid value for `tracking_category_id`, must not be `None`" + ) # noqa: E501 + + self._tracking_category_id = tracking_category_id + + @property + def tracking_option_id(self): + """Gets the tracking_option_id of this TrackingReference. # noqa: E501 + + The Xero identifier for a tracking category option # noqa: E501 + + :return: The tracking_option_id of this TrackingReference. # noqa: E501 + :rtype: str + """ + return self._tracking_option_id + + @tracking_option_id.setter + def tracking_option_id(self, tracking_option_id): + """Sets the tracking_option_id of this TrackingReference. + + The Xero identifier for a tracking category option # noqa: E501 + + :param tracking_option_id: The tracking_option_id of this TrackingReference. # noqa: E501 + :type: str + """ + if tracking_option_id is None: + raise ValueError( + "Invalid value for `tracking_option_id`, must not be `None`" + ) # noqa: E501 + + self._tracking_option_id = tracking_option_id + + @property + def name(self): + """Gets the name of this TrackingReference. # noqa: E501 + + The name of the tracking category # noqa: E501 + + :return: The name of this TrackingReference. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this TrackingReference. + + The name of the tracking category # noqa: E501 + + :param name: The name of this TrackingReference. # noqa: E501 + :type: str + """ + if name is not None and len(name) > 100: + raise ValueError( + "Invalid value for `name`, " + "length must be less than or equal to `100`" + ) # noqa: E501 + + self._name = name + + @property + def option(self): + """Gets the option of this TrackingReference. # noqa: E501 + + See Tracking Options # noqa: E501 + + :return: The option of this TrackingReference. # noqa: E501 + :rtype: str + """ + return self._option + + @option.setter + def option(self, option): + """Sets the option of this TrackingReference. + + See Tracking Options # noqa: E501 + + :param option: The option of this TrackingReference. # noqa: E501 + :type: str + """ + + self._option = option diff --git a/xero_python/accounting/models/user.py b/xero_python/accounting/models/user.py index ac870fc4..95c0180b 100644 --- a/xero_python/accounting/models/user.py +++ b/xero_python/accounting/models/user.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -251,6 +251,7 @@ def organisation_role(self, organisation_role): "MANAGEDCLIENT", "CASHBOOKCLIENT", "UNKNOWN", + "REMOVED", "None", ] # noqa: E501 diff --git a/xero_python/accounting/models/users.py b/xero_python/accounting/models/users.py index 8f1acaff..41a2d5ed 100644 --- a/xero_python/accounting/models/users.py +++ b/xero_python/accounting/models/users.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/validation_error.py b/xero_python/accounting/models/validation_error.py index cdad4864..195a267d 100644 --- a/xero_python/accounting/models/validation_error.py +++ b/xero_python/accounting/models/validation_error.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Accounting API +Xero Accounting API - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/api_client/__init__.py b/xero_python/api_client/__init__.py index e8d51ecd..645cf506 100644 --- a/xero_python/api_client/__init__.py +++ b/xero_python/api_client/__init__.py @@ -147,7 +147,6 @@ def __call_api( _preload_content=True, _request_timeout=None, ): - config = self.configuration # header parameters @@ -259,7 +258,7 @@ def __deserialize(self, data, klass, model_finder): if data is None: return None - if type(klass) == str: + if isinstance(klass, str): if klass.startswith("list["): sub_kls = re.match(r"list\[(.*)\]", klass).group(1) return [ diff --git a/xero_python/api_client/deserializer.py b/xero_python/api_client/deserializer.py index e8584130..b64e9820 100644 --- a/xero_python/api_client/deserializer.py +++ b/xero_python/api_client/deserializer.py @@ -22,7 +22,7 @@ ) MS_DATETIME_RE = re.compile(r"/Date\((?P-?\d+)(?P[+-]\d{2,4})?\)/$") -DATE_WITH_NO_DAY_RE = re.compile("(\d\d\d\d)-(\d\d)") +DATE_WITH_NO_DAY_RE = re.compile(r"(\d\d\d\d)-(\d\d)") def deserialize_routing(data_type, data, model_finder): diff --git a/xero_python/api_client/oauth2.py b/xero_python/api_client/oauth2.py index ca7aab20..f2277425 100644 --- a/xero_python/api_client/oauth2.py +++ b/xero_python/api_client/oauth2.py @@ -213,7 +213,7 @@ def can_refresh_access_token(self): """ return ( self.refresh_token - and isinstance(self.scope, (list, tuple)) + and isinstance(self.scope, (list, tuple, str)) and self.client_id and self.client_secret ) diff --git a/xero_python/appstore/__init__.py b/xero_python/appstore/__init__.py index 3edeead4..a32af2fc 100644 --- a/xero_python/appstore/__init__.py +++ b/xero_python/appstore/__init__.py @@ -3,12 +3,12 @@ # flake8: noqa """ - Xero AppStore API +Xero AppStore API - These endpoints are for Xero Partners to interact with the App Store Billing platform # noqa: E501 +These endpoints are for Xero Partners to interact with the App Store Billing platform # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -17,9 +17,13 @@ # import models into sdk package +from xero_python.appstore.models.create_usage_record import CreateUsageRecord from xero_python.appstore.models.plan import Plan from xero_python.appstore.models.price import Price from xero_python.appstore.models.problem_details import ProblemDetails from xero_python.appstore.models.product import Product from xero_python.appstore.models.subscription import Subscription from xero_python.appstore.models.subscription_item import SubscriptionItem +from xero_python.appstore.models.update_usage_record import UpdateUsageRecord +from xero_python.appstore.models.usage_record import UsageRecord +from xero_python.appstore.models.usage_records_list import UsageRecordsList diff --git a/xero_python/appstore/api/app_store_api.py b/xero_python/appstore/api/app_store_api.py index 29a17151..b201bc02 100644 --- a/xero_python/appstore/api/app_store_api.py +++ b/xero_python/appstore/api/app_store_api.py @@ -1,5 +1,16 @@ # coding: utf-8 +import importlib +import re # noqa: F401 + +from xero_python import exceptions +from xero_python.api_client import ApiClient, ModelFinder + +try: + from .exception_handler import translate_status_exception +except ImportError: + translate_status_exception = exceptions.translate_status_exception + """ Xero AppStore API @@ -10,20 +21,9 @@ """ """ - OpenAPI spec version: 2.19.3 + OpenAPI spec version: 16.2.0 """ -import importlib -import re # noqa: F401 - -from xero_python import exceptions -from xero_python.api_client import ApiClient, ModelFinder - -try: - from .exception_handler import translate_status_exception -except ImportError: - translate_status_exception = exceptions.translate_status_exception - class empty: """empty object to mark optional parameter not set""" @@ -121,3 +121,268 @@ def get_subscription( ) except exceptions.HTTPStatusException as error: raise translate_status_exception(error, self, "get_subscription") + + def get_usage_records( + self, + subscription_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Gets all usage records related to the subscription # noqa: E501 + OAuth2 scope: marketplace.billing + :param str subscription_id: Unique identifier for Subscription object (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: UsageRecordsList + """ + + # verify the required parameter 'subscription_id' is set + if subscription_id is None: + raise ValueError( + "Missing the required parameter `subscription_id` " + "when calling `get_usage_records`" + ) + + collection_formats = {} + path_params = { + "subscriptionId": subscription_id, + } + + query_params = [] + + header_params = {} + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/subscriptions/{subscriptionId}/usage-records") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="UsageRecordsList", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_usage_records") + + def post_usage_records( + self, + subscription_id, + subscription_item_id, + create_usage_record, + idempotency_key=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Send metered usage belonging to this subscription and subscription item # noqa: E501 + OAuth2 scope: marketplace.billing + :param str subscription_id: Unique identifier for Subscription object (required) + :param str subscription_item_id: The unique identifier of the subscriptionItem (required) + :param CreateUsageRecord create_usage_record: Contains the quantity for the usage record to create (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: UsageRecord + """ + + # verify the required parameter 'subscription_id' is set + if subscription_id is None: + raise ValueError( + "Missing the required parameter `subscription_id` " + "when calling `post_usage_records`" + ) + # verify the required parameter 'subscription_item_id' is set + if subscription_item_id is None: + raise ValueError( + "Missing the required parameter `subscription_item_id` " + "when calling `post_usage_records`" + ) + # verify the required parameter 'create_usage_record' is set + if create_usage_record is None: + raise ValueError( + "Missing the required parameter `create_usage_record` " + "when calling `post_usage_records`" + ) + + collection_formats = {} + path_params = { + "subscriptionId": subscription_id, + "subscriptionItemId": subscription_item_id, + } + + query_params = [] + + header_params = {} + + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + + local_var_files = {} + form_params = [] + + body_params = create_usage_record + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url( + "/subscriptions/{subscriptionId}/items/{subscriptionItemId}/usage-records" + ) + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="UsageRecord", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "post_usage_records") + + def put_usage_records( + self, + subscription_id, + subscription_item_id, + usage_record_id, + update_usage_record, + idempotency_key=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Update and existing metered usage belonging to this subscription and subscription item # noqa: E501 + OAuth2 scope: marketplace.billing + :param str subscription_id: Unique identifier for Subscription object (required) + :param str subscription_item_id: The unique identifier of the subscriptionItem (required) + :param str usage_record_id: The unique identifier of the usage record (required) + :param UpdateUsageRecord update_usage_record: Contains the quantity for the usage record to update (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: UsageRecord + """ + + # verify the required parameter 'subscription_id' is set + if subscription_id is None: + raise ValueError( + "Missing the required parameter `subscription_id` " + "when calling `put_usage_records`" + ) + # verify the required parameter 'subscription_item_id' is set + if subscription_item_id is None: + raise ValueError( + "Missing the required parameter `subscription_item_id` " + "when calling `put_usage_records`" + ) + # verify the required parameter 'usage_record_id' is set + if usage_record_id is None: + raise ValueError( + "Missing the required parameter `usage_record_id` " + "when calling `put_usage_records`" + ) + # verify the required parameter 'update_usage_record' is set + if update_usage_record is None: + raise ValueError( + "Missing the required parameter `update_usage_record` " + "when calling `put_usage_records`" + ) + + collection_formats = {} + path_params = { + "subscriptionId": subscription_id, + "subscriptionItemId": subscription_item_id, + "usageRecordId": usage_record_id, + } + + query_params = [] + + header_params = {} + + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + + local_var_files = {} + form_params = [] + + body_params = update_usage_record + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url( + "/subscriptions/{subscriptionId}/items/{subscriptionItemId}/usage-records/{usageRecordId}" + ) + + try: + return self.api_client.call_api( + url, + "PUT", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="UsageRecord", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "put_usage_records") diff --git a/xero_python/appstore/docs/AppStoreApi.md b/xero_python/appstore/docs/AppStoreApi.md index 475c655b..bb2d56d1 100644 --- a/xero_python/appstore/docs/AppStoreApi.md +++ b/xero_python/appstore/docs/AppStoreApi.md @@ -5,6 +5,9 @@ All URIs are relative to *https://api.xero.com/appstore/2.0* Method | HTTP request | Description ------------- | ------------- | ------------- [**get_subscription**](AppStoreApi.md#get_subscription) | **GET** /subscriptions/{subscriptionId} | Retrieves a subscription for a given subscriptionId +[**get_usage_records**](AppStoreApi.md#get_usage_records) | **GET** /subscriptions/{subscriptionId}/usage-records | Gets all usage records related to the subscription +[**post_usage_records**](AppStoreApi.md#post_usage_records) | **POST** /subscriptions/{subscriptionId}/items/{subscriptionItemId}/usage-records | Send metered usage belonging to this subscription and subscription item +[**put_usage_records**](AppStoreApi.md#put_usage_records) | **PUT** /subscriptions/{subscriptionId}/items/{subscriptionItemId}/usage-records/{usageRecordId} | Update and existing metered usage belonging to this subscription and subscription item # **get_subscription** @@ -68,3 +71,200 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_usage_records** +> UsageRecordsList get_usage_records(subscription_id) + +Gets all usage records related to the subscription + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.appstore import AppStoreApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = AppStoreApi(api_client) + +subscription_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for Subscription object +try: + # Gets all usage records related to the subscription + api_response = api_instance.get_usage_records(subscription_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling AppStoreApi->get_usage_records: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **subscription_id** | [**str**](.md)| Unique identifier for Subscription object | + +### Return type + +[**UsageRecordsList**](UsageRecordsList.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **post_usage_records** +> UsageRecord post_usage_records(subscription_id, subscription_item_id, create_usage_record, idempotency_key=idempotency_key) + +Send metered usage belonging to this subscription and subscription item + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.appstore import AppStoreApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = AppStoreApi(api_client) + +subscription_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for Subscription object +subscription_item_id = '00000000-0000-0000-0000-000000000000' # str | The unique identifier of the subscriptionItem +create_usage_record = {"timestamp":"2022-01-21T13:01:00","quantity":10} # CreateUsageRecord | Contains the quantity for the usage record to create +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) +try: + # Send metered usage belonging to this subscription and subscription item + api_response = api_instance.post_usage_records(subscription_id, subscription_item_id, create_usage_record, idempotency_key=idempotency_key) + pprint(api_response) +except ApiException as e: + print("Exception when calling AppStoreApi->post_usage_records: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **subscription_id** | [**str**](.md)| Unique identifier for Subscription object | + **subscription_item_id** | [**str**](.md)| The unique identifier of the subscriptionItem | + **create_usage_record** | [**CreateUsageRecord**](CreateUsageRecord.md)| Contains the quantity for the usage record to create | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] + +### Return type + +[**UsageRecord**](UsageRecord.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **put_usage_records** +> UsageRecord put_usage_records(subscription_id, subscription_item_id, usage_record_id, update_usage_record, idempotency_key=idempotency_key) + +Update and existing metered usage belonging to this subscription and subscription item + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.appstore import AppStoreApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = AppStoreApi(api_client) + +subscription_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for Subscription object +subscription_item_id = '00000000-0000-0000-0000-000000000000' # str | The unique identifier of the subscriptionItem +usage_record_id = '00000000-0000-0000-0000-000000000000' # str | The unique identifier of the usage record +update_usage_record = {"quantity":10} # UpdateUsageRecord | Contains the quantity for the usage record to update +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) +try: + # Update and existing metered usage belonging to this subscription and subscription item + api_response = api_instance.put_usage_records(subscription_id, subscription_item_id, usage_record_id, update_usage_record, idempotency_key=idempotency_key) + pprint(api_response) +except ApiException as e: + print("Exception when calling AppStoreApi->put_usage_records: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **subscription_id** | [**str**](.md)| Unique identifier for Subscription object | + **subscription_item_id** | [**str**](.md)| The unique identifier of the subscriptionItem | + **usage_record_id** | [**str**](.md)| The unique identifier of the usage record | + **update_usage_record** | [**UpdateUsageRecord**](UpdateUsageRecord.md)| Contains the quantity for the usage record to update | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] + +### Return type + +[**UsageRecord**](UsageRecord.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/xero_python/appstore/docs/CreateUsageRecord.md b/xero_python/appstore/docs/CreateUsageRecord.md new file mode 100644 index 00000000..b570e578 --- /dev/null +++ b/xero_python/appstore/docs/CreateUsageRecord.md @@ -0,0 +1,11 @@ +# CreateUsageRecord + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**quantity** | **int** | The initial quantity for the usage record. Must be a whole number that is greater than or equal to 0 | +**timestamp** | **datetime** | DateTime in UTC of when the the product was consumed/used | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/appstore/docs/Product.md b/xero_python/appstore/docs/Product.md index fefd6cd0..7019a83f 100644 --- a/xero_python/appstore/docs/Product.md +++ b/xero_python/appstore/docs/Product.md @@ -5,8 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | The unique identifier for the product | [optional] **name** | **str** | The name of the product | [optional] -**type** | **str** | The pricing model of the product: * FIXED: Customers are charged a fixed amount for each billing period * PER_SEAT: Customers are charged based on the number of units they purchase | [optional] **seat_unit** | **str** | The unit of the per seat product. e.g. \"user\", \"organisation\", \"SMS\", etc | [optional] +**type** | **str** | The pricing model of the product: * FIXED: Customers are charged a fixed amount for each billing period * PER_SEAT: Customers are charged based on the number of units they purchase * METERED: Customers are charged per use of this product * SIMPLE: Customers are charged on a fixed amount for each billing period with an optional add-on feature | [optional] +**usage_unit** | **str** | The unit of the usage product. e.g. \"user\", \"minutes\", \"SMS\", etc | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/appstore/docs/SubscriptionItem.md b/xero_python/appstore/docs/SubscriptionItem.md index 93eac8e8..294e6df9 100644 --- a/xero_python/appstore/docs/SubscriptionItem.md +++ b/xero_python/appstore/docs/SubscriptionItem.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **id** | **str** | The unique identifier of the subscription item. | **price** | [**Price**](Price.md) | | **product** | [**Product**](Product.md) | | +**quantity** | **int** | 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. | [optional] **start_date** | **datetime** | Date the subscription started, or will start. Note: this could be in the future for downgrades or reduced number of seats that haven't taken effect yet. | **status** | **str** | Status of the subscription item. Available statuses are ACTIVE, CANCELED, and PENDING_ACTIVATION. | **test_mode** | **bool** | If the subscription is a test subscription | [optional] diff --git a/xero_python/appstore/docs/UpdateUsageRecord.md b/xero_python/appstore/docs/UpdateUsageRecord.md new file mode 100644 index 00000000..e22fc3b9 --- /dev/null +++ b/xero_python/appstore/docs/UpdateUsageRecord.md @@ -0,0 +1,10 @@ +# UpdateUsageRecord + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**quantity** | **int** | The new quantity for the usage record. Must be a whole number that is greater than or equal to 0 | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/appstore/docs/UsageRecord.md b/xero_python/appstore/docs/UsageRecord.md new file mode 100644 index 00000000..3f8339a3 --- /dev/null +++ b/xero_python/appstore/docs/UsageRecord.md @@ -0,0 +1,17 @@ +# UsageRecord + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**quantity** | **int** | The quantity recorded | +**subscription_id** | **str** | The unique identifier of the Subscription. | +**subscription_item_id** | **str** | The unique identifier of the SubscriptionItem. | +**test_mode** | **bool** | If the subscription is a test subscription | +**recorded_at** | **datetime** | The time when this usage was recorded in UTC | +**usage_record_id** | **str** | The unique identifier of the usageRecord. | +**price_per_unit** | **float** | The price per unit | +**product_id** | **str** | The unique identifier of the linked Product | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/appstore/docs/UsageRecordsList.md b/xero_python/appstore/docs/UsageRecordsList.md new file mode 100644 index 00000000..278ee3c6 --- /dev/null +++ b/xero_python/appstore/docs/UsageRecordsList.md @@ -0,0 +1,10 @@ +# UsageRecordsList + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**usage_records** | [**list[UsageRecord]**](UsageRecord.md) | A collection of usage records | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/appstore/models/__init__.py b/xero_python/appstore/models/__init__.py index f0a6a556..04bd3cd3 100644 --- a/xero_python/appstore/models/__init__.py +++ b/xero_python/appstore/models/__init__.py @@ -2,19 +2,23 @@ # flake8: noqa """ - Xero AppStore API +Xero AppStore API - These endpoints are for Xero Partners to interact with the App Store Billing platform # noqa: E501 +These endpoints are for Xero Partners to interact with the App Store Billing platform # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ # import models into model package +from xero_python.appstore.models.create_usage_record import CreateUsageRecord from xero_python.appstore.models.plan import Plan from xero_python.appstore.models.price import Price from xero_python.appstore.models.problem_details import ProblemDetails from xero_python.appstore.models.product import Product from xero_python.appstore.models.subscription import Subscription from xero_python.appstore.models.subscription_item import SubscriptionItem +from xero_python.appstore.models.update_usage_record import UpdateUsageRecord +from xero_python.appstore.models.usage_record import UsageRecord +from xero_python.appstore.models.usage_records_list import UsageRecordsList diff --git a/xero_python/appstore/models/create_usage_record.py b/xero_python/appstore/models/create_usage_record.py new file mode 100644 index 00000000..0e1d88e8 --- /dev/null +++ b/xero_python/appstore/models/create_usage_record.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" +Xero AppStore API + +These endpoints are for Xero Partners to interact with the App Store Billing platform # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class CreateUsageRecord(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = {"quantity": "int", "timestamp": "datetime"} + + attribute_map = {"quantity": "quantity", "timestamp": "timestamp"} + + def __init__(self, quantity=None, timestamp=None): # noqa: E501 + """CreateUsageRecord - a model defined in OpenAPI""" # noqa: E501 + + self._quantity = None + self._timestamp = None + self.discriminator = None + + self.quantity = quantity + self.timestamp = timestamp + + @property + def quantity(self): + """Gets the quantity of this CreateUsageRecord. # noqa: E501 + + The initial quantity for the usage record. Must be a whole number that is greater than or equal to 0 # noqa: E501 + + :return: The quantity of this CreateUsageRecord. # noqa: E501 + :rtype: int + """ + return self._quantity + + @quantity.setter + def quantity(self, quantity): + """Sets the quantity of this CreateUsageRecord. + + The initial quantity for the usage record. Must be a whole number that is greater than or equal to 0 # noqa: E501 + + :param quantity: The quantity of this CreateUsageRecord. # noqa: E501 + :type: int + """ + if quantity is None: + raise ValueError( + "Invalid value for `quantity`, must not be `None`" + ) # noqa: E501 + + self._quantity = quantity + + @property + def timestamp(self): + """Gets the timestamp of this CreateUsageRecord. # noqa: E501 + + DateTime in UTC of when the the product was consumed/used # noqa: E501 + + :return: The timestamp of this CreateUsageRecord. # noqa: E501 + :rtype: datetime + """ + return self._timestamp + + @timestamp.setter + def timestamp(self, timestamp): + """Sets the timestamp of this CreateUsageRecord. + + DateTime in UTC of when the the product was consumed/used # noqa: E501 + + :param timestamp: The timestamp of this CreateUsageRecord. # noqa: E501 + :type: datetime + """ + if timestamp is None: + raise ValueError( + "Invalid value for `timestamp`, must not be `None`" + ) # noqa: E501 + + self._timestamp = timestamp diff --git a/xero_python/appstore/models/plan.py b/xero_python/appstore/models/plan.py index 6cb32f44..217495c4 100644 --- a/xero_python/appstore/models/plan.py +++ b/xero_python/appstore/models/plan.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero AppStore API +Xero AppStore API - These endpoints are for Xero Partners to interact with the App Store Billing platform # noqa: E501 +These endpoints are for Xero Partners to interact with the App Store Billing platform # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/appstore/models/price.py b/xero_python/appstore/models/price.py index f5b022a0..ac94923f 100644 --- a/xero_python/appstore/models/price.py +++ b/xero_python/appstore/models/price.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero AppStore API +Xero AppStore API - These endpoints are for Xero Partners to interact with the App Store Billing platform # noqa: E501 +These endpoints are for Xero Partners to interact with the App Store Billing platform # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/appstore/models/problem_details.py b/xero_python/appstore/models/problem_details.py index 8530a44a..78a77c0d 100644 --- a/xero_python/appstore/models/problem_details.py +++ b/xero_python/appstore/models/problem_details.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero AppStore API +Xero AppStore API - These endpoints are for Xero Partners to interact with the App Store Billing platform # noqa: E501 +These endpoints are for Xero Partners to interact with the App Store Billing platform # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/appstore/models/product.py b/xero_python/appstore/models/product.py index fa8bf8cc..c2732f0b 100644 --- a/xero_python/appstore/models/product.py +++ b/xero_python/appstore/models/product.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero AppStore API +Xero AppStore API - These endpoints are for Xero Partners to interact with the App Store Billing platform # noqa: E501 +These endpoints are for Xero Partners to interact with the App Store Billing platform # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -29,32 +29,44 @@ class Product(BaseModel): attribute_map (dict): The key is attribute name and the value is json key in definition. """ - openapi_types = {"id": "str", "name": "str", "type": "str", "seat_unit": "str"} + openapi_types = { + "id": "str", + "name": "str", + "seat_unit": "str", + "type": "str", + "usage_unit": "str", + } attribute_map = { "id": "id", "name": "name", - "type": "type", "seat_unit": "seatUnit", + "type": "type", + "usage_unit": "usageUnit", } - def __init__(self, id=None, name=None, type=None, seat_unit=None): # noqa: E501 + def __init__( + self, id=None, name=None, seat_unit=None, type=None, usage_unit=None + ): # noqa: E501 """Product - a model defined in OpenAPI""" # noqa: E501 self._id = None self._name = None - self._type = None self._seat_unit = None + self._type = None + self._usage_unit = None self.discriminator = None if id is not None: self.id = id if name is not None: self.name = name - if type is not None: - self.type = type if seat_unit is not None: self.seat_unit = seat_unit + if type is not None: + self.type = type + if usage_unit is not None: + self.usage_unit = usage_unit @property def id(self): @@ -102,11 +114,34 @@ def name(self, name): self._name = name + @property + def seat_unit(self): + """Gets the seat_unit of this Product. # noqa: E501 + + The unit of the per seat product. e.g. \"user\", \"organisation\", \"SMS\", etc # noqa: E501 + + :return: The seat_unit of this Product. # noqa: E501 + :rtype: str + """ + return self._seat_unit + + @seat_unit.setter + def seat_unit(self, seat_unit): + """Sets the seat_unit of this Product. + + The unit of the per seat product. e.g. \"user\", \"organisation\", \"SMS\", etc # noqa: E501 + + :param seat_unit: The seat_unit of this Product. # noqa: E501 + :type: str + """ + + self._seat_unit = seat_unit + @property def type(self): """Gets the type of this Product. # noqa: E501 - The pricing model of the product: * FIXED: Customers are charged a fixed amount for each billing period * PER_SEAT: Customers are charged based on the number of units they purchase # noqa: E501 + The pricing model of the product: * FIXED: Customers are charged a fixed amount for each billing period * PER_SEAT: Customers are charged based on the number of units they purchase * METERED: Customers are charged per use of this product * SIMPLE: Customers are charged on a fixed amount for each billing period with an optional add-on feature # noqa: E501 :return: The type of this Product. # noqa: E501 :rtype: str @@ -117,12 +152,18 @@ def type(self): def type(self, type): """Sets the type of this Product. - The pricing model of the product: * FIXED: Customers are charged a fixed amount for each billing period * PER_SEAT: Customers are charged based on the number of units they purchase # noqa: E501 + The pricing model of the product: * FIXED: Customers are charged a fixed amount for each billing period * PER_SEAT: Customers are charged based on the number of units they purchase * METERED: Customers are charged per use of this product * SIMPLE: Customers are charged on a fixed amount for each billing period with an optional add-on feature # noqa: E501 :param type: The type of this Product. # noqa: E501 :type: str """ - allowed_values = ["FIXED", "PER_SEAT", "None"] # noqa: E501 + allowed_values = [ + "FIXED", + "PER_SEAT", + "METERED", + "SIMPLE", + "None", + ] # noqa: E501 if type: if type not in allowed_values: @@ -135,24 +176,24 @@ def type(self, type): self._type = type @property - def seat_unit(self): - """Gets the seat_unit of this Product. # noqa: E501 + def usage_unit(self): + """Gets the usage_unit of this Product. # noqa: E501 - The unit of the per seat product. e.g. \"user\", \"organisation\", \"SMS\", etc # noqa: E501 + The unit of the usage product. e.g. \"user\", \"minutes\", \"SMS\", etc # noqa: E501 - :return: The seat_unit of this Product. # noqa: E501 + :return: The usage_unit of this Product. # noqa: E501 :rtype: str """ - return self._seat_unit + return self._usage_unit - @seat_unit.setter - def seat_unit(self, seat_unit): - """Sets the seat_unit of this Product. + @usage_unit.setter + def usage_unit(self, usage_unit): + """Sets the usage_unit of this Product. - The unit of the per seat product. e.g. \"user\", \"organisation\", \"SMS\", etc # noqa: E501 + The unit of the usage product. e.g. \"user\", \"minutes\", \"SMS\", etc # noqa: E501 - :param seat_unit: The seat_unit of this Product. # noqa: E501 + :param usage_unit: The usage_unit of this Product. # noqa: E501 :type: str """ - self._seat_unit = seat_unit + self._usage_unit = usage_unit diff --git a/xero_python/appstore/models/subscription.py b/xero_python/appstore/models/subscription.py index caf0f436..affad036 100644 --- a/xero_python/appstore/models/subscription.py +++ b/xero_python/appstore/models/subscription.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero AppStore API +Xero AppStore API - These endpoints are for Xero Partners to interact with the App Store Billing platform # noqa: E501 +These endpoints are for Xero Partners to interact with the App Store Billing platform # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/appstore/models/subscription_item.py b/xero_python/appstore/models/subscription_item.py index a0d849e2..9fc9f6e4 100644 --- a/xero_python/appstore/models/subscription_item.py +++ b/xero_python/appstore/models/subscription_item.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero AppStore API +Xero AppStore API - These endpoints are for Xero Partners to interact with the App Store Billing platform # noqa: E501 +These endpoints are for Xero Partners to interact with the App Store Billing platform # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -34,6 +34,7 @@ class SubscriptionItem(BaseModel): "id": "str", "price": "Price", "product": "Product", + "quantity": "int", "start_date": "datetime", "status": "str", "test_mode": "bool", @@ -44,6 +45,7 @@ class SubscriptionItem(BaseModel): "id": "id", "price": "price", "product": "product", + "quantity": "quantity", "start_date": "startDate", "status": "status", "test_mode": "testMode", @@ -55,6 +57,7 @@ def __init__( id=None, price=None, product=None, + quantity=None, start_date=None, status=None, test_mode=None, @@ -65,6 +68,7 @@ def __init__( self._id = None self._price = None self._product = None + self._quantity = None self._start_date = None self._status = None self._test_mode = None @@ -75,6 +79,8 @@ def __init__( self.id = id self.price = price self.product = product + if quantity is not None: + self.quantity = quantity self.start_date = start_date self.status = status if test_mode is not None: @@ -178,6 +184,29 @@ def product(self, product): self._product = product + @property + def quantity(self): + """Gets the quantity of this SubscriptionItem. # noqa: E501 + + 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. # noqa: E501 + + :return: The quantity of this SubscriptionItem. # noqa: E501 + :rtype: int + """ + return self._quantity + + @quantity.setter + def quantity(self, quantity): + """Sets the quantity of this SubscriptionItem. + + 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. # noqa: E501 + + :param quantity: The quantity of this SubscriptionItem. # noqa: E501 + :type: int + """ + + self._quantity = quantity + @property def start_date(self): """Gets the start_date of this SubscriptionItem. # noqa: E501 diff --git a/xero_python/appstore/models/update_usage_record.py b/xero_python/appstore/models/update_usage_record.py new file mode 100644 index 00000000..c478a346 --- /dev/null +++ b/xero_python/appstore/models/update_usage_record.py @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" +Xero AppStore API + +These endpoints are for Xero Partners to interact with the App Store Billing platform # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class UpdateUsageRecord(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = {"quantity": "int"} + + attribute_map = {"quantity": "quantity"} + + def __init__(self, quantity=None): # noqa: E501 + """UpdateUsageRecord - a model defined in OpenAPI""" # noqa: E501 + + self._quantity = None + self.discriminator = None + + self.quantity = quantity + + @property + def quantity(self): + """Gets the quantity of this UpdateUsageRecord. # noqa: E501 + + The new quantity for the usage record. Must be a whole number that is greater than or equal to 0 # noqa: E501 + + :return: The quantity of this UpdateUsageRecord. # noqa: E501 + :rtype: int + """ + return self._quantity + + @quantity.setter + def quantity(self, quantity): + """Sets the quantity of this UpdateUsageRecord. + + The new quantity for the usage record. Must be a whole number that is greater than or equal to 0 # noqa: E501 + + :param quantity: The quantity of this UpdateUsageRecord. # noqa: E501 + :type: int + """ + if quantity is None: + raise ValueError( + "Invalid value for `quantity`, must not be `None`" + ) # noqa: E501 + + self._quantity = quantity diff --git a/xero_python/appstore/models/usage_record.py b/xero_python/appstore/models/usage_record.py new file mode 100644 index 00000000..ee3b4cf1 --- /dev/null +++ b/xero_python/appstore/models/usage_record.py @@ -0,0 +1,300 @@ +# coding: utf-8 + +""" +Xero AppStore API + +These endpoints are for Xero Partners to interact with the App Store Billing platform # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class UsageRecord(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "quantity": "int", + "subscription_id": "str", + "subscription_item_id": "str", + "test_mode": "bool", + "recorded_at": "datetime", + "usage_record_id": "str", + "price_per_unit": "float", + "product_id": "str", + } + + attribute_map = { + "quantity": "quantity", + "subscription_id": "subscriptionId", + "subscription_item_id": "subscriptionItemId", + "test_mode": "testMode", + "recorded_at": "recordedAt", + "usage_record_id": "usageRecordId", + "price_per_unit": "pricePerUnit", + "product_id": "productId", + } + + def __init__( + self, + quantity=None, + subscription_id=None, + subscription_item_id=None, + test_mode=None, + recorded_at=None, + usage_record_id=None, + price_per_unit=None, + product_id=None, + ): # noqa: E501 + """UsageRecord - a model defined in OpenAPI""" # noqa: E501 + + self._quantity = None + self._subscription_id = None + self._subscription_item_id = None + self._test_mode = None + self._recorded_at = None + self._usage_record_id = None + self._price_per_unit = None + self._product_id = None + self.discriminator = None + + self.quantity = quantity + self.subscription_id = subscription_id + self.subscription_item_id = subscription_item_id + self.test_mode = test_mode + self.recorded_at = recorded_at + self.usage_record_id = usage_record_id + self.price_per_unit = price_per_unit + self.product_id = product_id + + @property + def quantity(self): + """Gets the quantity of this UsageRecord. # noqa: E501 + + The quantity recorded # noqa: E501 + + :return: The quantity of this UsageRecord. # noqa: E501 + :rtype: int + """ + return self._quantity + + @quantity.setter + def quantity(self, quantity): + """Sets the quantity of this UsageRecord. + + The quantity recorded # noqa: E501 + + :param quantity: The quantity of this UsageRecord. # noqa: E501 + :type: int + """ + if quantity is None: + raise ValueError( + "Invalid value for `quantity`, must not be `None`" + ) # noqa: E501 + + self._quantity = quantity + + @property + def subscription_id(self): + """Gets the subscription_id of this UsageRecord. # noqa: E501 + + The unique identifier of the Subscription. # noqa: E501 + + :return: The subscription_id of this UsageRecord. # noqa: E501 + :rtype: str + """ + return self._subscription_id + + @subscription_id.setter + def subscription_id(self, subscription_id): + """Sets the subscription_id of this UsageRecord. + + The unique identifier of the Subscription. # noqa: E501 + + :param subscription_id: The subscription_id of this UsageRecord. # noqa: E501 + :type: str + """ + if subscription_id is None: + raise ValueError( + "Invalid value for `subscription_id`, must not be `None`" + ) # noqa: E501 + + self._subscription_id = subscription_id + + @property + def subscription_item_id(self): + """Gets the subscription_item_id of this UsageRecord. # noqa: E501 + + The unique identifier of the SubscriptionItem. # noqa: E501 + + :return: The subscription_item_id of this UsageRecord. # noqa: E501 + :rtype: str + """ + return self._subscription_item_id + + @subscription_item_id.setter + def subscription_item_id(self, subscription_item_id): + """Sets the subscription_item_id of this UsageRecord. + + The unique identifier of the SubscriptionItem. # noqa: E501 + + :param subscription_item_id: The subscription_item_id of this UsageRecord. # noqa: E501 + :type: str + """ + if subscription_item_id is None: + raise ValueError( + "Invalid value for `subscription_item_id`, must not be `None`" + ) # noqa: E501 + + self._subscription_item_id = subscription_item_id + + @property + def test_mode(self): + """Gets the test_mode of this UsageRecord. # noqa: E501 + + If the subscription is a test subscription # noqa: E501 + + :return: The test_mode of this UsageRecord. # noqa: E501 + :rtype: bool + """ + return self._test_mode + + @test_mode.setter + def test_mode(self, test_mode): + """Sets the test_mode of this UsageRecord. + + If the subscription is a test subscription # noqa: E501 + + :param test_mode: The test_mode of this UsageRecord. # noqa: E501 + :type: bool + """ + if test_mode is None: + raise ValueError( + "Invalid value for `test_mode`, must not be `None`" + ) # noqa: E501 + + self._test_mode = test_mode + + @property + def recorded_at(self): + """Gets the recorded_at of this UsageRecord. # noqa: E501 + + The time when this usage was recorded in UTC # noqa: E501 + + :return: The recorded_at of this UsageRecord. # noqa: E501 + :rtype: datetime + """ + return self._recorded_at + + @recorded_at.setter + def recorded_at(self, recorded_at): + """Sets the recorded_at of this UsageRecord. + + The time when this usage was recorded in UTC # noqa: E501 + + :param recorded_at: The recorded_at of this UsageRecord. # noqa: E501 + :type: datetime + """ + if recorded_at is None: + raise ValueError( + "Invalid value for `recorded_at`, must not be `None`" + ) # noqa: E501 + + self._recorded_at = recorded_at + + @property + def usage_record_id(self): + """Gets the usage_record_id of this UsageRecord. # noqa: E501 + + The unique identifier of the usageRecord. # noqa: E501 + + :return: The usage_record_id of this UsageRecord. # noqa: E501 + :rtype: str + """ + return self._usage_record_id + + @usage_record_id.setter + def usage_record_id(self, usage_record_id): + """Sets the usage_record_id of this UsageRecord. + + The unique identifier of the usageRecord. # noqa: E501 + + :param usage_record_id: The usage_record_id of this UsageRecord. # noqa: E501 + :type: str + """ + if usage_record_id is None: + raise ValueError( + "Invalid value for `usage_record_id`, must not be `None`" + ) # noqa: E501 + + self._usage_record_id = usage_record_id + + @property + def price_per_unit(self): + """Gets the price_per_unit of this UsageRecord. # noqa: E501 + + The price per unit # noqa: E501 + + :return: The price_per_unit of this UsageRecord. # noqa: E501 + :rtype: float + """ + return self._price_per_unit + + @price_per_unit.setter + def price_per_unit(self, price_per_unit): + """Sets the price_per_unit of this UsageRecord. + + The price per unit # noqa: E501 + + :param price_per_unit: The price_per_unit of this UsageRecord. # noqa: E501 + :type: float + """ + if price_per_unit is None: + raise ValueError( + "Invalid value for `price_per_unit`, must not be `None`" + ) # noqa: E501 + + self._price_per_unit = price_per_unit + + @property + def product_id(self): + """Gets the product_id of this UsageRecord. # noqa: E501 + + The unique identifier of the linked Product # noqa: E501 + + :return: The product_id of this UsageRecord. # noqa: E501 + :rtype: str + """ + return self._product_id + + @product_id.setter + def product_id(self, product_id): + """Sets the product_id of this UsageRecord. + + The unique identifier of the linked Product # noqa: E501 + + :param product_id: The product_id of this UsageRecord. # noqa: E501 + :type: str + """ + if product_id is None: + raise ValueError( + "Invalid value for `product_id`, must not be `None`" + ) # noqa: E501 + + self._product_id = product_id diff --git a/xero_python/appstore/models/usage_records_list.py b/xero_python/appstore/models/usage_records_list.py new file mode 100644 index 00000000..f4ab2822 --- /dev/null +++ b/xero_python/appstore/models/usage_records_list.py @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" +Xero AppStore API + +These endpoints are for Xero Partners to interact with the App Store Billing platform # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class UsageRecordsList(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = {"usage_records": "list[UsageRecord]"} + + attribute_map = {"usage_records": "usageRecords"} + + def __init__(self, usage_records=None): # noqa: E501 + """UsageRecordsList - a model defined in OpenAPI""" # noqa: E501 + + self._usage_records = None + self.discriminator = None + + self.usage_records = usage_records + + @property + def usage_records(self): + """Gets the usage_records of this UsageRecordsList. # noqa: E501 + + A collection of usage records # noqa: E501 + + :return: The usage_records of this UsageRecordsList. # noqa: E501 + :rtype: list[UsageRecord] + """ + return self._usage_records + + @usage_records.setter + def usage_records(self, usage_records): + """Sets the usage_records of this UsageRecordsList. + + A collection of usage records # noqa: E501 + + :param usage_records: The usage_records of this UsageRecordsList. # noqa: E501 + :type: list[UsageRecord] + """ + if usage_records is None: + raise ValueError( + "Invalid value for `usage_records`, must not be `None`" + ) # noqa: E501 + + self._usage_records = usage_records diff --git a/xero_python/assets/__init__.py b/xero_python/assets/__init__.py index b69a585a..6f88e763 100644 --- a/xero_python/assets/__init__.py +++ b/xero_python/assets/__init__.py @@ -3,12 +3,12 @@ # flake8: noqa """ - Xero Assets API +Xero Assets API - The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 +The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/assets/api/asset_api.py b/xero_python/assets/api/asset_api.py index d9259a86..d15296ad 100644 --- a/xero_python/assets/api/asset_api.py +++ b/xero_python/assets/api/asset_api.py @@ -1,5 +1,16 @@ # coding: utf-8 +import importlib +import re # noqa: F401 + +from xero_python import exceptions +from xero_python.api_client import ApiClient, ModelFinder + +try: + from .exception_handler import translate_status_exception +except ImportError: + translate_status_exception = exceptions.translate_status_exception + """ Xero Assets API @@ -10,20 +21,9 @@ """ """ - OpenAPI spec version: 2.19.3 + OpenAPI spec version: 16.2.0 """ -import importlib -import re # noqa: F401 - -from xero_python import exceptions -from xero_python.api_client import ApiClient, ModelFinder - -try: - from .exception_handler import translate_status_exception -except ImportError: - translate_status_exception = exceptions.translate_status_exception - class empty: """empty object to mark optional parameter not set""" @@ -60,6 +60,7 @@ def create_asset( self, xero_tenant_id, asset, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -69,6 +70,7 @@ def create_asset( Adds an asset to the system # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) :param Asset asset: Fixed asset you are creating (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -96,6 +98,9 @@ def create_asset( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -138,7 +143,8 @@ def create_asset( def create_asset_type( self, xero_tenant_id, - asset_type=empty, + asset_type, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -147,7 +153,8 @@ def create_asset_type( OAuth2 scope: assets Adds an fixed asset type to the system # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) - :param AssetType asset_type: Asset type to add + :param AssetType asset_type: Asset type to add (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -160,6 +167,12 @@ def create_asset_type( "Missing the required parameter `xero_tenant_id` " "when calling `create_asset_type`" ) + # verify the required parameter 'asset_type' is set + if asset_type is None: + raise ValueError( + "Missing the required parameter `asset_type` " + "when calling `create_asset_type`" + ) collection_formats = {} path_params = {} @@ -170,6 +183,9 @@ def create_asset_type( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] diff --git a/xero_python/assets/docs/AssetApi.md b/xero_python/assets/docs/AssetApi.md index 92ca1eb6..7ff31045 100644 --- a/xero_python/assets/docs/AssetApi.md +++ b/xero_python/assets/docs/AssetApi.md @@ -13,7 +13,7 @@ Method | HTTP request | Description # **create_asset** -> Asset create_asset(xero_tenant_id, asset) +> Asset create_asset(xero_tenant_id, asset, idempotency_key=idempotency_key) adds a fixed asset @@ -46,10 +46,11 @@ api_client = ApiClient( api_instance = AssetApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -asset = { "assetName":"Computer74863", "assetNumber":"123477544", "purchaseDate":"2020-01-01", "purchasePrice":100.0, "disposalPrice":23.23, "assetStatus":"Draft", "bookDepreciationSetting":{ "depreciationMethod":"StraightLine", "averagingMethod":"ActualDays", "depreciationRate":0.5, "depreciationCalculationMethod":"None" }, "bookDepreciationDetail":{ "currentCapitalGain":5.32, "currentGainLoss":3.88, "depreciationStartDate":"2020-01-02", "costLimit":100.0, "currentAccumDepreciationAmount":2.25 }, "AccountingBookValue":99.5 } # Asset | Fixed asset you are creating +asset = {"assetName":"Computer74863","assetNumber":"123477544","purchaseDate":"2020-01-01","purchasePrice":100.0,"disposalPrice":23.23,"assetStatus":"Draft","bookDepreciationSetting":{"depreciationMethod":"StraightLine","averagingMethod":"ActualDays","depreciationRate":0.5,"depreciationCalculationMethod":"None"},"bookDepreciationDetail":{"currentCapitalGain":5.32,"currentGainLoss":3.88,"depreciationStartDate":"2020-01-02","costLimit":100.0,"currentAccumDepreciationAmount":2.25},"AccountingBookValue":99.5} # Asset | Fixed asset you are creating +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # adds a fixed asset - api_response = api_instance.create_asset(xero_tenant_id, asset) + api_response = api_instance.create_asset(xero_tenant_id, asset, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AssetApi->create_asset: %s\n" % e) @@ -61,6 +62,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **asset** | [**Asset**](Asset.md)| Fixed asset you are creating | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -78,7 +80,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_asset_type** -> AssetType create_asset_type(xero_tenant_id, asset_type=asset_type) +> AssetType create_asset_type(xero_tenant_id, asset_type, idempotency_key=idempotency_key) adds a fixed asset type @@ -111,10 +113,11 @@ api_client = ApiClient( api_instance = AssetApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -asset_type = { "assetTypeName":"Machinery11004", "fixedAssetAccountId":"3d8d063a-c148-4bb8-8b3c-a5e2ad3b1e82", "depreciationExpenseAccountId":"d1602f69-f900-4616-8d34-90af393fa368", "accumulatedDepreciationAccountId":"9195cadd-8645-41e6-9f67-7bcd421defe8", "bookDepreciationSetting":{ "depreciationMethod":"DiminishingValue100", "averagingMethod":"ActualDays", "depreciationRate":0.05, "depreciationCalculationMethod":"None" } } # AssetType | Asset type to add (optional) +asset_type = {"assetTypeName":"Machinery11004","fixedAssetAccountId":"3d8d063a-c148-4bb8-8b3c-a5e2ad3b1e82","depreciationExpenseAccountId":"d1602f69-f900-4616-8d34-90af393fa368","accumulatedDepreciationAccountId":"9195cadd-8645-41e6-9f67-7bcd421defe8","bookDepreciationSetting":{"depreciationMethod":"DiminishingValue100","averagingMethod":"ActualDays","depreciationRate":0.05,"depreciationCalculationMethod":"None"}} # AssetType | Asset type to add +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # adds a fixed asset type - api_response = api_instance.create_asset_type(xero_tenant_id, asset_type=asset_type) + api_response = api_instance.create_asset_type(xero_tenant_id, asset_type, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AssetApi->create_asset_type: %s\n" % e) @@ -125,7 +128,8 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | - **asset_type** | [**AssetType**](AssetType.md)| Asset type to add | [optional] + **asset_type** | [**AssetType**](AssetType.md)| Asset type to add | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type diff --git a/xero_python/assets/docs/BookDepreciationDetail.md b/xero_python/assets/docs/BookDepreciationDetail.md index 73e3a6f0..4a58d8db 100644 --- a/xero_python/assets/docs/BookDepreciationDetail.md +++ b/xero_python/assets/docs/BookDepreciationDetail.md @@ -10,6 +10,11 @@ Name | Type | Description | Notes **residual_value** | **float** | The value of the asset remaining when you've fully depreciated it. | [optional] **prior_accum_depreciation_amount** | **float** | All depreciation prior to the current financial year. | [optional] **current_accum_depreciation_amount** | **float** | All depreciation occurring in the current financial year. | [optional] +**business_use_capital_gain** | **float** | (New Zealand Orgs Only) The portion of capital gain realised from the disposal of a fixed asset that is attributable to its business use. | [optional] +**business_use_current_gain_loss** | **float** | (New Zealand Orgs Only) Represents the gain or loss from the disposal of the business use portion of a fixed asset. This value records the financial result (profit or loss) related specifically to the asset’s business use. | [optional] +**private_use_capital_gain** | **float** | (New Zealand Orgs Only) The portion of capital gain realised from the disposal of a fixed asset that is attributable to its private (non-business) use. | [optional] +**private_use_current_gain_loss** | **float** | (New Zealand Orgs Only) Represents the gain or loss from the disposal of the private use portion of a fixed asset. This value records the financial result (profit or loss) related specifically to the asset’s private use. | [optional] +**initial_deduction_percentage** | **float** | (New Zealand Orgs Only) The Investment Boost deduction percentage. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/assets/models/__init__.py b/xero_python/assets/models/__init__.py index 5cbde7cb..f624bb02 100644 --- a/xero_python/assets/models/__init__.py +++ b/xero_python/assets/models/__init__.py @@ -2,12 +2,12 @@ # flake8: noqa """ - Xero Assets API +Xero Assets API - The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 +The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/assets/models/asset.py b/xero_python/assets/models/asset.py index 376ceca3..be9693e3 100644 --- a/xero_python/assets/models/asset.py +++ b/xero_python/assets/models/asset.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Assets API +Xero Assets API - The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 +The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/assets/models/asset_status.py b/xero_python/assets/models/asset_status.py index 598f0a0d..d6e70542 100644 --- a/xero_python/assets/models/asset_status.py +++ b/xero_python/assets/models/asset_status.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Assets API +Xero Assets API - The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 +The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/assets/models/asset_status_query_param.py b/xero_python/assets/models/asset_status_query_param.py index 6c0a08ff..8bb3225c 100644 --- a/xero_python/assets/models/asset_status_query_param.py +++ b/xero_python/assets/models/asset_status_query_param.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Assets API +Xero Assets API - The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 +The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/assets/models/asset_type.py b/xero_python/assets/models/asset_type.py index d994ca83..b7dedf38 100644 --- a/xero_python/assets/models/asset_type.py +++ b/xero_python/assets/models/asset_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Assets API +Xero Assets API - The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 +The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/assets/models/assets.py b/xero_python/assets/models/assets.py index 6ad9c906..109c60e7 100644 --- a/xero_python/assets/models/assets.py +++ b/xero_python/assets/models/assets.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Assets API +Xero Assets API - The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 +The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/assets/models/book_depreciation_detail.py b/xero_python/assets/models/book_depreciation_detail.py index 1347bf19..8d2a9415 100644 --- a/xero_python/assets/models/book_depreciation_detail.py +++ b/xero_python/assets/models/book_depreciation_detail.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Assets API +Xero Assets API - The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 +The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -37,6 +37,11 @@ class BookDepreciationDetail(BaseModel): "residual_value": "float", "prior_accum_depreciation_amount": "float", "current_accum_depreciation_amount": "float", + "business_use_capital_gain": "float", + "business_use_current_gain_loss": "float", + "private_use_capital_gain": "float", + "private_use_current_gain_loss": "float", + "initial_deduction_percentage": "float", } attribute_map = { @@ -47,6 +52,11 @@ class BookDepreciationDetail(BaseModel): "residual_value": "residualValue", "prior_accum_depreciation_amount": "priorAccumDepreciationAmount", "current_accum_depreciation_amount": "currentAccumDepreciationAmount", + "business_use_capital_gain": "businessUseCapitalGain", + "business_use_current_gain_loss": "businessUseCurrentGainLoss", + "private_use_capital_gain": "privateUseCapitalGain", + "private_use_current_gain_loss": "privateUseCurrentGainLoss", + "initial_deduction_percentage": "initialDeductionPercentage", } def __init__( @@ -58,6 +68,11 @@ def __init__( residual_value=None, prior_accum_depreciation_amount=None, current_accum_depreciation_amount=None, + business_use_capital_gain=None, + business_use_current_gain_loss=None, + private_use_capital_gain=None, + private_use_current_gain_loss=None, + initial_deduction_percentage=None, ): # noqa: E501 """BookDepreciationDetail - a model defined in OpenAPI""" # noqa: E501 @@ -68,6 +83,11 @@ def __init__( self._residual_value = None self._prior_accum_depreciation_amount = None self._current_accum_depreciation_amount = None + self._business_use_capital_gain = None + self._business_use_current_gain_loss = None + self._private_use_capital_gain = None + self._private_use_current_gain_loss = None + self._initial_deduction_percentage = None self.discriminator = None if current_capital_gain is not None: @@ -84,6 +104,16 @@ def __init__( self.prior_accum_depreciation_amount = prior_accum_depreciation_amount if current_accum_depreciation_amount is not None: self.current_accum_depreciation_amount = current_accum_depreciation_amount + if business_use_capital_gain is not None: + self.business_use_capital_gain = business_use_capital_gain + if business_use_current_gain_loss is not None: + self.business_use_current_gain_loss = business_use_current_gain_loss + if private_use_capital_gain is not None: + self.private_use_capital_gain = private_use_capital_gain + if private_use_current_gain_loss is not None: + self.private_use_current_gain_loss = private_use_current_gain_loss + if initial_deduction_percentage is not None: + self.initial_deduction_percentage = initial_deduction_percentage @property def current_capital_gain(self): @@ -245,3 +275,118 @@ def current_accum_depreciation_amount(self, current_accum_depreciation_amount): """ self._current_accum_depreciation_amount = current_accum_depreciation_amount + + @property + def business_use_capital_gain(self): + """Gets the business_use_capital_gain of this BookDepreciationDetail. # noqa: E501 + + (New Zealand Orgs Only) The portion of capital gain realised from the disposal of a fixed asset that is attributable to its business use. # noqa: E501 + + :return: The business_use_capital_gain of this BookDepreciationDetail. # noqa: E501 + :rtype: float + """ + return self._business_use_capital_gain + + @business_use_capital_gain.setter + def business_use_capital_gain(self, business_use_capital_gain): + """Sets the business_use_capital_gain of this BookDepreciationDetail. + + (New Zealand Orgs Only) The portion of capital gain realised from the disposal of a fixed asset that is attributable to its business use. # noqa: E501 + + :param business_use_capital_gain: The business_use_capital_gain of this BookDepreciationDetail. # noqa: E501 + :type: float + """ + + self._business_use_capital_gain = business_use_capital_gain + + @property + def business_use_current_gain_loss(self): + """Gets the business_use_current_gain_loss of this BookDepreciationDetail. # noqa: E501 + + (New Zealand Orgs Only) Represents the gain or loss from the disposal of the business use portion of a fixed asset. This value records the financial result (profit or loss) related specifically to the asset’s business use. # noqa: E501 + + :return: The business_use_current_gain_loss of this BookDepreciationDetail. # noqa: E501 + :rtype: float + """ + return self._business_use_current_gain_loss + + @business_use_current_gain_loss.setter + def business_use_current_gain_loss(self, business_use_current_gain_loss): + """Sets the business_use_current_gain_loss of this BookDepreciationDetail. + + (New Zealand Orgs Only) Represents the gain or loss from the disposal of the business use portion of a fixed asset. This value records the financial result (profit or loss) related specifically to the asset’s business use. # noqa: E501 + + :param business_use_current_gain_loss: The business_use_current_gain_loss of this BookDepreciationDetail. # noqa: E501 + :type: float + """ + + self._business_use_current_gain_loss = business_use_current_gain_loss + + @property + def private_use_capital_gain(self): + """Gets the private_use_capital_gain of this BookDepreciationDetail. # noqa: E501 + + (New Zealand Orgs Only) The portion of capital gain realised from the disposal of a fixed asset that is attributable to its private (non-business) use. # noqa: E501 + + :return: The private_use_capital_gain of this BookDepreciationDetail. # noqa: E501 + :rtype: float + """ + return self._private_use_capital_gain + + @private_use_capital_gain.setter + def private_use_capital_gain(self, private_use_capital_gain): + """Sets the private_use_capital_gain of this BookDepreciationDetail. + + (New Zealand Orgs Only) The portion of capital gain realised from the disposal of a fixed asset that is attributable to its private (non-business) use. # noqa: E501 + + :param private_use_capital_gain: The private_use_capital_gain of this BookDepreciationDetail. # noqa: E501 + :type: float + """ + + self._private_use_capital_gain = private_use_capital_gain + + @property + def private_use_current_gain_loss(self): + """Gets the private_use_current_gain_loss of this BookDepreciationDetail. # noqa: E501 + + (New Zealand Orgs Only) Represents the gain or loss from the disposal of the private use portion of a fixed asset. This value records the financial result (profit or loss) related specifically to the asset’s private use. # noqa: E501 + + :return: The private_use_current_gain_loss of this BookDepreciationDetail. # noqa: E501 + :rtype: float + """ + return self._private_use_current_gain_loss + + @private_use_current_gain_loss.setter + def private_use_current_gain_loss(self, private_use_current_gain_loss): + """Sets the private_use_current_gain_loss of this BookDepreciationDetail. + + (New Zealand Orgs Only) Represents the gain or loss from the disposal of the private use portion of a fixed asset. This value records the financial result (profit or loss) related specifically to the asset’s private use. # noqa: E501 + + :param private_use_current_gain_loss: The private_use_current_gain_loss of this BookDepreciationDetail. # noqa: E501 + :type: float + """ + + self._private_use_current_gain_loss = private_use_current_gain_loss + + @property + def initial_deduction_percentage(self): + """Gets the initial_deduction_percentage of this BookDepreciationDetail. # noqa: E501 + + (New Zealand Orgs Only) The Investment Boost deduction percentage. # noqa: E501 + + :return: The initial_deduction_percentage of this BookDepreciationDetail. # noqa: E501 + :rtype: float + """ + return self._initial_deduction_percentage + + @initial_deduction_percentage.setter + def initial_deduction_percentage(self, initial_deduction_percentage): + """Sets the initial_deduction_percentage of this BookDepreciationDetail. + + (New Zealand Orgs Only) The Investment Boost deduction percentage. # noqa: E501 + + :param initial_deduction_percentage: The initial_deduction_percentage of this BookDepreciationDetail. # noqa: E501 + :type: float + """ + + self._initial_deduction_percentage = initial_deduction_percentage diff --git a/xero_python/assets/models/book_depreciation_setting.py b/xero_python/assets/models/book_depreciation_setting.py index ca17f803..eaddfba2 100644 --- a/xero_python/assets/models/book_depreciation_setting.py +++ b/xero_python/assets/models/book_depreciation_setting.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Assets API +Xero Assets API - The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 +The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/assets/models/error.py b/xero_python/assets/models/error.py index 91268b74..98db10ee 100644 --- a/xero_python/assets/models/error.py +++ b/xero_python/assets/models/error.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Assets API +Xero Assets API - The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 +The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/assets/models/field_validation_errors_element.py b/xero_python/assets/models/field_validation_errors_element.py index a414c562..808f366a 100644 --- a/xero_python/assets/models/field_validation_errors_element.py +++ b/xero_python/assets/models/field_validation_errors_element.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Assets API +Xero Assets API - The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 +The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/assets/models/pagination.py b/xero_python/assets/models/pagination.py index 9ef45805..81a9d844 100644 --- a/xero_python/assets/models/pagination.py +++ b/xero_python/assets/models/pagination.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Assets API +Xero Assets API - The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 +The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/assets/models/resource_validation_errors_element.py b/xero_python/assets/models/resource_validation_errors_element.py index 8b902409..4277672f 100644 --- a/xero_python/assets/models/resource_validation_errors_element.py +++ b/xero_python/assets/models/resource_validation_errors_element.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Assets API +Xero Assets API - The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 +The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/assets/models/setting.py b/xero_python/assets/models/setting.py index e8be8340..dc7e2bba 100644 --- a/xero_python/assets/models/setting.py +++ b/xero_python/assets/models/setting.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Assets API +Xero Assets API - The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 +The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/docs/README.md b/xero_python/docs/README.md index c88282bc..550a5b28 100644 --- a/xero_python/docs/README.md +++ b/xero_python/docs/README.md @@ -3,8 +3,8 @@ These endpoints are related to managing authentication tokens and identity for X The `xero_python` package is automatically generated by the [XeroAPI SDK 2.0 Codegen](https://github.com/xero-github/xeroapi-sdk-codegen) project: -- API version: 2.19.3 -- Package version: 1.13.1 +- API version: 16.2.0 +- Package version: 15.1.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit [https://developer.xero.com](https://developer.xero.com) diff --git a/xero_python/file/__init__.py b/xero_python/file/__init__.py index 813df195..a7239c99 100644 --- a/xero_python/file/__init__.py +++ b/xero_python/file/__init__.py @@ -3,12 +3,12 @@ # flake8: noqa """ - Xero Files API +Xero Files API - These endpoints are specific to Xero Files API # noqa: E501 +These endpoints are specific to Xero Files API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/file/api/files_api.py b/xero_python/file/api/files_api.py index 80daf8be..1f799f6c 100644 --- a/xero_python/file/api/files_api.py +++ b/xero_python/file/api/files_api.py @@ -1,5 +1,16 @@ # coding: utf-8 +import importlib +import re # noqa: F401 + +from xero_python import exceptions +from xero_python.api_client import ApiClient, ModelFinder + +try: + from .exception_handler import translate_status_exception +except ImportError: + translate_status_exception = exceptions.translate_status_exception + """ Xero Files API @@ -10,20 +21,9 @@ """ """ - OpenAPI spec version: 2.19.3 + OpenAPI spec version: 16.2.0 """ -import importlib -import re # noqa: F401 - -from xero_python import exceptions -from xero_python.api_client import ApiClient, ModelFinder - -try: - from .exception_handler import translate_status_exception -except ImportError: - translate_status_exception = exceptions.translate_status_exception - class empty: """empty object to mark optional parameter not set""" @@ -60,7 +60,8 @@ def create_file_association( self, xero_tenant_id, file_id, - association=empty, + association, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -70,7 +71,8 @@ def create_file_association( By passing in the appropriate options, you can create a new folder # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) :param str file_id: File id for single object (required) - :param Association association: + :param Association association: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -89,6 +91,12 @@ def create_file_association( "Missing the required parameter `file_id` " "when calling `create_file_association`" ) + # verify the required parameter 'association' is set + if association is None: + raise ValueError( + "Missing the required parameter `association` " + "when calling `create_file_association`" + ) collection_formats = {} path_params = { @@ -101,6 +109,9 @@ def create_file_association( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -143,7 +154,8 @@ def create_file_association( def create_folder( self, xero_tenant_id, - folder=empty, + folder, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -152,7 +164,8 @@ def create_folder( OAuth2 scope: files By passing in the appropriate properties, you can create a new folder # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) - :param Folder folder: + :param Folder folder: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -165,6 +178,12 @@ def create_folder( "Missing the required parameter `xero_tenant_id` " "when calling `create_folder`" ) + # verify the required parameter 'folder' is set + if folder is None: + raise ValueError( + "Missing the required parameter `folder` " + "when calling `create_folder`" + ) collection_formats = {} path_params = {} @@ -175,6 +194,9 @@ def create_folder( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -442,15 +464,23 @@ def get_associations_by_object( self, xero_tenant_id, object_id, + pagesize=empty, + page=empty, + sort=empty, + direction=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, ): """Retrieves an association object using a unique object ID # noqa: E501 OAuth2 scope: files, files.read - By passing in the appropriate options, # noqa: E501 + By passing in the appropriate options, you can retrieve an association # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) :param str object_id: Object id for single object (required) + :param int pagesize: pass an optional page size value + :param int page: number of records to skip for pagination + :param str sort: values to sort by + :param str direction: direction to sort by :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -470,6 +500,20 @@ def get_associations_by_object( "when calling `get_associations_by_object`" ) + if pagesize is not empty and pagesize > 100: + raise ValueError( + "Invalid value for parameter `pagesize` " + "when calling `get_associations_by_object`, must be a value " + "less than or equal to " + "`100`" + ) + if page is not empty and page < 1: + raise ValueError( + "Invalid value for parameter `page` " + "when calling `get_associations_by_object`, must be a value " + "greater than or equal to " + "`1`" + ) collection_formats = {} path_params = { "ObjectId": object_id, @@ -477,6 +521,18 @@ def get_associations_by_object( query_params = [] + if pagesize is not empty: + query_params.append(("pagesize", pagesize)) + + if page is not empty: + query_params.append(("page", page)) + + if sort is not empty: + query_params.append(("sort", sort)) + + if direction is not empty: + query_params.append(("direction", direction)) + header_params = { "xero-tenant-id": xero_tenant_id, } @@ -515,6 +571,85 @@ def get_associations_by_object( except exceptions.HTTPStatusException as error: raise translate_status_exception(error, self, "get_associations_by_object") + def get_associations_count( + self, + xero_tenant_id, + object_ids, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Retrieves a count of associations for a list of objects. # noqa: E501 + OAuth2 scope: files, files.read + By passing in the appropriate options, you can retrieve the association count for objects # noqa: E501 + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param list[str] object_ids: A comma-separated list of object ids (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: object + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_associations_count`" + ) + # verify the required parameter 'object_ids' is set + if object_ids is None: + raise ValueError( + "Missing the required parameter `object_ids` " + "when calling `get_associations_count`" + ) + + collection_formats = { + "ObjectIds": "multi", + } + path_params = {} + + query_params = [ + ("ObjectIds", object_ids), + ] + + header_params = { + "xero-tenant-id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Associations/Count") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="object", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_associations_count") + def get_file( self, xero_tenant_id, @@ -750,6 +885,7 @@ def get_files( pagesize=empty, page=empty, sort=empty, + direction=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -760,6 +896,7 @@ def get_files( :param int pagesize: pass an optional page size value :param int page: number of records to skip for pagination :param str sort: values to sort by + :param str direction: sort direction :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -801,6 +938,9 @@ def get_files( if sort is not empty: query_params.append(("sort", sort)) + if direction is not empty: + query_params.append(("direction", direction)) + header_params = { "xero-tenant-id": xero_tenant_id, } @@ -1059,7 +1199,8 @@ def update_file( self, xero_tenant_id, file_id, - file_object=empty, + file_object, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1069,7 +1210,8 @@ def update_file( Updates file properties of a single file # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) :param str file_id: File id for single object (required) - :param FileObject file_object: + :param FileObject file_object: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1087,6 +1229,12 @@ def update_file( raise ValueError( "Missing the required parameter `file_id` " "when calling `update_file`" ) + # verify the required parameter 'file_object' is set + if file_object is None: + raise ValueError( + "Missing the required parameter `file_object` " + "when calling `update_file`" + ) collection_formats = {} path_params = { @@ -1099,6 +1247,9 @@ def update_file( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1143,6 +1294,7 @@ def update_folder( xero_tenant_id, folder_id, folder, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1153,6 +1305,7 @@ def update_folder( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str folder_id: Folder id for single object (required) :param Folder folder: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1189,6 +1342,9 @@ def update_folder( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1234,6 +1390,7 @@ def upload_file( body, name, filename, + idempotency_key=empty, mime_type=empty, _return_http_data_only=True, _preload_content=True, @@ -1245,6 +1402,7 @@ def upload_file( :param str body: (required) :param str name: exact name of the file you are uploading (required) :param str filename: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param str mime_type: :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models @@ -1284,6 +1442,9 @@ def upload_file( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [ ("body", body), @@ -1336,6 +1497,7 @@ def upload_file_to_folder( body, name, filename, + idempotency_key=empty, mime_type=empty, _return_http_data_only=True, _preload_content=True, @@ -1348,6 +1510,7 @@ def upload_file_to_folder( :param str body: (required) :param str name: exact name of the file you are uploading (required) :param str filename: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param str mime_type: :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models @@ -1397,6 +1560,9 @@ def upload_file_to_folder( "xero-tenant-id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [ ("body", body), diff --git a/xero_python/file/docs/Association.md b/xero_python/file/docs/Association.md index 029356d2..d9c4b4d7 100644 --- a/xero_python/file/docs/Association.md +++ b/xero_python/file/docs/Association.md @@ -3,6 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**send_with_object** | **bool** | Boolean flag to determines whether the file is sent with the document it is attached to on client facing communications. Note- The SendWithObject element is only returned when using /Associations/{ObjectId} endpoint. | [optional] +**name** | **str** | The name of the associated file. Note- The Name element is only returned when using /Associations/{ObjectId} endpoint. | [optional] +**size** | **int** | The size of the associated file in bytes. Note- The Size element is only returned when using /Associations/{ObjectId} endpoint. | [optional] +**created_date_utc** | **datetime** | The date the file was created (UTC). Note- The CreatedDateUtc element is only returned when using /Associations/{ObjectId} endpoint. | [optional] +**association_date_utc** | **datetime** | The date the file was associated with the object (UTC). Note- The AssociationDateUtc element is only returned when using /Associations/{ObjectId} endpoint. | [optional] **file_id** | **str** | The unique identifier of the file | [optional] **object_id** | **str** | The identifier of the object that the file is being associated with (e.g. InvoiceID, BankTransactionID, ContactID) | [optional] **object_group** | [**ObjectGroup**](ObjectGroup.md) | | [optional] diff --git a/xero_python/file/docs/FilesApi.md b/xero_python/file/docs/FilesApi.md index 78d956b0..5c6583fe 100644 --- a/xero_python/file/docs/FilesApi.md +++ b/xero_python/file/docs/FilesApi.md @@ -10,6 +10,7 @@ Method | HTTP request | Description [**delete_file_association**](FilesApi.md#delete_file_association) | **DELETE** /Files/{FileId}/Associations/{ObjectId} | Deletes an existing file association [**delete_folder**](FilesApi.md#delete_folder) | **DELETE** /Folders/{FolderId} | Deletes a folder [**get_associations_by_object**](FilesApi.md#get_associations_by_object) | **GET** /Associations/{ObjectId} | Retrieves an association object using a unique object ID +[**get_associations_count**](FilesApi.md#get_associations_count) | **GET** /Associations/Count | Retrieves a count of associations for a list of objects. [**get_file**](FilesApi.md#get_file) | **GET** /Files/{FileId} | Retrieves a file by a unique file ID [**get_file_associations**](FilesApi.md#get_file_associations) | **GET** /Files/{FileId}/Associations | Retrieves a specific file associations [**get_file_content**](FilesApi.md#get_file_content) | **GET** /Files/{FileId}/Content | Retrieves the content of a specific file @@ -24,7 +25,7 @@ Method | HTTP request | Description # **create_file_association** -> Association create_file_association(xero_tenant_id, file_id, association=association) +> Association create_file_association(xero_tenant_id, file_id, association, idempotency_key=idempotency_key) Creates a new file association @@ -58,10 +59,11 @@ api_instance = FilesApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | File id for single object -association = { "ObjectId": "1270bf7c-5d18-473a-9231-1e36c4bd33ed", "ObjectGroup": "Contact", "ObjectType": "Business" } # Association | (optional) +association = { "ObjectId": "1270bf7c-5d18-473a-9231-1e36c4bd33ed", "ObjectGroup": "Contact", "ObjectType": "Business" } # Association | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a new file association - api_response = api_instance.create_file_association(xero_tenant_id, file_id, association=association) + api_response = api_instance.create_file_association(xero_tenant_id, file_id, association, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling FilesApi->create_file_association: %s\n" % e) @@ -73,7 +75,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **file_id** | [**str**](.md)| File id for single object | - **association** | [**Association**](Association.md)| | [optional] + **association** | [**Association**](Association.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -91,7 +94,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_folder** -> Folder create_folder(xero_tenant_id, folder=folder) +> Folder create_folder(xero_tenant_id, folder, idempotency_key=idempotency_key) Creates a new folder @@ -124,10 +127,11 @@ api_client = ApiClient( api_instance = FilesApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -folder = { "Name": "My Docs" } # Folder | (optional) +folder = { "Name": "My Docs" } # Folder | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a new folder - api_response = api_instance.create_folder(xero_tenant_id, folder=folder) + api_response = api_instance.create_folder(xero_tenant_id, folder, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling FilesApi->create_folder: %s\n" % e) @@ -138,7 +142,8 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | - **folder** | [**Folder**](Folder.md)| | [optional] + **folder** | [**Folder**](Folder.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -350,11 +355,11 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_associations_by_object** -> list[Association] get_associations_by_object(xero_tenant_id, object_id) +> list[Association] get_associations_by_object(xero_tenant_id, object_id, pagesize=pagesize, page=page, sort=sort, direction=direction) Retrieves an association object using a unique object ID -By passing in the appropriate options, +By passing in the appropriate options, you can retrieve an association ### Example @@ -384,9 +389,13 @@ api_instance = FilesApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant object_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Object id for single object +pagesize = 50 # int | pass an optional page size value (optional) +page = 2 # int | number of records to skip for pagination (optional) +sort = 'CreatedDateUtc' # str | values to sort by (optional) (default to 'CreatedDateUtc') +direction = 'Associations/{ObjectId}?sort=CreatedDateUtc&direction=DESC' # str | direction to sort by (optional) try: # Retrieves an association object using a unique object ID - api_response = api_instance.get_associations_by_object(xero_tenant_id, object_id) + api_response = api_instance.get_associations_by_object(xero_tenant_id, object_id, pagesize=pagesize, page=page, sort=sort, direction=direction) pprint(api_response) except ApiException as e: print("Exception when calling FilesApi->get_associations_by_object: %s\n" % e) @@ -398,6 +407,10 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **object_id** | [**str**](.md)| Object id for single object | + **pagesize** | **int**| pass an optional page size value | [optional] + **page** | **int**| number of records to skip for pagination | [optional] + **sort** | **str**| values to sort by | [optional] [default to 'CreatedDateUtc'] + **direction** | **str**| direction to sort by | [optional] ### Return type @@ -414,6 +427,71 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_associations_count** +> object get_associations_count(xero_tenant_id, object_ids) + +Retrieves a count of associations for a list of objects. + +By passing in the appropriate options, you can retrieve the association count for objects + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.file import FilesApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = FilesApi(api_client) + +xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant +object_ids = ['object_ids_example'] # list[str] | A comma-separated list of object ids +try: + # Retrieves a count of associations for a list of objects. + api_response = api_instance.get_associations_count(xero_tenant_id, object_ids) + pprint(api_response) +except ApiException as e: + print("Exception when calling FilesApi->get_associations_count: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **object_ids** | [**list[str]**](str.md)| A comma-separated list of object ids | + +### Return type + +**object** + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **get_file** > FileObject get_file(xero_tenant_id, file_id) @@ -608,7 +686,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_files** -> Files get_files(xero_tenant_id, pagesize=pagesize, page=page, sort=sort) +> Files get_files(xero_tenant_id, pagesize=pagesize, page=page, sort=sort, direction=direction) Retrieves files @@ -641,10 +719,11 @@ api_instance = FilesApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant pagesize = 50 # int | pass an optional page size value (optional) page = 2 # int | number of records to skip for pagination (optional) -sort = 'CreatedDateUTC DESC' # str | values to sort by (optional) +sort = 'CreatedDateUTC' # str | values to sort by (optional) +direction = 'ASC' # str | sort direction (optional) try: # Retrieves files - api_response = api_instance.get_files(xero_tenant_id, pagesize=pagesize, page=page, sort=sort) + api_response = api_instance.get_files(xero_tenant_id, pagesize=pagesize, page=page, sort=sort, direction=direction) pprint(api_response) except ApiException as e: print("Exception when calling FilesApi->get_files: %s\n" % e) @@ -658,6 +737,7 @@ Name | Type | Description | Notes **pagesize** | **int**| pass an optional page size value | [optional] **page** | **int**| number of records to skip for pagination | [optional] **sort** | **str**| values to sort by | [optional] + **direction** | **str**| sort direction | [optional] ### Return type @@ -868,7 +948,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_file** -> FileObject update_file(xero_tenant_id, file_id, file_object=file_object) +> FileObject update_file(xero_tenant_id, file_id, file_object, idempotency_key=idempotency_key) Update a file @@ -902,10 +982,11 @@ api_instance = FilesApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | File id for single object -file_object = { "FolderId": "bf924975-7097-46f2-a143-1ecfbab3c8c3" } # FileObject | (optional) +file_object = { "FolderId": "bf924975-7097-46f2-a143-1ecfbab3c8c3" } # FileObject | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Update a file - api_response = api_instance.update_file(xero_tenant_id, file_id, file_object=file_object) + api_response = api_instance.update_file(xero_tenant_id, file_id, file_object, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling FilesApi->update_file: %s\n" % e) @@ -917,7 +998,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **file_id** | [**str**](.md)| File id for single object | - **file_object** | [**FileObject**](FileObject.md)| | [optional] + **file_object** | [**FileObject**](FileObject.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -935,7 +1017,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_folder** -> Folder update_folder(xero_tenant_id, folder_id, folder) +> Folder update_folder(xero_tenant_id, folder_id, folder, idempotency_key=idempotency_key) Updates an existing folder @@ -970,9 +1052,10 @@ api_instance = FilesApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant folder_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Folder id for single object folder = { "Name": "Your Docs" } # Folder | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates an existing folder - api_response = api_instance.update_folder(xero_tenant_id, folder_id, folder) + api_response = api_instance.update_folder(xero_tenant_id, folder_id, folder, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling FilesApi->update_folder: %s\n" % e) @@ -985,6 +1068,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **folder_id** | [**str**](.md)| Folder id for single object | **folder** | [**Folder**](Folder.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1002,7 +1086,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **upload_file** -> FileObject upload_file(xero_tenant_id, body, name, filename, mime_type=mime_type) +> FileObject upload_file(xero_tenant_id, body, name, filename, idempotency_key=idempotency_key, mime_type=mime_type) Uploads a File to the inbox @@ -1036,10 +1120,11 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant body = 'body_example' # str | name = 'name_example' # str | exact name of the file you are uploading filename = 'filename_example' # str | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) mime_type = 'mime_type_example' # str | (optional) try: # Uploads a File to the inbox - api_response = api_instance.upload_file(xero_tenant_id, body, name, filename, mime_type=mime_type) + api_response = api_instance.upload_file(xero_tenant_id, body, name, filename, idempotency_key=idempotency_key, mime_type=mime_type) pprint(api_response) except ApiException as e: print("Exception when calling FilesApi->upload_file: %s\n" % e) @@ -1053,6 +1138,7 @@ Name | Type | Description | Notes **body** | **str**| | **name** | **str**| exact name of the file you are uploading | **filename** | **str**| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **mime_type** | **str**| | [optional] ### Return type @@ -1071,7 +1157,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **upload_file_to_folder** -> FileObject upload_file_to_folder(xero_tenant_id, folder_id, body, name, filename, mime_type=mime_type) +> FileObject upload_file_to_folder(xero_tenant_id, folder_id, body, name, filename, idempotency_key=idempotency_key, mime_type=mime_type) Uploads a File to a specific folder @@ -1106,10 +1192,11 @@ folder_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | pass required folder body = 'body_example' # str | name = 'name_example' # str | exact name of the file you are uploading filename = 'filename_example' # str | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) mime_type = 'mime_type_example' # str | (optional) try: # Uploads a File to a specific folder - api_response = api_instance.upload_file_to_folder(xero_tenant_id, folder_id, body, name, filename, mime_type=mime_type) + api_response = api_instance.upload_file_to_folder(xero_tenant_id, folder_id, body, name, filename, idempotency_key=idempotency_key, mime_type=mime_type) pprint(api_response) except ApiException as e: print("Exception when calling FilesApi->upload_file_to_folder: %s\n" % e) @@ -1124,6 +1211,7 @@ Name | Type | Description | Notes **body** | **str**| | **name** | **str**| exact name of the file you are uploading | **filename** | **str**| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **mime_type** | **str**| | [optional] ### Return type diff --git a/xero_python/file/models/__init__.py b/xero_python/file/models/__init__.py index 1e354185..404a43cc 100644 --- a/xero_python/file/models/__init__.py +++ b/xero_python/file/models/__init__.py @@ -2,12 +2,12 @@ # flake8: noqa """ - Xero Files API +Xero Files API - These endpoints are specific to Xero Files API # noqa: E501 +These endpoints are specific to Xero Files API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/file/models/association.py b/xero_python/file/models/association.py index 2b568922..5c5bf0ae 100644 --- a/xero_python/file/models/association.py +++ b/xero_python/file/models/association.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Files API +Xero Files API - These endpoints are specific to Xero Files API # noqa: E501 +These endpoints are specific to Xero Files API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -30,6 +30,11 @@ class Association(BaseModel): and the value is json key in definition. """ openapi_types = { + "send_with_object": "bool", + "name": "str", + "size": "int", + "created_date_utc": "datetime", + "association_date_utc": "datetime", "file_id": "str", "object_id": "str", "object_group": "ObjectGroup", @@ -37,6 +42,11 @@ class Association(BaseModel): } attribute_map = { + "send_with_object": "SendWithObject", + "name": "Name", + "size": "Size", + "created_date_utc": "CreatedDateUtc", + "association_date_utc": "AssociationDateUtc", "file_id": "FileId", "object_id": "ObjectId", "object_group": "ObjectGroup", @@ -44,16 +54,40 @@ class Association(BaseModel): } def __init__( - self, file_id=None, object_id=None, object_group=None, object_type=None + self, + send_with_object=None, + name=None, + size=None, + created_date_utc=None, + association_date_utc=None, + file_id=None, + object_id=None, + object_group=None, + object_type=None, ): # noqa: E501 """Association - a model defined in OpenAPI""" # noqa: E501 + self._send_with_object = None + self._name = None + self._size = None + self._created_date_utc = None + self._association_date_utc = None self._file_id = None self._object_id = None self._object_group = None self._object_type = None self.discriminator = None + if send_with_object is not None: + self.send_with_object = send_with_object + if name is not None: + self.name = name + if size is not None: + self.size = size + if created_date_utc is not None: + self.created_date_utc = created_date_utc + if association_date_utc is not None: + self.association_date_utc = association_date_utc if file_id is not None: self.file_id = file_id if object_id is not None: @@ -63,6 +97,121 @@ def __init__( if object_type is not None: self.object_type = object_type + @property + def send_with_object(self): + """Gets the send_with_object of this Association. # noqa: E501 + + Boolean flag to determines whether the file is sent with the document it is attached to on client facing communications. Note- The SendWithObject element is only returned when using /Associations/{ObjectId} endpoint. # noqa: E501 + + :return: The send_with_object of this Association. # noqa: E501 + :rtype: bool + """ + return self._send_with_object + + @send_with_object.setter + def send_with_object(self, send_with_object): + """Sets the send_with_object of this Association. + + Boolean flag to determines whether the file is sent with the document it is attached to on client facing communications. Note- The SendWithObject element is only returned when using /Associations/{ObjectId} endpoint. # noqa: E501 + + :param send_with_object: The send_with_object of this Association. # noqa: E501 + :type: bool + """ + + self._send_with_object = send_with_object + + @property + def name(self): + """Gets the name of this Association. # noqa: E501 + + The name of the associated file. Note- The Name element is only returned when using /Associations/{ObjectId} endpoint. # noqa: E501 + + :return: The name of this Association. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this Association. + + The name of the associated file. Note- The Name element is only returned when using /Associations/{ObjectId} endpoint. # noqa: E501 + + :param name: The name of this Association. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def size(self): + """Gets the size of this Association. # noqa: E501 + + The size of the associated file in bytes. Note- The Size element is only returned when using /Associations/{ObjectId} endpoint. # noqa: E501 + + :return: The size of this Association. # noqa: E501 + :rtype: int + """ + return self._size + + @size.setter + def size(self, size): + """Sets the size of this Association. + + The size of the associated file in bytes. Note- The Size element is only returned when using /Associations/{ObjectId} endpoint. # noqa: E501 + + :param size: The size of this Association. # noqa: E501 + :type: int + """ + + self._size = size + + @property + def created_date_utc(self): + """Gets the created_date_utc of this Association. # noqa: E501 + + The date the file was created (UTC). Note- The CreatedDateUtc element is only returned when using /Associations/{ObjectId} endpoint. # noqa: E501 + + :return: The created_date_utc of this Association. # noqa: E501 + :rtype: datetime + """ + return self._created_date_utc + + @created_date_utc.setter + def created_date_utc(self, created_date_utc): + """Sets the created_date_utc of this Association. + + The date the file was created (UTC). Note- The CreatedDateUtc element is only returned when using /Associations/{ObjectId} endpoint. # noqa: E501 + + :param created_date_utc: The created_date_utc of this Association. # noqa: E501 + :type: datetime + """ + + self._created_date_utc = created_date_utc + + @property + def association_date_utc(self): + """Gets the association_date_utc of this Association. # noqa: E501 + + The date the file was associated with the object (UTC). Note- The AssociationDateUtc element is only returned when using /Associations/{ObjectId} endpoint. # noqa: E501 + + :return: The association_date_utc of this Association. # noqa: E501 + :rtype: datetime + """ + return self._association_date_utc + + @association_date_utc.setter + def association_date_utc(self, association_date_utc): + """Sets the association_date_utc of this Association. + + The date the file was associated with the object (UTC). Note- The AssociationDateUtc element is only returned when using /Associations/{ObjectId} endpoint. # noqa: E501 + + :param association_date_utc: The association_date_utc of this Association. # noqa: E501 + :type: datetime + """ + + self._association_date_utc = association_date_utc + @property def file_id(self): """Gets the file_id of this Association. # noqa: E501 diff --git a/xero_python/file/models/file_object.py b/xero_python/file/models/file_object.py index ca9ad17f..27048b38 100644 --- a/xero_python/file/models/file_object.py +++ b/xero_python/file/models/file_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Files API +Xero Files API - These endpoints are specific to Xero Files API # noqa: E501 +These endpoints are specific to Xero Files API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/file/models/files.py b/xero_python/file/models/files.py index 340d4b1c..85ac322f 100644 --- a/xero_python/file/models/files.py +++ b/xero_python/file/models/files.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Files API +Xero Files API - These endpoints are specific to Xero Files API # noqa: E501 +These endpoints are specific to Xero Files API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/file/models/folder.py b/xero_python/file/models/folder.py index 41305080..e166cdcd 100644 --- a/xero_python/file/models/folder.py +++ b/xero_python/file/models/folder.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Files API +Xero Files API - These endpoints are specific to Xero Files API # noqa: E501 +These endpoints are specific to Xero Files API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/file/models/folders.py b/xero_python/file/models/folders.py index 3b3b1906..dedd250e 100644 --- a/xero_python/file/models/folders.py +++ b/xero_python/file/models/folders.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Files API +Xero Files API - These endpoints are specific to Xero Files API # noqa: E501 +These endpoints are specific to Xero Files API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/file/models/inline_object.py b/xero_python/file/models/inline_object.py deleted file mode 100644 index f6c88743..00000000 --- a/xero_python/file/models/inline_object.py +++ /dev/null @@ -1,150 +0,0 @@ -# coding: utf-8 - -""" - Xero Files API - - These endpoints are specific to Xero Files API # noqa: E501 - - Contact: api@xero.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 - -from xero_python.models import BaseModel - - -class InlineObject(BaseModel): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - """ - Attributes: - openapi_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - openapi_types = { - "body": "str", - "name": "str", - "filename": "str", - "mime_type": "str", - } - - attribute_map = { - "body": "body", - "name": "name", - "filename": "filename", - "mime_type": "mimeType", - } - - def __init__( - self, body=None, name=None, filename=None, mime_type=None - ): # noqa: E501 - """InlineObject - a model defined in OpenAPI""" # noqa: E501 - - self._body = None - self._name = None - self._filename = None - self._mime_type = None - self.discriminator = None - - if body is not None: - self.body = body - if name is not None: - self.name = name - if filename is not None: - self.filename = filename - if mime_type is not None: - self.mime_type = mime_type - - @property - def body(self): - """Gets the body of this InlineObject. # noqa: E501 - - - :return: The body of this InlineObject. # noqa: E501 - :rtype: str - """ - return self._body - - @body.setter - def body(self, body): - """Sets the body of this InlineObject. - - - :param body: The body of this InlineObject. # noqa: E501 - :type: str - """ - - self._body = body - - @property - def name(self): - """Gets the name of this InlineObject. # noqa: E501 - - exact name of the file you are uploading # noqa: E501 - - :return: The name of this InlineObject. # noqa: E501 - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """Sets the name of this InlineObject. - - exact name of the file you are uploading # noqa: E501 - - :param name: The name of this InlineObject. # noqa: E501 - :type: str - """ - - self._name = name - - @property - def filename(self): - """Gets the filename of this InlineObject. # noqa: E501 - - - :return: The filename of this InlineObject. # noqa: E501 - :rtype: str - """ - return self._filename - - @filename.setter - def filename(self, filename): - """Sets the filename of this InlineObject. - - - :param filename: The filename of this InlineObject. # noqa: E501 - :type: str - """ - - self._filename = filename - - @property - def mime_type(self): - """Gets the mime_type of this InlineObject. # noqa: E501 - - - :return: The mime_type of this InlineObject. # noqa: E501 - :rtype: str - """ - return self._mime_type - - @mime_type.setter - def mime_type(self, mime_type): - """Sets the mime_type of this InlineObject. - - - :param mime_type: The mime_type of this InlineObject. # noqa: E501 - :type: str - """ - - self._mime_type = mime_type diff --git a/xero_python/file/models/inline_object1.py b/xero_python/file/models/inline_object1.py deleted file mode 100644 index e4d338e4..00000000 --- a/xero_python/file/models/inline_object1.py +++ /dev/null @@ -1,150 +0,0 @@ -# coding: utf-8 - -""" - Xero Files API - - These endpoints are specific to Xero Files API # noqa: E501 - - Contact: api@xero.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 - -from xero_python.models import BaseModel - - -class InlineObject1(BaseModel): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - """ - Attributes: - openapi_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - openapi_types = { - "body": "str", - "name": "str", - "filename": "str", - "mime_type": "str", - } - - attribute_map = { - "body": "body", - "name": "name", - "filename": "filename", - "mime_type": "mimeType", - } - - def __init__( - self, body=None, name=None, filename=None, mime_type=None - ): # noqa: E501 - """InlineObject1 - a model defined in OpenAPI""" # noqa: E501 - - self._body = None - self._name = None - self._filename = None - self._mime_type = None - self.discriminator = None - - if body is not None: - self.body = body - if name is not None: - self.name = name - if filename is not None: - self.filename = filename - if mime_type is not None: - self.mime_type = mime_type - - @property - def body(self): - """Gets the body of this InlineObject1. # noqa: E501 - - - :return: The body of this InlineObject1. # noqa: E501 - :rtype: str - """ - return self._body - - @body.setter - def body(self, body): - """Sets the body of this InlineObject1. - - - :param body: The body of this InlineObject1. # noqa: E501 - :type: str - """ - - self._body = body - - @property - def name(self): - """Gets the name of this InlineObject1. # noqa: E501 - - exact name of the file you are uploading # noqa: E501 - - :return: The name of this InlineObject1. # noqa: E501 - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """Sets the name of this InlineObject1. - - exact name of the file you are uploading # noqa: E501 - - :param name: The name of this InlineObject1. # noqa: E501 - :type: str - """ - - self._name = name - - @property - def filename(self): - """Gets the filename of this InlineObject1. # noqa: E501 - - - :return: The filename of this InlineObject1. # noqa: E501 - :rtype: str - """ - return self._filename - - @filename.setter - def filename(self, filename): - """Sets the filename of this InlineObject1. - - - :param filename: The filename of this InlineObject1. # noqa: E501 - :type: str - """ - - self._filename = filename - - @property - def mime_type(self): - """Gets the mime_type of this InlineObject1. # noqa: E501 - - - :return: The mime_type of this InlineObject1. # noqa: E501 - :rtype: str - """ - return self._mime_type - - @mime_type.setter - def mime_type(self, mime_type): - """Sets the mime_type of this InlineObject1. - - - :param mime_type: The mime_type of this InlineObject1. # noqa: E501 - :type: str - """ - - self._mime_type = mime_type diff --git a/xero_python/file/models/object_group.py b/xero_python/file/models/object_group.py index bce4e3ed..8a5b224d 100644 --- a/xero_python/file/models/object_group.py +++ b/xero_python/file/models/object_group.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Files API +Xero Files API - These endpoints are specific to Xero Files API # noqa: E501 +These endpoints are specific to Xero Files API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/file/models/object_type.py b/xero_python/file/models/object_type.py index ad98a064..29360bcb 100644 --- a/xero_python/file/models/object_type.py +++ b/xero_python/file/models/object_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Files API +Xero Files API - These endpoints are specific to Xero Files API # noqa: E501 +These endpoints are specific to Xero Files API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/file/models/upload_object.py b/xero_python/file/models/upload_object.py index 36594e89..3a22deea 100644 --- a/xero_python/file/models/upload_object.py +++ b/xero_python/file/models/upload_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Files API +Xero Files API - These endpoints are specific to Xero Files API # noqa: E501 +These endpoints are specific to Xero Files API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/file/models/user.py b/xero_python/file/models/user.py index 12715566..d6cfda0f 100644 --- a/xero_python/file/models/user.py +++ b/xero_python/file/models/user.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Files API +Xero Files API - These endpoints are specific to Xero Files API # noqa: E501 +These endpoints are specific to Xero Files API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/__init__.py b/xero_python/finance/__init__.py index 100d946e..771c301b 100644 --- a/xero_python/finance/__init__.py +++ b/xero_python/finance/__init__.py @@ -3,12 +3,12 @@ # flake8: noqa """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -17,8 +17,6 @@ # import models into sdk package -from xero_python.finance.models.account_usage import AccountUsage -from xero_python.finance.models.account_usage_response import AccountUsageResponse from xero_python.finance.models.balance_sheet_account_detail import ( BalanceSheetAccountDetail, ) @@ -50,27 +48,21 @@ CurrentStatementResponse, ) from xero_python.finance.models.data_source_response import DataSourceResponse -from xero_python.finance.models.history_record_response import HistoryRecordResponse from xero_python.finance.models.income_by_contact_response import ( IncomeByContactResponse, ) from xero_python.finance.models.invoice_response import InvoiceResponse from xero_python.finance.models.line_item_response import LineItemResponse -from xero_python.finance.models.lock_history_model import LockHistoryModel -from xero_python.finance.models.lock_history_response import LockHistoryResponse from xero_python.finance.models.manual_journal_total import ManualJournalTotal from xero_python.finance.models.overpayment_response import OverpaymentResponse from xero_python.finance.models.payment_response import PaymentResponse from xero_python.finance.models.pnl_account import PnlAccount from xero_python.finance.models.pnl_account_class import PnlAccountClass from xero_python.finance.models.pnl_account_type import PnlAccountType -from xero_python.finance.models.practice_response import PracticeResponse from xero_python.finance.models.prepayment_response import PrepaymentResponse from xero_python.finance.models.problem import Problem from xero_python.finance.models.problem_type import ProblemType from xero_python.finance.models.profit_and_loss_response import ProfitAndLossResponse -from xero_python.finance.models.report_history_model import ReportHistoryModel -from xero_python.finance.models.report_history_response import ReportHistoryResponse from xero_python.finance.models.statement_balance_response import ( StatementBalanceResponse, ) @@ -83,5 +75,3 @@ from xero_python.finance.models.trial_balance_entry import TrialBalanceEntry from xero_python.finance.models.trial_balance_movement import TrialBalanceMovement from xero_python.finance.models.trial_balance_response import TrialBalanceResponse -from xero_python.finance.models.user_activities_response import UserActivitiesResponse -from xero_python.finance.models.user_response import UserResponse diff --git a/xero_python/finance/api/finance_api.py b/xero_python/finance/api/finance_api.py index d153adb0..826c35ad 100644 --- a/xero_python/finance/api/finance_api.py +++ b/xero_python/finance/api/finance_api.py @@ -1,5 +1,16 @@ # coding: utf-8 +import importlib +import re # noqa: F401 + +from xero_python import exceptions +from xero_python.api_client import ApiClient, ModelFinder + +try: + from .exception_handler import translate_status_exception +except ImportError: + translate_status_exception = exceptions.translate_status_exception + """ Xero Finance API @@ -10,20 +21,9 @@ """ """ - OpenAPI spec version: 2.19.3 + OpenAPI spec version: 16.2.0 """ -import importlib -import re # noqa: F401 - -from xero_python import exceptions -from xero_python.api_client import ApiClient, ModelFinder - -try: - from .exception_handler import translate_status_exception -except ImportError: - translate_status_exception = exceptions.translate_status_exception - class empty: """empty object to mark optional parameter not set""" @@ -56,307 +56,6 @@ def get_resource_url(self, resource_path): def get_model_finder(self): return ModelFinder(self.models_module) - def get_accounting_activity_account_usage( - self, - xero_tenant_id, - start_month=empty, - end_month=empty, - _return_http_data_only=True, - _preload_content=True, - _request_timeout=None, - ): - """Get account usage # noqa: E501 - OAuth2 scope: finance.accountingactivity.read - A summary of how each account is being transacted on exposing the level of detail and amounts attributable to manual adjustments. # noqa: E501 - :param str xero_tenant_id: Xero identifier for Tenant (required) - :param str start_month: date, yyyy-MM If no parameter is provided, the month 12 months prior to the end month will be used. Account usage for up to 12 months from this date will be returned. - :param str end_month: date, yyyy-MM If no parameter is provided, the current month will be used. Account usage for up to 12 months prior to this date will be returned. - :param bool _return_http_data_only: return received data only - :param bool _preload_content: load received data in models - :param bool _request_timeout: maximum wait time for response - :return: AccountUsageResponse - """ - - # verify the required parameter 'xero_tenant_id' is set - if xero_tenant_id is None: - raise ValueError( - "Missing the required parameter `xero_tenant_id` " - "when calling `get_accounting_activity_account_usage`" - ) - - collection_formats = {} - path_params = {} - - query_params = [] - - if start_month is not empty: - query_params.append(("startMonth", start_month)) - - if end_month is not empty: - query_params.append(("endMonth", end_month)) - - header_params = { - "xero-tenant-id": xero_tenant_id, - } - - local_var_files = {} - form_params = [] - - body_params = None - # HTTP header `Accept` - header_params["Accept"] = self.api_client.select_header_accept( - ["application/json"] - ) - - # Authentication setting - auth_settings = ["OAuth2"] - url = self.get_resource_url("/AccountingActivities/AccountUsage") - - try: - return self.api_client.call_api( - url, - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type="AccountUsageResponse", - response_model_finder=self.get_model_finder(), - auth_settings=auth_settings, - _return_http_data_only=_return_http_data_only, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - collection_formats=collection_formats, - ) - except exceptions.HTTPStatusException as error: - raise translate_status_exception( - error, self, "get_accounting_activity_account_usage" - ) - - def get_accounting_activity_lock_history( - self, - xero_tenant_id, - end_date=empty, - _return_http_data_only=True, - _preload_content=True, - _request_timeout=None, - ): - """Get lock history # noqa: E501 - OAuth2 scope: finance.accountingactivity.read - Provides a history of locking of accounting books. Locking may be an indicator of good accounting practices that could reduce the risk of changes to accounting records in prior periods. # noqa: E501 - :param str xero_tenant_id: Xero identifier for Tenant (required) - :param str end_date: date, yyyy-MM-dd If no parameter is provided, the current date will be used. Any changes to hard or soft lock dates that were made within the period up to 12 months before this date will be returned. Please be aware that there may be a delay of up to 3 days before a change is visible from this API. - :param bool _return_http_data_only: return received data only - :param bool _preload_content: load received data in models - :param bool _request_timeout: maximum wait time for response - :return: LockHistoryResponse - """ - - # verify the required parameter 'xero_tenant_id' is set - if xero_tenant_id is None: - raise ValueError( - "Missing the required parameter `xero_tenant_id` " - "when calling `get_accounting_activity_lock_history`" - ) - - collection_formats = {} - path_params = {} - - query_params = [] - - if end_date is not empty: - query_params.append(("endDate", end_date)) - - header_params = { - "xero-tenant-id": xero_tenant_id, - } - - local_var_files = {} - form_params = [] - - body_params = None - # HTTP header `Accept` - header_params["Accept"] = self.api_client.select_header_accept( - ["application/json"] - ) - - # Authentication setting - auth_settings = ["OAuth2"] - url = self.get_resource_url("/AccountingActivities/LockHistory") - - try: - return self.api_client.call_api( - url, - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type="LockHistoryResponse", - response_model_finder=self.get_model_finder(), - auth_settings=auth_settings, - _return_http_data_only=_return_http_data_only, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - collection_formats=collection_formats, - ) - except exceptions.HTTPStatusException as error: - raise translate_status_exception( - error, self, "get_accounting_activity_lock_history" - ) - - def get_accounting_activity_report_history( - self, - xero_tenant_id, - end_date=empty, - _return_http_data_only=True, - _preload_content=True, - _request_timeout=None, - ): - """Get report history # noqa: E501 - OAuth2 scope: finance.accountingactivity.read - For a specified organisation, provides a summary of all the reports published within a given period, which may be an indicator for good business management and oversight. # noqa: E501 - :param str xero_tenant_id: Xero identifier for Tenant (required) - :param str end_date: date, yyyy-MM-dd If no parameter is provided, the current date will be used. Any reports that were published within the period up to 12 months before this date will be returned. Please be aware that there may be a delay of up to 3 days before a published report is visible from this API. - :param bool _return_http_data_only: return received data only - :param bool _preload_content: load received data in models - :param bool _request_timeout: maximum wait time for response - :return: ReportHistoryResponse - """ - - # verify the required parameter 'xero_tenant_id' is set - if xero_tenant_id is None: - raise ValueError( - "Missing the required parameter `xero_tenant_id` " - "when calling `get_accounting_activity_report_history`" - ) - - collection_formats = {} - path_params = {} - - query_params = [] - - if end_date is not empty: - query_params.append(("endDate", end_date)) - - header_params = { - "xero-tenant-id": xero_tenant_id, - } - - local_var_files = {} - form_params = [] - - body_params = None - # HTTP header `Accept` - header_params["Accept"] = self.api_client.select_header_accept( - ["application/json"] - ) - - # Authentication setting - auth_settings = ["OAuth2"] - url = self.get_resource_url("/AccountingActivities/ReportHistory") - - try: - return self.api_client.call_api( - url, - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type="ReportHistoryResponse", - response_model_finder=self.get_model_finder(), - auth_settings=auth_settings, - _return_http_data_only=_return_http_data_only, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - collection_formats=collection_formats, - ) - except exceptions.HTTPStatusException as error: - raise translate_status_exception( - error, self, "get_accounting_activity_report_history" - ) - - def get_accounting_activity_user_activities( - self, - xero_tenant_id, - data_month=empty, - _return_http_data_only=True, - _preload_content=True, - _request_timeout=None, - ): - """Get user activities # noqa: E501 - OAuth2 scope: finance.accountingactivity.read - For a specified organisation, provides a list of all the users registered, and a history of their accounting transactions. Also identifies the existence of an external accounting advisor and the level of interaction. # noqa: E501 - :param str xero_tenant_id: Xero identifier for Tenant (required) - :param str data_month: date, yyyy-MM The specified month must be complete (in the past); The current month cannot be specified since it is not complete. If no parameter is provided, the month immediately previous to the current month will be used. Any user activities occurring within the specified month will be returned. Please be aware that there may be a delay of up to 3 days before a user activity is visible from this API. - :param bool _return_http_data_only: return received data only - :param bool _preload_content: load received data in models - :param bool _request_timeout: maximum wait time for response - :return: UserActivitiesResponse - """ - - # verify the required parameter 'xero_tenant_id' is set - if xero_tenant_id is None: - raise ValueError( - "Missing the required parameter `xero_tenant_id` " - "when calling `get_accounting_activity_user_activities`" - ) - - collection_formats = {} - path_params = {} - - query_params = [] - - if data_month is not empty: - query_params.append(("dataMonth", data_month)) - - header_params = { - "xero-tenant-id": xero_tenant_id, - } - - local_var_files = {} - form_params = [] - - body_params = None - # HTTP header `Accept` - header_params["Accept"] = self.api_client.select_header_accept( - ["application/json"] - ) - - # Authentication setting - auth_settings = ["OAuth2"] - url = self.get_resource_url("/AccountingActivities/UserActivities") - - try: - return self.api_client.call_api( - url, - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type="UserActivitiesResponse", - response_model_finder=self.get_model_finder(), - auth_settings=auth_settings, - _return_http_data_only=_return_http_data_only, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - collection_formats=collection_formats, - ) - except exceptions.HTTPStatusException as error: - raise translate_status_exception( - error, self, "get_accounting_activity_user_activities" - ) - def get_bank_statement_accounting( self, xero_tenant_id, diff --git a/xero_python/finance/docs/AccountUsage.md b/xero_python/finance/docs/AccountUsage.md deleted file mode 100644 index eeaf7c7d..00000000 --- a/xero_python/finance/docs/AccountUsage.md +++ /dev/null @@ -1,22 +0,0 @@ -# AccountUsage - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**month** | **str** | The month this usage item contains data for | [optional] -**account_id** | **str** | The account this usage item contains data for | [optional] -**currency_code** | **str** | The currency code this usage item contains data for | [optional] -**total_received** | **float** | Total received | [optional] -**count_received** | **int** | Count of received | [optional] -**total_paid** | **float** | Total paid | [optional] -**count_paid** | **int** | Count of paid | [optional] -**total_manual_journal** | **float** | Total value of manual journals | [optional] -**count_manual_journal** | **int** | Count of manual journals | [optional] -**account_name** | **str** | The name of the account | [optional] -**reporting_code** | **str** | Shown if set | [optional] -**reporting_code_name** | **str** | Shown if set | [optional] -**report_code_updated_date_utc** | **datetime** | Last modified date UTC format | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/xero_python/finance/docs/AccountUsageResponse.md b/xero_python/finance/docs/AccountUsageResponse.md deleted file mode 100644 index 8166754c..00000000 --- a/xero_python/finance/docs/AccountUsageResponse.md +++ /dev/null @@ -1,13 +0,0 @@ -# AccountUsageResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**organisation_id** | **str** | The requested Organisation to which the data pertains | [optional] -**start_month** | **str** | The start month of the report | [optional] -**end_month** | **str** | The end month of the report | [optional] -**account_usage** | [**list[AccountUsage]**](AccountUsage.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/xero_python/finance/docs/CurrentStatementResponse.md b/xero_python/finance/docs/CurrentStatementResponse.md index 854593cf..86743623 100644 --- a/xero_python/finance/docs/CurrentStatementResponse.md +++ b/xero_python/finance/docs/CurrentStatementResponse.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **start_balance** | **float** | Looking at the most recent bank statement, this field indicates the balance before the transactions on the statement are applied (note, this is not always populated by the bank in every single instance (~10%)). | [optional] **end_balance** | **float** | Looking at the most recent bank statement, this field indicates the balance after the transactions on the statement are applied (note, this is not always populated by the bank in every single instance (~10%)). | [optional] **imported_date_time_utc** | **datetime** | Looking at the most recent bank statement, this field indicates when the document was imported into Xero. This date is represented in ISO 8601 format. | [optional] -**import_source_type** | **str** | Looking at the most recent bank statement, this field indicates the source of the data (direct bank feed, indirect bank feed, file upload, or manual keying). | [optional] +**import_source_type** | **str** | Looking at the most recent bank statement, this field indicates the source of the data (direct bank feed, file upload, or manual keying). | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/finance/docs/DataSourceResponse.md b/xero_python/finance/docs/DataSourceResponse.md index 6e8ceffd..cda4b1f0 100644 --- a/xero_python/finance/docs/DataSourceResponse.md +++ b/xero_python/finance/docs/DataSourceResponse.md @@ -3,21 +3,18 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**direct_bank_feed** | **float** | Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero. This gives an indication on the certainty of correctness of the data. | [optional] -**indirect_bank_feed** | **float** | Sum of the amounts of all statement lines where the source of the data was a indirect bank feed to Xero (usually via Yodlee). This gives an indication on the certainty of correctness of the data. | [optional] -**file_upload** | **float** | Sum of the amounts of all statement lines where the source of the data was a CSV file upload in to Xero. This gives an indication on the certainty of correctness of the data. | [optional] -**manual** | **float** | Sum of the amounts of all statement lines where the source of the data was manually keyed in to Xero. This gives an indication on the certainty of correctness of the data. | [optional] -**direct_bank_feed_pos** | **float** | Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. | [optional] -**indirect_bank_feed_pos** | **float** | Sum of the amounts of all statement lines where the source of the data was a indirect bank feed to Xero (usually via Yodlee). This gives an indication on the certainty of correctness of the data. Only positive transactions are included. | [optional] -**file_upload_pos** | **float** | Sum of the amounts of all statement lines where the source of the data was a CSV file upload in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. | [optional] -**manual_pos** | **float** | Sum of the amounts of all statement lines where the source of the data was manually keyed in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. | [optional] -**direct_bank_feed_neg** | **float** | Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. | [optional] -**indirect_bank_feed_neg** | **float** | Sum of the amounts of all statement lines where the source of the data was a indirect bank feed to Xero (usually via Yodlee). This gives an indication on the certainty of correctness of the data. Only negative transactions are included. | [optional] -**file_upload_neg** | **float** | Sum of the amounts of all statement lines where the source of the data was a CSV file upload in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. | [optional] -**manual_neg** | **float** | Sum of the amounts of all statement lines where the source of the data was manually keyed in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. | [optional] -**other_pos** | **float** | Sum of the amounts of all statement lines where the source of the data was any other category. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. | [optional] -**other_neg** | **float** | Sum of the amounts of all statement lines where the source of the data was any other category. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. | [optional] -**other** | **float** | Sum of the amounts of all statement lines where the source of the data was any other category. This gives an indication on the certainty of correctness of the data. | [optional] +**direct_bank_feed** | **float** | Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration. This could be from a bank or aggregator. This gives an indication on the certainty of correctness of the data. | [optional] +**file_upload** | **float** | Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero. This gives an indication on the certainty of correctness of the data. | [optional] +**manual** | **float** | Sum of the amounts of all statement lines where the source of the data was manually input in to Xero. This gives an indication on the certainty of correctness of the data. | [optional] +**direct_bank_feed_pos** | **float** | Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration. This could be from a bank or aggregator. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. | [optional] +**file_upload_pos** | **float** | Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. | [optional] +**manual_pos** | **float** | Sum of the amounts of all statement lines where the source of the data was manually input in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. | [optional] +**direct_bank_feed_neg** | **float** | Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration. This could be from a bank or aggregator. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. | [optional] +**file_upload_neg** | **float** | Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. | [optional] +**manual_neg** | **float** | Sum of the amounts of all statement lines where the source of the data was manually input in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. | [optional] +**other_pos** | **float** | Sum of the amounts of all statement lines where the source of the data was unknown. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. | [optional] +**other_neg** | **float** | Sum of the amounts of all statement lines where the source of the data was unknown. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. | [optional] +**other** | **float** | Sum of the amounts of all statement lines where the source of the data was unknown. This gives an indication on the certainty of correctness of the data. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/finance/docs/FinanceApi.md b/xero_python/finance/docs/FinanceApi.md index 44044194..5b1c5667 100644 --- a/xero_python/finance/docs/FinanceApi.md +++ b/xero_python/finance/docs/FinanceApi.md @@ -4,10 +4,6 @@ All URIs are relative to *https://api.xero.com/finance.xro/1.0* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get_accounting_activity_account_usage**](FinanceApi.md#get_accounting_activity_account_usage) | **GET** /AccountingActivities/AccountUsage | Get account usage -[**get_accounting_activity_lock_history**](FinanceApi.md#get_accounting_activity_lock_history) | **GET** /AccountingActivities/LockHistory | Get lock history -[**get_accounting_activity_report_history**](FinanceApi.md#get_accounting_activity_report_history) | **GET** /AccountingActivities/ReportHistory | Get report history -[**get_accounting_activity_user_activities**](FinanceApi.md#get_accounting_activity_user_activities) | **GET** /AccountingActivities/UserActivities | Get user activities [**get_bank_statement_accounting**](FinanceApi.md#get_bank_statement_accounting) | **GET** /BankStatementsPlus/statements | Get Bank Statement Accounting [**get_cash_validation**](FinanceApi.md#get_cash_validation) | **GET** /CashValidation | Get cash validation [**get_financial_statement_balance_sheet**](FinanceApi.md#get_financial_statement_balance_sheet) | **GET** /FinancialStatements/BalanceSheet | Get Balance Sheet report @@ -18,268 +14,6 @@ Method | HTTP request | Description [**get_financial_statement_trial_balance**](FinanceApi.md#get_financial_statement_trial_balance) | **GET** /FinancialStatements/TrialBalance | Get Trial Balance report -# **get_accounting_activity_account_usage** -> AccountUsageResponse get_accounting_activity_account_usage(xero_tenant_id, start_month=start_month, end_month=end_month) - -Get account usage - -A summary of how each account is being transacted on exposing the level of detail and amounts attributable to manual adjustments. - -### Example - -* OAuth Authentication (OAuth2): -```python -from xero_python.api_client import Configuration, ApiClient -from xero_python.api_client.oauth2 import OAuth2Token -from xero_python.exceptions import ApiException -from xero_python.finance import FinanceApi -from pprint import pprint - -# Configure OAuth2 access token for authorization: OAuth2 -# simplified version, `xero_oauth2_token` represents permanent global token storage -xero_oauth2_token = {} # set to valid xero oauth2 token dictionary -# create client configuration with client id and client secret for automatic token refresh -api_config = Configuration(oauth2_token=OAuth2Token( - client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" -)) -# configure xero-python sdk client -api_client = ApiClient( - api_config, - oauth2_token_saver=lambda x: xero_oauth2_token.update(x), - oauth2_token_getter=lambda : xero_oauth2_token -) -# create an instance of the API class -api_instance = FinanceApi(api_client) - -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -start_month = '2020-09' # str | date, yyyy-MM If no parameter is provided, the month 12 months prior to the end month will be used. Account usage for up to 12 months from this date will be returned. (optional) -end_month = '2021-09' # str | date, yyyy-MM If no parameter is provided, the current month will be used. Account usage for up to 12 months prior to this date will be returned. (optional) -try: - # Get account usage - api_response = api_instance.get_accounting_activity_account_usage(xero_tenant_id, start_month=start_month, end_month=end_month) - pprint(api_response) -except ApiException as e: - print("Exception when calling FinanceApi->get_accounting_activity_account_usage: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **xero_tenant_id** | **str**| Xero identifier for Tenant | - **start_month** | **str**| date, yyyy-MM If no parameter is provided, the month 12 months prior to the end month will be used. Account usage for up to 12 months from this date will be returned. | [optional] - **end_month** | **str**| date, yyyy-MM If no parameter is provided, the current month will be used. Account usage for up to 12 months prior to this date will be returned. | [optional] - -### Return type - -[**AccountUsageResponse**](AccountUsageResponse.md) - -### Authorization - -[OAuth2](../README.md#OAuth2) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_accounting_activity_lock_history** -> LockHistoryResponse get_accounting_activity_lock_history(xero_tenant_id, end_date=end_date) - -Get lock history - -Provides a history of locking of accounting books. Locking may be an indicator of good accounting practices that could reduce the risk of changes to accounting records in prior periods. - -### Example - -* OAuth Authentication (OAuth2): -```python -from xero_python.api_client import Configuration, ApiClient -from xero_python.api_client.oauth2 import OAuth2Token -from xero_python.exceptions import ApiException -from xero_python.finance import FinanceApi -from pprint import pprint - -# Configure OAuth2 access token for authorization: OAuth2 -# simplified version, `xero_oauth2_token` represents permanent global token storage -xero_oauth2_token = {} # set to valid xero oauth2 token dictionary -# create client configuration with client id and client secret for automatic token refresh -api_config = Configuration(oauth2_token=OAuth2Token( - client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" -)) -# configure xero-python sdk client -api_client = ApiClient( - api_config, - oauth2_token_saver=lambda x: xero_oauth2_token.update(x), - oauth2_token_getter=lambda : xero_oauth2_token -) -# create an instance of the API class -api_instance = FinanceApi(api_client) - -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -end_date = '2021-09-15' # str | date, yyyy-MM-dd If no parameter is provided, the current date will be used. Any changes to hard or soft lock dates that were made within the period up to 12 months before this date will be returned. Please be aware that there may be a delay of up to 3 days before a change is visible from this API. (optional) -try: - # Get lock history - api_response = api_instance.get_accounting_activity_lock_history(xero_tenant_id, end_date=end_date) - pprint(api_response) -except ApiException as e: - print("Exception when calling FinanceApi->get_accounting_activity_lock_history: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **xero_tenant_id** | **str**| Xero identifier for Tenant | - **end_date** | **str**| date, yyyy-MM-dd If no parameter is provided, the current date will be used. Any changes to hard or soft lock dates that were made within the period up to 12 months before this date will be returned. Please be aware that there may be a delay of up to 3 days before a change is visible from this API. | [optional] - -### Return type - -[**LockHistoryResponse**](LockHistoryResponse.md) - -### Authorization - -[OAuth2](../README.md#OAuth2) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_accounting_activity_report_history** -> ReportHistoryResponse get_accounting_activity_report_history(xero_tenant_id, end_date=end_date) - -Get report history - -For a specified organisation, provides a summary of all the reports published within a given period, which may be an indicator for good business management and oversight. - -### Example - -* OAuth Authentication (OAuth2): -```python -from xero_python.api_client import Configuration, ApiClient -from xero_python.api_client.oauth2 import OAuth2Token -from xero_python.exceptions import ApiException -from xero_python.finance import FinanceApi -from pprint import pprint - -# Configure OAuth2 access token for authorization: OAuth2 -# simplified version, `xero_oauth2_token` represents permanent global token storage -xero_oauth2_token = {} # set to valid xero oauth2 token dictionary -# create client configuration with client id and client secret for automatic token refresh -api_config = Configuration(oauth2_token=OAuth2Token( - client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" -)) -# configure xero-python sdk client -api_client = ApiClient( - api_config, - oauth2_token_saver=lambda x: xero_oauth2_token.update(x), - oauth2_token_getter=lambda : xero_oauth2_token -) -# create an instance of the API class -api_instance = FinanceApi(api_client) - -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -end_date = '2021-09-15' # str | date, yyyy-MM-dd If no parameter is provided, the current date will be used. Any reports that were published within the period up to 12 months before this date will be returned. Please be aware that there may be a delay of up to 3 days before a published report is visible from this API. (optional) -try: - # Get report history - api_response = api_instance.get_accounting_activity_report_history(xero_tenant_id, end_date=end_date) - pprint(api_response) -except ApiException as e: - print("Exception when calling FinanceApi->get_accounting_activity_report_history: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **xero_tenant_id** | **str**| Xero identifier for Tenant | - **end_date** | **str**| date, yyyy-MM-dd If no parameter is provided, the current date will be used. Any reports that were published within the period up to 12 months before this date will be returned. Please be aware that there may be a delay of up to 3 days before a published report is visible from this API. | [optional] - -### Return type - -[**ReportHistoryResponse**](ReportHistoryResponse.md) - -### Authorization - -[OAuth2](../README.md#OAuth2) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_accounting_activity_user_activities** -> UserActivitiesResponse get_accounting_activity_user_activities(xero_tenant_id, data_month=data_month) - -Get user activities - -For a specified organisation, provides a list of all the users registered, and a history of their accounting transactions. Also identifies the existence of an external accounting advisor and the level of interaction. - -### Example - -* OAuth Authentication (OAuth2): -```python -from xero_python.api_client import Configuration, ApiClient -from xero_python.api_client.oauth2 import OAuth2Token -from xero_python.exceptions import ApiException -from xero_python.finance import FinanceApi -from pprint import pprint - -# Configure OAuth2 access token for authorization: OAuth2 -# simplified version, `xero_oauth2_token` represents permanent global token storage -xero_oauth2_token = {} # set to valid xero oauth2 token dictionary -# create client configuration with client id and client secret for automatic token refresh -api_config = Configuration(oauth2_token=OAuth2Token( - client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" -)) -# configure xero-python sdk client -api_client = ApiClient( - api_config, - oauth2_token_saver=lambda x: xero_oauth2_token.update(x), - oauth2_token_getter=lambda : xero_oauth2_token -) -# create an instance of the API class -api_instance = FinanceApi(api_client) - -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -data_month = '2021-09' # str | date, yyyy-MM The specified month must be complete (in the past); The current month cannot be specified since it is not complete. If no parameter is provided, the month immediately previous to the current month will be used. Any user activities occurring within the specified month will be returned. Please be aware that there may be a delay of up to 3 days before a user activity is visible from this API. (optional) -try: - # Get user activities - api_response = api_instance.get_accounting_activity_user_activities(xero_tenant_id, data_month=data_month) - pprint(api_response) -except ApiException as e: - print("Exception when calling FinanceApi->get_accounting_activity_user_activities: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **xero_tenant_id** | **str**| Xero identifier for Tenant | - **data_month** | **str**| date, yyyy-MM The specified month must be complete (in the past); The current month cannot be specified since it is not complete. If no parameter is provided, the month immediately previous to the current month will be used. Any user activities occurring within the specified month will be returned. Please be aware that there may be a delay of up to 3 days before a user activity is visible from this API. | [optional] - -### Return type - -[**UserActivitiesResponse**](UserActivitiesResponse.md) - -### Authorization - -[OAuth2](../README.md#OAuth2) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - # **get_bank_statement_accounting** > BankStatementAccountingResponse get_bank_statement_accounting(xero_tenant_id, bank_account_id, from_date, to_date, summary_only=summary_only) @@ -317,7 +51,7 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant bank_account_id = 'bank_account_id_example' # str | string, GUID Bank account Id from_date = '2020-07-01' # str | date, yyyy-MM-dd Specifies the start date of the query period. The maximum range of the query period is 12 months. If the specified query period is more than 12 months the request will be rejected. to_date = '2021-06-30' # str | date, yyyy-MM-dd Specifies the end date of the query period. If the end date is a future date, the request will be rejected. -summary_only = True # bool | boolean, true/false The default value is true if no parameter is provided. In summary mode, the response will exclude the computation-heavy LineItems fields from bank transaction, invoice, credit note, prepayment and overpayment data, making the API calls quicker and more efficient. (optional) +summary_only = true # bool | boolean, true/false The default value is true if no parameter is provided. In summary mode, the response will exclude the computation-heavy LineItems fields from bank transaction, invoice, credit note, prepayment and overpayment data, making the API calls quicker and more efficient. (optional) try: # Get Bank Statement Accounting api_response = api_instance.get_bank_statement_accounting(xero_tenant_id, bank_account_id, from_date, to_date, summary_only=summary_only) diff --git a/xero_python/finance/docs/HistoryRecordResponse.md b/xero_python/finance/docs/HistoryRecordResponse.md deleted file mode 100644 index 18c0dc18..00000000 --- a/xero_python/finance/docs/HistoryRecordResponse.md +++ /dev/null @@ -1,14 +0,0 @@ -# HistoryRecordResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**changes** | **str** | The type of change recorded against the document | [optional] -**date_utc_string** | **str** | UTC date that the history record was created | [optional] -**date_utc** | **datetime** | UTC date that the history record was created | [optional] -**user** | **str** | The users first and last name | [optional] -**details** | **str** | Description of the change event or transaction | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/xero_python/finance/docs/LockHistoryModel.md b/xero_python/finance/docs/LockHistoryModel.md deleted file mode 100644 index 36658c53..00000000 --- a/xero_python/finance/docs/LockHistoryModel.md +++ /dev/null @@ -1,12 +0,0 @@ -# LockHistoryModel - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**hard_lock_date** | **date** | Date the account hard lock was set | [optional] -**soft_lock_date** | **date** | Date the account soft lock was set | [optional] -**updated_date_utc** | **datetime** | The system date time that the lock was updated | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/xero_python/finance/docs/PracticeResponse.md b/xero_python/finance/docs/PracticeResponse.md deleted file mode 100644 index 5e3f0d04..00000000 --- a/xero_python/finance/docs/PracticeResponse.md +++ /dev/null @@ -1,14 +0,0 @@ -# PracticeResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**xero_partner_since** | **int** | Year of becoming a partner. | [optional] -**tier** | **str** | Customer tier e.g. Silver | [optional] -**location** | **str** | Country of location. | [optional] -**organisation_count** | **int** | Organisation count. | [optional] -**staff_certified** | **bool** | Staff certified (true/false). | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/xero_python/finance/docs/ReportHistoryResponse.md b/xero_python/finance/docs/ReportHistoryResponse.md deleted file mode 100644 index 56489c80..00000000 --- a/xero_python/finance/docs/ReportHistoryResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# ReportHistoryResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**organisation_id** | **str** | The requested Organisation to which the data pertains | [optional] -**end_date** | **date** | The end date of the report | [optional] -**reports** | [**list[ReportHistoryModel]**](ReportHistoryModel.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/xero_python/finance/docs/StatementLineResponse.md b/xero_python/finance/docs/StatementLineResponse.md index d9d44f9d..12e5ed60 100644 --- a/xero_python/finance/docs/StatementLineResponse.md +++ b/xero_python/finance/docs/StatementLineResponse.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **statement_line_id** | **str** | Xero Identifier of statement line | [optional] **posted_date** | **date** | Date of when statement line was posted | [optional] +**payee** | **str** | Payee description of statement line | [optional] **reference** | **str** | Reference description of statement line | [optional] **notes** | **str** | Notes description of statement line | [optional] **cheque_no** | **str** | Cheque number of statement line | [optional] diff --git a/xero_python/finance/docs/StatementResponse.md b/xero_python/finance/docs/StatementResponse.md index b6a0cf61..2e1cc118 100644 --- a/xero_python/finance/docs/StatementResponse.md +++ b/xero_python/finance/docs/StatementResponse.md @@ -7,7 +7,11 @@ Name | Type | Description | Notes **start_date** | **date** | Start date of statement | [optional] **end_date** | **date** | End date of statement | [optional] **imported_date_time_utc** | **datetime** | Utc date time of when the statement was imported in Xero | [optional] -**import_source** | **str** | Import source of statement (STMTIMPORTSRC/MANUAL, STMTIMPORTSRC/CSV, STMTIMPORTSRC/QIF, STMTIMPORTSRC/OFX, XeroApi) | [optional] +**import_source** | **str** | Identifies where the statement data in Xero was sourced, 1) direct bank feed, automatically loaded from the bank (eg STMTIMPORTSRC/CBAFEED); 2) indirect bank feed, automatically loaded from a 3rd party provider (eg STMTIMPORTSRC/YODLEE); 3) manually uploaded bank feed (eg STMTIMPORTSRC/CSV) or 4) manually entered statement data (STMTIMPORTSRC/MANUAL). | [optional] +**start_balance** | **float** | Opening balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied. Where not supplied, the value will be 0. | [optional] +**end_balance** | **float** | Closing balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied. Where not supplied, the value will be 0. | [optional] +**indicative_start_balance** | **float** | Opening statement balance calculated in Xero (= bank account conversion balance plus sum of imported bank statement lines). Note: If indicative statement balance doesn't match imported statement balance for the same date, either the conversion (opening at inception) balance in Xero is wrong or there's an error in the bank statement lines in Xero. Ref: https://central.xero.com/s/article/Compare-the-statement-balance-in-Xero-to-your-actual-bank-balance?userregion=true | [optional] +**indicative_end_balance** | **float** | Closing statement balance calculated in Xero (= bank account conversion balance plus sum of imported bank statement lines). Note: If indicative statement balance doesn't match imported statement balance for the same date, either the conversion (opening at inception) balance in Xero is wrong or there's an error in the bank statement lines in Xero. Ref: https://central.xero.com/s/article/Compare-the-statement-balance-in-Xero-to-your-actual-bank-balance?userregion=true | [optional] **statement_lines** | [**list[StatementLineResponse]**](StatementLineResponse.md) | List of statement lines | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/finance/docs/UserResponse.md b/xero_python/finance/docs/UserResponse.md deleted file mode 100644 index 54146236..00000000 --- a/xero_python/finance/docs/UserResponse.md +++ /dev/null @@ -1,21 +0,0 @@ -# UserResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**user_id** | **str** | The Xero identifier for the user | [optional] -**user_created_date_utc** | **datetime** | Timestamp of user creation. | [optional] -**last_login_date_utc** | **datetime** | Timestamp of user last login | [optional] -**is_external_partner** | **bool** | User is external partner. | [optional] -**has_accountant_role** | **bool** | User has Accountant role. | [optional] -**month_period** | **str** | Month period in format yyyy-MM. | [optional] -**number_of_logins** | **int** | Number of times the user has logged in. | [optional] -**number_of_documents_created** | **int** | Number of documents created. | [optional] -**net_value_documents_created** | **float** | Net value of documents created. | [optional] -**absolute_value_documents_created** | **float** | Absolute value of documents created. | [optional] -**attached_practices** | [**list[PracticeResponse]**](PracticeResponse.md) | | [optional] -**history_records** | [**list[HistoryRecordResponse]**](HistoryRecordResponse.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/xero_python/finance/models/__init__.py b/xero_python/finance/models/__init__.py index 41ea1a33..01631ae4 100644 --- a/xero_python/finance/models/__init__.py +++ b/xero_python/finance/models/__init__.py @@ -2,18 +2,16 @@ # flake8: noqa """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ # import models into model package -from xero_python.finance.models.account_usage import AccountUsage -from xero_python.finance.models.account_usage_response import AccountUsageResponse from xero_python.finance.models.balance_sheet_account_detail import ( BalanceSheetAccountDetail, ) @@ -45,27 +43,21 @@ CurrentStatementResponse, ) from xero_python.finance.models.data_source_response import DataSourceResponse -from xero_python.finance.models.history_record_response import HistoryRecordResponse from xero_python.finance.models.income_by_contact_response import ( IncomeByContactResponse, ) from xero_python.finance.models.invoice_response import InvoiceResponse from xero_python.finance.models.line_item_response import LineItemResponse -from xero_python.finance.models.lock_history_model import LockHistoryModel -from xero_python.finance.models.lock_history_response import LockHistoryResponse from xero_python.finance.models.manual_journal_total import ManualJournalTotal from xero_python.finance.models.overpayment_response import OverpaymentResponse from xero_python.finance.models.payment_response import PaymentResponse from xero_python.finance.models.pnl_account import PnlAccount from xero_python.finance.models.pnl_account_class import PnlAccountClass from xero_python.finance.models.pnl_account_type import PnlAccountType -from xero_python.finance.models.practice_response import PracticeResponse from xero_python.finance.models.prepayment_response import PrepaymentResponse from xero_python.finance.models.problem import Problem from xero_python.finance.models.problem_type import ProblemType from xero_python.finance.models.profit_and_loss_response import ProfitAndLossResponse -from xero_python.finance.models.report_history_model import ReportHistoryModel -from xero_python.finance.models.report_history_response import ReportHistoryResponse from xero_python.finance.models.statement_balance_response import ( StatementBalanceResponse, ) @@ -78,5 +70,3 @@ from xero_python.finance.models.trial_balance_entry import TrialBalanceEntry from xero_python.finance.models.trial_balance_movement import TrialBalanceMovement from xero_python.finance.models.trial_balance_response import TrialBalanceResponse -from xero_python.finance.models.user_activities_response import UserActivitiesResponse -from xero_python.finance.models.user_response import UserResponse diff --git a/xero_python/finance/models/account_usage.py b/xero_python/finance/models/account_usage.py deleted file mode 100644 index 8efa98ce..00000000 --- a/xero_python/finance/models/account_usage.py +++ /dev/null @@ -1,421 +0,0 @@ -# coding: utf-8 - -""" - Xero Finance API - - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - - Contact: api@xero.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 - -from xero_python.models import BaseModel - - -class AccountUsage(BaseModel): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - """ - Attributes: - openapi_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - openapi_types = { - "month": "str", - "account_id": "str", - "currency_code": "str", - "total_received": "float", - "count_received": "int", - "total_paid": "float", - "count_paid": "int", - "total_manual_journal": "float", - "count_manual_journal": "int", - "account_name": "str", - "reporting_code": "str", - "reporting_code_name": "str", - "report_code_updated_date_utc": "datetime", - } - - attribute_map = { - "month": "month", - "account_id": "accountId", - "currency_code": "currencyCode", - "total_received": "totalReceived", - "count_received": "countReceived", - "total_paid": "totalPaid", - "count_paid": "countPaid", - "total_manual_journal": "totalManualJournal", - "count_manual_journal": "countManualJournal", - "account_name": "accountName", - "reporting_code": "reportingCode", - "reporting_code_name": "reportingCodeName", - "report_code_updated_date_utc": "reportCodeUpdatedDateUtc", - } - - def __init__( - self, - month=None, - account_id=None, - currency_code=None, - total_received=None, - count_received=None, - total_paid=None, - count_paid=None, - total_manual_journal=None, - count_manual_journal=None, - account_name=None, - reporting_code=None, - reporting_code_name=None, - report_code_updated_date_utc=None, - ): # noqa: E501 - """AccountUsage - a model defined in OpenAPI""" # noqa: E501 - - self._month = None - self._account_id = None - self._currency_code = None - self._total_received = None - self._count_received = None - self._total_paid = None - self._count_paid = None - self._total_manual_journal = None - self._count_manual_journal = None - self._account_name = None - self._reporting_code = None - self._reporting_code_name = None - self._report_code_updated_date_utc = None - self.discriminator = None - - if month is not None: - self.month = month - if account_id is not None: - self.account_id = account_id - if currency_code is not None: - self.currency_code = currency_code - if total_received is not None: - self.total_received = total_received - if count_received is not None: - self.count_received = count_received - if total_paid is not None: - self.total_paid = total_paid - if count_paid is not None: - self.count_paid = count_paid - if total_manual_journal is not None: - self.total_manual_journal = total_manual_journal - if count_manual_journal is not None: - self.count_manual_journal = count_manual_journal - if account_name is not None: - self.account_name = account_name - if reporting_code is not None: - self.reporting_code = reporting_code - if reporting_code_name is not None: - self.reporting_code_name = reporting_code_name - if report_code_updated_date_utc is not None: - self.report_code_updated_date_utc = report_code_updated_date_utc - - @property - def month(self): - """Gets the month of this AccountUsage. # noqa: E501 - - The month this usage item contains data for # noqa: E501 - - :return: The month of this AccountUsage. # noqa: E501 - :rtype: str - """ - return self._month - - @month.setter - def month(self, month): - """Sets the month of this AccountUsage. - - The month this usage item contains data for # noqa: E501 - - :param month: The month of this AccountUsage. # noqa: E501 - :type: str - """ - - self._month = month - - @property - def account_id(self): - """Gets the account_id of this AccountUsage. # noqa: E501 - - The account this usage item contains data for # noqa: E501 - - :return: The account_id of this AccountUsage. # noqa: E501 - :rtype: str - """ - return self._account_id - - @account_id.setter - def account_id(self, account_id): - """Sets the account_id of this AccountUsage. - - The account this usage item contains data for # noqa: E501 - - :param account_id: The account_id of this AccountUsage. # noqa: E501 - :type: str - """ - - self._account_id = account_id - - @property - def currency_code(self): - """Gets the currency_code of this AccountUsage. # noqa: E501 - - The currency code this usage item contains data for # noqa: E501 - - :return: The currency_code of this AccountUsage. # noqa: E501 - :rtype: str - """ - return self._currency_code - - @currency_code.setter - def currency_code(self, currency_code): - """Sets the currency_code of this AccountUsage. - - The currency code this usage item contains data for # noqa: E501 - - :param currency_code: The currency_code of this AccountUsage. # noqa: E501 - :type: str - """ - - self._currency_code = currency_code - - @property - def total_received(self): - """Gets the total_received of this AccountUsage. # noqa: E501 - - Total received # noqa: E501 - - :return: The total_received of this AccountUsage. # noqa: E501 - :rtype: float - """ - return self._total_received - - @total_received.setter - def total_received(self, total_received): - """Sets the total_received of this AccountUsage. - - Total received # noqa: E501 - - :param total_received: The total_received of this AccountUsage. # noqa: E501 - :type: float - """ - - self._total_received = total_received - - @property - def count_received(self): - """Gets the count_received of this AccountUsage. # noqa: E501 - - Count of received # noqa: E501 - - :return: The count_received of this AccountUsage. # noqa: E501 - :rtype: int - """ - return self._count_received - - @count_received.setter - def count_received(self, count_received): - """Sets the count_received of this AccountUsage. - - Count of received # noqa: E501 - - :param count_received: The count_received of this AccountUsage. # noqa: E501 - :type: int - """ - - self._count_received = count_received - - @property - def total_paid(self): - """Gets the total_paid of this AccountUsage. # noqa: E501 - - Total paid # noqa: E501 - - :return: The total_paid of this AccountUsage. # noqa: E501 - :rtype: float - """ - return self._total_paid - - @total_paid.setter - def total_paid(self, total_paid): - """Sets the total_paid of this AccountUsage. - - Total paid # noqa: E501 - - :param total_paid: The total_paid of this AccountUsage. # noqa: E501 - :type: float - """ - - self._total_paid = total_paid - - @property - def count_paid(self): - """Gets the count_paid of this AccountUsage. # noqa: E501 - - Count of paid # noqa: E501 - - :return: The count_paid of this AccountUsage. # noqa: E501 - :rtype: int - """ - return self._count_paid - - @count_paid.setter - def count_paid(self, count_paid): - """Sets the count_paid of this AccountUsage. - - Count of paid # noqa: E501 - - :param count_paid: The count_paid of this AccountUsage. # noqa: E501 - :type: int - """ - - self._count_paid = count_paid - - @property - def total_manual_journal(self): - """Gets the total_manual_journal of this AccountUsage. # noqa: E501 - - Total value of manual journals # noqa: E501 - - :return: The total_manual_journal of this AccountUsage. # noqa: E501 - :rtype: float - """ - return self._total_manual_journal - - @total_manual_journal.setter - def total_manual_journal(self, total_manual_journal): - """Sets the total_manual_journal of this AccountUsage. - - Total value of manual journals # noqa: E501 - - :param total_manual_journal: The total_manual_journal of this AccountUsage. # noqa: E501 - :type: float - """ - - self._total_manual_journal = total_manual_journal - - @property - def count_manual_journal(self): - """Gets the count_manual_journal of this AccountUsage. # noqa: E501 - - Count of manual journals # noqa: E501 - - :return: The count_manual_journal of this AccountUsage. # noqa: E501 - :rtype: int - """ - return self._count_manual_journal - - @count_manual_journal.setter - def count_manual_journal(self, count_manual_journal): - """Sets the count_manual_journal of this AccountUsage. - - Count of manual journals # noqa: E501 - - :param count_manual_journal: The count_manual_journal of this AccountUsage. # noqa: E501 - :type: int - """ - - self._count_manual_journal = count_manual_journal - - @property - def account_name(self): - """Gets the account_name of this AccountUsage. # noqa: E501 - - The name of the account # noqa: E501 - - :return: The account_name of this AccountUsage. # noqa: E501 - :rtype: str - """ - return self._account_name - - @account_name.setter - def account_name(self, account_name): - """Sets the account_name of this AccountUsage. - - The name of the account # noqa: E501 - - :param account_name: The account_name of this AccountUsage. # noqa: E501 - :type: str - """ - - self._account_name = account_name - - @property - def reporting_code(self): - """Gets the reporting_code of this AccountUsage. # noqa: E501 - - Shown if set # noqa: E501 - - :return: The reporting_code of this AccountUsage. # noqa: E501 - :rtype: str - """ - return self._reporting_code - - @reporting_code.setter - def reporting_code(self, reporting_code): - """Sets the reporting_code of this AccountUsage. - - Shown if set # noqa: E501 - - :param reporting_code: The reporting_code of this AccountUsage. # noqa: E501 - :type: str - """ - - self._reporting_code = reporting_code - - @property - def reporting_code_name(self): - """Gets the reporting_code_name of this AccountUsage. # noqa: E501 - - Shown if set # noqa: E501 - - :return: The reporting_code_name of this AccountUsage. # noqa: E501 - :rtype: str - """ - return self._reporting_code_name - - @reporting_code_name.setter - def reporting_code_name(self, reporting_code_name): - """Sets the reporting_code_name of this AccountUsage. - - Shown if set # noqa: E501 - - :param reporting_code_name: The reporting_code_name of this AccountUsage. # noqa: E501 - :type: str - """ - - self._reporting_code_name = reporting_code_name - - @property - def report_code_updated_date_utc(self): - """Gets the report_code_updated_date_utc of this AccountUsage. # noqa: E501 - - Last modified date UTC format # noqa: E501 - - :return: The report_code_updated_date_utc of this AccountUsage. # noqa: E501 - :rtype: datetime - """ - return self._report_code_updated_date_utc - - @report_code_updated_date_utc.setter - def report_code_updated_date_utc(self, report_code_updated_date_utc): - """Sets the report_code_updated_date_utc of this AccountUsage. - - Last modified date UTC format # noqa: E501 - - :param report_code_updated_date_utc: The report_code_updated_date_utc of this AccountUsage. # noqa: E501 - :type: datetime - """ - - self._report_code_updated_date_utc = report_code_updated_date_utc diff --git a/xero_python/finance/models/account_usage_response.py b/xero_python/finance/models/account_usage_response.py deleted file mode 100644 index 5676ef13..00000000 --- a/xero_python/finance/models/account_usage_response.py +++ /dev/null @@ -1,154 +0,0 @@ -# coding: utf-8 - -""" - Xero Finance API - - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - - Contact: api@xero.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 - -from xero_python.models import BaseModel - - -class AccountUsageResponse(BaseModel): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - """ - Attributes: - openapi_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - openapi_types = { - "organisation_id": "str", - "start_month": "str", - "end_month": "str", - "account_usage": "list[AccountUsage]", - } - - attribute_map = { - "organisation_id": "organisationId", - "start_month": "startMonth", - "end_month": "endMonth", - "account_usage": "accountUsage", - } - - def __init__( - self, organisation_id=None, start_month=None, end_month=None, account_usage=None - ): # noqa: E501 - """AccountUsageResponse - a model defined in OpenAPI""" # noqa: E501 - - self._organisation_id = None - self._start_month = None - self._end_month = None - self._account_usage = None - self.discriminator = None - - if organisation_id is not None: - self.organisation_id = organisation_id - if start_month is not None: - self.start_month = start_month - if end_month is not None: - self.end_month = end_month - if account_usage is not None: - self.account_usage = account_usage - - @property - def organisation_id(self): - """Gets the organisation_id of this AccountUsageResponse. # noqa: E501 - - The requested Organisation to which the data pertains # noqa: E501 - - :return: The organisation_id of this AccountUsageResponse. # noqa: E501 - :rtype: str - """ - return self._organisation_id - - @organisation_id.setter - def organisation_id(self, organisation_id): - """Sets the organisation_id of this AccountUsageResponse. - - The requested Organisation to which the data pertains # noqa: E501 - - :param organisation_id: The organisation_id of this AccountUsageResponse. # noqa: E501 - :type: str - """ - - self._organisation_id = organisation_id - - @property - def start_month(self): - """Gets the start_month of this AccountUsageResponse. # noqa: E501 - - The start month of the report # noqa: E501 - - :return: The start_month of this AccountUsageResponse. # noqa: E501 - :rtype: str - """ - return self._start_month - - @start_month.setter - def start_month(self, start_month): - """Sets the start_month of this AccountUsageResponse. - - The start month of the report # noqa: E501 - - :param start_month: The start_month of this AccountUsageResponse. # noqa: E501 - :type: str - """ - - self._start_month = start_month - - @property - def end_month(self): - """Gets the end_month of this AccountUsageResponse. # noqa: E501 - - The end month of the report # noqa: E501 - - :return: The end_month of this AccountUsageResponse. # noqa: E501 - :rtype: str - """ - return self._end_month - - @end_month.setter - def end_month(self, end_month): - """Sets the end_month of this AccountUsageResponse. - - The end month of the report # noqa: E501 - - :param end_month: The end_month of this AccountUsageResponse. # noqa: E501 - :type: str - """ - - self._end_month = end_month - - @property - def account_usage(self): - """Gets the account_usage of this AccountUsageResponse. # noqa: E501 - - - :return: The account_usage of this AccountUsageResponse. # noqa: E501 - :rtype: list[AccountUsage] - """ - return self._account_usage - - @account_usage.setter - def account_usage(self, account_usage): - """Sets the account_usage of this AccountUsageResponse. - - - :param account_usage: The account_usage of this AccountUsageResponse. # noqa: E501 - :type: list[AccountUsage] - """ - - self._account_usage = account_usage diff --git a/xero_python/finance/models/balance_sheet_account_detail.py b/xero_python/finance/models/balance_sheet_account_detail.py index 659c4d18..12ee0ad9 100644 --- a/xero_python/finance/models/balance_sheet_account_detail.py +++ b/xero_python/finance/models/balance_sheet_account_detail.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/balance_sheet_account_group.py b/xero_python/finance/models/balance_sheet_account_group.py index 3ee1e701..2ac4f48d 100644 --- a/xero_python/finance/models/balance_sheet_account_group.py +++ b/xero_python/finance/models/balance_sheet_account_group.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/balance_sheet_account_type.py b/xero_python/finance/models/balance_sheet_account_type.py index 23c1aeba..1be95dd9 100644 --- a/xero_python/finance/models/balance_sheet_account_type.py +++ b/xero_python/finance/models/balance_sheet_account_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/balance_sheet_response.py b/xero_python/finance/models/balance_sheet_response.py index 1db7f757..e335930a 100644 --- a/xero_python/finance/models/balance_sheet_response.py +++ b/xero_python/finance/models/balance_sheet_response.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/bank_statement_accounting_response.py b/xero_python/finance/models/bank_statement_accounting_response.py index 96cc85b2..2cc4ce3a 100644 --- a/xero_python/finance/models/bank_statement_accounting_response.py +++ b/xero_python/finance/models/bank_statement_accounting_response.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/bank_statement_response.py b/xero_python/finance/models/bank_statement_response.py index fd21ff00..06f74f50 100644 --- a/xero_python/finance/models/bank_statement_response.py +++ b/xero_python/finance/models/bank_statement_response.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/bank_transaction_response.py b/xero_python/finance/models/bank_transaction_response.py index e94884bf..fbae0628 100644 --- a/xero_python/finance/models/bank_transaction_response.py +++ b/xero_python/finance/models/bank_transaction_response.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/cash_account_response.py b/xero_python/finance/models/cash_account_response.py index 6ee8c6e8..e9ef9042 100644 --- a/xero_python/finance/models/cash_account_response.py +++ b/xero_python/finance/models/cash_account_response.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/cash_balance.py b/xero_python/finance/models/cash_balance.py index 253e9c58..0ced0b21 100644 --- a/xero_python/finance/models/cash_balance.py +++ b/xero_python/finance/models/cash_balance.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/cash_validation_response.py b/xero_python/finance/models/cash_validation_response.py index a932b622..410973eb 100644 --- a/xero_python/finance/models/cash_validation_response.py +++ b/xero_python/finance/models/cash_validation_response.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/cashflow_account.py b/xero_python/finance/models/cashflow_account.py index 00bf4d17..eee6a2ec 100644 --- a/xero_python/finance/models/cashflow_account.py +++ b/xero_python/finance/models/cashflow_account.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/cashflow_activity.py b/xero_python/finance/models/cashflow_activity.py index f31a5575..2421bbc1 100644 --- a/xero_python/finance/models/cashflow_activity.py +++ b/xero_python/finance/models/cashflow_activity.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/cashflow_response.py b/xero_python/finance/models/cashflow_response.py index e2371ece..33f1044f 100644 --- a/xero_python/finance/models/cashflow_response.py +++ b/xero_python/finance/models/cashflow_response.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/cashflow_type.py b/xero_python/finance/models/cashflow_type.py index 8abba627..bf7274b5 100644 --- a/xero_python/finance/models/cashflow_type.py +++ b/xero_python/finance/models/cashflow_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/contact_detail.py b/xero_python/finance/models/contact_detail.py index 86c8b103..30552e10 100644 --- a/xero_python/finance/models/contact_detail.py +++ b/xero_python/finance/models/contact_detail.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/contact_response.py b/xero_python/finance/models/contact_response.py index 5b4ef8f4..a5bbaa3c 100644 --- a/xero_python/finance/models/contact_response.py +++ b/xero_python/finance/models/contact_response.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/contact_total_detail.py b/xero_python/finance/models/contact_total_detail.py index a1ac88e8..d49e6db6 100644 --- a/xero_python/finance/models/contact_total_detail.py +++ b/xero_python/finance/models/contact_total_detail.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/contact_total_other.py b/xero_python/finance/models/contact_total_other.py index c2ad5331..8de38cfe 100644 --- a/xero_python/finance/models/contact_total_other.py +++ b/xero_python/finance/models/contact_total_other.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/credit_note_response.py b/xero_python/finance/models/credit_note_response.py index a8c5cbf0..10824d3a 100644 --- a/xero_python/finance/models/credit_note_response.py +++ b/xero_python/finance/models/credit_note_response.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/current_statement_response.py b/xero_python/finance/models/current_statement_response.py index 363f3ee2..919d18a7 100644 --- a/xero_python/finance/models/current_statement_response.py +++ b/xero_python/finance/models/current_statement_response.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -198,7 +198,7 @@ def imported_date_time_utc(self, imported_date_time_utc): def import_source_type(self): """Gets the import_source_type of this CurrentStatementResponse. # noqa: E501 - Looking at the most recent bank statement, this field indicates the source of the data (direct bank feed, indirect bank feed, file upload, or manual keying). # noqa: E501 + Looking at the most recent bank statement, this field indicates the source of the data (direct bank feed, file upload, or manual keying). # noqa: E501 :return: The import_source_type of this CurrentStatementResponse. # noqa: E501 :rtype: str @@ -209,7 +209,7 @@ def import_source_type(self): def import_source_type(self, import_source_type): """Sets the import_source_type of this CurrentStatementResponse. - Looking at the most recent bank statement, this field indicates the source of the data (direct bank feed, indirect bank feed, file upload, or manual keying). # noqa: E501 + Looking at the most recent bank statement, this field indicates the source of the data (direct bank feed, file upload, or manual keying). # noqa: E501 :param import_source_type: The import_source_type of this CurrentStatementResponse. # noqa: E501 :type: str diff --git a/xero_python/finance/models/data_source_response.py b/xero_python/finance/models/data_source_response.py index a3b33ba6..1c78f6f4 100644 --- a/xero_python/finance/models/data_source_response.py +++ b/xero_python/finance/models/data_source_response.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -31,15 +31,12 @@ class DataSourceResponse(BaseModel): """ openapi_types = { "direct_bank_feed": "float", - "indirect_bank_feed": "float", "file_upload": "float", "manual": "float", "direct_bank_feed_pos": "float", - "indirect_bank_feed_pos": "float", "file_upload_pos": "float", "manual_pos": "float", "direct_bank_feed_neg": "float", - "indirect_bank_feed_neg": "float", "file_upload_neg": "float", "manual_neg": "float", "other_pos": "float", @@ -49,15 +46,12 @@ class DataSourceResponse(BaseModel): attribute_map = { "direct_bank_feed": "directBankFeed", - "indirect_bank_feed": "indirectBankFeed", "file_upload": "fileUpload", "manual": "manual", "direct_bank_feed_pos": "directBankFeedPos", - "indirect_bank_feed_pos": "indirectBankFeedPos", "file_upload_pos": "fileUploadPos", "manual_pos": "manualPos", "direct_bank_feed_neg": "directBankFeedNeg", - "indirect_bank_feed_neg": "indirectBankFeedNeg", "file_upload_neg": "fileUploadNeg", "manual_neg": "manualNeg", "other_pos": "otherPos", @@ -68,15 +62,12 @@ class DataSourceResponse(BaseModel): def __init__( self, direct_bank_feed=None, - indirect_bank_feed=None, file_upload=None, manual=None, direct_bank_feed_pos=None, - indirect_bank_feed_pos=None, file_upload_pos=None, manual_pos=None, direct_bank_feed_neg=None, - indirect_bank_feed_neg=None, file_upload_neg=None, manual_neg=None, other_pos=None, @@ -86,15 +77,12 @@ def __init__( """DataSourceResponse - a model defined in OpenAPI""" # noqa: E501 self._direct_bank_feed = None - self._indirect_bank_feed = None self._file_upload = None self._manual = None self._direct_bank_feed_pos = None - self._indirect_bank_feed_pos = None self._file_upload_pos = None self._manual_pos = None self._direct_bank_feed_neg = None - self._indirect_bank_feed_neg = None self._file_upload_neg = None self._manual_neg = None self._other_pos = None @@ -104,24 +92,18 @@ def __init__( if direct_bank_feed is not None: self.direct_bank_feed = direct_bank_feed - if indirect_bank_feed is not None: - self.indirect_bank_feed = indirect_bank_feed if file_upload is not None: self.file_upload = file_upload if manual is not None: self.manual = manual if direct_bank_feed_pos is not None: self.direct_bank_feed_pos = direct_bank_feed_pos - if indirect_bank_feed_pos is not None: - self.indirect_bank_feed_pos = indirect_bank_feed_pos if file_upload_pos is not None: self.file_upload_pos = file_upload_pos if manual_pos is not None: self.manual_pos = manual_pos if direct_bank_feed_neg is not None: self.direct_bank_feed_neg = direct_bank_feed_neg - if indirect_bank_feed_neg is not None: - self.indirect_bank_feed_neg = indirect_bank_feed_neg if file_upload_neg is not None: self.file_upload_neg = file_upload_neg if manual_neg is not None: @@ -137,7 +119,7 @@ def __init__( def direct_bank_feed(self): """Gets the direct_bank_feed of this DataSourceResponse. # noqa: E501 - Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero. This gives an indication on the certainty of correctness of the data. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration. This could be from a bank or aggregator. This gives an indication on the certainty of correctness of the data. # noqa: E501 :return: The direct_bank_feed of this DataSourceResponse. # noqa: E501 :rtype: float @@ -148,7 +130,7 @@ def direct_bank_feed(self): def direct_bank_feed(self, direct_bank_feed): """Sets the direct_bank_feed of this DataSourceResponse. - Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero. This gives an indication on the certainty of correctness of the data. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration. This could be from a bank or aggregator. This gives an indication on the certainty of correctness of the data. # noqa: E501 :param direct_bank_feed: The direct_bank_feed of this DataSourceResponse. # noqa: E501 :type: float @@ -156,34 +138,11 @@ def direct_bank_feed(self, direct_bank_feed): self._direct_bank_feed = direct_bank_feed - @property - def indirect_bank_feed(self): - """Gets the indirect_bank_feed of this DataSourceResponse. # noqa: E501 - - Sum of the amounts of all statement lines where the source of the data was a indirect bank feed to Xero (usually via Yodlee). This gives an indication on the certainty of correctness of the data. # noqa: E501 - - :return: The indirect_bank_feed of this DataSourceResponse. # noqa: E501 - :rtype: float - """ - return self._indirect_bank_feed - - @indirect_bank_feed.setter - def indirect_bank_feed(self, indirect_bank_feed): - """Sets the indirect_bank_feed of this DataSourceResponse. - - Sum of the amounts of all statement lines where the source of the data was a indirect bank feed to Xero (usually via Yodlee). This gives an indication on the certainty of correctness of the data. # noqa: E501 - - :param indirect_bank_feed: The indirect_bank_feed of this DataSourceResponse. # noqa: E501 - :type: float - """ - - self._indirect_bank_feed = indirect_bank_feed - @property def file_upload(self): """Gets the file_upload of this DataSourceResponse. # noqa: E501 - Sum of the amounts of all statement lines where the source of the data was a CSV file upload in to Xero. This gives an indication on the certainty of correctness of the data. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero. This gives an indication on the certainty of correctness of the data. # noqa: E501 :return: The file_upload of this DataSourceResponse. # noqa: E501 :rtype: float @@ -194,7 +153,7 @@ def file_upload(self): def file_upload(self, file_upload): """Sets the file_upload of this DataSourceResponse. - Sum of the amounts of all statement lines where the source of the data was a CSV file upload in to Xero. This gives an indication on the certainty of correctness of the data. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero. This gives an indication on the certainty of correctness of the data. # noqa: E501 :param file_upload: The file_upload of this DataSourceResponse. # noqa: E501 :type: float @@ -206,7 +165,7 @@ def file_upload(self, file_upload): def manual(self): """Gets the manual of this DataSourceResponse. # noqa: E501 - Sum of the amounts of all statement lines where the source of the data was manually keyed in to Xero. This gives an indication on the certainty of correctness of the data. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was manually input in to Xero. This gives an indication on the certainty of correctness of the data. # noqa: E501 :return: The manual of this DataSourceResponse. # noqa: E501 :rtype: float @@ -217,7 +176,7 @@ def manual(self): def manual(self, manual): """Sets the manual of this DataSourceResponse. - Sum of the amounts of all statement lines where the source of the data was manually keyed in to Xero. This gives an indication on the certainty of correctness of the data. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was manually input in to Xero. This gives an indication on the certainty of correctness of the data. # noqa: E501 :param manual: The manual of this DataSourceResponse. # noqa: E501 :type: float @@ -229,7 +188,7 @@ def manual(self, manual): def direct_bank_feed_pos(self): """Gets the direct_bank_feed_pos of this DataSourceResponse. # noqa: E501 - Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration. This could be from a bank or aggregator. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 :return: The direct_bank_feed_pos of this DataSourceResponse. # noqa: E501 :rtype: float @@ -240,7 +199,7 @@ def direct_bank_feed_pos(self): def direct_bank_feed_pos(self, direct_bank_feed_pos): """Sets the direct_bank_feed_pos of this DataSourceResponse. - Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration. This could be from a bank or aggregator. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 :param direct_bank_feed_pos: The direct_bank_feed_pos of this DataSourceResponse. # noqa: E501 :type: float @@ -248,34 +207,11 @@ def direct_bank_feed_pos(self, direct_bank_feed_pos): self._direct_bank_feed_pos = direct_bank_feed_pos - @property - def indirect_bank_feed_pos(self): - """Gets the indirect_bank_feed_pos of this DataSourceResponse. # noqa: E501 - - Sum of the amounts of all statement lines where the source of the data was a indirect bank feed to Xero (usually via Yodlee). This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 - - :return: The indirect_bank_feed_pos of this DataSourceResponse. # noqa: E501 - :rtype: float - """ - return self._indirect_bank_feed_pos - - @indirect_bank_feed_pos.setter - def indirect_bank_feed_pos(self, indirect_bank_feed_pos): - """Sets the indirect_bank_feed_pos of this DataSourceResponse. - - Sum of the amounts of all statement lines where the source of the data was a indirect bank feed to Xero (usually via Yodlee). This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 - - :param indirect_bank_feed_pos: The indirect_bank_feed_pos of this DataSourceResponse. # noqa: E501 - :type: float - """ - - self._indirect_bank_feed_pos = indirect_bank_feed_pos - @property def file_upload_pos(self): """Gets the file_upload_pos of this DataSourceResponse. # noqa: E501 - Sum of the amounts of all statement lines where the source of the data was a CSV file upload in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 :return: The file_upload_pos of this DataSourceResponse. # noqa: E501 :rtype: float @@ -286,7 +222,7 @@ def file_upload_pos(self): def file_upload_pos(self, file_upload_pos): """Sets the file_upload_pos of this DataSourceResponse. - Sum of the amounts of all statement lines where the source of the data was a CSV file upload in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 :param file_upload_pos: The file_upload_pos of this DataSourceResponse. # noqa: E501 :type: float @@ -298,7 +234,7 @@ def file_upload_pos(self, file_upload_pos): def manual_pos(self): """Gets the manual_pos of this DataSourceResponse. # noqa: E501 - Sum of the amounts of all statement lines where the source of the data was manually keyed in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was manually input in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 :return: The manual_pos of this DataSourceResponse. # noqa: E501 :rtype: float @@ -309,7 +245,7 @@ def manual_pos(self): def manual_pos(self, manual_pos): """Sets the manual_pos of this DataSourceResponse. - Sum of the amounts of all statement lines where the source of the data was manually keyed in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was manually input in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 :param manual_pos: The manual_pos of this DataSourceResponse. # noqa: E501 :type: float @@ -321,7 +257,7 @@ def manual_pos(self, manual_pos): def direct_bank_feed_neg(self): """Gets the direct_bank_feed_neg of this DataSourceResponse. # noqa: E501 - Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration. This could be from a bank or aggregator. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 :return: The direct_bank_feed_neg of this DataSourceResponse. # noqa: E501 :rtype: float @@ -332,7 +268,7 @@ def direct_bank_feed_neg(self): def direct_bank_feed_neg(self, direct_bank_feed_neg): """Sets the direct_bank_feed_neg of this DataSourceResponse. - Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration. This could be from a bank or aggregator. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 :param direct_bank_feed_neg: The direct_bank_feed_neg of this DataSourceResponse. # noqa: E501 :type: float @@ -340,34 +276,11 @@ def direct_bank_feed_neg(self, direct_bank_feed_neg): self._direct_bank_feed_neg = direct_bank_feed_neg - @property - def indirect_bank_feed_neg(self): - """Gets the indirect_bank_feed_neg of this DataSourceResponse. # noqa: E501 - - Sum of the amounts of all statement lines where the source of the data was a indirect bank feed to Xero (usually via Yodlee). This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 - - :return: The indirect_bank_feed_neg of this DataSourceResponse. # noqa: E501 - :rtype: float - """ - return self._indirect_bank_feed_neg - - @indirect_bank_feed_neg.setter - def indirect_bank_feed_neg(self, indirect_bank_feed_neg): - """Sets the indirect_bank_feed_neg of this DataSourceResponse. - - Sum of the amounts of all statement lines where the source of the data was a indirect bank feed to Xero (usually via Yodlee). This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 - - :param indirect_bank_feed_neg: The indirect_bank_feed_neg of this DataSourceResponse. # noqa: E501 - :type: float - """ - - self._indirect_bank_feed_neg = indirect_bank_feed_neg - @property def file_upload_neg(self): """Gets the file_upload_neg of this DataSourceResponse. # noqa: E501 - Sum of the amounts of all statement lines where the source of the data was a CSV file upload in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 :return: The file_upload_neg of this DataSourceResponse. # noqa: E501 :rtype: float @@ -378,7 +291,7 @@ def file_upload_neg(self): def file_upload_neg(self, file_upload_neg): """Sets the file_upload_neg of this DataSourceResponse. - Sum of the amounts of all statement lines where the source of the data was a CSV file upload in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 :param file_upload_neg: The file_upload_neg of this DataSourceResponse. # noqa: E501 :type: float @@ -390,7 +303,7 @@ def file_upload_neg(self, file_upload_neg): def manual_neg(self): """Gets the manual_neg of this DataSourceResponse. # noqa: E501 - Sum of the amounts of all statement lines where the source of the data was manually keyed in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was manually input in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 :return: The manual_neg of this DataSourceResponse. # noqa: E501 :rtype: float @@ -401,7 +314,7 @@ def manual_neg(self): def manual_neg(self, manual_neg): """Sets the manual_neg of this DataSourceResponse. - Sum of the amounts of all statement lines where the source of the data was manually keyed in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was manually input in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 :param manual_neg: The manual_neg of this DataSourceResponse. # noqa: E501 :type: float @@ -413,7 +326,7 @@ def manual_neg(self, manual_neg): def other_pos(self): """Gets the other_pos of this DataSourceResponse. # noqa: E501 - Sum of the amounts of all statement lines where the source of the data was any other category. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was unknown. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 :return: The other_pos of this DataSourceResponse. # noqa: E501 :rtype: float @@ -424,7 +337,7 @@ def other_pos(self): def other_pos(self, other_pos): """Sets the other_pos of this DataSourceResponse. - Sum of the amounts of all statement lines where the source of the data was any other category. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was unknown. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 :param other_pos: The other_pos of this DataSourceResponse. # noqa: E501 :type: float @@ -436,7 +349,7 @@ def other_pos(self, other_pos): def other_neg(self): """Gets the other_neg of this DataSourceResponse. # noqa: E501 - Sum of the amounts of all statement lines where the source of the data was any other category. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was unknown. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 :return: The other_neg of this DataSourceResponse. # noqa: E501 :rtype: float @@ -447,7 +360,7 @@ def other_neg(self): def other_neg(self, other_neg): """Sets the other_neg of this DataSourceResponse. - Sum of the amounts of all statement lines where the source of the data was any other category. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was unknown. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 :param other_neg: The other_neg of this DataSourceResponse. # noqa: E501 :type: float @@ -459,7 +372,7 @@ def other_neg(self, other_neg): def other(self): """Gets the other of this DataSourceResponse. # noqa: E501 - Sum of the amounts of all statement lines where the source of the data was any other category. This gives an indication on the certainty of correctness of the data. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was unknown. This gives an indication on the certainty of correctness of the data. # noqa: E501 :return: The other of this DataSourceResponse. # noqa: E501 :rtype: float @@ -470,7 +383,7 @@ def other(self): def other(self, other): """Sets the other of this DataSourceResponse. - Sum of the amounts of all statement lines where the source of the data was any other category. This gives an indication on the certainty of correctness of the data. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was unknown. This gives an indication on the certainty of correctness of the data. # noqa: E501 :param other: The other of this DataSourceResponse. # noqa: E501 :type: float diff --git a/xero_python/finance/models/history_record_response.py b/xero_python/finance/models/history_record_response.py deleted file mode 100644 index 513e9e03..00000000 --- a/xero_python/finance/models/history_record_response.py +++ /dev/null @@ -1,184 +0,0 @@ -# coding: utf-8 - -""" - Xero Finance API - - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - - Contact: api@xero.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 - -from xero_python.models import BaseModel - - -class HistoryRecordResponse(BaseModel): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - """ - Attributes: - openapi_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - openapi_types = { - "changes": "str", - "date_utc_string": "str", - "date_utc": "datetime", - "user": "str", - "details": "str", - } - - attribute_map = { - "changes": "changes", - "date_utc_string": "dateUTCString", - "date_utc": "dateUTC", - "user": "user", - "details": "details", - } - - def __init__( - self, changes=None, date_utc_string=None, date_utc=None, user=None, details=None - ): # noqa: E501 - """HistoryRecordResponse - a model defined in OpenAPI""" # noqa: E501 - - self._changes = None - self._date_utc_string = None - self._date_utc = None - self._user = None - self._details = None - self.discriminator = None - - if changes is not None: - self.changes = changes - if date_utc_string is not None: - self.date_utc_string = date_utc_string - if date_utc is not None: - self.date_utc = date_utc - if user is not None: - self.user = user - if details is not None: - self.details = details - - @property - def changes(self): - """Gets the changes of this HistoryRecordResponse. # noqa: E501 - - The type of change recorded against the document # noqa: E501 - - :return: The changes of this HistoryRecordResponse. # noqa: E501 - :rtype: str - """ - return self._changes - - @changes.setter - def changes(self, changes): - """Sets the changes of this HistoryRecordResponse. - - The type of change recorded against the document # noqa: E501 - - :param changes: The changes of this HistoryRecordResponse. # noqa: E501 - :type: str - """ - - self._changes = changes - - @property - def date_utc_string(self): - """Gets the date_utc_string of this HistoryRecordResponse. # noqa: E501 - - UTC date that the history record was created # noqa: E501 - - :return: The date_utc_string of this HistoryRecordResponse. # noqa: E501 - :rtype: str - """ - return self._date_utc_string - - @date_utc_string.setter - def date_utc_string(self, date_utc_string): - """Sets the date_utc_string of this HistoryRecordResponse. - - UTC date that the history record was created # noqa: E501 - - :param date_utc_string: The date_utc_string of this HistoryRecordResponse. # noqa: E501 - :type: str - """ - - self._date_utc_string = date_utc_string - - @property - def date_utc(self): - """Gets the date_utc of this HistoryRecordResponse. # noqa: E501 - - UTC date that the history record was created # noqa: E501 - - :return: The date_utc of this HistoryRecordResponse. # noqa: E501 - :rtype: datetime - """ - return self._date_utc - - @date_utc.setter - def date_utc(self, date_utc): - """Sets the date_utc of this HistoryRecordResponse. - - UTC date that the history record was created # noqa: E501 - - :param date_utc: The date_utc of this HistoryRecordResponse. # noqa: E501 - :type: datetime - """ - - self._date_utc = date_utc - - @property - def user(self): - """Gets the user of this HistoryRecordResponse. # noqa: E501 - - The users first and last name # noqa: E501 - - :return: The user of this HistoryRecordResponse. # noqa: E501 - :rtype: str - """ - return self._user - - @user.setter - def user(self, user): - """Sets the user of this HistoryRecordResponse. - - The users first and last name # noqa: E501 - - :param user: The user of this HistoryRecordResponse. # noqa: E501 - :type: str - """ - - self._user = user - - @property - def details(self): - """Gets the details of this HistoryRecordResponse. # noqa: E501 - - Description of the change event or transaction # noqa: E501 - - :return: The details of this HistoryRecordResponse. # noqa: E501 - :rtype: str - """ - return self._details - - @details.setter - def details(self, details): - """Sets the details of this HistoryRecordResponse. - - Description of the change event or transaction # noqa: E501 - - :param details: The details of this HistoryRecordResponse. # noqa: E501 - :type: str - """ - - self._details = details diff --git a/xero_python/finance/models/income_by_contact_response.py b/xero_python/finance/models/income_by_contact_response.py index 5918562a..da3f59c3 100644 --- a/xero_python/finance/models/income_by_contact_response.py +++ b/xero_python/finance/models/income_by_contact_response.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/invoice_response.py b/xero_python/finance/models/invoice_response.py index 8224926c..0ac4697d 100644 --- a/xero_python/finance/models/invoice_response.py +++ b/xero_python/finance/models/invoice_response.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/line_item_response.py b/xero_python/finance/models/line_item_response.py index 93037db3..83efbf47 100644 --- a/xero_python/finance/models/line_item_response.py +++ b/xero_python/finance/models/line_item_response.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/lock_history_model.py b/xero_python/finance/models/lock_history_model.py deleted file mode 100644 index f9195bc9..00000000 --- a/xero_python/finance/models/lock_history_model.py +++ /dev/null @@ -1,128 +0,0 @@ -# coding: utf-8 - -""" - Xero Finance API - - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - - Contact: api@xero.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 - -from xero_python.models import BaseModel - - -class LockHistoryModel(BaseModel): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - """ - Attributes: - openapi_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - openapi_types = { - "hard_lock_date": "date", - "soft_lock_date": "date", - "updated_date_utc": "datetime", - } - - attribute_map = { - "hard_lock_date": "hardLockDate", - "soft_lock_date": "softLockDate", - "updated_date_utc": "updatedDateUtc", - } - - def __init__( - self, hard_lock_date=None, soft_lock_date=None, updated_date_utc=None - ): # noqa: E501 - """LockHistoryModel - a model defined in OpenAPI""" # noqa: E501 - - self._hard_lock_date = None - self._soft_lock_date = None - self._updated_date_utc = None - self.discriminator = None - - if hard_lock_date is not None: - self.hard_lock_date = hard_lock_date - if soft_lock_date is not None: - self.soft_lock_date = soft_lock_date - if updated_date_utc is not None: - self.updated_date_utc = updated_date_utc - - @property - def hard_lock_date(self): - """Gets the hard_lock_date of this LockHistoryModel. # noqa: E501 - - Date the account hard lock was set # noqa: E501 - - :return: The hard_lock_date of this LockHistoryModel. # noqa: E501 - :rtype: date - """ - return self._hard_lock_date - - @hard_lock_date.setter - def hard_lock_date(self, hard_lock_date): - """Sets the hard_lock_date of this LockHistoryModel. - - Date the account hard lock was set # noqa: E501 - - :param hard_lock_date: The hard_lock_date of this LockHistoryModel. # noqa: E501 - :type: date - """ - - self._hard_lock_date = hard_lock_date - - @property - def soft_lock_date(self): - """Gets the soft_lock_date of this LockHistoryModel. # noqa: E501 - - Date the account soft lock was set # noqa: E501 - - :return: The soft_lock_date of this LockHistoryModel. # noqa: E501 - :rtype: date - """ - return self._soft_lock_date - - @soft_lock_date.setter - def soft_lock_date(self, soft_lock_date): - """Sets the soft_lock_date of this LockHistoryModel. - - Date the account soft lock was set # noqa: E501 - - :param soft_lock_date: The soft_lock_date of this LockHistoryModel. # noqa: E501 - :type: date - """ - - self._soft_lock_date = soft_lock_date - - @property - def updated_date_utc(self): - """Gets the updated_date_utc of this LockHistoryModel. # noqa: E501 - - The system date time that the lock was updated # noqa: E501 - - :return: The updated_date_utc of this LockHistoryModel. # noqa: E501 - :rtype: datetime - """ - return self._updated_date_utc - - @updated_date_utc.setter - def updated_date_utc(self, updated_date_utc): - """Sets the updated_date_utc of this LockHistoryModel. - - The system date time that the lock was updated # noqa: E501 - - :param updated_date_utc: The updated_date_utc of this LockHistoryModel. # noqa: E501 - :type: datetime - """ - - self._updated_date_utc = updated_date_utc diff --git a/xero_python/finance/models/lock_history_response.py b/xero_python/finance/models/lock_history_response.py deleted file mode 100644 index ce7b3477..00000000 --- a/xero_python/finance/models/lock_history_response.py +++ /dev/null @@ -1,126 +0,0 @@ -# coding: utf-8 - -""" - Xero Finance API - - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - - Contact: api@xero.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 - -from xero_python.models import BaseModel - - -class LockHistoryResponse(BaseModel): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - """ - Attributes: - openapi_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - openapi_types = { - "organisation_id": "str", - "end_date": "date", - "lock_dates": "list[LockHistoryModel]", - } - - attribute_map = { - "organisation_id": "organisationId", - "end_date": "endDate", - "lock_dates": "lockDates", - } - - def __init__( - self, organisation_id=None, end_date=None, lock_dates=None - ): # noqa: E501 - """LockHistoryResponse - a model defined in OpenAPI""" # noqa: E501 - - self._organisation_id = None - self._end_date = None - self._lock_dates = None - self.discriminator = None - - if organisation_id is not None: - self.organisation_id = organisation_id - if end_date is not None: - self.end_date = end_date - if lock_dates is not None: - self.lock_dates = lock_dates - - @property - def organisation_id(self): - """Gets the organisation_id of this LockHistoryResponse. # noqa: E501 - - The requested Organisation to which the data pertains # noqa: E501 - - :return: The organisation_id of this LockHistoryResponse. # noqa: E501 - :rtype: str - """ - return self._organisation_id - - @organisation_id.setter - def organisation_id(self, organisation_id): - """Sets the organisation_id of this LockHistoryResponse. - - The requested Organisation to which the data pertains # noqa: E501 - - :param organisation_id: The organisation_id of this LockHistoryResponse. # noqa: E501 - :type: str - """ - - self._organisation_id = organisation_id - - @property - def end_date(self): - """Gets the end_date of this LockHistoryResponse. # noqa: E501 - - The end date of the report # noqa: E501 - - :return: The end_date of this LockHistoryResponse. # noqa: E501 - :rtype: date - """ - return self._end_date - - @end_date.setter - def end_date(self, end_date): - """Sets the end_date of this LockHistoryResponse. - - The end date of the report # noqa: E501 - - :param end_date: The end_date of this LockHistoryResponse. # noqa: E501 - :type: date - """ - - self._end_date = end_date - - @property - def lock_dates(self): - """Gets the lock_dates of this LockHistoryResponse. # noqa: E501 - - - :return: The lock_dates of this LockHistoryResponse. # noqa: E501 - :rtype: list[LockHistoryModel] - """ - return self._lock_dates - - @lock_dates.setter - def lock_dates(self, lock_dates): - """Sets the lock_dates of this LockHistoryResponse. - - - :param lock_dates: The lock_dates of this LockHistoryResponse. # noqa: E501 - :type: list[LockHistoryModel] - """ - - self._lock_dates = lock_dates diff --git a/xero_python/finance/models/manual_journal_total.py b/xero_python/finance/models/manual_journal_total.py index 37aaba2a..8156beac 100644 --- a/xero_python/finance/models/manual_journal_total.py +++ b/xero_python/finance/models/manual_journal_total.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/overpayment_response.py b/xero_python/finance/models/overpayment_response.py index 86dc5c53..936a9c70 100644 --- a/xero_python/finance/models/overpayment_response.py +++ b/xero_python/finance/models/overpayment_response.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/payment_response.py b/xero_python/finance/models/payment_response.py index d1e08441..63574228 100644 --- a/xero_python/finance/models/payment_response.py +++ b/xero_python/finance/models/payment_response.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/pnl_account.py b/xero_python/finance/models/pnl_account.py index b37a0288..528260ce 100644 --- a/xero_python/finance/models/pnl_account.py +++ b/xero_python/finance/models/pnl_account.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/pnl_account_class.py b/xero_python/finance/models/pnl_account_class.py index 9dc26d97..31680d78 100644 --- a/xero_python/finance/models/pnl_account_class.py +++ b/xero_python/finance/models/pnl_account_class.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/pnl_account_type.py b/xero_python/finance/models/pnl_account_type.py index f7f36048..e2a276d5 100644 --- a/xero_python/finance/models/pnl_account_type.py +++ b/xero_python/finance/models/pnl_account_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/practice_response.py b/xero_python/finance/models/practice_response.py deleted file mode 100644 index 4b94e178..00000000 --- a/xero_python/finance/models/practice_response.py +++ /dev/null @@ -1,189 +0,0 @@ -# coding: utf-8 - -""" - Xero Finance API - - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - - Contact: api@xero.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 - -from xero_python.models import BaseModel - - -class PracticeResponse(BaseModel): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - """ - Attributes: - openapi_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - openapi_types = { - "xero_partner_since": "int", - "tier": "str", - "location": "str", - "organisation_count": "int", - "staff_certified": "bool", - } - - attribute_map = { - "xero_partner_since": "xeroPartnerSince", - "tier": "tier", - "location": "location", - "organisation_count": "organisationCount", - "staff_certified": "staffCertified", - } - - def __init__( - self, - xero_partner_since=None, - tier=None, - location=None, - organisation_count=None, - staff_certified=None, - ): # noqa: E501 - """PracticeResponse - a model defined in OpenAPI""" # noqa: E501 - - self._xero_partner_since = None - self._tier = None - self._location = None - self._organisation_count = None - self._staff_certified = None - self.discriminator = None - - if xero_partner_since is not None: - self.xero_partner_since = xero_partner_since - if tier is not None: - self.tier = tier - if location is not None: - self.location = location - if organisation_count is not None: - self.organisation_count = organisation_count - if staff_certified is not None: - self.staff_certified = staff_certified - - @property - def xero_partner_since(self): - """Gets the xero_partner_since of this PracticeResponse. # noqa: E501 - - Year of becoming a partner. # noqa: E501 - - :return: The xero_partner_since of this PracticeResponse. # noqa: E501 - :rtype: int - """ - return self._xero_partner_since - - @xero_partner_since.setter - def xero_partner_since(self, xero_partner_since): - """Sets the xero_partner_since of this PracticeResponse. - - Year of becoming a partner. # noqa: E501 - - :param xero_partner_since: The xero_partner_since of this PracticeResponse. # noqa: E501 - :type: int - """ - - self._xero_partner_since = xero_partner_since - - @property - def tier(self): - """Gets the tier of this PracticeResponse. # noqa: E501 - - Customer tier e.g. Silver # noqa: E501 - - :return: The tier of this PracticeResponse. # noqa: E501 - :rtype: str - """ - return self._tier - - @tier.setter - def tier(self, tier): - """Sets the tier of this PracticeResponse. - - Customer tier e.g. Silver # noqa: E501 - - :param tier: The tier of this PracticeResponse. # noqa: E501 - :type: str - """ - - self._tier = tier - - @property - def location(self): - """Gets the location of this PracticeResponse. # noqa: E501 - - Country of location. # noqa: E501 - - :return: The location of this PracticeResponse. # noqa: E501 - :rtype: str - """ - return self._location - - @location.setter - def location(self, location): - """Sets the location of this PracticeResponse. - - Country of location. # noqa: E501 - - :param location: The location of this PracticeResponse. # noqa: E501 - :type: str - """ - - self._location = location - - @property - def organisation_count(self): - """Gets the organisation_count of this PracticeResponse. # noqa: E501 - - Organisation count. # noqa: E501 - - :return: The organisation_count of this PracticeResponse. # noqa: E501 - :rtype: int - """ - return self._organisation_count - - @organisation_count.setter - def organisation_count(self, organisation_count): - """Sets the organisation_count of this PracticeResponse. - - Organisation count. # noqa: E501 - - :param organisation_count: The organisation_count of this PracticeResponse. # noqa: E501 - :type: int - """ - - self._organisation_count = organisation_count - - @property - def staff_certified(self): - """Gets the staff_certified of this PracticeResponse. # noqa: E501 - - Staff certified (true/false). # noqa: E501 - - :return: The staff_certified of this PracticeResponse. # noqa: E501 - :rtype: bool - """ - return self._staff_certified - - @staff_certified.setter - def staff_certified(self, staff_certified): - """Sets the staff_certified of this PracticeResponse. - - Staff certified (true/false). # noqa: E501 - - :param staff_certified: The staff_certified of this PracticeResponse. # noqa: E501 - :type: bool - """ - - self._staff_certified = staff_certified diff --git a/xero_python/finance/models/prepayment_response.py b/xero_python/finance/models/prepayment_response.py index d026b8da..26068a8b 100644 --- a/xero_python/finance/models/prepayment_response.py +++ b/xero_python/finance/models/prepayment_response.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/problem.py b/xero_python/finance/models/problem.py index 613c1721..4a3e2905 100644 --- a/xero_python/finance/models/problem.py +++ b/xero_python/finance/models/problem.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/problem_type.py b/xero_python/finance/models/problem_type.py index da37dac4..e946277e 100644 --- a/xero_python/finance/models/problem_type.py +++ b/xero_python/finance/models/problem_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -34,3 +34,4 @@ class ProblemType(Enum): REQUEST_TIMEOUT = "request-timeout" SERVICE_UNAVAILABLE = "service-unavailable" UNAUTHORIZED = "unauthorized" + RATE_LIMIT_ERROR = "rate-limit-error" diff --git a/xero_python/finance/models/profit_and_loss_response.py b/xero_python/finance/models/profit_and_loss_response.py index 8169e792..b9ce5c40 100644 --- a/xero_python/finance/models/profit_and_loss_response.py +++ b/xero_python/finance/models/profit_and_loss_response.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/report_history_model.py b/xero_python/finance/models/report_history_model.py deleted file mode 100644 index f7ee8d1d..00000000 --- a/xero_python/finance/models/report_history_model.py +++ /dev/null @@ -1,128 +0,0 @@ -# coding: utf-8 - -""" - Xero Finance API - - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - - Contact: api@xero.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 - -from xero_python.models import BaseModel - - -class ReportHistoryModel(BaseModel): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - """ - Attributes: - openapi_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - openapi_types = { - "report_name": "str", - "report_date_text": "str", - "published_date_utc": "datetime", - } - - attribute_map = { - "report_name": "reportName", - "report_date_text": "reportDateText", - "published_date_utc": "publishedDateUtc", - } - - def __init__( - self, report_name=None, report_date_text=None, published_date_utc=None - ): # noqa: E501 - """ReportHistoryModel - a model defined in OpenAPI""" # noqa: E501 - - self._report_name = None - self._report_date_text = None - self._published_date_utc = None - self.discriminator = None - - if report_name is not None: - self.report_name = report_name - if report_date_text is not None: - self.report_date_text = report_date_text - if published_date_utc is not None: - self.published_date_utc = published_date_utc - - @property - def report_name(self): - """Gets the report_name of this ReportHistoryModel. # noqa: E501 - - Report code or report title # noqa: E501 - - :return: The report_name of this ReportHistoryModel. # noqa: E501 - :rtype: str - """ - return self._report_name - - @report_name.setter - def report_name(self, report_name): - """Sets the report_name of this ReportHistoryModel. - - Report code or report title # noqa: E501 - - :param report_name: The report_name of this ReportHistoryModel. # noqa: E501 - :type: str - """ - - self._report_name = report_name - - @property - def report_date_text(self): - """Gets the report_date_text of this ReportHistoryModel. # noqa: E501 - - The date or date range of the report # noqa: E501 - - :return: The report_date_text of this ReportHistoryModel. # noqa: E501 - :rtype: str - """ - return self._report_date_text - - @report_date_text.setter - def report_date_text(self, report_date_text): - """Sets the report_date_text of this ReportHistoryModel. - - The date or date range of the report # noqa: E501 - - :param report_date_text: The report_date_text of this ReportHistoryModel. # noqa: E501 - :type: str - """ - - self._report_date_text = report_date_text - - @property - def published_date_utc(self): - """Gets the published_date_utc of this ReportHistoryModel. # noqa: E501 - - The system date time that the report was published # noqa: E501 - - :return: The published_date_utc of this ReportHistoryModel. # noqa: E501 - :rtype: datetime - """ - return self._published_date_utc - - @published_date_utc.setter - def published_date_utc(self, published_date_utc): - """Sets the published_date_utc of this ReportHistoryModel. - - The system date time that the report was published # noqa: E501 - - :param published_date_utc: The published_date_utc of this ReportHistoryModel. # noqa: E501 - :type: datetime - """ - - self._published_date_utc = published_date_utc diff --git a/xero_python/finance/models/report_history_response.py b/xero_python/finance/models/report_history_response.py deleted file mode 100644 index 8e85616f..00000000 --- a/xero_python/finance/models/report_history_response.py +++ /dev/null @@ -1,124 +0,0 @@ -# coding: utf-8 - -""" - Xero Finance API - - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - - Contact: api@xero.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 - -from xero_python.models import BaseModel - - -class ReportHistoryResponse(BaseModel): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - """ - Attributes: - openapi_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - openapi_types = { - "organisation_id": "str", - "end_date": "date", - "reports": "list[ReportHistoryModel]", - } - - attribute_map = { - "organisation_id": "organisationId", - "end_date": "endDate", - "reports": "reports", - } - - def __init__(self, organisation_id=None, end_date=None, reports=None): # noqa: E501 - """ReportHistoryResponse - a model defined in OpenAPI""" # noqa: E501 - - self._organisation_id = None - self._end_date = None - self._reports = None - self.discriminator = None - - if organisation_id is not None: - self.organisation_id = organisation_id - if end_date is not None: - self.end_date = end_date - if reports is not None: - self.reports = reports - - @property - def organisation_id(self): - """Gets the organisation_id of this ReportHistoryResponse. # noqa: E501 - - The requested Organisation to which the data pertains # noqa: E501 - - :return: The organisation_id of this ReportHistoryResponse. # noqa: E501 - :rtype: str - """ - return self._organisation_id - - @organisation_id.setter - def organisation_id(self, organisation_id): - """Sets the organisation_id of this ReportHistoryResponse. - - The requested Organisation to which the data pertains # noqa: E501 - - :param organisation_id: The organisation_id of this ReportHistoryResponse. # noqa: E501 - :type: str - """ - - self._organisation_id = organisation_id - - @property - def end_date(self): - """Gets the end_date of this ReportHistoryResponse. # noqa: E501 - - The end date of the report # noqa: E501 - - :return: The end_date of this ReportHistoryResponse. # noqa: E501 - :rtype: date - """ - return self._end_date - - @end_date.setter - def end_date(self, end_date): - """Sets the end_date of this ReportHistoryResponse. - - The end date of the report # noqa: E501 - - :param end_date: The end_date of this ReportHistoryResponse. # noqa: E501 - :type: date - """ - - self._end_date = end_date - - @property - def reports(self): - """Gets the reports of this ReportHistoryResponse. # noqa: E501 - - - :return: The reports of this ReportHistoryResponse. # noqa: E501 - :rtype: list[ReportHistoryModel] - """ - return self._reports - - @reports.setter - def reports(self, reports): - """Sets the reports of this ReportHistoryResponse. - - - :param reports: The reports of this ReportHistoryResponse. # noqa: E501 - :type: list[ReportHistoryModel] - """ - - self._reports = reports diff --git a/xero_python/finance/models/statement_balance_response.py b/xero_python/finance/models/statement_balance_response.py index 4de40c34..6399e03c 100644 --- a/xero_python/finance/models/statement_balance_response.py +++ b/xero_python/finance/models/statement_balance_response.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/statement_line_response.py b/xero_python/finance/models/statement_line_response.py index 027e1c78..b2cbbea9 100644 --- a/xero_python/finance/models/statement_line_response.py +++ b/xero_python/finance/models/statement_line_response.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -32,6 +32,7 @@ class StatementLineResponse(BaseModel): openapi_types = { "statement_line_id": "str", "posted_date": "date", + "payee": "str", "reference": "str", "notes": "str", "cheque_no": "str", @@ -48,6 +49,7 @@ class StatementLineResponse(BaseModel): attribute_map = { "statement_line_id": "statementLineId", "posted_date": "postedDate", + "payee": "payee", "reference": "reference", "notes": "notes", "cheque_no": "chequeNo", @@ -65,6 +67,7 @@ def __init__( self, statement_line_id=None, posted_date=None, + payee=None, reference=None, notes=None, cheque_no=None, @@ -81,6 +84,7 @@ def __init__( self._statement_line_id = None self._posted_date = None + self._payee = None self._reference = None self._notes = None self._cheque_no = None @@ -98,6 +102,8 @@ def __init__( self.statement_line_id = statement_line_id if posted_date is not None: self.posted_date = posted_date + if payee is not None: + self.payee = payee if reference is not None: self.reference = reference if notes is not None: @@ -167,6 +173,29 @@ def posted_date(self, posted_date): self._posted_date = posted_date + @property + def payee(self): + """Gets the payee of this StatementLineResponse. # noqa: E501 + + Payee description of statement line # noqa: E501 + + :return: The payee of this StatementLineResponse. # noqa: E501 + :rtype: str + """ + return self._payee + + @payee.setter + def payee(self, payee): + """Sets the payee of this StatementLineResponse. + + Payee description of statement line # noqa: E501 + + :param payee: The payee of this StatementLineResponse. # noqa: E501 + :type: str + """ + + self._payee = payee + @property def reference(self): """Gets the reference of this StatementLineResponse. # noqa: E501 diff --git a/xero_python/finance/models/statement_lines_response.py b/xero_python/finance/models/statement_lines_response.py index 2d70d6c2..8bf59235 100644 --- a/xero_python/finance/models/statement_lines_response.py +++ b/xero_python/finance/models/statement_lines_response.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/statement_response.py b/xero_python/finance/models/statement_response.py index d521898a..8a546986 100644 --- a/xero_python/finance/models/statement_response.py +++ b/xero_python/finance/models/statement_response.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -35,6 +35,10 @@ class StatementResponse(BaseModel): "end_date": "date", "imported_date_time_utc": "datetime", "import_source": "str", + "start_balance": "float", + "end_balance": "float", + "indicative_start_balance": "float", + "indicative_end_balance": "float", "statement_lines": "list[StatementLineResponse]", } @@ -44,6 +48,10 @@ class StatementResponse(BaseModel): "end_date": "endDate", "imported_date_time_utc": "importedDateTimeUtc", "import_source": "importSource", + "start_balance": "startBalance", + "end_balance": "endBalance", + "indicative_start_balance": "indicativeStartBalance", + "indicative_end_balance": "indicativeEndBalance", "statement_lines": "statementLines", } @@ -54,6 +62,10 @@ def __init__( end_date=None, imported_date_time_utc=None, import_source=None, + start_balance=None, + end_balance=None, + indicative_start_balance=None, + indicative_end_balance=None, statement_lines=None, ): # noqa: E501 """StatementResponse - a model defined in OpenAPI""" # noqa: E501 @@ -63,6 +75,10 @@ def __init__( self._end_date = None self._imported_date_time_utc = None self._import_source = None + self._start_balance = None + self._end_balance = None + self._indicative_start_balance = None + self._indicative_end_balance = None self._statement_lines = None self.discriminator = None @@ -76,6 +92,14 @@ def __init__( self.imported_date_time_utc = imported_date_time_utc if import_source is not None: self.import_source = import_source + if start_balance is not None: + self.start_balance = start_balance + if end_balance is not None: + self.end_balance = end_balance + if indicative_start_balance is not None: + self.indicative_start_balance = indicative_start_balance + if indicative_end_balance is not None: + self.indicative_end_balance = indicative_end_balance if statement_lines is not None: self.statement_lines = statement_lines @@ -175,7 +199,7 @@ def imported_date_time_utc(self, imported_date_time_utc): def import_source(self): """Gets the import_source of this StatementResponse. # noqa: E501 - Import source of statement (STMTIMPORTSRC/MANUAL, STMTIMPORTSRC/CSV, STMTIMPORTSRC/QIF, STMTIMPORTSRC/OFX, XeroApi) # noqa: E501 + Identifies where the statement data in Xero was sourced, 1) direct bank feed, automatically loaded from the bank (eg STMTIMPORTSRC/CBAFEED); 2) indirect bank feed, automatically loaded from a 3rd party provider (eg STMTIMPORTSRC/YODLEE); 3) manually uploaded bank feed (eg STMTIMPORTSRC/CSV) or 4) manually entered statement data (STMTIMPORTSRC/MANUAL). # noqa: E501 :return: The import_source of this StatementResponse. # noqa: E501 :rtype: str @@ -186,7 +210,7 @@ def import_source(self): def import_source(self, import_source): """Sets the import_source of this StatementResponse. - Import source of statement (STMTIMPORTSRC/MANUAL, STMTIMPORTSRC/CSV, STMTIMPORTSRC/QIF, STMTIMPORTSRC/OFX, XeroApi) # noqa: E501 + Identifies where the statement data in Xero was sourced, 1) direct bank feed, automatically loaded from the bank (eg STMTIMPORTSRC/CBAFEED); 2) indirect bank feed, automatically loaded from a 3rd party provider (eg STMTIMPORTSRC/YODLEE); 3) manually uploaded bank feed (eg STMTIMPORTSRC/CSV) or 4) manually entered statement data (STMTIMPORTSRC/MANUAL). # noqa: E501 :param import_source: The import_source of this StatementResponse. # noqa: E501 :type: str @@ -194,6 +218,98 @@ def import_source(self, import_source): self._import_source = import_source + @property + def start_balance(self): + """Gets the start_balance of this StatementResponse. # noqa: E501 + + Opening balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied. Where not supplied, the value will be 0. # noqa: E501 + + :return: The start_balance of this StatementResponse. # noqa: E501 + :rtype: float + """ + return self._start_balance + + @start_balance.setter + def start_balance(self, start_balance): + """Sets the start_balance of this StatementResponse. + + Opening balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied. Where not supplied, the value will be 0. # noqa: E501 + + :param start_balance: The start_balance of this StatementResponse. # noqa: E501 + :type: float + """ + + self._start_balance = start_balance + + @property + def end_balance(self): + """Gets the end_balance of this StatementResponse. # noqa: E501 + + Closing balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied. Where not supplied, the value will be 0. # noqa: E501 + + :return: The end_balance of this StatementResponse. # noqa: E501 + :rtype: float + """ + return self._end_balance + + @end_balance.setter + def end_balance(self, end_balance): + """Sets the end_balance of this StatementResponse. + + Closing balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied. Where not supplied, the value will be 0. # noqa: E501 + + :param end_balance: The end_balance of this StatementResponse. # noqa: E501 + :type: float + """ + + self._end_balance = end_balance + + @property + def indicative_start_balance(self): + """Gets the indicative_start_balance of this StatementResponse. # noqa: E501 + + Opening statement balance calculated in Xero (= bank account conversion balance plus sum of imported bank statement lines). Note: If indicative statement balance doesn't match imported statement balance for the same date, either the conversion (opening at inception) balance in Xero is wrong or there's an error in the bank statement lines in Xero. Ref: https://central.xero.com/s/article/Compare-the-statement-balance-in-Xero-to-your-actual-bank-balance?userregion=true # noqa: E501 + + :return: The indicative_start_balance of this StatementResponse. # noqa: E501 + :rtype: float + """ + return self._indicative_start_balance + + @indicative_start_balance.setter + def indicative_start_balance(self, indicative_start_balance): + """Sets the indicative_start_balance of this StatementResponse. + + Opening statement balance calculated in Xero (= bank account conversion balance plus sum of imported bank statement lines). Note: If indicative statement balance doesn't match imported statement balance for the same date, either the conversion (opening at inception) balance in Xero is wrong or there's an error in the bank statement lines in Xero. Ref: https://central.xero.com/s/article/Compare-the-statement-balance-in-Xero-to-your-actual-bank-balance?userregion=true # noqa: E501 + + :param indicative_start_balance: The indicative_start_balance of this StatementResponse. # noqa: E501 + :type: float + """ + + self._indicative_start_balance = indicative_start_balance + + @property + def indicative_end_balance(self): + """Gets the indicative_end_balance of this StatementResponse. # noqa: E501 + + Closing statement balance calculated in Xero (= bank account conversion balance plus sum of imported bank statement lines). Note: If indicative statement balance doesn't match imported statement balance for the same date, either the conversion (opening at inception) balance in Xero is wrong or there's an error in the bank statement lines in Xero. Ref: https://central.xero.com/s/article/Compare-the-statement-balance-in-Xero-to-your-actual-bank-balance?userregion=true # noqa: E501 + + :return: The indicative_end_balance of this StatementResponse. # noqa: E501 + :rtype: float + """ + return self._indicative_end_balance + + @indicative_end_balance.setter + def indicative_end_balance(self, indicative_end_balance): + """Sets the indicative_end_balance of this StatementResponse. + + Closing statement balance calculated in Xero (= bank account conversion balance plus sum of imported bank statement lines). Note: If indicative statement balance doesn't match imported statement balance for the same date, either the conversion (opening at inception) balance in Xero is wrong or there's an error in the bank statement lines in Xero. Ref: https://central.xero.com/s/article/Compare-the-statement-balance-in-Xero-to-your-actual-bank-balance?userregion=true # noqa: E501 + + :param indicative_end_balance: The indicative_end_balance of this StatementResponse. # noqa: E501 + :type: float + """ + + self._indicative_end_balance = indicative_end_balance + @property def statement_lines(self): """Gets the statement_lines of this StatementResponse. # noqa: E501 diff --git a/xero_python/finance/models/total_detail.py b/xero_python/finance/models/total_detail.py index b003f826..96da3586 100644 --- a/xero_python/finance/models/total_detail.py +++ b/xero_python/finance/models/total_detail.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/total_other.py b/xero_python/finance/models/total_other.py index 6e176554..48f8fe72 100644 --- a/xero_python/finance/models/total_other.py +++ b/xero_python/finance/models/total_other.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/trial_balance_account.py b/xero_python/finance/models/trial_balance_account.py index c88cf999..7ffc4e65 100644 --- a/xero_python/finance/models/trial_balance_account.py +++ b/xero_python/finance/models/trial_balance_account.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/trial_balance_entry.py b/xero_python/finance/models/trial_balance_entry.py index 8efee179..1c426fd9 100644 --- a/xero_python/finance/models/trial_balance_entry.py +++ b/xero_python/finance/models/trial_balance_entry.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/trial_balance_movement.py b/xero_python/finance/models/trial_balance_movement.py index 36ac1577..52f7a7b8 100644 --- a/xero_python/finance/models/trial_balance_movement.py +++ b/xero_python/finance/models/trial_balance_movement.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/trial_balance_response.py b/xero_python/finance/models/trial_balance_response.py index 9dd4f301..bbd0bc64 100644 --- a/xero_python/finance/models/trial_balance_response.py +++ b/xero_python/finance/models/trial_balance_response.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Finance API +Xero Finance API - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 +The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/finance/models/user_activities_response.py b/xero_python/finance/models/user_activities_response.py deleted file mode 100644 index 8a98e4a1..00000000 --- a/xero_python/finance/models/user_activities_response.py +++ /dev/null @@ -1,124 +0,0 @@ -# coding: utf-8 - -""" - Xero Finance API - - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - - Contact: api@xero.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 - -from xero_python.models import BaseModel - - -class UserActivitiesResponse(BaseModel): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - """ - Attributes: - openapi_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - openapi_types = { - "organisation_id": "str", - "data_month": "str", - "users": "list[UserResponse]", - } - - attribute_map = { - "organisation_id": "organisationId", - "data_month": "dataMonth", - "users": "users", - } - - def __init__(self, organisation_id=None, data_month=None, users=None): # noqa: E501 - """UserActivitiesResponse - a model defined in OpenAPI""" # noqa: E501 - - self._organisation_id = None - self._data_month = None - self._users = None - self.discriminator = None - - if organisation_id is not None: - self.organisation_id = organisation_id - if data_month is not None: - self.data_month = data_month - if users is not None: - self.users = users - - @property - def organisation_id(self): - """Gets the organisation_id of this UserActivitiesResponse. # noqa: E501 - - The requested Organisation to which the data pertains # noqa: E501 - - :return: The organisation_id of this UserActivitiesResponse. # noqa: E501 - :rtype: str - """ - return self._organisation_id - - @organisation_id.setter - def organisation_id(self, organisation_id): - """Sets the organisation_id of this UserActivitiesResponse. - - The requested Organisation to which the data pertains # noqa: E501 - - :param organisation_id: The organisation_id of this UserActivitiesResponse. # noqa: E501 - :type: str - """ - - self._organisation_id = organisation_id - - @property - def data_month(self): - """Gets the data_month of this UserActivitiesResponse. # noqa: E501 - - The month of the report # noqa: E501 - - :return: The data_month of this UserActivitiesResponse. # noqa: E501 - :rtype: str - """ - return self._data_month - - @data_month.setter - def data_month(self, data_month): - """Sets the data_month of this UserActivitiesResponse. - - The month of the report # noqa: E501 - - :param data_month: The data_month of this UserActivitiesResponse. # noqa: E501 - :type: str - """ - - self._data_month = data_month - - @property - def users(self): - """Gets the users of this UserActivitiesResponse. # noqa: E501 - - - :return: The users of this UserActivitiesResponse. # noqa: E501 - :rtype: list[UserResponse] - """ - return self._users - - @users.setter - def users(self, users): - """Sets the users of this UserActivitiesResponse. - - - :param users: The users of this UserActivitiesResponse. # noqa: E501 - :type: list[UserResponse] - """ - - self._users = users diff --git a/xero_python/finance/models/user_response.py b/xero_python/finance/models/user_response.py deleted file mode 100644 index 517f2cf1..00000000 --- a/xero_python/finance/models/user_response.py +++ /dev/null @@ -1,388 +0,0 @@ -# coding: utf-8 - -""" - Xero Finance API - - The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital. # noqa: E501 - - Contact: api@xero.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 - -from xero_python.models import BaseModel - - -class UserResponse(BaseModel): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - """ - Attributes: - openapi_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - openapi_types = { - "user_id": "str", - "user_created_date_utc": "datetime", - "last_login_date_utc": "datetime", - "is_external_partner": "bool", - "has_accountant_role": "bool", - "month_period": "str", - "number_of_logins": "int", - "number_of_documents_created": "int", - "net_value_documents_created": "float", - "absolute_value_documents_created": "float", - "attached_practices": "list[PracticeResponse]", - "history_records": "list[HistoryRecordResponse]", - } - - attribute_map = { - "user_id": "userId", - "user_created_date_utc": "userCreatedDateUtc", - "last_login_date_utc": "lastLoginDateUtc", - "is_external_partner": "isExternalPartner", - "has_accountant_role": "hasAccountantRole", - "month_period": "monthPeriod", - "number_of_logins": "numberOfLogins", - "number_of_documents_created": "numberOfDocumentsCreated", - "net_value_documents_created": "netValueDocumentsCreated", - "absolute_value_documents_created": "absoluteValueDocumentsCreated", - "attached_practices": "attachedPractices", - "history_records": "historyRecords", - } - - def __init__( - self, - user_id=None, - user_created_date_utc=None, - last_login_date_utc=None, - is_external_partner=None, - has_accountant_role=None, - month_period=None, - number_of_logins=None, - number_of_documents_created=None, - net_value_documents_created=None, - absolute_value_documents_created=None, - attached_practices=None, - history_records=None, - ): # noqa: E501 - """UserResponse - a model defined in OpenAPI""" # noqa: E501 - - self._user_id = None - self._user_created_date_utc = None - self._last_login_date_utc = None - self._is_external_partner = None - self._has_accountant_role = None - self._month_period = None - self._number_of_logins = None - self._number_of_documents_created = None - self._net_value_documents_created = None - self._absolute_value_documents_created = None - self._attached_practices = None - self._history_records = None - self.discriminator = None - - if user_id is not None: - self.user_id = user_id - if user_created_date_utc is not None: - self.user_created_date_utc = user_created_date_utc - if last_login_date_utc is not None: - self.last_login_date_utc = last_login_date_utc - if is_external_partner is not None: - self.is_external_partner = is_external_partner - if has_accountant_role is not None: - self.has_accountant_role = has_accountant_role - if month_period is not None: - self.month_period = month_period - if number_of_logins is not None: - self.number_of_logins = number_of_logins - if number_of_documents_created is not None: - self.number_of_documents_created = number_of_documents_created - if net_value_documents_created is not None: - self.net_value_documents_created = net_value_documents_created - if absolute_value_documents_created is not None: - self.absolute_value_documents_created = absolute_value_documents_created - if attached_practices is not None: - self.attached_practices = attached_practices - if history_records is not None: - self.history_records = history_records - - @property - def user_id(self): - """Gets the user_id of this UserResponse. # noqa: E501 - - The Xero identifier for the user # noqa: E501 - - :return: The user_id of this UserResponse. # noqa: E501 - :rtype: str - """ - return self._user_id - - @user_id.setter - def user_id(self, user_id): - """Sets the user_id of this UserResponse. - - The Xero identifier for the user # noqa: E501 - - :param user_id: The user_id of this UserResponse. # noqa: E501 - :type: str - """ - - self._user_id = user_id - - @property - def user_created_date_utc(self): - """Gets the user_created_date_utc of this UserResponse. # noqa: E501 - - Timestamp of user creation. # noqa: E501 - - :return: The user_created_date_utc of this UserResponse. # noqa: E501 - :rtype: datetime - """ - return self._user_created_date_utc - - @user_created_date_utc.setter - def user_created_date_utc(self, user_created_date_utc): - """Sets the user_created_date_utc of this UserResponse. - - Timestamp of user creation. # noqa: E501 - - :param user_created_date_utc: The user_created_date_utc of this UserResponse. # noqa: E501 - :type: datetime - """ - - self._user_created_date_utc = user_created_date_utc - - @property - def last_login_date_utc(self): - """Gets the last_login_date_utc of this UserResponse. # noqa: E501 - - Timestamp of user last login # noqa: E501 - - :return: The last_login_date_utc of this UserResponse. # noqa: E501 - :rtype: datetime - """ - return self._last_login_date_utc - - @last_login_date_utc.setter - def last_login_date_utc(self, last_login_date_utc): - """Sets the last_login_date_utc of this UserResponse. - - Timestamp of user last login # noqa: E501 - - :param last_login_date_utc: The last_login_date_utc of this UserResponse. # noqa: E501 - :type: datetime - """ - - self._last_login_date_utc = last_login_date_utc - - @property - def is_external_partner(self): - """Gets the is_external_partner of this UserResponse. # noqa: E501 - - User is external partner. # noqa: E501 - - :return: The is_external_partner of this UserResponse. # noqa: E501 - :rtype: bool - """ - return self._is_external_partner - - @is_external_partner.setter - def is_external_partner(self, is_external_partner): - """Sets the is_external_partner of this UserResponse. - - User is external partner. # noqa: E501 - - :param is_external_partner: The is_external_partner of this UserResponse. # noqa: E501 - :type: bool - """ - - self._is_external_partner = is_external_partner - - @property - def has_accountant_role(self): - """Gets the has_accountant_role of this UserResponse. # noqa: E501 - - User has Accountant role. # noqa: E501 - - :return: The has_accountant_role of this UserResponse. # noqa: E501 - :rtype: bool - """ - return self._has_accountant_role - - @has_accountant_role.setter - def has_accountant_role(self, has_accountant_role): - """Sets the has_accountant_role of this UserResponse. - - User has Accountant role. # noqa: E501 - - :param has_accountant_role: The has_accountant_role of this UserResponse. # noqa: E501 - :type: bool - """ - - self._has_accountant_role = has_accountant_role - - @property - def month_period(self): - """Gets the month_period of this UserResponse. # noqa: E501 - - Month period in format yyyy-MM. # noqa: E501 - - :return: The month_period of this UserResponse. # noqa: E501 - :rtype: str - """ - return self._month_period - - @month_period.setter - def month_period(self, month_period): - """Sets the month_period of this UserResponse. - - Month period in format yyyy-MM. # noqa: E501 - - :param month_period: The month_period of this UserResponse. # noqa: E501 - :type: str - """ - - self._month_period = month_period - - @property - def number_of_logins(self): - """Gets the number_of_logins of this UserResponse. # noqa: E501 - - Number of times the user has logged in. # noqa: E501 - - :return: The number_of_logins of this UserResponse. # noqa: E501 - :rtype: int - """ - return self._number_of_logins - - @number_of_logins.setter - def number_of_logins(self, number_of_logins): - """Sets the number_of_logins of this UserResponse. - - Number of times the user has logged in. # noqa: E501 - - :param number_of_logins: The number_of_logins of this UserResponse. # noqa: E501 - :type: int - """ - - self._number_of_logins = number_of_logins - - @property - def number_of_documents_created(self): - """Gets the number_of_documents_created of this UserResponse. # noqa: E501 - - Number of documents created. # noqa: E501 - - :return: The number_of_documents_created of this UserResponse. # noqa: E501 - :rtype: int - """ - return self._number_of_documents_created - - @number_of_documents_created.setter - def number_of_documents_created(self, number_of_documents_created): - """Sets the number_of_documents_created of this UserResponse. - - Number of documents created. # noqa: E501 - - :param number_of_documents_created: The number_of_documents_created of this UserResponse. # noqa: E501 - :type: int - """ - - self._number_of_documents_created = number_of_documents_created - - @property - def net_value_documents_created(self): - """Gets the net_value_documents_created of this UserResponse. # noqa: E501 - - Net value of documents created. # noqa: E501 - - :return: The net_value_documents_created of this UserResponse. # noqa: E501 - :rtype: float - """ - return self._net_value_documents_created - - @net_value_documents_created.setter - def net_value_documents_created(self, net_value_documents_created): - """Sets the net_value_documents_created of this UserResponse. - - Net value of documents created. # noqa: E501 - - :param net_value_documents_created: The net_value_documents_created of this UserResponse. # noqa: E501 - :type: float - """ - - self._net_value_documents_created = net_value_documents_created - - @property - def absolute_value_documents_created(self): - """Gets the absolute_value_documents_created of this UserResponse. # noqa: E501 - - Absolute value of documents created. # noqa: E501 - - :return: The absolute_value_documents_created of this UserResponse. # noqa: E501 - :rtype: float - """ - return self._absolute_value_documents_created - - @absolute_value_documents_created.setter - def absolute_value_documents_created(self, absolute_value_documents_created): - """Sets the absolute_value_documents_created of this UserResponse. - - Absolute value of documents created. # noqa: E501 - - :param absolute_value_documents_created: The absolute_value_documents_created of this UserResponse. # noqa: E501 - :type: float - """ - - self._absolute_value_documents_created = absolute_value_documents_created - - @property - def attached_practices(self): - """Gets the attached_practices of this UserResponse. # noqa: E501 - - - :return: The attached_practices of this UserResponse. # noqa: E501 - :rtype: list[PracticeResponse] - """ - return self._attached_practices - - @attached_practices.setter - def attached_practices(self, attached_practices): - """Sets the attached_practices of this UserResponse. - - - :param attached_practices: The attached_practices of this UserResponse. # noqa: E501 - :type: list[PracticeResponse] - """ - - self._attached_practices = attached_practices - - @property - def history_records(self): - """Gets the history_records of this UserResponse. # noqa: E501 - - - :return: The history_records of this UserResponse. # noqa: E501 - :rtype: list[HistoryRecordResponse] - """ - return self._history_records - - @history_records.setter - def history_records(self, history_records): - """Sets the history_records of this UserResponse. - - - :param history_records: The history_records of this UserResponse. # noqa: E501 - :type: list[HistoryRecordResponse] - """ - - self._history_records = history_records diff --git a/xero_python/identity/__init__.py b/xero_python/identity/__init__.py index bbe8fed7..a0623527 100644 --- a/xero_python/identity/__init__.py +++ b/xero_python/identity/__init__.py @@ -3,12 +3,12 @@ # flake8: noqa """ - Xero OAuth 2 Identity Service API +Xero OAuth 2 Identity Service API - These endpoints are related to managing authentication tokens and identity for Xero API # noqa: E501 +These endpoints are related to managing authentication tokens and identity for Xero API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/identity/api/identity_api.py b/xero_python/identity/api/identity_api.py index a1ded035..d412386d 100644 --- a/xero_python/identity/api/identity_api.py +++ b/xero_python/identity/api/identity_api.py @@ -1,5 +1,16 @@ # coding: utf-8 +import importlib +import re # noqa: F401 + +from xero_python import exceptions +from xero_python.api_client import ApiClient, ModelFinder + +try: + from .exception_handler import translate_status_exception +except ImportError: + translate_status_exception = exceptions.translate_status_exception + """ Xero OAuth 2 Identity Service API @@ -10,20 +21,9 @@ """ """ - OpenAPI spec version: 2.19.3 + OpenAPI spec version: 16.2.0 """ -import importlib -import re # noqa: F401 - -from xero_python import exceptions -from xero_python.api_client import ApiClient, ModelFinder - -try: - from .exception_handler import translate_status_exception -except ImportError: - translate_status_exception = exceptions.translate_status_exception - class empty: """empty object to mark optional parameter not set""" diff --git a/xero_python/identity/models/__init__.py b/xero_python/identity/models/__init__.py index 961bbd7f..8f1106d6 100644 --- a/xero_python/identity/models/__init__.py +++ b/xero_python/identity/models/__init__.py @@ -2,12 +2,12 @@ # flake8: noqa """ - Xero OAuth 2 Identity Service API +Xero OAuth 2 Identity Service API - These endpoints are related to managing authentication tokens and identity for Xero API # noqa: E501 +These endpoints are related to managing authentication tokens and identity for Xero API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/identity/models/access_token.py b/xero_python/identity/models/access_token.py index 2c86aaaa..aa4a58b9 100644 --- a/xero_python/identity/models/access_token.py +++ b/xero_python/identity/models/access_token.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero OAuth 2 Identity Service API +Xero OAuth 2 Identity Service API - These endpoints are related to managing authentication tokens and identity for Xero API # noqa: E501 +These endpoints are related to managing authentication tokens and identity for Xero API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/identity/models/connection.py b/xero_python/identity/models/connection.py index 543e6921..934ede88 100644 --- a/xero_python/identity/models/connection.py +++ b/xero_python/identity/models/connection.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero OAuth 2 Identity Service API +Xero OAuth 2 Identity Service API - These endpoints are related to managing authentication tokens and identity for Xero API # noqa: E501 +These endpoints are related to managing authentication tokens and identity for Xero API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/identity/models/refresh_token.py b/xero_python/identity/models/refresh_token.py index c7acab29..de7e9214 100644 --- a/xero_python/identity/models/refresh_token.py +++ b/xero_python/identity/models/refresh_token.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero OAuth 2 Identity Service API +Xero OAuth 2 Identity Service API - These endpoints are related to managing authentication tokens and identity for Xero API # noqa: E501 +These endpoints are related to managing authentication tokens and identity for Xero API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/__init__.py b/xero_python/payrollau/__init__.py index fe296e33..029594ca 100644 --- a/xero_python/payrollau/__init__.py +++ b/xero_python/payrollau/__init__.py @@ -3,12 +3,12 @@ # flake8: noqa """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -24,6 +24,7 @@ from xero_python.payrollau.models.allowance_type import AllowanceType from xero_python.payrollau.models.bank_account import BankAccount from xero_python.payrollau.models.calendar_type import CalendarType +from xero_python.payrollau.models.country_of_residence import CountryOfResidence from xero_python.payrollau.models.deduction_line import DeductionLine from xero_python.payrollau.models.deduction_type import DeductionType from xero_python.payrollau.models.deduction_type_calculation_type import ( @@ -42,14 +43,17 @@ from xero_python.payrollau.models.employment_termination_payment_type import ( EmploymentTerminationPaymentType, ) +from xero_python.payrollau.models.employment_type import EmploymentType from xero_python.payrollau.models.entitlement_final_pay_payout_type import ( EntitlementFinalPayPayoutType, ) from xero_python.payrollau.models.home_address import HomeAddress +from xero_python.payrollau.models.income_type import IncomeType from xero_python.payrollau.models.leave_accrual_line import LeaveAccrualLine from xero_python.payrollau.models.leave_application import LeaveApplication from xero_python.payrollau.models.leave_applications import LeaveApplications from xero_python.payrollau.models.leave_balance import LeaveBalance +from xero_python.payrollau.models.leave_category_code import LeaveCategoryCode from xero_python.payrollau.models.leave_earnings_line import LeaveEarningsLine from xero_python.payrollau.models.leave_line import LeaveLine from xero_python.payrollau.models.leave_line_calculation_type import ( @@ -63,9 +67,14 @@ LeaveTypeContributionType, ) from xero_python.payrollau.models.manual_tax_type import ManualTaxType +from xero_python.payrollau.models.opening_balance_leave_line import ( + OpeningBalanceLeaveLine, +) from xero_python.payrollau.models.opening_balances import OpeningBalances +from xero_python.payrollau.models.paid_leave_earnings_line import PaidLeaveEarningsLine from xero_python.payrollau.models.pay_item import PayItem from xero_python.payrollau.models.pay_items import PayItems +from xero_python.payrollau.models.pay_out_type import PayOutType from xero_python.payrollau.models.pay_run import PayRun from xero_python.payrollau.models.pay_run_status import PayRunStatus from xero_python.payrollau.models.pay_runs import PayRuns @@ -83,6 +92,7 @@ from xero_python.payrollau.models.reimbursement_lines import ReimbursementLines from xero_python.payrollau.models.reimbursement_type import ReimbursementType from xero_python.payrollau.models.residency_status import ResidencyStatus +from xero_python.payrollau.models.senior_marital_status import SeniorMaritalStatus from xero_python.payrollau.models.settings import Settings from xero_python.payrollau.models.settings_object import SettingsObject from xero_python.payrollau.models.settings_tracking_categories import ( @@ -112,9 +122,11 @@ from xero_python.payrollau.models.tfn_exemption_type import TFNExemptionType from xero_python.payrollau.models.tax_declaration import TaxDeclaration from xero_python.payrollau.models.tax_line import TaxLine +from xero_python.payrollau.models.tax_scale_type import TaxScaleType from xero_python.payrollau.models.timesheet import Timesheet from xero_python.payrollau.models.timesheet_line import TimesheetLine from xero_python.payrollau.models.timesheet_object import TimesheetObject from xero_python.payrollau.models.timesheet_status import TimesheetStatus from xero_python.payrollau.models.timesheets import Timesheets from xero_python.payrollau.models.validation_error import ValidationError +from xero_python.payrollau.models.work_condition import WorkCondition diff --git a/xero_python/payrollau/api/payroll_au_api.py b/xero_python/payrollau/api/payroll_au_api.py index e5966572..68b77542 100644 --- a/xero_python/payrollau/api/payroll_au_api.py +++ b/xero_python/payrollau/api/payroll_au_api.py @@ -1,5 +1,16 @@ # coding: utf-8 +import importlib +import re # noqa: F401 + +from xero_python import exceptions +from xero_python.api_client import ApiClient, ModelFinder + +try: + from .exception_handler import translate_status_exception +except ImportError: + translate_status_exception = exceptions.translate_status_exception + """ Xero Payroll AU API @@ -10,20 +21,9 @@ """ """ - OpenAPI spec version: 2.19.3 + OpenAPI spec version: 16.2.0 """ -import importlib -import re # noqa: F401 - -from xero_python import exceptions -from xero_python.api_client import ApiClient, ModelFinder - -try: - from .exception_handler import translate_status_exception -except ImportError: - translate_status_exception = exceptions.translate_status_exception - class empty: """empty object to mark optional parameter not set""" @@ -56,10 +56,92 @@ def get_resource_url(self, resource_path): def get_model_finder(self): return ModelFinder(self.models_module) + def approve_leave_application( + self, + xero_tenant_id, + leave_application_id, + idempotency_key=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Approve a requested leave application by a unique leave application id # noqa: E501 + OAuth2 scope: payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str leave_application_id: Leave Application id for single object (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: LeaveApplications + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `approve_leave_application`" + ) + # verify the required parameter 'leave_application_id' is set + if leave_application_id is None: + raise ValueError( + "Missing the required parameter `leave_application_id` " + "when calling `approve_leave_application`" + ) + + collection_formats = {} + path_params = { + "LeaveApplicationID": leave_application_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/LeaveApplications/{LeaveApplicationID}/approve") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="LeaveApplications", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "approve_leave_application") + def create_employee( self, xero_tenant_id, employee, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -68,6 +150,7 @@ def create_employee( OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param list[Employee] employee: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -96,6 +179,9 @@ def create_employee( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -139,6 +225,7 @@ def create_leave_application( self, xero_tenant_id, leave_application, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -147,6 +234,7 @@ def create_leave_application( OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param list[LeaveApplication] leave_application: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -175,6 +263,9 @@ def create_leave_application( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -218,6 +309,7 @@ def create_pay_item( self, xero_tenant_id, pay_item, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -226,6 +318,7 @@ def create_pay_item( OAuth2 scope: payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param PayItem pay_item: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -254,6 +347,9 @@ def create_pay_item( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -297,6 +393,7 @@ def create_pay_run( self, xero_tenant_id, pay_run, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -305,6 +402,7 @@ def create_pay_run( OAuth2 scope: payroll.payruns :param str xero_tenant_id: Xero identifier for Tenant (required) :param list[PayRun] pay_run: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -333,6 +431,9 @@ def create_pay_run( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -376,6 +477,7 @@ def create_payroll_calendar( self, xero_tenant_id, payroll_calendar, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -384,6 +486,7 @@ def create_payroll_calendar( OAuth2 scope: payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param list[PayrollCalendar] payroll_calendar: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -412,6 +515,9 @@ def create_payroll_calendar( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -455,6 +561,7 @@ def create_superfund( self, xero_tenant_id, super_fund, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -463,6 +570,7 @@ def create_superfund( OAuth2 scope: payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param list[SuperFund] super_fund: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -491,6 +599,9 @@ def create_superfund( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -534,6 +645,7 @@ def create_timesheet( self, xero_tenant_id, timesheet, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -542,6 +654,7 @@ def create_timesheet( OAuth2 scope: payroll.timesheets :param str xero_tenant_id: Xero identifier for Tenant (required) :param list[Timesheet] timesheet: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -570,6 +683,9 @@ def create_timesheet( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -933,6 +1049,92 @@ def get_leave_applications( except exceptions.HTTPStatusException as error: raise translate_status_exception(error, self, "get_leave_applications") + def get_leave_applications_v2( + self, + xero_tenant_id, + if_modified_since=empty, + where=empty, + order=empty, + page=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Retrieves leave applications including leave requests # noqa: E501 + OAuth2 scope: payroll.employees, payroll.employees.read + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param datetime if_modified_since: Only records created or modified since this timestamp will be returned + :param str where: Filter by an any element + :param str order: Order by an any element + :param int page: e.g. page=1 – Up to 100 objects will be returned in a single API call + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: LeaveApplications + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_leave_applications_v2`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + if where is not empty: + query_params.append(("where", where)) + + if order is not empty: + query_params.append(("order", order)) + + if page is not empty: + query_params.append(("page", page)) + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + if if_modified_since is not empty: + header_params["If-Modified-Since"] = if_modified_since + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/LeaveApplications/v2") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="LeaveApplications", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_leave_applications_v2") + def get_pay_items( self, xero_tenant_id, @@ -1885,11 +2087,93 @@ def get_timesheets( except exceptions.HTTPStatusException as error: raise translate_status_exception(error, self, "get_timesheets") + def reject_leave_application( + self, + xero_tenant_id, + leave_application_id, + idempotency_key=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Reject a leave application by a unique leave application id # noqa: E501 + OAuth2 scope: payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str leave_application_id: Leave Application id for single object (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: LeaveApplications + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `reject_leave_application`" + ) + # verify the required parameter 'leave_application_id' is set + if leave_application_id is None: + raise ValueError( + "Missing the required parameter `leave_application_id` " + "when calling `reject_leave_application`" + ) + + collection_formats = {} + path_params = { + "LeaveApplicationID": leave_application_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/LeaveApplications/{LeaveApplicationID}/reject") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="LeaveApplications", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "reject_leave_application") + def update_employee( self, xero_tenant_id, employee_id, - employee=empty, + employee, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1899,7 +2183,8 @@ def update_employee( Update properties on a single employee # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) - :param list[Employee] employee: + :param list[Employee] employee: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1918,6 +2203,12 @@ def update_employee( "Missing the required parameter `employee_id` " "when calling `update_employee`" ) + # verify the required parameter 'employee' is set + if employee is None: + raise ValueError( + "Missing the required parameter `employee` " + "when calling `update_employee`" + ) collection_formats = {} path_params = { @@ -1930,6 +2221,9 @@ def update_employee( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1974,6 +2268,7 @@ def update_leave_application( xero_tenant_id, leave_application_id, leave_application, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1983,6 +2278,7 @@ def update_leave_application( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str leave_application_id: Leave Application id for single object (required) :param list[LeaveApplication] leave_application: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -2019,6 +2315,9 @@ def update_leave_application( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -2062,7 +2361,8 @@ def update_pay_run( self, xero_tenant_id, pay_run_id, - pay_run=empty, + pay_run, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -2072,7 +2372,8 @@ def update_pay_run( Update properties on a single PayRun # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) :param str pay_run_id: PayRun id for single object (required) - :param list[PayRun] pay_run: + :param list[PayRun] pay_run: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -2091,6 +2392,12 @@ def update_pay_run( "Missing the required parameter `pay_run_id` " "when calling `update_pay_run`" ) + # verify the required parameter 'pay_run' is set + if pay_run is None: + raise ValueError( + "Missing the required parameter `pay_run` " + "when calling `update_pay_run`" + ) collection_formats = {} path_params = { @@ -2103,6 +2410,9 @@ def update_pay_run( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -2146,7 +2456,8 @@ def update_payslip( self, xero_tenant_id, payslip_id, - payslip_lines=empty, + payslip_lines, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -2156,7 +2467,8 @@ def update_payslip( Update lines on a single payslips # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) :param str payslip_id: Payslip id for single object (required) - :param list[PayslipLines] payslip_lines: + :param list[PayslipLines] payslip_lines: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -2175,6 +2487,12 @@ def update_payslip( "Missing the required parameter `payslip_id` " "when calling `update_payslip`" ) + # verify the required parameter 'payslip_lines' is set + if payslip_lines is None: + raise ValueError( + "Missing the required parameter `payslip_lines` " + "when calling `update_payslip`" + ) collection_formats = {} path_params = { @@ -2187,6 +2505,9 @@ def update_payslip( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -2230,7 +2551,8 @@ def update_superfund( self, xero_tenant_id, super_fund_id, - super_fund=empty, + super_fund, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -2240,7 +2562,8 @@ def update_superfund( Update properties on a single Superfund # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) :param str super_fund_id: Superfund id for single object (required) - :param list[SuperFund] super_fund: + :param list[SuperFund] super_fund: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -2259,6 +2582,12 @@ def update_superfund( "Missing the required parameter `super_fund_id` " "when calling `update_superfund`" ) + # verify the required parameter 'super_fund' is set + if super_fund is None: + raise ValueError( + "Missing the required parameter `super_fund` " + "when calling `update_superfund`" + ) collection_formats = {} path_params = { @@ -2271,6 +2600,9 @@ def update_superfund( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -2314,7 +2646,8 @@ def update_timesheet( self, xero_tenant_id, timesheet_id, - timesheet=empty, + timesheet, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -2324,7 +2657,8 @@ def update_timesheet( Update properties on a single timesheet # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) :param str timesheet_id: Timesheet id for single object (required) - :param list[Timesheet] timesheet: + :param list[Timesheet] timesheet: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -2343,6 +2677,12 @@ def update_timesheet( "Missing the required parameter `timesheet_id` " "when calling `update_timesheet`" ) + # verify the required parameter 'timesheet' is set + if timesheet is None: + raise ValueError( + "Missing the required parameter `timesheet` " + "when calling `update_timesheet`" + ) collection_formats = {} path_params = { @@ -2355,6 +2695,9 @@ def update_timesheet( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] diff --git a/xero_python/payrollau/docs/CountryOfResidence.md b/xero_python/payrollau/docs/CountryOfResidence.md new file mode 100644 index 00000000..32beea2f --- /dev/null +++ b/xero_python/payrollau/docs/CountryOfResidence.md @@ -0,0 +1,9 @@ +# CountryOfResidence + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollau/docs/EarningsRate.md b/xero_python/payrollau/docs/EarningsRate.md index f7f26bf2..0cc5bc09 100644 --- a/xero_python/payrollau/docs/EarningsRate.md +++ b/xero_python/payrollau/docs/EarningsRate.md @@ -9,6 +9,9 @@ Name | Type | Description | Notes **is_exempt_from_tax** | **bool** | Most payments are subject to tax, so you should only set this value if you are sure that a payment is exempt from PAYG withholding | [optional] **is_exempt_from_super** | **bool** | See the ATO website for details of which payments are exempt from SGC | [optional] **is_reportable_as_w1** | **bool** | Boolean to determine if the earnings rate is reportable or exempt from W1 | [optional] +**is_qualifying_earnings** | **bool** | Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations | +**allowance_contributes_to_annual_leave_rate** | **bool** | Boolean to determine if the allowance earnings rate contributes towards annual leave rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT | [optional] +**allowance_contributes_to_overtime_rate** | **bool** | Boolean to determine if the allowance earnings rate contributes towards overtime allowance rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT | [optional] **earnings_type** | [**EarningsType**](EarningsType.md) | | [optional] **earnings_rate_id** | **str** | Xero identifier | [optional] **rate_type** | [**RateType**](RateType.md) | | [optional] diff --git a/xero_python/payrollau/docs/Employee.md b/xero_python/payrollau/docs/Employee.md index fe347bd0..0e754a22 100644 --- a/xero_python/payrollau/docs/Employee.md +++ b/xero_python/payrollau/docs/Employee.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **title** | **str** | Title of the employee | [optional] **middle_names** | **str** | Middle name(s) of the employee | [optional] **email** | **str** | The email address for the employee | [optional] -**gender** | **str** | The employee’s gender. See Employee Gender | [optional] +**gender** | **str** | The employee’s gender. See Employee Gender | [optional] **phone** | **str** | Employee phone number | [optional] **mobile** | **str** | Employee mobile number | [optional] **twitter_user_name** | **str** | Employee’s twitter name | [optional] @@ -29,8 +29,11 @@ Name | Type | Description | Notes **pay_template** | [**PayTemplate**](PayTemplate.md) | | [optional] **opening_balances** | [**OpeningBalances**](OpeningBalances.md) | | [optional] **tax_declaration** | [**TaxDeclaration**](TaxDeclaration.md) | | [optional] +**income_type** | [**IncomeType**](IncomeType.md) | | [optional] +**employment_type** | [**EmploymentType**](EmploymentType.md) | | [optional] +**country_of_residence** | [**CountryOfResidence**](CountryOfResidence.md) | | [optional] +**is_stp2_qualified** | **bool** | Indicates if the employee has been updated for STP Phase 2 compliance. Doesn't indicate that the employee is payable. | [optional] **leave_balances** | [**list[LeaveBalance]**](LeaveBalance.md) | | [optional] -**leave_lines** | [**list[LeaveLine]**](LeaveLine.md) | | [optional] **super_memberships** | [**list[SuperMembership]**](SuperMembership.md) | | [optional] **status** | [**EmployeeStatus**](EmployeeStatus.md) | | [optional] **updated_date_utc** | **datetime** | Last modified timestamp | [optional] diff --git a/xero_python/payrollau/docs/EmploymentType.md b/xero_python/payrollau/docs/EmploymentType.md new file mode 100644 index 00000000..dc14679e --- /dev/null +++ b/xero_python/payrollau/docs/EmploymentType.md @@ -0,0 +1,9 @@ +# EmploymentType + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollau/docs/IncomeType.md b/xero_python/payrollau/docs/IncomeType.md new file mode 100644 index 00000000..60b2755a --- /dev/null +++ b/xero_python/payrollau/docs/IncomeType.md @@ -0,0 +1,9 @@ +# IncomeType + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollau/docs/LeaveApplication.md b/xero_python/payrollau/docs/LeaveApplication.md index ef054467..f8e25783 100644 --- a/xero_python/payrollau/docs/LeaveApplication.md +++ b/xero_python/payrollau/docs/LeaveApplication.md @@ -10,6 +10,7 @@ Name | Type | Description | Notes **start_date** | **date** | Start date of the leave (YYYY-MM-DD) | [optional] **end_date** | **date** | End date of the leave (YYYY-MM-DD) | [optional] **description** | **str** | The Description of the Leave | [optional] +**pay_out_type** | [**PayOutType**](PayOutType.md) | | [optional] **leave_periods** | [**list[LeavePeriod]**](LeavePeriod.md) | | [optional] **updated_date_utc** | **datetime** | Last modified timestamp | [optional] **validation_errors** | [**list[ValidationError]**](ValidationError.md) | Displays array of validation error messages from the API | [optional] diff --git a/xero_python/payrollau/docs/LeaveCategoryCode.md b/xero_python/payrollau/docs/LeaveCategoryCode.md new file mode 100644 index 00000000..a75a5c57 --- /dev/null +++ b/xero_python/payrollau/docs/LeaveCategoryCode.md @@ -0,0 +1,9 @@ +# LeaveCategoryCode + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollau/docs/LeaveEarningsLine.md b/xero_python/payrollau/docs/LeaveEarningsLine.md index 234da08c..029a9f8b 100644 --- a/xero_python/payrollau/docs/LeaveEarningsLine.md +++ b/xero_python/payrollau/docs/LeaveEarningsLine.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes **earnings_rate_id** | **str** | Xero identifier | [optional] **rate_per_unit** | **float** | Rate per unit of the EarningsLine. | [optional] **number_of_units** | **float** | Earnings rate number of units. | [optional] +**pay_out_type** | [**PayOutType**](PayOutType.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrollau/docs/LeaveLine.md b/xero_python/payrollau/docs/LeaveLine.md index 18387baa..06996c3e 100644 --- a/xero_python/payrollau/docs/LeaveLine.md +++ b/xero_python/payrollau/docs/LeaveLine.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **entitlement_final_pay_payout_type** | [**EntitlementFinalPayPayoutType**](EntitlementFinalPayPayoutType.md) | | [optional] **employment_termination_payment_type** | [**EmploymentTerminationPaymentType**](EmploymentTerminationPaymentType.md) | | [optional] **include_superannuation_guarantee_contribution** | **bool** | amount of leave line | [optional] +**is_qualifying_earnings** | **bool** | Boolean to determine if the leave line is considered as qualifying earnings for superannuation guarantee calculations | **number_of_units** | **float** | Number of units for leave line. | [optional] **annual_number_of_units** | **float** | Hours of leave accrued each year | [optional] **full_time_number_of_units_per_period** | **float** | Normal ordinary earnings number of units for leave line. | [optional] diff --git a/xero_python/payrollau/docs/LeaveType.md b/xero_python/payrollau/docs/LeaveType.md index 8d620a06..8a859907 100644 --- a/xero_python/payrollau/docs/LeaveType.md +++ b/xero_python/payrollau/docs/LeaveType.md @@ -12,6 +12,9 @@ Name | Type | Description | Notes **is_paid_leave** | **bool** | Set this to indicate that an employee will be paid when taking this type of leave | [optional] **show_on_payslip** | **bool** | Set this if you want a balance for this leave type to be shown on your employee’s payslips | [optional] **current_record** | **bool** | Is the current record | [optional] +**leave_category_code** | [**LeaveCategoryCode**](LeaveCategoryCode.md) | | [optional] +**sgc_exempt** | **bool** | Set this to indicate that the leave type is exempt from superannuation guarantee contribution | [optional] +**is_qualifying_earnings** | **bool** | Boolean to determine if the leave type is considered as qualifying earnings for superannuation guarantee calculations | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/finance/docs/UserActivitiesResponse.md b/xero_python/payrollau/docs/OpeningBalanceLeaveLine.md similarity index 52% rename from xero_python/finance/docs/UserActivitiesResponse.md rename to xero_python/payrollau/docs/OpeningBalanceLeaveLine.md index a082a55b..d9850130 100644 --- a/xero_python/finance/docs/UserActivitiesResponse.md +++ b/xero_python/payrollau/docs/OpeningBalanceLeaveLine.md @@ -1,11 +1,10 @@ -# UserActivitiesResponse +# OpeningBalanceLeaveLine ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**organisation_id** | **str** | The requested Organisation to which the data pertains | [optional] -**data_month** | **str** | The month of the report | [optional] -**users** | [**list[UserResponse]**](UserResponse.md) | | [optional] +**leave_type_id** | **str** | Xero leave type identifier | [optional] +**number_of_units** | **float** | Number of units for leave line. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrollau/docs/OpeningBalances.md b/xero_python/payrollau/docs/OpeningBalances.md index 05101eb6..14243bcb 100644 --- a/xero_python/payrollau/docs/OpeningBalances.md +++ b/xero_python/payrollau/docs/OpeningBalances.md @@ -9,7 +9,8 @@ Name | Type | Description | Notes **deduction_lines** | [**list[DeductionLine]**](DeductionLine.md) | | [optional] **super_lines** | [**list[SuperLine]**](SuperLine.md) | | [optional] **reimbursement_lines** | [**list[ReimbursementLine]**](ReimbursementLine.md) | | [optional] -**leave_lines** | [**list[LeaveLine]**](LeaveLine.md) | | [optional] +**leave_lines** | [**list[OpeningBalanceLeaveLine]**](OpeningBalanceLeaveLine.md) | | [optional] +**paid_leave_earnings_lines** | [**list[PaidLeaveEarningsLine]**](PaidLeaveEarningsLine.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrollau/docs/PaidLeaveEarningsLine.md b/xero_python/payrollau/docs/PaidLeaveEarningsLine.md new file mode 100644 index 00000000..7837e1d7 --- /dev/null +++ b/xero_python/payrollau/docs/PaidLeaveEarningsLine.md @@ -0,0 +1,14 @@ +# PaidLeaveEarningsLine + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**leave_type_id** | **str** | Xero leave type identifier | +**amount** | **float** | Paid leave amount | +**sgc_applied_leave_loading_amount** | **float** | The amount of leave loading applied for the leave type that is subject to Superannuation Guarantee Contributions. *Only applicable for Leave Types with Annual Leave Categories | [optional] +**sgc_exempted_leave_loading_amount** | **float** | The amount of leave loading applied for the leave type that is exempt from Superannuation Guarantee Contributions. *Only applicable for Leave Types with Annual Leave Categories | [optional] +**reset_stp_categorisation** | **bool** | Reset the STP categorisations for the leave type. *Only applicable for Leave Types with Annual Leave Categories | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollau/docs/PayOutType.md b/xero_python/payrollau/docs/PayOutType.md new file mode 100644 index 00000000..192f3b16 --- /dev/null +++ b/xero_python/payrollau/docs/PayOutType.md @@ -0,0 +1,9 @@ +# PayOutType + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollau/docs/PayrollAuApi.md b/xero_python/payrollau/docs/PayrollAuApi.md index 3b4a2dd3..31b742f2 100644 --- a/xero_python/payrollau/docs/PayrollAuApi.md +++ b/xero_python/payrollau/docs/PayrollAuApi.md @@ -4,6 +4,7 @@ All URIs are relative to *https://api.xero.com/payroll.xro/1.0* Method | HTTP request | Description ------------- | ------------- | ------------- +[**approve_leave_application**](PayrollAuApi.md#approve_leave_application) | **POST** /LeaveApplications/{LeaveApplicationID}/approve | Approve a requested leave application by a unique leave application id [**create_employee**](PayrollAuApi.md#create_employee) | **POST** /Employees | Creates a payroll employee [**create_leave_application**](PayrollAuApi.md#create_leave_application) | **POST** /LeaveApplications | Creates a leave application [**create_pay_item**](PayrollAuApi.md#create_pay_item) | **POST** /PayItems | Creates a pay item @@ -15,6 +16,7 @@ Method | HTTP request | Description [**get_employees**](PayrollAuApi.md#get_employees) | **GET** /Employees | Searches payroll employees [**get_leave_application**](PayrollAuApi.md#get_leave_application) | **GET** /LeaveApplications/{LeaveApplicationID} | Retrieves a leave application by a unique leave application id [**get_leave_applications**](PayrollAuApi.md#get_leave_applications) | **GET** /LeaveApplications | Retrieves leave applications +[**get_leave_applications_v2**](PayrollAuApi.md#get_leave_applications_v2) | **GET** /LeaveApplications/v2 | Retrieves leave applications including leave requests [**get_pay_items**](PayrollAuApi.md#get_pay_items) | **GET** /PayItems | Retrieves pay items [**get_pay_run**](PayrollAuApi.md#get_pay_run) | **GET** /PayRuns/{PayRunID} | Retrieves a pay run by using a unique pay run id [**get_pay_runs**](PayrollAuApi.md#get_pay_runs) | **GET** /PayRuns | Retrieves pay runs @@ -27,6 +29,7 @@ Method | HTTP request | Description [**get_superfunds**](PayrollAuApi.md#get_superfunds) | **GET** /Superfunds | Retrieves superfunds [**get_timesheet**](PayrollAuApi.md#get_timesheet) | **GET** /Timesheets/{TimesheetID} | Retrieves a timesheet by using a unique timesheet id [**get_timesheets**](PayrollAuApi.md#get_timesheets) | **GET** /Timesheets | Retrieves timesheets +[**reject_leave_application**](PayrollAuApi.md#reject_leave_application) | **POST** /LeaveApplications/{LeaveApplicationID}/reject | Reject a leave application by a unique leave application id [**update_employee**](PayrollAuApi.md#update_employee) | **POST** /Employees/{EmployeeID} | Updates an employee's detail [**update_leave_application**](PayrollAuApi.md#update_leave_application) | **POST** /LeaveApplications/{LeaveApplicationID} | Updates a specific leave application [**update_pay_run**](PayrollAuApi.md#update_pay_run) | **POST** /PayRuns/{PayRunID} | Updates a pay run @@ -35,8 +38,73 @@ Method | HTTP request | Description [**update_timesheet**](PayrollAuApi.md#update_timesheet) | **POST** /Timesheets/{TimesheetID} | Updates a timesheet +# **approve_leave_application** +> LeaveApplications approve_leave_application(xero_tenant_id, leave_application_id, idempotency_key=idempotency_key) + +Approve a requested leave application by a unique leave application id + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollau import PayrollAuApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollAuApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +leave_application_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Leave Application id for single object +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) +try: + # Approve a requested leave application by a unique leave application id + api_response = api_instance.approve_leave_application(xero_tenant_id, leave_application_id, idempotency_key=idempotency_key) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->approve_leave_application: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **leave_application_id** | [**str**](.md)| Leave Application id for single object | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] + +### Return type + +[**LeaveApplications**](LeaveApplications.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **create_employee** -> Employees create_employee(xero_tenant_id, employee) +> Employees create_employee(xero_tenant_id, employee, idempotency_key=idempotency_key) Creates a payroll employee @@ -68,9 +136,10 @@ api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee = [ { "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" } ] # list[Employee] | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a payroll employee - api_response = api_instance.create_employee(xero_tenant_id, employee) + api_response = api_instance.create_employee(xero_tenant_id, employee, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollAuApi->create_employee: %s\n" % e) @@ -82,6 +151,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **employee** | [**list[Employee]**](Employee.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -99,7 +169,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_leave_application** -> LeaveApplications create_leave_application(xero_tenant_id, leave_application) +> LeaveApplications create_leave_application(xero_tenant_id, leave_application, idempotency_key=idempotency_key) Creates a leave application @@ -131,9 +201,10 @@ api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant leave_application = [ { "EmployeeID": "cdfb8371-0b21-4b8a-8903-1024df6c391e", "LeaveTypeID": "184ea8f7-d143-46dd-bef3-0c60e1aa6fca", "Title": "Hello World", "StartDate": "/Date(1572559200000+0000)/", "EndDate": "/Date(1572645600000+0000)/" } ] # list[LeaveApplication] | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a leave application - api_response = api_instance.create_leave_application(xero_tenant_id, leave_application) + api_response = api_instance.create_leave_application(xero_tenant_id, leave_application, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollAuApi->create_leave_application: %s\n" % e) @@ -145,6 +216,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **leave_application** | [**list[LeaveApplication]**](LeaveApplication.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -162,7 +234,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_pay_item** -> PayItems create_pay_item(xero_tenant_id, pay_item) +> PayItems create_pay_item(xero_tenant_id, pay_item, idempotency_key=idempotency_key) Creates a pay item @@ -193,10 +265,11 @@ api_client = ApiClient( api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -pay_item = { "EarningsRates": [ { "Name": "MyRate", "AccountCode": "400", "TypeOfUnits": "4.00", "IsExemptFromTax": true, "IsExemptFromSuper": true, "IsReportableAsW1": false, "EarningsType": "ORDINARYTIMEEARNINGS", "EarningsRateID": "1fa4e226-b711-46ba-a8a7-4344c9c5fb87", "RateType": "MULTIPLE", "RatePerUnit": "10.0", "Multiplier": 1.5, "Amount": 5, "EmploymentTerminationPaymentType": "O" } ] } # PayItem | +pay_item = {"EarningsRates":[{"Name":"MyRate","AccountCode":"400","TypeOfUnits":"4.00","IsExemptFromTax":false,"IsExemptFromSuper":true,"IsReportableAsW1":false,"IsQualifyingEarnings":true,"AllowanceContributesToAnnualLeaveRate":false,"AllowanceContributesToOvertimeRate":false,"EarningsType":"ORDINARYTIMEEARNINGS","EarningsRateID":"1fa4e226-b711-46ba-a8a7-4344c9c5fb87","RateType":"MULTIPLE","RatePerUnit":"10.0","Multiplier":1.5,"Amount":5,"EmploymentTerminationPaymentType":"O"}]} # PayItem | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a pay item - api_response = api_instance.create_pay_item(xero_tenant_id, pay_item) + api_response = api_instance.create_pay_item(xero_tenant_id, pay_item, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollAuApi->create_pay_item: %s\n" % e) @@ -208,6 +281,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **pay_item** | [**PayItem**](PayItem.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -225,7 +299,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_pay_run** -> PayRuns create_pay_run(xero_tenant_id, pay_run) +> PayRuns create_pay_run(xero_tenant_id, pay_run, idempotency_key=idempotency_key) Creates a pay run @@ -257,9 +331,10 @@ api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant pay_run = [ { "PayrollCalendarID": "78bb86b9-e1ea-47ac-b75d-f087a81931de", "PayRunPeriodStartDate": "/Date(1572566400000+0000)/", "PayRunPeriodEndDate": "/Date(1573084800000+0000)/", "PayRunStatus": "DRAFT", "PaymentDate": "/Date(1573171200000+0000)/" } ] # list[PayRun] | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a pay run - api_response = api_instance.create_pay_run(xero_tenant_id, pay_run) + api_response = api_instance.create_pay_run(xero_tenant_id, pay_run, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollAuApi->create_pay_run: %s\n" % e) @@ -271,6 +346,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **pay_run** | [**list[PayRun]**](PayRun.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -288,7 +364,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_payroll_calendar** -> PayrollCalendars create_payroll_calendar(xero_tenant_id, payroll_calendar) +> PayrollCalendars create_payroll_calendar(xero_tenant_id, payroll_calendar, idempotency_key=idempotency_key) Creates a Payroll Calendar @@ -320,9 +396,10 @@ api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant payroll_calendar = [ { "PayrollCalendarID":"78bb86b9-e1ea-47ac-b75d-f087a81931de", "PayRunPeriodStartDate":"/Date(1572566400000+0000)/", "PayRunPeriodEndDate":"/Date(1573084800000+0000)/", "PayRunStatus":"DRAFT", "PaymentDate":"/Date(1573171200000+0000)/" } ] # list[PayrollCalendar] | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a Payroll Calendar - api_response = api_instance.create_payroll_calendar(xero_tenant_id, payroll_calendar) + api_response = api_instance.create_payroll_calendar(xero_tenant_id, payroll_calendar, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollAuApi->create_payroll_calendar: %s\n" % e) @@ -334,6 +411,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **payroll_calendar** | [**list[PayrollCalendar]**](PayrollCalendar.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -351,7 +429,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_superfund** -> SuperFunds create_superfund(xero_tenant_id, super_fund) +> SuperFunds create_superfund(xero_tenant_id, super_fund, idempotency_key=idempotency_key) Creates a superfund @@ -383,9 +461,10 @@ api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant super_fund = [ { "usi":"PTC0133AU", "Type":"REGULATED", "Name":"Bar99359", "AccountNumber":"FB36350", "AccountName":"Foo38428", "USI":"PTC0133AU" } ] # list[SuperFund] | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a superfund - api_response = api_instance.create_superfund(xero_tenant_id, super_fund) + api_response = api_instance.create_superfund(xero_tenant_id, super_fund, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollAuApi->create_superfund: %s\n" % e) @@ -397,6 +476,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **super_fund** | [**list[SuperFund]**](SuperFund.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -414,7 +494,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_timesheet** -> Timesheets create_timesheet(xero_tenant_id, timesheet) +> Timesheets create_timesheet(xero_tenant_id, timesheet, idempotency_key=idempotency_key) Creates a timesheet @@ -446,9 +526,10 @@ api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant timesheet = [ { "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 ] } ] } ] # list[Timesheet] | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a timesheet - api_response = api_instance.create_timesheet(xero_tenant_id, timesheet) + api_response = api_instance.create_timesheet(xero_tenant_id, timesheet, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollAuApi->create_timesheet: %s\n" % e) @@ -460,6 +541,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **timesheet** | [**list[Timesheet]**](Timesheet.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -740,6 +822,75 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_leave_applications_v2** +> LeaveApplications get_leave_applications_v2(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) + +Retrieves leave applications including leave requests + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollau import PayrollAuApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollAuApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +if_modified_since = '2020-02-06T12:17:43.202-08:00' # datetime | Only records created or modified since this timestamp will be returned (optional) +where = 'Status==\"ACTIVE\"' # str | Filter by an any element (optional) +order = 'EmailAddress%20DESC' # str | Order by an any element (optional) +page = 56 # int | e.g. page=1 – Up to 100 objects will be returned in a single API call (optional) +try: + # Retrieves leave applications including leave requests + api_response = api_instance.get_leave_applications_v2(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->get_leave_applications_v2: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **if_modified_since** | **datetime**| Only records created or modified since this timestamp will be returned | [optional] + **where** | **str**| Filter by an any element | [optional] + **order** | **str**| Order by an any element | [optional] + **page** | **int**| e.g. page=1 – Up to 100 objects will be returned in a single API call | [optional] + +### Return type + +[**LeaveApplications**](LeaveApplications.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **get_pay_items** > PayItems get_pay_items(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) @@ -1526,8 +1677,73 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **reject_leave_application** +> LeaveApplications reject_leave_application(xero_tenant_id, leave_application_id, idempotency_key=idempotency_key) + +Reject a leave application by a unique leave application id + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollau import PayrollAuApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollAuApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +leave_application_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Leave Application id for single object +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) +try: + # Reject a leave application by a unique leave application id + api_response = api_instance.reject_leave_application(xero_tenant_id, leave_application_id, idempotency_key=idempotency_key) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->reject_leave_application: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **leave_application_id** | [**str**](.md)| Leave Application id for single object | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] + +### Return type + +[**LeaveApplications**](LeaveApplications.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **update_employee** -> Employees update_employee(xero_tenant_id, employee_id, employee=employee) +> Employees update_employee(xero_tenant_id, employee_id, employee, idempotency_key=idempotency_key) Updates an employee's detail @@ -1561,10 +1777,11 @@ api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object -employee = [ { "MiddleNames": "Frank" } ] # list[Employee] | (optional) +employee = [ { "MiddleNames": "Frank" } ] # list[Employee] | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates an employee's detail - api_response = api_instance.update_employee(xero_tenant_id, employee_id, employee=employee) + api_response = api_instance.update_employee(xero_tenant_id, employee_id, employee, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollAuApi->update_employee: %s\n" % e) @@ -1576,7 +1793,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **employee_id** | [**str**](.md)| Employee id for single object | - **employee** | [**list[Employee]**](Employee.md)| | [optional] + **employee** | [**list[Employee]**](Employee.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1594,7 +1812,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_leave_application** -> LeaveApplications update_leave_application(xero_tenant_id, leave_application_id, leave_application) +> LeaveApplications update_leave_application(xero_tenant_id, leave_application_id, leave_application, idempotency_key=idempotency_key) Updates a specific leave application @@ -1626,10 +1844,11 @@ api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant leave_application_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Leave Application id for single object -leave_application = [ { "EmployeeID": "cdfb8371-0b21-4b8a-8903-1024df6c391e", "LeaveTypeID": "184ea8f7-d143-46dd-bef3-0c60e1aa6fca", "StartDate": "/Date(1572559200000+0000)/", "EndDate": "/Date(1572645600000+0000)/", "Description": "My updated Description" } ] # list[LeaveApplication] | +leave_application = [ { "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" } ] # list[LeaveApplication] | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a specific leave application - api_response = api_instance.update_leave_application(xero_tenant_id, leave_application_id, leave_application) + api_response = api_instance.update_leave_application(xero_tenant_id, leave_application_id, leave_application, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollAuApi->update_leave_application: %s\n" % e) @@ -1642,6 +1861,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **leave_application_id** | [**str**](.md)| Leave Application id for single object | **leave_application** | [**list[LeaveApplication]**](LeaveApplication.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1659,7 +1879,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_pay_run** -> PayRuns update_pay_run(xero_tenant_id, pay_run_id, pay_run=pay_run) +> PayRuns update_pay_run(xero_tenant_id, pay_run_id, pay_run, idempotency_key=idempotency_key) Updates a pay run @@ -1693,10 +1913,11 @@ api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant pay_run_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | PayRun id for single object -pay_run = [xero_python.payrollau.PayRun()] # list[PayRun] | (optional) +pay_run = [xero_python.payrollau.PayRun()] # list[PayRun] | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a pay run - api_response = api_instance.update_pay_run(xero_tenant_id, pay_run_id, pay_run=pay_run) + api_response = api_instance.update_pay_run(xero_tenant_id, pay_run_id, pay_run, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollAuApi->update_pay_run: %s\n" % e) @@ -1708,7 +1929,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **pay_run_id** | [**str**](.md)| PayRun id for single object | - **pay_run** | [**list[PayRun]**](PayRun.md)| | [optional] + **pay_run** | [**list[PayRun]**](PayRun.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1726,7 +1948,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_payslip** -> Payslips update_payslip(xero_tenant_id, payslip_id, payslip_lines=payslip_lines) +> Payslips update_payslip(xero_tenant_id, payslip_id, payslip_lines, idempotency_key=idempotency_key) Updates a payslip @@ -1760,10 +1982,11 @@ api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant payslip_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Payslip id for single object -payslip_lines = { "Payslip": { "EmployeeID": "cdfb8371-0b21-4b8a-8903-1024df6c391e", "DeductionLines": [ { "DeductionTypeID": "727af5e8-b347-4ae7-85fc-9b82266d0aec", "CalculationType": "FIXEDAMOUNT", "NumberOfUnits": 10 } ] } } # list[PayslipLines] | (optional) +payslip_lines = {"Payslip":{"EmployeeID":"cdfb8371-0b21-4b8a-8903-1024df6c391e","DeductionLines":[{"DeductionTypeID":"727af5e8-b347-4ae7-85fc-9b82266d0aec","CalculationType":"FIXEDAMOUNT","NumberOfUnits":10}]}} # list[PayslipLines] | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a payslip - api_response = api_instance.update_payslip(xero_tenant_id, payslip_id, payslip_lines=payslip_lines) + api_response = api_instance.update_payslip(xero_tenant_id, payslip_id, payslip_lines, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollAuApi->update_payslip: %s\n" % e) @@ -1775,7 +1998,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **payslip_id** | [**str**](.md)| Payslip id for single object | - **payslip_lines** | [**list[PayslipLines]**](PayslipLines.md)| | [optional] + **payslip_lines** | [**list[PayslipLines]**](PayslipLines.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1793,7 +2017,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_superfund** -> SuperFunds update_superfund(xero_tenant_id, super_fund_id, super_fund=super_fund) +> SuperFunds update_superfund(xero_tenant_id, super_fund_id, super_fund, idempotency_key=idempotency_key) Updates a superfund @@ -1827,10 +2051,11 @@ api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant super_fund_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Superfund id for single object -super_fund = [ { "Type":"REGULATED", "Name":"Nice23534" } ] # list[SuperFund] | (optional) +super_fund = [ { "Type":"REGULATED", "Name":"Nice23534" } ] # list[SuperFund] | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a superfund - api_response = api_instance.update_superfund(xero_tenant_id, super_fund_id, super_fund=super_fund) + api_response = api_instance.update_superfund(xero_tenant_id, super_fund_id, super_fund, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollAuApi->update_superfund: %s\n" % e) @@ -1842,7 +2067,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **super_fund_id** | [**str**](.md)| Superfund id for single object | - **super_fund** | [**list[SuperFund]**](SuperFund.md)| | [optional] + **super_fund** | [**list[SuperFund]**](SuperFund.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1860,7 +2086,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_timesheet** -> Timesheets update_timesheet(xero_tenant_id, timesheet_id, timesheet=timesheet) +> Timesheets update_timesheet(xero_tenant_id, timesheet_id, timesheet, idempotency_key=idempotency_key) Updates a timesheet @@ -1894,10 +2120,11 @@ api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant timesheet_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Timesheet id for single object -timesheet = [ { "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)/" } ] } ] # list[Timesheet] | (optional) +timesheet = [ { "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)/" } ] } ] # list[Timesheet] | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a timesheet - api_response = api_instance.update_timesheet(xero_tenant_id, timesheet_id, timesheet=timesheet) + api_response = api_instance.update_timesheet(xero_tenant_id, timesheet_id, timesheet, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollAuApi->update_timesheet: %s\n" % e) @@ -1909,7 +2136,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **timesheet_id** | [**str**](.md)| Timesheet id for single object | - **timesheet** | [**list[Timesheet]**](Timesheet.md)| | [optional] + **timesheet** | [**list[Timesheet]**](Timesheet.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type diff --git a/xero_python/payrollau/docs/SeniorMaritalStatus.md b/xero_python/payrollau/docs/SeniorMaritalStatus.md new file mode 100644 index 00000000..f92978d7 --- /dev/null +++ b/xero_python/payrollau/docs/SeniorMaritalStatus.md @@ -0,0 +1,9 @@ +# SeniorMaritalStatus + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollau/docs/Settings.md b/xero_python/payrollau/docs/Settings.md index 7753cf43..6772ab13 100644 --- a/xero_python/payrollau/docs/Settings.md +++ b/xero_python/payrollau/docs/Settings.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes **accounts** | [**list[Account]**](Account.md) | Payroll Account details for SuperExpense, SuperLiabilty, WagesExpense, PAYGLiability & WagesPayable. | [optional] **tracking_categories** | [**SettingsTrackingCategories**](SettingsTrackingCategories.md) | | [optional] **days_in_payroll_year** | **int** | Number of days in the Payroll year | [optional] +**employees_are_stp2** | **bool** | Indicates if the organisation has been enabled for STP Phase 2 editing of employees. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrollau/docs/TaxDeclaration.md b/xero_python/payrollau/docs/TaxDeclaration.md index e012c76a..e136779f 100644 --- a/xero_python/payrollau/docs/TaxDeclaration.md +++ b/xero_python/payrollau/docs/TaxDeclaration.md @@ -7,8 +7,12 @@ Name | Type | Description | Notes **employment_basis** | [**EmploymentBasis**](EmploymentBasis.md) | | [optional] **tfn_exemption_type** | [**TFNExemptionType**](TFNExemptionType.md) | | [optional] **tax_file_number** | **str** | The tax file number e.g 123123123. | [optional] +**abn** | **str** | 11-digit Australian Business Number e.g 21006819692 or an empty string (\"\") to unset a previously set value. Only applicable, and mandatory if income type is NONEMPLOYEE. | [optional] **australian_resident_for_tax_purposes** | **bool** | If the employee is Australian resident for tax purposes. e.g true or false | [optional] **residency_status** | [**ResidencyStatus**](ResidencyStatus.md) | | [optional] +**tax_scale_type** | [**TaxScaleType**](TaxScaleType.md) | | [optional] +**work_condition** | [**WorkCondition**](WorkCondition.md) | | [optional] +**senior_marital_status** | [**SeniorMaritalStatus**](SeniorMaritalStatus.md) | | [optional] **tax_free_threshold_claimed** | **bool** | If tax free threshold claimed. e.g true or false | [optional] **tax_offset_estimated_amount** | **float** | If has tax offset estimated then the tax offset estimated amount. e.g 100 | [optional] **has_help_debt** | **bool** | If employee has HECS or HELP debt. e.g true or false | [optional] @@ -18,7 +22,9 @@ Name | Type | Description | Notes **eligible_to_receive_leave_loading** | **bool** | If the employee is eligible to receive an additional percentage on top of ordinary earnings when they take leave (typically 17.5%). e.g true or false | [optional] **approved_withholding_variation_percentage** | **float** | If the employee has approved withholding variation. e.g (0 - 100) | [optional] **has_student_startup_loan** | **bool** | If the employee is eligible for student startup loan rules | [optional] +**has_loan_or_student_debt** | **bool** | 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) | [optional] **updated_date_utc** | **datetime** | Last modified timestamp | [optional] +**include_leave_loading_in_qualifying_earnings** | **bool** | Boolean to determine if leave loading is considered as qualifying earnings for superannuation guarantee calculations. Required when IncludeLeaveLoadingInSGC is specified in the payload | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrollau/docs/TaxScaleType.md b/xero_python/payrollau/docs/TaxScaleType.md new file mode 100644 index 00000000..acd5879c --- /dev/null +++ b/xero_python/payrollau/docs/TaxScaleType.md @@ -0,0 +1,9 @@ +# TaxScaleType + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollau/docs/WorkCondition.md b/xero_python/payrollau/docs/WorkCondition.md new file mode 100644 index 00000000..c9131cf7 --- /dev/null +++ b/xero_python/payrollau/docs/WorkCondition.md @@ -0,0 +1,9 @@ +# WorkCondition + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollau/models/__init__.py b/xero_python/payrollau/models/__init__.py index fabf94f5..a534bc59 100644 --- a/xero_python/payrollau/models/__init__.py +++ b/xero_python/payrollau/models/__init__.py @@ -2,12 +2,12 @@ # flake8: noqa """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -19,6 +19,7 @@ from xero_python.payrollau.models.allowance_type import AllowanceType from xero_python.payrollau.models.bank_account import BankAccount from xero_python.payrollau.models.calendar_type import CalendarType +from xero_python.payrollau.models.country_of_residence import CountryOfResidence from xero_python.payrollau.models.deduction_line import DeductionLine from xero_python.payrollau.models.deduction_type import DeductionType from xero_python.payrollau.models.deduction_type_calculation_type import ( @@ -37,14 +38,17 @@ from xero_python.payrollau.models.employment_termination_payment_type import ( EmploymentTerminationPaymentType, ) +from xero_python.payrollau.models.employment_type import EmploymentType from xero_python.payrollau.models.entitlement_final_pay_payout_type import ( EntitlementFinalPayPayoutType, ) from xero_python.payrollau.models.home_address import HomeAddress +from xero_python.payrollau.models.income_type import IncomeType from xero_python.payrollau.models.leave_accrual_line import LeaveAccrualLine from xero_python.payrollau.models.leave_application import LeaveApplication from xero_python.payrollau.models.leave_applications import LeaveApplications from xero_python.payrollau.models.leave_balance import LeaveBalance +from xero_python.payrollau.models.leave_category_code import LeaveCategoryCode from xero_python.payrollau.models.leave_earnings_line import LeaveEarningsLine from xero_python.payrollau.models.leave_line import LeaveLine from xero_python.payrollau.models.leave_line_calculation_type import ( @@ -58,9 +62,14 @@ LeaveTypeContributionType, ) from xero_python.payrollau.models.manual_tax_type import ManualTaxType +from xero_python.payrollau.models.opening_balance_leave_line import ( + OpeningBalanceLeaveLine, +) from xero_python.payrollau.models.opening_balances import OpeningBalances +from xero_python.payrollau.models.paid_leave_earnings_line import PaidLeaveEarningsLine from xero_python.payrollau.models.pay_item import PayItem from xero_python.payrollau.models.pay_items import PayItems +from xero_python.payrollau.models.pay_out_type import PayOutType from xero_python.payrollau.models.pay_run import PayRun from xero_python.payrollau.models.pay_run_status import PayRunStatus from xero_python.payrollau.models.pay_runs import PayRuns @@ -78,6 +87,7 @@ from xero_python.payrollau.models.reimbursement_lines import ReimbursementLines from xero_python.payrollau.models.reimbursement_type import ReimbursementType from xero_python.payrollau.models.residency_status import ResidencyStatus +from xero_python.payrollau.models.senior_marital_status import SeniorMaritalStatus from xero_python.payrollau.models.settings import Settings from xero_python.payrollau.models.settings_object import SettingsObject from xero_python.payrollau.models.settings_tracking_categories import ( @@ -107,9 +117,11 @@ from xero_python.payrollau.models.tfn_exemption_type import TFNExemptionType from xero_python.payrollau.models.tax_declaration import TaxDeclaration from xero_python.payrollau.models.tax_line import TaxLine +from xero_python.payrollau.models.tax_scale_type import TaxScaleType from xero_python.payrollau.models.timesheet import Timesheet from xero_python.payrollau.models.timesheet_line import TimesheetLine from xero_python.payrollau.models.timesheet_object import TimesheetObject from xero_python.payrollau.models.timesheet_status import TimesheetStatus from xero_python.payrollau.models.timesheets import Timesheets from xero_python.payrollau.models.validation_error import ValidationError +from xero_python.payrollau.models.work_condition import WorkCondition diff --git a/xero_python/payrollau/models/account.py b/xero_python/payrollau/models/account.py index eb44265b..e29fc000 100644 --- a/xero_python/payrollau/models/account.py +++ b/xero_python/payrollau/models/account.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/account_type.py b/xero_python/payrollau/models/account_type.py index 19d93988..4d13c734 100644 --- a/xero_python/payrollau/models/account_type.py +++ b/xero_python/payrollau/models/account_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/allowance_category.py b/xero_python/payrollau/models/allowance_category.py index a0264f1b..e28f2db5 100644 --- a/xero_python/payrollau/models/allowance_category.py +++ b/xero_python/payrollau/models/allowance_category.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/allowance_type.py b/xero_python/payrollau/models/allowance_type.py index 970dbeff..d46c40b1 100644 --- a/xero_python/payrollau/models/allowance_type.py +++ b/xero_python/payrollau/models/allowance_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -30,7 +30,6 @@ class AllowanceType(Enum): MEALS = "MEALS" TRAVEL = "TRAVEL" OTHER = "OTHER" - JOBKEEPER = "JOBKEEPER" TOOLS = "TOOLS" TASKS = "TASKS" QUALIFICATIONS = "QUALIFICATIONS" diff --git a/xero_python/payrollau/models/api_exception.py b/xero_python/payrollau/models/api_exception.py index d4c9d5e6..543a7fb5 100644 --- a/xero_python/payrollau/models/api_exception.py +++ b/xero_python/payrollau/models/api_exception.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/bank_account.py b/xero_python/payrollau/models/bank_account.py index 821d29a3..99bcf196 100644 --- a/xero_python/payrollau/models/bank_account.py +++ b/xero_python/payrollau/models/bank_account.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/calendar_type.py b/xero_python/payrollau/models/calendar_type.py index 44bc1242..333a140e 100644 --- a/xero_python/payrollau/models/calendar_type.py +++ b/xero_python/payrollau/models/calendar_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/country_of_residence.py b/xero_python/payrollau/models/country_of_residence.py new file mode 100644 index 00000000..069f02e0 --- /dev/null +++ b/xero_python/payrollau/models/country_of_residence.py @@ -0,0 +1,276 @@ +# coding: utf-8 + +""" +Xero Payroll AU API + +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class CountryOfResidence(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + AF = "AF" + AX = "AX" + AL = "AL" + DZ = "DZ" + AS = "AS" + AD = "AD" + AO = "AO" + AI = "AI" + AQ = "AQ" + AG = "AG" + AR = "AR" + AM = "AM" + AW = "AW" + AU = "AU" + AT = "AT" + AZ = "AZ" + BS = "BS" + BH = "BH" + BD = "BD" + BB = "BB" + BY = "BY" + BE = "BE" + BZ = "BZ" + BJ = "BJ" + BM = "BM" + BT = "BT" + BO = "BO" + BA = "BA" + BW = "BW" + BV = "BV" + BR = "BR" + IO = "IO" + BN = "BN" + BG = "BG" + BF = "BF" + BI = "BI" + KH = "KH" + CM = "CM" + CA = "CA" + CV = "CV" + KY = "KY" + CF = "CF" + TD = "TD" + CL = "CL" + CN = "CN" + CX = "CX" + CC = "CC" + CO = "CO" + KM = "KM" + CG = "CG" + CD = "CD" + CK = "CK" + CR = "CR" + CI = "CI" + HR = "HR" + CU = "CU" + CY = "CY" + CZ = "CZ" + DK = "DK" + DJ = "DJ" + DM = "DM" + DO = "DO" + EC = "EC" + EG = "EG" + SV = "SV" + GQ = "GQ" + ER = "ER" + EE = "EE" + ET = "ET" + FK = "FK" + FO = "FO" + FJ = "FJ" + FI = "FI" + FR = "FR" + GF = "GF" + PF = "PF" + TF = "TF" + GA = "GA" + GM = "GM" + GE = "GE" + DE = "DE" + GH = "GH" + GI = "GI" + GR = "GR" + GL = "GL" + GD = "GD" + GP = "GP" + GU = "GU" + GT = "GT" + GG = "GG" + GN = "GN" + GW = "GW" + GY = "GY" + HT = "HT" + HM = "HM" + VA = "VA" + HN = "HN" + HK = "HK" + HU = "HU" + IS = "IS" + IN = "IN" + ID = "ID" + IR = "IR" + IQ = "IQ" + IE = "IE" + IM = "IM" + IL = "IL" + IT = "IT" + JM = "JM" + JP = "JP" + JE = "JE" + JO = "JO" + KZ = "KZ" + KE = "KE" + KI = "KI" + KP = "KP" + KR = "KR" + KW = "KW" + KG = "KG" + LA = "LA" + LV = "LV" + LB = "LB" + LS = "LS" + LR = "LR" + LY = "LY" + LI = "LI" + LT = "LT" + LU = "LU" + MO = "MO" + MK = "MK" + MG = "MG" + MW = "MW" + MY = "MY" + MV = "MV" + ML = "ML" + MT = "MT" + MH = "MH" + MQ = "MQ" + MR = "MR" + MU = "MU" + YT = "YT" + MX = "MX" + FM = "FM" + MD = "MD" + MC = "MC" + MN = "MN" + ME = "ME" + MS = "MS" + MA = "MA" + MZ = "MZ" + MM = "MM" + NA = "NA" + NR = "NR" + NP = "NP" + NL = "NL" + AN = "AN" + NC = "NC" + NZ = "NZ" + NI = "NI" + NE = "NE" + NG = "NG" + NU = "NU" + NF = "NF" + MP = "MP" + NO = "NO" + OM = "OM" + PK = "PK" + PW = "PW" + PS = "PS" + PA = "PA" + PG = "PG" + PY = "PY" + PE = "PE" + PH = "PH" + PN = "PN" + PL = "PL" + PT = "PT" + PR = "PR" + QA = "QA" + RE = "RE" + RO = "RO" + RU = "RU" + RW = "RW" + BL = "BL" + SH = "SH" + KN = "KN" + LC = "LC" + MF = "MF" + PM = "PM" + VC = "VC" + WS = "WS" + SM = "SM" + ST = "ST" + SA = "SA" + SN = "SN" + RS = "RS" + SC = "SC" + SL = "SL" + SG = "SG" + SK = "SK" + SI = "SI" + SB = "SB" + SO = "SO" + ZA = "ZA" + GS = "GS" + ES = "ES" + LK = "LK" + SD = "SD" + SR = "SR" + SJ = "SJ" + SZ = "SZ" + SE = "SE" + CH = "CH" + SY = "SY" + TW = "TW" + TJ = "TJ" + TZ = "TZ" + TH = "TH" + TL = "TL" + TG = "TG" + TK = "TK" + TO = "TO" + TT = "TT" + TN = "TN" + TR = "TR" + TM = "TM" + TC = "TC" + TV = "TV" + UG = "UG" + UA = "UA" + AE = "AE" + GB = "GB" + US = "US" + UM = "UM" + UY = "UY" + UZ = "UZ" + VU = "VU" + VE = "VE" + VN = "VN" + VG = "VG" + VI = "VI" + WF = "WF" + EH = "EH" + YE = "YE" + ZM = "ZM" + ZW = "ZW" + BQ = "BQ" + CW = "CW" + SX = "SX" + SS = "SS" diff --git a/xero_python/payrollau/models/deduction_line.py b/xero_python/payrollau/models/deduction_line.py index 9d8e7850..6e36b44c 100644 --- a/xero_python/payrollau/models/deduction_line.py +++ b/xero_python/payrollau/models/deduction_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/deduction_type.py b/xero_python/payrollau/models/deduction_type.py index 710f70c6..56b8b44c 100644 --- a/xero_python/payrollau/models/deduction_type.py +++ b/xero_python/payrollau/models/deduction_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/deduction_type_calculation_type.py b/xero_python/payrollau/models/deduction_type_calculation_type.py index 064ed497..667e35df 100644 --- a/xero_python/payrollau/models/deduction_type_calculation_type.py +++ b/xero_python/payrollau/models/deduction_type_calculation_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/earnings_line.py b/xero_python/payrollau/models/earnings_line.py index 09ba7a36..8ba80e68 100644 --- a/xero_python/payrollau/models/earnings_line.py +++ b/xero_python/payrollau/models/earnings_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/earnings_rate.py b/xero_python/payrollau/models/earnings_rate.py index 6dcd7d71..0f2fc24b 100644 --- a/xero_python/payrollau/models/earnings_rate.py +++ b/xero_python/payrollau/models/earnings_rate.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -36,6 +36,9 @@ class EarningsRate(BaseModel): "is_exempt_from_tax": "bool", "is_exempt_from_super": "bool", "is_reportable_as_w1": "bool", + "is_qualifying_earnings": "bool", + "allowance_contributes_to_annual_leave_rate": "bool", + "allowance_contributes_to_overtime_rate": "bool", "earnings_type": "EarningsType", "earnings_rate_id": "str", "rate_type": "RateType", @@ -57,6 +60,9 @@ class EarningsRate(BaseModel): "is_exempt_from_tax": "IsExemptFromTax", "is_exempt_from_super": "IsExemptFromSuper", "is_reportable_as_w1": "IsReportableAsW1", + "is_qualifying_earnings": "IsQualifyingEarnings", + "allowance_contributes_to_annual_leave_rate": "AllowanceContributesToAnnualLeaveRate", + "allowance_contributes_to_overtime_rate": "AllowanceContributesToOvertimeRate", "earnings_type": "EarningsType", "earnings_rate_id": "EarningsRateID", "rate_type": "RateType", @@ -79,6 +85,9 @@ def __init__( is_exempt_from_tax=None, is_exempt_from_super=None, is_reportable_as_w1=None, + is_qualifying_earnings=None, + allowance_contributes_to_annual_leave_rate=None, + allowance_contributes_to_overtime_rate=None, earnings_type=None, earnings_rate_id=None, rate_type=None, @@ -100,6 +109,9 @@ def __init__( self._is_exempt_from_tax = None self._is_exempt_from_super = None self._is_reportable_as_w1 = None + self._is_qualifying_earnings = None + self._allowance_contributes_to_annual_leave_rate = None + self._allowance_contributes_to_overtime_rate = None self._earnings_type = None self._earnings_rate_id = None self._rate_type = None @@ -126,6 +138,15 @@ def __init__( self.is_exempt_from_super = is_exempt_from_super if is_reportable_as_w1 is not None: self.is_reportable_as_w1 = is_reportable_as_w1 + self.is_qualifying_earnings = is_qualifying_earnings + if allowance_contributes_to_annual_leave_rate is not None: + self.allowance_contributes_to_annual_leave_rate = ( + allowance_contributes_to_annual_leave_rate + ) + if allowance_contributes_to_overtime_rate is not None: + self.allowance_contributes_to_overtime_rate = ( + allowance_contributes_to_overtime_rate + ) if earnings_type is not None: self.earnings_type = earnings_type if earnings_rate_id is not None: @@ -301,6 +322,87 @@ def is_reportable_as_w1(self, is_reportable_as_w1): self._is_reportable_as_w1 = is_reportable_as_w1 + @property + def is_qualifying_earnings(self): + """Gets the is_qualifying_earnings of this EarningsRate. # noqa: E501 + + Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations # noqa: E501 + + :return: The is_qualifying_earnings of this EarningsRate. # noqa: E501 + :rtype: bool + """ + return self._is_qualifying_earnings + + @is_qualifying_earnings.setter + def is_qualifying_earnings(self, is_qualifying_earnings): + """Sets the is_qualifying_earnings of this EarningsRate. + + Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations # noqa: E501 + + :param is_qualifying_earnings: The is_qualifying_earnings of this EarningsRate. # noqa: E501 + :type: bool + """ + if is_qualifying_earnings is None: + raise ValueError( + "Invalid value for `is_qualifying_earnings`, must not be `None`" + ) # noqa: E501 + + self._is_qualifying_earnings = is_qualifying_earnings + + @property + def allowance_contributes_to_annual_leave_rate(self): + """Gets the allowance_contributes_to_annual_leave_rate of this EarningsRate. # noqa: E501 + + Boolean to determine if the allowance earnings rate contributes towards annual leave rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT # noqa: E501 + + :return: The allowance_contributes_to_annual_leave_rate of this EarningsRate. # noqa: E501 + :rtype: bool + """ + return self._allowance_contributes_to_annual_leave_rate + + @allowance_contributes_to_annual_leave_rate.setter + def allowance_contributes_to_annual_leave_rate( + self, allowance_contributes_to_annual_leave_rate + ): + """Sets the allowance_contributes_to_annual_leave_rate of this EarningsRate. + + Boolean to determine if the allowance earnings rate contributes towards annual leave rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT # noqa: E501 + + :param allowance_contributes_to_annual_leave_rate: The allowance_contributes_to_annual_leave_rate of this EarningsRate. # noqa: E501 + :type: bool + """ + + self._allowance_contributes_to_annual_leave_rate = ( + allowance_contributes_to_annual_leave_rate + ) + + @property + def allowance_contributes_to_overtime_rate(self): + """Gets the allowance_contributes_to_overtime_rate of this EarningsRate. # noqa: E501 + + Boolean to determine if the allowance earnings rate contributes towards overtime allowance rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT # noqa: E501 + + :return: The allowance_contributes_to_overtime_rate of this EarningsRate. # noqa: E501 + :rtype: bool + """ + return self._allowance_contributes_to_overtime_rate + + @allowance_contributes_to_overtime_rate.setter + def allowance_contributes_to_overtime_rate( + self, allowance_contributes_to_overtime_rate + ): + """Sets the allowance_contributes_to_overtime_rate of this EarningsRate. + + Boolean to determine if the allowance earnings rate contributes towards overtime allowance rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT # noqa: E501 + + :param allowance_contributes_to_overtime_rate: The allowance_contributes_to_overtime_rate of this EarningsRate. # noqa: E501 + :type: bool + """ + + self._allowance_contributes_to_overtime_rate = ( + allowance_contributes_to_overtime_rate + ) + @property def earnings_type(self): """Gets the earnings_type of this EarningsRate. # noqa: E501 diff --git a/xero_python/payrollau/models/earnings_rate_calculation_type.py b/xero_python/payrollau/models/earnings_rate_calculation_type.py index 5673f2da..58bae2ed 100644 --- a/xero_python/payrollau/models/earnings_rate_calculation_type.py +++ b/xero_python/payrollau/models/earnings_rate_calculation_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/earnings_type.py b/xero_python/payrollau/models/earnings_type.py index 64bf9fa9..c136cceb 100644 --- a/xero_python/payrollau/models/earnings_type.py +++ b/xero_python/payrollau/models/earnings_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -36,3 +36,5 @@ class EarningsType(Enum): LUMPSUME = "LUMPSUME" LUMPSUMW = "LUMPSUMW" DIRECTORSFEES = "DIRECTORSFEES" + PAIDPARENTALLEAVE = "PAIDPARENTALLEAVE" + WORKERSCOMPENSATION = "WORKERSCOMPENSATION" diff --git a/xero_python/payrollau/models/employee.py b/xero_python/payrollau/models/employee.py index b18378c8..b432faf8 100644 --- a/xero_python/payrollau/models/employee.py +++ b/xero_python/payrollau/models/employee.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -56,8 +56,11 @@ class Employee(BaseModel): "pay_template": "PayTemplate", "opening_balances": "OpeningBalances", "tax_declaration": "TaxDeclaration", + "income_type": "IncomeType", + "employment_type": "EmploymentType", + "country_of_residence": "CountryOfResidence", + "is_stp2_qualified": "bool", "leave_balances": "list[LeaveBalance]", - "leave_lines": "list[LeaveLine]", "super_memberships": "list[SuperMembership]", "status": "EmployeeStatus", "updated_date_utc": "datetime[ms-format]", @@ -91,8 +94,11 @@ class Employee(BaseModel): "pay_template": "PayTemplate", "opening_balances": "OpeningBalances", "tax_declaration": "TaxDeclaration", + "income_type": "IncomeType", + "employment_type": "EmploymentType", + "country_of_residence": "CountryOfResidence", + "is_stp2_qualified": "IsSTP2Qualified", "leave_balances": "LeaveBalances", - "leave_lines": "LeaveLines", "super_memberships": "SuperMemberships", "status": "Status", "updated_date_utc": "UpdatedDateUTC", @@ -127,8 +133,11 @@ def __init__( pay_template=None, opening_balances=None, tax_declaration=None, + income_type=None, + employment_type=None, + country_of_residence=None, + is_stp2_qualified=None, leave_balances=None, - leave_lines=None, super_memberships=None, status=None, updated_date_utc=None, @@ -162,8 +171,11 @@ def __init__( self._pay_template = None self._opening_balances = None self._tax_declaration = None + self._income_type = None + self._employment_type = None + self._country_of_residence = None + self._is_stp2_qualified = None self._leave_balances = None - self._leave_lines = None self._super_memberships = None self._status = None self._updated_date_utc = None @@ -221,10 +233,16 @@ def __init__( self.opening_balances = opening_balances if tax_declaration is not None: self.tax_declaration = tax_declaration + if income_type is not None: + self.income_type = income_type + if employment_type is not None: + self.employment_type = employment_type + if country_of_residence is not None: + self.country_of_residence = country_of_residence + if is_stp2_qualified is not None: + self.is_stp2_qualified = is_stp2_qualified if leave_balances is not None: self.leave_balances = leave_balances - if leave_lines is not None: - self.leave_lines = leave_lines if super_memberships is not None: self.super_memberships = super_memberships if status is not None: @@ -432,7 +450,7 @@ def email(self, email): def gender(self): """Gets the gender of this Employee. # noqa: E501 - The employee’s gender. See Employee Gender # noqa: E501 + The employee’s gender. See Employee Gender # noqa: E501 :return: The gender of this Employee. # noqa: E501 :rtype: str @@ -443,7 +461,7 @@ def gender(self): def gender(self, gender): """Sets the gender of this Employee. - The employee’s gender. See Employee Gender # noqa: E501 + The employee’s gender. See Employee Gender # noqa: E501 :param gender: The gender of this Employee. # noqa: E501 :type: str @@ -852,6 +870,92 @@ def tax_declaration(self, tax_declaration): self._tax_declaration = tax_declaration + @property + def income_type(self): + """Gets the income_type of this Employee. # noqa: E501 + + + :return: The income_type of this Employee. # noqa: E501 + :rtype: IncomeType + """ + return self._income_type + + @income_type.setter + def income_type(self, income_type): + """Sets the income_type of this Employee. + + + :param income_type: The income_type of this Employee. # noqa: E501 + :type: IncomeType + """ + + self._income_type = income_type + + @property + def employment_type(self): + """Gets the employment_type of this Employee. # noqa: E501 + + + :return: The employment_type of this Employee. # noqa: E501 + :rtype: EmploymentType + """ + return self._employment_type + + @employment_type.setter + def employment_type(self, employment_type): + """Sets the employment_type of this Employee. + + + :param employment_type: The employment_type of this Employee. # noqa: E501 + :type: EmploymentType + """ + + self._employment_type = employment_type + + @property + def country_of_residence(self): + """Gets the country_of_residence of this Employee. # noqa: E501 + + + :return: The country_of_residence of this Employee. # noqa: E501 + :rtype: CountryOfResidence + """ + return self._country_of_residence + + @country_of_residence.setter + def country_of_residence(self, country_of_residence): + """Sets the country_of_residence of this Employee. + + + :param country_of_residence: The country_of_residence of this Employee. # noqa: E501 + :type: CountryOfResidence + """ + + self._country_of_residence = country_of_residence + + @property + def is_stp2_qualified(self): + """Gets the is_stp2_qualified of this Employee. # noqa: E501 + + Indicates if the employee has been updated for STP Phase 2 compliance. Doesn't indicate that the employee is payable. # noqa: E501 + + :return: The is_stp2_qualified of this Employee. # noqa: E501 + :rtype: bool + """ + return self._is_stp2_qualified + + @is_stp2_qualified.setter + def is_stp2_qualified(self, is_stp2_qualified): + """Sets the is_stp2_qualified of this Employee. + + Indicates if the employee has been updated for STP Phase 2 compliance. Doesn't indicate that the employee is payable. # noqa: E501 + + :param is_stp2_qualified: The is_stp2_qualified of this Employee. # noqa: E501 + :type: bool + """ + + self._is_stp2_qualified = is_stp2_qualified + @property def leave_balances(self): """Gets the leave_balances of this Employee. # noqa: E501 @@ -873,27 +977,6 @@ def leave_balances(self, leave_balances): self._leave_balances = leave_balances - @property - def leave_lines(self): - """Gets the leave_lines of this Employee. # noqa: E501 - - - :return: The leave_lines of this Employee. # noqa: E501 - :rtype: list[LeaveLine] - """ - return self._leave_lines - - @leave_lines.setter - def leave_lines(self, leave_lines): - """Sets the leave_lines of this Employee. - - - :param leave_lines: The leave_lines of this Employee. # noqa: E501 - :type: list[LeaveLine] - """ - - self._leave_lines = leave_lines - @property def super_memberships(self): """Gets the super_memberships of this Employee. # noqa: E501 diff --git a/xero_python/payrollau/models/employee_status.py b/xero_python/payrollau/models/employee_status.py index 628aed98..96939d95 100644 --- a/xero_python/payrollau/models/employee_status.py +++ b/xero_python/payrollau/models/employee_status.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/employees.py b/xero_python/payrollau/models/employees.py index 0ea5f01a..bcaec799 100644 --- a/xero_python/payrollau/models/employees.py +++ b/xero_python/payrollau/models/employees.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/employment_basis.py b/xero_python/payrollau/models/employment_basis.py index 5ca369a9..6e3e3440 100644 --- a/xero_python/payrollau/models/employment_basis.py +++ b/xero_python/payrollau/models/employment_basis.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -29,3 +29,4 @@ class EmploymentBasis(Enum): CASUAL = "CASUAL" LABOURHIRE = "LABOURHIRE" SUPERINCOMESTREAM = "SUPERINCOMESTREAM" + NONEMPLOYEE = "NONEMPLOYEE" diff --git a/xero_python/payrollau/models/employment_termination_payment_type.py b/xero_python/payrollau/models/employment_termination_payment_type.py index 62bfe29b..ae7e9351 100644 --- a/xero_python/payrollau/models/employment_termination_payment_type.py +++ b/xero_python/payrollau/models/employment_termination_payment_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/employment_type.py b/xero_python/payrollau/models/employment_type.py new file mode 100644 index 00000000..92fccf6c --- /dev/null +++ b/xero_python/payrollau/models/employment_type.py @@ -0,0 +1,28 @@ +# coding: utf-8 + +""" +Xero Payroll AU API + +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class EmploymentType(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + EMPLOYEE = "EMPLOYEE" + CONTRACTOR = "CONTRACTOR" diff --git a/xero_python/payrollau/models/entitlement_final_pay_payout_type.py b/xero_python/payrollau/models/entitlement_final_pay_payout_type.py index f25e777b..20df7b8f 100644 --- a/xero_python/payrollau/models/entitlement_final_pay_payout_type.py +++ b/xero_python/payrollau/models/entitlement_final_pay_payout_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/home_address.py b/xero_python/payrollau/models/home_address.py index 1d0a43fe..7dc0bad5 100644 --- a/xero_python/payrollau/models/home_address.py +++ b/xero_python/payrollau/models/home_address.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/income_type.py b/xero_python/payrollau/models/income_type.py new file mode 100644 index 00000000..dfdac20d --- /dev/null +++ b/xero_python/payrollau/models/income_type.py @@ -0,0 +1,31 @@ +# coding: utf-8 + +""" +Xero Payroll AU API + +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class IncomeType(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + SALARYANDWAGES = "SALARYANDWAGES" + WORKINGHOLIDAYMAKER = "WORKINGHOLIDAYMAKER" + NONEMPLOYEE = "NONEMPLOYEE" + CLOSELYHELDPAYEES = "CLOSELYHELDPAYEES" + LABOURHIRE = "LABOURHIRE" diff --git a/xero_python/payrollau/models/leave_accrual_line.py b/xero_python/payrollau/models/leave_accrual_line.py index 0c067d77..ce245143 100644 --- a/xero_python/payrollau/models/leave_accrual_line.py +++ b/xero_python/payrollau/models/leave_accrual_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/leave_application.py b/xero_python/payrollau/models/leave_application.py index 496ebd6d..327c3f8e 100644 --- a/xero_python/payrollau/models/leave_application.py +++ b/xero_python/payrollau/models/leave_application.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -37,6 +37,7 @@ class LeaveApplication(BaseModel): "start_date": "date[ms-format]", "end_date": "date[ms-format]", "description": "str", + "pay_out_type": "PayOutType", "leave_periods": "list[LeavePeriod]", "updated_date_utc": "datetime[ms-format]", "validation_errors": "list[ValidationError]", @@ -50,6 +51,7 @@ class LeaveApplication(BaseModel): "start_date": "StartDate", "end_date": "EndDate", "description": "Description", + "pay_out_type": "PayOutType", "leave_periods": "LeavePeriods", "updated_date_utc": "UpdatedDateUTC", "validation_errors": "ValidationErrors", @@ -64,6 +66,7 @@ def __init__( start_date=None, end_date=None, description=None, + pay_out_type=None, leave_periods=None, updated_date_utc=None, validation_errors=None, @@ -77,6 +80,7 @@ def __init__( self._start_date = None self._end_date = None self._description = None + self._pay_out_type = None self._leave_periods = None self._updated_date_utc = None self._validation_errors = None @@ -96,6 +100,8 @@ def __init__( self.end_date = end_date if description is not None: self.description = description + if pay_out_type is not None: + self.pay_out_type = pay_out_type if leave_periods is not None: self.leave_periods = leave_periods if updated_date_utc is not None: @@ -264,6 +270,27 @@ def description(self, description): self._description = description + @property + def pay_out_type(self): + """Gets the pay_out_type of this LeaveApplication. # noqa: E501 + + + :return: The pay_out_type of this LeaveApplication. # noqa: E501 + :rtype: PayOutType + """ + return self._pay_out_type + + @pay_out_type.setter + def pay_out_type(self, pay_out_type): + """Sets the pay_out_type of this LeaveApplication. + + + :param pay_out_type: The pay_out_type of this LeaveApplication. # noqa: E501 + :type: PayOutType + """ + + self._pay_out_type = pay_out_type + @property def leave_periods(self): """Gets the leave_periods of this LeaveApplication. # noqa: E501 diff --git a/xero_python/payrollau/models/leave_applications.py b/xero_python/payrollau/models/leave_applications.py index 76b072d2..426bb91e 100644 --- a/xero_python/payrollau/models/leave_applications.py +++ b/xero_python/payrollau/models/leave_applications.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/leave_balance.py b/xero_python/payrollau/models/leave_balance.py index 005e2628..c3a60eee 100644 --- a/xero_python/payrollau/models/leave_balance.py +++ b/xero_python/payrollau/models/leave_balance.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/leave_category_code.py b/xero_python/payrollau/models/leave_category_code.py new file mode 100644 index 00000000..9ab4ee75 --- /dev/null +++ b/xero_python/payrollau/models/leave_category_code.py @@ -0,0 +1,38 @@ +# coding: utf-8 + +""" +Xero Payroll AU API + +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class LeaveCategoryCode(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + ANNUALLEAVE = "ANNUALLEAVE" + LONGSERVICELEAVE = "LONGSERVICELEAVE" + PERSONALSICKCARERSLEAVE = "PERSONALSICKCARERSLEAVE" + ROSTEREDDAYOFF = "ROSTEREDDAYOFF" + TIMEOFFINLIEU = "TIMEOFFINLIEU" + COMPASSIONATEANDBEREAVEMENTLEAVE = "COMPASSIONATEANDBEREAVEMENTLEAVE" + STUDYLEAVE = "STUDYLEAVE" + FAMILYANDDOMESTICVIOLENCELEAVE = "FAMILYANDDOMESTICVIOLENCELEAVE" + SPECIALPAIDLEAVE = "SPECIALPAIDLEAVE" + COMMUNITYSERVICELEAVE = "COMMUNITYSERVICELEAVE" + JURYDUTYLEAVE = "JURYDUTYLEAVE" + DEFENCERESERVELEAVE = "DEFENCERESERVELEAVE" diff --git a/xero_python/payrollau/models/leave_earnings_line.py b/xero_python/payrollau/models/leave_earnings_line.py index 240f0627..6fcb56fa 100644 --- a/xero_python/payrollau/models/leave_earnings_line.py +++ b/xero_python/payrollau/models/leave_earnings_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -33,22 +33,29 @@ class LeaveEarningsLine(BaseModel): "earnings_rate_id": "str", "rate_per_unit": "float", "number_of_units": "float", + "pay_out_type": "PayOutType", } attribute_map = { "earnings_rate_id": "EarningsRateID", "rate_per_unit": "RatePerUnit", "number_of_units": "NumberOfUnits", + "pay_out_type": "PayOutType", } def __init__( - self, earnings_rate_id=None, rate_per_unit=None, number_of_units=None + self, + earnings_rate_id=None, + rate_per_unit=None, + number_of_units=None, + pay_out_type=None, ): # noqa: E501 """LeaveEarningsLine - a model defined in OpenAPI""" # noqa: E501 self._earnings_rate_id = None self._rate_per_unit = None self._number_of_units = None + self._pay_out_type = None self.discriminator = None if earnings_rate_id is not None: @@ -57,6 +64,8 @@ def __init__( self.rate_per_unit = rate_per_unit if number_of_units is not None: self.number_of_units = number_of_units + if pay_out_type is not None: + self.pay_out_type = pay_out_type @property def earnings_rate_id(self): @@ -126,3 +135,24 @@ def number_of_units(self, number_of_units): """ self._number_of_units = number_of_units + + @property + def pay_out_type(self): + """Gets the pay_out_type of this LeaveEarningsLine. # noqa: E501 + + + :return: The pay_out_type of this LeaveEarningsLine. # noqa: E501 + :rtype: PayOutType + """ + return self._pay_out_type + + @pay_out_type.setter + def pay_out_type(self, pay_out_type): + """Sets the pay_out_type of this LeaveEarningsLine. + + + :param pay_out_type: The pay_out_type of this LeaveEarningsLine. # noqa: E501 + :type: PayOutType + """ + + self._pay_out_type = pay_out_type diff --git a/xero_python/payrollau/models/leave_line.py b/xero_python/payrollau/models/leave_line.py index b37e47c5..a7624a1e 100644 --- a/xero_python/payrollau/models/leave_line.py +++ b/xero_python/payrollau/models/leave_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -35,6 +35,7 @@ class LeaveLine(BaseModel): "entitlement_final_pay_payout_type": "EntitlementFinalPayPayoutType", "employment_termination_payment_type": "EmploymentTerminationPaymentType", "include_superannuation_guarantee_contribution": "bool", + "is_qualifying_earnings": "bool", "number_of_units": "float", "annual_number_of_units": "float", "full_time_number_of_units_per_period": "float", @@ -46,6 +47,7 @@ class LeaveLine(BaseModel): "entitlement_final_pay_payout_type": "EntitlementFinalPayPayoutType", "employment_termination_payment_type": "EmploymentTerminationPaymentType", "include_superannuation_guarantee_contribution": "IncludeSuperannuationGuaranteeContribution", + "is_qualifying_earnings": "IsQualifyingEarnings", "number_of_units": "NumberOfUnits", "annual_number_of_units": "AnnualNumberOfUnits", "full_time_number_of_units_per_period": "FullTimeNumberOfUnitsPerPeriod", @@ -58,6 +60,7 @@ def __init__( entitlement_final_pay_payout_type=None, employment_termination_payment_type=None, include_superannuation_guarantee_contribution=None, + is_qualifying_earnings=None, number_of_units=None, annual_number_of_units=None, full_time_number_of_units_per_period=None, @@ -69,6 +72,7 @@ def __init__( self._entitlement_final_pay_payout_type = None self._employment_termination_payment_type = None self._include_superannuation_guarantee_contribution = None + self._is_qualifying_earnings = None self._number_of_units = None self._annual_number_of_units = None self._full_time_number_of_units_per_period = None @@ -88,6 +92,7 @@ def __init__( self.include_superannuation_guarantee_contribution = ( include_superannuation_guarantee_contribution ) + self.is_qualifying_earnings = is_qualifying_earnings if number_of_units is not None: self.number_of_units = number_of_units if annual_number_of_units is not None: @@ -210,6 +215,33 @@ def include_superannuation_guarantee_contribution( include_superannuation_guarantee_contribution ) + @property + def is_qualifying_earnings(self): + """Gets the is_qualifying_earnings of this LeaveLine. # noqa: E501 + + Boolean to determine if the leave line is considered as qualifying earnings for superannuation guarantee calculations # noqa: E501 + + :return: The is_qualifying_earnings of this LeaveLine. # noqa: E501 + :rtype: bool + """ + return self._is_qualifying_earnings + + @is_qualifying_earnings.setter + def is_qualifying_earnings(self, is_qualifying_earnings): + """Sets the is_qualifying_earnings of this LeaveLine. + + Boolean to determine if the leave line is considered as qualifying earnings for superannuation guarantee calculations # noqa: E501 + + :param is_qualifying_earnings: The is_qualifying_earnings of this LeaveLine. # noqa: E501 + :type: bool + """ + if is_qualifying_earnings is None: + raise ValueError( + "Invalid value for `is_qualifying_earnings`, must not be `None`" + ) # noqa: E501 + + self._is_qualifying_earnings = is_qualifying_earnings + @property def number_of_units(self): """Gets the number_of_units of this LeaveLine. # noqa: E501 diff --git a/xero_python/payrollau/models/leave_line_calculation_type.py b/xero_python/payrollau/models/leave_line_calculation_type.py index 713503bd..1f9efab8 100644 --- a/xero_python/payrollau/models/leave_line_calculation_type.py +++ b/xero_python/payrollau/models/leave_line_calculation_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -28,4 +28,3 @@ class LeaveLineCalculationType(Enum): FIXEDAMOUNTEACHPERIOD = "FIXEDAMOUNTEACHPERIOD" ENTERRATEINPAYTEMPLATE = "ENTERRATEINPAYTEMPLATE" BASEDONORDINARYEARNINGS = "BASEDONORDINARYEARNINGS" - EMPTY = "" diff --git a/xero_python/payrollau/models/leave_lines.py b/xero_python/payrollau/models/leave_lines.py index ec518109..e3cf8f3e 100644 --- a/xero_python/payrollau/models/leave_lines.py +++ b/xero_python/payrollau/models/leave_lines.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/leave_period.py b/xero_python/payrollau/models/leave_period.py index 7866ab3a..4c1c3014 100644 --- a/xero_python/payrollau/models/leave_period.py +++ b/xero_python/payrollau/models/leave_period.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/leave_period_status.py b/xero_python/payrollau/models/leave_period_status.py index 49a73e28..84a706f9 100644 --- a/xero_python/payrollau/models/leave_period_status.py +++ b/xero_python/payrollau/models/leave_period_status.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -26,3 +26,5 @@ class LeavePeriodStatus(Enum): SCHEDULED = "SCHEDULED" PROCESSED = "PROCESSED" + REQUESTED = "REQUESTED" + REJECTED = "REJECTED" diff --git a/xero_python/payrollau/models/leave_type.py b/xero_python/payrollau/models/leave_type.py index 8826df30..91db368d 100644 --- a/xero_python/payrollau/models/leave_type.py +++ b/xero_python/payrollau/models/leave_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -39,6 +39,9 @@ class LeaveType(BaseModel): "is_paid_leave": "bool", "show_on_payslip": "bool", "current_record": "bool", + "leave_category_code": "LeaveCategoryCode", + "sgc_exempt": "bool", + "is_qualifying_earnings": "bool", } attribute_map = { @@ -51,6 +54,9 @@ class LeaveType(BaseModel): "is_paid_leave": "IsPaidLeave", "show_on_payslip": "ShowOnPayslip", "current_record": "CurrentRecord", + "leave_category_code": "LeaveCategoryCode", + "sgc_exempt": "SGCExempt", + "is_qualifying_earnings": "IsQualifyingEarnings", } def __init__( @@ -64,6 +70,9 @@ def __init__( is_paid_leave=None, show_on_payslip=None, current_record=None, + leave_category_code=None, + sgc_exempt=None, + is_qualifying_earnings=None, ): # noqa: E501 """LeaveType - a model defined in OpenAPI""" # noqa: E501 @@ -76,6 +85,9 @@ def __init__( self._is_paid_leave = None self._show_on_payslip = None self._current_record = None + self._leave_category_code = None + self._sgc_exempt = None + self._is_qualifying_earnings = None self.discriminator = None if name is not None: @@ -96,6 +108,11 @@ def __init__( self.show_on_payslip = show_on_payslip if current_record is not None: self.current_record = current_record + if leave_category_code is not None: + self.leave_category_code = leave_category_code + if sgc_exempt is not None: + self.sgc_exempt = sgc_exempt + self.is_qualifying_earnings = is_qualifying_earnings @property def name(self): @@ -308,3 +325,74 @@ def current_record(self, current_record): """ self._current_record = current_record + + @property + def leave_category_code(self): + """Gets the leave_category_code of this LeaveType. # noqa: E501 + + + :return: The leave_category_code of this LeaveType. # noqa: E501 + :rtype: LeaveCategoryCode + """ + return self._leave_category_code + + @leave_category_code.setter + def leave_category_code(self, leave_category_code): + """Sets the leave_category_code of this LeaveType. + + + :param leave_category_code: The leave_category_code of this LeaveType. # noqa: E501 + :type: LeaveCategoryCode + """ + + self._leave_category_code = leave_category_code + + @property + def sgc_exempt(self): + """Gets the sgc_exempt of this LeaveType. # noqa: E501 + + Set this to indicate that the leave type is exempt from superannuation guarantee contribution # noqa: E501 + + :return: The sgc_exempt of this LeaveType. # noqa: E501 + :rtype: bool + """ + return self._sgc_exempt + + @sgc_exempt.setter + def sgc_exempt(self, sgc_exempt): + """Sets the sgc_exempt of this LeaveType. + + Set this to indicate that the leave type is exempt from superannuation guarantee contribution # noqa: E501 + + :param sgc_exempt: The sgc_exempt of this LeaveType. # noqa: E501 + :type: bool + """ + + self._sgc_exempt = sgc_exempt + + @property + def is_qualifying_earnings(self): + """Gets the is_qualifying_earnings of this LeaveType. # noqa: E501 + + Boolean to determine if the leave type is considered as qualifying earnings for superannuation guarantee calculations # noqa: E501 + + :return: The is_qualifying_earnings of this LeaveType. # noqa: E501 + :rtype: bool + """ + return self._is_qualifying_earnings + + @is_qualifying_earnings.setter + def is_qualifying_earnings(self, is_qualifying_earnings): + """Sets the is_qualifying_earnings of this LeaveType. + + Boolean to determine if the leave type is considered as qualifying earnings for superannuation guarantee calculations # noqa: E501 + + :param is_qualifying_earnings: The is_qualifying_earnings of this LeaveType. # noqa: E501 + :type: bool + """ + if is_qualifying_earnings is None: + raise ValueError( + "Invalid value for `is_qualifying_earnings`, must not be `None`" + ) # noqa: E501 + + self._is_qualifying_earnings = is_qualifying_earnings diff --git a/xero_python/payrollau/models/leave_type_contribution_type.py b/xero_python/payrollau/models/leave_type_contribution_type.py index e80b9751..75845859 100644 --- a/xero_python/payrollau/models/leave_type_contribution_type.py +++ b/xero_python/payrollau/models/leave_type_contribution_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/manual_tax_type.py b/xero_python/payrollau/models/manual_tax_type.py index af18735a..1d313a26 100644 --- a/xero_python/payrollau/models/manual_tax_type.py +++ b/xero_python/payrollau/models/manual_tax_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/opening_balance_leave_line.py b/xero_python/payrollau/models/opening_balance_leave_line.py new file mode 100644 index 00000000..781c85f4 --- /dev/null +++ b/xero_python/payrollau/models/opening_balance_leave_line.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" +Xero Payroll AU API + +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class OpeningBalanceLeaveLine(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = {"leave_type_id": "str", "number_of_units": "float"} + + attribute_map = {"leave_type_id": "LeaveTypeID", "number_of_units": "NumberOfUnits"} + + def __init__(self, leave_type_id=None, number_of_units=None): # noqa: E501 + """OpeningBalanceLeaveLine - a model defined in OpenAPI""" # noqa: E501 + + self._leave_type_id = None + self._number_of_units = None + self.discriminator = None + + if leave_type_id is not None: + self.leave_type_id = leave_type_id + if number_of_units is not None: + self.number_of_units = number_of_units + + @property + def leave_type_id(self): + """Gets the leave_type_id of this OpeningBalanceLeaveLine. # noqa: E501 + + Xero leave type identifier # noqa: E501 + + :return: The leave_type_id of this OpeningBalanceLeaveLine. # noqa: E501 + :rtype: str + """ + return self._leave_type_id + + @leave_type_id.setter + def leave_type_id(self, leave_type_id): + """Sets the leave_type_id of this OpeningBalanceLeaveLine. + + Xero leave type identifier # noqa: E501 + + :param leave_type_id: The leave_type_id of this OpeningBalanceLeaveLine. # noqa: E501 + :type: str + """ + + self._leave_type_id = leave_type_id + + @property + def number_of_units(self): + """Gets the number_of_units of this OpeningBalanceLeaveLine. # noqa: E501 + + Number of units for leave line. # noqa: E501 + + :return: The number_of_units of this OpeningBalanceLeaveLine. # noqa: E501 + :rtype: float + """ + return self._number_of_units + + @number_of_units.setter + def number_of_units(self, number_of_units): + """Sets the number_of_units of this OpeningBalanceLeaveLine. + + Number of units for leave line. # noqa: E501 + + :param number_of_units: The number_of_units of this OpeningBalanceLeaveLine. # noqa: E501 + :type: float + """ + + self._number_of_units = number_of_units diff --git a/xero_python/payrollau/models/opening_balances.py b/xero_python/payrollau/models/opening_balances.py index 93889b35..eb455ec7 100644 --- a/xero_python/payrollau/models/opening_balances.py +++ b/xero_python/payrollau/models/opening_balances.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -36,7 +36,8 @@ class OpeningBalances(BaseModel): "deduction_lines": "list[DeductionLine]", "super_lines": "list[SuperLine]", "reimbursement_lines": "list[ReimbursementLine]", - "leave_lines": "list[LeaveLine]", + "leave_lines": "list[OpeningBalanceLeaveLine]", + "paid_leave_earnings_lines": "list[PaidLeaveEarningsLine]", } attribute_map = { @@ -47,6 +48,7 @@ class OpeningBalances(BaseModel): "super_lines": "SuperLines", "reimbursement_lines": "ReimbursementLines", "leave_lines": "LeaveLines", + "paid_leave_earnings_lines": "PaidLeaveEarningsLines", } def __init__( @@ -58,6 +60,7 @@ def __init__( super_lines=None, reimbursement_lines=None, leave_lines=None, + paid_leave_earnings_lines=None, ): # noqa: E501 """OpeningBalances - a model defined in OpenAPI""" # noqa: E501 @@ -68,6 +71,7 @@ def __init__( self._super_lines = None self._reimbursement_lines = None self._leave_lines = None + self._paid_leave_earnings_lines = None self.discriminator = None if opening_balance_date is not None: @@ -84,6 +88,8 @@ def __init__( self.reimbursement_lines = reimbursement_lines if leave_lines is not None: self.leave_lines = leave_lines + if paid_leave_earnings_lines is not None: + self.paid_leave_earnings_lines = paid_leave_earnings_lines @property def opening_balance_date(self): @@ -221,7 +227,7 @@ def leave_lines(self): :return: The leave_lines of this OpeningBalances. # noqa: E501 - :rtype: list[LeaveLine] + :rtype: list[OpeningBalanceLeaveLine] """ return self._leave_lines @@ -231,7 +237,28 @@ def leave_lines(self, leave_lines): :param leave_lines: The leave_lines of this OpeningBalances. # noqa: E501 - :type: list[LeaveLine] + :type: list[OpeningBalanceLeaveLine] """ self._leave_lines = leave_lines + + @property + def paid_leave_earnings_lines(self): + """Gets the paid_leave_earnings_lines of this OpeningBalances. # noqa: E501 + + + :return: The paid_leave_earnings_lines of this OpeningBalances. # noqa: E501 + :rtype: list[PaidLeaveEarningsLine] + """ + return self._paid_leave_earnings_lines + + @paid_leave_earnings_lines.setter + def paid_leave_earnings_lines(self, paid_leave_earnings_lines): + """Sets the paid_leave_earnings_lines of this OpeningBalances. + + + :param paid_leave_earnings_lines: The paid_leave_earnings_lines of this OpeningBalances. # noqa: E501 + :type: list[PaidLeaveEarningsLine] + """ + + self._paid_leave_earnings_lines = paid_leave_earnings_lines diff --git a/xero_python/payrollau/models/paid_leave_earnings_line.py b/xero_python/payrollau/models/paid_leave_earnings_line.py new file mode 100644 index 00000000..a4002838 --- /dev/null +++ b/xero_python/payrollau/models/paid_leave_earnings_line.py @@ -0,0 +1,195 @@ +# coding: utf-8 + +""" +Xero Payroll AU API + +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class PaidLeaveEarningsLine(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "leave_type_id": "str", + "amount": "float", + "sgc_applied_leave_loading_amount": "float", + "sgc_exempted_leave_loading_amount": "float", + "reset_stp_categorisation": "bool", + } + + attribute_map = { + "leave_type_id": "LeaveTypeID", + "amount": "Amount", + "sgc_applied_leave_loading_amount": "SGCAppliedLeaveLoadingAmount", + "sgc_exempted_leave_loading_amount": "SGCExemptedLeaveLoadingAmount", + "reset_stp_categorisation": "ResetSTPCategorisation", + } + + def __init__( + self, + leave_type_id=None, + amount=None, + sgc_applied_leave_loading_amount=None, + sgc_exempted_leave_loading_amount=None, + reset_stp_categorisation=None, + ): # noqa: E501 + """PaidLeaveEarningsLine - a model defined in OpenAPI""" # noqa: E501 + + self._leave_type_id = None + self._amount = None + self._sgc_applied_leave_loading_amount = None + self._sgc_exempted_leave_loading_amount = None + self._reset_stp_categorisation = None + self.discriminator = None + + self.leave_type_id = leave_type_id + self.amount = amount + if sgc_applied_leave_loading_amount is not None: + self.sgc_applied_leave_loading_amount = sgc_applied_leave_loading_amount + if sgc_exempted_leave_loading_amount is not None: + self.sgc_exempted_leave_loading_amount = sgc_exempted_leave_loading_amount + if reset_stp_categorisation is not None: + self.reset_stp_categorisation = reset_stp_categorisation + + @property + def leave_type_id(self): + """Gets the leave_type_id of this PaidLeaveEarningsLine. # noqa: E501 + + Xero leave type identifier # noqa: E501 + + :return: The leave_type_id of this PaidLeaveEarningsLine. # noqa: E501 + :rtype: str + """ + return self._leave_type_id + + @leave_type_id.setter + def leave_type_id(self, leave_type_id): + """Sets the leave_type_id of this PaidLeaveEarningsLine. + + Xero leave type identifier # noqa: E501 + + :param leave_type_id: The leave_type_id of this PaidLeaveEarningsLine. # noqa: E501 + :type: str + """ + if leave_type_id is None: + raise ValueError( + "Invalid value for `leave_type_id`, must not be `None`" + ) # noqa: E501 + + self._leave_type_id = leave_type_id + + @property + def amount(self): + """Gets the amount of this PaidLeaveEarningsLine. # noqa: E501 + + Paid leave amount # noqa: E501 + + :return: The amount of this PaidLeaveEarningsLine. # noqa: E501 + :rtype: float + """ + return self._amount + + @amount.setter + def amount(self, amount): + """Sets the amount of this PaidLeaveEarningsLine. + + Paid leave amount # noqa: E501 + + :param amount: The amount of this PaidLeaveEarningsLine. # noqa: E501 + :type: float + """ + if amount is None: + raise ValueError( + "Invalid value for `amount`, must not be `None`" + ) # noqa: E501 + + self._amount = amount + + @property + def sgc_applied_leave_loading_amount(self): + """Gets the sgc_applied_leave_loading_amount of this PaidLeaveEarningsLine. # noqa: E501 + + The amount of leave loading applied for the leave type that is subject to Superannuation Guarantee Contributions. *Only applicable for Leave Types with Annual Leave Categories # noqa: E501 + + :return: The sgc_applied_leave_loading_amount of this PaidLeaveEarningsLine. # noqa: E501 + :rtype: float + """ + return self._sgc_applied_leave_loading_amount + + @sgc_applied_leave_loading_amount.setter + def sgc_applied_leave_loading_amount(self, sgc_applied_leave_loading_amount): + """Sets the sgc_applied_leave_loading_amount of this PaidLeaveEarningsLine. + + The amount of leave loading applied for the leave type that is subject to Superannuation Guarantee Contributions. *Only applicable for Leave Types with Annual Leave Categories # noqa: E501 + + :param sgc_applied_leave_loading_amount: The sgc_applied_leave_loading_amount of this PaidLeaveEarningsLine. # noqa: E501 + :type: float + """ + + self._sgc_applied_leave_loading_amount = sgc_applied_leave_loading_amount + + @property + def sgc_exempted_leave_loading_amount(self): + """Gets the sgc_exempted_leave_loading_amount of this PaidLeaveEarningsLine. # noqa: E501 + + The amount of leave loading applied for the leave type that is exempt from Superannuation Guarantee Contributions. *Only applicable for Leave Types with Annual Leave Categories # noqa: E501 + + :return: The sgc_exempted_leave_loading_amount of this PaidLeaveEarningsLine. # noqa: E501 + :rtype: float + """ + return self._sgc_exempted_leave_loading_amount + + @sgc_exempted_leave_loading_amount.setter + def sgc_exempted_leave_loading_amount(self, sgc_exempted_leave_loading_amount): + """Sets the sgc_exempted_leave_loading_amount of this PaidLeaveEarningsLine. + + The amount of leave loading applied for the leave type that is exempt from Superannuation Guarantee Contributions. *Only applicable for Leave Types with Annual Leave Categories # noqa: E501 + + :param sgc_exempted_leave_loading_amount: The sgc_exempted_leave_loading_amount of this PaidLeaveEarningsLine. # noqa: E501 + :type: float + """ + + self._sgc_exempted_leave_loading_amount = sgc_exempted_leave_loading_amount + + @property + def reset_stp_categorisation(self): + """Gets the reset_stp_categorisation of this PaidLeaveEarningsLine. # noqa: E501 + + Reset the STP categorisations for the leave type. *Only applicable for Leave Types with Annual Leave Categories # noqa: E501 + + :return: The reset_stp_categorisation of this PaidLeaveEarningsLine. # noqa: E501 + :rtype: bool + """ + return self._reset_stp_categorisation + + @reset_stp_categorisation.setter + def reset_stp_categorisation(self, reset_stp_categorisation): + """Sets the reset_stp_categorisation of this PaidLeaveEarningsLine. + + Reset the STP categorisations for the leave type. *Only applicable for Leave Types with Annual Leave Categories # noqa: E501 + + :param reset_stp_categorisation: The reset_stp_categorisation of this PaidLeaveEarningsLine. # noqa: E501 + :type: bool + """ + + self._reset_stp_categorisation = reset_stp_categorisation diff --git a/xero_python/payrollau/models/pay_item.py b/xero_python/payrollau/models/pay_item.py index b6cf5fbc..9246590a 100644 --- a/xero_python/payrollau/models/pay_item.py +++ b/xero_python/payrollau/models/pay_item.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/pay_items.py b/xero_python/payrollau/models/pay_items.py index 09fb1444..bde2f2a2 100644 --- a/xero_python/payrollau/models/pay_items.py +++ b/xero_python/payrollau/models/pay_items.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/pay_out_type.py b/xero_python/payrollau/models/pay_out_type.py new file mode 100644 index 00000000..5e1db85b --- /dev/null +++ b/xero_python/payrollau/models/pay_out_type.py @@ -0,0 +1,28 @@ +# coding: utf-8 + +""" +Xero Payroll AU API + +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class PayOutType(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + DEFAULT = "DEFAULT" + CASHED_OUT = "CASHED_OUT" diff --git a/xero_python/payrollau/models/pay_run.py b/xero_python/payrollau/models/pay_run.py index b4147298..09ac6a08 100644 --- a/xero_python/payrollau/models/pay_run.py +++ b/xero_python/payrollau/models/pay_run.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/pay_run_status.py b/xero_python/payrollau/models/pay_run_status.py index c979661f..9449b2fa 100644 --- a/xero_python/payrollau/models/pay_run_status.py +++ b/xero_python/payrollau/models/pay_run_status.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/pay_runs.py b/xero_python/payrollau/models/pay_runs.py index f927b517..f7336dea 100644 --- a/xero_python/payrollau/models/pay_runs.py +++ b/xero_python/payrollau/models/pay_runs.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/pay_template.py b/xero_python/payrollau/models/pay_template.py index 2d418db4..4f7a7f5d 100644 --- a/xero_python/payrollau/models/pay_template.py +++ b/xero_python/payrollau/models/pay_template.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/payment_frequency_type.py b/xero_python/payrollau/models/payment_frequency_type.py index 429a0a47..803a82e5 100644 --- a/xero_python/payrollau/models/payment_frequency_type.py +++ b/xero_python/payrollau/models/payment_frequency_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/payroll_calendar.py b/xero_python/payrollau/models/payroll_calendar.py index 8ae75b2e..0271eafe 100644 --- a/xero_python/payrollau/models/payroll_calendar.py +++ b/xero_python/payrollau/models/payroll_calendar.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/payroll_calendars.py b/xero_python/payrollau/models/payroll_calendars.py index 2eb58960..c8a44f72 100644 --- a/xero_python/payrollau/models/payroll_calendars.py +++ b/xero_python/payrollau/models/payroll_calendars.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/payslip.py b/xero_python/payrollau/models/payslip.py index 2ba9e568..329f8297 100644 --- a/xero_python/payrollau/models/payslip.py +++ b/xero_python/payrollau/models/payslip.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/payslip_lines.py b/xero_python/payrollau/models/payslip_lines.py index f47471b7..1bfbfbbc 100644 --- a/xero_python/payrollau/models/payslip_lines.py +++ b/xero_python/payrollau/models/payslip_lines.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/payslip_object.py b/xero_python/payrollau/models/payslip_object.py index f69acc67..03405d00 100644 --- a/xero_python/payrollau/models/payslip_object.py +++ b/xero_python/payrollau/models/payslip_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/payslip_summary.py b/xero_python/payrollau/models/payslip_summary.py index 97dbfa4c..712dfcd2 100644 --- a/xero_python/payrollau/models/payslip_summary.py +++ b/xero_python/payrollau/models/payslip_summary.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/payslips.py b/xero_python/payrollau/models/payslips.py index ee7f6744..a7b4f7f6 100644 --- a/xero_python/payrollau/models/payslips.py +++ b/xero_python/payrollau/models/payslips.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/rate_type.py b/xero_python/payrollau/models/rate_type.py index 1bc96604..4891d8b7 100644 --- a/xero_python/payrollau/models/rate_type.py +++ b/xero_python/payrollau/models/rate_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/reimbursement_line.py b/xero_python/payrollau/models/reimbursement_line.py index 43940ce5..4b39bd6d 100644 --- a/xero_python/payrollau/models/reimbursement_line.py +++ b/xero_python/payrollau/models/reimbursement_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/reimbursement_lines.py b/xero_python/payrollau/models/reimbursement_lines.py index 4d65d57c..b1f70e92 100644 --- a/xero_python/payrollau/models/reimbursement_lines.py +++ b/xero_python/payrollau/models/reimbursement_lines.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/reimbursement_type.py b/xero_python/payrollau/models/reimbursement_type.py index a0ba6d92..f2f459d5 100644 --- a/xero_python/payrollau/models/reimbursement_type.py +++ b/xero_python/payrollau/models/reimbursement_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/residency_status.py b/xero_python/payrollau/models/residency_status.py index a9eaa6c3..100fe4e7 100644 --- a/xero_python/payrollau/models/residency_status.py +++ b/xero_python/payrollau/models/residency_status.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/senior_marital_status.py b/xero_python/payrollau/models/senior_marital_status.py new file mode 100644 index 00000000..72ee4c9f --- /dev/null +++ b/xero_python/payrollau/models/senior_marital_status.py @@ -0,0 +1,29 @@ +# coding: utf-8 + +""" +Xero Payroll AU API + +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class SeniorMaritalStatus(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + MEMBEROFCOUPLE = "MEMBEROFCOUPLE" + MEMBEROFILLNESSSEPARATEDCOUPLE = "MEMBEROFILLNESSSEPARATEDCOUPLE" + SINGLE = "SINGLE" diff --git a/xero_python/payrollau/models/settings.py b/xero_python/payrollau/models/settings.py index 816f5777..49dfa75a 100644 --- a/xero_python/payrollau/models/settings.py +++ b/xero_python/payrollau/models/settings.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -33,22 +33,29 @@ class Settings(BaseModel): "accounts": "list[Account]", "tracking_categories": "SettingsTrackingCategories", "days_in_payroll_year": "int", + "employees_are_stp2": "bool", } attribute_map = { "accounts": "Accounts", "tracking_categories": "TrackingCategories", "days_in_payroll_year": "DaysInPayrollYear", + "employees_are_stp2": "EmployeesAreSTP2", } def __init__( - self, accounts=None, tracking_categories=None, days_in_payroll_year=None + self, + accounts=None, + tracking_categories=None, + days_in_payroll_year=None, + employees_are_stp2=None, ): # noqa: E501 """Settings - a model defined in OpenAPI""" # noqa: E501 self._accounts = None self._tracking_categories = None self._days_in_payroll_year = None + self._employees_are_stp2 = None self.discriminator = None if accounts is not None: @@ -57,6 +64,8 @@ def __init__( self.tracking_categories = tracking_categories if days_in_payroll_year is not None: self.days_in_payroll_year = days_in_payroll_year + if employees_are_stp2 is not None: + self.employees_are_stp2 = employees_are_stp2 @property def accounts(self): @@ -124,3 +133,26 @@ def days_in_payroll_year(self, days_in_payroll_year): """ self._days_in_payroll_year = days_in_payroll_year + + @property + def employees_are_stp2(self): + """Gets the employees_are_stp2 of this Settings. # noqa: E501 + + Indicates if the organisation has been enabled for STP Phase 2 editing of employees. # noqa: E501 + + :return: The employees_are_stp2 of this Settings. # noqa: E501 + :rtype: bool + """ + return self._employees_are_stp2 + + @employees_are_stp2.setter + def employees_are_stp2(self, employees_are_stp2): + """Sets the employees_are_stp2 of this Settings. + + Indicates if the organisation has been enabled for STP Phase 2 editing of employees. # noqa: E501 + + :param employees_are_stp2: The employees_are_stp2 of this Settings. # noqa: E501 + :type: bool + """ + + self._employees_are_stp2 = employees_are_stp2 diff --git a/xero_python/payrollau/models/settings_object.py b/xero_python/payrollau/models/settings_object.py index 05bf40b0..1bf03291 100644 --- a/xero_python/payrollau/models/settings_object.py +++ b/xero_python/payrollau/models/settings_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/settings_tracking_categories.py b/xero_python/payrollau/models/settings_tracking_categories.py index 9c65ea23..9769d67e 100644 --- a/xero_python/payrollau/models/settings_tracking_categories.py +++ b/xero_python/payrollau/models/settings_tracking_categories.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/settings_tracking_categories_employee_groups.py b/xero_python/payrollau/models/settings_tracking_categories_employee_groups.py index 7e67f1b3..d6ca8237 100644 --- a/xero_python/payrollau/models/settings_tracking_categories_employee_groups.py +++ b/xero_python/payrollau/models/settings_tracking_categories_employee_groups.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/settings_tracking_categories_timesheet_categories.py b/xero_python/payrollau/models/settings_tracking_categories_timesheet_categories.py index 5a37b5d6..821271d3 100644 --- a/xero_python/payrollau/models/settings_tracking_categories_timesheet_categories.py +++ b/xero_python/payrollau/models/settings_tracking_categories_timesheet_categories.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/state.py b/xero_python/payrollau/models/state.py index b6b7807a..cffec21e 100644 --- a/xero_python/payrollau/models/state.py +++ b/xero_python/payrollau/models/state.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/super_fund.py b/xero_python/payrollau/models/super_fund.py index 435f3a0e..1a31fc86 100644 --- a/xero_python/payrollau/models/super_fund.py +++ b/xero_python/payrollau/models/super_fund.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/super_fund_product.py b/xero_python/payrollau/models/super_fund_product.py index 2a19af5c..a1db206a 100644 --- a/xero_python/payrollau/models/super_fund_product.py +++ b/xero_python/payrollau/models/super_fund_product.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/super_fund_products.py b/xero_python/payrollau/models/super_fund_products.py index a568a9b5..d0a807ce 100644 --- a/xero_python/payrollau/models/super_fund_products.py +++ b/xero_python/payrollau/models/super_fund_products.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/super_fund_type.py b/xero_python/payrollau/models/super_fund_type.py index 71690a55..bfc10b25 100644 --- a/xero_python/payrollau/models/super_fund_type.py +++ b/xero_python/payrollau/models/super_fund_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/super_funds.py b/xero_python/payrollau/models/super_funds.py index 8696d36f..a7481a4e 100644 --- a/xero_python/payrollau/models/super_funds.py +++ b/xero_python/payrollau/models/super_funds.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/super_line.py b/xero_python/payrollau/models/super_line.py index c81dcac3..2d3b3dfe 100644 --- a/xero_python/payrollau/models/super_line.py +++ b/xero_python/payrollau/models/super_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/super_membership.py b/xero_python/payrollau/models/super_membership.py index dfd4cc94..cb461fc7 100644 --- a/xero_python/payrollau/models/super_membership.py +++ b/xero_python/payrollau/models/super_membership.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/superannuation_calculation_type.py b/xero_python/payrollau/models/superannuation_calculation_type.py index 0c376fa2..adb98d29 100644 --- a/xero_python/payrollau/models/superannuation_calculation_type.py +++ b/xero_python/payrollau/models/superannuation_calculation_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/superannuation_contribution_type.py b/xero_python/payrollau/models/superannuation_contribution_type.py index 2ca054be..324f810c 100644 --- a/xero_python/payrollau/models/superannuation_contribution_type.py +++ b/xero_python/payrollau/models/superannuation_contribution_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/superannuation_line.py b/xero_python/payrollau/models/superannuation_line.py index 4537d6f6..70820047 100644 --- a/xero_python/payrollau/models/superannuation_line.py +++ b/xero_python/payrollau/models/superannuation_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/tax_declaration.py b/xero_python/payrollau/models/tax_declaration.py index 53c8595f..c5f5e5bf 100644 --- a/xero_python/payrollau/models/tax_declaration.py +++ b/xero_python/payrollau/models/tax_declaration.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -34,8 +34,12 @@ class TaxDeclaration(BaseModel): "employment_basis": "EmploymentBasis", "tfn_exemption_type": "TFNExemptionType", "tax_file_number": "str", + "abn": "str", "australian_resident_for_tax_purposes": "bool", "residency_status": "ResidencyStatus", + "tax_scale_type": "TaxScaleType", + "work_condition": "WorkCondition", + "senior_marital_status": "SeniorMaritalStatus", "tax_free_threshold_claimed": "bool", "tax_offset_estimated_amount": "float", "has_help_debt": "bool", @@ -45,7 +49,9 @@ class TaxDeclaration(BaseModel): "eligible_to_receive_leave_loading": "bool", "approved_withholding_variation_percentage": "float", "has_student_startup_loan": "bool", + "has_loan_or_student_debt": "bool", "updated_date_utc": "datetime[ms-format]", + "include_leave_loading_in_qualifying_earnings": "bool", } attribute_map = { @@ -53,8 +59,12 @@ class TaxDeclaration(BaseModel): "employment_basis": "EmploymentBasis", "tfn_exemption_type": "TFNExemptionType", "tax_file_number": "TaxFileNumber", + "abn": "ABN", "australian_resident_for_tax_purposes": "AustralianResidentForTaxPurposes", "residency_status": "ResidencyStatus", + "tax_scale_type": "TaxScaleType", + "work_condition": "WorkCondition", + "senior_marital_status": "SeniorMaritalStatus", "tax_free_threshold_claimed": "TaxFreeThresholdClaimed", "tax_offset_estimated_amount": "TaxOffsetEstimatedAmount", "has_help_debt": "HasHELPDebt", @@ -64,7 +74,9 @@ class TaxDeclaration(BaseModel): "eligible_to_receive_leave_loading": "EligibleToReceiveLeaveLoading", "approved_withholding_variation_percentage": "ApprovedWithholdingVariationPercentage", "has_student_startup_loan": "HasStudentStartupLoan", + "has_loan_or_student_debt": "HasLoanOrStudentDebt", "updated_date_utc": "UpdatedDateUTC", + "include_leave_loading_in_qualifying_earnings": "IncludeLeaveLoadingInQualifyingEarnings", } def __init__( @@ -73,8 +85,12 @@ def __init__( employment_basis=None, tfn_exemption_type=None, tax_file_number=None, + abn=None, australian_resident_for_tax_purposes=None, residency_status=None, + tax_scale_type=None, + work_condition=None, + senior_marital_status=None, tax_free_threshold_claimed=None, tax_offset_estimated_amount=None, has_help_debt=None, @@ -84,7 +100,9 @@ def __init__( eligible_to_receive_leave_loading=None, approved_withholding_variation_percentage=None, has_student_startup_loan=None, + has_loan_or_student_debt=None, updated_date_utc=None, + include_leave_loading_in_qualifying_earnings=None, ): # noqa: E501 """TaxDeclaration - a model defined in OpenAPI""" # noqa: E501 @@ -92,8 +110,12 @@ def __init__( self._employment_basis = None self._tfn_exemption_type = None self._tax_file_number = None + self._abn = None self._australian_resident_for_tax_purposes = None self._residency_status = None + self._tax_scale_type = None + self._work_condition = None + self._senior_marital_status = None self._tax_free_threshold_claimed = None self._tax_offset_estimated_amount = None self._has_help_debt = None @@ -103,7 +125,9 @@ def __init__( self._eligible_to_receive_leave_loading = None self._approved_withholding_variation_percentage = None self._has_student_startup_loan = None + self._has_loan_or_student_debt = None self._updated_date_utc = None + self._include_leave_loading_in_qualifying_earnings = None self.discriminator = None if employee_id is not None: @@ -114,12 +138,20 @@ def __init__( self.tfn_exemption_type = tfn_exemption_type if tax_file_number is not None: self.tax_file_number = tax_file_number + if abn is not None: + self.abn = abn if australian_resident_for_tax_purposes is not None: self.australian_resident_for_tax_purposes = ( australian_resident_for_tax_purposes ) if residency_status is not None: self.residency_status = residency_status + if tax_scale_type is not None: + self.tax_scale_type = tax_scale_type + if work_condition is not None: + self.work_condition = work_condition + if senior_marital_status is not None: + self.senior_marital_status = senior_marital_status if tax_free_threshold_claimed is not None: self.tax_free_threshold_claimed = tax_free_threshold_claimed if tax_offset_estimated_amount is not None: @@ -142,8 +174,14 @@ def __init__( ) if has_student_startup_loan is not None: self.has_student_startup_loan = has_student_startup_loan + if has_loan_or_student_debt is not None: + self.has_loan_or_student_debt = has_loan_or_student_debt if updated_date_utc is not None: self.updated_date_utc = updated_date_utc + if include_leave_loading_in_qualifying_earnings is not None: + self.include_leave_loading_in_qualifying_earnings = ( + include_leave_loading_in_qualifying_earnings + ) @property def employee_id(self): @@ -233,6 +271,29 @@ def tax_file_number(self, tax_file_number): self._tax_file_number = tax_file_number + @property + def abn(self): + """Gets the abn of this TaxDeclaration. # noqa: E501 + + 11-digit Australian Business Number e.g 21006819692 or an empty string (\"\") to unset a previously set value. Only applicable, and mandatory if income type is NONEMPLOYEE. # noqa: E501 + + :return: The abn of this TaxDeclaration. # noqa: E501 + :rtype: str + """ + return self._abn + + @abn.setter + def abn(self, abn): + """Sets the abn of this TaxDeclaration. + + 11-digit Australian Business Number e.g 21006819692 or an empty string (\"\") to unset a previously set value. Only applicable, and mandatory if income type is NONEMPLOYEE. # noqa: E501 + + :param abn: The abn of this TaxDeclaration. # noqa: E501 + :type: str + """ + + self._abn = abn + @property def australian_resident_for_tax_purposes(self): """Gets the australian_resident_for_tax_purposes of this TaxDeclaration. # noqa: E501 @@ -281,6 +342,69 @@ def residency_status(self, residency_status): self._residency_status = residency_status + @property + def tax_scale_type(self): + """Gets the tax_scale_type of this TaxDeclaration. # noqa: E501 + + + :return: The tax_scale_type of this TaxDeclaration. # noqa: E501 + :rtype: TaxScaleType + """ + return self._tax_scale_type + + @tax_scale_type.setter + def tax_scale_type(self, tax_scale_type): + """Sets the tax_scale_type of this TaxDeclaration. + + + :param tax_scale_type: The tax_scale_type of this TaxDeclaration. # noqa: E501 + :type: TaxScaleType + """ + + self._tax_scale_type = tax_scale_type + + @property + def work_condition(self): + """Gets the work_condition of this TaxDeclaration. # noqa: E501 + + + :return: The work_condition of this TaxDeclaration. # noqa: E501 + :rtype: WorkCondition + """ + return self._work_condition + + @work_condition.setter + def work_condition(self, work_condition): + """Sets the work_condition of this TaxDeclaration. + + + :param work_condition: The work_condition of this TaxDeclaration. # noqa: E501 + :type: WorkCondition + """ + + self._work_condition = work_condition + + @property + def senior_marital_status(self): + """Gets the senior_marital_status of this TaxDeclaration. # noqa: E501 + + + :return: The senior_marital_status of this TaxDeclaration. # noqa: E501 + :rtype: SeniorMaritalStatus + """ + return self._senior_marital_status + + @senior_marital_status.setter + def senior_marital_status(self, senior_marital_status): + """Sets the senior_marital_status of this TaxDeclaration. + + + :param senior_marital_status: The senior_marital_status of this TaxDeclaration. # noqa: E501 + :type: SeniorMaritalStatus + """ + + self._senior_marital_status = senior_marital_status + @property def tax_free_threshold_claimed(self): """Gets the tax_free_threshold_claimed of this TaxDeclaration. # noqa: E501 @@ -496,6 +620,29 @@ def has_student_startup_loan(self, has_student_startup_loan): self._has_student_startup_loan = has_student_startup_loan + @property + def has_loan_or_student_debt(self): + """Gets the has_loan_or_student_debt of this TaxDeclaration. # noqa: E501 + + 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) # noqa: E501 + + :return: The has_loan_or_student_debt of this TaxDeclaration. # noqa: E501 + :rtype: bool + """ + return self._has_loan_or_student_debt + + @has_loan_or_student_debt.setter + def has_loan_or_student_debt(self, has_loan_or_student_debt): + """Sets the has_loan_or_student_debt of this TaxDeclaration. + + 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) # noqa: E501 + + :param has_loan_or_student_debt: The has_loan_or_student_debt of this TaxDeclaration. # noqa: E501 + :type: bool + """ + + self._has_loan_or_student_debt = has_loan_or_student_debt + @property def updated_date_utc(self): """Gets the updated_date_utc of this TaxDeclaration. # noqa: E501 @@ -518,3 +665,30 @@ def updated_date_utc(self, updated_date_utc): """ self._updated_date_utc = updated_date_utc + + @property + def include_leave_loading_in_qualifying_earnings(self): + """Gets the include_leave_loading_in_qualifying_earnings of this TaxDeclaration. # noqa: E501 + + Boolean to determine if leave loading is considered as qualifying earnings for superannuation guarantee calculations. Required when IncludeLeaveLoadingInSGC is specified in the payload # noqa: E501 + + :return: The include_leave_loading_in_qualifying_earnings of this TaxDeclaration. # noqa: E501 + :rtype: bool + """ + return self._include_leave_loading_in_qualifying_earnings + + @include_leave_loading_in_qualifying_earnings.setter + def include_leave_loading_in_qualifying_earnings( + self, include_leave_loading_in_qualifying_earnings + ): + """Sets the include_leave_loading_in_qualifying_earnings of this TaxDeclaration. + + Boolean to determine if leave loading is considered as qualifying earnings for superannuation guarantee calculations. Required when IncludeLeaveLoadingInSGC is specified in the payload # noqa: E501 + + :param include_leave_loading_in_qualifying_earnings: The include_leave_loading_in_qualifying_earnings of this TaxDeclaration. # noqa: E501 + :type: bool + """ + + self._include_leave_loading_in_qualifying_earnings = ( + include_leave_loading_in_qualifying_earnings + ) diff --git a/xero_python/payrollau/models/tax_line.py b/xero_python/payrollau/models/tax_line.py index 8b022601..4a3af0e1 100644 --- a/xero_python/payrollau/models/tax_line.py +++ b/xero_python/payrollau/models/tax_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/tax_scale_type.py b/xero_python/payrollau/models/tax_scale_type.py new file mode 100644 index 00000000..d572f28a --- /dev/null +++ b/xero_python/payrollau/models/tax_scale_type.py @@ -0,0 +1,32 @@ +# coding: utf-8 + +""" +Xero Payroll AU API + +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class TaxScaleType(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + REGULAR = "REGULAR" + ACTORSARTISTSENTERTAINERS = "ACTORSARTISTSENTERTAINERS" + HORTICULTURISTORSHEARER = "HORTICULTURISTORSHEARER" + SENIORORPENSIONER = "SENIORORPENSIONER" + WORKINGHOLIDAYMAKER = "WORKINGHOLIDAYMAKER" + FOREIGN = "FOREIGN" diff --git a/xero_python/payrollau/models/tfn_exemption_type.py b/xero_python/payrollau/models/tfn_exemption_type.py index df27d91d..bde86547 100644 --- a/xero_python/payrollau/models/tfn_exemption_type.py +++ b/xero_python/payrollau/models/tfn_exemption_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/timesheet.py b/xero_python/payrollau/models/timesheet.py index b6ac10f1..a805cd5b 100644 --- a/xero_python/payrollau/models/timesheet.py +++ b/xero_python/payrollau/models/timesheet.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/timesheet_line.py b/xero_python/payrollau/models/timesheet_line.py index 652decf9..98d693c7 100644 --- a/xero_python/payrollau/models/timesheet_line.py +++ b/xero_python/payrollau/models/timesheet_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/timesheet_object.py b/xero_python/payrollau/models/timesheet_object.py index d36079d7..50b28a3c 100644 --- a/xero_python/payrollau/models/timesheet_object.py +++ b/xero_python/payrollau/models/timesheet_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/timesheet_status.py b/xero_python/payrollau/models/timesheet_status.py index 909fac8e..68b863e6 100644 --- a/xero_python/payrollau/models/timesheet_status.py +++ b/xero_python/payrollau/models/timesheet_status.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/timesheets.py b/xero_python/payrollau/models/timesheets.py index 1708bbee..151f14fc 100644 --- a/xero_python/payrollau/models/timesheets.py +++ b/xero_python/payrollau/models/timesheets.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/validation_error.py b/xero_python/payrollau/models/validation_error.py index bffdf366..f55b3999 100644 --- a/xero_python/payrollau/models/validation_error.py +++ b/xero_python/payrollau/models/validation_error.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll AU API +Xero Payroll AU API - This is the Xero Payroll API for orgs in Australia region. # noqa: E501 +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/work_condition.py b/xero_python/payrollau/models/work_condition.py new file mode 100644 index 00000000..6896222c --- /dev/null +++ b/xero_python/payrollau/models/work_condition.py @@ -0,0 +1,29 @@ +# coding: utf-8 + +""" +Xero Payroll AU API + +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class WorkCondition(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + PROMOTIONAL = "PROMOTIONAL" + THREELESSPERFORMANCESPERWEEK = "THREELESSPERFORMANCESPERWEEK" + NONE = "NONE" diff --git a/xero_python/payrollauv2/__init__.py b/xero_python/payrollauv2/__init__.py new file mode 100644 index 00000000..22b36f7f --- /dev/null +++ b/xero_python/payrollauv2/__init__.py @@ -0,0 +1,27 @@ +# coding: utf-8 + +# flake8: noqa + +""" +Xero Payroll AU API 2.0 + +This is the Xero Payroll API 2.0 for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +# import apis into sdk package +from xero_python.payrollauv2.api.payroll_au_v2_api import PayrollAuV2Api + + +# import models into sdk package +from xero_python.payrollauv2.models.invalid_field import InvalidField +from xero_python.payrollauv2.models.pagination import Pagination +from xero_python.payrollauv2.models.problem import Problem +from xero_python.payrollauv2.models.timesheet import Timesheet +from xero_python.payrollauv2.models.timesheet_line import TimesheetLine +from xero_python.payrollauv2.models.timesheet_line_object import TimesheetLineObject +from xero_python.payrollauv2.models.timesheet_object import TimesheetObject +from xero_python.payrollauv2.models.timesheets import Timesheets diff --git a/xero_python/payrollauv2/api/__init__.py b/xero_python/payrollauv2/api/__init__.py new file mode 100644 index 00000000..f65c04e7 --- /dev/null +++ b/xero_python/payrollauv2/api/__init__.py @@ -0,0 +1,4 @@ +# flake8: noqa + +# import apis into api package +from xero_python.payrollauv2.api.payroll_au_v2_api import PayrollAuV2Api diff --git a/xero_python/payrollauv2/api/payroll_au_v2_api.py b/xero_python/payrollauv2/api/payroll_au_v2_api.py new file mode 100644 index 00000000..fcc58aa7 --- /dev/null +++ b/xero_python/payrollauv2/api/payroll_au_v2_api.py @@ -0,0 +1,833 @@ +# coding: utf-8 + +import importlib +import re # noqa: F401 + +from xero_python import exceptions +from xero_python.api_client import ApiClient, ModelFinder + +try: + from .exception_handler import translate_status_exception +except ImportError: + translate_status_exception = exceptions.translate_status_exception + +""" + Xero Payroll AU API 2.0 + + This is the Xero Payroll API 2.0 for orgs in Australia region. # noqa: E501 + + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + +""" + OpenAPI spec version: 16.2.0 +""" + + +class empty: + """empty object to mark optional parameter not set""" + + +class PayrollAuV2Api(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + base_url = "https://api.xero.com/payroll.xro/2.0" + models_module = importlib.import_module("xero_python.payrollauv2.models") + + def __init__(self, api_client=None, base_url=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.base_url = base_url or self.base_url + + def get_resource_url(self, resource_path): + """ + Combine API base url with resource specific path + :param str resource_path: API endpoint specific path + :return: str full resource path + """ + return self.base_url + resource_path + + def get_model_finder(self): + return ModelFinder(self.models_module) + + def approve_timesheet( + self, + xero_tenant_id, + timesheet_id, + idempotency_key=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Approves a specific timesheet # noqa: E501 + OAuth2 scope: payroll.timesheets + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str timesheet_id: Identifier for the timesheet (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: TimesheetObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `approve_timesheet`" + ) + # verify the required parameter 'timesheet_id' is set + if timesheet_id is None: + raise ValueError( + "Missing the required parameter `timesheet_id` " + "when calling `approve_timesheet`" + ) + + collection_formats = {} + path_params = { + "TimesheetID": timesheet_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Timesheets/{TimesheetID}/Approve") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="TimesheetObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "approve_timesheet") + + def create_timesheet( + self, + xero_tenant_id, + timesheet, + idempotency_key=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Creates a new timesheet # noqa: E501 + OAuth2 scope: payroll.timesheets + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param Timesheet timesheet: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: TimesheetObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `create_timesheet`" + ) + # verify the required parameter 'timesheet' is set + if timesheet is None: + raise ValueError( + "Missing the required parameter `timesheet` " + "when calling `create_timesheet`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + + local_var_files = {} + form_params = [] + + body_params = timesheet + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Timesheets") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="TimesheetObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "create_timesheet") + + def create_timesheet_line( + self, + xero_tenant_id, + timesheet_id, + timesheet_line, + idempotency_key=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Creates a new timesheet line for a specific timesheet using a unique timesheet ID # noqa: E501 + OAuth2 scope: payroll.timesheets + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str timesheet_id: Identifier for the timesheet (required) + :param TimesheetLine timesheet_line: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: TimesheetLineObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `create_timesheet_line`" + ) + # verify the required parameter 'timesheet_id' is set + if timesheet_id is None: + raise ValueError( + "Missing the required parameter `timesheet_id` " + "when calling `create_timesheet_line`" + ) + # verify the required parameter 'timesheet_line' is set + if timesheet_line is None: + raise ValueError( + "Missing the required parameter `timesheet_line` " + "when calling `create_timesheet_line`" + ) + + collection_formats = {} + path_params = { + "TimesheetID": timesheet_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + + local_var_files = {} + form_params = [] + + body_params = timesheet_line + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Timesheets/{TimesheetID}/Lines") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="TimesheetLineObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "create_timesheet_line") + + def delete_timesheet( + self, + xero_tenant_id, + timesheet_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Deletes a specific timesheet # noqa: E501 + OAuth2 scope: payroll.timesheets + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str timesheet_id: Identifier for the timesheet (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: TimesheetLine + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `delete_timesheet`" + ) + # verify the required parameter 'timesheet_id' is set + if timesheet_id is None: + raise ValueError( + "Missing the required parameter `timesheet_id` " + "when calling `delete_timesheet`" + ) + + collection_formats = {} + path_params = { + "TimesheetID": timesheet_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Timesheets/{TimesheetID}") + + try: + return self.api_client.call_api( + url, + "DELETE", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="TimesheetLine", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "delete_timesheet") + + def delete_timesheet_line( + self, + xero_tenant_id, + timesheet_id, + timesheet_line_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Deletes a specific timesheet line # noqa: E501 + OAuth2 scope: payroll.timesheets + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str timesheet_id: Identifier for the timesheet (required) + :param str timesheet_line_id: Identifier for the timesheet line (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: TimesheetLine + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `delete_timesheet_line`" + ) + # verify the required parameter 'timesheet_id' is set + if timesheet_id is None: + raise ValueError( + "Missing the required parameter `timesheet_id` " + "when calling `delete_timesheet_line`" + ) + # verify the required parameter 'timesheet_line_id' is set + if timesheet_line_id is None: + raise ValueError( + "Missing the required parameter `timesheet_line_id` " + "when calling `delete_timesheet_line`" + ) + + collection_formats = {} + path_params = { + "TimesheetID": timesheet_id, + "TimesheetLineID": timesheet_line_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Timesheets/{TimesheetID}/Lines/{TimesheetLineID}") + + try: + return self.api_client.call_api( + url, + "DELETE", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="TimesheetLine", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "delete_timesheet_line") + + def get_timesheet( + self, + xero_tenant_id, + timesheet_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Retrieve a specific timesheet by using a unique timesheet ID # noqa: E501 + OAuth2 scope: payroll.timesheets, payroll.timesheets.read + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str timesheet_id: Identifier for the timesheet (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: TimesheetObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_timesheet`" + ) + # verify the required parameter 'timesheet_id' is set + if timesheet_id is None: + raise ValueError( + "Missing the required parameter `timesheet_id` " + "when calling `get_timesheet`" + ) + + collection_formats = {} + path_params = { + "TimesheetID": timesheet_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Timesheets/{TimesheetID}") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="TimesheetObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_timesheet") + + def get_timesheets( + self, + xero_tenant_id, + page=empty, + filter=empty, + status=empty, + start_date=empty, + end_date=empty, + sort=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Retrieves timesheets # noqa: E501 + OAuth2 scope: payroll.timesheets, payroll.timesheets.read + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. + :param str filter: Filter by employeeId and/or payrollCalendarId + :param str status: filter results by any timesheets with a matching timesheet status + :param str start_date: filter results by any timesheets with a startDate on or after the provided date + :param str end_date: filter results by any timesheets with a endDate on or before the provided date + :param str sort: sort the order of timesheets returned. The default is based on the timesheets createdDate, sorted oldest to newest. Currently, the only other option is to reverse the order based on the timesheets startDate, sorted newest to oldest. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: Timesheets + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_timesheets`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + if page is not empty: + query_params.append(("page", page)) + + if filter is not empty: + query_params.append(("filter", filter)) + + if status is not empty: + query_params.append(("status", status)) + + if start_date is not empty: + query_params.append(("startDate", start_date)) + + if end_date is not empty: + query_params.append(("endDate", end_date)) + + if sort is not empty: + query_params.append(("sort", sort)) + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Timesheets") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="Timesheets", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_timesheets") + + def revert_timesheet( + self, + xero_tenant_id, + timesheet_id, + idempotency_key=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Reverts a specific timesheet to draft # noqa: E501 + OAuth2 scope: payroll.timesheets + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str timesheet_id: Identifier for the timesheet (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: TimesheetObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `revert_timesheet`" + ) + # verify the required parameter 'timesheet_id' is set + if timesheet_id is None: + raise ValueError( + "Missing the required parameter `timesheet_id` " + "when calling `revert_timesheet`" + ) + + collection_formats = {} + path_params = { + "TimesheetID": timesheet_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Timesheets/{TimesheetID}/RevertToDraft") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="TimesheetObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "revert_timesheet") + + def update_timesheet_line( + self, + xero_tenant_id, + timesheet_id, + timesheet_line_id, + timesheet_line, + idempotency_key=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Updates a specific timesheet line for a specific timesheet # noqa: E501 + OAuth2 scope: payroll.timesheets + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str timesheet_id: Identifier for the timesheet (required) + :param str timesheet_line_id: Identifier for the timesheet line (required) + :param TimesheetLine timesheet_line: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: TimesheetLineObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `update_timesheet_line`" + ) + # verify the required parameter 'timesheet_id' is set + if timesheet_id is None: + raise ValueError( + "Missing the required parameter `timesheet_id` " + "when calling `update_timesheet_line`" + ) + # verify the required parameter 'timesheet_line_id' is set + if timesheet_line_id is None: + raise ValueError( + "Missing the required parameter `timesheet_line_id` " + "when calling `update_timesheet_line`" + ) + # verify the required parameter 'timesheet_line' is set + if timesheet_line is None: + raise ValueError( + "Missing the required parameter `timesheet_line` " + "when calling `update_timesheet_line`" + ) + + collection_formats = {} + path_params = { + "TimesheetID": timesheet_id, + "TimesheetLineID": timesheet_line_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + + local_var_files = {} + form_params = [] + + body_params = timesheet_line + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Timesheets/{TimesheetID}/Lines/{TimesheetLineID}") + + try: + return self.api_client.call_api( + url, + "PUT", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="TimesheetLineObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "update_timesheet_line") diff --git a/xero_python/accounting/docs/BudgetLines.md b/xero_python/payrollauv2/docs/InvalidField.md similarity index 50% rename from xero_python/accounting/docs/BudgetLines.md rename to xero_python/payrollauv2/docs/InvalidField.md index 790cd0b4..fbb1b5b2 100644 --- a/xero_python/accounting/docs/BudgetLines.md +++ b/xero_python/payrollauv2/docs/InvalidField.md @@ -1,12 +1,10 @@ -# BudgetLines +# InvalidField ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**period** | **date** | Period the amount applies to (e.g. “2019-08”) | [optional] -**amount** | **int** | LineItem Quantity | [optional] -**unit_amount** | **int** | Budgeted amount | [optional] -**notes** | **str** | Any footnotes associated with this balance | [optional] +**name** | **str** | The name of the field that caused the error | [optional] +**reason** | **str** | The reason the error occurred | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrollauv2/docs/Pagination.md b/xero_python/payrollauv2/docs/Pagination.md new file mode 100644 index 00000000..7d4aa488 --- /dev/null +++ b/xero_python/payrollauv2/docs/Pagination.md @@ -0,0 +1,13 @@ +# Pagination + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**page** | **int** | | [optional] +**page_size** | **int** | | [optional] +**page_count** | **int** | | [optional] +**item_count** | **int** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollauv2/docs/PayrollAuV2Api.md b/xero_python/payrollauv2/docs/PayrollAuV2Api.md new file mode 100644 index 00000000..582d0794 --- /dev/null +++ b/xero_python/payrollauv2/docs/PayrollAuV2Api.md @@ -0,0 +1,612 @@ +# xero_python.payrollauv2.PayrollAuV2Api + +All URIs are relative to *https://api.xero.com/payroll.xro/2.0* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve_timesheet**](PayrollAuV2Api.md#approve_timesheet) | **POST** /Timesheets/{TimesheetID}/Approve | Approves a specific timesheet +[**create_timesheet**](PayrollAuV2Api.md#create_timesheet) | **POST** /Timesheets | Creates a new timesheet +[**create_timesheet_line**](PayrollAuV2Api.md#create_timesheet_line) | **POST** /Timesheets/{TimesheetID}/Lines | Creates a new timesheet line for a specific timesheet using a unique timesheet ID +[**delete_timesheet**](PayrollAuV2Api.md#delete_timesheet) | **DELETE** /Timesheets/{TimesheetID} | Deletes a specific timesheet +[**delete_timesheet_line**](PayrollAuV2Api.md#delete_timesheet_line) | **DELETE** /Timesheets/{TimesheetID}/Lines/{TimesheetLineID} | Deletes a specific timesheet line +[**get_timesheet**](PayrollAuV2Api.md#get_timesheet) | **GET** /Timesheets/{TimesheetID} | Retrieve a specific timesheet by using a unique timesheet ID +[**get_timesheets**](PayrollAuV2Api.md#get_timesheets) | **GET** /Timesheets | Retrieves timesheets +[**revert_timesheet**](PayrollAuV2Api.md#revert_timesheet) | **POST** /Timesheets/{TimesheetID}/RevertToDraft | Reverts a specific timesheet to draft +[**update_timesheet_line**](PayrollAuV2Api.md#update_timesheet_line) | **PUT** /Timesheets/{TimesheetID}/Lines/{TimesheetLineID} | Updates a specific timesheet line for a specific timesheet + + +# **approve_timesheet** +> TimesheetObject approve_timesheet(xero_tenant_id, timesheet_id, idempotency_key=idempotency_key) + +Approves a specific timesheet + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollauv2 import PayrollAuV2Api +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollAuV2Api(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) +try: + # Approves a specific timesheet + api_response = api_instance.approve_timesheet(xero_tenant_id, timesheet_id, idempotency_key=idempotency_key) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuV2Api->approve_timesheet: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **timesheet_id** | [**str**](.md)| Identifier for the timesheet | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] + +### Return type + +[**TimesheetObject**](TimesheetObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_timesheet** +> TimesheetObject create_timesheet(xero_tenant_id, timesheet, idempotency_key=idempotency_key) + +Creates a new timesheet + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollauv2 import PayrollAuV2Api +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollAuV2Api(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +timesheet = {"payrollCalendarID":"216d80e6-af55-47b1-b718-9457c3f5d2fe","employeeID":"aad6b292-7b94-408b-93f6-e489867e3fb0","startDate":"2020-04-13","endDate":"2020-04-19","timesheetLines":[{"date":"2020-04-13","earningsRateID":"87f5b43a-cf51-4b74-92de-94c819e82d27","numberOfUnits":8},{"date":"2020-04-15","earningsRateID":"87f5b43a-cf51-4b74-92de-94c819e82d27","numberOfUnits":6}]} # Timesheet | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) +try: + # Creates a new timesheet + api_response = api_instance.create_timesheet(xero_tenant_id, timesheet, idempotency_key=idempotency_key) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuV2Api->create_timesheet: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **timesheet** | [**Timesheet**](Timesheet.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] + +### Return type + +[**TimesheetObject**](TimesheetObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_timesheet_line** +> TimesheetLineObject create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line, idempotency_key=idempotency_key) + +Creates a new timesheet line for a specific timesheet using a unique timesheet ID + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollauv2 import PayrollAuV2Api +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollAuV2Api(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet +timesheet_line = {"date":"2020-04-14","earningsRateID":"87f5b43a-cf51-4b74-92de-94c819e82d27","numberOfUnits":1} # TimesheetLine | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) +try: + # Creates a new timesheet line for a specific timesheet using a unique timesheet ID + api_response = api_instance.create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line, idempotency_key=idempotency_key) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuV2Api->create_timesheet_line: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **timesheet_id** | [**str**](.md)| Identifier for the timesheet | + **timesheet_line** | [**TimesheetLine**](TimesheetLine.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] + +### Return type + +[**TimesheetLineObject**](TimesheetLineObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_timesheet** +> TimesheetLine delete_timesheet(xero_tenant_id, timesheet_id) + +Deletes a specific timesheet + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollauv2 import PayrollAuV2Api +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollAuV2Api(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet +try: + # Deletes a specific timesheet + api_response = api_instance.delete_timesheet(xero_tenant_id, timesheet_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuV2Api->delete_timesheet: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **timesheet_id** | [**str**](.md)| Identifier for the timesheet | + +### Return type + +[**TimesheetLine**](TimesheetLine.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_timesheet_line** +> TimesheetLine delete_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id) + +Deletes a specific timesheet line + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollauv2 import PayrollAuV2Api +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollAuV2Api(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet +timesheet_line_id = 'timesheet_line_id_example' # str | Identifier for the timesheet line +try: + # Deletes a specific timesheet line + api_response = api_instance.delete_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuV2Api->delete_timesheet_line: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **timesheet_id** | [**str**](.md)| Identifier for the timesheet | + **timesheet_line_id** | [**str**](.md)| Identifier for the timesheet line | + +### Return type + +[**TimesheetLine**](TimesheetLine.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_timesheet** +> TimesheetObject get_timesheet(xero_tenant_id, timesheet_id) + +Retrieve a specific timesheet by using a unique timesheet ID + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollauv2 import PayrollAuV2Api +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollAuV2Api(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet +try: + # Retrieve a specific timesheet by using a unique timesheet ID + api_response = api_instance.get_timesheet(xero_tenant_id, timesheet_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuV2Api->get_timesheet: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **timesheet_id** | [**str**](.md)| Identifier for the timesheet | + +### Return type + +[**TimesheetObject**](TimesheetObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_timesheets** +> Timesheets get_timesheets(xero_tenant_id, page=page, filter=filter, status=status, start_date=start_date, end_date=end_date, sort=sort) + +Retrieves timesheets + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollauv2 import PayrollAuV2Api +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollAuV2Api(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +page = 5 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) +filter = 'employeeId==00000000-0000-0000-0000-000000000000,payrollCalendarId==00000000-0000-0000-0000-000000000000' # str | Filter by employeeId and/or payrollCalendarId (optional) +status = 'Draft' # str | filter results by any timesheets with a matching timesheet status (optional) +start_date = '2019-01-02' # str | filter results by any timesheets with a startDate on or after the provided date (optional) +end_date = '2020-01-02' # str | filter results by any timesheets with a endDate on or before the provided date (optional) +sort = 'startDate' # str | sort the order of timesheets returned. The default is based on the timesheets createdDate, sorted oldest to newest. Currently, the only other option is to reverse the order based on the timesheets startDate, sorted newest to oldest. (optional) +try: + # Retrieves timesheets + api_response = api_instance.get_timesheets(xero_tenant_id, page=page, filter=filter, status=status, start_date=start_date, end_date=end_date, sort=sort) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuV2Api->get_timesheets: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **page** | **int**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional] + **filter** | **str**| Filter by employeeId and/or payrollCalendarId | [optional] + **status** | **str**| filter results by any timesheets with a matching timesheet status | [optional] + **start_date** | **str**| filter results by any timesheets with a startDate on or after the provided date | [optional] + **end_date** | **str**| filter results by any timesheets with a endDate on or before the provided date | [optional] + **sort** | **str**| sort the order of timesheets returned. The default is based on the timesheets createdDate, sorted oldest to newest. Currently, the only other option is to reverse the order based on the timesheets startDate, sorted newest to oldest. | [optional] + +### Return type + +[**Timesheets**](Timesheets.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **revert_timesheet** +> TimesheetObject revert_timesheet(xero_tenant_id, timesheet_id, idempotency_key=idempotency_key) + +Reverts a specific timesheet to draft + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollauv2 import PayrollAuV2Api +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollAuV2Api(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) +try: + # Reverts a specific timesheet to draft + api_response = api_instance.revert_timesheet(xero_tenant_id, timesheet_id, idempotency_key=idempotency_key) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuV2Api->revert_timesheet: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **timesheet_id** | [**str**](.md)| Identifier for the timesheet | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] + +### Return type + +[**TimesheetObject**](TimesheetObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_timesheet_line** +> TimesheetLineObject update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, idempotency_key=idempotency_key) + +Updates a specific timesheet line for a specific timesheet + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollauv2 import PayrollAuV2Api +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollAuV2Api(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet +timesheet_line_id = 'timesheet_line_id_example' # str | Identifier for the timesheet line +timesheet_line = {"date":"2020-04-14","earningsRateID":"87f5b43a-cf51-4b74-92de-94c819e82d27","numberOfUnits":2} # TimesheetLine | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) +try: + # Updates a specific timesheet line for a specific timesheet + api_response = api_instance.update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, idempotency_key=idempotency_key) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuV2Api->update_timesheet_line: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **timesheet_id** | [**str**](.md)| Identifier for the timesheet | + **timesheet_line_id** | [**str**](.md)| Identifier for the timesheet line | + **timesheet_line** | [**TimesheetLine**](TimesheetLine.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] + +### Return type + +[**TimesheetLineObject**](TimesheetLineObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/xero_python/payrollauv2/docs/Problem.md b/xero_python/payrollauv2/docs/Problem.md new file mode 100644 index 00000000..edbdda5b --- /dev/null +++ b/xero_python/payrollauv2/docs/Problem.md @@ -0,0 +1,15 @@ +# Problem + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | The type of error format | [optional] +**title** | **str** | The type of the error | [optional] +**status** | **str** | The error status code | [optional] +**detail** | **str** | A description of the error | [optional] +**instance** | **str** | | [optional] +**invalid_fields** | [**list[InvalidField]**](InvalidField.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollauv2/docs/Timesheet.md b/xero_python/payrollauv2/docs/Timesheet.md new file mode 100644 index 00000000..ee693b86 --- /dev/null +++ b/xero_python/payrollauv2/docs/Timesheet.md @@ -0,0 +1,18 @@ +# Timesheet + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**timesheet_id** | **str** | The Xero identifier for a Timesheet | [optional] +**payroll_calendar_id** | **str** | The Xero identifier for the Payroll Calendar that the Timesheet applies to | +**employee_id** | **str** | The Xero identifier for the Employee that the Timesheet is for | +**start_date** | **date** | The Start Date of the Timesheet period (YYYY-MM-DD) | +**end_date** | **date** | The End Date of the Timesheet period (YYYY-MM-DD) | +**status** | **str** | Status of the timesheet | [optional] +**total_hours** | **float** | The Total Hours of the Timesheet | [optional] +**updated_date_utc** | **datetime** | The UTC date time that the Timesheet was last updated | [optional] +**timesheet_lines** | [**list[TimesheetLine]**](TimesheetLine.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollauv2/docs/TimesheetLine.md b/xero_python/payrollauv2/docs/TimesheetLine.md new file mode 100644 index 00000000..c5124b94 --- /dev/null +++ b/xero_python/payrollauv2/docs/TimesheetLine.md @@ -0,0 +1,14 @@ +# TimesheetLine + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**timesheet_line_id** | **str** | The Xero identifier for a Timesheet Line | [optional] +**date** | **date** | The Date that this Timesheet Line is for (YYYY-MM-DD) | +**earnings_rate_id** | **str** | The Xero identifier for the Earnings Rate that the Timesheet is for | +**tracking_item_id** | **str** | The Xero identifier for the Tracking Item that the Timesheet is for | [optional] +**number_of_units** | **float** | The Number of Units of the Timesheet Line | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/file/docs/InlineObject.md b/xero_python/payrollauv2/docs/TimesheetLineObject.md similarity index 57% rename from xero_python/file/docs/InlineObject.md rename to xero_python/payrollauv2/docs/TimesheetLineObject.md index fea79105..a6d06d1e 100644 --- a/xero_python/file/docs/InlineObject.md +++ b/xero_python/payrollauv2/docs/TimesheetLineObject.md @@ -1,12 +1,11 @@ -# InlineObject +# TimesheetLineObject ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**body** | **str** | | [optional] -**name** | **str** | exact name of the file you are uploading | [optional] -**filename** | **str** | | [optional] -**mime_type** | **str** | | [optional] +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**timesheet_line** | [**TimesheetLine**](TimesheetLine.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrollauv2/docs/TimesheetObject.md b/xero_python/payrollauv2/docs/TimesheetObject.md new file mode 100644 index 00000000..4ab9cc40 --- /dev/null +++ b/xero_python/payrollauv2/docs/TimesheetObject.md @@ -0,0 +1,12 @@ +# TimesheetObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**timesheet** | [**Timesheet**](Timesheet.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/finance/docs/ReportHistoryModel.md b/xero_python/payrollauv2/docs/Timesheets.md similarity index 50% rename from xero_python/finance/docs/ReportHistoryModel.md rename to xero_python/payrollauv2/docs/Timesheets.md index ec080b90..ae42a3b6 100644 --- a/xero_python/finance/docs/ReportHistoryModel.md +++ b/xero_python/payrollauv2/docs/Timesheets.md @@ -1,11 +1,11 @@ -# ReportHistoryModel +# Timesheets ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**report_name** | **str** | Report code or report title | [optional] -**report_date_text** | **str** | The date or date range of the report | [optional] -**published_date_utc** | **datetime** | The system date time that the report was published | [optional] +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**timesheets** | [**list[Timesheet]**](Timesheet.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrollauv2/models/__init__.py b/xero_python/payrollauv2/models/__init__.py new file mode 100644 index 00000000..3251186f --- /dev/null +++ b/xero_python/payrollauv2/models/__init__.py @@ -0,0 +1,22 @@ +# coding: utf-8 + +# flake8: noqa +""" +Xero Payroll AU API 2.0 + +This is the Xero Payroll API 2.0 for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +# import models into model package +from xero_python.payrollauv2.models.invalid_field import InvalidField +from xero_python.payrollauv2.models.pagination import Pagination +from xero_python.payrollauv2.models.problem import Problem +from xero_python.payrollauv2.models.timesheet import Timesheet +from xero_python.payrollauv2.models.timesheet_line import TimesheetLine +from xero_python.payrollauv2.models.timesheet_line_object import TimesheetLineObject +from xero_python.payrollauv2.models.timesheet_object import TimesheetObject +from xero_python.payrollauv2.models.timesheets import Timesheets diff --git a/xero_python/payrollauv2/models/invalid_field.py b/xero_python/payrollauv2/models/invalid_field.py new file mode 100644 index 00000000..8de56365 --- /dev/null +++ b/xero_python/payrollauv2/models/invalid_field.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" +Xero Payroll AU API 2.0 + +This is the Xero Payroll API 2.0 for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class InvalidField(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = {"name": "str", "reason": "str"} + + attribute_map = {"name": "name", "reason": "reason"} + + def __init__(self, name=None, reason=None): # noqa: E501 + """InvalidField - a model defined in OpenAPI""" # noqa: E501 + + self._name = None + self._reason = None + self.discriminator = None + + if name is not None: + self.name = name + if reason is not None: + self.reason = reason + + @property + def name(self): + """Gets the name of this InvalidField. # noqa: E501 + + The name of the field that caused the error # noqa: E501 + + :return: The name of this InvalidField. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this InvalidField. + + The name of the field that caused the error # noqa: E501 + + :param name: The name of this InvalidField. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def reason(self): + """Gets the reason of this InvalidField. # noqa: E501 + + The reason the error occurred # noqa: E501 + + :return: The reason of this InvalidField. # noqa: E501 + :rtype: str + """ + return self._reason + + @reason.setter + def reason(self, reason): + """Sets the reason of this InvalidField. + + The reason the error occurred # noqa: E501 + + :param reason: The reason of this InvalidField. # noqa: E501 + :type: str + """ + + self._reason = reason diff --git a/xero_python/payrollauv2/models/pagination.py b/xero_python/payrollauv2/models/pagination.py new file mode 100644 index 00000000..483e873c --- /dev/null +++ b/xero_python/payrollauv2/models/pagination.py @@ -0,0 +1,148 @@ +# coding: utf-8 + +""" +Xero Payroll AU API 2.0 + +This is the Xero Payroll API 2.0 for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class Pagination(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "page": "int", + "page_size": "int", + "page_count": "int", + "item_count": "int", + } + + attribute_map = { + "page": "page", + "page_size": "pageSize", + "page_count": "pageCount", + "item_count": "itemCount", + } + + def __init__( + self, page=None, page_size=None, page_count=None, item_count=None + ): # noqa: E501 + """Pagination - a model defined in OpenAPI""" # noqa: E501 + + self._page = None + self._page_size = None + self._page_count = None + self._item_count = None + self.discriminator = None + + if page is not None: + self.page = page + if page_size is not None: + self.page_size = page_size + if page_count is not None: + self.page_count = page_count + if item_count is not None: + self.item_count = item_count + + @property + def page(self): + """Gets the page of this Pagination. # noqa: E501 + + + :return: The page of this Pagination. # noqa: E501 + :rtype: int + """ + return self._page + + @page.setter + def page(self, page): + """Sets the page of this Pagination. + + + :param page: The page of this Pagination. # noqa: E501 + :type: int + """ + + self._page = page + + @property + def page_size(self): + """Gets the page_size of this Pagination. # noqa: E501 + + + :return: The page_size of this Pagination. # noqa: E501 + :rtype: int + """ + return self._page_size + + @page_size.setter + def page_size(self, page_size): + """Sets the page_size of this Pagination. + + + :param page_size: The page_size of this Pagination. # noqa: E501 + :type: int + """ + + self._page_size = page_size + + @property + def page_count(self): + """Gets the page_count of this Pagination. # noqa: E501 + + + :return: The page_count of this Pagination. # noqa: E501 + :rtype: int + """ + return self._page_count + + @page_count.setter + def page_count(self, page_count): + """Sets the page_count of this Pagination. + + + :param page_count: The page_count of this Pagination. # noqa: E501 + :type: int + """ + + self._page_count = page_count + + @property + def item_count(self): + """Gets the item_count of this Pagination. # noqa: E501 + + + :return: The item_count of this Pagination. # noqa: E501 + :rtype: int + """ + return self._item_count + + @item_count.setter + def item_count(self, item_count): + """Sets the item_count of this Pagination. + + + :param item_count: The item_count of this Pagination. # noqa: E501 + :type: int + """ + + self._item_count = item_count diff --git a/xero_python/payrollauv2/models/problem.py b/xero_python/payrollauv2/models/problem.py new file mode 100644 index 00000000..d9f0e2a4 --- /dev/null +++ b/xero_python/payrollauv2/models/problem.py @@ -0,0 +1,214 @@ +# coding: utf-8 + +""" +Xero Payroll AU API 2.0 + +This is the Xero Payroll API 2.0 for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class Problem(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "type": "str", + "title": "str", + "status": "str", + "detail": "str", + "instance": "str", + "invalid_fields": "list[InvalidField]", + } + + attribute_map = { + "type": "type", + "title": "title", + "status": "status", + "detail": "detail", + "instance": "instance", + "invalid_fields": "invalidFields", + } + + def __init__( + self, + type=None, + title=None, + status=None, + detail=None, + instance=None, + invalid_fields=None, + ): # noqa: E501 + """Problem - a model defined in OpenAPI""" # noqa: E501 + + self._type = None + self._title = None + self._status = None + self._detail = None + self._instance = None + self._invalid_fields = None + self.discriminator = None + + if type is not None: + self.type = type + if title is not None: + self.title = title + if status is not None: + self.status = status + if detail is not None: + self.detail = detail + if instance is not None: + self.instance = instance + if invalid_fields is not None: + self.invalid_fields = invalid_fields + + @property + def type(self): + """Gets the type of this Problem. # noqa: E501 + + The type of error format # noqa: E501 + + :return: The type of this Problem. # noqa: E501 + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this Problem. + + The type of error format # noqa: E501 + + :param type: The type of this Problem. # noqa: E501 + :type: str + """ + + self._type = type + + @property + def title(self): + """Gets the title of this Problem. # noqa: E501 + + The type of the error # noqa: E501 + + :return: The title of this Problem. # noqa: E501 + :rtype: str + """ + return self._title + + @title.setter + def title(self, title): + """Sets the title of this Problem. + + The type of the error # noqa: E501 + + :param title: The title of this Problem. # noqa: E501 + :type: str + """ + + self._title = title + + @property + def status(self): + """Gets the status of this Problem. # noqa: E501 + + The error status code # noqa: E501 + + :return: The status of this Problem. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this Problem. + + The error status code # noqa: E501 + + :param status: The status of this Problem. # noqa: E501 + :type: str + """ + + self._status = status + + @property + def detail(self): + """Gets the detail of this Problem. # noqa: E501 + + A description of the error # noqa: E501 + + :return: The detail of this Problem. # noqa: E501 + :rtype: str + """ + return self._detail + + @detail.setter + def detail(self, detail): + """Sets the detail of this Problem. + + A description of the error # noqa: E501 + + :param detail: The detail of this Problem. # noqa: E501 + :type: str + """ + + self._detail = detail + + @property + def instance(self): + """Gets the instance of this Problem. # noqa: E501 + + + :return: The instance of this Problem. # noqa: E501 + :rtype: str + """ + return self._instance + + @instance.setter + def instance(self, instance): + """Sets the instance of this Problem. + + + :param instance: The instance of this Problem. # noqa: E501 + :type: str + """ + + self._instance = instance + + @property + def invalid_fields(self): + """Gets the invalid_fields of this Problem. # noqa: E501 + + + :return: The invalid_fields of this Problem. # noqa: E501 + :rtype: list[InvalidField] + """ + return self._invalid_fields + + @invalid_fields.setter + def invalid_fields(self, invalid_fields): + """Sets the invalid_fields of this Problem. + + + :param invalid_fields: The invalid_fields of this Problem. # noqa: E501 + :type: list[InvalidField] + """ + + self._invalid_fields = invalid_fields diff --git a/xero_python/payrollauv2/models/timesheet.py b/xero_python/payrollauv2/models/timesheet.py new file mode 100644 index 00000000..6d33c001 --- /dev/null +++ b/xero_python/payrollauv2/models/timesheet.py @@ -0,0 +1,324 @@ +# coding: utf-8 + +""" +Xero Payroll AU API 2.0 + +This is the Xero Payroll API 2.0 for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class Timesheet(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "timesheet_id": "str", + "payroll_calendar_id": "str", + "employee_id": "str", + "start_date": "date", + "end_date": "date", + "status": "str", + "total_hours": "float", + "updated_date_utc": "datetime", + "timesheet_lines": "list[TimesheetLine]", + } + + attribute_map = { + "timesheet_id": "timesheetID", + "payroll_calendar_id": "payrollCalendarID", + "employee_id": "employeeID", + "start_date": "startDate", + "end_date": "endDate", + "status": "status", + "total_hours": "totalHours", + "updated_date_utc": "updatedDateUTC", + "timesheet_lines": "timesheetLines", + } + + def __init__( + self, + timesheet_id=None, + payroll_calendar_id=None, + employee_id=None, + start_date=None, + end_date=None, + status=None, + total_hours=None, + updated_date_utc=None, + timesheet_lines=None, + ): # noqa: E501 + """Timesheet - a model defined in OpenAPI""" # noqa: E501 + + self._timesheet_id = None + self._payroll_calendar_id = None + self._employee_id = None + self._start_date = None + self._end_date = None + self._status = None + self._total_hours = None + self._updated_date_utc = None + self._timesheet_lines = None + self.discriminator = None + + if timesheet_id is not None: + self.timesheet_id = timesheet_id + self.payroll_calendar_id = payroll_calendar_id + self.employee_id = employee_id + self.start_date = start_date + self.end_date = end_date + if status is not None: + self.status = status + if total_hours is not None: + self.total_hours = total_hours + if updated_date_utc is not None: + self.updated_date_utc = updated_date_utc + if timesheet_lines is not None: + self.timesheet_lines = timesheet_lines + + @property + def timesheet_id(self): + """Gets the timesheet_id of this Timesheet. # noqa: E501 + + The Xero identifier for a Timesheet # noqa: E501 + + :return: The timesheet_id of this Timesheet. # noqa: E501 + :rtype: str + """ + return self._timesheet_id + + @timesheet_id.setter + def timesheet_id(self, timesheet_id): + """Sets the timesheet_id of this Timesheet. + + The Xero identifier for a Timesheet # noqa: E501 + + :param timesheet_id: The timesheet_id of this Timesheet. # noqa: E501 + :type: str + """ + + self._timesheet_id = timesheet_id + + @property + def payroll_calendar_id(self): + """Gets the payroll_calendar_id of this Timesheet. # noqa: E501 + + The Xero identifier for the Payroll Calendar that the Timesheet applies to # noqa: E501 + + :return: The payroll_calendar_id of this Timesheet. # noqa: E501 + :rtype: str + """ + return self._payroll_calendar_id + + @payroll_calendar_id.setter + def payroll_calendar_id(self, payroll_calendar_id): + """Sets the payroll_calendar_id of this Timesheet. + + The Xero identifier for the Payroll Calendar that the Timesheet applies to # noqa: E501 + + :param payroll_calendar_id: The payroll_calendar_id of this Timesheet. # noqa: E501 + :type: str + """ + if payroll_calendar_id is None: + raise ValueError( + "Invalid value for `payroll_calendar_id`, must not be `None`" + ) # noqa: E501 + + self._payroll_calendar_id = payroll_calendar_id + + @property + def employee_id(self): + """Gets the employee_id of this Timesheet. # noqa: E501 + + The Xero identifier for the Employee that the Timesheet is for # noqa: E501 + + :return: The employee_id of this Timesheet. # noqa: E501 + :rtype: str + """ + return self._employee_id + + @employee_id.setter + def employee_id(self, employee_id): + """Sets the employee_id of this Timesheet. + + The Xero identifier for the Employee that the Timesheet is for # noqa: E501 + + :param employee_id: The employee_id of this Timesheet. # noqa: E501 + :type: str + """ + if employee_id is None: + raise ValueError( + "Invalid value for `employee_id`, must not be `None`" + ) # noqa: E501 + + self._employee_id = employee_id + + @property + def start_date(self): + """Gets the start_date of this Timesheet. # noqa: E501 + + The Start Date of the Timesheet period (YYYY-MM-DD) # noqa: E501 + + :return: The start_date of this Timesheet. # noqa: E501 + :rtype: date + """ + return self._start_date + + @start_date.setter + def start_date(self, start_date): + """Sets the start_date of this Timesheet. + + The Start Date of the Timesheet period (YYYY-MM-DD) # noqa: E501 + + :param start_date: The start_date of this Timesheet. # noqa: E501 + :type: date + """ + if start_date is None: + raise ValueError( + "Invalid value for `start_date`, must not be `None`" + ) # noqa: E501 + + self._start_date = start_date + + @property + def end_date(self): + """Gets the end_date of this Timesheet. # noqa: E501 + + The End Date of the Timesheet period (YYYY-MM-DD) # noqa: E501 + + :return: The end_date of this Timesheet. # noqa: E501 + :rtype: date + """ + return self._end_date + + @end_date.setter + def end_date(self, end_date): + """Sets the end_date of this Timesheet. + + The End Date of the Timesheet period (YYYY-MM-DD) # noqa: E501 + + :param end_date: The end_date of this Timesheet. # noqa: E501 + :type: date + """ + if end_date is None: + raise ValueError( + "Invalid value for `end_date`, must not be `None`" + ) # noqa: E501 + + self._end_date = end_date + + @property + def status(self): + """Gets the status of this Timesheet. # noqa: E501 + + Status of the timesheet # noqa: E501 + + :return: The status of this Timesheet. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this Timesheet. + + Status of the timesheet # noqa: E501 + + :param status: The status of this Timesheet. # noqa: E501 + :type: str + """ + allowed_values = ["Draft", "Approved", "Completed", "None"] # noqa: E501 + + if status: + if status not in allowed_values: + raise ValueError( + "Invalid value for `status` ({0}), must be one of {1}".format( # noqa: E501 + status, allowed_values + ) + ) + + self._status = status + + @property + def total_hours(self): + """Gets the total_hours of this Timesheet. # noqa: E501 + + The Total Hours of the Timesheet # noqa: E501 + + :return: The total_hours of this Timesheet. # noqa: E501 + :rtype: float + """ + return self._total_hours + + @total_hours.setter + def total_hours(self, total_hours): + """Sets the total_hours of this Timesheet. + + The Total Hours of the Timesheet # noqa: E501 + + :param total_hours: The total_hours of this Timesheet. # noqa: E501 + :type: float + """ + + self._total_hours = total_hours + + @property + def updated_date_utc(self): + """Gets the updated_date_utc of this Timesheet. # noqa: E501 + + The UTC date time that the Timesheet was last updated # noqa: E501 + + :return: The updated_date_utc of this Timesheet. # noqa: E501 + :rtype: datetime + """ + return self._updated_date_utc + + @updated_date_utc.setter + def updated_date_utc(self, updated_date_utc): + """Sets the updated_date_utc of this Timesheet. + + The UTC date time that the Timesheet was last updated # noqa: E501 + + :param updated_date_utc: The updated_date_utc of this Timesheet. # noqa: E501 + :type: datetime + """ + + self._updated_date_utc = updated_date_utc + + @property + def timesheet_lines(self): + """Gets the timesheet_lines of this Timesheet. # noqa: E501 + + + :return: The timesheet_lines of this Timesheet. # noqa: E501 + :rtype: list[TimesheetLine] + """ + return self._timesheet_lines + + @timesheet_lines.setter + def timesheet_lines(self, timesheet_lines): + """Sets the timesheet_lines of this Timesheet. + + + :param timesheet_lines: The timesheet_lines of this Timesheet. # noqa: E501 + :type: list[TimesheetLine] + """ + + self._timesheet_lines = timesheet_lines diff --git a/xero_python/payrollauv2/models/timesheet_line.py b/xero_python/payrollauv2/models/timesheet_line.py new file mode 100644 index 00000000..eb2406ed --- /dev/null +++ b/xero_python/payrollauv2/models/timesheet_line.py @@ -0,0 +1,198 @@ +# coding: utf-8 + +""" +Xero Payroll AU API 2.0 + +This is the Xero Payroll API 2.0 for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class TimesheetLine(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "timesheet_line_id": "str", + "date": "date", + "earnings_rate_id": "str", + "tracking_item_id": "str", + "number_of_units": "float", + } + + attribute_map = { + "timesheet_line_id": "timesheetLineID", + "date": "date", + "earnings_rate_id": "earningsRateID", + "tracking_item_id": "trackingItemID", + "number_of_units": "numberOfUnits", + } + + def __init__( + self, + timesheet_line_id=None, + date=None, + earnings_rate_id=None, + tracking_item_id=None, + number_of_units=None, + ): # noqa: E501 + """TimesheetLine - a model defined in OpenAPI""" # noqa: E501 + + self._timesheet_line_id = None + self._date = None + self._earnings_rate_id = None + self._tracking_item_id = None + self._number_of_units = None + self.discriminator = None + + if timesheet_line_id is not None: + self.timesheet_line_id = timesheet_line_id + self.date = date + self.earnings_rate_id = earnings_rate_id + if tracking_item_id is not None: + self.tracking_item_id = tracking_item_id + self.number_of_units = number_of_units + + @property + def timesheet_line_id(self): + """Gets the timesheet_line_id of this TimesheetLine. # noqa: E501 + + The Xero identifier for a Timesheet Line # noqa: E501 + + :return: The timesheet_line_id of this TimesheetLine. # noqa: E501 + :rtype: str + """ + return self._timesheet_line_id + + @timesheet_line_id.setter + def timesheet_line_id(self, timesheet_line_id): + """Sets the timesheet_line_id of this TimesheetLine. + + The Xero identifier for a Timesheet Line # noqa: E501 + + :param timesheet_line_id: The timesheet_line_id of this TimesheetLine. # noqa: E501 + :type: str + """ + + self._timesheet_line_id = timesheet_line_id + + @property + def date(self): + """Gets the date of this TimesheetLine. # noqa: E501 + + The Date that this Timesheet Line is for (YYYY-MM-DD) # noqa: E501 + + :return: The date of this TimesheetLine. # noqa: E501 + :rtype: date + """ + return self._date + + @date.setter + def date(self, date): + """Sets the date of this TimesheetLine. + + The Date that this Timesheet Line is for (YYYY-MM-DD) # noqa: E501 + + :param date: The date of this TimesheetLine. # noqa: E501 + :type: date + """ + if date is None: + raise ValueError( + "Invalid value for `date`, must not be `None`" + ) # noqa: E501 + + self._date = date + + @property + def earnings_rate_id(self): + """Gets the earnings_rate_id of this TimesheetLine. # noqa: E501 + + The Xero identifier for the Earnings Rate that the Timesheet is for # noqa: E501 + + :return: The earnings_rate_id of this TimesheetLine. # noqa: E501 + :rtype: str + """ + return self._earnings_rate_id + + @earnings_rate_id.setter + def earnings_rate_id(self, earnings_rate_id): + """Sets the earnings_rate_id of this TimesheetLine. + + The Xero identifier for the Earnings Rate that the Timesheet is for # noqa: E501 + + :param earnings_rate_id: The earnings_rate_id of this TimesheetLine. # noqa: E501 + :type: str + """ + if earnings_rate_id is None: + raise ValueError( + "Invalid value for `earnings_rate_id`, must not be `None`" + ) # noqa: E501 + + self._earnings_rate_id = earnings_rate_id + + @property + def tracking_item_id(self): + """Gets the tracking_item_id of this TimesheetLine. # noqa: E501 + + The Xero identifier for the Tracking Item that the Timesheet is for # noqa: E501 + + :return: The tracking_item_id of this TimesheetLine. # noqa: E501 + :rtype: str + """ + return self._tracking_item_id + + @tracking_item_id.setter + def tracking_item_id(self, tracking_item_id): + """Sets the tracking_item_id of this TimesheetLine. + + The Xero identifier for the Tracking Item that the Timesheet is for # noqa: E501 + + :param tracking_item_id: The tracking_item_id of this TimesheetLine. # noqa: E501 + :type: str + """ + + self._tracking_item_id = tracking_item_id + + @property + def number_of_units(self): + """Gets the number_of_units of this TimesheetLine. # noqa: E501 + + The Number of Units of the Timesheet Line # noqa: E501 + + :return: The number_of_units of this TimesheetLine. # noqa: E501 + :rtype: float + """ + return self._number_of_units + + @number_of_units.setter + def number_of_units(self, number_of_units): + """Sets the number_of_units of this TimesheetLine. + + The Number of Units of the Timesheet Line # noqa: E501 + + :param number_of_units: The number_of_units of this TimesheetLine. # noqa: E501 + :type: float + """ + if number_of_units is None: + raise ValueError( + "Invalid value for `number_of_units`, must not be `None`" + ) # noqa: E501 + + self._number_of_units = number_of_units diff --git a/xero_python/payrollauv2/models/timesheet_line_object.py b/xero_python/payrollauv2/models/timesheet_line_object.py new file mode 100644 index 00000000..d4e77f1a --- /dev/null +++ b/xero_python/payrollauv2/models/timesheet_line_object.py @@ -0,0 +1,122 @@ +# coding: utf-8 + +""" +Xero Payroll AU API 2.0 + +This is the Xero Payroll API 2.0 for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class TimesheetLineObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "timesheet_line": "TimesheetLine", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "timesheet_line": "timesheetLine", + } + + def __init__( + self, pagination=None, problem=None, timesheet_line=None + ): # noqa: E501 + """TimesheetLineObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._timesheet_line = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if timesheet_line is not None: + self.timesheet_line = timesheet_line + + @property + def pagination(self): + """Gets the pagination of this TimesheetLineObject. # noqa: E501 + + + :return: The pagination of this TimesheetLineObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this TimesheetLineObject. + + + :param pagination: The pagination of this TimesheetLineObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this TimesheetLineObject. # noqa: E501 + + + :return: The problem of this TimesheetLineObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this TimesheetLineObject. + + + :param problem: The problem of this TimesheetLineObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def timesheet_line(self): + """Gets the timesheet_line of this TimesheetLineObject. # noqa: E501 + + + :return: The timesheet_line of this TimesheetLineObject. # noqa: E501 + :rtype: TimesheetLine + """ + return self._timesheet_line + + @timesheet_line.setter + def timesheet_line(self, timesheet_line): + """Sets the timesheet_line of this TimesheetLineObject. + + + :param timesheet_line: The timesheet_line of this TimesheetLineObject. # noqa: E501 + :type: TimesheetLine + """ + + self._timesheet_line = timesheet_line diff --git a/xero_python/payrollauv2/models/timesheet_object.py b/xero_python/payrollauv2/models/timesheet_object.py new file mode 100644 index 00000000..6c6cd97c --- /dev/null +++ b/xero_python/payrollauv2/models/timesheet_object.py @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" +Xero Payroll AU API 2.0 + +This is the Xero Payroll API 2.0 for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class TimesheetObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "timesheet": "Timesheet", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "timesheet": "timesheet", + } + + def __init__(self, pagination=None, problem=None, timesheet=None): # noqa: E501 + """TimesheetObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._timesheet = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if timesheet is not None: + self.timesheet = timesheet + + @property + def pagination(self): + """Gets the pagination of this TimesheetObject. # noqa: E501 + + + :return: The pagination of this TimesheetObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this TimesheetObject. + + + :param pagination: The pagination of this TimesheetObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this TimesheetObject. # noqa: E501 + + + :return: The problem of this TimesheetObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this TimesheetObject. + + + :param problem: The problem of this TimesheetObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def timesheet(self): + """Gets the timesheet of this TimesheetObject. # noqa: E501 + + + :return: The timesheet of this TimesheetObject. # noqa: E501 + :rtype: Timesheet + """ + return self._timesheet + + @timesheet.setter + def timesheet(self, timesheet): + """Sets the timesheet of this TimesheetObject. + + + :param timesheet: The timesheet of this TimesheetObject. # noqa: E501 + :type: Timesheet + """ + + self._timesheet = timesheet diff --git a/xero_python/payrollauv2/models/timesheets.py b/xero_python/payrollauv2/models/timesheets.py new file mode 100644 index 00000000..51481a6e --- /dev/null +++ b/xero_python/payrollauv2/models/timesheets.py @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" +Xero Payroll AU API 2.0 + +This is the Xero Payroll API 2.0 for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class Timesheets(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "timesheets": "list[Timesheet]", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "timesheets": "timesheets", + } + + def __init__(self, pagination=None, problem=None, timesheets=None): # noqa: E501 + """Timesheets - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._timesheets = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if timesheets is not None: + self.timesheets = timesheets + + @property + def pagination(self): + """Gets the pagination of this Timesheets. # noqa: E501 + + + :return: The pagination of this Timesheets. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this Timesheets. + + + :param pagination: The pagination of this Timesheets. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this Timesheets. # noqa: E501 + + + :return: The problem of this Timesheets. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this Timesheets. + + + :param problem: The problem of this Timesheets. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def timesheets(self): + """Gets the timesheets of this Timesheets. # noqa: E501 + + + :return: The timesheets of this Timesheets. # noqa: E501 + :rtype: list[Timesheet] + """ + return self._timesheets + + @timesheets.setter + def timesheets(self, timesheets): + """Sets the timesheets of this Timesheets. + + + :param timesheets: The timesheets of this Timesheets. # noqa: E501 + :type: list[Timesheet] + """ + + self._timesheets = timesheets diff --git a/xero_python/payrollnz/__init__.py b/xero_python/payrollnz/__init__.py index 1aa00d0c..073fca58 100644 --- a/xero_python/payrollnz/__init__.py +++ b/xero_python/payrollnz/__init__.py @@ -3,12 +3,12 @@ # flake8: noqa """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -87,6 +87,19 @@ ) from xero_python.payrollnz.models.employee_tax import EmployeeTax from xero_python.payrollnz.models.employee_tax_object import EmployeeTaxObject +from xero_python.payrollnz.models.employee_working_pattern import EmployeeWorkingPattern +from xero_python.payrollnz.models.employee_working_pattern_with_working_weeks import ( + EmployeeWorkingPatternWithWorkingWeeks, +) +from xero_python.payrollnz.models.employee_working_pattern_with_working_weeks_object import ( + EmployeeWorkingPatternWithWorkingWeeksObject, +) +from xero_python.payrollnz.models.employee_working_pattern_with_working_weeks_request import ( + EmployeeWorkingPatternWithWorkingWeeksRequest, +) +from xero_python.payrollnz.models.employee_working_patterns_object import ( + EmployeeWorkingPatternsObject, +) from xero_python.payrollnz.models.employees import Employees from xero_python.payrollnz.models.employment import Employment from xero_python.payrollnz.models.employment_object import EmploymentObject @@ -144,3 +157,4 @@ from xero_python.payrollnz.models.timesheets import Timesheets from xero_python.payrollnz.models.tracking_categories import TrackingCategories from xero_python.payrollnz.models.tracking_category import TrackingCategory +from xero_python.payrollnz.models.working_week import WorkingWeek diff --git a/xero_python/payrollnz/api/payroll_nz_api.py b/xero_python/payrollnz/api/payroll_nz_api.py index 084c1345..7c37737e 100644 --- a/xero_python/payrollnz/api/payroll_nz_api.py +++ b/xero_python/payrollnz/api/payroll_nz_api.py @@ -1,5 +1,16 @@ # coding: utf-8 +import importlib +import re # noqa: F401 + +from xero_python import exceptions +from xero_python.api_client import ApiClient, ModelFinder + +try: + from .exception_handler import translate_status_exception +except ImportError: + translate_status_exception = exceptions.translate_status_exception + """ Xero Payroll NZ @@ -10,20 +21,9 @@ """ """ - OpenAPI spec version: 2.19.3 + OpenAPI spec version: 16.2.0 """ -import importlib -import re # noqa: F401 - -from xero_python import exceptions -from xero_python.api_client import ApiClient, ModelFinder - -try: - from .exception_handler import translate_status_exception -except ImportError: - translate_status_exception = exceptions.translate_status_exception - class empty: """empty object to mark optional parameter not set""" @@ -60,6 +60,7 @@ def approve_timesheet( self, xero_tenant_id, timesheet_id, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -68,6 +69,7 @@ def approve_timesheet( OAuth2 scope: payroll.timesheets :param str xero_tenant_id: Xero identifier for Tenant (required) :param str timesheet_id: Identifier for the timesheet (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -98,6 +100,9 @@ def approve_timesheet( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -136,6 +141,7 @@ def create_deduction( self, xero_tenant_id, deduction, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -144,6 +150,7 @@ def create_deduction( OAuth2 scope: payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param Deduction deduction: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -172,6 +179,9 @@ def create_deduction( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -215,6 +225,7 @@ def create_earnings_rate( self, xero_tenant_id, earnings_rate, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -223,6 +234,7 @@ def create_earnings_rate( OAuth2 scope: payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param EarningsRate earnings_rate: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -251,6 +263,9 @@ def create_earnings_rate( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -294,6 +309,7 @@ def create_employee( self, xero_tenant_id, employee, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -302,6 +318,7 @@ def create_employee( OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param Employee employee: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -330,6 +347,9 @@ def create_employee( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -374,6 +394,7 @@ def create_employee_earnings_template( xero_tenant_id, employee_id, earnings_template, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -383,6 +404,7 @@ def create_employee_earnings_template( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) :param EarningsTemplate earnings_template: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -419,6 +441,9 @@ def create_employee_earnings_template( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -435,7 +460,7 @@ def create_employee_earnings_template( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeID}/PayTemplates/earnings") + url = self.get_resource_url("/Employees/{EmployeeID}/PayTemplates/Earnings") try: return self.api_client.call_api( @@ -465,6 +490,7 @@ def create_employee_leave( xero_tenant_id, employee_id, employee_leave, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -474,6 +500,7 @@ def create_employee_leave( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) :param EmployeeLeave employee_leave: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -510,6 +537,9 @@ def create_employee_leave( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -554,6 +584,7 @@ def create_employee_leave_setup( xero_tenant_id, employee_id, employee_leave_setup, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -563,6 +594,7 @@ def create_employee_leave_setup( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) :param EmployeeLeaveSetup employee_leave_setup: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -599,6 +631,9 @@ def create_employee_leave_setup( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -615,7 +650,7 @@ def create_employee_leave_setup( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeID}/leaveSetup") + url = self.get_resource_url("/Employees/{EmployeeID}/LeaveSetup") try: return self.api_client.call_api( @@ -643,6 +678,7 @@ def create_employee_leave_type( xero_tenant_id, employee_id, employee_leave_type, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -652,6 +688,7 @@ def create_employee_leave_type( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) :param EmployeeLeaveType employee_leave_type: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -688,6 +725,9 @@ def create_employee_leave_type( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -732,6 +772,7 @@ def create_employee_opening_balances( xero_tenant_id, employee_id, employee_opening_balance, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -741,6 +782,7 @@ def create_employee_opening_balances( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) :param list[EmployeeOpeningBalance] employee_opening_balance: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -777,6 +819,9 @@ def create_employee_opening_balances( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -793,7 +838,7 @@ def create_employee_opening_balances( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeID}/openingBalances") + url = self.get_resource_url("/Employees/{EmployeeID}/OpeningBalances") try: return self.api_client.call_api( @@ -823,6 +868,7 @@ def create_employee_payment_method( xero_tenant_id, employee_id, payment_method, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -832,6 +878,7 @@ def create_employee_payment_method( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) :param PaymentMethod payment_method: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -868,6 +915,9 @@ def create_employee_payment_method( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -914,6 +964,7 @@ def create_employee_salary_and_wage( xero_tenant_id, employee_id, salary_and_wage, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -923,6 +974,7 @@ def create_employee_salary_and_wage( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) :param SalaryAndWage salary_and_wage: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -959,6 +1011,9 @@ def create_employee_salary_and_wage( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1000,11 +1055,108 @@ def create_employee_salary_and_wage( error, self, "create_employee_salary_and_wage" ) + def create_employee_working_pattern( + self, + xero_tenant_id, + employee_id, + employee_working_pattern_with_working_weeks_request, + idempotency_key=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Creates an employee working pattern # noqa: E501 + OAuth2 scope: payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param EmployeeWorkingPatternWithWorkingWeeksRequest employee_working_pattern_with_working_weeks_request: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EmployeeWorkingPatternWithWorkingWeeksObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `create_employee_working_pattern`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `create_employee_working_pattern`" + ) + # verify the required parameter 'employee_working_pattern_with_working_weeks_request' is set + if employee_working_pattern_with_working_weeks_request is None: + raise ValueError( + "Missing the required parameter `employee_working_pattern_with_working_weeks_request` " + "when calling `create_employee_working_pattern`" + ) + + collection_formats = {} + path_params = { + "EmployeeID": employee_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + + local_var_files = {} + form_params = [] + + body_params = employee_working_pattern_with_working_weeks_request + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Employees/{EmployeeID}/Working-Patterns") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EmployeeWorkingPatternWithWorkingWeeksObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception( + error, self, "create_employee_working_pattern" + ) + def create_employment( self, xero_tenant_id, employee_id, employment, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1014,6 +1166,7 @@ def create_employment( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) :param Employment employment: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1050,6 +1203,9 @@ def create_employment( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1093,6 +1249,7 @@ def create_leave_type( self, xero_tenant_id, leave_type, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1101,6 +1258,7 @@ def create_leave_type( OAuth2 scope: payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param LeaveType leave_type: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1129,6 +1287,9 @@ def create_leave_type( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1173,6 +1334,7 @@ def create_multiple_employee_earnings_template( xero_tenant_id, employee_id, earnings_template, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1182,6 +1344,7 @@ def create_multiple_employee_earnings_template( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) :param list[EarningsTemplate] earnings_template: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1218,6 +1381,9 @@ def create_multiple_employee_earnings_template( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1234,7 +1400,7 @@ def create_multiple_employee_earnings_template( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeID}/paytemplateearnings") + url = self.get_resource_url("/Employees/{EmployeeID}/PayTemplateEarnings") try: return self.api_client.call_api( @@ -1263,6 +1429,7 @@ def create_pay_run( self, xero_tenant_id, pay_run, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1271,6 +1438,7 @@ def create_pay_run( OAuth2 scope: payroll.payruns :param str xero_tenant_id: Xero identifier for Tenant (required) :param PayRun pay_run: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1299,6 +1467,9 @@ def create_pay_run( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1342,6 +1513,7 @@ def create_pay_run_calendar( self, xero_tenant_id, pay_run_calendar, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1350,6 +1522,7 @@ def create_pay_run_calendar( OAuth2 scope: payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param PayRunCalendar pay_run_calendar: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1378,6 +1551,9 @@ def create_pay_run_calendar( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1421,6 +1597,7 @@ def create_reimbursement( self, xero_tenant_id, reimbursement, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1429,6 +1606,7 @@ def create_reimbursement( OAuth2 scope: payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param Reimbursement reimbursement: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1457,6 +1635,9 @@ def create_reimbursement( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1500,6 +1681,7 @@ def create_superannuation( self, xero_tenant_id, benefit, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1508,6 +1690,7 @@ def create_superannuation( OAuth2 scope: payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param Benefit benefit: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1536,6 +1719,9 @@ def create_superannuation( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1579,6 +1765,7 @@ def create_timesheet( self, xero_tenant_id, timesheet, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1587,6 +1774,7 @@ def create_timesheet( OAuth2 scope: payroll.timesheets :param str xero_tenant_id: Xero identifier for Tenant (required) :param Timesheet timesheet: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1615,6 +1803,9 @@ def create_timesheet( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1659,6 +1850,7 @@ def create_timesheet_line( xero_tenant_id, timesheet_id, timesheet_line, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1668,6 +1860,7 @@ def create_timesheet_line( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str timesheet_id: Identifier for the timesheet (required) :param TimesheetLine timesheet_line: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1704,6 +1897,9 @@ def create_timesheet_line( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1806,7 +2002,7 @@ def delete_employee_earnings_template( # Authentication setting auth_settings = ["OAuth2"] url = self.get_resource_url( - "/Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}" + "/Employees/{EmployeeID}/PayTemplates/Earnings/{PayTemplateEarningID}" ) try: @@ -2006,6 +2202,95 @@ def delete_employee_salary_and_wage( error, self, "delete_employee_salary_and_wage" ) + def delete_employee_working_pattern( + self, + xero_tenant_id, + employee_id, + employee_working_pattern_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """deletes employee's working patterns # noqa: E501 + OAuth2 scope: payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param str employee_working_pattern_id: Employee working pattern id for single object (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EmployeeLeaveObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `delete_employee_working_pattern`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `delete_employee_working_pattern`" + ) + # verify the required parameter 'employee_working_pattern_id' is set + if employee_working_pattern_id is None: + raise ValueError( + "Missing the required parameter `employee_working_pattern_id` " + "when calling `delete_employee_working_pattern`" + ) + + collection_formats = {} + path_params = { + "EmployeeID": employee_id, + "EmployeeWorkingPatternID": employee_working_pattern_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url( + "/Employees/{EmployeeID}/Working-Patterns/{EmployeeWorkingPatternID}" + ) + + try: + return self.api_client.call_api( + url, + "DELETE", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EmployeeLeaveObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception( + error, self, "delete_employee_working_pattern" + ) + def delete_timesheet( self, xero_tenant_id, @@ -2904,7 +3189,7 @@ def get_employee_opening_balances( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeID}/openingBalances") + url = self.get_resource_url("/Employees/{EmployeeID}/OpeningBalances") try: return self.api_client.call_api( @@ -3329,6 +3614,173 @@ def get_employee_tax( except exceptions.HTTPStatusException as error: raise translate_status_exception(error, self, "get_employee_tax") + def get_employee_working_pattern( + self, + xero_tenant_id, + employee_id, + employee_working_pattern_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Retrieves employee's working patterns # noqa: E501 + OAuth2 scope: payroll.employees, payroll.employees.read + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param str employee_working_pattern_id: Employee working pattern id for single object (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EmployeeWorkingPatternWithWorkingWeeksObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_employee_working_pattern`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `get_employee_working_pattern`" + ) + # verify the required parameter 'employee_working_pattern_id' is set + if employee_working_pattern_id is None: + raise ValueError( + "Missing the required parameter `employee_working_pattern_id` " + "when calling `get_employee_working_pattern`" + ) + + collection_formats = {} + path_params = { + "EmployeeID": employee_id, + "EmployeeWorkingPatternID": employee_working_pattern_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url( + "/Employees/{EmployeeID}/Working-Patterns/{EmployeeWorkingPatternID}" + ) + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EmployeeWorkingPatternWithWorkingWeeksObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception( + error, self, "get_employee_working_pattern" + ) + + def get_employee_working_patterns( + self, + xero_tenant_id, + employee_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Retrieves employee's working patterns # noqa: E501 + OAuth2 scope: payroll.employees, payroll.employees.read + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EmployeeWorkingPatternsObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_employee_working_patterns`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `get_employee_working_patterns`" + ) + + collection_formats = {} + path_params = { + "EmployeeID": employee_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Employees/{EmployeeID}/Working-Patterns") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EmployeeWorkingPatternsObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception( + error, self, "get_employee_working_patterns" + ) + def get_employees( self, xero_tenant_id, @@ -4762,6 +5214,7 @@ def revert_timesheet( self, xero_tenant_id, timesheet_id, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -4770,6 +5223,7 @@ def revert_timesheet( OAuth2 scope: payroll.timesheets :param str xero_tenant_id: Xero identifier for Tenant (required) :param str timesheet_id: Identifier for the timesheet (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -4800,6 +5254,9 @@ def revert_timesheet( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -4839,6 +5296,7 @@ def update_employee( xero_tenant_id, employee_id, employee, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -4848,6 +5306,7 @@ def update_employee( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) :param Employee employee: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -4884,6 +5343,9 @@ def update_employee( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -4929,6 +5391,7 @@ def update_employee_earnings_template( employee_id, pay_template_earning_id, earnings_template, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -4939,6 +5402,7 @@ def update_employee_earnings_template( :param str employee_id: Employee id for single object (required) :param str pay_template_earning_id: Id for single pay template earnings object (required) :param EarningsTemplate earnings_template: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -4982,6 +5446,9 @@ def update_employee_earnings_template( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -4999,7 +5466,7 @@ def update_employee_earnings_template( # Authentication setting auth_settings = ["OAuth2"] url = self.get_resource_url( - "/Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}" + "/Employees/{EmployeeID}/PayTemplates/Earnings/{PayTemplateEarningID}" ) try: @@ -5031,6 +5498,7 @@ def update_employee_leave( employee_id, leave_id, employee_leave, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -5041,6 +5509,7 @@ def update_employee_leave( :param str employee_id: Employee id for single object (required) :param str leave_id: Leave id for single object (required) :param EmployeeLeave employee_leave: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -5084,6 +5553,9 @@ def update_employee_leave( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -5129,6 +5601,7 @@ def update_employee_salary_and_wage( employee_id, salary_and_wages_id, salary_and_wage, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -5139,6 +5612,7 @@ def update_employee_salary_and_wage( :param str employee_id: Employee id for single object (required) :param str salary_and_wages_id: Id for single pay template earnings object (required) :param SalaryAndWage salary_and_wage: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -5182,6 +5656,9 @@ def update_employee_salary_and_wage( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -5230,6 +5707,7 @@ def update_employee_tax( xero_tenant_id, employee_id, employee_tax, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -5239,6 +5717,7 @@ def update_employee_tax( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) :param EmployeeTax employee_tax: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -5275,6 +5754,9 @@ def update_employee_tax( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -5314,100 +5796,12 @@ def update_employee_tax( except exceptions.HTTPStatusException as error: raise translate_status_exception(error, self, "update_employee_tax") - def update_pay_run( - self, - xero_tenant_id, - pay_run_id, - pay_run, - _return_http_data_only=True, - _preload_content=True, - _request_timeout=None, - ): - """Updates a pay run # noqa: E501 - OAuth2 scope: payroll.payruns - :param str xero_tenant_id: Xero identifier for Tenant (required) - :param str pay_run_id: Identifier for the pay run (required) - :param PayRun pay_run: (required) - :param bool _return_http_data_only: return received data only - :param bool _preload_content: load received data in models - :param bool _request_timeout: maximum wait time for response - :return: PayRunObject - """ - - # verify the required parameter 'xero_tenant_id' is set - if xero_tenant_id is None: - raise ValueError( - "Missing the required parameter `xero_tenant_id` " - "when calling `update_pay_run`" - ) - # verify the required parameter 'pay_run_id' is set - if pay_run_id is None: - raise ValueError( - "Missing the required parameter `pay_run_id` " - "when calling `update_pay_run`" - ) - # verify the required parameter 'pay_run' is set - if pay_run is None: - raise ValueError( - "Missing the required parameter `pay_run` " - "when calling `update_pay_run`" - ) - - collection_formats = {} - path_params = { - "PayRunID": pay_run_id, - } - - query_params = [] - - header_params = { - "Xero-Tenant-Id": xero_tenant_id, - } - - local_var_files = {} - form_params = [] - - body_params = pay_run - # HTTP header `Accept` - header_params["Accept"] = self.api_client.select_header_accept( - ["application/json"] - ) - - # HTTP header `Content-Type` - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json"] - ) - - # Authentication setting - auth_settings = ["OAuth2"] - url = self.get_resource_url("/PayRuns/{PayRunID}") - - try: - return self.api_client.call_api( - url, - "PUT", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type="PayRunObject", - response_model_finder=self.get_model_finder(), - auth_settings=auth_settings, - _return_http_data_only=_return_http_data_only, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - collection_formats=collection_formats, - ) - except exceptions.HTTPStatusException as error: - raise translate_status_exception(error, self, "update_pay_run") - def update_pay_slip_line_items( self, xero_tenant_id, pay_slip_id, pay_slip, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -5417,6 +5811,7 @@ def update_pay_slip_line_items( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str pay_slip_id: Identifier for the payslip (required) :param PaySlip pay_slip: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -5453,6 +5848,9 @@ def update_pay_slip_line_items( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -5498,6 +5896,7 @@ def update_timesheet_line( timesheet_id, timesheet_line_id, timesheet_line, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -5508,6 +5907,7 @@ def update_timesheet_line( :param str timesheet_id: Identifier for the timesheet (required) :param str timesheet_line_id: Identifier for the timesheet line (required) :param TimesheetLine timesheet_line: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -5551,6 +5951,9 @@ def update_timesheet_line( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] diff --git a/xero_python/payrollnz/docs/Employee.md b/xero_python/payrollnz/docs/Employee.md index 307246c4..2cb3d04f 100644 --- a/xero_python/payrollnz/docs/Employee.md +++ b/xero_python/payrollnz/docs/Employee.md @@ -5,10 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **employee_id** | **str** | Xero unique identifier for the employee | [optional] **title** | **str** | Title of the employee | [optional] -**first_name** | **str** | First name of employee | [optional] -**last_name** | **str** | Last name of employee | [optional] -**date_of_birth** | **date** | Date of birth of the employee (YYYY-MM-DD) | [optional] -**address** | [**Address**](Address.md) | | [optional] +**first_name** | **str** | First name of employee | +**last_name** | **str** | Last name of employee | +**date_of_birth** | **date** | Date of birth of the employee (YYYY-MM-DD) | +**address** | [**Address**](Address.md) | | **email** | **str** | The email address for the employee | [optional] **gender** | **str** | The employee’s gender | [optional] **phone_number** | **str** | Employee phone number | [optional] @@ -17,6 +17,9 @@ Name | Type | Description | Notes **payroll_calendar_id** | **str** | Xero unique identifier for the payroll calendar of the employee | [optional] **updated_date_utc** | **datetime** | UTC timestamp of last update to the employee | [optional] **created_date_utc** | **datetime** | UTC timestamp when the employee was created in Xero | [optional] +**job_title** | **str** | Employee's job title | [optional] +**engagement_type** | **str** | Engagement type of the employee | [optional] +**fixed_term_end_date** | **date** | End date for an employee with a fixed-term engagement type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrollnz/docs/EmployeeLeaveSetup.md b/xero_python/payrollnz/docs/EmployeeLeaveSetup.md index b9bf6d82..ef05ec62 100644 --- a/xero_python/payrollnz/docs/EmployeeLeaveSetup.md +++ b/xero_python/payrollnz/docs/EmployeeLeaveSetup.md @@ -7,9 +7,12 @@ Name | Type | Description | Notes **holiday_pay_opening_balance** | **float** | Initial holiday pay balance. A percentage — usually 8% — of gross earnings since their last work anniversary. | [optional] **annual_leave_opening_balance** | **float** | Initial annual leave balance. The balance at their last anniversary, less any leave taken since then and excluding accrued annual leave. | [optional] **negative_annual_leave_balance_paid_amount** | **float** | The dollar value of annual leave opening balance if negative. | [optional] -**sick_leave_hours_to_accrue_annually** | **float** | Number of hours accrued annually for sick leave. Multiply the number of days they're entitled to by the hours worked per day | [optional] -**sick_leave_maximum_hours_to_accrue** | **float** | Maximum number of hours accrued annually for sick leave. Multiply the maximum days they can accrue by the hours worked per day | [optional] +**sick_leave_to_accrue_annually** | **float** | Number of units accrued annually for sick leave. The type of units is determined by the property \"TypeOfUnitsToAccrue\" on the \"Sick Leave\" leave type | [optional] +**sick_leave_maximum_to_accrue** | **float** | Maximum number of units accrued annually for sick leave. The type of units is determined by the property \"TypeOfUnitsToAccrue\" on the \"Sick Leave\" leave type | [optional] **sick_leave_opening_balance** | **float** | Initial sick leave balance. This will be positive unless they've taken sick leave in advance | [optional] +**sick_leave_schedule_of_accrual** | **str** | Set Schedule of Accrual Type for Sick Leave | [optional] +**sick_leave_anniversary_date** | **date** | If Sick Leave Schedule of Accrual is \"OnAnniversaryDate\", this is the date when entitled to Sick Leave. When null the Employee's start date is used as the anniversary date | [optional] +**annual_leave_anniversary_date** | **date** | The first date the employee will accrue Annual Leave. When null the Employee's start date is used as the anniversary date | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrollnz/docs/EmployeeLeaveType.md b/xero_python/payrollnz/docs/EmployeeLeaveType.md index eca4056f..d5769bec 100644 --- a/xero_python/payrollnz/docs/EmployeeLeaveType.md +++ b/xero_python/payrollnz/docs/EmployeeLeaveType.md @@ -5,14 +5,17 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **leave_type_id** | **str** | The Xero identifier for leave type | [optional] **schedule_of_accrual** | **str** | The schedule of accrual | [optional] -**hours_accrued_annually** | **float** | The number of hours accrued for the leave annually. This is 0 when the scheduleOfAccrual chosen is \"OnHourWorked\" | [optional] -**maximum_to_accrue** | **float** | The maximum number of hours that can be accrued for the leave | [optional] -**opening_balance** | **float** | The initial number of hours assigned when the leave was added to the employee | [optional] -**rate_accrued_hourly** | **float** | The number of hours added to the leave balance for every hour worked by the employee. This is normally 0, unless the scheduleOfAccrual chosen is \"OnHourWorked\" | [optional] +**units_accrued_annually** | **float** | The number of units accrued for the leave annually. This is 0 when the ScheduleOfAccrual chosen is \"NoAccruals\" | [optional] +**type_of_units_to_accrue** | **str** | The type of units accrued for the leave annually | [optional] +**maximum_to_accrue** | **float** | The maximum number of units that can be accrued for the leave | [optional] +**opening_balance** | **float** | The initial number of units assigned when the leave was added to the employee | [optional] +**opening_balance_type_of_units** | **str** | The type of units for the opening balance | [optional] +**rate_accrued_hourly** | **float** | not supported in Payroll NZ | [optional] **percentage_of_gross_earnings** | **float** | Specific for scheduleOfAccrual having percentage of gross earnings. Identifies how much percentage of gross earnings is accrued per pay period. | [optional] **include_holiday_pay_every_pay** | **bool** | Specific to Holiday pay. Flag determining if pay for leave type is added on each pay run. | [optional] **show_annual_leave_in_advance** | **bool** | Specific to Annual Leave. Flag to include leave available to take in advance in the balance in the payslip | [optional] **annual_leave_total_amount_paid** | **float** | Specific to Annual Leave. Annual leave balance in dollars | [optional] +**schedule_of_accrual_date** | **date** | The date when an employee becomes entitled to their accrual. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrollnz/docs/EmployeePayTemplate.md b/xero_python/payrollnz/docs/EmployeePayTemplate.md index 6fc2e482..de05e921 100644 --- a/xero_python/payrollnz/docs/EmployeePayTemplate.md +++ b/xero_python/payrollnz/docs/EmployeePayTemplate.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **employee_id** | **str** | Unique identifier for the employee | [optional] -**earning_templates** | [**list[EarningsTemplate]**](EarningsTemplate.md) | | [optional] +**earning_templates** | [**list[EarningsTemplate]**](EarningsTemplate.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrollnz/docs/EmployeeWorkingPattern.md b/xero_python/payrollnz/docs/EmployeeWorkingPattern.md new file mode 100644 index 00000000..c38617ef --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeWorkingPattern.md @@ -0,0 +1,11 @@ +# EmployeeWorkingPattern + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payee_working_pattern_id** | **str** | The Xero identifier for for Employee working pattern | +**effective_from** | **date** | The effective date of the corresponding salary and wages | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollnz/docs/EmployeeWorkingPatternWithWorkingWeeks.md b/xero_python/payrollnz/docs/EmployeeWorkingPatternWithWorkingWeeks.md new file mode 100644 index 00000000..2ae49f5f --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeWorkingPatternWithWorkingWeeks.md @@ -0,0 +1,12 @@ +# EmployeeWorkingPatternWithWorkingWeeks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payee_working_pattern_id** | **str** | The Xero identifier for for Employee working pattern | +**effective_from** | **date** | The effective date of the corresponding salary and wages | +**working_weeks** | [**list[WorkingWeek]**](WorkingWeek.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollnz/docs/EmployeeWorkingPatternWithWorkingWeeksObject.md b/xero_python/payrollnz/docs/EmployeeWorkingPatternWithWorkingWeeksObject.md new file mode 100644 index 00000000..b00027b6 --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeWorkingPatternWithWorkingWeeksObject.md @@ -0,0 +1,12 @@ +# EmployeeWorkingPatternWithWorkingWeeksObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**payee_working_pattern** | [**EmployeeWorkingPatternWithWorkingWeeks**](EmployeeWorkingPatternWithWorkingWeeks.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollnz/docs/EmployeeWorkingPatternWithWorkingWeeksRequest.md b/xero_python/payrollnz/docs/EmployeeWorkingPatternWithWorkingWeeksRequest.md new file mode 100644 index 00000000..37d63bb3 --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeWorkingPatternWithWorkingWeeksRequest.md @@ -0,0 +1,11 @@ +# EmployeeWorkingPatternWithWorkingWeeksRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**effective_from** | **date** | The effective date of the corresponding salary and wages | +**working_weeks** | [**list[WorkingWeek]**](WorkingWeek.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollnz/docs/EmployeeWorkingPatternsObject.md b/xero_python/payrollnz/docs/EmployeeWorkingPatternsObject.md new file mode 100644 index 00000000..a1f10fa9 --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeWorkingPatternsObject.md @@ -0,0 +1,12 @@ +# EmployeeWorkingPatternsObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**payee_working_patterns** | [**list[EmployeeWorkingPattern]**](EmployeeWorkingPattern.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollnz/docs/Employment.md b/xero_python/payrollnz/docs/Employment.md index 70b6e694..7b236418 100644 --- a/xero_python/payrollnz/docs/Employment.md +++ b/xero_python/payrollnz/docs/Employment.md @@ -3,9 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**payroll_calendar_id** | **str** | Xero unique identifier for the payroll calendar of the employee | [optional] +**payroll_calendar_id** | **str** | Xero unique identifier for the payroll calendar of the employee | **pay_run_calendar_id** | **str** | Xero unique identifier for the payrun calendar for the employee (Deprecated in version 1.1.6) | [optional] -**start_date** | **date** | Start date of the employment (YYYY-MM-DD) | [optional] +**start_date** | **date** | Start date of the employment (YYYY-MM-DD) | +**engagement_type** | **str** | Engagement type of the employee | +**fixed_term_end_date** | **date** | End date for an employee with a fixed-term engagement type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrollnz/docs/LeavePeriod.md b/xero_python/payrollnz/docs/LeavePeriod.md index ad97b401..9c71454c 100644 --- a/xero_python/payrollnz/docs/LeavePeriod.md +++ b/xero_python/payrollnz/docs/LeavePeriod.md @@ -6,7 +6,10 @@ Name | Type | Description | Notes **period_start_date** | **date** | The Pay Period Start Date (YYYY-MM-DD) | [optional] **period_end_date** | **date** | The Pay Period End Date (YYYY-MM-DD) | [optional] **number_of_units** | **float** | The Number of Units for the leave | [optional] -**period_status** | **str** | Period Status | [optional] +**number_of_units_taken** | **float** | The number of units taken for the leave | [optional] +**type_of_units** | **str** | The type of units paid for the leave | [optional] +**type_of_units_taken** | **str** | The type of units taken for the leave | [optional] +**period_status** | **str** | Status of leave | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrollnz/docs/LeaveType.md b/xero_python/payrollnz/docs/LeaveType.md index 49553d40..28668f5c 100644 --- a/xero_python/payrollnz/docs/LeaveType.md +++ b/xero_python/payrollnz/docs/LeaveType.md @@ -9,6 +9,8 @@ Name | Type | Description | Notes **show_on_payslip** | **bool** | Indicate that a balance for this leave type to be shown on the employee’s payslips | **updated_date_utc** | **datetime** | UTC timestamp of last update to the leave type note | [optional] **is_active** | **bool** | Shows whether the leave type is active or not | [optional] +**type_of_units** | **str** | The type of units to be paid for the leave type | [optional] +**type_of_units_to_accrue** | **str** | The type of units to be accrued for the leave type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrollnz/docs/PayrollNZApi.md b/xero_python/payrollnz/docs/PayrollNZApi.md index 0fe0d25e..6eb5aa9f 100644 --- a/xero_python/payrollnz/docs/PayrollNZApi.md +++ b/xero_python/payrollnz/docs/PayrollNZApi.md @@ -8,25 +8,27 @@ Method | HTTP request | Description [**create_deduction**](PayrollNzApi.md#create_deduction) | **POST** /Deductions | Creates a new deduction for a specific employee [**create_earnings_rate**](PayrollNzApi.md#create_earnings_rate) | **POST** /EarningsRates | Creates a new earnings rate [**create_employee**](PayrollNzApi.md#create_employee) | **POST** /Employees | Creates an employees -[**create_employee_earnings_template**](PayrollNzApi.md#create_employee_earnings_template) | **POST** /Employees/{EmployeeID}/PayTemplates/earnings | Creates earnings template records for an employee +[**create_employee_earnings_template**](PayrollNzApi.md#create_employee_earnings_template) | **POST** /Employees/{EmployeeID}/PayTemplates/Earnings | Creates earnings template records for an employee [**create_employee_leave**](PayrollNzApi.md#create_employee_leave) | **POST** /Employees/{EmployeeID}/Leave | Creates leave records for a specific employee -[**create_employee_leave_setup**](PayrollNzApi.md#create_employee_leave_setup) | **POST** /Employees/{EmployeeID}/leaveSetup | Creates a leave set-up for a specific employee. This is required before viewing, configuring and requesting leave for an employee +[**create_employee_leave_setup**](PayrollNzApi.md#create_employee_leave_setup) | **POST** /Employees/{EmployeeID}/LeaveSetup | Creates a leave set-up for a specific employee. This is required before viewing, configuring and requesting leave for an employee [**create_employee_leave_type**](PayrollNzApi.md#create_employee_leave_type) | **POST** /Employees/{EmployeeID}/LeaveTypes | Creates leave type records for a specific employee -[**create_employee_opening_balances**](PayrollNzApi.md#create_employee_opening_balances) | **POST** /Employees/{EmployeeID}/openingBalances | Creates opening balances for a specific employee +[**create_employee_opening_balances**](PayrollNzApi.md#create_employee_opening_balances) | **POST** /Employees/{EmployeeID}/OpeningBalances | Creates opening balances for a specific employee [**create_employee_payment_method**](PayrollNzApi.md#create_employee_payment_method) | **POST** /Employees/{EmployeeID}/PaymentMethods | Creates a payment method for an employee [**create_employee_salary_and_wage**](PayrollNzApi.md#create_employee_salary_and_wage) | **POST** /Employees/{EmployeeID}/SalaryAndWages | Creates an employee salary and wage record +[**create_employee_working_pattern**](PayrollNzApi.md#create_employee_working_pattern) | **POST** /Employees/{EmployeeID}/Working-Patterns | Creates an employee working pattern [**create_employment**](PayrollNzApi.md#create_employment) | **POST** /Employees/{EmployeeID}/Employment | Creates an employment detail for a specific employee [**create_leave_type**](PayrollNzApi.md#create_leave_type) | **POST** /LeaveTypes | Creates a new leave type -[**create_multiple_employee_earnings_template**](PayrollNzApi.md#create_multiple_employee_earnings_template) | **POST** /Employees/{EmployeeID}/paytemplateearnings | Creates multiple employee earnings template records for a specific employee +[**create_multiple_employee_earnings_template**](PayrollNzApi.md#create_multiple_employee_earnings_template) | **POST** /Employees/{EmployeeID}/PayTemplateEarnings | Creates multiple employee earnings template records for a specific employee [**create_pay_run**](PayrollNzApi.md#create_pay_run) | **POST** /PayRuns | Creates a pay run [**create_pay_run_calendar**](PayrollNzApi.md#create_pay_run_calendar) | **POST** /PayRunCalendars | Creates a new payrun calendar [**create_reimbursement**](PayrollNzApi.md#create_reimbursement) | **POST** /Reimbursements | Creates a new reimbursement [**create_superannuation**](PayrollNzApi.md#create_superannuation) | **POST** /Superannuations | Creates a new superannuation [**create_timesheet**](PayrollNzApi.md#create_timesheet) | **POST** /Timesheets | Creates a new timesheet [**create_timesheet_line**](PayrollNzApi.md#create_timesheet_line) | **POST** /Timesheets/{TimesheetID}/Lines | Create a new timesheet line for a specific time sheet -[**delete_employee_earnings_template**](PayrollNzApi.md#delete_employee_earnings_template) | **DELETE** /Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID} | Deletes an employee's earnings template record +[**delete_employee_earnings_template**](PayrollNzApi.md#delete_employee_earnings_template) | **DELETE** /Employees/{EmployeeID}/PayTemplates/Earnings/{PayTemplateEarningID} | Deletes an employee's earnings template record [**delete_employee_leave**](PayrollNzApi.md#delete_employee_leave) | **DELETE** /Employees/{EmployeeID}/Leave/{LeaveID} | Deletes a leave record for a specific employee [**delete_employee_salary_and_wage**](PayrollNzApi.md#delete_employee_salary_and_wage) | **DELETE** /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID} | Deletes an employee's salary and wages record +[**delete_employee_working_pattern**](PayrollNzApi.md#delete_employee_working_pattern) | **DELETE** /Employees/{EmployeeID}/Working-Patterns/{EmployeeWorkingPatternID} | deletes employee's working patterns [**delete_timesheet**](PayrollNzApi.md#delete_timesheet) | **DELETE** /Timesheets/{TimesheetID} | Deletes a timesheet [**delete_timesheet_line**](PayrollNzApi.md#delete_timesheet_line) | **DELETE** /Timesheets/{TimesheetID}/Lines/{TimesheetLineID} | Deletes a timesheet line for a specific timesheet [**get_deduction**](PayrollNzApi.md#get_deduction) | **GET** /Deductions/{deductionId} | Retrieves a single deduction by using a unique deduction ID @@ -38,12 +40,14 @@ Method | HTTP request | Description [**get_employee_leave_periods**](PayrollNzApi.md#get_employee_leave_periods) | **GET** /Employees/{EmployeeID}/LeavePeriods | Retrieves leave periods for a specific employee [**get_employee_leave_types**](PayrollNzApi.md#get_employee_leave_types) | **GET** /Employees/{EmployeeID}/LeaveTypes | Retrieves leave types for a specific employee [**get_employee_leaves**](PayrollNzApi.md#get_employee_leaves) | **GET** /Employees/{EmployeeID}/Leave | Retrieves leave records for a specific employee -[**get_employee_opening_balances**](PayrollNzApi.md#get_employee_opening_balances) | **GET** /Employees/{EmployeeID}/openingBalances | Retrieves the opening balance for a specific employee +[**get_employee_opening_balances**](PayrollNzApi.md#get_employee_opening_balances) | **GET** /Employees/{EmployeeID}/OpeningBalances | Retrieves the opening balance for a specific employee [**get_employee_pay_templates**](PayrollNzApi.md#get_employee_pay_templates) | **GET** /Employees/{EmployeeID}/PayTemplates | Retrieves pay templates for a specific employee [**get_employee_payment_method**](PayrollNzApi.md#get_employee_payment_method) | **GET** /Employees/{EmployeeID}/PaymentMethods | Retrieves available payment methods for a specific employee [**get_employee_salary_and_wage**](PayrollNzApi.md#get_employee_salary_and_wage) | **GET** /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID} | Retrieves an employee's salary and wages record by using a unique salary and wage ID [**get_employee_salary_and_wages**](PayrollNzApi.md#get_employee_salary_and_wages) | **GET** /Employees/{EmployeeID}/SalaryAndWages | Retrieves an employee's salary and wages [**get_employee_tax**](PayrollNzApi.md#get_employee_tax) | **GET** /Employees/{EmployeeID}/Tax | Retrieves tax records for a specific employee +[**get_employee_working_pattern**](PayrollNzApi.md#get_employee_working_pattern) | **GET** /Employees/{EmployeeID}/Working-Patterns/{EmployeeWorkingPatternID} | Retrieves employee's working patterns +[**get_employee_working_patterns**](PayrollNzApi.md#get_employee_working_patterns) | **GET** /Employees/{EmployeeID}/Working-Patterns | Retrieves employee's working patterns [**get_employees**](PayrollNzApi.md#get_employees) | **GET** /Employees | Retrieves employees [**get_leave_type**](PayrollNzApi.md#get_leave_type) | **GET** /LeaveTypes/{LeaveTypeID} | Retrieves a specific leave type by using a unique leave type ID [**get_leave_types**](PayrollNzApi.md#get_leave_types) | **GET** /LeaveTypes | Retrieves leave types @@ -65,17 +69,16 @@ Method | HTTP request | Description [**get_tracking_categories**](PayrollNzApi.md#get_tracking_categories) | **GET** /Settings/TrackingCategories | Retrieves tracking categories [**revert_timesheet**](PayrollNzApi.md#revert_timesheet) | **POST** /Timesheets/{TimesheetID}/RevertToDraft | Reverts a timesheet to draft [**update_employee**](PayrollNzApi.md#update_employee) | **PUT** /Employees/{EmployeeID} | Updates an existing employee -[**update_employee_earnings_template**](PayrollNzApi.md#update_employee_earnings_template) | **PUT** /Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID} | Updates an earnings template records for an employee +[**update_employee_earnings_template**](PayrollNzApi.md#update_employee_earnings_template) | **PUT** /Employees/{EmployeeID}/PayTemplates/Earnings/{PayTemplateEarningID} | Updates an earnings template records for an employee [**update_employee_leave**](PayrollNzApi.md#update_employee_leave) | **PUT** /Employees/{EmployeeID}/Leave/{LeaveID} | Updates leave records for a specific employee [**update_employee_salary_and_wage**](PayrollNzApi.md#update_employee_salary_and_wage) | **PUT** /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID} | Updates an employee's salary and wages record [**update_employee_tax**](PayrollNzApi.md#update_employee_tax) | **POST** /Employees/{EmployeeID}/Tax | Updates the tax records for a specific employee -[**update_pay_run**](PayrollNzApi.md#update_pay_run) | **PUT** /PayRuns/{PayRunID} | Updates a pay run [**update_pay_slip_line_items**](PayrollNzApi.md#update_pay_slip_line_items) | **PUT** /PaySlips/{PaySlipID} | Creates an employee pay slip [**update_timesheet_line**](PayrollNzApi.md#update_timesheet_line) | **PUT** /Timesheets/{TimesheetID}/Lines/{TimesheetLineID} | Updates a timesheet line for a specific timesheet # **approve_timesheet** -> TimesheetObject approve_timesheet(xero_tenant_id, timesheet_id) +> TimesheetObject approve_timesheet(xero_tenant_id, timesheet_id, idempotency_key=idempotency_key) Approves a timesheet @@ -107,9 +110,10 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Approves a timesheet - api_response = api_instance.approve_timesheet(xero_tenant_id, timesheet_id) + api_response = api_instance.approve_timesheet(xero_tenant_id, timesheet_id, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollNzApi->approve_timesheet: %s\n" % e) @@ -121,6 +125,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **timesheet_id** | [**str**](.md)| Identifier for the timesheet | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -138,7 +143,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_deduction** -> DeductionObject create_deduction(xero_tenant_id, deduction) +> DeductionObject create_deduction(xero_tenant_id, deduction, idempotency_key=idempotency_key) Creates a new deduction for a specific employee @@ -169,10 +174,11 @@ api_client = ApiClient( api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -deduction = { "deductionName": "My new deduction", "deductionCategory": "NzOther", "liabilityAccountId": "568f2e9a-0870-46cc-8678-f83f132ed4e3" } # Deduction | +deduction = {"deductionName":"My new deduction","deductionCategory":"NzOther","liabilityAccountId":"568f2e9a-0870-46cc-8678-f83f132ed4e3"} # Deduction | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a new deduction for a specific employee - api_response = api_instance.create_deduction(xero_tenant_id, deduction) + api_response = api_instance.create_deduction(xero_tenant_id, deduction, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollNzApi->create_deduction: %s\n" % e) @@ -184,6 +190,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **deduction** | [**Deduction**](Deduction.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -201,7 +208,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_earnings_rate** -> EarningsRateObject create_earnings_rate(xero_tenant_id, earnings_rate) +> EarningsRateObject create_earnings_rate(xero_tenant_id, earnings_rate, idempotency_key=idempotency_key) Creates a new earnings rate @@ -232,10 +239,11 @@ api_client = ApiClient( api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -earnings_rate = { "name": "My Earnings Rate", "earningsType": "RegularEarnings", "rateType": "RatePerUnit", "typeOfUnits": "hours", "expenseAccountID": "e4eb36f6-97e3-4427-a394-dd4e1b355c2e" } # EarningsRate | +earnings_rate = {"name":"My Earnings Rate","earningsType":"RegularEarnings","rateType":"RatePerUnit","typeOfUnits":"hours","expenseAccountID":"e4eb36f6-97e3-4427-a394-dd4e1b355c2e"} # EarningsRate | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a new earnings rate - api_response = api_instance.create_earnings_rate(xero_tenant_id, earnings_rate) + api_response = api_instance.create_earnings_rate(xero_tenant_id, earnings_rate, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollNzApi->create_earnings_rate: %s\n" % e) @@ -247,6 +255,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **earnings_rate** | [**EarningsRate**](EarningsRate.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -264,7 +273,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_employee** -> EmployeeObject create_employee(xero_tenant_id, employee) +> EmployeeObject create_employee(xero_tenant_id, employee, idempotency_key=idempotency_key) Creates an employees @@ -295,10 +304,11 @@ api_client = ApiClient( api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -employee = { "title": "Mr", "firstName": "Mike", "lastName": "Johntzxzpxhmkgson", "dateOfBirth": "2000-01-01", "address": { "addressLine1": "101 Green St", "city": "San Francisco", "postCode": "4351", "countryName": "United Kingdom" }, "email": "83139@starkindustries.com", "gender": "M" } # Employee | +employee = {"title":"Mr","firstName":"Mike","lastName":"Johntzxzpxhmkgson","dateOfBirth":"2000-01-01","address":{"addressLine1":"101 Green St","city":"San Francisco","postCode":"4351","countryName":"United Kingdom"},"email":"83139@starkindustries.com","gender":"M"} # Employee | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates an employees - api_response = api_instance.create_employee(xero_tenant_id, employee) + api_response = api_instance.create_employee(xero_tenant_id, employee, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollNzApi->create_employee: %s\n" % e) @@ -310,6 +320,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **employee** | [**Employee**](Employee.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -327,7 +338,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_employee_earnings_template** -> EarningsTemplateObject create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template) +> EarningsTemplateObject create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template, idempotency_key=idempotency_key) Creates earnings template records for an employee @@ -359,10 +370,11 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object -earnings_template = { "ratePerUnit": 20, "numberOfUnits": 8, "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "name": "My New One" } # EarningsTemplate | +earnings_template = {"ratePerUnit":20,"numberOfUnits":8,"earningsRateID":"f9d8f5b5-9049-47f4-8541-35e200f750a5","name":"My New One"} # EarningsTemplate | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates earnings template records for an employee - api_response = api_instance.create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template) + api_response = api_instance.create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollNzApi->create_employee_earnings_template: %s\n" % e) @@ -375,6 +387,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **employee_id** | [**str**](.md)| Employee id for single object | **earnings_template** | [**EarningsTemplate**](EarningsTemplate.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -392,7 +405,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_employee_leave** -> EmployeeLeaveObject create_employee_leave(xero_tenant_id, employee_id, employee_leave) +> EmployeeLeaveObject create_employee_leave(xero_tenant_id, employee_id, employee_leave, idempotency_key=idempotency_key) Creates leave records for a specific employee @@ -424,10 +437,11 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object -employee_leave = { "leaveTypeID": "b0b1b79e-2a25-46c2-ad08-ca25ef48d7e4", "description": "Creating a Description", "startDate": "2020-04-24", "endDate": "2020-04-26" } # EmployeeLeave | +employee_leave = {"leaveTypeID":"b0b1b79e-2a25-46c2-ad08-ca25ef48d7e4","description":"Creating a Description","startDate":"2020-04-24","endDate":"2020-04-26"} # EmployeeLeave | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates leave records for a specific employee - api_response = api_instance.create_employee_leave(xero_tenant_id, employee_id, employee_leave) + api_response = api_instance.create_employee_leave(xero_tenant_id, employee_id, employee_leave, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollNzApi->create_employee_leave: %s\n" % e) @@ -440,6 +454,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **employee_id** | [**str**](.md)| Employee id for single object | **employee_leave** | [**EmployeeLeave**](EmployeeLeave.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -457,7 +472,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_employee_leave_setup** -> EmployeeLeaveSetupObject create_employee_leave_setup(xero_tenant_id, employee_id, employee_leave_setup) +> EmployeeLeaveSetupObject create_employee_leave_setup(xero_tenant_id, employee_id, employee_leave_setup, idempotency_key=idempotency_key) Creates a leave set-up for a specific employee. This is required before viewing, configuring and requesting leave for an employee @@ -489,10 +504,11 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object -employee_leave_setup = { "holidayPayOpeningBalance": 10, "annualLeaveOpeningBalance": 100, "sickLeaveHoursToAccrueAnnually": 20, "sickLeaveOpeningBalance": 10 } # EmployeeLeaveSetup | +employee_leave_setup = {"holidayPayOpeningBalance":10,"annualLeaveOpeningBalance":100,"sickLeaveToAccrueAnnually":20,"sickLeaveOpeningBalance":10,"sickLeaveScheduleOfAccrual":"OnAnniversaryDate","sickLeaveAnniversaryDate":"2023-12-31","annualLeaveAnniversaryDate":"2023-12-31"} # EmployeeLeaveSetup | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a leave set-up for a specific employee. This is required before viewing, configuring and requesting leave for an employee - api_response = api_instance.create_employee_leave_setup(xero_tenant_id, employee_id, employee_leave_setup) + api_response = api_instance.create_employee_leave_setup(xero_tenant_id, employee_id, employee_leave_setup, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollNzApi->create_employee_leave_setup: %s\n" % e) @@ -505,6 +521,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **employee_id** | [**str**](.md)| Employee id for single object | **employee_leave_setup** | [**EmployeeLeaveSetup**](EmployeeLeaveSetup.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -522,7 +539,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_employee_leave_type** -> EmployeeLeaveTypeObject create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type) +> EmployeeLeaveTypeObject create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type, idempotency_key=idempotency_key) Creates leave type records for a specific employee @@ -554,10 +571,11 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object -employee_leave_type = { "leaveTypeID": "35da97ae-05b9-427f-9a98-69157ba42cec", "scheduleOfAccrual": "AnnuallyAfter6Months", "hoursAccruedAnnually": 10, "maximumToAccrue": 80, "openingBalance": 100, "rateAccruedHourly": 3.5 } # EmployeeLeaveType | +employee_leave_type = {"leaveTypeID":"35da97ae-05b9-427f-9a98-69157ba42cec","scheduleOfAccrual":"AnnuallyAfter6Months","unitsAccruedAnnually":10,"typeOfUnitsToAccrue":"Hours","openingBalanceTypeOfUnits":"Hours","maximumToAccrue":80,"openingBalance":100,"rateAccruedHourly":null} # EmployeeLeaveType | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates leave type records for a specific employee - api_response = api_instance.create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type) + api_response = api_instance.create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollNzApi->create_employee_leave_type: %s\n" % e) @@ -570,6 +588,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **employee_id** | [**str**](.md)| Employee id for single object | **employee_leave_type** | [**EmployeeLeaveType**](EmployeeLeaveType.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -587,7 +606,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_employee_opening_balances** -> EmployeeOpeningBalancesObject create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balance) +> EmployeeOpeningBalancesObject create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balance, idempotency_key=idempotency_key) Creates opening balances for a specific employee @@ -620,9 +639,10 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object employee_opening_balance = [{"periodEndDate":"2020-10-01","daysPaid":3,"unpaidWeeks":2,"grossEarnings":40.0}] # list[EmployeeOpeningBalance] | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates opening balances for a specific employee - api_response = api_instance.create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balance) + api_response = api_instance.create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balance, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollNzApi->create_employee_opening_balances: %s\n" % e) @@ -635,6 +655,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **employee_id** | [**str**](.md)| Employee id for single object | **employee_opening_balance** | [**list[EmployeeOpeningBalance]**](EmployeeOpeningBalance.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -652,7 +673,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_employee_payment_method** -> PaymentMethodObject create_employee_payment_method(xero_tenant_id, employee_id, payment_method) +> PaymentMethodObject create_employee_payment_method(xero_tenant_id, employee_id, payment_method, idempotency_key=idempotency_key) Creates a payment method for an employee @@ -684,10 +705,11 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object -payment_method = xero_python.payrollnz.PaymentMethod() # PaymentMethod | +payment_method = {"bankAccounts":[{"accountName":"Casual Worker","accountNumber":"0607050201419000","sortCode":null,"particulars":null,"code":null,"dollarAmount":null,"reference":"","calculationType":"Balance"}]} # PaymentMethod | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a payment method for an employee - api_response = api_instance.create_employee_payment_method(xero_tenant_id, employee_id, payment_method) + api_response = api_instance.create_employee_payment_method(xero_tenant_id, employee_id, payment_method, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollNzApi->create_employee_payment_method: %s\n" % e) @@ -700,6 +722,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **employee_id** | [**str**](.md)| Employee id for single object | **payment_method** | [**PaymentMethod**](PaymentMethod.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -717,7 +740,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_employee_salary_and_wage** -> SalaryAndWageObject create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage) +> SalaryAndWageObject create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage, idempotency_key=idempotency_key) Creates an employee salary and wage record @@ -749,10 +772,11 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object -salary_and_wage = { "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "numberOfUnitsPerWeek": 2, "ratePerUnit": 10, "numberOfUnitsPerDay": 2, "daysPerWeek": 1, "effectiveFrom": "2020-05-01", "annualSalary": 100, "status": "Active", "paymentType": "Salary" } # SalaryAndWage | +salary_and_wage = {"earningsRateID":"f9d8f5b5-9049-47f4-8541-35e200f750a5","numberOfUnitsPerWeek":2,"ratePerUnit":10,"numberOfUnitsPerDay":2,"daysPerWeek":1,"effectiveFrom":"2020-05-01","annualSalary":100,"status":"Active","paymentType":"Salary"} # SalaryAndWage | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates an employee salary and wage record - api_response = api_instance.create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage) + api_response = api_instance.create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollNzApi->create_employee_salary_and_wage: %s\n" % e) @@ -765,6 +789,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **employee_id** | [**str**](.md)| Employee id for single object | **salary_and_wage** | [**SalaryAndWage**](SalaryAndWage.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -781,8 +806,75 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **create_employee_working_pattern** +> EmployeeWorkingPatternWithWorkingWeeksObject create_employee_working_pattern(xero_tenant_id, employee_id, employee_working_pattern_with_working_weeks_request, idempotency_key=idempotency_key) + +Creates an employee working pattern + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +employee_working_pattern_with_working_weeks_request = {"effectiveFrom":"2020-01-01T00:00:00","workingWeeks":[{"monday":0.0,"tuesday":3.0,"wednesday":0.0,"thursday":0.0,"friday":0.0,"saturday":0.0,"sunday":0.0}]} # EmployeeWorkingPatternWithWorkingWeeksRequest | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) +try: + # Creates an employee working pattern + api_response = api_instance.create_employee_working_pattern(xero_tenant_id, employee_id, employee_working_pattern_with_working_weeks_request, idempotency_key=idempotency_key) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->create_employee_working_pattern: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + **employee_working_pattern_with_working_weeks_request** | [**EmployeeWorkingPatternWithWorkingWeeksRequest**](EmployeeWorkingPatternWithWorkingWeeksRequest.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] + +### Return type + +[**EmployeeWorkingPatternWithWorkingWeeksObject**](EmployeeWorkingPatternWithWorkingWeeksObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **create_employment** -> EmploymentObject create_employment(xero_tenant_id, employee_id, employment) +> EmploymentObject create_employment(xero_tenant_id, employee_id, employment, idempotency_key=idempotency_key) Creates an employment detail for a specific employee @@ -814,10 +906,11 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object -employment = { "payrollCalendarID": "9aa56064-990f-4ad3-a189-d966d8f6a030", "startDate": "2020-09-02" } # Employment | +employment = {"payrollCalendarID":"9aa56064-990f-4ad3-a189-d966d8f6a030","startDate":"2020-09-02","engagementType":"FixedTerm","fixedTermEndDate":"2026-01-01"} # Employment | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates an employment detail for a specific employee - api_response = api_instance.create_employment(xero_tenant_id, employee_id, employment) + api_response = api_instance.create_employment(xero_tenant_id, employee_id, employment, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollNzApi->create_employment: %s\n" % e) @@ -830,6 +923,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **employee_id** | [**str**](.md)| Employee id for single object | **employment** | [**Employment**](Employment.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -847,7 +941,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_leave_type** -> LeaveTypeObject create_leave_type(xero_tenant_id, leave_type) +> LeaveTypeObject create_leave_type(xero_tenant_id, leave_type, idempotency_key=idempotency_key) Creates a new leave type @@ -878,10 +972,11 @@ api_client = ApiClient( api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -leave_type = { "name": "My wqwhhiktun Leave", "isPaidLeave": false, "showOnPayslip": true } # LeaveType | +leave_type = {"name":"My wqwhhiktun Leave","isPaidLeave":false,"showOnPayslip":true} # LeaveType | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a new leave type - api_response = api_instance.create_leave_type(xero_tenant_id, leave_type) + api_response = api_instance.create_leave_type(xero_tenant_id, leave_type, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollNzApi->create_leave_type: %s\n" % e) @@ -893,6 +988,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **leave_type** | [**LeaveType**](LeaveType.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -910,7 +1006,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_multiple_employee_earnings_template** -> EmployeeEarningsTemplates create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template) +> EmployeeEarningsTemplates create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template, idempotency_key=idempotency_key) Creates multiple employee earnings template records for a specific employee @@ -943,9 +1039,10 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object earnings_template = [{"ratePerUnit":20.0,"numberOfUnits":8.0,"earningsRateID":"f9d8f5b5-9049-47f4-8541-35e200f750a5"},{"ratePerUnit":0.0,"numberOfUnits":8.0,"earningsRateID":"65b83d94-f20f-45e1-85ae-387fcf460c26"}] # list[EarningsTemplate] | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates multiple employee earnings template records for a specific employee - api_response = api_instance.create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template) + api_response = api_instance.create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollNzApi->create_multiple_employee_earnings_template: %s\n" % e) @@ -958,6 +1055,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **employee_id** | [**str**](.md)| Employee id for single object | **earnings_template** | [**list[EarningsTemplate]**](EarningsTemplate.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -975,7 +1073,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_pay_run** -> PayRunObject create_pay_run(xero_tenant_id, pay_run) +> PayRunObject create_pay_run(xero_tenant_id, pay_run, idempotency_key=idempotency_key) Creates a pay run @@ -1006,10 +1104,11 @@ api_client = ApiClient( api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -pay_run = { "payrollCalendarID": "9aa56064-990f-4ad3-a189-d966d8f6a030", "periodStartDate": "2020-09-08", "periodEndDate": "2020-09-15", "paymentDate": "2020-09-20", "payRunStatus": "Draft", "payRunType": "Scheduled", "calendarType": "Weekly" } # PayRun | +pay_run = {"payrollCalendarID":"9aa56064-990f-4ad3-a189-d966d8f6a030","periodStartDate":"2020-09-08","periodEndDate":"2020-09-15","paymentDate":"2020-09-20","payRunStatus":"Draft","payRunType":"Scheduled","calendarType":"Weekly"} # PayRun | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a pay run - api_response = api_instance.create_pay_run(xero_tenant_id, pay_run) + api_response = api_instance.create_pay_run(xero_tenant_id, pay_run, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollNzApi->create_pay_run: %s\n" % e) @@ -1021,6 +1120,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **pay_run** | [**PayRun**](PayRun.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1038,7 +1138,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_pay_run_calendar** -> PayRunCalendarObject create_pay_run_calendar(xero_tenant_id, pay_run_calendar) +> PayRunCalendarObject create_pay_run_calendar(xero_tenant_id, pay_run_calendar, idempotency_key=idempotency_key) Creates a new payrun calendar @@ -1069,10 +1169,11 @@ api_client = ApiClient( api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -pay_run_calendar = { "name": "My Weekly Cal", "calendarType": "Weekly", "periodStartDate": "2020-05-01", "paymentDate": "2020-05-15" } # PayRunCalendar | +pay_run_calendar = {"name":"My Weekly Cal","calendarType":"Weekly","periodStartDate":"2020-05-01","paymentDate":"2020-05-15"} # PayRunCalendar | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a new payrun calendar - api_response = api_instance.create_pay_run_calendar(xero_tenant_id, pay_run_calendar) + api_response = api_instance.create_pay_run_calendar(xero_tenant_id, pay_run_calendar, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollNzApi->create_pay_run_calendar: %s\n" % e) @@ -1084,6 +1185,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **pay_run_calendar** | [**PayRunCalendar**](PayRunCalendar.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1101,7 +1203,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_reimbursement** -> ReimbursementObject create_reimbursement(xero_tenant_id, reimbursement) +> ReimbursementObject create_reimbursement(xero_tenant_id, reimbursement, idempotency_key=idempotency_key) Creates a new reimbursement @@ -1132,10 +1234,11 @@ api_client = ApiClient( api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -reimbursement = { "name": "My new Reimburse", "accountID": "fa5cdc43-643b-4ad8-b4ac-3ffe0d0f4488", "reimbursementCategory": "GSTInclusive", "calculationType": "FixedAmount" } # Reimbursement | +reimbursement = {"name":"My new Reimburse","accountID":"fa5cdc43-643b-4ad8-b4ac-3ffe0d0f4488","reimbursementCategory":"GSTInclusive","calculationType":"FixedAmount"} # Reimbursement | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a new reimbursement - api_response = api_instance.create_reimbursement(xero_tenant_id, reimbursement) + api_response = api_instance.create_reimbursement(xero_tenant_id, reimbursement, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollNzApi->create_reimbursement: %s\n" % e) @@ -1147,6 +1250,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **reimbursement** | [**Reimbursement**](Reimbursement.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1164,7 +1268,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_superannuation** -> SuperannuationObject create_superannuation(xero_tenant_id, benefit) +> SuperannuationObject create_superannuation(xero_tenant_id, benefit, idempotency_key=idempotency_key) Creates a new superannuation @@ -1195,10 +1299,11 @@ api_client = ApiClient( api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -benefit = { "name": "SidSaver", "category": "Other", "liabilityAccountId": "568f2e9a-0870-46cc-8678-f83f132ed4e3", "expenseAccountId": "e4eb36f6-97e3-4427-a394-dd4e1b355c2e", "CalculationTypeNZ": "FixedAmount", "standardAmount": 10 } # Benefit | +benefit = {"name":"SidSaver","category":"Other","liabilityAccountId":"568f2e9a-0870-46cc-8678-f83f132ed4e3","expenseAccountId":"e4eb36f6-97e3-4427-a394-dd4e1b355c2e","CalculationTypeNZ":"FixedAmount","standardAmount":10} # Benefit | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a new superannuation - api_response = api_instance.create_superannuation(xero_tenant_id, benefit) + api_response = api_instance.create_superannuation(xero_tenant_id, benefit, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollNzApi->create_superannuation: %s\n" % e) @@ -1210,6 +1315,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **benefit** | [**Benefit**](Benefit.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1227,7 +1333,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_timesheet** -> TimesheetObject create_timesheet(xero_tenant_id, timesheet) +> TimesheetObject create_timesheet(xero_tenant_id, timesheet, idempotency_key=idempotency_key) Creates a new timesheet @@ -1258,10 +1364,11 @@ api_client = ApiClient( api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -timesheet = { "payrollCalendarID": "9aa56064-990f-4ad3-a189-d966d8f6a030", "employeeID": "68342973-c405-4b86-b5d3-d7b877c27995", "startDate": "2020-04-13", "endDate": "2020-04-19", "timesheetLines": [ { "date": "2020-04-13", "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "numberOfUnits": 8 }, { "date": "2020-04-15", "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "numberOfUnits": 6 } ] } # Timesheet | +timesheet = {"payrollCalendarID":"9aa56064-990f-4ad3-a189-d966d8f6a030","employeeID":"68342973-c405-4b86-b5d3-d7b877c27995","startDate":"2020-04-13","endDate":"2020-04-19","timesheetLines":[{"date":"2020-04-13","earningsRateID":"f9d8f5b5-9049-47f4-8541-35e200f750a5","numberOfUnits":8},{"date":"2020-04-15","earningsRateID":"f9d8f5b5-9049-47f4-8541-35e200f750a5","numberOfUnits":6}]} # Timesheet | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a new timesheet - api_response = api_instance.create_timesheet(xero_tenant_id, timesheet) + api_response = api_instance.create_timesheet(xero_tenant_id, timesheet, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollNzApi->create_timesheet: %s\n" % e) @@ -1273,6 +1380,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **timesheet** | [**Timesheet**](Timesheet.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1290,7 +1398,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_timesheet_line** -> TimesheetLineObject create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line) +> TimesheetLineObject create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line, idempotency_key=idempotency_key) Create a new timesheet line for a specific time sheet @@ -1322,10 +1430,11 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet -timesheet_line = { "date": "2020-08-03", "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "numberOfUnits": 1 } # TimesheetLine | +timesheet_line = {"date":"2020-08-03","earningsRateID":"f9d8f5b5-9049-47f4-8541-35e200f750a5","numberOfUnits":1} # TimesheetLine | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Create a new timesheet line for a specific time sheet - api_response = api_instance.create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line) + api_response = api_instance.create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollNzApi->create_timesheet_line: %s\n" % e) @@ -1338,6 +1447,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **timesheet_id** | [**str**](.md)| Identifier for the timesheet | **timesheet_line** | [**TimesheetLine**](TimesheetLine.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1549,6 +1659,71 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **delete_employee_working_pattern** +> EmployeeLeaveObject delete_employee_working_pattern(xero_tenant_id, employee_id, employee_working_pattern_id) + +deletes employee's working patterns + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +employee_working_pattern_id = '4ff1e5cc-9835-40d5-bb18-09f3b118db9c' # str | Employee working pattern id for single object +try: + # deletes employee's working patterns + api_response = api_instance.delete_employee_working_pattern(xero_tenant_id, employee_id, employee_working_pattern_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->delete_employee_working_pattern: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + **employee_working_pattern_id** | [**str**](.md)| Employee working pattern id for single object | + +### Return type + +[**EmployeeLeaveObject**](EmployeeLeaveObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **delete_timesheet** > TimesheetLine delete_timesheet(xero_tenant_id, timesheet_id) @@ -2630,6 +2805,134 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_employee_working_pattern** +> EmployeeWorkingPatternWithWorkingWeeksObject get_employee_working_pattern(xero_tenant_id, employee_id, employee_working_pattern_id) + +Retrieves employee's working patterns + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +employee_working_pattern_id = '4ff1e5cc-9835-40d5-bb18-09f3b118db9c' # str | Employee working pattern id for single object +try: + # Retrieves employee's working patterns + api_response = api_instance.get_employee_working_pattern(xero_tenant_id, employee_id, employee_working_pattern_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_employee_working_pattern: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + **employee_working_pattern_id** | [**str**](.md)| Employee working pattern id for single object | + +### Return type + +[**EmployeeWorkingPatternWithWorkingWeeksObject**](EmployeeWorkingPatternWithWorkingWeeksObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_employee_working_patterns** +> EmployeeWorkingPatternsObject get_employee_working_patterns(xero_tenant_id, employee_id) + +Retrieves employee's working patterns + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +try: + # Retrieves employee's working patterns + api_response = api_instance.get_employee_working_patterns(xero_tenant_id, employee_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_employee_working_patterns: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + +### Return type + +[**EmployeeWorkingPatternsObject**](EmployeeWorkingPatternsObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **get_employees** > Employees get_employees(xero_tenant_id, filter=filter, page=page) @@ -2791,7 +3094,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) -active_only = True # bool | Filters leave types by active status. By default the API returns all leave types. (optional) +active_only = true # bool | Filters leave types by active status. By default the API returns all leave types. (optional) try: # Retrieves leave types api_response = api_instance.get_leave_types(xero_tenant_id, page=page, active_only=active_only) @@ -3842,7 +4145,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **revert_timesheet** -> TimesheetObject revert_timesheet(xero_tenant_id, timesheet_id) +> TimesheetObject revert_timesheet(xero_tenant_id, timesheet_id, idempotency_key=idempotency_key) Reverts a timesheet to draft @@ -3874,9 +4177,10 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Reverts a timesheet to draft - api_response = api_instance.revert_timesheet(xero_tenant_id, timesheet_id) + api_response = api_instance.revert_timesheet(xero_tenant_id, timesheet_id, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollNzApi->revert_timesheet: %s\n" % e) @@ -3888,6 +4192,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **timesheet_id** | [**str**](.md)| Identifier for the timesheet | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3905,7 +4210,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_employee** -> EmployeeObject update_employee(xero_tenant_id, employee_id, employee) +> EmployeeObject update_employee(xero_tenant_id, employee_id, employee, idempotency_key=idempotency_key) Updates an existing employee @@ -3937,10 +4242,11 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object -employee = { "title": "Mr", "firstName": "Tony", "lastName": "Starkgtrzgquusrson", "dateOfBirth": "1999-01-01", "address": { "addressLine1": "101 Green St", "city": "San Francisco", "postCode": "4432", "countryName": "United Kingdom" }, "email": "58315@starkindustries.com", "gender": "M" } # Employee | +employee = {"title":"Mr","firstName":"Tony","lastName":"Starkgtrzgquusrson","dateOfBirth":"1999-01-01","address":{"addressLine1":"101 Green St","city":"San Francisco","postCode":"4432","countryName":"United Kingdom"},"email":"58315@starkindustries.com","gender":"M"} # Employee | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates an existing employee - api_response = api_instance.update_employee(xero_tenant_id, employee_id, employee) + api_response = api_instance.update_employee(xero_tenant_id, employee_id, employee, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollNzApi->update_employee: %s\n" % e) @@ -3953,6 +4259,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **employee_id** | [**str**](.md)| Employee id for single object | **employee** | [**Employee**](Employee.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3970,7 +4277,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_employee_earnings_template** -> EarningsTemplateObject update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template) +> EarningsTemplateObject update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template, idempotency_key=idempotency_key) Updates an earnings template records for an employee @@ -4003,10 +4310,11 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object pay_template_earning_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6' # str | Id for single pay template earnings object -earnings_template = { "ratePerUnit": 25, "numberOfUnits": 4, "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5" } # EarningsTemplate | +earnings_template = {"ratePerUnit":25,"numberOfUnits":4,"earningsRateID":"f9d8f5b5-9049-47f4-8541-35e200f750a5"} # EarningsTemplate | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates an earnings template records for an employee - api_response = api_instance.update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template) + api_response = api_instance.update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollNzApi->update_employee_earnings_template: %s\n" % e) @@ -4020,6 +4328,7 @@ Name | Type | Description | Notes **employee_id** | [**str**](.md)| Employee id for single object | **pay_template_earning_id** | [**str**](.md)| Id for single pay template earnings object | **earnings_template** | [**EarningsTemplate**](EarningsTemplate.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4037,7 +4346,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_employee_leave** -> EmployeeLeaveObject update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave) +> EmployeeLeaveObject update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave, idempotency_key=idempotency_key) Updates leave records for a specific employee @@ -4070,10 +4379,11 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object leave_id = 'c4be24e5-e840-4c92-9eaa-2d86cd596314' # str | Leave id for single object -employee_leave = { "leaveTypeID": "b0b1b79e-2a25-46c2-ad08-ca25ef48d7e4", "description": "Creating a Description", "startDate": "2020-04-24", "endDate": "2020-04-26", "periods": [ { "periodStartDate": "2020-04-20", "periodEndDate": "2020-04-26", "numberOfUnits": 1, "periodStatus": "Approved" } ] } # EmployeeLeave | +employee_leave = {"leaveTypeID":"b0b1b79e-2a25-46c2-ad08-ca25ef48d7e4","description":"Creating a Description","startDate":"2020-04-24","endDate":"2020-04-26","periods":[{"periodStartDate":"2020-04-20","periodEndDate":"2020-04-26","numberOfUnits":1,"periodStatus":"Approved"}]} # EmployeeLeave | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates leave records for a specific employee - api_response = api_instance.update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave) + api_response = api_instance.update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollNzApi->update_employee_leave: %s\n" % e) @@ -4087,6 +4397,7 @@ Name | Type | Description | Notes **employee_id** | [**str**](.md)| Employee id for single object | **leave_id** | [**str**](.md)| Leave id for single object | **employee_leave** | [**EmployeeLeave**](EmployeeLeave.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4104,7 +4415,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_employee_salary_and_wage** -> SalaryAndWageObject update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage) +> SalaryAndWageObject update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage, idempotency_key=idempotency_key) Updates an employee's salary and wages record @@ -4137,10 +4448,11 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object salary_and_wages_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6' # str | Id for single pay template earnings object -salary_and_wage = { "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "numberOfUnitsPerWeek": 3, "ratePerUnit": 11, "numberOfUnitsPerDay": 3, "daysPerWeek": 1, "effectiveFrom": "2020-05-15", "annualSalary": 101, "status": "Active", "paymentType": "Salary" } # SalaryAndWage | +salary_and_wage = {"earningsRateID":"f9d8f5b5-9049-47f4-8541-35e200f750a5","numberOfUnitsPerWeek":3,"ratePerUnit":11,"numberOfUnitsPerDay":3,"daysPerWeek":1,"effectiveFrom":"2020-05-15","annualSalary":101,"status":"Active","paymentType":"Salary"} # SalaryAndWage | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates an employee's salary and wages record - api_response = api_instance.update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage) + api_response = api_instance.update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollNzApi->update_employee_salary_and_wage: %s\n" % e) @@ -4154,6 +4466,7 @@ Name | Type | Description | Notes **employee_id** | [**str**](.md)| Employee id for single object | **salary_and_wages_id** | [**str**](.md)| Id for single pay template earnings object | **salary_and_wage** | [**SalaryAndWage**](SalaryAndWage.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4171,7 +4484,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_employee_tax** -> EmployeeTaxObject update_employee_tax(xero_tenant_id, employee_id, employee_tax) +> EmployeeTaxObject update_employee_tax(xero_tenant_id, employee_id, employee_tax, idempotency_key=idempotency_key) Updates the tax records for a specific employee @@ -4203,10 +4516,11 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object -employee_tax = xero_python.payrollnz.EmployeeTax() # EmployeeTax | +employee_tax = {"irdNumber":"111111111","taxCode":"M","esctRatePercentage":17.5,"isEligibleForKiwiSaver":true,"hasSpecialStudentLoanRate":false,"specialStudentLoanRatePercentage":null,"specialTaxRatePercentage":null,"kiwiSaverContributions":"MakeContributions","kiwiSaverOptOutDate":null,"kiwiSaverContributionHolidayEndDate":null,"kiwiSaverEmployeeContributionRatePercentage":3,"kiwiSaverEmployerContributionRatePercentage":3,"kiwiSaverEmployerSalarySacrificeContributionRatePercentage":0,"hasStudentLoanBalance":false,"studentLoanBalance":null,"studentLoanAsAt":null} # EmployeeTax | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates the tax records for a specific employee - api_response = api_instance.update_employee_tax(xero_tenant_id, employee_id, employee_tax) + api_response = api_instance.update_employee_tax(xero_tenant_id, employee_id, employee_tax, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollNzApi->update_employee_tax: %s\n" % e) @@ -4219,6 +4533,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **employee_id** | [**str**](.md)| Employee id for single object | **employee_tax** | [**EmployeeTax**](EmployeeTax.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4235,73 +4550,8 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **update_pay_run** -> PayRunObject update_pay_run(xero_tenant_id, pay_run_id, pay_run) - -Updates a pay run - -### Example - -* OAuth Authentication (OAuth2): -```python -from xero_python.api_client import Configuration, ApiClient -from xero_python.api_client.oauth2 import OAuth2Token -from xero_python.exceptions import ApiException -from xero_python.payrollnz import PayrollNzApi -from pprint import pprint - -# Configure OAuth2 access token for authorization: OAuth2 -# simplified version, `xero_oauth2_token` represents permanent global token storage -xero_oauth2_token = {} # set to valid xero oauth2 token dictionary -# create client configuration with client id and client secret for automatic token refresh -api_config = Configuration(oauth2_token=OAuth2Token( - client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" -)) -# configure xero-python sdk client -api_client = ApiClient( - api_config, - oauth2_token_saver=lambda x: xero_oauth2_token.update(x), - oauth2_token_getter=lambda : xero_oauth2_token -) -# create an instance of the API class -api_instance = PayrollNzApi(api_client) - -xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -pay_run_id = 'pay_run_id_example' # str | Identifier for the pay run -pay_run = { "paymentDate": "2019-07-01" } # PayRun | -try: - # Updates a pay run - api_response = api_instance.update_pay_run(xero_tenant_id, pay_run_id, pay_run) - pprint(api_response) -except ApiException as e: - print("Exception when calling PayrollNzApi->update_pay_run: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **xero_tenant_id** | **str**| Xero identifier for Tenant | - **pay_run_id** | [**str**](.md)| Identifier for the pay run | - **pay_run** | [**PayRun**](PayRun.md)| | - -### Return type - -[**PayRunObject**](PayRunObject.md) - -### Authorization - -[OAuth2](../README.md#OAuth2) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - # **update_pay_slip_line_items** -> PaySlipObject update_pay_slip_line_items(xero_tenant_id, pay_slip_id, pay_slip) +> PaySlipObject update_pay_slip_line_items(xero_tenant_id, pay_slip_id, pay_slip, idempotency_key=idempotency_key) Creates an employee pay slip @@ -4333,10 +4583,11 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant pay_slip_id = 'pay_slip_id_example' # str | Identifier for the payslip -pay_slip = { "earningsLines": [ { "earningsLineID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "displayName": "Ordinary Time", "ratePerUnit": 25, "numberOfUnits": 0, "amount": 0, "isLinkedToTimesheet": false, "isSystemGenerated": true }, { "earningsLineID": "65b83d94-f20f-45e1-85ae-387fcf460c26", "earningsRateID": "65b83d94-f20f-45e1-85ae-387fcf460c26", "displayName": "Salary", "ratePerUnit": 0, "numberOfUnits": 8, "amount": 0, "isLinkedToTimesheet": false, "isSystemGenerated": false } ], "leaveEarningsLines": [ { "earningsLineID": "0441497f-5dc7-4cd3-a90d-f2e07e21b2a6", "earningsRateID": "39b3560a-5d2f-4538-924a-4349dc86396e", "displayName": "Holiday Pay", "fixedAmount": 268.8, "amount": 268.8, "isLinkedToTimesheet": false, "isSystemGenerated": true } ], "deductionLines": [ { "deductionTypeID": "a3760fe4-68a4-4e38-8326-fe616af7dc74", "amount": 100 } ], "leaveAccrualLines": [ { "leaveTypeID": "0441497f-5dc7-4cd3-a90d-f2e07e21b2a6", "numberOfUnits": 268.8 }, { "leaveTypeID": "b0b1b79e-2a25-46c2-ad08-ca25ef48d7e4", "numberOfUnits": 0 }, { "leaveTypeID": "f2f994cf-1899-46f3-ad4f-5d92d78c3719", "numberOfUnits": 0 }, { "leaveTypeID": "34129765-11cb-4d8c-b568-84a2219beda3", "numberOfUnits": 0 } ], "superannuationLines": [ { "superannuationTypeID": "563273ea-0dae-4f82-86a4-e0db77c008ea", "displayName": "KiwiSaver", "amount": 108.86, "fixedAmount": 3, "percentage": 3, "manualAdjustment": false } ], "employeeTaxLines": [ { "taxLineID": "1084146b-e890-489c-aed3-06de80f63d84", "amount": 1057.22, "globalTaxTypeID": "11", "manualAdjustment": false } ], "employerTaxLines": [ { "taxLineID": "6f9eb8cd-0f4a-440b-939c-bdb0f6ad694c", "amount": 18.9, "globalTaxTypeID": "10", "manualAdjustment": false } ], "statutoryDeductionLines": [ { "statutoryDeductionTypeID": "b5efd8d1-0c93-4a14-a314-b5cba4a4e6b3", "amount": 108.86 } ], "grossEarningsHistory": { "daysPaid": 3, "unpaidWeeks": 0 } } # PaySlip | +pay_slip = {"earningsLines":[{"earningsLineID":"f9d8f5b5-9049-47f4-8541-35e200f750a5","earningsRateID":"f9d8f5b5-9049-47f4-8541-35e200f750a5","displayName":"Ordinary Time","ratePerUnit":25,"numberOfUnits":0,"amount":0,"isLinkedToTimesheet":false,"isSystemGenerated":true},{"earningsLineID":"65b83d94-f20f-45e1-85ae-387fcf460c26","earningsRateID":"65b83d94-f20f-45e1-85ae-387fcf460c26","displayName":"Salary","ratePerUnit":0,"numberOfUnits":8,"amount":0,"isLinkedToTimesheet":false,"isSystemGenerated":false}],"leaveEarningsLines":[{"earningsLineID":"0441497f-5dc7-4cd3-a90d-f2e07e21b2a6","earningsRateID":"39b3560a-5d2f-4538-924a-4349dc86396e","displayName":"Holiday Pay","fixedAmount":268.8,"amount":268.8,"isLinkedToTimesheet":false,"isSystemGenerated":true}],"deductionLines":[{"deductionTypeID":"a3760fe4-68a4-4e38-8326-fe616af7dc74","amount":100}],"leaveAccrualLines":[{"leaveTypeID":"0441497f-5dc7-4cd3-a90d-f2e07e21b2a6","numberOfUnits":268.8},{"leaveTypeID":"b0b1b79e-2a25-46c2-ad08-ca25ef48d7e4","numberOfUnits":0},{"leaveTypeID":"f2f994cf-1899-46f3-ad4f-5d92d78c3719","numberOfUnits":0},{"leaveTypeID":"34129765-11cb-4d8c-b568-84a2219beda3","numberOfUnits":0}],"superannuationLines":[{"superannuationTypeID":"563273ea-0dae-4f82-86a4-e0db77c008ea","displayName":"KiwiSaver","amount":108.86,"fixedAmount":3,"percentage":3,"manualAdjustment":false}],"employeeTaxLines":[{"taxLineID":"1084146b-e890-489c-aed3-06de80f63d84","amount":1057.22,"globalTaxTypeID":"11","manualAdjustment":false}],"employerTaxLines":[{"taxLineID":"6f9eb8cd-0f4a-440b-939c-bdb0f6ad694c","amount":18.9,"globalTaxTypeID":"10","manualAdjustment":false}],"statutoryDeductionLines":[{"statutoryDeductionTypeID":"b5efd8d1-0c93-4a14-a314-b5cba4a4e6b3","amount":108.86}],"grossEarningsHistory":{"daysPaid":3,"unpaidWeeks":0}} # PaySlip | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates an employee pay slip - api_response = api_instance.update_pay_slip_line_items(xero_tenant_id, pay_slip_id, pay_slip) + api_response = api_instance.update_pay_slip_line_items(xero_tenant_id, pay_slip_id, pay_slip, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollNzApi->update_pay_slip_line_items: %s\n" % e) @@ -4349,6 +4600,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **pay_slip_id** | [**str**](.md)| Identifier for the payslip | **pay_slip** | [**PaySlip**](PaySlip.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4366,7 +4618,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_timesheet_line** -> TimesheetLineObject update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line) +> TimesheetLineObject update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, idempotency_key=idempotency_key) Updates a timesheet line for a specific timesheet @@ -4399,10 +4651,11 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet timesheet_line_id = 'timesheet_line_id_example' # str | Identifier for the timesheet line -timesheet_line = { "date": "2020-08-04", "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "numberOfUnits": 2 } # TimesheetLine | +timesheet_line = {"date":"2020-08-04","earningsRateID":"f9d8f5b5-9049-47f4-8541-35e200f750a5","numberOfUnits":2} # TimesheetLine | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a timesheet line for a specific timesheet - api_response = api_instance.update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line) + api_response = api_instance.update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollNzApi->update_timesheet_line: %s\n" % e) @@ -4416,6 +4669,7 @@ Name | Type | Description | Notes **timesheet_id** | [**str**](.md)| Identifier for the timesheet | **timesheet_line_id** | [**str**](.md)| Identifier for the timesheet line | **timesheet_line** | [**TimesheetLine**](TimesheetLine.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type diff --git a/xero_python/payrollnz/docs/SalaryAndWage.md b/xero_python/payrollnz/docs/SalaryAndWage.md index fa4cd16a..65ab101c 100644 --- a/xero_python/payrollnz/docs/SalaryAndWage.md +++ b/xero_python/payrollnz/docs/SalaryAndWage.md @@ -13,6 +13,7 @@ Name | Type | Description | Notes **annual_salary** | **float** | The annual salary | **status** | **str** | The current status of the corresponding salary and wages | **payment_type** | **str** | The type of the payment of the corresponding salary and wages | +**work_pattern_type** | **str** | The type of the Working Pattern of the corresponding salary and wages | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrollnz/docs/WorkingWeek.md b/xero_python/payrollnz/docs/WorkingWeek.md new file mode 100644 index 00000000..58ad2b2a --- /dev/null +++ b/xero_python/payrollnz/docs/WorkingWeek.md @@ -0,0 +1,16 @@ +# WorkingWeek + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**monday** | **float** | The number of hours worked on a Monday | +**tuesday** | **float** | The number of hours worked on a Tuesday | +**wednesday** | **float** | The number of hours worked on a Wednesday | +**thursday** | **float** | The number of hours worked on a Thursday | +**friday** | **float** | The number of hours worked on a Friday | +**saturday** | **float** | The number of hours worked on a Saturday | +**sunday** | **float** | The number of hours worked on a Sunday | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollnz/models/__init__.py b/xero_python/payrollnz/models/__init__.py index dc995d81..8cfdfde3 100644 --- a/xero_python/payrollnz/models/__init__.py +++ b/xero_python/payrollnz/models/__init__.py @@ -2,12 +2,12 @@ # flake8: noqa """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -82,6 +82,19 @@ ) from xero_python.payrollnz.models.employee_tax import EmployeeTax from xero_python.payrollnz.models.employee_tax_object import EmployeeTaxObject +from xero_python.payrollnz.models.employee_working_pattern import EmployeeWorkingPattern +from xero_python.payrollnz.models.employee_working_pattern_with_working_weeks import ( + EmployeeWorkingPatternWithWorkingWeeks, +) +from xero_python.payrollnz.models.employee_working_pattern_with_working_weeks_object import ( + EmployeeWorkingPatternWithWorkingWeeksObject, +) +from xero_python.payrollnz.models.employee_working_pattern_with_working_weeks_request import ( + EmployeeWorkingPatternWithWorkingWeeksRequest, +) +from xero_python.payrollnz.models.employee_working_patterns_object import ( + EmployeeWorkingPatternsObject, +) from xero_python.payrollnz.models.employees import Employees from xero_python.payrollnz.models.employment import Employment from xero_python.payrollnz.models.employment_object import EmploymentObject @@ -139,3 +152,4 @@ from xero_python.payrollnz.models.timesheets import Timesheets from xero_python.payrollnz.models.tracking_categories import TrackingCategories from xero_python.payrollnz.models.tracking_category import TrackingCategory +from xero_python.payrollnz.models.working_week import WorkingWeek diff --git a/xero_python/payrollnz/models/account.py b/xero_python/payrollnz/models/account.py index 52c83c46..35172e82 100644 --- a/xero_python/payrollnz/models/account.py +++ b/xero_python/payrollnz/models/account.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/accounts.py b/xero_python/payrollnz/models/accounts.py index 29f3577a..49eec8ef 100644 --- a/xero_python/payrollnz/models/accounts.py +++ b/xero_python/payrollnz/models/accounts.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/address.py b/xero_python/payrollnz/models/address.py index 6a83b184..4e6f253e 100644 --- a/xero_python/payrollnz/models/address.py +++ b/xero_python/payrollnz/models/address.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/bank_account.py b/xero_python/payrollnz/models/bank_account.py index 0db7d4ec..74a0e8ea 100644 --- a/xero_python/payrollnz/models/bank_account.py +++ b/xero_python/payrollnz/models/bank_account.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/benefit.py b/xero_python/payrollnz/models/benefit.py index a48793a8..a0d0b595 100644 --- a/xero_python/payrollnz/models/benefit.py +++ b/xero_python/payrollnz/models/benefit.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/calendar_type.py b/xero_python/payrollnz/models/calendar_type.py index ec67f5b1..b4ee6a20 100644 --- a/xero_python/payrollnz/models/calendar_type.py +++ b/xero_python/payrollnz/models/calendar_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/deduction.py b/xero_python/payrollnz/models/deduction.py index 6cf1c98c..4ff058c3 100644 --- a/xero_python/payrollnz/models/deduction.py +++ b/xero_python/payrollnz/models/deduction.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/deduction_line.py b/xero_python/payrollnz/models/deduction_line.py index c33952f4..5f8238bd 100644 --- a/xero_python/payrollnz/models/deduction_line.py +++ b/xero_python/payrollnz/models/deduction_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/deduction_object.py b/xero_python/payrollnz/models/deduction_object.py index 6f5fa475..7d87eebb 100644 --- a/xero_python/payrollnz/models/deduction_object.py +++ b/xero_python/payrollnz/models/deduction_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/deductions.py b/xero_python/payrollnz/models/deductions.py index 60ae6b03..68032c73 100644 --- a/xero_python/payrollnz/models/deductions.py +++ b/xero_python/payrollnz/models/deductions.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/earnings_line.py b/xero_python/payrollnz/models/earnings_line.py index 016bdb21..6d85a169 100644 --- a/xero_python/payrollnz/models/earnings_line.py +++ b/xero_python/payrollnz/models/earnings_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/earnings_order.py b/xero_python/payrollnz/models/earnings_order.py index 2d5318a2..12f1dd98 100644 --- a/xero_python/payrollnz/models/earnings_order.py +++ b/xero_python/payrollnz/models/earnings_order.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/earnings_order_object.py b/xero_python/payrollnz/models/earnings_order_object.py index 52977b06..a997cbfe 100644 --- a/xero_python/payrollnz/models/earnings_order_object.py +++ b/xero_python/payrollnz/models/earnings_order_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/earnings_orders.py b/xero_python/payrollnz/models/earnings_orders.py index 162bb272..72be9c6f 100644 --- a/xero_python/payrollnz/models/earnings_orders.py +++ b/xero_python/payrollnz/models/earnings_orders.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/earnings_rate.py b/xero_python/payrollnz/models/earnings_rate.py index df6dc811..70e9c98f 100644 --- a/xero_python/payrollnz/models/earnings_rate.py +++ b/xero_python/payrollnz/models/earnings_rate.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/earnings_rate_object.py b/xero_python/payrollnz/models/earnings_rate_object.py index 6b9dfa1d..9014235f 100644 --- a/xero_python/payrollnz/models/earnings_rate_object.py +++ b/xero_python/payrollnz/models/earnings_rate_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/earnings_rates.py b/xero_python/payrollnz/models/earnings_rates.py index 34066eea..23f2d90a 100644 --- a/xero_python/payrollnz/models/earnings_rates.py +++ b/xero_python/payrollnz/models/earnings_rates.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/earnings_template.py b/xero_python/payrollnz/models/earnings_template.py index 91002160..c5340b05 100644 --- a/xero_python/payrollnz/models/earnings_template.py +++ b/xero_python/payrollnz/models/earnings_template.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/earnings_template_object.py b/xero_python/payrollnz/models/earnings_template_object.py index 6fd43c54..85b68eb9 100644 --- a/xero_python/payrollnz/models/earnings_template_object.py +++ b/xero_python/payrollnz/models/earnings_template_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/employee.py b/xero_python/payrollnz/models/employee.py index ce9cf9c0..aefac4e3 100644 --- a/xero_python/payrollnz/models/employee.py +++ b/xero_python/payrollnz/models/employee.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -44,6 +44,9 @@ class Employee(BaseModel): "payroll_calendar_id": "str", "updated_date_utc": "datetime", "created_date_utc": "datetime", + "job_title": "str", + "engagement_type": "str", + "fixed_term_end_date": "date", } attribute_map = { @@ -61,6 +64,9 @@ class Employee(BaseModel): "payroll_calendar_id": "payrollCalendarID", "updated_date_utc": "updatedDateUTC", "created_date_utc": "createdDateUTC", + "job_title": "jobTitle", + "engagement_type": "engagementType", + "fixed_term_end_date": "fixedTermEndDate", } def __init__( @@ -79,6 +85,9 @@ def __init__( payroll_calendar_id=None, updated_date_utc=None, created_date_utc=None, + job_title=None, + engagement_type=None, + fixed_term_end_date=None, ): # noqa: E501 """Employee - a model defined in OpenAPI""" # noqa: E501 @@ -96,20 +105,19 @@ def __init__( self._payroll_calendar_id = None self._updated_date_utc = None self._created_date_utc = None + self._job_title = None + self._engagement_type = None + self._fixed_term_end_date = None self.discriminator = None if employee_id is not None: self.employee_id = employee_id if title is not None: self.title = title - if first_name is not None: - self.first_name = first_name - if last_name is not None: - self.last_name = last_name - if date_of_birth is not None: - self.date_of_birth = date_of_birth - if address is not None: - self.address = address + self.first_name = first_name + self.last_name = last_name + self.date_of_birth = date_of_birth + self.address = address if email is not None: self.email = email if gender is not None: @@ -126,6 +134,12 @@ def __init__( self.updated_date_utc = updated_date_utc if created_date_utc is not None: self.created_date_utc = created_date_utc + if job_title is not None: + self.job_title = job_title + if engagement_type is not None: + self.engagement_type = engagement_type + if fixed_term_end_date is not None: + self.fixed_term_end_date = fixed_term_end_date @property def employee_id(self): @@ -193,6 +207,10 @@ def first_name(self, first_name): :param first_name: The first_name of this Employee. # noqa: E501 :type: str """ + if first_name is None: + raise ValueError( + "Invalid value for `first_name`, must not be `None`" + ) # noqa: E501 self._first_name = first_name @@ -216,6 +234,10 @@ def last_name(self, last_name): :param last_name: The last_name of this Employee. # noqa: E501 :type: str """ + if last_name is None: + raise ValueError( + "Invalid value for `last_name`, must not be `None`" + ) # noqa: E501 self._last_name = last_name @@ -239,6 +261,10 @@ def date_of_birth(self, date_of_birth): :param date_of_birth: The date_of_birth of this Employee. # noqa: E501 :type: date """ + if date_of_birth is None: + raise ValueError( + "Invalid value for `date_of_birth`, must not be `None`" + ) # noqa: E501 self._date_of_birth = date_of_birth @@ -260,6 +286,10 @@ def address(self, address): :param address: The address of this Employee. # noqa: E501 :type: Address """ + if address is None: + raise ValueError( + "Invalid value for `address`, must not be `None`" + ) # noqa: E501 self._address = address @@ -455,3 +485,72 @@ def created_date_utc(self, created_date_utc): """ self._created_date_utc = created_date_utc + + @property + def job_title(self): + """Gets the job_title of this Employee. # noqa: E501 + + Employee's job title # noqa: E501 + + :return: The job_title of this Employee. # noqa: E501 + :rtype: str + """ + return self._job_title + + @job_title.setter + def job_title(self, job_title): + """Sets the job_title of this Employee. + + Employee's job title # noqa: E501 + + :param job_title: The job_title of this Employee. # noqa: E501 + :type: str + """ + + self._job_title = job_title + + @property + def engagement_type(self): + """Gets the engagement_type of this Employee. # noqa: E501 + + Engagement type of the employee # noqa: E501 + + :return: The engagement_type of this Employee. # noqa: E501 + :rtype: str + """ + return self._engagement_type + + @engagement_type.setter + def engagement_type(self, engagement_type): + """Sets the engagement_type of this Employee. + + Engagement type of the employee # noqa: E501 + + :param engagement_type: The engagement_type of this Employee. # noqa: E501 + :type: str + """ + + self._engagement_type = engagement_type + + @property + def fixed_term_end_date(self): + """Gets the fixed_term_end_date of this Employee. # noqa: E501 + + End date for an employee with a fixed-term engagement type # noqa: E501 + + :return: The fixed_term_end_date of this Employee. # noqa: E501 + :rtype: date + """ + return self._fixed_term_end_date + + @fixed_term_end_date.setter + def fixed_term_end_date(self, fixed_term_end_date): + """Sets the fixed_term_end_date of this Employee. + + End date for an employee with a fixed-term engagement type # noqa: E501 + + :param fixed_term_end_date: The fixed_term_end_date of this Employee. # noqa: E501 + :type: date + """ + + self._fixed_term_end_date = fixed_term_end_date diff --git a/xero_python/payrollnz/models/employee_earnings_templates.py b/xero_python/payrollnz/models/employee_earnings_templates.py index 708c2a88..64f14ad0 100644 --- a/xero_python/payrollnz/models/employee_earnings_templates.py +++ b/xero_python/payrollnz/models/employee_earnings_templates.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/employee_leave.py b/xero_python/payrollnz/models/employee_leave.py index 9f4352ad..91cb40f1 100644 --- a/xero_python/payrollnz/models/employee_leave.py +++ b/xero_python/payrollnz/models/employee_leave.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/employee_leave_balance.py b/xero_python/payrollnz/models/employee_leave_balance.py index 5fc42c8b..3935bf93 100644 --- a/xero_python/payrollnz/models/employee_leave_balance.py +++ b/xero_python/payrollnz/models/employee_leave_balance.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/employee_leave_balances.py b/xero_python/payrollnz/models/employee_leave_balances.py index 8ed41347..a7ca4729 100644 --- a/xero_python/payrollnz/models/employee_leave_balances.py +++ b/xero_python/payrollnz/models/employee_leave_balances.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/employee_leave_object.py b/xero_python/payrollnz/models/employee_leave_object.py index 701babcc..cf6f8a99 100644 --- a/xero_python/payrollnz/models/employee_leave_object.py +++ b/xero_python/payrollnz/models/employee_leave_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/employee_leave_setup.py b/xero_python/payrollnz/models/employee_leave_setup.py index 2a63a0bd..0258b8c6 100644 --- a/xero_python/payrollnz/models/employee_leave_setup.py +++ b/xero_python/payrollnz/models/employee_leave_setup.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -34,9 +34,12 @@ class EmployeeLeaveSetup(BaseModel): "holiday_pay_opening_balance": "float", "annual_leave_opening_balance": "float", "negative_annual_leave_balance_paid_amount": "float", - "sick_leave_hours_to_accrue_annually": "float", - "sick_leave_maximum_hours_to_accrue": "float", + "sick_leave_to_accrue_annually": "float", + "sick_leave_maximum_to_accrue": "float", "sick_leave_opening_balance": "float", + "sick_leave_schedule_of_accrual": "str", + "sick_leave_anniversary_date": "date", + "annual_leave_anniversary_date": "date", } attribute_map = { @@ -44,9 +47,12 @@ class EmployeeLeaveSetup(BaseModel): "holiday_pay_opening_balance": "holidayPayOpeningBalance", "annual_leave_opening_balance": "annualLeaveOpeningBalance", "negative_annual_leave_balance_paid_amount": "negativeAnnualLeaveBalancePaidAmount", - "sick_leave_hours_to_accrue_annually": "sickLeaveHoursToAccrueAnnually", - "sick_leave_maximum_hours_to_accrue": "sickLeaveMaximumHoursToAccrue", + "sick_leave_to_accrue_annually": "SickLeaveToAccrueAnnually", + "sick_leave_maximum_to_accrue": "SickLeaveMaximumToAccrue", "sick_leave_opening_balance": "sickLeaveOpeningBalance", + "sick_leave_schedule_of_accrual": "SickLeaveScheduleOfAccrual", + "sick_leave_anniversary_date": "SickLeaveAnniversaryDate", + "annual_leave_anniversary_date": "AnnualLeaveAnniversaryDate", } def __init__( @@ -55,9 +61,12 @@ def __init__( holiday_pay_opening_balance=None, annual_leave_opening_balance=None, negative_annual_leave_balance_paid_amount=None, - sick_leave_hours_to_accrue_annually=None, - sick_leave_maximum_hours_to_accrue=None, + sick_leave_to_accrue_annually=None, + sick_leave_maximum_to_accrue=None, sick_leave_opening_balance=None, + sick_leave_schedule_of_accrual=None, + sick_leave_anniversary_date=None, + annual_leave_anniversary_date=None, ): # noqa: E501 """EmployeeLeaveSetup - a model defined in OpenAPI""" # noqa: E501 @@ -65,9 +74,12 @@ def __init__( self._holiday_pay_opening_balance = None self._annual_leave_opening_balance = None self._negative_annual_leave_balance_paid_amount = None - self._sick_leave_hours_to_accrue_annually = None - self._sick_leave_maximum_hours_to_accrue = None + self._sick_leave_to_accrue_annually = None + self._sick_leave_maximum_to_accrue = None self._sick_leave_opening_balance = None + self._sick_leave_schedule_of_accrual = None + self._sick_leave_anniversary_date = None + self._annual_leave_anniversary_date = None self.discriminator = None if include_holiday_pay is not None: @@ -80,14 +92,18 @@ def __init__( self.negative_annual_leave_balance_paid_amount = ( negative_annual_leave_balance_paid_amount ) - if sick_leave_hours_to_accrue_annually is not None: - self.sick_leave_hours_to_accrue_annually = ( - sick_leave_hours_to_accrue_annually - ) - if sick_leave_maximum_hours_to_accrue is not None: - self.sick_leave_maximum_hours_to_accrue = sick_leave_maximum_hours_to_accrue + if sick_leave_to_accrue_annually is not None: + self.sick_leave_to_accrue_annually = sick_leave_to_accrue_annually + if sick_leave_maximum_to_accrue is not None: + self.sick_leave_maximum_to_accrue = sick_leave_maximum_to_accrue if sick_leave_opening_balance is not None: self.sick_leave_opening_balance = sick_leave_opening_balance + if sick_leave_schedule_of_accrual is not None: + self.sick_leave_schedule_of_accrual = sick_leave_schedule_of_accrual + if sick_leave_anniversary_date is not None: + self.sick_leave_anniversary_date = sick_leave_anniversary_date + if annual_leave_anniversary_date is not None: + self.annual_leave_anniversary_date = annual_leave_anniversary_date @property def include_holiday_pay(self): @@ -186,50 +202,50 @@ def negative_annual_leave_balance_paid_amount( ) @property - def sick_leave_hours_to_accrue_annually(self): - """Gets the sick_leave_hours_to_accrue_annually of this EmployeeLeaveSetup. # noqa: E501 + def sick_leave_to_accrue_annually(self): + """Gets the sick_leave_to_accrue_annually of this EmployeeLeaveSetup. # noqa: E501 - Number of hours accrued annually for sick leave. Multiply the number of days they're entitled to by the hours worked per day # noqa: E501 + Number of units accrued annually for sick leave. The type of units is determined by the property \"TypeOfUnitsToAccrue\" on the \"Sick Leave\" leave type # noqa: E501 - :return: The sick_leave_hours_to_accrue_annually of this EmployeeLeaveSetup. # noqa: E501 + :return: The sick_leave_to_accrue_annually of this EmployeeLeaveSetup. # noqa: E501 :rtype: float """ - return self._sick_leave_hours_to_accrue_annually + return self._sick_leave_to_accrue_annually - @sick_leave_hours_to_accrue_annually.setter - def sick_leave_hours_to_accrue_annually(self, sick_leave_hours_to_accrue_annually): - """Sets the sick_leave_hours_to_accrue_annually of this EmployeeLeaveSetup. + @sick_leave_to_accrue_annually.setter + def sick_leave_to_accrue_annually(self, sick_leave_to_accrue_annually): + """Sets the sick_leave_to_accrue_annually of this EmployeeLeaveSetup. - Number of hours accrued annually for sick leave. Multiply the number of days they're entitled to by the hours worked per day # noqa: E501 + Number of units accrued annually for sick leave. The type of units is determined by the property \"TypeOfUnitsToAccrue\" on the \"Sick Leave\" leave type # noqa: E501 - :param sick_leave_hours_to_accrue_annually: The sick_leave_hours_to_accrue_annually of this EmployeeLeaveSetup. # noqa: E501 + :param sick_leave_to_accrue_annually: The sick_leave_to_accrue_annually of this EmployeeLeaveSetup. # noqa: E501 :type: float """ - self._sick_leave_hours_to_accrue_annually = sick_leave_hours_to_accrue_annually + self._sick_leave_to_accrue_annually = sick_leave_to_accrue_annually @property - def sick_leave_maximum_hours_to_accrue(self): - """Gets the sick_leave_maximum_hours_to_accrue of this EmployeeLeaveSetup. # noqa: E501 + def sick_leave_maximum_to_accrue(self): + """Gets the sick_leave_maximum_to_accrue of this EmployeeLeaveSetup. # noqa: E501 - Maximum number of hours accrued annually for sick leave. Multiply the maximum days they can accrue by the hours worked per day # noqa: E501 + Maximum number of units accrued annually for sick leave. The type of units is determined by the property \"TypeOfUnitsToAccrue\" on the \"Sick Leave\" leave type # noqa: E501 - :return: The sick_leave_maximum_hours_to_accrue of this EmployeeLeaveSetup. # noqa: E501 + :return: The sick_leave_maximum_to_accrue of this EmployeeLeaveSetup. # noqa: E501 :rtype: float """ - return self._sick_leave_maximum_hours_to_accrue + return self._sick_leave_maximum_to_accrue - @sick_leave_maximum_hours_to_accrue.setter - def sick_leave_maximum_hours_to_accrue(self, sick_leave_maximum_hours_to_accrue): - """Sets the sick_leave_maximum_hours_to_accrue of this EmployeeLeaveSetup. + @sick_leave_maximum_to_accrue.setter + def sick_leave_maximum_to_accrue(self, sick_leave_maximum_to_accrue): + """Sets the sick_leave_maximum_to_accrue of this EmployeeLeaveSetup. - Maximum number of hours accrued annually for sick leave. Multiply the maximum days they can accrue by the hours worked per day # noqa: E501 + Maximum number of units accrued annually for sick leave. The type of units is determined by the property \"TypeOfUnitsToAccrue\" on the \"Sick Leave\" leave type # noqa: E501 - :param sick_leave_maximum_hours_to_accrue: The sick_leave_maximum_hours_to_accrue of this EmployeeLeaveSetup. # noqa: E501 + :param sick_leave_maximum_to_accrue: The sick_leave_maximum_to_accrue of this EmployeeLeaveSetup. # noqa: E501 :type: float """ - self._sick_leave_maximum_hours_to_accrue = sick_leave_maximum_hours_to_accrue + self._sick_leave_maximum_to_accrue = sick_leave_maximum_to_accrue @property def sick_leave_opening_balance(self): @@ -253,3 +269,72 @@ def sick_leave_opening_balance(self, sick_leave_opening_balance): """ self._sick_leave_opening_balance = sick_leave_opening_balance + + @property + def sick_leave_schedule_of_accrual(self): + """Gets the sick_leave_schedule_of_accrual of this EmployeeLeaveSetup. # noqa: E501 + + Set Schedule of Accrual Type for Sick Leave # noqa: E501 + + :return: The sick_leave_schedule_of_accrual of this EmployeeLeaveSetup. # noqa: E501 + :rtype: str + """ + return self._sick_leave_schedule_of_accrual + + @sick_leave_schedule_of_accrual.setter + def sick_leave_schedule_of_accrual(self, sick_leave_schedule_of_accrual): + """Sets the sick_leave_schedule_of_accrual of this EmployeeLeaveSetup. + + Set Schedule of Accrual Type for Sick Leave # noqa: E501 + + :param sick_leave_schedule_of_accrual: The sick_leave_schedule_of_accrual of this EmployeeLeaveSetup. # noqa: E501 + :type: str + """ + + self._sick_leave_schedule_of_accrual = sick_leave_schedule_of_accrual + + @property + def sick_leave_anniversary_date(self): + """Gets the sick_leave_anniversary_date of this EmployeeLeaveSetup. # noqa: E501 + + If Sick Leave Schedule of Accrual is \"OnAnniversaryDate\", this is the date when entitled to Sick Leave. When null the Employee's start date is used as the anniversary date # noqa: E501 + + :return: The sick_leave_anniversary_date of this EmployeeLeaveSetup. # noqa: E501 + :rtype: date + """ + return self._sick_leave_anniversary_date + + @sick_leave_anniversary_date.setter + def sick_leave_anniversary_date(self, sick_leave_anniversary_date): + """Sets the sick_leave_anniversary_date of this EmployeeLeaveSetup. + + If Sick Leave Schedule of Accrual is \"OnAnniversaryDate\", this is the date when entitled to Sick Leave. When null the Employee's start date is used as the anniversary date # noqa: E501 + + :param sick_leave_anniversary_date: The sick_leave_anniversary_date of this EmployeeLeaveSetup. # noqa: E501 + :type: date + """ + + self._sick_leave_anniversary_date = sick_leave_anniversary_date + + @property + def annual_leave_anniversary_date(self): + """Gets the annual_leave_anniversary_date of this EmployeeLeaveSetup. # noqa: E501 + + The first date the employee will accrue Annual Leave. When null the Employee's start date is used as the anniversary date # noqa: E501 + + :return: The annual_leave_anniversary_date of this EmployeeLeaveSetup. # noqa: E501 + :rtype: date + """ + return self._annual_leave_anniversary_date + + @annual_leave_anniversary_date.setter + def annual_leave_anniversary_date(self, annual_leave_anniversary_date): + """Sets the annual_leave_anniversary_date of this EmployeeLeaveSetup. + + The first date the employee will accrue Annual Leave. When null the Employee's start date is used as the anniversary date # noqa: E501 + + :param annual_leave_anniversary_date: The annual_leave_anniversary_date of this EmployeeLeaveSetup. # noqa: E501 + :type: date + """ + + self._annual_leave_anniversary_date = annual_leave_anniversary_date diff --git a/xero_python/payrollnz/models/employee_leave_setup_object.py b/xero_python/payrollnz/models/employee_leave_setup_object.py index b502be79..06c09d34 100644 --- a/xero_python/payrollnz/models/employee_leave_setup_object.py +++ b/xero_python/payrollnz/models/employee_leave_setup_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/employee_leave_type.py b/xero_python/payrollnz/models/employee_leave_type.py index 0a5814e7..b4bf4c2e 100644 --- a/xero_python/payrollnz/models/employee_leave_type.py +++ b/xero_python/payrollnz/models/employee_leave_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -32,66 +32,82 @@ class EmployeeLeaveType(BaseModel): openapi_types = { "leave_type_id": "str", "schedule_of_accrual": "str", - "hours_accrued_annually": "float", + "units_accrued_annually": "float", + "type_of_units_to_accrue": "str", "maximum_to_accrue": "float", "opening_balance": "float", + "opening_balance_type_of_units": "str", "rate_accrued_hourly": "float", "percentage_of_gross_earnings": "float", "include_holiday_pay_every_pay": "bool", "show_annual_leave_in_advance": "bool", "annual_leave_total_amount_paid": "float", + "schedule_of_accrual_date": "date", } attribute_map = { "leave_type_id": "leaveTypeID", "schedule_of_accrual": "scheduleOfAccrual", - "hours_accrued_annually": "hoursAccruedAnnually", + "units_accrued_annually": "unitsAccruedAnnually", + "type_of_units_to_accrue": "typeOfUnitsToAccrue", "maximum_to_accrue": "maximumToAccrue", "opening_balance": "openingBalance", + "opening_balance_type_of_units": "openingBalanceTypeOfUnits", "rate_accrued_hourly": "rateAccruedHourly", "percentage_of_gross_earnings": "percentageOfGrossEarnings", "include_holiday_pay_every_pay": "includeHolidayPayEveryPay", "show_annual_leave_in_advance": "showAnnualLeaveInAdvance", "annual_leave_total_amount_paid": "annualLeaveTotalAmountPaid", + "schedule_of_accrual_date": "scheduleOfAccrualDate", } def __init__( self, leave_type_id=None, schedule_of_accrual=None, - hours_accrued_annually=None, + units_accrued_annually=None, + type_of_units_to_accrue=None, maximum_to_accrue=None, opening_balance=None, + opening_balance_type_of_units=None, rate_accrued_hourly=None, percentage_of_gross_earnings=None, include_holiday_pay_every_pay=None, show_annual_leave_in_advance=None, annual_leave_total_amount_paid=None, + schedule_of_accrual_date=None, ): # noqa: E501 """EmployeeLeaveType - a model defined in OpenAPI""" # noqa: E501 self._leave_type_id = None self._schedule_of_accrual = None - self._hours_accrued_annually = None + self._units_accrued_annually = None + self._type_of_units_to_accrue = None self._maximum_to_accrue = None self._opening_balance = None + self._opening_balance_type_of_units = None self._rate_accrued_hourly = None self._percentage_of_gross_earnings = None self._include_holiday_pay_every_pay = None self._show_annual_leave_in_advance = None self._annual_leave_total_amount_paid = None + self._schedule_of_accrual_date = None self.discriminator = None if leave_type_id is not None: self.leave_type_id = leave_type_id if schedule_of_accrual is not None: self.schedule_of_accrual = schedule_of_accrual - if hours_accrued_annually is not None: - self.hours_accrued_annually = hours_accrued_annually + if units_accrued_annually is not None: + self.units_accrued_annually = units_accrued_annually + if type_of_units_to_accrue is not None: + self.type_of_units_to_accrue = type_of_units_to_accrue if maximum_to_accrue is not None: self.maximum_to_accrue = maximum_to_accrue if opening_balance is not None: self.opening_balance = opening_balance + if opening_balance_type_of_units is not None: + self.opening_balance_type_of_units = opening_balance_type_of_units if rate_accrued_hourly is not None: self.rate_accrued_hourly = rate_accrued_hourly if percentage_of_gross_earnings is not None: @@ -102,6 +118,8 @@ def __init__( self.show_annual_leave_in_advance = show_annual_leave_in_advance if annual_leave_total_amount_paid is not None: self.annual_leave_total_amount_paid = annual_leave_total_amount_paid + if schedule_of_accrual_date is not None: + self.schedule_of_accrual_date = schedule_of_accrual_date @property def leave_type_id(self): @@ -165,33 +183,56 @@ def schedule_of_accrual(self, schedule_of_accrual): self._schedule_of_accrual = schedule_of_accrual @property - def hours_accrued_annually(self): - """Gets the hours_accrued_annually of this EmployeeLeaveType. # noqa: E501 + def units_accrued_annually(self): + """Gets the units_accrued_annually of this EmployeeLeaveType. # noqa: E501 - The number of hours accrued for the leave annually. This is 0 when the scheduleOfAccrual chosen is \"OnHourWorked\" # noqa: E501 + The number of units accrued for the leave annually. This is 0 when the ScheduleOfAccrual chosen is \"NoAccruals\" # noqa: E501 - :return: The hours_accrued_annually of this EmployeeLeaveType. # noqa: E501 + :return: The units_accrued_annually of this EmployeeLeaveType. # noqa: E501 :rtype: float """ - return self._hours_accrued_annually + return self._units_accrued_annually - @hours_accrued_annually.setter - def hours_accrued_annually(self, hours_accrued_annually): - """Sets the hours_accrued_annually of this EmployeeLeaveType. + @units_accrued_annually.setter + def units_accrued_annually(self, units_accrued_annually): + """Sets the units_accrued_annually of this EmployeeLeaveType. - The number of hours accrued for the leave annually. This is 0 when the scheduleOfAccrual chosen is \"OnHourWorked\" # noqa: E501 + The number of units accrued for the leave annually. This is 0 when the ScheduleOfAccrual chosen is \"NoAccruals\" # noqa: E501 - :param hours_accrued_annually: The hours_accrued_annually of this EmployeeLeaveType. # noqa: E501 + :param units_accrued_annually: The units_accrued_annually of this EmployeeLeaveType. # noqa: E501 :type: float """ - self._hours_accrued_annually = hours_accrued_annually + self._units_accrued_annually = units_accrued_annually + + @property + def type_of_units_to_accrue(self): + """Gets the type_of_units_to_accrue of this EmployeeLeaveType. # noqa: E501 + + The type of units accrued for the leave annually # noqa: E501 + + :return: The type_of_units_to_accrue of this EmployeeLeaveType. # noqa: E501 + :rtype: str + """ + return self._type_of_units_to_accrue + + @type_of_units_to_accrue.setter + def type_of_units_to_accrue(self, type_of_units_to_accrue): + """Sets the type_of_units_to_accrue of this EmployeeLeaveType. + + The type of units accrued for the leave annually # noqa: E501 + + :param type_of_units_to_accrue: The type_of_units_to_accrue of this EmployeeLeaveType. # noqa: E501 + :type: str + """ + + self._type_of_units_to_accrue = type_of_units_to_accrue @property def maximum_to_accrue(self): """Gets the maximum_to_accrue of this EmployeeLeaveType. # noqa: E501 - The maximum number of hours that can be accrued for the leave # noqa: E501 + The maximum number of units that can be accrued for the leave # noqa: E501 :return: The maximum_to_accrue of this EmployeeLeaveType. # noqa: E501 :rtype: float @@ -202,7 +243,7 @@ def maximum_to_accrue(self): def maximum_to_accrue(self, maximum_to_accrue): """Sets the maximum_to_accrue of this EmployeeLeaveType. - The maximum number of hours that can be accrued for the leave # noqa: E501 + The maximum number of units that can be accrued for the leave # noqa: E501 :param maximum_to_accrue: The maximum_to_accrue of this EmployeeLeaveType. # noqa: E501 :type: float @@ -214,7 +255,7 @@ def maximum_to_accrue(self, maximum_to_accrue): def opening_balance(self): """Gets the opening_balance of this EmployeeLeaveType. # noqa: E501 - The initial number of hours assigned when the leave was added to the employee # noqa: E501 + The initial number of units assigned when the leave was added to the employee # noqa: E501 :return: The opening_balance of this EmployeeLeaveType. # noqa: E501 :rtype: float @@ -225,7 +266,7 @@ def opening_balance(self): def opening_balance(self, opening_balance): """Sets the opening_balance of this EmployeeLeaveType. - The initial number of hours assigned when the leave was added to the employee # noqa: E501 + The initial number of units assigned when the leave was added to the employee # noqa: E501 :param opening_balance: The opening_balance of this EmployeeLeaveType. # noqa: E501 :type: float @@ -233,11 +274,34 @@ def opening_balance(self, opening_balance): self._opening_balance = opening_balance + @property + def opening_balance_type_of_units(self): + """Gets the opening_balance_type_of_units of this EmployeeLeaveType. # noqa: E501 + + The type of units for the opening balance # noqa: E501 + + :return: The opening_balance_type_of_units of this EmployeeLeaveType. # noqa: E501 + :rtype: str + """ + return self._opening_balance_type_of_units + + @opening_balance_type_of_units.setter + def opening_balance_type_of_units(self, opening_balance_type_of_units): + """Sets the opening_balance_type_of_units of this EmployeeLeaveType. + + The type of units for the opening balance # noqa: E501 + + :param opening_balance_type_of_units: The opening_balance_type_of_units of this EmployeeLeaveType. # noqa: E501 + :type: str + """ + + self._opening_balance_type_of_units = opening_balance_type_of_units + @property def rate_accrued_hourly(self): """Gets the rate_accrued_hourly of this EmployeeLeaveType. # noqa: E501 - The number of hours added to the leave balance for every hour worked by the employee. This is normally 0, unless the scheduleOfAccrual chosen is \"OnHourWorked\" # noqa: E501 + not supported in Payroll NZ # noqa: E501 :return: The rate_accrued_hourly of this EmployeeLeaveType. # noqa: E501 :rtype: float @@ -248,7 +312,7 @@ def rate_accrued_hourly(self): def rate_accrued_hourly(self, rate_accrued_hourly): """Sets the rate_accrued_hourly of this EmployeeLeaveType. - The number of hours added to the leave balance for every hour worked by the employee. This is normally 0, unless the scheduleOfAccrual chosen is \"OnHourWorked\" # noqa: E501 + not supported in Payroll NZ # noqa: E501 :param rate_accrued_hourly: The rate_accrued_hourly of this EmployeeLeaveType. # noqa: E501 :type: float @@ -347,3 +411,26 @@ def annual_leave_total_amount_paid(self, annual_leave_total_amount_paid): """ self._annual_leave_total_amount_paid = annual_leave_total_amount_paid + + @property + def schedule_of_accrual_date(self): + """Gets the schedule_of_accrual_date of this EmployeeLeaveType. # noqa: E501 + + The date when an employee becomes entitled to their accrual. # noqa: E501 + + :return: The schedule_of_accrual_date of this EmployeeLeaveType. # noqa: E501 + :rtype: date + """ + return self._schedule_of_accrual_date + + @schedule_of_accrual_date.setter + def schedule_of_accrual_date(self, schedule_of_accrual_date): + """Sets the schedule_of_accrual_date of this EmployeeLeaveType. + + The date when an employee becomes entitled to their accrual. # noqa: E501 + + :param schedule_of_accrual_date: The schedule_of_accrual_date of this EmployeeLeaveType. # noqa: E501 + :type: date + """ + + self._schedule_of_accrual_date = schedule_of_accrual_date diff --git a/xero_python/payrollnz/models/employee_leave_type_object.py b/xero_python/payrollnz/models/employee_leave_type_object.py index a8e054c7..3584e609 100644 --- a/xero_python/payrollnz/models/employee_leave_type_object.py +++ b/xero_python/payrollnz/models/employee_leave_type_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/employee_leave_types.py b/xero_python/payrollnz/models/employee_leave_types.py index d0ba3fb4..6c02383f 100644 --- a/xero_python/payrollnz/models/employee_leave_types.py +++ b/xero_python/payrollnz/models/employee_leave_types.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/employee_leaves.py b/xero_python/payrollnz/models/employee_leaves.py index 1e108a09..2301e2ca 100644 --- a/xero_python/payrollnz/models/employee_leaves.py +++ b/xero_python/payrollnz/models/employee_leaves.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/employee_object.py b/xero_python/payrollnz/models/employee_object.py index b76d3807..526f374d 100644 --- a/xero_python/payrollnz/models/employee_object.py +++ b/xero_python/payrollnz/models/employee_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/employee_opening_balance.py b/xero_python/payrollnz/models/employee_opening_balance.py index 8ea5313e..23873e75 100644 --- a/xero_python/payrollnz/models/employee_opening_balance.py +++ b/xero_python/payrollnz/models/employee_opening_balance.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/employee_opening_balances_object.py b/xero_python/payrollnz/models/employee_opening_balances_object.py index 4c5ab86c..15f13195 100644 --- a/xero_python/payrollnz/models/employee_opening_balances_object.py +++ b/xero_python/payrollnz/models/employee_opening_balances_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/employee_pay_template.py b/xero_python/payrollnz/models/employee_pay_template.py index 1da6d96f..03bac62f 100644 --- a/xero_python/payrollnz/models/employee_pay_template.py +++ b/xero_python/payrollnz/models/employee_pay_template.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -48,8 +48,7 @@ def __init__(self, employee_id=None, earning_templates=None): # noqa: E501 if employee_id is not None: self.employee_id = employee_id - if earning_templates is not None: - self.earning_templates = earning_templates + self.earning_templates = earning_templates @property def employee_id(self): @@ -92,5 +91,9 @@ def earning_templates(self, earning_templates): :param earning_templates: The earning_templates of this EmployeePayTemplate. # noqa: E501 :type: list[EarningsTemplate] """ + if earning_templates is None: + raise ValueError( + "Invalid value for `earning_templates`, must not be `None`" + ) # noqa: E501 self._earning_templates = earning_templates diff --git a/xero_python/payrollnz/models/employee_pay_template_object.py b/xero_python/payrollnz/models/employee_pay_template_object.py index 25c9d1b2..9121030a 100644 --- a/xero_python/payrollnz/models/employee_pay_template_object.py +++ b/xero_python/payrollnz/models/employee_pay_template_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/employee_pay_templates.py b/xero_python/payrollnz/models/employee_pay_templates.py index b192e4f3..2b2cc803 100644 --- a/xero_python/payrollnz/models/employee_pay_templates.py +++ b/xero_python/payrollnz/models/employee_pay_templates.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/employee_statutory_leave_balance.py b/xero_python/payrollnz/models/employee_statutory_leave_balance.py index cdc674bf..8f789d23 100644 --- a/xero_python/payrollnz/models/employee_statutory_leave_balance.py +++ b/xero_python/payrollnz/models/employee_statutory_leave_balance.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/employee_statutory_leave_balance_object.py b/xero_python/payrollnz/models/employee_statutory_leave_balance_object.py index 0e2ad2f3..8c4c335c 100644 --- a/xero_python/payrollnz/models/employee_statutory_leave_balance_object.py +++ b/xero_python/payrollnz/models/employee_statutory_leave_balance_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/employee_statutory_leave_summary.py b/xero_python/payrollnz/models/employee_statutory_leave_summary.py index 6b458a05..02973d23 100644 --- a/xero_python/payrollnz/models/employee_statutory_leave_summary.py +++ b/xero_python/payrollnz/models/employee_statutory_leave_summary.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/employee_statutory_leaves_summaries.py b/xero_python/payrollnz/models/employee_statutory_leaves_summaries.py index e77812c1..904cf1fb 100644 --- a/xero_python/payrollnz/models/employee_statutory_leaves_summaries.py +++ b/xero_python/payrollnz/models/employee_statutory_leaves_summaries.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/employee_statutory_sick_leave.py b/xero_python/payrollnz/models/employee_statutory_sick_leave.py index d9bd8f75..87e8400a 100644 --- a/xero_python/payrollnz/models/employee_statutory_sick_leave.py +++ b/xero_python/payrollnz/models/employee_statutory_sick_leave.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/employee_statutory_sick_leave_object.py b/xero_python/payrollnz/models/employee_statutory_sick_leave_object.py index 6326a3d3..b9c36ee8 100644 --- a/xero_python/payrollnz/models/employee_statutory_sick_leave_object.py +++ b/xero_python/payrollnz/models/employee_statutory_sick_leave_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/employee_statutory_sick_leaves.py b/xero_python/payrollnz/models/employee_statutory_sick_leaves.py index ca9e3c9f..e7e96149 100644 --- a/xero_python/payrollnz/models/employee_statutory_sick_leaves.py +++ b/xero_python/payrollnz/models/employee_statutory_sick_leaves.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/employee_tax.py b/xero_python/payrollnz/models/employee_tax.py index 9efd203a..e89f43fc 100644 --- a/xero_python/payrollnz/models/employee_tax.py +++ b/xero_python/payrollnz/models/employee_tax.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/employee_tax_object.py b/xero_python/payrollnz/models/employee_tax_object.py index 38c2a2ef..ae443dc6 100644 --- a/xero_python/payrollnz/models/employee_tax_object.py +++ b/xero_python/payrollnz/models/employee_tax_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/employee_working_pattern.py b/xero_python/payrollnz/models/employee_working_pattern.py new file mode 100644 index 00000000..98cfd425 --- /dev/null +++ b/xero_python/payrollnz/models/employee_working_pattern.py @@ -0,0 +1,103 @@ +# coding: utf-8 + +""" +Xero Payroll NZ + +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeWorkingPattern(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = {"payee_working_pattern_id": "str", "effective_from": "date"} + + attribute_map = { + "payee_working_pattern_id": "payeeWorkingPatternID", + "effective_from": "effectiveFrom", + } + + def __init__( + self, payee_working_pattern_id=None, effective_from=None + ): # noqa: E501 + """EmployeeWorkingPattern - a model defined in OpenAPI""" # noqa: E501 + + self._payee_working_pattern_id = None + self._effective_from = None + self.discriminator = None + + self.payee_working_pattern_id = payee_working_pattern_id + self.effective_from = effective_from + + @property + def payee_working_pattern_id(self): + """Gets the payee_working_pattern_id of this EmployeeWorkingPattern. # noqa: E501 + + The Xero identifier for for Employee working pattern # noqa: E501 + + :return: The payee_working_pattern_id of this EmployeeWorkingPattern. # noqa: E501 + :rtype: str + """ + return self._payee_working_pattern_id + + @payee_working_pattern_id.setter + def payee_working_pattern_id(self, payee_working_pattern_id): + """Sets the payee_working_pattern_id of this EmployeeWorkingPattern. + + The Xero identifier for for Employee working pattern # noqa: E501 + + :param payee_working_pattern_id: The payee_working_pattern_id of this EmployeeWorkingPattern. # noqa: E501 + :type: str + """ + if payee_working_pattern_id is None: + raise ValueError( + "Invalid value for `payee_working_pattern_id`, must not be `None`" + ) # noqa: E501 + + self._payee_working_pattern_id = payee_working_pattern_id + + @property + def effective_from(self): + """Gets the effective_from of this EmployeeWorkingPattern. # noqa: E501 + + The effective date of the corresponding salary and wages # noqa: E501 + + :return: The effective_from of this EmployeeWorkingPattern. # noqa: E501 + :rtype: date + """ + return self._effective_from + + @effective_from.setter + def effective_from(self, effective_from): + """Sets the effective_from of this EmployeeWorkingPattern. + + The effective date of the corresponding salary and wages # noqa: E501 + + :param effective_from: The effective_from of this EmployeeWorkingPattern. # noqa: E501 + :type: date + """ + if effective_from is None: + raise ValueError( + "Invalid value for `effective_from`, must not be `None`" + ) # noqa: E501 + + self._effective_from = effective_from diff --git a/xero_python/payrollnz/models/employee_working_pattern_with_working_weeks.py b/xero_python/payrollnz/models/employee_working_pattern_with_working_weeks.py new file mode 100644 index 00000000..01336b98 --- /dev/null +++ b/xero_python/payrollnz/models/employee_working_pattern_with_working_weeks.py @@ -0,0 +1,132 @@ +# coding: utf-8 + +""" +Xero Payroll NZ + +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeWorkingPatternWithWorkingWeeks(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "payee_working_pattern_id": "str", + "effective_from": "date", + "working_weeks": "list[WorkingWeek]", + } + + attribute_map = { + "payee_working_pattern_id": "payeeWorkingPatternID", + "effective_from": "effectiveFrom", + "working_weeks": "workingWeeks", + } + + def __init__( + self, payee_working_pattern_id=None, effective_from=None, working_weeks=None + ): # noqa: E501 + """EmployeeWorkingPatternWithWorkingWeeks - a model defined in OpenAPI""" # noqa: E501 + + self._payee_working_pattern_id = None + self._effective_from = None + self._working_weeks = None + self.discriminator = None + + self.payee_working_pattern_id = payee_working_pattern_id + self.effective_from = effective_from + if working_weeks is not None: + self.working_weeks = working_weeks + + @property + def payee_working_pattern_id(self): + """Gets the payee_working_pattern_id of this EmployeeWorkingPatternWithWorkingWeeks. # noqa: E501 + + The Xero identifier for for Employee working pattern # noqa: E501 + + :return: The payee_working_pattern_id of this EmployeeWorkingPatternWithWorkingWeeks. # noqa: E501 + :rtype: str + """ + return self._payee_working_pattern_id + + @payee_working_pattern_id.setter + def payee_working_pattern_id(self, payee_working_pattern_id): + """Sets the payee_working_pattern_id of this EmployeeWorkingPatternWithWorkingWeeks. + + The Xero identifier for for Employee working pattern # noqa: E501 + + :param payee_working_pattern_id: The payee_working_pattern_id of this EmployeeWorkingPatternWithWorkingWeeks. # noqa: E501 + :type: str + """ + if payee_working_pattern_id is None: + raise ValueError( + "Invalid value for `payee_working_pattern_id`, must not be `None`" + ) # noqa: E501 + + self._payee_working_pattern_id = payee_working_pattern_id + + @property + def effective_from(self): + """Gets the effective_from of this EmployeeWorkingPatternWithWorkingWeeks. # noqa: E501 + + The effective date of the corresponding salary and wages # noqa: E501 + + :return: The effective_from of this EmployeeWorkingPatternWithWorkingWeeks. # noqa: E501 + :rtype: date + """ + return self._effective_from + + @effective_from.setter + def effective_from(self, effective_from): + """Sets the effective_from of this EmployeeWorkingPatternWithWorkingWeeks. + + The effective date of the corresponding salary and wages # noqa: E501 + + :param effective_from: The effective_from of this EmployeeWorkingPatternWithWorkingWeeks. # noqa: E501 + :type: date + """ + if effective_from is None: + raise ValueError( + "Invalid value for `effective_from`, must not be `None`" + ) # noqa: E501 + + self._effective_from = effective_from + + @property + def working_weeks(self): + """Gets the working_weeks of this EmployeeWorkingPatternWithWorkingWeeks. # noqa: E501 + + + :return: The working_weeks of this EmployeeWorkingPatternWithWorkingWeeks. # noqa: E501 + :rtype: list[WorkingWeek] + """ + return self._working_weeks + + @working_weeks.setter + def working_weeks(self, working_weeks): + """Sets the working_weeks of this EmployeeWorkingPatternWithWorkingWeeks. + + + :param working_weeks: The working_weeks of this EmployeeWorkingPatternWithWorkingWeeks. # noqa: E501 + :type: list[WorkingWeek] + """ + + self._working_weeks = working_weeks diff --git a/xero_python/payrollnz/models/employee_working_pattern_with_working_weeks_object.py b/xero_python/payrollnz/models/employee_working_pattern_with_working_weeks_object.py new file mode 100644 index 00000000..37690ef4 --- /dev/null +++ b/xero_python/payrollnz/models/employee_working_pattern_with_working_weeks_object.py @@ -0,0 +1,122 @@ +# coding: utf-8 + +""" +Xero Payroll NZ + +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeWorkingPatternWithWorkingWeeksObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "payee_working_pattern": "EmployeeWorkingPatternWithWorkingWeeks", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "payee_working_pattern": "payeeWorkingPattern", + } + + def __init__( + self, pagination=None, problem=None, payee_working_pattern=None + ): # noqa: E501 + """EmployeeWorkingPatternWithWorkingWeeksObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._payee_working_pattern = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if payee_working_pattern is not None: + self.payee_working_pattern = payee_working_pattern + + @property + def pagination(self): + """Gets the pagination of this EmployeeWorkingPatternWithWorkingWeeksObject. # noqa: E501 + + + :return: The pagination of this EmployeeWorkingPatternWithWorkingWeeksObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this EmployeeWorkingPatternWithWorkingWeeksObject. + + + :param pagination: The pagination of this EmployeeWorkingPatternWithWorkingWeeksObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this EmployeeWorkingPatternWithWorkingWeeksObject. # noqa: E501 + + + :return: The problem of this EmployeeWorkingPatternWithWorkingWeeksObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this EmployeeWorkingPatternWithWorkingWeeksObject. + + + :param problem: The problem of this EmployeeWorkingPatternWithWorkingWeeksObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def payee_working_pattern(self): + """Gets the payee_working_pattern of this EmployeeWorkingPatternWithWorkingWeeksObject. # noqa: E501 + + + :return: The payee_working_pattern of this EmployeeWorkingPatternWithWorkingWeeksObject. # noqa: E501 + :rtype: EmployeeWorkingPatternWithWorkingWeeks + """ + return self._payee_working_pattern + + @payee_working_pattern.setter + def payee_working_pattern(self, payee_working_pattern): + """Sets the payee_working_pattern of this EmployeeWorkingPatternWithWorkingWeeksObject. + + + :param payee_working_pattern: The payee_working_pattern of this EmployeeWorkingPatternWithWorkingWeeksObject. # noqa: E501 + :type: EmployeeWorkingPatternWithWorkingWeeks + """ + + self._payee_working_pattern = payee_working_pattern diff --git a/xero_python/payrollnz/models/employee_working_pattern_with_working_weeks_request.py b/xero_python/payrollnz/models/employee_working_pattern_with_working_weeks_request.py new file mode 100644 index 00000000..28728073 --- /dev/null +++ b/xero_python/payrollnz/models/employee_working_pattern_with_working_weeks_request.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" +Xero Payroll NZ + +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeWorkingPatternWithWorkingWeeksRequest(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = {"effective_from": "date", "working_weeks": "list[WorkingWeek]"} + + attribute_map = {"effective_from": "effectiveFrom", "working_weeks": "workingWeeks"} + + def __init__(self, effective_from=None, working_weeks=None): # noqa: E501 + """EmployeeWorkingPatternWithWorkingWeeksRequest - a model defined in OpenAPI""" # noqa: E501 + + self._effective_from = None + self._working_weeks = None + self.discriminator = None + + self.effective_from = effective_from + self.working_weeks = working_weeks + + @property + def effective_from(self): + """Gets the effective_from of this EmployeeWorkingPatternWithWorkingWeeksRequest. # noqa: E501 + + The effective date of the corresponding salary and wages # noqa: E501 + + :return: The effective_from of this EmployeeWorkingPatternWithWorkingWeeksRequest. # noqa: E501 + :rtype: date + """ + return self._effective_from + + @effective_from.setter + def effective_from(self, effective_from): + """Sets the effective_from of this EmployeeWorkingPatternWithWorkingWeeksRequest. + + The effective date of the corresponding salary and wages # noqa: E501 + + :param effective_from: The effective_from of this EmployeeWorkingPatternWithWorkingWeeksRequest. # noqa: E501 + :type: date + """ + if effective_from is None: + raise ValueError( + "Invalid value for `effective_from`, must not be `None`" + ) # noqa: E501 + + self._effective_from = effective_from + + @property + def working_weeks(self): + """Gets the working_weeks of this EmployeeWorkingPatternWithWorkingWeeksRequest. # noqa: E501 + + + :return: The working_weeks of this EmployeeWorkingPatternWithWorkingWeeksRequest. # noqa: E501 + :rtype: list[WorkingWeek] + """ + return self._working_weeks + + @working_weeks.setter + def working_weeks(self, working_weeks): + """Sets the working_weeks of this EmployeeWorkingPatternWithWorkingWeeksRequest. + + + :param working_weeks: The working_weeks of this EmployeeWorkingPatternWithWorkingWeeksRequest. # noqa: E501 + :type: list[WorkingWeek] + """ + if working_weeks is None: + raise ValueError( + "Invalid value for `working_weeks`, must not be `None`" + ) # noqa: E501 + + self._working_weeks = working_weeks diff --git a/xero_python/payrollnz/models/employee_working_patterns_object.py b/xero_python/payrollnz/models/employee_working_patterns_object.py new file mode 100644 index 00000000..a1e57306 --- /dev/null +++ b/xero_python/payrollnz/models/employee_working_patterns_object.py @@ -0,0 +1,122 @@ +# coding: utf-8 + +""" +Xero Payroll NZ + +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeWorkingPatternsObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "payee_working_patterns": "list[EmployeeWorkingPattern]", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "payee_working_patterns": "payeeWorkingPatterns", + } + + def __init__( + self, pagination=None, problem=None, payee_working_patterns=None + ): # noqa: E501 + """EmployeeWorkingPatternsObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._payee_working_patterns = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if payee_working_patterns is not None: + self.payee_working_patterns = payee_working_patterns + + @property + def pagination(self): + """Gets the pagination of this EmployeeWorkingPatternsObject. # noqa: E501 + + + :return: The pagination of this EmployeeWorkingPatternsObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this EmployeeWorkingPatternsObject. + + + :param pagination: The pagination of this EmployeeWorkingPatternsObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this EmployeeWorkingPatternsObject. # noqa: E501 + + + :return: The problem of this EmployeeWorkingPatternsObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this EmployeeWorkingPatternsObject. + + + :param problem: The problem of this EmployeeWorkingPatternsObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def payee_working_patterns(self): + """Gets the payee_working_patterns of this EmployeeWorkingPatternsObject. # noqa: E501 + + + :return: The payee_working_patterns of this EmployeeWorkingPatternsObject. # noqa: E501 + :rtype: list[EmployeeWorkingPattern] + """ + return self._payee_working_patterns + + @payee_working_patterns.setter + def payee_working_patterns(self, payee_working_patterns): + """Sets the payee_working_patterns of this EmployeeWorkingPatternsObject. + + + :param payee_working_patterns: The payee_working_patterns of this EmployeeWorkingPatternsObject. # noqa: E501 + :type: list[EmployeeWorkingPattern] + """ + + self._payee_working_patterns = payee_working_patterns diff --git a/xero_python/payrollnz/models/employees.py b/xero_python/payrollnz/models/employees.py index 8effa3d7..bb72d15b 100644 --- a/xero_python/payrollnz/models/employees.py +++ b/xero_python/payrollnz/models/employees.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/employment.py b/xero_python/payrollnz/models/employment.py index da83247b..8d6aa4fd 100644 --- a/xero_python/payrollnz/models/employment.py +++ b/xero_python/payrollnz/models/employment.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -33,30 +33,42 @@ class Employment(BaseModel): "payroll_calendar_id": "str", "pay_run_calendar_id": "str", "start_date": "date", + "engagement_type": "str", + "fixed_term_end_date": "date", } attribute_map = { "payroll_calendar_id": "payrollCalendarID", "pay_run_calendar_id": "payRunCalendarID", "start_date": "startDate", + "engagement_type": "engagementType", + "fixed_term_end_date": "fixedTermEndDate", } def __init__( - self, payroll_calendar_id=None, pay_run_calendar_id=None, start_date=None + self, + payroll_calendar_id=None, + pay_run_calendar_id=None, + start_date=None, + engagement_type=None, + fixed_term_end_date=None, ): # noqa: E501 """Employment - a model defined in OpenAPI""" # noqa: E501 self._payroll_calendar_id = None self._pay_run_calendar_id = None self._start_date = None + self._engagement_type = None + self._fixed_term_end_date = None self.discriminator = None - if payroll_calendar_id is not None: - self.payroll_calendar_id = payroll_calendar_id + self.payroll_calendar_id = payroll_calendar_id if pay_run_calendar_id is not None: self.pay_run_calendar_id = pay_run_calendar_id - if start_date is not None: - self.start_date = start_date + self.start_date = start_date + self.engagement_type = engagement_type + if fixed_term_end_date is not None: + self.fixed_term_end_date = fixed_term_end_date @property def payroll_calendar_id(self): @@ -78,6 +90,10 @@ def payroll_calendar_id(self, payroll_calendar_id): :param payroll_calendar_id: The payroll_calendar_id of this Employment. # noqa: E501 :type: str """ + if payroll_calendar_id is None: + raise ValueError( + "Invalid value for `payroll_calendar_id`, must not be `None`" + ) # noqa: E501 self._payroll_calendar_id = payroll_calendar_id @@ -124,5 +140,59 @@ def start_date(self, start_date): :param start_date: The start_date of this Employment. # noqa: E501 :type: date """ + if start_date is None: + raise ValueError( + "Invalid value for `start_date`, must not be `None`" + ) # noqa: E501 self._start_date = start_date + + @property + def engagement_type(self): + """Gets the engagement_type of this Employment. # noqa: E501 + + Engagement type of the employee # noqa: E501 + + :return: The engagement_type of this Employment. # noqa: E501 + :rtype: str + """ + return self._engagement_type + + @engagement_type.setter + def engagement_type(self, engagement_type): + """Sets the engagement_type of this Employment. + + Engagement type of the employee # noqa: E501 + + :param engagement_type: The engagement_type of this Employment. # noqa: E501 + :type: str + """ + if engagement_type is None: + raise ValueError( + "Invalid value for `engagement_type`, must not be `None`" + ) # noqa: E501 + + self._engagement_type = engagement_type + + @property + def fixed_term_end_date(self): + """Gets the fixed_term_end_date of this Employment. # noqa: E501 + + End date for an employee with a fixed-term engagement type # noqa: E501 + + :return: The fixed_term_end_date of this Employment. # noqa: E501 + :rtype: date + """ + return self._fixed_term_end_date + + @fixed_term_end_date.setter + def fixed_term_end_date(self, fixed_term_end_date): + """Sets the fixed_term_end_date of this Employment. + + End date for an employee with a fixed-term engagement type # noqa: E501 + + :param fixed_term_end_date: The fixed_term_end_date of this Employment. # noqa: E501 + :type: date + """ + + self._fixed_term_end_date = fixed_term_end_date diff --git a/xero_python/payrollnz/models/employment_object.py b/xero_python/payrollnz/models/employment_object.py index 411227ef..934d45ca 100644 --- a/xero_python/payrollnz/models/employment_object.py +++ b/xero_python/payrollnz/models/employment_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/gross_earnings_history.py b/xero_python/payrollnz/models/gross_earnings_history.py index c58915cb..2f214845 100644 --- a/xero_python/payrollnz/models/gross_earnings_history.py +++ b/xero_python/payrollnz/models/gross_earnings_history.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/invalid_field.py b/xero_python/payrollnz/models/invalid_field.py index b998c28b..f8c708e1 100644 --- a/xero_python/payrollnz/models/invalid_field.py +++ b/xero_python/payrollnz/models/invalid_field.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/leave_accrual_line.py b/xero_python/payrollnz/models/leave_accrual_line.py index b5df7895..b5d3c23e 100644 --- a/xero_python/payrollnz/models/leave_accrual_line.py +++ b/xero_python/payrollnz/models/leave_accrual_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/leave_earnings_line.py b/xero_python/payrollnz/models/leave_earnings_line.py index c2c917e4..143e674c 100644 --- a/xero_python/payrollnz/models/leave_earnings_line.py +++ b/xero_python/payrollnz/models/leave_earnings_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/leave_period.py b/xero_python/payrollnz/models/leave_period.py index da81576b..fd2ce8e0 100644 --- a/xero_python/payrollnz/models/leave_period.py +++ b/xero_python/payrollnz/models/leave_period.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -33,6 +33,9 @@ class LeavePeriod(BaseModel): "period_start_date": "date", "period_end_date": "date", "number_of_units": "float", + "number_of_units_taken": "float", + "type_of_units": "str", + "type_of_units_taken": "str", "period_status": "str", } @@ -40,6 +43,9 @@ class LeavePeriod(BaseModel): "period_start_date": "periodStartDate", "period_end_date": "periodEndDate", "number_of_units": "numberOfUnits", + "number_of_units_taken": "numberOfUnitsTaken", + "type_of_units": "typeOfUnits", + "type_of_units_taken": "typeOfUnitsTaken", "period_status": "periodStatus", } @@ -48,6 +54,9 @@ def __init__( period_start_date=None, period_end_date=None, number_of_units=None, + number_of_units_taken=None, + type_of_units=None, + type_of_units_taken=None, period_status=None, ): # noqa: E501 """LeavePeriod - a model defined in OpenAPI""" # noqa: E501 @@ -55,6 +64,9 @@ def __init__( self._period_start_date = None self._period_end_date = None self._number_of_units = None + self._number_of_units_taken = None + self._type_of_units = None + self._type_of_units_taken = None self._period_status = None self.discriminator = None @@ -64,6 +76,12 @@ def __init__( self.period_end_date = period_end_date if number_of_units is not None: self.number_of_units = number_of_units + if number_of_units_taken is not None: + self.number_of_units_taken = number_of_units_taken + if type_of_units is not None: + self.type_of_units = type_of_units + if type_of_units_taken is not None: + self.type_of_units_taken = type_of_units_taken if period_status is not None: self.period_status = period_status @@ -136,11 +154,80 @@ def number_of_units(self, number_of_units): self._number_of_units = number_of_units + @property + def number_of_units_taken(self): + """Gets the number_of_units_taken of this LeavePeriod. # noqa: E501 + + The number of units taken for the leave # noqa: E501 + + :return: The number_of_units_taken of this LeavePeriod. # noqa: E501 + :rtype: float + """ + return self._number_of_units_taken + + @number_of_units_taken.setter + def number_of_units_taken(self, number_of_units_taken): + """Sets the number_of_units_taken of this LeavePeriod. + + The number of units taken for the leave # noqa: E501 + + :param number_of_units_taken: The number_of_units_taken of this LeavePeriod. # noqa: E501 + :type: float + """ + + self._number_of_units_taken = number_of_units_taken + + @property + def type_of_units(self): + """Gets the type_of_units of this LeavePeriod. # noqa: E501 + + The type of units paid for the leave # noqa: E501 + + :return: The type_of_units of this LeavePeriod. # noqa: E501 + :rtype: str + """ + return self._type_of_units + + @type_of_units.setter + def type_of_units(self, type_of_units): + """Sets the type_of_units of this LeavePeriod. + + The type of units paid for the leave # noqa: E501 + + :param type_of_units: The type_of_units of this LeavePeriod. # noqa: E501 + :type: str + """ + + self._type_of_units = type_of_units + + @property + def type_of_units_taken(self): + """Gets the type_of_units_taken of this LeavePeriod. # noqa: E501 + + The type of units taken for the leave # noqa: E501 + + :return: The type_of_units_taken of this LeavePeriod. # noqa: E501 + :rtype: str + """ + return self._type_of_units_taken + + @type_of_units_taken.setter + def type_of_units_taken(self, type_of_units_taken): + """Sets the type_of_units_taken of this LeavePeriod. + + The type of units taken for the leave # noqa: E501 + + :param type_of_units_taken: The type_of_units_taken of this LeavePeriod. # noqa: E501 + :type: str + """ + + self._type_of_units_taken = type_of_units_taken + @property def period_status(self): """Gets the period_status of this LeavePeriod. # noqa: E501 - Period Status # noqa: E501 + Status of leave # noqa: E501 :return: The period_status of this LeavePeriod. # noqa: E501 :rtype: str @@ -151,12 +238,12 @@ def period_status(self): def period_status(self, period_status): """Sets the period_status of this LeavePeriod. - Period Status # noqa: E501 + Status of leave # noqa: E501 :param period_status: The period_status of this LeavePeriod. # noqa: E501 :type: str """ - allowed_values = ["Approved", "Completed", "None"] # noqa: E501 + allowed_values = ["Approved", "Completed", "Estimated", "None"] # noqa: E501 if period_status: if period_status not in allowed_values: diff --git a/xero_python/payrollnz/models/leave_periods.py b/xero_python/payrollnz/models/leave_periods.py index c691bad8..ab9c7318 100644 --- a/xero_python/payrollnz/models/leave_periods.py +++ b/xero_python/payrollnz/models/leave_periods.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/leave_type.py b/xero_python/payrollnz/models/leave_type.py index d581a2f9..344f6939 100644 --- a/xero_python/payrollnz/models/leave_type.py +++ b/xero_python/payrollnz/models/leave_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -36,6 +36,8 @@ class LeaveType(BaseModel): "show_on_payslip": "bool", "updated_date_utc": "datetime", "is_active": "bool", + "type_of_units": "str", + "type_of_units_to_accrue": "str", } attribute_map = { @@ -45,6 +47,8 @@ class LeaveType(BaseModel): "show_on_payslip": "showOnPayslip", "updated_date_utc": "updatedDateUTC", "is_active": "isActive", + "type_of_units": "typeOfUnits", + "type_of_units_to_accrue": "typeOfUnitsToAccrue", } def __init__( @@ -55,6 +59,8 @@ def __init__( show_on_payslip=None, updated_date_utc=None, is_active=None, + type_of_units=None, + type_of_units_to_accrue=None, ): # noqa: E501 """LeaveType - a model defined in OpenAPI""" # noqa: E501 @@ -64,6 +70,8 @@ def __init__( self._show_on_payslip = None self._updated_date_utc = None self._is_active = None + self._type_of_units = None + self._type_of_units_to_accrue = None self.discriminator = None if leave_type_id is not None: @@ -75,6 +83,10 @@ def __init__( self.updated_date_utc = updated_date_utc if is_active is not None: self.is_active = is_active + if type_of_units is not None: + self.type_of_units = type_of_units + if type_of_units_to_accrue is not None: + self.type_of_units_to_accrue = type_of_units_to_accrue @property def leave_type_id(self): @@ -225,3 +237,49 @@ def is_active(self, is_active): """ self._is_active = is_active + + @property + def type_of_units(self): + """Gets the type_of_units of this LeaveType. # noqa: E501 + + The type of units to be paid for the leave type # noqa: E501 + + :return: The type_of_units of this LeaveType. # noqa: E501 + :rtype: str + """ + return self._type_of_units + + @type_of_units.setter + def type_of_units(self, type_of_units): + """Sets the type_of_units of this LeaveType. + + The type of units to be paid for the leave type # noqa: E501 + + :param type_of_units: The type_of_units of this LeaveType. # noqa: E501 + :type: str + """ + + self._type_of_units = type_of_units + + @property + def type_of_units_to_accrue(self): + """Gets the type_of_units_to_accrue of this LeaveType. # noqa: E501 + + The type of units to be accrued for the leave type # noqa: E501 + + :return: The type_of_units_to_accrue of this LeaveType. # noqa: E501 + :rtype: str + """ + return self._type_of_units_to_accrue + + @type_of_units_to_accrue.setter + def type_of_units_to_accrue(self, type_of_units_to_accrue): + """Sets the type_of_units_to_accrue of this LeaveType. + + The type of units to be accrued for the leave type # noqa: E501 + + :param type_of_units_to_accrue: The type_of_units_to_accrue of this LeaveType. # noqa: E501 + :type: str + """ + + self._type_of_units_to_accrue = type_of_units_to_accrue diff --git a/xero_python/payrollnz/models/leave_type_object.py b/xero_python/payrollnz/models/leave_type_object.py index 40edaba2..c9058be9 100644 --- a/xero_python/payrollnz/models/leave_type_object.py +++ b/xero_python/payrollnz/models/leave_type_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/leave_types.py b/xero_python/payrollnz/models/leave_types.py index e0521dea..afb8cf6c 100644 --- a/xero_python/payrollnz/models/leave_types.py +++ b/xero_python/payrollnz/models/leave_types.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/pagination.py b/xero_python/payrollnz/models/pagination.py index 581e85aa..f6b2996b 100644 --- a/xero_python/payrollnz/models/pagination.py +++ b/xero_python/payrollnz/models/pagination.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/pay_run.py b/xero_python/payrollnz/models/pay_run.py index ac3720f9..7f7007d5 100644 --- a/xero_python/payrollnz/models/pay_run.py +++ b/xero_python/payrollnz/models/pay_run.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/pay_run_calendar.py b/xero_python/payrollnz/models/pay_run_calendar.py index bd0901a7..ca3fe5f3 100644 --- a/xero_python/payrollnz/models/pay_run_calendar.py +++ b/xero_python/payrollnz/models/pay_run_calendar.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/pay_run_calendar_object.py b/xero_python/payrollnz/models/pay_run_calendar_object.py index 0a8671fb..148cccdc 100644 --- a/xero_python/payrollnz/models/pay_run_calendar_object.py +++ b/xero_python/payrollnz/models/pay_run_calendar_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/pay_run_calendars.py b/xero_python/payrollnz/models/pay_run_calendars.py index 0a5122c4..19d33f9a 100644 --- a/xero_python/payrollnz/models/pay_run_calendars.py +++ b/xero_python/payrollnz/models/pay_run_calendars.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/pay_run_object.py b/xero_python/payrollnz/models/pay_run_object.py index 024747c0..724f46ee 100644 --- a/xero_python/payrollnz/models/pay_run_object.py +++ b/xero_python/payrollnz/models/pay_run_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/pay_runs.py b/xero_python/payrollnz/models/pay_runs.py index 3bd6ff1a..c648fb82 100644 --- a/xero_python/payrollnz/models/pay_runs.py +++ b/xero_python/payrollnz/models/pay_runs.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/pay_slip.py b/xero_python/payrollnz/models/pay_slip.py index fe62f21c..63c1ab45 100644 --- a/xero_python/payrollnz/models/pay_slip.py +++ b/xero_python/payrollnz/models/pay_slip.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/pay_slip_object.py b/xero_python/payrollnz/models/pay_slip_object.py index 1ec2207f..f619cd16 100644 --- a/xero_python/payrollnz/models/pay_slip_object.py +++ b/xero_python/payrollnz/models/pay_slip_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/pay_slips.py b/xero_python/payrollnz/models/pay_slips.py index 96769906..bfbb7dd2 100644 --- a/xero_python/payrollnz/models/pay_slips.py +++ b/xero_python/payrollnz/models/pay_slips.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/payment_line.py b/xero_python/payrollnz/models/payment_line.py index 678f6d9f..02bdcd40 100644 --- a/xero_python/payrollnz/models/payment_line.py +++ b/xero_python/payrollnz/models/payment_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/payment_method.py b/xero_python/payrollnz/models/payment_method.py index 0677ccf2..67053f57 100644 --- a/xero_python/payrollnz/models/payment_method.py +++ b/xero_python/payrollnz/models/payment_method.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/payment_method_object.py b/xero_python/payrollnz/models/payment_method_object.py index ea2ad4e1..677e1769 100644 --- a/xero_python/payrollnz/models/payment_method_object.py +++ b/xero_python/payrollnz/models/payment_method_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/problem.py b/xero_python/payrollnz/models/problem.py index 33f70ad0..7f56bd75 100644 --- a/xero_python/payrollnz/models/problem.py +++ b/xero_python/payrollnz/models/problem.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/reimbursement.py b/xero_python/payrollnz/models/reimbursement.py index 27340d1e..c33eb3f9 100644 --- a/xero_python/payrollnz/models/reimbursement.py +++ b/xero_python/payrollnz/models/reimbursement.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/reimbursement_line.py b/xero_python/payrollnz/models/reimbursement_line.py index ad4c8211..192f12b9 100644 --- a/xero_python/payrollnz/models/reimbursement_line.py +++ b/xero_python/payrollnz/models/reimbursement_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/reimbursement_object.py b/xero_python/payrollnz/models/reimbursement_object.py index 2a6671f8..174af0cc 100644 --- a/xero_python/payrollnz/models/reimbursement_object.py +++ b/xero_python/payrollnz/models/reimbursement_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/reimbursements.py b/xero_python/payrollnz/models/reimbursements.py index fb6071ac..8d08955c 100644 --- a/xero_python/payrollnz/models/reimbursements.py +++ b/xero_python/payrollnz/models/reimbursements.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/salary_and_wage.py b/xero_python/payrollnz/models/salary_and_wage.py index 8034e143..5cd8ad7e 100644 --- a/xero_python/payrollnz/models/salary_and_wage.py +++ b/xero_python/payrollnz/models/salary_and_wage.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -40,6 +40,7 @@ class SalaryAndWage(BaseModel): "annual_salary": "float", "status": "str", "payment_type": "str", + "work_pattern_type": "str", } attribute_map = { @@ -53,6 +54,7 @@ class SalaryAndWage(BaseModel): "annual_salary": "annualSalary", "status": "status", "payment_type": "paymentType", + "work_pattern_type": "workPatternType", } def __init__( @@ -67,6 +69,7 @@ def __init__( annual_salary=None, status=None, payment_type=None, + work_pattern_type=None, ): # noqa: E501 """SalaryAndWage - a model defined in OpenAPI""" # noqa: E501 @@ -80,6 +83,7 @@ def __init__( self._annual_salary = None self._status = None self._payment_type = None + self._work_pattern_type = None self.discriminator = None if salary_and_wages_id is not None: @@ -95,6 +99,8 @@ def __init__( self.annual_salary = annual_salary self.status = status self.payment_type = payment_type + if work_pattern_type is not None: + self.work_pattern_type = work_pattern_type @property def salary_and_wages_id(self): @@ -371,3 +377,35 @@ def payment_type(self, payment_type): ) self._payment_type = payment_type + + @property + def work_pattern_type(self): + """Gets the work_pattern_type of this SalaryAndWage. # noqa: E501 + + The type of the Working Pattern of the corresponding salary and wages # noqa: E501 + + :return: The work_pattern_type of this SalaryAndWage. # noqa: E501 + :rtype: str + """ + return self._work_pattern_type + + @work_pattern_type.setter + def work_pattern_type(self, work_pattern_type): + """Sets the work_pattern_type of this SalaryAndWage. + + The type of the Working Pattern of the corresponding salary and wages # noqa: E501 + + :param work_pattern_type: The work_pattern_type of this SalaryAndWage. # noqa: E501 + :type: str + """ + allowed_values = ["DaysAndHours", "RegularWeek", "None"] # noqa: E501 + + if work_pattern_type: + if work_pattern_type not in allowed_values: + raise ValueError( + "Invalid value for `work_pattern_type` ({0}), must be one of {1}".format( # noqa: E501 + work_pattern_type, allowed_values + ) + ) + + self._work_pattern_type = work_pattern_type diff --git a/xero_python/payrollnz/models/salary_and_wage_object.py b/xero_python/payrollnz/models/salary_and_wage_object.py index a5c5cb47..b0db64bc 100644 --- a/xero_python/payrollnz/models/salary_and_wage_object.py +++ b/xero_python/payrollnz/models/salary_and_wage_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/salary_and_wages.py b/xero_python/payrollnz/models/salary_and_wages.py index 5fa96a54..8a17a005 100644 --- a/xero_python/payrollnz/models/salary_and_wages.py +++ b/xero_python/payrollnz/models/salary_and_wages.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/settings.py b/xero_python/payrollnz/models/settings.py index 8f766a83..2c25f846 100644 --- a/xero_python/payrollnz/models/settings.py +++ b/xero_python/payrollnz/models/settings.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/statutory_deduction.py b/xero_python/payrollnz/models/statutory_deduction.py index 24cf57b9..2da60ece 100644 --- a/xero_python/payrollnz/models/statutory_deduction.py +++ b/xero_python/payrollnz/models/statutory_deduction.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/statutory_deduction_category.py b/xero_python/payrollnz/models/statutory_deduction_category.py index 5348a355..190833b4 100644 --- a/xero_python/payrollnz/models/statutory_deduction_category.py +++ b/xero_python/payrollnz/models/statutory_deduction_category.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/statutory_deduction_line.py b/xero_python/payrollnz/models/statutory_deduction_line.py index 62a8860b..3424aff6 100644 --- a/xero_python/payrollnz/models/statutory_deduction_line.py +++ b/xero_python/payrollnz/models/statutory_deduction_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/statutory_deduction_object.py b/xero_python/payrollnz/models/statutory_deduction_object.py index 750774f2..cd5e97c1 100644 --- a/xero_python/payrollnz/models/statutory_deduction_object.py +++ b/xero_python/payrollnz/models/statutory_deduction_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/statutory_deductions.py b/xero_python/payrollnz/models/statutory_deductions.py index 745b6803..2438c83d 100644 --- a/xero_python/payrollnz/models/statutory_deductions.py +++ b/xero_python/payrollnz/models/statutory_deductions.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/superannuation_line.py b/xero_python/payrollnz/models/superannuation_line.py index 5ab61bda..ee2541f5 100644 --- a/xero_python/payrollnz/models/superannuation_line.py +++ b/xero_python/payrollnz/models/superannuation_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/superannuation_object.py b/xero_python/payrollnz/models/superannuation_object.py index 87adebb8..94ad212a 100644 --- a/xero_python/payrollnz/models/superannuation_object.py +++ b/xero_python/payrollnz/models/superannuation_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/superannuations.py b/xero_python/payrollnz/models/superannuations.py index 56294fde..074dc3e3 100644 --- a/xero_python/payrollnz/models/superannuations.py +++ b/xero_python/payrollnz/models/superannuations.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/tax_code.py b/xero_python/payrollnz/models/tax_code.py index ae2690ab..a9298684 100644 --- a/xero_python/payrollnz/models/tax_code.py +++ b/xero_python/payrollnz/models/tax_code.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/tax_line.py b/xero_python/payrollnz/models/tax_line.py index 5ef4b8fd..83eea2e5 100644 --- a/xero_python/payrollnz/models/tax_line.py +++ b/xero_python/payrollnz/models/tax_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/tax_settings.py b/xero_python/payrollnz/models/tax_settings.py index 3f192110..8856afc3 100644 --- a/xero_python/payrollnz/models/tax_settings.py +++ b/xero_python/payrollnz/models/tax_settings.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/timesheet.py b/xero_python/payrollnz/models/timesheet.py index 684fad91..c8ac30af 100644 --- a/xero_python/payrollnz/models/timesheet.py +++ b/xero_python/payrollnz/models/timesheet.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/timesheet_earnings_line.py b/xero_python/payrollnz/models/timesheet_earnings_line.py index 107ccf53..b960a2ad 100644 --- a/xero_python/payrollnz/models/timesheet_earnings_line.py +++ b/xero_python/payrollnz/models/timesheet_earnings_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/timesheet_line.py b/xero_python/payrollnz/models/timesheet_line.py index a16a47aa..b2f3dc60 100644 --- a/xero_python/payrollnz/models/timesheet_line.py +++ b/xero_python/payrollnz/models/timesheet_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/timesheet_line_object.py b/xero_python/payrollnz/models/timesheet_line_object.py index d0ec74a0..9e9e7ccb 100644 --- a/xero_python/payrollnz/models/timesheet_line_object.py +++ b/xero_python/payrollnz/models/timesheet_line_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/timesheet_object.py b/xero_python/payrollnz/models/timesheet_object.py index 6bcd3169..2866d668 100644 --- a/xero_python/payrollnz/models/timesheet_object.py +++ b/xero_python/payrollnz/models/timesheet_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/timesheets.py b/xero_python/payrollnz/models/timesheets.py index f2fc7a66..031c1dfe 100644 --- a/xero_python/payrollnz/models/timesheets.py +++ b/xero_python/payrollnz/models/timesheets.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/tracking_categories.py b/xero_python/payrollnz/models/tracking_categories.py index 2d18fe86..6789302d 100644 --- a/xero_python/payrollnz/models/tracking_categories.py +++ b/xero_python/payrollnz/models/tracking_categories.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/tracking_category.py b/xero_python/payrollnz/models/tracking_category.py index 3c353f10..61e40db0 100644 --- a/xero_python/payrollnz/models/tracking_category.py +++ b/xero_python/payrollnz/models/tracking_category.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll NZ +Xero Payroll NZ - This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/models/working_week.py b/xero_python/payrollnz/models/working_week.py new file mode 100644 index 00000000..299362e9 --- /dev/null +++ b/xero_python/payrollnz/models/working_week.py @@ -0,0 +1,268 @@ +# coding: utf-8 + +""" +Xero Payroll NZ + +This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class WorkingWeek(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "monday": "float", + "tuesday": "float", + "wednesday": "float", + "thursday": "float", + "friday": "float", + "saturday": "float", + "sunday": "float", + } + + attribute_map = { + "monday": "monday", + "tuesday": "tuesday", + "wednesday": "wednesday", + "thursday": "thursday", + "friday": "friday", + "saturday": "saturday", + "sunday": "sunday", + } + + def __init__( + self, + monday=None, + tuesday=None, + wednesday=None, + thursday=None, + friday=None, + saturday=None, + sunday=None, + ): # noqa: E501 + """WorkingWeek - a model defined in OpenAPI""" # noqa: E501 + + self._monday = None + self._tuesday = None + self._wednesday = None + self._thursday = None + self._friday = None + self._saturday = None + self._sunday = None + self.discriminator = None + + self.monday = monday + self.tuesday = tuesday + self.wednesday = wednesday + self.thursday = thursday + self.friday = friday + self.saturday = saturday + self.sunday = sunday + + @property + def monday(self): + """Gets the monday of this WorkingWeek. # noqa: E501 + + The number of hours worked on a Monday # noqa: E501 + + :return: The monday of this WorkingWeek. # noqa: E501 + :rtype: float + """ + return self._monday + + @monday.setter + def monday(self, monday): + """Sets the monday of this WorkingWeek. + + The number of hours worked on a Monday # noqa: E501 + + :param monday: The monday of this WorkingWeek. # noqa: E501 + :type: float + """ + if monday is None: + raise ValueError( + "Invalid value for `monday`, must not be `None`" + ) # noqa: E501 + + self._monday = monday + + @property + def tuesday(self): + """Gets the tuesday of this WorkingWeek. # noqa: E501 + + The number of hours worked on a Tuesday # noqa: E501 + + :return: The tuesday of this WorkingWeek. # noqa: E501 + :rtype: float + """ + return self._tuesday + + @tuesday.setter + def tuesday(self, tuesday): + """Sets the tuesday of this WorkingWeek. + + The number of hours worked on a Tuesday # noqa: E501 + + :param tuesday: The tuesday of this WorkingWeek. # noqa: E501 + :type: float + """ + if tuesday is None: + raise ValueError( + "Invalid value for `tuesday`, must not be `None`" + ) # noqa: E501 + + self._tuesday = tuesday + + @property + def wednesday(self): + """Gets the wednesday of this WorkingWeek. # noqa: E501 + + The number of hours worked on a Wednesday # noqa: E501 + + :return: The wednesday of this WorkingWeek. # noqa: E501 + :rtype: float + """ + return self._wednesday + + @wednesday.setter + def wednesday(self, wednesday): + """Sets the wednesday of this WorkingWeek. + + The number of hours worked on a Wednesday # noqa: E501 + + :param wednesday: The wednesday of this WorkingWeek. # noqa: E501 + :type: float + """ + if wednesday is None: + raise ValueError( + "Invalid value for `wednesday`, must not be `None`" + ) # noqa: E501 + + self._wednesday = wednesday + + @property + def thursday(self): + """Gets the thursday of this WorkingWeek. # noqa: E501 + + The number of hours worked on a Thursday # noqa: E501 + + :return: The thursday of this WorkingWeek. # noqa: E501 + :rtype: float + """ + return self._thursday + + @thursday.setter + def thursday(self, thursday): + """Sets the thursday of this WorkingWeek. + + The number of hours worked on a Thursday # noqa: E501 + + :param thursday: The thursday of this WorkingWeek. # noqa: E501 + :type: float + """ + if thursday is None: + raise ValueError( + "Invalid value for `thursday`, must not be `None`" + ) # noqa: E501 + + self._thursday = thursday + + @property + def friday(self): + """Gets the friday of this WorkingWeek. # noqa: E501 + + The number of hours worked on a Friday # noqa: E501 + + :return: The friday of this WorkingWeek. # noqa: E501 + :rtype: float + """ + return self._friday + + @friday.setter + def friday(self, friday): + """Sets the friday of this WorkingWeek. + + The number of hours worked on a Friday # noqa: E501 + + :param friday: The friday of this WorkingWeek. # noqa: E501 + :type: float + """ + if friday is None: + raise ValueError( + "Invalid value for `friday`, must not be `None`" + ) # noqa: E501 + + self._friday = friday + + @property + def saturday(self): + """Gets the saturday of this WorkingWeek. # noqa: E501 + + The number of hours worked on a Saturday # noqa: E501 + + :return: The saturday of this WorkingWeek. # noqa: E501 + :rtype: float + """ + return self._saturday + + @saturday.setter + def saturday(self, saturday): + """Sets the saturday of this WorkingWeek. + + The number of hours worked on a Saturday # noqa: E501 + + :param saturday: The saturday of this WorkingWeek. # noqa: E501 + :type: float + """ + if saturday is None: + raise ValueError( + "Invalid value for `saturday`, must not be `None`" + ) # noqa: E501 + + self._saturday = saturday + + @property + def sunday(self): + """Gets the sunday of this WorkingWeek. # noqa: E501 + + The number of hours worked on a Sunday # noqa: E501 + + :return: The sunday of this WorkingWeek. # noqa: E501 + :rtype: float + """ + return self._sunday + + @sunday.setter + def sunday(self, sunday): + """Sets the sunday of this WorkingWeek. + + The number of hours worked on a Sunday # noqa: E501 + + :param sunday: The sunday of this WorkingWeek. # noqa: E501 + :type: float + """ + if sunday is None: + raise ValueError( + "Invalid value for `sunday`, must not be `None`" + ) # noqa: E501 + + self._sunday = sunday diff --git a/xero_python/payrolluk/__init__.py b/xero_python/payrolluk/__init__.py index 05497b10..6b51b5d2 100644 --- a/xero_python/payrolluk/__init__.py +++ b/xero_python/payrolluk/__init__.py @@ -3,12 +3,12 @@ # flake8: noqa """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -25,11 +25,16 @@ from xero_python.payrolluk.models.benefit_line import BenefitLine from xero_python.payrolluk.models.benefit_object import BenefitObject from xero_python.payrolluk.models.benefits import Benefits +from xero_python.payrolluk.models.contract_type import ContractType +from xero_python.payrolluk.models.contracts import Contracts from xero_python.payrolluk.models.court_order_line import CourtOrderLine from xero_python.payrolluk.models.deduction import Deduction from xero_python.payrolluk.models.deduction_line import DeductionLine from xero_python.payrolluk.models.deduction_object import DeductionObject from xero_python.payrolluk.models.deductions import Deductions +from xero_python.payrolluk.models.developmental_role_details import ( + DevelopmentalRoleDetails, +) from xero_python.payrolluk.models.earnings_line import EarningsLine from xero_python.payrolluk.models.earnings_order import EarningsOrder from xero_python.payrolluk.models.earnings_order_object import EarningsOrderObject @@ -88,6 +93,7 @@ from xero_python.payrolluk.models.employees import Employees from xero_python.payrolluk.models.employment import Employment from xero_python.payrolluk.models.employment_object import EmploymentObject +from xero_python.payrolluk.models.employment_status import EmploymentStatus from xero_python.payrolluk.models.invalid_field import InvalidField from xero_python.payrolluk.models.leave_accrual_line import LeaveAccrualLine from xero_python.payrolluk.models.leave_earnings_line import LeaveEarningsLine @@ -96,6 +102,10 @@ from xero_python.payrolluk.models.leave_type import LeaveType from xero_python.payrolluk.models.leave_type_object import LeaveTypeObject from xero_python.payrolluk.models.leave_types import LeaveTypes +from xero_python.payrolluk.models.ni_category import NICategory +from xero_python.payrolluk.models.ni_category_letter import NICategoryLetter +from xero_python.payrolluk.models.ni_category_one_of import NICategoryOneOf +from xero_python.payrolluk.models.ni_category_one_of1 import NICategoryOneOf1 from xero_python.payrolluk.models.pagination import Pagination from xero_python.payrolluk.models.pay_run import PayRun from xero_python.payrolluk.models.pay_run_calendar import PayRunCalendar diff --git a/xero_python/payrolluk/api/payroll_uk_api.py b/xero_python/payrolluk/api/payroll_uk_api.py index 3b62f12a..2025c28b 100644 --- a/xero_python/payrolluk/api/payroll_uk_api.py +++ b/xero_python/payrolluk/api/payroll_uk_api.py @@ -1,5 +1,16 @@ # coding: utf-8 +import importlib +import re # noqa: F401 + +from xero_python import exceptions +from xero_python.api_client import ApiClient, ModelFinder + +try: + from .exception_handler import translate_status_exception +except ImportError: + translate_status_exception = exceptions.translate_status_exception + """ Xero Payroll UK @@ -10,20 +21,9 @@ """ """ - OpenAPI spec version: 2.19.3 + OpenAPI spec version: 16.2.0 """ -import importlib -import re # noqa: F401 - -from xero_python import exceptions -from xero_python.api_client import ApiClient, ModelFinder - -try: - from .exception_handler import translate_status_exception -except ImportError: - translate_status_exception = exceptions.translate_status_exception - class empty: """empty object to mark optional parameter not set""" @@ -60,6 +60,7 @@ def approve_timesheet( self, xero_tenant_id, timesheet_id, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -68,6 +69,7 @@ def approve_timesheet( OAuth2 scope: payroll.timesheets :param str xero_tenant_id: Xero identifier for Tenant (required) :param str timesheet_id: Identifier for the timesheet (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -98,6 +100,9 @@ def approve_timesheet( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -136,6 +141,7 @@ def create_benefit( self, xero_tenant_id, benefit, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -144,6 +150,7 @@ def create_benefit( OAuth2 scope: payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param Benefit benefit: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -172,6 +179,9 @@ def create_benefit( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -215,6 +225,7 @@ def create_deduction( self, xero_tenant_id, deduction, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -223,6 +234,7 @@ def create_deduction( OAuth2 scope: payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param Deduction deduction: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -251,6 +263,9 @@ def create_deduction( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -294,6 +309,7 @@ def create_earnings_rate( self, xero_tenant_id, earnings_rate, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -302,6 +318,7 @@ def create_earnings_rate( OAuth2 scope: payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param EarningsRate earnings_rate: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -330,6 +347,9 @@ def create_earnings_rate( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -373,6 +393,7 @@ def create_employee( self, xero_tenant_id, employee, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -381,6 +402,7 @@ def create_employee( OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param Employee employee: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -409,6 +431,9 @@ def create_employee( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -453,6 +478,7 @@ def create_employee_earnings_template( xero_tenant_id, employee_id, earnings_template, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -462,6 +488,7 @@ def create_employee_earnings_template( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) :param EarningsTemplate earnings_template: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -498,6 +525,9 @@ def create_employee_earnings_template( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -544,6 +574,7 @@ def create_employee_leave( xero_tenant_id, employee_id, employee_leave, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -553,6 +584,7 @@ def create_employee_leave( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) :param EmployeeLeave employee_leave: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -589,6 +621,9 @@ def create_employee_leave( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -633,6 +668,7 @@ def create_employee_leave_type( xero_tenant_id, employee_id, employee_leave_type, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -642,6 +678,7 @@ def create_employee_leave_type( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) :param EmployeeLeaveType employee_leave_type: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -678,6 +715,9 @@ def create_employee_leave_type( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -722,6 +762,7 @@ def create_employee_opening_balances( xero_tenant_id, employee_id, employee_opening_balances, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -731,6 +772,7 @@ def create_employee_opening_balances( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) :param EmployeeOpeningBalances employee_opening_balances: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -767,6 +809,9 @@ def create_employee_opening_balances( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -813,6 +858,7 @@ def create_employee_payment_method( xero_tenant_id, employee_id, payment_method, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -822,6 +868,7 @@ def create_employee_payment_method( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) :param PaymentMethod payment_method: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -858,6 +905,9 @@ def create_employee_payment_method( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -904,6 +954,7 @@ def create_employee_salary_and_wage( xero_tenant_id, employee_id, salary_and_wage, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -913,6 +964,7 @@ def create_employee_salary_and_wage( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) :param SalaryAndWage salary_and_wage: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -949,6 +1001,9 @@ def create_employee_salary_and_wage( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -994,6 +1049,7 @@ def create_employee_statutory_sick_leave( self, xero_tenant_id, employee_statutory_sick_leave, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1002,6 +1058,7 @@ def create_employee_statutory_sick_leave( OAuth2 scope: payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param EmployeeStatutorySickLeave employee_statutory_sick_leave: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1030,6 +1087,9 @@ def create_employee_statutory_sick_leave( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1076,6 +1136,7 @@ def create_employment( xero_tenant_id, employee_id, employment, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1085,6 +1146,7 @@ def create_employment( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) :param Employment employment: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1121,6 +1183,9 @@ def create_employment( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1164,6 +1229,7 @@ def create_leave_type( self, xero_tenant_id, leave_type, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1172,6 +1238,7 @@ def create_leave_type( OAuth2 scope: payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param LeaveType leave_type: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1200,6 +1267,9 @@ def create_leave_type( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1244,6 +1314,7 @@ def create_multiple_employee_earnings_template( xero_tenant_id, employee_id, earnings_template, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1253,6 +1324,7 @@ def create_multiple_employee_earnings_template( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) :param list[EarningsTemplate] earnings_template: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1289,6 +1361,9 @@ def create_multiple_employee_earnings_template( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1334,6 +1409,7 @@ def create_pay_run_calendar( self, xero_tenant_id, pay_run_calendar, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1342,6 +1418,7 @@ def create_pay_run_calendar( OAuth2 scope: payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param PayRunCalendar pay_run_calendar: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1370,6 +1447,9 @@ def create_pay_run_calendar( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1413,6 +1493,7 @@ def create_reimbursement( self, xero_tenant_id, reimbursement, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1421,6 +1502,7 @@ def create_reimbursement( OAuth2 scope: payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param Reimbursement reimbursement: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1449,6 +1531,9 @@ def create_reimbursement( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1492,6 +1577,7 @@ def create_timesheet( self, xero_tenant_id, timesheet, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1500,6 +1586,7 @@ def create_timesheet( OAuth2 scope: payroll.timesheets :param str xero_tenant_id: Xero identifier for Tenant (required) :param Timesheet timesheet: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1528,6 +1615,9 @@ def create_timesheet( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1572,6 +1662,7 @@ def create_timesheet_line( xero_tenant_id, timesheet_id, timesheet_line, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1581,6 +1672,7 @@ def create_timesheet_line( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str timesheet_id: Identifier for the timesheet (required) :param TimesheetLine timesheet_line: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1617,6 +1709,9 @@ def create_timesheet_line( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -4996,6 +5091,7 @@ def revert_timesheet( self, xero_tenant_id, timesheet_id, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -5004,6 +5100,7 @@ def revert_timesheet( OAuth2 scope: payroll.timesheets :param str xero_tenant_id: Xero identifier for Tenant (required) :param str timesheet_id: Identifier for the timesheet (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -5034,6 +5131,9 @@ def revert_timesheet( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -5073,6 +5173,7 @@ def update_employee( xero_tenant_id, employee_id, employee, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -5082,6 +5183,7 @@ def update_employee( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) :param Employee employee: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -5118,6 +5220,9 @@ def update_employee( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -5163,6 +5268,7 @@ def update_employee_earnings_template( employee_id, pay_template_earning_id, earnings_template, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -5173,6 +5279,7 @@ def update_employee_earnings_template( :param str employee_id: Employee id for single object (required) :param str pay_template_earning_id: Id for single pay template earnings object (required) :param EarningsTemplate earnings_template: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -5216,6 +5323,9 @@ def update_employee_earnings_template( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -5265,6 +5375,7 @@ def update_employee_leave( employee_id, leave_id, employee_leave, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -5275,6 +5386,7 @@ def update_employee_leave( :param str employee_id: Employee id for single object (required) :param str leave_id: Leave id for single object (required) :param EmployeeLeave employee_leave: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -5318,6 +5430,9 @@ def update_employee_leave( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -5362,6 +5477,7 @@ def update_employee_opening_balances( xero_tenant_id, employee_id, employee_opening_balances, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -5371,6 +5487,7 @@ def update_employee_opening_balances( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) :param EmployeeOpeningBalances employee_opening_balances: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -5407,6 +5524,9 @@ def update_employee_opening_balances( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -5454,6 +5574,7 @@ def update_employee_salary_and_wage( employee_id, salary_and_wages_id, salary_and_wage, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -5464,6 +5585,7 @@ def update_employee_salary_and_wage( :param str employee_id: Employee id for single object (required) :param str salary_and_wages_id: Id for single pay template earnings object (required) :param SalaryAndWage salary_and_wage: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -5507,6 +5629,9 @@ def update_employee_salary_and_wage( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -5550,101 +5675,13 @@ def update_employee_salary_and_wage( error, self, "update_employee_salary_and_wage" ) - def update_pay_run( - self, - xero_tenant_id, - pay_run_id, - pay_run, - _return_http_data_only=True, - _preload_content=True, - _request_timeout=None, - ): - """Updates a specific pay run # noqa: E501 - OAuth2 scope: payroll.payruns - :param str xero_tenant_id: Xero identifier for Tenant (required) - :param str pay_run_id: Identifier for the pay run (required) - :param PayRun pay_run: (required) - :param bool _return_http_data_only: return received data only - :param bool _preload_content: load received data in models - :param bool _request_timeout: maximum wait time for response - :return: PayRunObject - """ - - # verify the required parameter 'xero_tenant_id' is set - if xero_tenant_id is None: - raise ValueError( - "Missing the required parameter `xero_tenant_id` " - "when calling `update_pay_run`" - ) - # verify the required parameter 'pay_run_id' is set - if pay_run_id is None: - raise ValueError( - "Missing the required parameter `pay_run_id` " - "when calling `update_pay_run`" - ) - # verify the required parameter 'pay_run' is set - if pay_run is None: - raise ValueError( - "Missing the required parameter `pay_run` " - "when calling `update_pay_run`" - ) - - collection_formats = {} - path_params = { - "PayRunID": pay_run_id, - } - - query_params = [] - - header_params = { - "Xero-Tenant-Id": xero_tenant_id, - } - - local_var_files = {} - form_params = [] - - body_params = pay_run - # HTTP header `Accept` - header_params["Accept"] = self.api_client.select_header_accept( - ["application/json"] - ) - - # HTTP header `Content-Type` - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json"] - ) - - # Authentication setting - auth_settings = ["OAuth2"] - url = self.get_resource_url("/PayRuns/{PayRunID}") - - try: - return self.api_client.call_api( - url, - "PUT", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type="PayRunObject", - response_model_finder=self.get_model_finder(), - auth_settings=auth_settings, - _return_http_data_only=_return_http_data_only, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - collection_formats=collection_formats, - ) - except exceptions.HTTPStatusException as error: - raise translate_status_exception(error, self, "update_pay_run") - def update_timesheet_line( self, xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -5655,6 +5692,7 @@ def update_timesheet_line( :param str timesheet_id: Identifier for the timesheet (required) :param str timesheet_line_id: Identifier for the timesheet line (required) :param TimesheetLine timesheet_line: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -5698,6 +5736,9 @@ def update_timesheet_line( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] diff --git a/xero_python/payrolluk/docs/ContractType.md b/xero_python/payrolluk/docs/ContractType.md new file mode 100644 index 00000000..b968f7d7 --- /dev/null +++ b/xero_python/payrolluk/docs/ContractType.md @@ -0,0 +1,9 @@ +# ContractType + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrolluk/docs/Contracts.md b/xero_python/payrolluk/docs/Contracts.md new file mode 100644 index 00000000..ff0956b6 --- /dev/null +++ b/xero_python/payrolluk/docs/Contracts.md @@ -0,0 +1,16 @@ +# Contracts + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**start_date** | **date** | The contract start date of the employee. This will be locked once an employee has been paid and cannot be changed (YYYY-MM-DD) | +**employment_status** | [**EmploymentStatus**](EmploymentStatus.md) | | +**contract_type** | [**ContractType**](ContractType.md) | | +**public_key** | **str** | The public key of the contract. Public key is required if the intention is to edit an existing contract. If no key is supplied a new contract will be created | [optional] +**is_fixed_term** | **bool** | describes whether the contract is fixed term (required if trying to create Fixed term contract) | [optional] +**fixed_term_end_date** | **date** | The fixed term end date of the employee. Not required if isFixedTerm is false or not provided (required if trying to create Fixed term contract) | [optional] +**developmental_role_details** | [**DevelopmentalRoleDetails**](DevelopmentalRoleDetails.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrolluk/docs/DevelopmentalRoleDetails.md b/xero_python/payrolluk/docs/DevelopmentalRoleDetails.md new file mode 100644 index 00000000..952e7a3d --- /dev/null +++ b/xero_python/payrolluk/docs/DevelopmentalRoleDetails.md @@ -0,0 +1,13 @@ +# DevelopmentalRoleDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**start_date** | **date** | The start date of the developmental role | +**end_date** | **date** | The end date of the developmental role | +**developmental_role** | **str** | The developmental role type - \"Apprentice\" is the only supported role currently | +**public_key** | **str** | The public key of the developmental role. Public key is required if the intention is to edit an existing developmental role. If no key is supplied a new developmental role will be created | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrolluk/docs/Employee.md b/xero_python/payrolluk/docs/Employee.md index 1e709554..7795d2e5 100644 --- a/xero_python/payrolluk/docs/Employee.md +++ b/xero_python/payrolluk/docs/Employee.md @@ -4,21 +4,24 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **employee_id** | **str** | Xero unique identifier for the employee | [optional] -**title** | **str** | Title of the employee | [optional] -**first_name** | **str** | First name of employee | [optional] -**last_name** | **str** | Last name of employee | [optional] -**date_of_birth** | **date** | Date of birth of the employee (YYYY-MM-DD) | [optional] -**address** | [**Address**](Address.md) | | [optional] +**title** | **str** | Title of the employee | +**first_name** | **str** | First name of employee | +**last_name** | **str** | Last name of employee | +**date_of_birth** | **date** | Date of birth of the employee (YYYY-MM-DD) | +**address** | [**Address**](Address.md) | | **email** | **str** | The email address for the employee | [optional] -**gender** | **str** | The employee’s gender | [optional] +**gender** | **str** | The employee’s gender | **phone_number** | **str** | Employee phone number | [optional] **start_date** | **date** | Employment start date of the employee at the time it was requested | [optional] **end_date** | **date** | Employment end date of the employee at the time it was requested | [optional] **payroll_calendar_id** | **str** | Xero unique identifier for the payroll calendar of the employee | [optional] **updated_date_utc** | **datetime** | UTC timestamp of last update to the employee | [optional] **created_date_utc** | **datetime** | UTC timestamp when the employee was created in Xero | [optional] +**ni_category** | [**NICategoryLetter**](NICategoryLetter.md) | | [optional] +**ni_categories** | [**list[NICategory]**](NICategory.md) | The employee's NI categories | [optional] **national_insurance_number** | **str** | National insurance number of the employee | [optional] **is_off_payroll_worker** | **bool** | Whether the employee is an off payroll worker | [optional] +**contracts** | [**list[Contracts]**](Contracts.md) | The employee's contracts | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrolluk/docs/EmployeeLeaveType.md b/xero_python/payrolluk/docs/EmployeeLeaveType.md index 7d0d3c5e..330ae18c 100644 --- a/xero_python/payrolluk/docs/EmployeeLeaveType.md +++ b/xero_python/payrolluk/docs/EmployeeLeaveType.md @@ -9,6 +9,7 @@ Name | Type | Description | Notes **maximum_to_accrue** | **float** | The maximum number of hours that can be accrued for the leave | [optional] **opening_balance** | **float** | The initial number of hours assigned when the leave was added to the employee | [optional] **rate_accrued_hourly** | **float** | The number of hours added to the leave balance for every hour worked by the employee. This is normally 0, unless the scheduleOfAccrual chosen is \"OnHourWorked\" | [optional] +**schedule_of_accrual_date** | **date** | The date when an employee becomes entitled to their accrual. Only applicable when scheduleOfAccrual is \"OnAnniversaryDate\" | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrolluk/docs/EmployeePayTemplate.md b/xero_python/payrolluk/docs/EmployeePayTemplate.md index 6fc2e482..de05e921 100644 --- a/xero_python/payrolluk/docs/EmployeePayTemplate.md +++ b/xero_python/payrolluk/docs/EmployeePayTemplate.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **employee_id** | **str** | Unique identifier for the employee | [optional] -**earning_templates** | [**list[EarningsTemplate]**](EarningsTemplate.md) | | [optional] +**earning_templates** | [**list[EarningsTemplate]**](EarningsTemplate.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrolluk/docs/Employment.md b/xero_python/payrolluk/docs/Employment.md index 596e2c8b..f44edf31 100644 --- a/xero_python/payrolluk/docs/Employment.md +++ b/xero_python/payrolluk/docs/Employment.md @@ -3,10 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**payroll_calendar_id** | **str** | Xero unique identifier for the payroll calendar of the employee | [optional] -**start_date** | **date** | Start date of the employment (YYYY-MM-DD) | [optional] -**employee_number** | **str** | The employment number of the employee | [optional] -**ni_category** | **str** | The NI Category of the employee | [optional] +**payroll_calendar_id** | **str** | Xero unique identifier for the payroll calendar of the employee | +**start_date** | **date** | Start date of the employment (YYYY-MM-DD) | +**employee_number** | **str** | The employment number of the employee | +**ni_category** | [**NICategoryLetter**](NICategoryLetter.md) | | [optional] +**ni_categories** | [**list[NICategory]**](NICategory.md) | The employee's NI categories | +**contracts** | [**list[Contracts]**](Contracts.md) | The employee's contracts | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrolluk/docs/EmploymentStatus.md b/xero_python/payrolluk/docs/EmploymentStatus.md new file mode 100644 index 00000000..05ccec0d --- /dev/null +++ b/xero_python/payrolluk/docs/EmploymentStatus.md @@ -0,0 +1,9 @@ +# EmploymentStatus + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrolluk/docs/NICategory.md b/xero_python/payrolluk/docs/NICategory.md new file mode 100644 index 00000000..a6e44ac7 --- /dev/null +++ b/xero_python/payrolluk/docs/NICategory.md @@ -0,0 +1,14 @@ +# NICategory + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**start_date** | **date** | The start date of the NI category (YYYY-MM-DD) | [optional] +**ni_category** | [**NICategoryLetter**](NICategoryLetter.md) | | +**ni_category_id** | **float** | Xero unique identifier for the NI category | [optional] +**date_first_employed_as_civilian** | **date** | The date in which the employee was first employed as a civilian (YYYY-MM-DD) | [optional] +**workplace_postcode** | **str** | The workplace postcode | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrolluk/docs/NICategoryLetter.md b/xero_python/payrolluk/docs/NICategoryLetter.md new file mode 100644 index 00000000..971bdc23 --- /dev/null +++ b/xero_python/payrolluk/docs/NICategoryLetter.md @@ -0,0 +1,9 @@ +# NICategoryLetter + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrolluk/docs/NICategoryOneOf.md b/xero_python/payrolluk/docs/NICategoryOneOf.md new file mode 100644 index 00000000..3157451c --- /dev/null +++ b/xero_python/payrolluk/docs/NICategoryOneOf.md @@ -0,0 +1,10 @@ +# NICategoryOneOf + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ni_category** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrolluk/docs/NICategoryOneOf1.md b/xero_python/payrolluk/docs/NICategoryOneOf1.md new file mode 100644 index 00000000..1a2cc3a4 --- /dev/null +++ b/xero_python/payrolluk/docs/NICategoryOneOf1.md @@ -0,0 +1,10 @@ +# NICategoryOneOf1 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ni_category** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrolluk/docs/PayrollUkApi.md b/xero_python/payrolluk/docs/PayrollUkApi.md index 89391f7a..bfaf6959 100644 --- a/xero_python/payrolluk/docs/PayrollUkApi.md +++ b/xero_python/payrolluk/docs/PayrollUkApi.md @@ -72,12 +72,11 @@ Method | HTTP request | Description [**update_employee_leave**](PayrollUkApi.md#update_employee_leave) | **PUT** /Employees/{EmployeeID}/Leave/{LeaveID} | Updates a specific employee's leave records [**update_employee_opening_balances**](PayrollUkApi.md#update_employee_opening_balances) | **PUT** /Employees/{EmployeeID}/ukopeningbalances | Updates a specific employee's opening balances [**update_employee_salary_and_wage**](PayrollUkApi.md#update_employee_salary_and_wage) | **PUT** /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID} | Updates salary and wages record for a specific employee -[**update_pay_run**](PayrollUkApi.md#update_pay_run) | **PUT** /PayRuns/{PayRunID} | Updates a specific pay run [**update_timesheet_line**](PayrollUkApi.md#update_timesheet_line) | **PUT** /Timesheets/{TimesheetID}/Lines/{TimesheetLineID} | Updates a specific timesheet line for a specific timesheet # **approve_timesheet** -> TimesheetObject approve_timesheet(xero_tenant_id, timesheet_id) +> TimesheetObject approve_timesheet(xero_tenant_id, timesheet_id, idempotency_key=idempotency_key) Approves a specific timesheet @@ -109,9 +108,10 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Approves a specific timesheet - api_response = api_instance.approve_timesheet(xero_tenant_id, timesheet_id) + api_response = api_instance.approve_timesheet(xero_tenant_id, timesheet_id, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollUkApi->approve_timesheet: %s\n" % e) @@ -123,6 +123,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **timesheet_id** | [**str**](.md)| Identifier for the timesheet | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -140,7 +141,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_benefit** -> BenefitObject create_benefit(xero_tenant_id, benefit) +> BenefitObject create_benefit(xero_tenant_id, benefit, idempotency_key=idempotency_key) Creates a new employee benefit @@ -171,10 +172,11 @@ api_client = ApiClient( api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -benefit = { "name": "My Big Bennie", "category": "StakeholderPension", "liabilityAccountId": "e0faa299-ca0d-4b0a-9e32-0dfabdf9179a", "expenseAccountId": "4b03500d-32fd-4616-8d70-e1e56e0519c6", "standardAmount": 50, "percentage": 25, "calculationType": "PercentageOfGross" } # Benefit | +benefit = {"name":"My Big Bennie","category":"StakeholderPension","liabilityAccountId":"e0faa299-ca0d-4b0a-9e32-0dfabdf9179a","expenseAccountId":"4b03500d-32fd-4616-8d70-e1e56e0519c6","standardAmount":50,"percentage":25,"calculationType":"PercentageOfGross"} # Benefit | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a new employee benefit - api_response = api_instance.create_benefit(xero_tenant_id, benefit) + api_response = api_instance.create_benefit(xero_tenant_id, benefit, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollUkApi->create_benefit: %s\n" % e) @@ -186,6 +188,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **benefit** | [**Benefit**](Benefit.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -203,7 +206,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_deduction** -> DeductionObject create_deduction(xero_tenant_id, deduction) +> DeductionObject create_deduction(xero_tenant_id, deduction, idempotency_key=idempotency_key) Creates a new deduction @@ -234,10 +237,11 @@ api_client = ApiClient( api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -deduction = { "deductionName": "My new deduction", "deductionCategory": "SalarySacrifice", "liabilityAccountId": "e0faa299-ca0d-4b0a-9e32-0dfabdf9179a", "calculationType": "FixedAmount" } # Deduction | +deduction = {"deductionName":"My new deduction","deductionCategory":"SalarySacrifice","liabilityAccountId":"e0faa299-ca0d-4b0a-9e32-0dfabdf9179a","calculationType":"FixedAmount"} # Deduction | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a new deduction - api_response = api_instance.create_deduction(xero_tenant_id, deduction) + api_response = api_instance.create_deduction(xero_tenant_id, deduction, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollUkApi->create_deduction: %s\n" % e) @@ -249,6 +253,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **deduction** | [**Deduction**](Deduction.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -266,7 +271,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_earnings_rate** -> EarningsRateObject create_earnings_rate(xero_tenant_id, earnings_rate) +> EarningsRateObject create_earnings_rate(xero_tenant_id, earnings_rate, idempotency_key=idempotency_key) Creates a new earnings rate @@ -297,10 +302,11 @@ api_client = ApiClient( api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -earnings_rate = { "name": "My Earnings Rate", "earningsType": "RegularEarnings", "rateType": "RatePerUnit", "typeOfUnits": "hours", "expenseAccountID": "4b03500d-32fd-4616-8d70-e1e56e0519c6" } # EarningsRate | +earnings_rate = {"name":"My Earnings Rate","earningsType":"RegularEarnings","rateType":"RatePerUnit","typeOfUnits":"hours","expenseAccountID":"4b03500d-32fd-4616-8d70-e1e56e0519c6"} # EarningsRate | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a new earnings rate - api_response = api_instance.create_earnings_rate(xero_tenant_id, earnings_rate) + api_response = api_instance.create_earnings_rate(xero_tenant_id, earnings_rate, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollUkApi->create_earnings_rate: %s\n" % e) @@ -312,6 +318,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **earnings_rate** | [**EarningsRate**](EarningsRate.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -329,7 +336,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_employee** -> EmployeeObject create_employee(xero_tenant_id, employee) +> EmployeeObject create_employee(xero_tenant_id, employee, idempotency_key=idempotency_key) Creates employees @@ -360,10 +367,11 @@ api_client = ApiClient( api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -employee = { "title":"Mr", "firstName":"Mike", "lastName":"Fancy", "dateOfBirth":"1999-01-01T00:00:00", "gender":"M", "email":"mike@starkindustries.com", "isOffPayrollWorker": false, "address": { "addressLine1": "171 Midsummer", "city": "Milton Keyness", "postCode": "MK9 1EB" } } # Employee | +employee = {"title":"Mr","firstName":"Mike","lastName":"Fancy","dateOfBirth":"1999-01-01T00:00:00Z","gender":"M","email":"mike@starkindustries.com","isOffPayrollWorker":false,"address":{"addressLine1":"171 Midsummer","city":"Milton Keyness","postCode":"MK9 1EB"}} # Employee | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates employees - api_response = api_instance.create_employee(xero_tenant_id, employee) + api_response = api_instance.create_employee(xero_tenant_id, employee, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollUkApi->create_employee: %s\n" % e) @@ -375,6 +383,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **employee** | [**Employee**](Employee.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -392,7 +401,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_employee_earnings_template** -> EarningsTemplateObject create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template) +> EarningsTemplateObject create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template, idempotency_key=idempotency_key) Creates an earnings template records for a specific employee @@ -425,9 +434,10 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object earnings_template = xero_python.payrolluk.EarningsTemplate() # EarningsTemplate | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates an earnings template records for a specific employee - api_response = api_instance.create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template) + api_response = api_instance.create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollUkApi->create_employee_earnings_template: %s\n" % e) @@ -440,6 +450,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **employee_id** | [**str**](.md)| Employee id for single object | **earnings_template** | [**EarningsTemplate**](EarningsTemplate.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -457,7 +468,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_employee_leave** -> EmployeeLeaveObject create_employee_leave(xero_tenant_id, employee_id, employee_leave) +> EmployeeLeaveObject create_employee_leave(xero_tenant_id, employee_id, employee_leave, idempotency_key=idempotency_key) Creates leave records for a specific employee @@ -489,10 +500,11 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object -employee_leave = { "leaveTypeID": "1d2778ee-86ea-45c0-bbf8-1045485f6b3f", "description": "Creating a Description", "startDate": "2020-03-24", "endDate": "2020-03-26" } # EmployeeLeave | +employee_leave = {"leaveTypeID":"1d2778ee-86ea-45c0-bbf8-1045485f6b3f","description":"Creating a Description","startDate":"2020-03-24","endDate":"2020-03-26"} # EmployeeLeave | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates leave records for a specific employee - api_response = api_instance.create_employee_leave(xero_tenant_id, employee_id, employee_leave) + api_response = api_instance.create_employee_leave(xero_tenant_id, employee_id, employee_leave, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollUkApi->create_employee_leave: %s\n" % e) @@ -505,6 +517,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **employee_id** | [**str**](.md)| Employee id for single object | **employee_leave** | [**EmployeeLeave**](EmployeeLeave.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -522,7 +535,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_employee_leave_type** -> EmployeeLeaveTypeObject create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type) +> EmployeeLeaveTypeObject create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type, idempotency_key=idempotency_key) Creates employee leave type records @@ -554,10 +567,11 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object -employee_leave_type = { "leaveTypeID": "4918f233-bd31-43f9-9633-bcc6de1178f2", "scheduleOfAccrual": "BeginningOfCalendarYear", "hoursAccruedAnnually": 10 } # EmployeeLeaveType | +employee_leave_type = {"leaveTypeID":"4918f233-bd31-43f9-9633-bcc6de1178f2","scheduleOfAccrual":"BeginningOfCalendarYear","hoursAccruedAnnually":10} # EmployeeLeaveType | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates employee leave type records - api_response = api_instance.create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type) + api_response = api_instance.create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollUkApi->create_employee_leave_type: %s\n" % e) @@ -570,6 +584,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **employee_id** | [**str**](.md)| Employee id for single object | **employee_leave_type** | [**EmployeeLeaveType**](EmployeeLeaveType.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -587,7 +602,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_employee_opening_balances** -> EmployeeOpeningBalancesObject create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances) +> EmployeeOpeningBalancesObject create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances, idempotency_key=idempotency_key) Creates an opening balance for a specific employee @@ -619,10 +634,11 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object -employee_opening_balances = { "statutoryAdoptionPay": 10, "statutoryMaternityPay": 10, "statutoryPaternityPay": 10, "statutorySharedParentalPay": 10, "statutorySickPay": 10, "priorEmployeeNumber": 10 } # EmployeeOpeningBalances | +employee_opening_balances = {"statutoryAdoptionPay":10,"statutoryMaternityPay":10,"statutoryPaternityPay":10,"statutorySharedParentalPay":10,"statutorySickPay":10,"priorEmployeeNumber":10} # EmployeeOpeningBalances | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates an opening balance for a specific employee - api_response = api_instance.create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances) + api_response = api_instance.create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollUkApi->create_employee_opening_balances: %s\n" % e) @@ -635,6 +651,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **employee_id** | [**str**](.md)| Employee id for single object | **employee_opening_balances** | [**EmployeeOpeningBalances**](EmployeeOpeningBalances.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -652,7 +669,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_employee_payment_method** -> PaymentMethodObject create_employee_payment_method(xero_tenant_id, employee_id, payment_method) +> PaymentMethodObject create_employee_payment_method(xero_tenant_id, employee_id, payment_method, idempotency_key=idempotency_key) Creates an employee payment method @@ -684,10 +701,11 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object -payment_method = { "paymentMethod": "Electronically", "bankAccounts": [ { "accountName": "Sid BofA", "accountNumber": "24987654", "sortCode": "287654" } ] } # PaymentMethod | +payment_method = {"paymentMethod":"Electronically","bankAccounts":[{"accountName":"Sid BofA","accountNumber":"24987654","sortCode":"287654"}]} # PaymentMethod | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates an employee payment method - api_response = api_instance.create_employee_payment_method(xero_tenant_id, employee_id, payment_method) + api_response = api_instance.create_employee_payment_method(xero_tenant_id, employee_id, payment_method, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollUkApi->create_employee_payment_method: %s\n" % e) @@ -700,6 +718,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **employee_id** | [**str**](.md)| Employee id for single object | **payment_method** | [**PaymentMethod**](PaymentMethod.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -717,7 +736,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_employee_salary_and_wage** -> SalaryAndWageObject create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage) +> SalaryAndWageObject create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage, idempotency_key=idempotency_key) Creates a salary and wage record for a specific employee @@ -749,10 +768,11 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object -salary_and_wage = { "earningsRateID": "87f5b43a-cf51-4b74-92de-94c819e82d27", "numberOfUnitsPerWeek": 2, "ratePerUnit": 10, "numberOfUnitsPerDay": 2, "effectiveFrom": "2020-05-01", "annualSalary": 100, "status": "ACTIVE", "paymentType": "Salary" } # SalaryAndWage | +salary_and_wage = {"earningsRateID":"87f5b43a-cf51-4b74-92de-94c819e82d27","numberOfUnitsPerWeek":2,"ratePerUnit":10,"numberOfUnitsPerDay":2,"effectiveFrom":"2020-05-01","annualSalary":100,"status":"ACTIVE","paymentType":"Salary"} # SalaryAndWage | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a salary and wage record for a specific employee - api_response = api_instance.create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage) + api_response = api_instance.create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollUkApi->create_employee_salary_and_wage: %s\n" % e) @@ -765,6 +785,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **employee_id** | [**str**](.md)| Employee id for single object | **salary_and_wage** | [**SalaryAndWage**](SalaryAndWage.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -782,7 +803,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_employee_statutory_sick_leave** -> EmployeeStatutorySickLeaveObject create_employee_statutory_sick_leave(xero_tenant_id, employee_statutory_sick_leave) +> EmployeeStatutorySickLeaveObject create_employee_statutory_sick_leave(xero_tenant_id, employee_statutory_sick_leave, idempotency_key=idempotency_key) Creates statutory sick leave records @@ -813,10 +834,11 @@ api_client = ApiClient( api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -employee_statutory_sick_leave = { "employeeID": "aad6b292-7b94-408b-93f6-e489867e3fb0", "leaveTypeID": "aab78802-e9d3-4bbd-bc87-df858054988f", "startDate": "2020-04-21", "endDate": "2020-04-24", "workPattern": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday" ], "isPregnancyRelated": false, "sufficientNotice": true } # EmployeeStatutorySickLeave | +employee_statutory_sick_leave = {"employeeID":"aad6b292-7b94-408b-93f6-e489867e3fb0","leaveTypeID":"aab78802-e9d3-4bbd-bc87-df858054988f","startDate":"2020-04-21","endDate":"2020-04-24","workPattern":["Monday","Tuesday","Wednesday","Thursday","Friday"],"isPregnancyRelated":false,"sufficientNotice":true} # EmployeeStatutorySickLeave | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates statutory sick leave records - api_response = api_instance.create_employee_statutory_sick_leave(xero_tenant_id, employee_statutory_sick_leave) + api_response = api_instance.create_employee_statutory_sick_leave(xero_tenant_id, employee_statutory_sick_leave, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollUkApi->create_employee_statutory_sick_leave: %s\n" % e) @@ -828,6 +850,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **employee_statutory_sick_leave** | [**EmployeeStatutorySickLeave**](EmployeeStatutorySickLeave.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -845,7 +868,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_employment** -> EmploymentObject create_employment(xero_tenant_id, employee_id, employment) +> EmploymentObject create_employment(xero_tenant_id, employee_id, employment, idempotency_key=idempotency_key) Creates employment detail for a specific employee using a unique employee ID @@ -877,10 +900,11 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object -employment = { "PayrollCalendarID": "216d80e6-af55-47b1-b718-9457c3f5d2fe", "StartDate": "2020-04-01", "EmployeeNumber": "123ABC", "NICategory": "A" } # Employment | +employment = {"payrollCalendarID":"cdfb8371-0b21-4b8a-8903-1024df6c391e","startDate":"2024-04-01","niCategories":[{"niCategory":"I","startDate":"2020-05-01","workplacePostcode":"SW1A 1AA"}],"employeeNumber":"123ABC"} # Employment | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates employment detail for a specific employee using a unique employee ID - api_response = api_instance.create_employment(xero_tenant_id, employee_id, employment) + api_response = api_instance.create_employment(xero_tenant_id, employee_id, employment, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollUkApi->create_employment: %s\n" % e) @@ -893,6 +917,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **employee_id** | [**str**](.md)| Employee id for single object | **employment** | [**Employment**](Employment.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -910,7 +935,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_leave_type** -> LeaveTypeObject create_leave_type(xero_tenant_id, leave_type) +> LeaveTypeObject create_leave_type(xero_tenant_id, leave_type, idempotency_key=idempotency_key) Creates a new leave type @@ -941,10 +966,11 @@ api_client = ApiClient( api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -leave_type = { "name": "My opebvwbfxf Leave", "isPaidLeave": false, "showOnPayslip": true } # LeaveType | +leave_type = {"name":"My opebvwbfxf Leave","isPaidLeave":false,"showOnPayslip":true} # LeaveType | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a new leave type - api_response = api_instance.create_leave_type(xero_tenant_id, leave_type) + api_response = api_instance.create_leave_type(xero_tenant_id, leave_type, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollUkApi->create_leave_type: %s\n" % e) @@ -956,6 +982,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **leave_type** | [**LeaveType**](LeaveType.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -973,7 +1000,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_multiple_employee_earnings_template** -> EmployeePayTemplates create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template) +> EmployeePayTemplates create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template, idempotency_key=idempotency_key) Creates multiple earnings template records for a specific employee using a unique employee ID @@ -1006,9 +1033,10 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object earnings_template = [ { "ratePerUnit":20.0, "numberOfUnits":8.0, "earningsRateID":"87f5b43a-cf51-4b74-92de-94c819e82d27" }, { "ratePerUnit":20.0, "numberOfUnits":8.0, "earningsRateID":"973365f3-66b2-4c33-8ae6-14b75f78f68b" } ] # list[EarningsTemplate] | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates multiple earnings template records for a specific employee using a unique employee ID - api_response = api_instance.create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template) + api_response = api_instance.create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollUkApi->create_multiple_employee_earnings_template: %s\n" % e) @@ -1021,6 +1049,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **employee_id** | [**str**](.md)| Employee id for single object | **earnings_template** | [**list[EarningsTemplate]**](EarningsTemplate.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1038,7 +1067,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_pay_run_calendar** -> PayRunCalendarObject create_pay_run_calendar(xero_tenant_id, pay_run_calendar) +> PayRunCalendarObject create_pay_run_calendar(xero_tenant_id, pay_run_calendar, idempotency_key=idempotency_key) Creates a new payrun calendar @@ -1069,10 +1098,11 @@ api_client = ApiClient( api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -pay_run_calendar = { "name": "My Weekly Cal", "calendarType": "Weekly", "periodStartDate": "2020-05-01", "paymentDate": "2020-05-15" } # PayRunCalendar | +pay_run_calendar = {"name":"My Weekly Cal","calendarType":"Weekly","periodStartDate":"2020-05-01","paymentDate":"2020-05-15"} # PayRunCalendar | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a new payrun calendar - api_response = api_instance.create_pay_run_calendar(xero_tenant_id, pay_run_calendar) + api_response = api_instance.create_pay_run_calendar(xero_tenant_id, pay_run_calendar, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollUkApi->create_pay_run_calendar: %s\n" % e) @@ -1084,6 +1114,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **pay_run_calendar** | [**PayRunCalendar**](PayRunCalendar.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1101,7 +1132,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_reimbursement** -> ReimbursementObject create_reimbursement(xero_tenant_id, reimbursement) +> ReimbursementObject create_reimbursement(xero_tenant_id, reimbursement, idempotency_key=idempotency_key) Creates a new reimbursement @@ -1132,10 +1163,11 @@ api_client = ApiClient( api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -reimbursement = { "name": "My new Reimburse", "accountID": "9ee28149-32a9-4661-8eab-a28738696983" } # Reimbursement | +reimbursement = {"name":"My new Reimburse","accountID":"9ee28149-32a9-4661-8eab-a28738696983"} # Reimbursement | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a new reimbursement - api_response = api_instance.create_reimbursement(xero_tenant_id, reimbursement) + api_response = api_instance.create_reimbursement(xero_tenant_id, reimbursement, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollUkApi->create_reimbursement: %s\n" % e) @@ -1147,6 +1179,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **reimbursement** | [**Reimbursement**](Reimbursement.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1164,7 +1197,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_timesheet** -> TimesheetObject create_timesheet(xero_tenant_id, timesheet) +> TimesheetObject create_timesheet(xero_tenant_id, timesheet, idempotency_key=idempotency_key) Creates a new timesheet @@ -1195,10 +1228,11 @@ api_client = ApiClient( api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -timesheet = { "payrollCalendarID": "216d80e6-af55-47b1-b718-9457c3f5d2fe", "employeeID": "aad6b292-7b94-408b-93f6-e489867e3fb0", "startDate": "2020-04-13", "endDate": "2020-04-19", "timesheetLines": [ { "date": "2020-04-13", "earningsRateID": "87f5b43a-cf51-4b74-92de-94c819e82d27", "numberOfUnits": 8 }, { "date": "2020-04-15", "earningsRateID": "87f5b43a-cf51-4b74-92de-94c819e82d27", "numberOfUnits": 6 } ] } # Timesheet | +timesheet = {"payrollCalendarID":"216d80e6-af55-47b1-b718-9457c3f5d2fe","employeeID":"aad6b292-7b94-408b-93f6-e489867e3fb0","startDate":"2020-04-13","endDate":"2020-04-19","timesheetLines":[{"date":"2020-04-13","earningsRateID":"87f5b43a-cf51-4b74-92de-94c819e82d27","numberOfUnits":8},{"date":"2020-04-15","earningsRateID":"87f5b43a-cf51-4b74-92de-94c819e82d27","numberOfUnits":6}]} # Timesheet | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a new timesheet - api_response = api_instance.create_timesheet(xero_tenant_id, timesheet) + api_response = api_instance.create_timesheet(xero_tenant_id, timesheet, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollUkApi->create_timesheet: %s\n" % e) @@ -1210,6 +1244,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **timesheet** | [**Timesheet**](Timesheet.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1227,7 +1262,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_timesheet_line** -> TimesheetLineObject create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line) +> TimesheetLineObject create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line, idempotency_key=idempotency_key) Creates a new timesheet line for a specific timesheet using a unique timesheet ID @@ -1259,10 +1294,11 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet -timesheet_line = { "date": "2020-04-14", "earningsRateID": "87f5b43a-cf51-4b74-92de-94c819e82d27", "numberOfUnits": 1 } # TimesheetLine | +timesheet_line = {"date":"2020-04-14","earningsRateID":"87f5b43a-cf51-4b74-92de-94c819e82d27","numberOfUnits":1} # TimesheetLine | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a new timesheet line for a specific timesheet using a unique timesheet ID - api_response = api_instance.create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line) + api_response = api_instance.create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollUkApi->create_timesheet_line: %s\n" % e) @@ -1275,6 +1311,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **timesheet_id** | [**str**](.md)| Identifier for the timesheet | **timesheet_line** | [**TimesheetLine**](TimesheetLine.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4037,7 +4074,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **revert_timesheet** -> TimesheetObject revert_timesheet(xero_tenant_id, timesheet_id) +> TimesheetObject revert_timesheet(xero_tenant_id, timesheet_id, idempotency_key=idempotency_key) Reverts a specific timesheet to draft @@ -4069,9 +4106,10 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Reverts a specific timesheet to draft - api_response = api_instance.revert_timesheet(xero_tenant_id, timesheet_id) + api_response = api_instance.revert_timesheet(xero_tenant_id, timesheet_id, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollUkApi->revert_timesheet: %s\n" % e) @@ -4083,6 +4121,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **timesheet_id** | [**str**](.md)| Identifier for the timesheet | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4100,7 +4139,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_employee** -> EmployeeObject update_employee(xero_tenant_id, employee_id, employee) +> EmployeeObject update_employee(xero_tenant_id, employee_id, employee, idempotency_key=idempotency_key) Updates a specific employee's detail @@ -4132,10 +4171,11 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object -employee = { "title": "Mr.", "firstName": "TestDataUK", "lastName": "Tester", "dateOfBirth": "1992-11-22T00:00:00", "gender": "M", "email": "tester@gmail.com", "phoneNumber": "0400123456", "isOffPayrollWorker": false, "address": { "addressLine1": "171 Midsummer", "city": "Milton Keyness", "postCode": "MK9 1EB" } } # Employee | +employee = {"title":"Mr.","firstName":"TestDataUK","lastName":"Tester","dateOfBirth":"1992-11-22T00:00:00Z","gender":"M","email":"tester@gmail.com","phoneNumber":"0400123456","isOffPayrollWorker":false,"address":{"addressLine1":"171 Midsummer","city":"Milton Keyness","postCode":"MK9 1EB"}} # Employee | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a specific employee's detail - api_response = api_instance.update_employee(xero_tenant_id, employee_id, employee) + api_response = api_instance.update_employee(xero_tenant_id, employee_id, employee, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollUkApi->update_employee: %s\n" % e) @@ -4148,6 +4188,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **employee_id** | [**str**](.md)| Employee id for single object | **employee** | [**Employee**](Employee.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4165,7 +4206,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_employee_earnings_template** -> EarningsTemplateObject update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template) +> EarningsTemplateObject update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template, idempotency_key=idempotency_key) Updates a specific employee's earnings template records @@ -4198,10 +4239,11 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object pay_template_earning_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6' # str | Id for single pay template earnings object -earnings_template = { "ratePerUnit": 30, "numberOfUnits": 4, "earningsRateID": "87f5b43a-cf51-4b74-92de-94c819e82d27" } # EarningsTemplate | +earnings_template = {"ratePerUnit":30,"numberOfUnits":4,"earningsRateID":"87f5b43a-cf51-4b74-92de-94c819e82d27"} # EarningsTemplate | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a specific employee's earnings template records - api_response = api_instance.update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template) + api_response = api_instance.update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollUkApi->update_employee_earnings_template: %s\n" % e) @@ -4215,6 +4257,7 @@ Name | Type | Description | Notes **employee_id** | [**str**](.md)| Employee id for single object | **pay_template_earning_id** | [**str**](.md)| Id for single pay template earnings object | **earnings_template** | [**EarningsTemplate**](EarningsTemplate.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4232,7 +4275,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_employee_leave** -> EmployeeLeaveObject update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave) +> EmployeeLeaveObject update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave, idempotency_key=idempotency_key) Updates a specific employee's leave records @@ -4265,10 +4308,11 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object leave_id = 'c4be24e5-e840-4c92-9eaa-2d86cd596314' # str | Leave id for single object -employee_leave = { "leaveTypeID": "ed08dffe-788e-4b24-9630-f0fa2f4d164c", "description": "Creating a Description", "startDate": "2020-04-24", "endDate": "2020-04-26", "periods": [ { "periodStartDate": "2020-04-20", "periodEndDate": "2020-04-26", "numberOfUnits": 1, "periodStatus": "Approved" } ] } # EmployeeLeave | +employee_leave = {"leaveTypeID":"ed08dffe-788e-4b24-9630-f0fa2f4d164c","description":"Creating a Description","startDate":"2020-04-24","endDate":"2020-04-26","periods":[{"periodStartDate":"2020-04-20","periodEndDate":"2020-04-26","numberOfUnits":1,"periodStatus":"Approved"}]} # EmployeeLeave | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a specific employee's leave records - api_response = api_instance.update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave) + api_response = api_instance.update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollUkApi->update_employee_leave: %s\n" % e) @@ -4282,6 +4326,7 @@ Name | Type | Description | Notes **employee_id** | [**str**](.md)| Employee id for single object | **leave_id** | [**str**](.md)| Leave id for single object | **employee_leave** | [**EmployeeLeave**](EmployeeLeave.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4299,7 +4344,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_employee_opening_balances** -> EmployeeOpeningBalancesObject update_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances) +> EmployeeOpeningBalancesObject update_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances, idempotency_key=idempotency_key) Updates a specific employee's opening balances @@ -4331,10 +4376,11 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object -employee_opening_balances = { "statutoryAdoptionPay": 20, "statutoryMaternityPay": 20, "statutoryPaternityPay": 20, "statutorySharedParentalPay": 20, "statutorySickPay": 20, "priorEmployeeNumber": 20 } # EmployeeOpeningBalances | +employee_opening_balances = {"statutoryAdoptionPay":20,"statutoryMaternityPay":20,"statutoryPaternityPay":20,"statutorySharedParentalPay":20,"statutorySickPay":20,"priorEmployeeNumber":20} # EmployeeOpeningBalances | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a specific employee's opening balances - api_response = api_instance.update_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances) + api_response = api_instance.update_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollUkApi->update_employee_opening_balances: %s\n" % e) @@ -4347,6 +4393,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **employee_id** | [**str**](.md)| Employee id for single object | **employee_opening_balances** | [**EmployeeOpeningBalances**](EmployeeOpeningBalances.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4364,7 +4411,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_employee_salary_and_wage** -> SalaryAndWageObject update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage) +> SalaryAndWageObject update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage, idempotency_key=idempotency_key) Updates salary and wages record for a specific employee @@ -4397,10 +4444,11 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object salary_and_wages_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6' # str | Id for single pay template earnings object -salary_and_wage = { "earningsRateID": "87f5b43a-cf51-4b74-92de-94c819e82d27", "numberOfUnitsPerWeek": 3, "ratePerUnit": 11, "effectiveFrom": "2020-05-15", "annualSalary": 101, "status": "ACTIVE", "paymentType": "Salary" } # SalaryAndWage | +salary_and_wage = {"earningsRateID":"87f5b43a-cf51-4b74-92de-94c819e82d27","numberOfUnitsPerWeek":3,"ratePerUnit":11,"effectiveFrom":"2020-05-15","annualSalary":101,"status":"ACTIVE","paymentType":"Salary"} # SalaryAndWage | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates salary and wages record for a specific employee - api_response = api_instance.update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage) + api_response = api_instance.update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollUkApi->update_employee_salary_and_wage: %s\n" % e) @@ -4414,6 +4462,7 @@ Name | Type | Description | Notes **employee_id** | [**str**](.md)| Employee id for single object | **salary_and_wages_id** | [**str**](.md)| Id for single pay template earnings object | **salary_and_wage** | [**SalaryAndWage**](SalaryAndWage.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4430,73 +4479,8 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **update_pay_run** -> PayRunObject update_pay_run(xero_tenant_id, pay_run_id, pay_run) - -Updates a specific pay run - -### Example - -* OAuth Authentication (OAuth2): -```python -from xero_python.api_client import Configuration, ApiClient -from xero_python.api_client.oauth2 import OAuth2Token -from xero_python.exceptions import ApiException -from xero_python.payrolluk import PayrollUkApi -from pprint import pprint - -# Configure OAuth2 access token for authorization: OAuth2 -# simplified version, `xero_oauth2_token` represents permanent global token storage -xero_oauth2_token = {} # set to valid xero oauth2 token dictionary -# create client configuration with client id and client secret for automatic token refresh -api_config = Configuration(oauth2_token=OAuth2Token( - client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" -)) -# configure xero-python sdk client -api_client = ApiClient( - api_config, - oauth2_token_saver=lambda x: xero_oauth2_token.update(x), - oauth2_token_getter=lambda : xero_oauth2_token -) -# create an instance of the API class -api_instance = PayrollUkApi(api_client) - -xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -pay_run_id = 'pay_run_id_example' # str | Identifier for the pay run -pay_run = { "paymentDate": "2020-05-01" } # PayRun | -try: - # Updates a specific pay run - api_response = api_instance.update_pay_run(xero_tenant_id, pay_run_id, pay_run) - pprint(api_response) -except ApiException as e: - print("Exception when calling PayrollUkApi->update_pay_run: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **xero_tenant_id** | **str**| Xero identifier for Tenant | - **pay_run_id** | [**str**](.md)| Identifier for the pay run | - **pay_run** | [**PayRun**](PayRun.md)| | - -### Return type - -[**PayRunObject**](PayRunObject.md) - -### Authorization - -[OAuth2](../README.md#OAuth2) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - # **update_timesheet_line** -> TimesheetLineObject update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line) +> TimesheetLineObject update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, idempotency_key=idempotency_key) Updates a specific timesheet line for a specific timesheet @@ -4529,10 +4513,11 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet timesheet_line_id = 'timesheet_line_id_example' # str | Identifier for the timesheet line -timesheet_line = { "date": "2020-04-14", "earningsRateID": "87f5b43a-cf51-4b74-92de-94c819e82d27", "numberOfUnits": 2 } # TimesheetLine | +timesheet_line = {"date":"2020-04-14","earningsRateID":"87f5b43a-cf51-4b74-92de-94c819e82d27","numberOfUnits":2} # TimesheetLine | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a specific timesheet line for a specific timesheet - api_response = api_instance.update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line) + api_response = api_instance.update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollUkApi->update_timesheet_line: %s\n" % e) @@ -4546,6 +4531,7 @@ Name | Type | Description | Notes **timesheet_id** | [**str**](.md)| Identifier for the timesheet | **timesheet_line_id** | [**str**](.md)| Identifier for the timesheet line | **timesheet_line** | [**TimesheetLine**](TimesheetLine.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type diff --git a/xero_python/payrolluk/models/__init__.py b/xero_python/payrolluk/models/__init__.py index ad69d57c..15156247 100644 --- a/xero_python/payrolluk/models/__init__.py +++ b/xero_python/payrolluk/models/__init__.py @@ -2,12 +2,12 @@ # flake8: noqa """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -20,11 +20,16 @@ from xero_python.payrolluk.models.benefit_line import BenefitLine from xero_python.payrolluk.models.benefit_object import BenefitObject from xero_python.payrolluk.models.benefits import Benefits +from xero_python.payrolluk.models.contract_type import ContractType +from xero_python.payrolluk.models.contracts import Contracts from xero_python.payrolluk.models.court_order_line import CourtOrderLine from xero_python.payrolluk.models.deduction import Deduction from xero_python.payrolluk.models.deduction_line import DeductionLine from xero_python.payrolluk.models.deduction_object import DeductionObject from xero_python.payrolluk.models.deductions import Deductions +from xero_python.payrolluk.models.developmental_role_details import ( + DevelopmentalRoleDetails, +) from xero_python.payrolluk.models.earnings_line import EarningsLine from xero_python.payrolluk.models.earnings_order import EarningsOrder from xero_python.payrolluk.models.earnings_order_object import EarningsOrderObject @@ -83,6 +88,7 @@ from xero_python.payrolluk.models.employees import Employees from xero_python.payrolluk.models.employment import Employment from xero_python.payrolluk.models.employment_object import EmploymentObject +from xero_python.payrolluk.models.employment_status import EmploymentStatus from xero_python.payrolluk.models.invalid_field import InvalidField from xero_python.payrolluk.models.leave_accrual_line import LeaveAccrualLine from xero_python.payrolluk.models.leave_earnings_line import LeaveEarningsLine @@ -91,6 +97,10 @@ from xero_python.payrolluk.models.leave_type import LeaveType from xero_python.payrolluk.models.leave_type_object import LeaveTypeObject from xero_python.payrolluk.models.leave_types import LeaveTypes +from xero_python.payrolluk.models.ni_category import NICategory +from xero_python.payrolluk.models.ni_category_letter import NICategoryLetter +from xero_python.payrolluk.models.ni_category_one_of import NICategoryOneOf +from xero_python.payrolluk.models.ni_category_one_of1 import NICategoryOneOf1 from xero_python.payrolluk.models.pagination import Pagination from xero_python.payrolluk.models.pay_run import PayRun from xero_python.payrolluk.models.pay_run_calendar import PayRunCalendar diff --git a/xero_python/payrolluk/models/account.py b/xero_python/payrolluk/models/account.py index 9d35d8a2..6a2e12e2 100644 --- a/xero_python/payrolluk/models/account.py +++ b/xero_python/payrolluk/models/account.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/accounts.py b/xero_python/payrolluk/models/accounts.py index 6a507062..c8008ce3 100644 --- a/xero_python/payrolluk/models/accounts.py +++ b/xero_python/payrolluk/models/accounts.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/address.py b/xero_python/payrolluk/models/address.py index 5faf7f57..6bd3ef82 100644 --- a/xero_python/payrolluk/models/address.py +++ b/xero_python/payrolluk/models/address.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/bank_account.py b/xero_python/payrolluk/models/bank_account.py index 58e9f2c2..db2b6bd7 100644 --- a/xero_python/payrolluk/models/bank_account.py +++ b/xero_python/payrolluk/models/bank_account.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/benefit.py b/xero_python/payrolluk/models/benefit.py index bb98cc95..e4220b74 100644 --- a/xero_python/payrolluk/models/benefit.py +++ b/xero_python/payrolluk/models/benefit.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/benefit_line.py b/xero_python/payrolluk/models/benefit_line.py index 69598972..4224eb01 100644 --- a/xero_python/payrolluk/models/benefit_line.py +++ b/xero_python/payrolluk/models/benefit_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/benefit_object.py b/xero_python/payrolluk/models/benefit_object.py index f5c66520..7fa0de09 100644 --- a/xero_python/payrolluk/models/benefit_object.py +++ b/xero_python/payrolluk/models/benefit_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/benefits.py b/xero_python/payrolluk/models/benefits.py index 9b72df0b..adade269 100644 --- a/xero_python/payrolluk/models/benefits.py +++ b/xero_python/payrolluk/models/benefits.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/contract_type.py b/xero_python/payrolluk/models/contract_type.py new file mode 100644 index 00000000..9097d9df --- /dev/null +++ b/xero_python/payrolluk/models/contract_type.py @@ -0,0 +1,30 @@ +# coding: utf-8 + +""" +Xero Payroll UK + +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class ContractType(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + FULLTIME = "FullTime" + PARTTIME = "PartTime" + ZEROHOUR = "ZeroHour" + UNSPECIFIED = "Unspecified" diff --git a/xero_python/payrolluk/models/contracts.py b/xero_python/payrolluk/models/contracts.py new file mode 100644 index 00000000..f3bc94ce --- /dev/null +++ b/xero_python/payrolluk/models/contracts.py @@ -0,0 +1,250 @@ +# coding: utf-8 + +""" +Xero Payroll UK + +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class Contracts(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "start_date": "date", + "employment_status": "EmploymentStatus", + "contract_type": "ContractType", + "public_key": "str", + "is_fixed_term": "bool", + "fixed_term_end_date": "date", + "developmental_role_details": "DevelopmentalRoleDetails", + } + + attribute_map = { + "start_date": "startDate", + "employment_status": "employmentStatus", + "contract_type": "contractType", + "public_key": "publicKey", + "is_fixed_term": "isFixedTerm", + "fixed_term_end_date": "fixedTermEndDate", + "developmental_role_details": "developmentalRoleDetails", + } + + def __init__( + self, + start_date=None, + employment_status=None, + contract_type=None, + public_key=None, + is_fixed_term=None, + fixed_term_end_date=None, + developmental_role_details=None, + ): # noqa: E501 + """Contracts - a model defined in OpenAPI""" # noqa: E501 + + self._start_date = None + self._employment_status = None + self._contract_type = None + self._public_key = None + self._is_fixed_term = None + self._fixed_term_end_date = None + self._developmental_role_details = None + self.discriminator = None + + self.start_date = start_date + self.employment_status = employment_status + self.contract_type = contract_type + if public_key is not None: + self.public_key = public_key + if is_fixed_term is not None: + self.is_fixed_term = is_fixed_term + if fixed_term_end_date is not None: + self.fixed_term_end_date = fixed_term_end_date + if developmental_role_details is not None: + self.developmental_role_details = developmental_role_details + + @property + def start_date(self): + """Gets the start_date of this Contracts. # noqa: E501 + + The contract start date of the employee. This will be locked once an employee has been paid and cannot be changed (YYYY-MM-DD) # noqa: E501 + + :return: The start_date of this Contracts. # noqa: E501 + :rtype: date + """ + return self._start_date + + @start_date.setter + def start_date(self, start_date): + """Sets the start_date of this Contracts. + + The contract start date of the employee. This will be locked once an employee has been paid and cannot be changed (YYYY-MM-DD) # noqa: E501 + + :param start_date: The start_date of this Contracts. # noqa: E501 + :type: date + """ + if start_date is None: + raise ValueError( + "Invalid value for `start_date`, must not be `None`" + ) # noqa: E501 + + self._start_date = start_date + + @property + def employment_status(self): + """Gets the employment_status of this Contracts. # noqa: E501 + + + :return: The employment_status of this Contracts. # noqa: E501 + :rtype: EmploymentStatus + """ + return self._employment_status + + @employment_status.setter + def employment_status(self, employment_status): + """Sets the employment_status of this Contracts. + + + :param employment_status: The employment_status of this Contracts. # noqa: E501 + :type: EmploymentStatus + """ + if employment_status is None: + raise ValueError( + "Invalid value for `employment_status`, must not be `None`" + ) # noqa: E501 + + self._employment_status = employment_status + + @property + def contract_type(self): + """Gets the contract_type of this Contracts. # noqa: E501 + + + :return: The contract_type of this Contracts. # noqa: E501 + :rtype: ContractType + """ + return self._contract_type + + @contract_type.setter + def contract_type(self, contract_type): + """Sets the contract_type of this Contracts. + + + :param contract_type: The contract_type of this Contracts. # noqa: E501 + :type: ContractType + """ + if contract_type is None: + raise ValueError( + "Invalid value for `contract_type`, must not be `None`" + ) # noqa: E501 + + self._contract_type = contract_type + + @property + def public_key(self): + """Gets the public_key of this Contracts. # noqa: E501 + + The public key of the contract. Public key is required if the intention is to edit an existing contract. If no key is supplied a new contract will be created # noqa: E501 + + :return: The public_key of this Contracts. # noqa: E501 + :rtype: str + """ + return self._public_key + + @public_key.setter + def public_key(self, public_key): + """Sets the public_key of this Contracts. + + The public key of the contract. Public key is required if the intention is to edit an existing contract. If no key is supplied a new contract will be created # noqa: E501 + + :param public_key: The public_key of this Contracts. # noqa: E501 + :type: str + """ + + self._public_key = public_key + + @property + def is_fixed_term(self): + """Gets the is_fixed_term of this Contracts. # noqa: E501 + + describes whether the contract is fixed term (required if trying to create Fixed term contract) # noqa: E501 + + :return: The is_fixed_term of this Contracts. # noqa: E501 + :rtype: bool + """ + return self._is_fixed_term + + @is_fixed_term.setter + def is_fixed_term(self, is_fixed_term): + """Sets the is_fixed_term of this Contracts. + + describes whether the contract is fixed term (required if trying to create Fixed term contract) # noqa: E501 + + :param is_fixed_term: The is_fixed_term of this Contracts. # noqa: E501 + :type: bool + """ + + self._is_fixed_term = is_fixed_term + + @property + def fixed_term_end_date(self): + """Gets the fixed_term_end_date of this Contracts. # noqa: E501 + + The fixed term end date of the employee. Not required if isFixedTerm is false or not provided (required if trying to create Fixed term contract) # noqa: E501 + + :return: The fixed_term_end_date of this Contracts. # noqa: E501 + :rtype: date + """ + return self._fixed_term_end_date + + @fixed_term_end_date.setter + def fixed_term_end_date(self, fixed_term_end_date): + """Sets the fixed_term_end_date of this Contracts. + + The fixed term end date of the employee. Not required if isFixedTerm is false or not provided (required if trying to create Fixed term contract) # noqa: E501 + + :param fixed_term_end_date: The fixed_term_end_date of this Contracts. # noqa: E501 + :type: date + """ + + self._fixed_term_end_date = fixed_term_end_date + + @property + def developmental_role_details(self): + """Gets the developmental_role_details of this Contracts. # noqa: E501 + + + :return: The developmental_role_details of this Contracts. # noqa: E501 + :rtype: DevelopmentalRoleDetails + """ + return self._developmental_role_details + + @developmental_role_details.setter + def developmental_role_details(self, developmental_role_details): + """Sets the developmental_role_details of this Contracts. + + + :param developmental_role_details: The developmental_role_details of this Contracts. # noqa: E501 + :type: DevelopmentalRoleDetails + """ + + self._developmental_role_details = developmental_role_details diff --git a/xero_python/payrolluk/models/court_order_line.py b/xero_python/payrolluk/models/court_order_line.py index 22c15b28..921c661e 100644 --- a/xero_python/payrolluk/models/court_order_line.py +++ b/xero_python/payrolluk/models/court_order_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/deduction.py b/xero_python/payrolluk/models/deduction.py index 8afb6bf4..6c78d730 100644 --- a/xero_python/payrolluk/models/deduction.py +++ b/xero_python/payrolluk/models/deduction.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/deduction_line.py b/xero_python/payrolluk/models/deduction_line.py index b1a7c593..032dee71 100644 --- a/xero_python/payrolluk/models/deduction_line.py +++ b/xero_python/payrolluk/models/deduction_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/deduction_object.py b/xero_python/payrolluk/models/deduction_object.py index 1361638e..9abebf9e 100644 --- a/xero_python/payrolluk/models/deduction_object.py +++ b/xero_python/payrolluk/models/deduction_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/deductions.py b/xero_python/payrolluk/models/deductions.py index 1a0a88c6..0fd7c65a 100644 --- a/xero_python/payrolluk/models/deductions.py +++ b/xero_python/payrolluk/models/deductions.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/developmental_role_details.py b/xero_python/payrolluk/models/developmental_role_details.py new file mode 100644 index 00000000..9b43e009 --- /dev/null +++ b/xero_python/payrolluk/models/developmental_role_details.py @@ -0,0 +1,165 @@ +# coding: utf-8 + +""" +Xero Payroll UK + +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class DevelopmentalRoleDetails(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "start_date": "date", + "end_date": "date", + "developmental_role": "str", + "public_key": "str", + } + + attribute_map = { + "start_date": "startDate", + "end_date": "endDate", + "developmental_role": "developmentalRole", + "public_key": "publicKey", + } + + def __init__( + self, start_date=None, end_date=None, developmental_role=None, public_key=None + ): # noqa: E501 + """DevelopmentalRoleDetails - a model defined in OpenAPI""" # noqa: E501 + + self._start_date = None + self._end_date = None + self._developmental_role = None + self._public_key = None + self.discriminator = None + + self.start_date = start_date + self.end_date = end_date + self.developmental_role = developmental_role + if public_key is not None: + self.public_key = public_key + + @property + def start_date(self): + """Gets the start_date of this DevelopmentalRoleDetails. # noqa: E501 + + The start date of the developmental role # noqa: E501 + + :return: The start_date of this DevelopmentalRoleDetails. # noqa: E501 + :rtype: date + """ + return self._start_date + + @start_date.setter + def start_date(self, start_date): + """Sets the start_date of this DevelopmentalRoleDetails. + + The start date of the developmental role # noqa: E501 + + :param start_date: The start_date of this DevelopmentalRoleDetails. # noqa: E501 + :type: date + """ + if start_date is None: + raise ValueError( + "Invalid value for `start_date`, must not be `None`" + ) # noqa: E501 + + self._start_date = start_date + + @property + def end_date(self): + """Gets the end_date of this DevelopmentalRoleDetails. # noqa: E501 + + The end date of the developmental role # noqa: E501 + + :return: The end_date of this DevelopmentalRoleDetails. # noqa: E501 + :rtype: date + """ + return self._end_date + + @end_date.setter + def end_date(self, end_date): + """Sets the end_date of this DevelopmentalRoleDetails. + + The end date of the developmental role # noqa: E501 + + :param end_date: The end_date of this DevelopmentalRoleDetails. # noqa: E501 + :type: date + """ + if end_date is None: + raise ValueError( + "Invalid value for `end_date`, must not be `None`" + ) # noqa: E501 + + self._end_date = end_date + + @property + def developmental_role(self): + """Gets the developmental_role of this DevelopmentalRoleDetails. # noqa: E501 + + The developmental role type - \"Apprentice\" is the only supported role currently # noqa: E501 + + :return: The developmental_role of this DevelopmentalRoleDetails. # noqa: E501 + :rtype: str + """ + return self._developmental_role + + @developmental_role.setter + def developmental_role(self, developmental_role): + """Sets the developmental_role of this DevelopmentalRoleDetails. + + The developmental role type - \"Apprentice\" is the only supported role currently # noqa: E501 + + :param developmental_role: The developmental_role of this DevelopmentalRoleDetails. # noqa: E501 + :type: str + """ + if developmental_role is None: + raise ValueError( + "Invalid value for `developmental_role`, must not be `None`" + ) # noqa: E501 + + self._developmental_role = developmental_role + + @property + def public_key(self): + """Gets the public_key of this DevelopmentalRoleDetails. # noqa: E501 + + The public key of the developmental role. Public key is required if the intention is to edit an existing developmental role. If no key is supplied a new developmental role will be created # noqa: E501 + + :return: The public_key of this DevelopmentalRoleDetails. # noqa: E501 + :rtype: str + """ + return self._public_key + + @public_key.setter + def public_key(self, public_key): + """Sets the public_key of this DevelopmentalRoleDetails. + + The public key of the developmental role. Public key is required if the intention is to edit an existing developmental role. If no key is supplied a new developmental role will be created # noqa: E501 + + :param public_key: The public_key of this DevelopmentalRoleDetails. # noqa: E501 + :type: str + """ + + self._public_key = public_key diff --git a/xero_python/payrolluk/models/earnings_line.py b/xero_python/payrolluk/models/earnings_line.py index 0f6feb71..601ab54c 100644 --- a/xero_python/payrolluk/models/earnings_line.py +++ b/xero_python/payrolluk/models/earnings_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/earnings_order.py b/xero_python/payrolluk/models/earnings_order.py index 5faa8aad..14cca1b0 100644 --- a/xero_python/payrolluk/models/earnings_order.py +++ b/xero_python/payrolluk/models/earnings_order.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/earnings_order_object.py b/xero_python/payrolluk/models/earnings_order_object.py index 82822abc..c65425b1 100644 --- a/xero_python/payrolluk/models/earnings_order_object.py +++ b/xero_python/payrolluk/models/earnings_order_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/earnings_orders.py b/xero_python/payrolluk/models/earnings_orders.py index 4e104a76..ac696e62 100644 --- a/xero_python/payrolluk/models/earnings_orders.py +++ b/xero_python/payrolluk/models/earnings_orders.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/earnings_rate.py b/xero_python/payrolluk/models/earnings_rate.py index f88b9b81..7c4277cb 100644 --- a/xero_python/payrolluk/models/earnings_rate.py +++ b/xero_python/payrolluk/models/earnings_rate.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -174,7 +174,7 @@ def earnings_type(self, earnings_type): ) # noqa: E501 allowed_values = [ "Allowance", - "Backpay", + "BackPay", "Bonus", "Commission", "LumpSum", @@ -196,6 +196,9 @@ def earnings_type(self, earnings_type): "TipsNonDirect", "TipsDirect", "TerminationPay", + "StatutoryNeonatalCarePay", + "StatutoryNeonatalCarePayNonPensionable", + "StatutoryBereavementPayNorthernIreland", "None", ] # noqa: E501 diff --git a/xero_python/payrolluk/models/earnings_rate_object.py b/xero_python/payrolluk/models/earnings_rate_object.py index d469f668..782a87d2 100644 --- a/xero_python/payrolluk/models/earnings_rate_object.py +++ b/xero_python/payrolluk/models/earnings_rate_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/earnings_rates.py b/xero_python/payrolluk/models/earnings_rates.py index 2200b480..1bea527d 100644 --- a/xero_python/payrolluk/models/earnings_rates.py +++ b/xero_python/payrolluk/models/earnings_rates.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/earnings_template.py b/xero_python/payrolluk/models/earnings_template.py index 12282cd0..d619e049 100644 --- a/xero_python/payrolluk/models/earnings_template.py +++ b/xero_python/payrolluk/models/earnings_template.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/earnings_template_object.py b/xero_python/payrolluk/models/earnings_template_object.py index 3f5e0856..a72421b2 100644 --- a/xero_python/payrolluk/models/earnings_template_object.py +++ b/xero_python/payrolluk/models/earnings_template_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee.py b/xero_python/payrolluk/models/employee.py index 6cfe8136..9424f783 100644 --- a/xero_python/payrolluk/models/employee.py +++ b/xero_python/payrolluk/models/employee.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -44,8 +44,11 @@ class Employee(BaseModel): "payroll_calendar_id": "str", "updated_date_utc": "datetime", "created_date_utc": "datetime", + "ni_category": "NICategoryLetter", + "ni_categories": "list[NICategory]", "national_insurance_number": "str", "is_off_payroll_worker": "bool", + "contracts": "list[Contracts]", } attribute_map = { @@ -63,8 +66,11 @@ class Employee(BaseModel): "payroll_calendar_id": "payrollCalendarID", "updated_date_utc": "updatedDateUTC", "created_date_utc": "createdDateUTC", + "ni_category": "niCategory", + "ni_categories": "niCategories", "national_insurance_number": "nationalInsuranceNumber", "is_off_payroll_worker": "isOffPayrollWorker", + "contracts": "contracts", } def __init__( @@ -83,8 +89,11 @@ def __init__( payroll_calendar_id=None, updated_date_utc=None, created_date_utc=None, + ni_category=None, + ni_categories=None, national_insurance_number=None, is_off_payroll_worker=None, + contracts=None, ): # noqa: E501 """Employee - a model defined in OpenAPI""" # noqa: E501 @@ -102,26 +111,23 @@ def __init__( self._payroll_calendar_id = None self._updated_date_utc = None self._created_date_utc = None + self._ni_category = None + self._ni_categories = None self._national_insurance_number = None self._is_off_payroll_worker = None + self._contracts = None self.discriminator = None if employee_id is not None: self.employee_id = employee_id - if title is not None: - self.title = title - if first_name is not None: - self.first_name = first_name - if last_name is not None: - self.last_name = last_name - if date_of_birth is not None: - self.date_of_birth = date_of_birth - if address is not None: - self.address = address + self.title = title + self.first_name = first_name + self.last_name = last_name + self.date_of_birth = date_of_birth + self.address = address if email is not None: self.email = email - if gender is not None: - self.gender = gender + self.gender = gender if phone_number is not None: self.phone_number = phone_number if start_date is not None: @@ -134,10 +140,16 @@ def __init__( self.updated_date_utc = updated_date_utc if created_date_utc is not None: self.created_date_utc = created_date_utc + if ni_category is not None: + self.ni_category = ni_category + if ni_categories is not None: + self.ni_categories = ni_categories if national_insurance_number is not None: self.national_insurance_number = national_insurance_number if is_off_payroll_worker is not None: self.is_off_payroll_worker = is_off_payroll_worker + if contracts is not None: + self.contracts = contracts @property def employee_id(self): @@ -182,6 +194,10 @@ def title(self, title): :param title: The title of this Employee. # noqa: E501 :type: str """ + if title is None: + raise ValueError( + "Invalid value for `title`, must not be `None`" + ) # noqa: E501 self._title = title @@ -205,6 +221,10 @@ def first_name(self, first_name): :param first_name: The first_name of this Employee. # noqa: E501 :type: str """ + if first_name is None: + raise ValueError( + "Invalid value for `first_name`, must not be `None`" + ) # noqa: E501 self._first_name = first_name @@ -228,6 +248,10 @@ def last_name(self, last_name): :param last_name: The last_name of this Employee. # noqa: E501 :type: str """ + if last_name is None: + raise ValueError( + "Invalid value for `last_name`, must not be `None`" + ) # noqa: E501 self._last_name = last_name @@ -251,6 +275,10 @@ def date_of_birth(self, date_of_birth): :param date_of_birth: The date_of_birth of this Employee. # noqa: E501 :type: date """ + if date_of_birth is None: + raise ValueError( + "Invalid value for `date_of_birth`, must not be `None`" + ) # noqa: E501 self._date_of_birth = date_of_birth @@ -272,6 +300,10 @@ def address(self, address): :param address: The address of this Employee. # noqa: E501 :type: Address """ + if address is None: + raise ValueError( + "Invalid value for `address`, must not be `None`" + ) # noqa: E501 self._address = address @@ -318,6 +350,10 @@ def gender(self, gender): :param gender: The gender of this Employee. # noqa: E501 :type: str """ + if gender is None: + raise ValueError( + "Invalid value for `gender`, must not be `None`" + ) # noqa: E501 allowed_values = ["M", "F", "None"] # noqa: E501 if gender: @@ -468,6 +504,50 @@ def created_date_utc(self, created_date_utc): self._created_date_utc = created_date_utc + @property + def ni_category(self): + """Gets the ni_category of this Employee. # noqa: E501 + + + :return: The ni_category of this Employee. # noqa: E501 + :rtype: NICategoryLetter + """ + return self._ni_category + + @ni_category.setter + def ni_category(self, ni_category): + """Sets the ni_category of this Employee. + + + :param ni_category: The ni_category of this Employee. # noqa: E501 + :type: NICategoryLetter + """ + + self._ni_category = ni_category + + @property + def ni_categories(self): + """Gets the ni_categories of this Employee. # noqa: E501 + + The employee's NI categories # noqa: E501 + + :return: The ni_categories of this Employee. # noqa: E501 + :rtype: list[NICategory] + """ + return self._ni_categories + + @ni_categories.setter + def ni_categories(self, ni_categories): + """Sets the ni_categories of this Employee. + + The employee's NI categories # noqa: E501 + + :param ni_categories: The ni_categories of this Employee. # noqa: E501 + :type: list[NICategory] + """ + + self._ni_categories = ni_categories + @property def national_insurance_number(self): """Gets the national_insurance_number of this Employee. # noqa: E501 @@ -513,3 +593,26 @@ def is_off_payroll_worker(self, is_off_payroll_worker): """ self._is_off_payroll_worker = is_off_payroll_worker + + @property + def contracts(self): + """Gets the contracts of this Employee. # noqa: E501 + + The employee's contracts # noqa: E501 + + :return: The contracts of this Employee. # noqa: E501 + :rtype: list[Contracts] + """ + return self._contracts + + @contracts.setter + def contracts(self, contracts): + """Sets the contracts of this Employee. + + The employee's contracts # noqa: E501 + + :param contracts: The contracts of this Employee. # noqa: E501 + :type: list[Contracts] + """ + + self._contracts = contracts diff --git a/xero_python/payrolluk/models/employee_leave.py b/xero_python/payrolluk/models/employee_leave.py index 4d2dafc6..67213792 100644 --- a/xero_python/payrolluk/models/employee_leave.py +++ b/xero_python/payrolluk/models/employee_leave.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_leave_balance.py b/xero_python/payrolluk/models/employee_leave_balance.py index 9f12cd9d..bba26239 100644 --- a/xero_python/payrolluk/models/employee_leave_balance.py +++ b/xero_python/payrolluk/models/employee_leave_balance.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_leave_balances.py b/xero_python/payrolluk/models/employee_leave_balances.py index 2ad547a2..4f5d2781 100644 --- a/xero_python/payrolluk/models/employee_leave_balances.py +++ b/xero_python/payrolluk/models/employee_leave_balances.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_leave_object.py b/xero_python/payrolluk/models/employee_leave_object.py index 2db020d6..b687fefe 100644 --- a/xero_python/payrolluk/models/employee_leave_object.py +++ b/xero_python/payrolluk/models/employee_leave_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_leave_type.py b/xero_python/payrolluk/models/employee_leave_type.py index c78c577a..0333c790 100644 --- a/xero_python/payrolluk/models/employee_leave_type.py +++ b/xero_python/payrolluk/models/employee_leave_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -36,6 +36,7 @@ class EmployeeLeaveType(BaseModel): "maximum_to_accrue": "float", "opening_balance": "float", "rate_accrued_hourly": "float", + "schedule_of_accrual_date": "date", } attribute_map = { @@ -45,6 +46,7 @@ class EmployeeLeaveType(BaseModel): "maximum_to_accrue": "maximumToAccrue", "opening_balance": "openingBalance", "rate_accrued_hourly": "rateAccruedHourly", + "schedule_of_accrual_date": "scheduleOfAccrualDate", } def __init__( @@ -55,6 +57,7 @@ def __init__( maximum_to_accrue=None, opening_balance=None, rate_accrued_hourly=None, + schedule_of_accrual_date=None, ): # noqa: E501 """EmployeeLeaveType - a model defined in OpenAPI""" # noqa: E501 @@ -64,6 +67,7 @@ def __init__( self._maximum_to_accrue = None self._opening_balance = None self._rate_accrued_hourly = None + self._schedule_of_accrual_date = None self.discriminator = None self.leave_type_id = leave_type_id @@ -76,6 +80,8 @@ def __init__( self.opening_balance = opening_balance if rate_accrued_hourly is not None: self.rate_accrued_hourly = rate_accrued_hourly + if schedule_of_accrual_date is not None: + self.schedule_of_accrual_date = schedule_of_accrual_date @property def leave_type_id(self): @@ -237,3 +243,26 @@ def rate_accrued_hourly(self, rate_accrued_hourly): """ self._rate_accrued_hourly = rate_accrued_hourly + + @property + def schedule_of_accrual_date(self): + """Gets the schedule_of_accrual_date of this EmployeeLeaveType. # noqa: E501 + + The date when an employee becomes entitled to their accrual. Only applicable when scheduleOfAccrual is \"OnAnniversaryDate\" # noqa: E501 + + :return: The schedule_of_accrual_date of this EmployeeLeaveType. # noqa: E501 + :rtype: date + """ + return self._schedule_of_accrual_date + + @schedule_of_accrual_date.setter + def schedule_of_accrual_date(self, schedule_of_accrual_date): + """Sets the schedule_of_accrual_date of this EmployeeLeaveType. + + The date when an employee becomes entitled to their accrual. Only applicable when scheduleOfAccrual is \"OnAnniversaryDate\" # noqa: E501 + + :param schedule_of_accrual_date: The schedule_of_accrual_date of this EmployeeLeaveType. # noqa: E501 + :type: date + """ + + self._schedule_of_accrual_date = schedule_of_accrual_date diff --git a/xero_python/payrolluk/models/employee_leave_type_object.py b/xero_python/payrolluk/models/employee_leave_type_object.py index 352b44d1..6cbd6e25 100644 --- a/xero_python/payrolluk/models/employee_leave_type_object.py +++ b/xero_python/payrolluk/models/employee_leave_type_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_leave_types.py b/xero_python/payrolluk/models/employee_leave_types.py index 72e821f5..06ad93eb 100644 --- a/xero_python/payrolluk/models/employee_leave_types.py +++ b/xero_python/payrolluk/models/employee_leave_types.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_leaves.py b/xero_python/payrolluk/models/employee_leaves.py index bb546eb7..a4fe9ed2 100644 --- a/xero_python/payrolluk/models/employee_leaves.py +++ b/xero_python/payrolluk/models/employee_leaves.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_object.py b/xero_python/payrolluk/models/employee_object.py index d2530f9f..4d468a78 100644 --- a/xero_python/payrolluk/models/employee_object.py +++ b/xero_python/payrolluk/models/employee_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_opening_balances.py b/xero_python/payrolluk/models/employee_opening_balances.py index 36a8d1d3..06cd567c 100644 --- a/xero_python/payrolluk/models/employee_opening_balances.py +++ b/xero_python/payrolluk/models/employee_opening_balances.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_opening_balances_object.py b/xero_python/payrolluk/models/employee_opening_balances_object.py index d289daeb..741bf863 100644 --- a/xero_python/payrolluk/models/employee_opening_balances_object.py +++ b/xero_python/payrolluk/models/employee_opening_balances_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_pay_template.py b/xero_python/payrolluk/models/employee_pay_template.py index 800ae4b5..4a60b60f 100644 --- a/xero_python/payrolluk/models/employee_pay_template.py +++ b/xero_python/payrolluk/models/employee_pay_template.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -48,8 +48,7 @@ def __init__(self, employee_id=None, earning_templates=None): # noqa: E501 if employee_id is not None: self.employee_id = employee_id - if earning_templates is not None: - self.earning_templates = earning_templates + self.earning_templates = earning_templates @property def employee_id(self): @@ -92,5 +91,9 @@ def earning_templates(self, earning_templates): :param earning_templates: The earning_templates of this EmployeePayTemplate. # noqa: E501 :type: list[EarningsTemplate] """ + if earning_templates is None: + raise ValueError( + "Invalid value for `earning_templates`, must not be `None`" + ) # noqa: E501 self._earning_templates = earning_templates diff --git a/xero_python/payrolluk/models/employee_pay_template_object.py b/xero_python/payrolluk/models/employee_pay_template_object.py index 657ae88f..dc7f91db 100644 --- a/xero_python/payrolluk/models/employee_pay_template_object.py +++ b/xero_python/payrolluk/models/employee_pay_template_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_pay_templates.py b/xero_python/payrolluk/models/employee_pay_templates.py index 9c9867bf..897d0a21 100644 --- a/xero_python/payrolluk/models/employee_pay_templates.py +++ b/xero_python/payrolluk/models/employee_pay_templates.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_statutory_leave_balance.py b/xero_python/payrolluk/models/employee_statutory_leave_balance.py index a88f6af1..dcea0cd7 100644 --- a/xero_python/payrolluk/models/employee_statutory_leave_balance.py +++ b/xero_python/payrolluk/models/employee_statutory_leave_balance.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -80,6 +80,8 @@ def leave_type(self, leave_type): "Maternity", "Paternity", "Sharedparental", + "Bereavement", + "NeonatalCare", "None", ] # noqa: E501 diff --git a/xero_python/payrolluk/models/employee_statutory_leave_balance_object.py b/xero_python/payrolluk/models/employee_statutory_leave_balance_object.py index 809f4f7d..baebddae 100644 --- a/xero_python/payrolluk/models/employee_statutory_leave_balance_object.py +++ b/xero_python/payrolluk/models/employee_statutory_leave_balance_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_statutory_leave_summary.py b/xero_python/payrolluk/models/employee_statutory_leave_summary.py index 847dc5ac..4c67e810 100644 --- a/xero_python/payrolluk/models/employee_statutory_leave_summary.py +++ b/xero_python/payrolluk/models/employee_statutory_leave_summary.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -157,6 +157,9 @@ def type(self, type): "Maternity", "Paternity", "Sharedparental", + "Bereavement", + "NeonatalCare", + "BereavementNire", "None", ] # noqa: E501 diff --git a/xero_python/payrolluk/models/employee_statutory_leaves_summaries.py b/xero_python/payrolluk/models/employee_statutory_leaves_summaries.py index 960dc00b..0b6f2074 100644 --- a/xero_python/payrolluk/models/employee_statutory_leaves_summaries.py +++ b/xero_python/payrolluk/models/employee_statutory_leaves_summaries.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_statutory_sick_leave.py b/xero_python/payrolluk/models/employee_statutory_sick_leave.py index 98306902..49e80eec 100644 --- a/xero_python/payrolluk/models/employee_statutory_sick_leave.py +++ b/xero_python/payrolluk/models/employee_statutory_sick_leave.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_statutory_sick_leave_object.py b/xero_python/payrolluk/models/employee_statutory_sick_leave_object.py index 9dcc9f61..66a09f05 100644 --- a/xero_python/payrolluk/models/employee_statutory_sick_leave_object.py +++ b/xero_python/payrolluk/models/employee_statutory_sick_leave_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_statutory_sick_leaves.py b/xero_python/payrolluk/models/employee_statutory_sick_leaves.py index 03deef03..bb19dcc8 100644 --- a/xero_python/payrolluk/models/employee_statutory_sick_leaves.py +++ b/xero_python/payrolluk/models/employee_statutory_sick_leaves.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_tax.py b/xero_python/payrolluk/models/employee_tax.py index 907cb863..365bbb28 100644 --- a/xero_python/payrolluk/models/employee_tax.py +++ b/xero_python/payrolluk/models/employee_tax.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_tax_object.py b/xero_python/payrolluk/models/employee_tax_object.py index 88381c48..b2891ca0 100644 --- a/xero_python/payrolluk/models/employee_tax_object.py +++ b/xero_python/payrolluk/models/employee_tax_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employees.py b/xero_python/payrolluk/models/employees.py index 6bc094f7..45905504 100644 --- a/xero_python/payrolluk/models/employees.py +++ b/xero_python/payrolluk/models/employees.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employment.py b/xero_python/payrolluk/models/employment.py index d31b4a1d..a350aa9c 100644 --- a/xero_python/payrolluk/models/employment.py +++ b/xero_python/payrolluk/models/employment.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -33,7 +33,9 @@ class Employment(BaseModel): "payroll_calendar_id": "str", "start_date": "date", "employee_number": "str", - "ni_category": "str", + "ni_category": "NICategoryLetter", + "ni_categories": "list[NICategory]", + "contracts": "list[Contracts]", } attribute_map = { @@ -41,6 +43,8 @@ class Employment(BaseModel): "start_date": "startDate", "employee_number": "employeeNumber", "ni_category": "niCategory", + "ni_categories": "niCategories", + "contracts": "contracts", } def __init__( @@ -49,6 +53,8 @@ def __init__( start_date=None, employee_number=None, ni_category=None, + ni_categories=None, + contracts=None, ): # noqa: E501 """Employment - a model defined in OpenAPI""" # noqa: E501 @@ -56,16 +62,18 @@ def __init__( self._start_date = None self._employee_number = None self._ni_category = None + self._ni_categories = None + self._contracts = None self.discriminator = None - if payroll_calendar_id is not None: - self.payroll_calendar_id = payroll_calendar_id - if start_date is not None: - self.start_date = start_date - if employee_number is not None: - self.employee_number = employee_number + self.payroll_calendar_id = payroll_calendar_id + self.start_date = start_date + self.employee_number = employee_number if ni_category is not None: self.ni_category = ni_category + self.ni_categories = ni_categories + if contracts is not None: + self.contracts = contracts @property def payroll_calendar_id(self): @@ -87,6 +95,10 @@ def payroll_calendar_id(self, payroll_calendar_id): :param payroll_calendar_id: The payroll_calendar_id of this Employment. # noqa: E501 :type: str """ + if payroll_calendar_id is None: + raise ValueError( + "Invalid value for `payroll_calendar_id`, must not be `None`" + ) # noqa: E501 self._payroll_calendar_id = payroll_calendar_id @@ -110,6 +122,10 @@ def start_date(self, start_date): :param start_date: The start_date of this Employment. # noqa: E501 :type: date """ + if start_date is None: + raise ValueError( + "Invalid value for `start_date`, must not be `None`" + ) # noqa: E501 self._start_date = start_date @@ -133,6 +149,10 @@ def employee_number(self, employee_number): :param employee_number: The employee_number of this Employment. # noqa: E501 :type: str """ + if employee_number is None: + raise ValueError( + "Invalid value for `employee_number`, must not be `None`" + ) # noqa: E501 self._employee_number = employee_number @@ -140,10 +160,9 @@ def employee_number(self, employee_number): def ni_category(self): """Gets the ni_category of this Employment. # noqa: E501 - The NI Category of the employee # noqa: E501 :return: The ni_category of this Employment. # noqa: E501 - :rtype: str + :rtype: NICategoryLetter """ return self._ni_category @@ -151,19 +170,59 @@ def ni_category(self): def ni_category(self, ni_category): """Sets the ni_category of this Employment. - The NI Category of the employee # noqa: E501 :param ni_category: The ni_category of this Employment. # noqa: E501 - :type: str + :type: NICategoryLetter """ - allowed_values = ["A", "B", "C", "H", "J", "M", "Z", "X", "None"] # noqa: E501 - - if ni_category: - if ni_category not in allowed_values: - raise ValueError( - "Invalid value for `ni_category` ({0}), must be one of {1}".format( # noqa: E501 - ni_category, allowed_values - ) - ) self._ni_category = ni_category + + @property + def ni_categories(self): + """Gets the ni_categories of this Employment. # noqa: E501 + + The employee's NI categories # noqa: E501 + + :return: The ni_categories of this Employment. # noqa: E501 + :rtype: list[NICategory] + """ + return self._ni_categories + + @ni_categories.setter + def ni_categories(self, ni_categories): + """Sets the ni_categories of this Employment. + + The employee's NI categories # noqa: E501 + + :param ni_categories: The ni_categories of this Employment. # noqa: E501 + :type: list[NICategory] + """ + if ni_categories is None: + raise ValueError( + "Invalid value for `ni_categories`, must not be `None`" + ) # noqa: E501 + + self._ni_categories = ni_categories + + @property + def contracts(self): + """Gets the contracts of this Employment. # noqa: E501 + + The employee's contracts # noqa: E501 + + :return: The contracts of this Employment. # noqa: E501 + :rtype: list[Contracts] + """ + return self._contracts + + @contracts.setter + def contracts(self, contracts): + """Sets the contracts of this Employment. + + The employee's contracts # noqa: E501 + + :param contracts: The contracts of this Employment. # noqa: E501 + :type: list[Contracts] + """ + + self._contracts = contracts diff --git a/xero_python/payrolluk/models/employment_object.py b/xero_python/payrolluk/models/employment_object.py index 31e839ed..4ce4ba06 100644 --- a/xero_python/payrolluk/models/employment_object.py +++ b/xero_python/payrolluk/models/employment_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employment_status.py b/xero_python/payrolluk/models/employment_status.py new file mode 100644 index 00000000..ab4e2e49 --- /dev/null +++ b/xero_python/payrolluk/models/employment_status.py @@ -0,0 +1,29 @@ +# coding: utf-8 + +""" +Xero Payroll UK + +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class EmploymentStatus(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + EMPLOYEE = "Employee" + WORKER = "Worker" + UNSPECIFIED = "Unspecified" diff --git a/xero_python/payrolluk/models/invalid_field.py b/xero_python/payrolluk/models/invalid_field.py index ec0371a1..1f38acad 100644 --- a/xero_python/payrolluk/models/invalid_field.py +++ b/xero_python/payrolluk/models/invalid_field.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/leave_accrual_line.py b/xero_python/payrolluk/models/leave_accrual_line.py index d3216125..110b3287 100644 --- a/xero_python/payrolluk/models/leave_accrual_line.py +++ b/xero_python/payrolluk/models/leave_accrual_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/leave_earnings_line.py b/xero_python/payrolluk/models/leave_earnings_line.py index d2a9e2d2..839a3f04 100644 --- a/xero_python/payrolluk/models/leave_earnings_line.py +++ b/xero_python/payrolluk/models/leave_earnings_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/leave_period.py b/xero_python/payrolluk/models/leave_period.py index 725239c4..70f8cbb6 100644 --- a/xero_python/payrolluk/models/leave_period.py +++ b/xero_python/payrolluk/models/leave_period.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/leave_periods.py b/xero_python/payrolluk/models/leave_periods.py index 00da74ff..65e8e96c 100644 --- a/xero_python/payrolluk/models/leave_periods.py +++ b/xero_python/payrolluk/models/leave_periods.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/leave_type.py b/xero_python/payrolluk/models/leave_type.py index 3d2c80fb..e6b04987 100644 --- a/xero_python/payrolluk/models/leave_type.py +++ b/xero_python/payrolluk/models/leave_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/leave_type_object.py b/xero_python/payrolluk/models/leave_type_object.py index d6f0f291..6626e1d2 100644 --- a/xero_python/payrolluk/models/leave_type_object.py +++ b/xero_python/payrolluk/models/leave_type_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/leave_types.py b/xero_python/payrolluk/models/leave_types.py index 4a16497b..0e67ffc1 100644 --- a/xero_python/payrolluk/models/leave_types.py +++ b/xero_python/payrolluk/models/leave_types.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/ni_category.py b/xero_python/payrolluk/models/ni_category.py new file mode 100644 index 00000000..19ee6c54 --- /dev/null +++ b/xero_python/payrolluk/models/ni_category.py @@ -0,0 +1,193 @@ +# coding: utf-8 + +""" +Xero Payroll UK + +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class NICategory(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "start_date": "date", + "ni_category": "NICategoryLetter", + "ni_category_id": "float", + "date_first_employed_as_civilian": "date", + "workplace_postcode": "str", + } + + attribute_map = { + "start_date": "startDate", + "ni_category": "niCategory", + "ni_category_id": "niCategoryID", + "date_first_employed_as_civilian": "dateFirstEmployedAsCivilian", + "workplace_postcode": "workplacePostcode", + } + + def __init__( + self, + start_date=None, + ni_category=None, + ni_category_id=None, + date_first_employed_as_civilian=None, + workplace_postcode=None, + ): # noqa: E501 + """NICategory - a model defined in OpenAPI""" # noqa: E501 + + self._start_date = None + self._ni_category = None + self._ni_category_id = None + self._date_first_employed_as_civilian = None + self._workplace_postcode = None + self.discriminator = None + + if start_date is not None: + self.start_date = start_date + self.ni_category = ni_category + if ni_category_id is not None: + self.ni_category_id = ni_category_id + if date_first_employed_as_civilian is not None: + self.date_first_employed_as_civilian = date_first_employed_as_civilian + self.workplace_postcode = workplace_postcode + + @property + def start_date(self): + """Gets the start_date of this NICategory. # noqa: E501 + + The start date of the NI category (YYYY-MM-DD) # noqa: E501 + + :return: The start_date of this NICategory. # noqa: E501 + :rtype: date + """ + return self._start_date + + @start_date.setter + def start_date(self, start_date): + """Sets the start_date of this NICategory. + + The start date of the NI category (YYYY-MM-DD) # noqa: E501 + + :param start_date: The start_date of this NICategory. # noqa: E501 + :type: date + """ + + self._start_date = start_date + + @property + def ni_category(self): + """Gets the ni_category of this NICategory. # noqa: E501 + + + :return: The ni_category of this NICategory. # noqa: E501 + :rtype: NICategoryLetter + """ + return self._ni_category + + @ni_category.setter + def ni_category(self, ni_category): + """Sets the ni_category of this NICategory. + + + :param ni_category: The ni_category of this NICategory. # noqa: E501 + :type: NICategoryLetter + """ + if ni_category is None: + raise ValueError( + "Invalid value for `ni_category`, must not be `None`" + ) # noqa: E501 + + self._ni_category = ni_category + + @property + def ni_category_id(self): + """Gets the ni_category_id of this NICategory. # noqa: E501 + + Xero unique identifier for the NI category # noqa: E501 + + :return: The ni_category_id of this NICategory. # noqa: E501 + :rtype: float + """ + return self._ni_category_id + + @ni_category_id.setter + def ni_category_id(self, ni_category_id): + """Sets the ni_category_id of this NICategory. + + Xero unique identifier for the NI category # noqa: E501 + + :param ni_category_id: The ni_category_id of this NICategory. # noqa: E501 + :type: float + """ + + self._ni_category_id = ni_category_id + + @property + def date_first_employed_as_civilian(self): + """Gets the date_first_employed_as_civilian of this NICategory. # noqa: E501 + + The date in which the employee was first employed as a civilian (YYYY-MM-DD) # noqa: E501 + + :return: The date_first_employed_as_civilian of this NICategory. # noqa: E501 + :rtype: date + """ + return self._date_first_employed_as_civilian + + @date_first_employed_as_civilian.setter + def date_first_employed_as_civilian(self, date_first_employed_as_civilian): + """Sets the date_first_employed_as_civilian of this NICategory. + + The date in which the employee was first employed as a civilian (YYYY-MM-DD) # noqa: E501 + + :param date_first_employed_as_civilian: The date_first_employed_as_civilian of this NICategory. # noqa: E501 + :type: date + """ + + self._date_first_employed_as_civilian = date_first_employed_as_civilian + + @property + def workplace_postcode(self): + """Gets the workplace_postcode of this NICategory. # noqa: E501 + + The workplace postcode # noqa: E501 + + :return: The workplace_postcode of this NICategory. # noqa: E501 + :rtype: str + """ + return self._workplace_postcode + + @workplace_postcode.setter + def workplace_postcode(self, workplace_postcode): + """Sets the workplace_postcode of this NICategory. + + The workplace postcode # noqa: E501 + + :param workplace_postcode: The workplace_postcode of this NICategory. # noqa: E501 + :type: str + """ + if workplace_postcode is None: + raise ValueError( + "Invalid value for `workplace_postcode`, must not be `None`" + ) # noqa: E501 + + self._workplace_postcode = workplace_postcode diff --git a/xero_python/payrolluk/models/ni_category_letter.py b/xero_python/payrolluk/models/ni_category_letter.py new file mode 100644 index 00000000..efc69725 --- /dev/null +++ b/xero_python/payrolluk/models/ni_category_letter.py @@ -0,0 +1,43 @@ +# coding: utf-8 + +""" +Xero Payroll UK + +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class NICategoryLetter(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + A = "A" + B = "B" + C = "C" + F = "F" + H = "H" + I = "I" + J = "J" + L = "L" + M = "M" + S = "S" + V = "V" + X = "X" + Z = "Z" + D = "D" + E = "E" + K = "K" + N = "N" diff --git a/xero_python/payrolluk/models/ni_category_one_of.py b/xero_python/payrolluk/models/ni_category_one_of.py new file mode 100644 index 00000000..106a09e2 --- /dev/null +++ b/xero_python/payrolluk/models/ni_category_one_of.py @@ -0,0 +1,73 @@ +# coding: utf-8 + +""" +Xero Payroll UK + +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class NICategoryOneOf(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = {"ni_category": "str"} + + attribute_map = {"ni_category": "niCategory"} + + def __init__(self, ni_category=None): # noqa: E501 + """NICategoryOneOf - a model defined in OpenAPI""" # noqa: E501 + + self._ni_category = None + self.discriminator = None + + if ni_category is not None: + self.ni_category = ni_category + + @property + def ni_category(self): + """Gets the ni_category of this NICategoryOneOf. # noqa: E501 + + + :return: The ni_category of this NICategoryOneOf. # noqa: E501 + :rtype: str + """ + return self._ni_category + + @ni_category.setter + def ni_category(self, ni_category): + """Sets the ni_category of this NICategoryOneOf. + + + :param ni_category: The ni_category of this NICategoryOneOf. # noqa: E501 + :type: str + """ + allowed_values = ["F", "I", "L", "S", "N", "E", "D", "K", "None"] # noqa: E501 + + if ni_category: + if ni_category not in allowed_values: + raise ValueError( + "Invalid value for `ni_category` ({0}), must be one of {1}".format( # noqa: E501 + ni_category, allowed_values + ) + ) + + self._ni_category = ni_category diff --git a/xero_python/payrolluk/models/ni_category_one_of1.py b/xero_python/payrolluk/models/ni_category_one_of1.py new file mode 100644 index 00000000..8c61e397 --- /dev/null +++ b/xero_python/payrolluk/models/ni_category_one_of1.py @@ -0,0 +1,73 @@ +# coding: utf-8 + +""" +Xero Payroll UK + +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class NICategoryOneOf1(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = {"ni_category": "str"} + + attribute_map = {"ni_category": "niCategory"} + + def __init__(self, ni_category=None): # noqa: E501 + """NICategoryOneOf1 - a model defined in OpenAPI""" # noqa: E501 + + self._ni_category = None + self.discriminator = None + + if ni_category is not None: + self.ni_category = ni_category + + @property + def ni_category(self): + """Gets the ni_category of this NICategoryOneOf1. # noqa: E501 + + + :return: The ni_category of this NICategoryOneOf1. # noqa: E501 + :rtype: str + """ + return self._ni_category + + @ni_category.setter + def ni_category(self, ni_category): + """Sets the ni_category of this NICategoryOneOf1. + + + :param ni_category: The ni_category of this NICategoryOneOf1. # noqa: E501 + :type: str + """ + allowed_values = ["V", "None"] # noqa: E501 + + if ni_category: + if ni_category not in allowed_values: + raise ValueError( + "Invalid value for `ni_category` ({0}), must be one of {1}".format( # noqa: E501 + ni_category, allowed_values + ) + ) + + self._ni_category = ni_category diff --git a/xero_python/payrolluk/models/pagination.py b/xero_python/payrolluk/models/pagination.py index d9cdc10b..f4114baa 100644 --- a/xero_python/payrolluk/models/pagination.py +++ b/xero_python/payrolluk/models/pagination.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/pay_run.py b/xero_python/payrolluk/models/pay_run.py index 9f96a82c..ec73437d 100644 --- a/xero_python/payrolluk/models/pay_run.py +++ b/xero_python/payrolluk/models/pay_run.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/pay_run_calendar.py b/xero_python/payrolluk/models/pay_run_calendar.py index 76d93a06..1f406a2e 100644 --- a/xero_python/payrolluk/models/pay_run_calendar.py +++ b/xero_python/payrolluk/models/pay_run_calendar.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/pay_run_calendar_object.py b/xero_python/payrolluk/models/pay_run_calendar_object.py index 483a9c9a..a880ef1b 100644 --- a/xero_python/payrolluk/models/pay_run_calendar_object.py +++ b/xero_python/payrolluk/models/pay_run_calendar_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/pay_run_calendars.py b/xero_python/payrolluk/models/pay_run_calendars.py index d9b39182..757447f7 100644 --- a/xero_python/payrolluk/models/pay_run_calendars.py +++ b/xero_python/payrolluk/models/pay_run_calendars.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/pay_run_object.py b/xero_python/payrolluk/models/pay_run_object.py index a64898da..f3e89e8b 100644 --- a/xero_python/payrolluk/models/pay_run_object.py +++ b/xero_python/payrolluk/models/pay_run_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/pay_runs.py b/xero_python/payrolluk/models/pay_runs.py index 52d7b96b..fa1b099c 100644 --- a/xero_python/payrolluk/models/pay_runs.py +++ b/xero_python/payrolluk/models/pay_runs.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/payment_line.py b/xero_python/payrolluk/models/payment_line.py index 781ba8e9..99d3d39c 100644 --- a/xero_python/payrolluk/models/payment_line.py +++ b/xero_python/payrolluk/models/payment_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/payment_method.py b/xero_python/payrolluk/models/payment_method.py index 89a09cfb..20383ce7 100644 --- a/xero_python/payrolluk/models/payment_method.py +++ b/xero_python/payrolluk/models/payment_method.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/payment_method_object.py b/xero_python/payrolluk/models/payment_method_object.py index 6d7b7a28..9b0c51f5 100644 --- a/xero_python/payrolluk/models/payment_method_object.py +++ b/xero_python/payrolluk/models/payment_method_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/payslip.py b/xero_python/payrolluk/models/payslip.py index cfb76a96..5cab1e20 100644 --- a/xero_python/payrolluk/models/payslip.py +++ b/xero_python/payrolluk/models/payslip.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/payslip_object.py b/xero_python/payrolluk/models/payslip_object.py index 07a5a831..32ddf530 100644 --- a/xero_python/payrolluk/models/payslip_object.py +++ b/xero_python/payrolluk/models/payslip_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/payslips.py b/xero_python/payrolluk/models/payslips.py index 2bfe9b9b..a61c3bba 100644 --- a/xero_python/payrolluk/models/payslips.py +++ b/xero_python/payrolluk/models/payslips.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/problem.py b/xero_python/payrolluk/models/problem.py index 87d8dd7c..330df9a7 100644 --- a/xero_python/payrolluk/models/problem.py +++ b/xero_python/payrolluk/models/problem.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/reimbursement.py b/xero_python/payrolluk/models/reimbursement.py index 2de7616b..09c9d321 100644 --- a/xero_python/payrolluk/models/reimbursement.py +++ b/xero_python/payrolluk/models/reimbursement.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/reimbursement_line.py b/xero_python/payrolluk/models/reimbursement_line.py index dac66d7b..cb39ee0d 100644 --- a/xero_python/payrolluk/models/reimbursement_line.py +++ b/xero_python/payrolluk/models/reimbursement_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/reimbursement_object.py b/xero_python/payrolluk/models/reimbursement_object.py index ee0bb1ca..8fdf1c65 100644 --- a/xero_python/payrolluk/models/reimbursement_object.py +++ b/xero_python/payrolluk/models/reimbursement_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/reimbursements.py b/xero_python/payrolluk/models/reimbursements.py index 17383e1d..ea038cf7 100644 --- a/xero_python/payrolluk/models/reimbursements.py +++ b/xero_python/payrolluk/models/reimbursements.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/salary_and_wage.py b/xero_python/payrolluk/models/salary_and_wage.py index 494e6c6f..95a3ce48 100644 --- a/xero_python/payrolluk/models/salary_and_wage.py +++ b/xero_python/payrolluk/models/salary_and_wage.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/salary_and_wage_object.py b/xero_python/payrolluk/models/salary_and_wage_object.py index 5021e9c3..ac5c5e50 100644 --- a/xero_python/payrolluk/models/salary_and_wage_object.py +++ b/xero_python/payrolluk/models/salary_and_wage_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/salary_and_wages.py b/xero_python/payrolluk/models/salary_and_wages.py index 3e9c5165..1d0071d7 100644 --- a/xero_python/payrolluk/models/salary_and_wages.py +++ b/xero_python/payrolluk/models/salary_and_wages.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/settings.py b/xero_python/payrolluk/models/settings.py index 8788dbba..63646e51 100644 --- a/xero_python/payrolluk/models/settings.py +++ b/xero_python/payrolluk/models/settings.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/statutory_deduction.py b/xero_python/payrolluk/models/statutory_deduction.py index e1196d7b..ffe0ee5e 100644 --- a/xero_python/payrolluk/models/statutory_deduction.py +++ b/xero_python/payrolluk/models/statutory_deduction.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/statutory_deduction_category.py b/xero_python/payrolluk/models/statutory_deduction_category.py index 499c95ee..b5e78974 100644 --- a/xero_python/payrolluk/models/statutory_deduction_category.py +++ b/xero_python/payrolluk/models/statutory_deduction_category.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/tax_line.py b/xero_python/payrolluk/models/tax_line.py index 58a1b680..fbe23401 100644 --- a/xero_python/payrolluk/models/tax_line.py +++ b/xero_python/payrolluk/models/tax_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/timesheet.py b/xero_python/payrolluk/models/timesheet.py index ae711971..64000186 100644 --- a/xero_python/payrolluk/models/timesheet.py +++ b/xero_python/payrolluk/models/timesheet.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/timesheet_earnings_line.py b/xero_python/payrolluk/models/timesheet_earnings_line.py index d016619f..301965f3 100644 --- a/xero_python/payrolluk/models/timesheet_earnings_line.py +++ b/xero_python/payrolluk/models/timesheet_earnings_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/timesheet_line.py b/xero_python/payrolluk/models/timesheet_line.py index 9ab789e9..15c79a95 100644 --- a/xero_python/payrolluk/models/timesheet_line.py +++ b/xero_python/payrolluk/models/timesheet_line.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/timesheet_line_object.py b/xero_python/payrolluk/models/timesheet_line_object.py index 349b5170..fd1ac776 100644 --- a/xero_python/payrolluk/models/timesheet_line_object.py +++ b/xero_python/payrolluk/models/timesheet_line_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/timesheet_object.py b/xero_python/payrolluk/models/timesheet_object.py index f8f2f3d1..147d46ef 100644 --- a/xero_python/payrolluk/models/timesheet_object.py +++ b/xero_python/payrolluk/models/timesheet_object.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/timesheets.py b/xero_python/payrolluk/models/timesheets.py index 2e7cef7c..a701395e 100644 --- a/xero_python/payrolluk/models/timesheets.py +++ b/xero_python/payrolluk/models/timesheets.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/tracking_categories.py b/xero_python/payrolluk/models/tracking_categories.py index 91f1743c..0d5fc368 100644 --- a/xero_python/payrolluk/models/tracking_categories.py +++ b/xero_python/payrolluk/models/tracking_categories.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/tracking_category.py b/xero_python/payrolluk/models/tracking_category.py index 00f19ad3..c5d5f448 100644 --- a/xero_python/payrolluk/models/tracking_category.py +++ b/xero_python/payrolluk/models/tracking_category.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Payroll UK +Xero Payroll UK - This is the Xero Payroll API for orgs in the UK region. # noqa: E501 +This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/__init__.py b/xero_python/project/__init__.py index 022237df..c06fe940 100644 --- a/xero_python/project/__init__.py +++ b/xero_python/project/__init__.py @@ -3,12 +3,12 @@ # flake8: noqa """ - Xero Projects API +Xero Projects API - This is the Xero Projects API # noqa: E501 +This is the Xero Projects API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/api/project_api.py b/xero_python/project/api/project_api.py index 4c81e5e5..cfddf7ba 100644 --- a/xero_python/project/api/project_api.py +++ b/xero_python/project/api/project_api.py @@ -1,5 +1,16 @@ # coding: utf-8 +import importlib +import re # noqa: F401 + +from xero_python import exceptions +from xero_python.api_client import ApiClient, ModelFinder + +try: + from .exception_handler import translate_status_exception +except ImportError: + translate_status_exception = exceptions.translate_status_exception + """ Xero Projects API @@ -10,20 +21,9 @@ """ """ - OpenAPI spec version: 2.19.3 + OpenAPI spec version: 16.2.0 """ -import importlib -import re # noqa: F401 - -from xero_python import exceptions -from xero_python.api_client import ApiClient, ModelFinder - -try: - from .exception_handler import translate_status_exception -except ImportError: - translate_status_exception = exceptions.translate_status_exception - class empty: """empty object to mark optional parameter not set""" @@ -60,6 +60,7 @@ def create_project( self, xero_tenant_id, project_create_or_update, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -68,6 +69,7 @@ def create_project( OAuth2 scope: projects :param str xero_tenant_id: Xero identifier for Tenant (required) :param ProjectCreateOrUpdate project_create_or_update: Create a new project with ProjectCreateOrUpdate object (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -96,6 +98,9 @@ def create_project( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -135,11 +140,107 @@ def create_project( except exceptions.HTTPStatusException as error: raise translate_status_exception(error, self, "create_project") + def create_task( + self, + xero_tenant_id, + project_id, + task_create_or_update, + idempotency_key=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Allows you to create a task # noqa: E501 + OAuth2 scope: projects + Allows you to create a specific task # noqa: E501 + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str project_id: You can create a task on a specified projectId (required) + :param TaskCreateOrUpdate task_create_or_update: The task object you are creating (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: Task + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `create_task`" + ) + # verify the required parameter 'project_id' is set + if project_id is None: + raise ValueError( + "Missing the required parameter `project_id` " + "when calling `create_task`" + ) + # verify the required parameter 'task_create_or_update' is set + if task_create_or_update is None: + raise ValueError( + "Missing the required parameter `task_create_or_update` " + "when calling `create_task`" + ) + + collection_formats = {} + path_params = { + "projectId": project_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + + local_var_files = {} + form_params = [] + + body_params = task_create_or_update + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Projects/{projectId}/Tasks") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="Task", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "create_task") + def create_time_entry( self, xero_tenant_id, project_id, time_entry_create_or_update, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -150,6 +251,7 @@ def create_time_entry( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str project_id: You can specify an individual project by appending the projectId to the endpoint (required) :param TimeEntryCreateOrUpdate time_entry_create_or_update: The time entry object you are creating (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -186,6 +288,9 @@ def create_time_entry( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -225,6 +330,91 @@ def create_time_entry( except exceptions.HTTPStatusException as error: raise translate_status_exception(error, self, "create_time_entry") + def delete_task( + self, + xero_tenant_id, + project_id, + task_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Allows you to delete a task # noqa: E501 + OAuth2 scope: projects + Allows you to delete a specific task # noqa: E501 + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str project_id: You can specify an individual project by appending the projectId to the endpoint (required) + :param str task_id: You can specify an individual task by appending the id to the endpoint (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: None + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `delete_task`" + ) + # verify the required parameter 'project_id' is set + if project_id is None: + raise ValueError( + "Missing the required parameter `project_id` " + "when calling `delete_task`" + ) + # verify the required parameter 'task_id' is set + if task_id is None: + raise ValueError( + "Missing the required parameter `task_id` " "when calling `delete_task`" + ) + + collection_formats = {} + path_params = { + "projectId": project_id, + "taskId": task_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Projects/{projectId}/Tasks/{taskId}") + + try: + return self.api_client.call_api( + url, + "DELETE", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "delete_task") + def delete_time_entry( self, xero_tenant_id, @@ -281,6 +471,11 @@ def delete_time_entry( form_params = [] body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + # Authentication setting auth_settings = ["OAuth2"] url = self.get_resource_url("/Projects/{projectId}/Time/{timeEntryId}") @@ -685,7 +880,7 @@ def get_tasks( :param str project_id: You can specify an individual project by appending the projectId to the endpoint (required) :param int page: Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. :param int page_size: Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. - :param str task_ids: taskIdsSearch for all tasks that match a comma separated list of taskIds, i.e. GET https://.../tasks?taskIds={taskID},{taskID} + :param str task_ids: Search for all tasks that match a comma separated list of taskIds, i.e. GET https://.../tasks?taskIds={taskID},{taskID} :param ChargeType charge_type: :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models @@ -983,6 +1178,7 @@ def patch_project( xero_tenant_id, project_id, project_patch, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -993,6 +1189,7 @@ def patch_project( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str project_id: You can specify an individual project by appending the projectId to the endpoint (required) :param ProjectPatch project_patch: Update the status of an existing Project (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1029,6 +1226,9 @@ def patch_project( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1073,6 +1273,7 @@ def update_project( xero_tenant_id, project_id, project_create_or_update, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1083,6 +1284,7 @@ def update_project( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str project_id: You can specify an individual project by appending the projectId to the endpoint (required) :param ProjectCreateOrUpdate project_create_or_update: Request of type ProjectCreateOrUpdate (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1119,6 +1321,9 @@ def update_project( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] @@ -1158,12 +1363,116 @@ def update_project( except exceptions.HTTPStatusException as error: raise translate_status_exception(error, self, "update_project") + def update_task( + self, + xero_tenant_id, + project_id, + task_id, + task_create_or_update, + idempotency_key=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Allows you to update a task # noqa: E501 + OAuth2 scope: projects + Allows you to update a specific task # noqa: E501 + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str project_id: You can specify an individual project by appending the projectId to the endpoint (required) + :param str task_id: You can specify an individual task by appending the id to the endpoint (required) + :param TaskCreateOrUpdate task_create_or_update: The task object you are updating (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: None + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `update_task`" + ) + # verify the required parameter 'project_id' is set + if project_id is None: + raise ValueError( + "Missing the required parameter `project_id` " + "when calling `update_task`" + ) + # verify the required parameter 'task_id' is set + if task_id is None: + raise ValueError( + "Missing the required parameter `task_id` " "when calling `update_task`" + ) + # verify the required parameter 'task_create_or_update' is set + if task_create_or_update is None: + raise ValueError( + "Missing the required parameter `task_create_or_update` " + "when calling `update_task`" + ) + + collection_formats = {} + path_params = { + "projectId": project_id, + "taskId": task_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + + local_var_files = {} + form_params = [] + + body_params = task_create_or_update + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Projects/{projectId}/Tasks/{taskId}") + + try: + return self.api_client.call_api( + url, + "PUT", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "update_task") + def update_time_entry( self, xero_tenant_id, project_id, time_entry_id, time_entry_create_or_update, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1175,6 +1484,7 @@ def update_time_entry( :param str project_id: You can specify an individual project by appending the projectId to the endpoint (required) :param str time_entry_id: You can specify an individual time entry by appending the id to the endpoint (required) :param TimeEntryCreateOrUpdate time_entry_create_or_update: The time entry object you are updating (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1218,10 +1528,18 @@ def update_time_entry( "Xero-Tenant-Id": xero_tenant_id, } + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + local_var_files = {} form_params = [] body_params = time_entry_create_or_update + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + # HTTP header `Content-Type` header_params["Content-Type"] = self.api_client.select_header_content_type( ["application/json"] diff --git a/xero_python/project/docs/ProjectApi.md b/xero_python/project/docs/ProjectApi.md index 132ea99d..3828acb0 100644 --- a/xero_python/project/docs/ProjectApi.md +++ b/xero_python/project/docs/ProjectApi.md @@ -5,7 +5,9 @@ All URIs are relative to *https://api.xero.com/projects.xro/2.0* Method | HTTP request | Description ------------- | ------------- | ------------- [**create_project**](ProjectApi.md#create_project) | **POST** /Projects | Create one or more new projects +[**create_task**](ProjectApi.md#create_task) | **POST** /Projects/{projectId}/Tasks | Allows you to create a task [**create_time_entry**](ProjectApi.md#create_time_entry) | **POST** /Projects/{projectId}/Time | Creates a time entry for a specific project +[**delete_task**](ProjectApi.md#delete_task) | **DELETE** /Projects/{projectId}/Tasks/{taskId} | Allows you to delete a task [**delete_time_entry**](ProjectApi.md#delete_time_entry) | **DELETE** /Projects/{projectId}/Time/{timeEntryId} | Deletes a time entry for a specific project [**get_project**](ProjectApi.md#get_project) | **GET** /Projects/{projectId} | Retrieves a single project [**get_project_users**](ProjectApi.md#get_project_users) | **GET** /ProjectsUsers | Retrieves a list of all project users @@ -16,11 +18,12 @@ Method | HTTP request | Description [**get_time_entry**](ProjectApi.md#get_time_entry) | **GET** /Projects/{projectId}/Time/{timeEntryId} | Retrieves a single time entry for a specific project [**patch_project**](ProjectApi.md#patch_project) | **PATCH** /Projects/{projectId} | creates a project for the specified contact [**update_project**](ProjectApi.md#update_project) | **PUT** /Projects/{projectId} | Updates a specific project +[**update_task**](ProjectApi.md#update_task) | **PUT** /Projects/{projectId}/Tasks/{taskId} | Allows you to update a task [**update_time_entry**](ProjectApi.md#update_time_entry) | **PUT** /Projects/{projectId}/Time/{timeEntryId} | Updates a time entry for a specific project # **create_project** -> Project create_project(xero_tenant_id, project_create_or_update) +> Project create_project(xero_tenant_id, project_create_or_update, idempotency_key=idempotency_key) Create one or more new projects @@ -52,9 +55,10 @@ api_instance = ProjectApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant project_create_or_update = { "contactId": "00000000-0000-0000-000-000000000000", "name": "New Kitchen", "deadlineUtc": "2019-12-10T12:59:59Z", "estimateAmount": "99.99" } # ProjectCreateOrUpdate | Create a new project with ProjectCreateOrUpdate object +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Create one or more new projects - api_response = api_instance.create_project(xero_tenant_id, project_create_or_update) + api_response = api_instance.create_project(xero_tenant_id, project_create_or_update, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->create_project: %s\n" % e) @@ -66,6 +70,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **project_create_or_update** | [**ProjectCreateOrUpdate**](ProjectCreateOrUpdate.md)| Create a new project with ProjectCreateOrUpdate object | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -82,8 +87,77 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **create_task** +> Task create_task(xero_tenant_id, project_id, task_create_or_update, idempotency_key=idempotency_key) + +Allows you to create a task + +Allows you to create a specific task + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.project import ProjectApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = ProjectApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +project_id = 'project_id_example' # str | You can create a task on a specified projectId +task_create_or_update = { "status": "INPROGRESS" } # TaskCreateOrUpdate | The task object you are creating +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) +try: + # Allows you to create a task + api_response = api_instance.create_task(xero_tenant_id, project_id, task_create_or_update, idempotency_key=idempotency_key) + pprint(api_response) +except ApiException as e: + print("Exception when calling ProjectApi->create_task: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **project_id** | [**str**](.md)| You can create a task on a specified projectId | + **task_create_or_update** | [**TaskCreateOrUpdate**](TaskCreateOrUpdate.md)| The task object you are creating | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] + +### Return type + +[**Task**](Task.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **create_time_entry** -> TimeEntry create_time_entry(xero_tenant_id, project_id, time_entry_create_or_update) +> TimeEntry create_time_entry(xero_tenant_id, project_id, time_entry_create_or_update, idempotency_key=idempotency_key) Creates a time entry for a specific project @@ -117,10 +191,11 @@ api_instance = ProjectApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant project_id = 'project_id_example' # str | You can specify an individual project by appending the projectId to the endpoint -time_entry_create_or_update = { "userId": "00000000-0000-0000-0000-000000000000", "taskId": "00000000-0000-0000-0000-000000000000", "dateUtc": "2020-02-26T15:00:00Z", "duration":30, "description": "My description" } # TimeEntryCreateOrUpdate | The time entry object you are creating +time_entry_create_or_update = {"userId":"00000000-0000-0000-0000-000000000000","taskId":"00000000-0000-0000-0000-000000000000","dateUtc":"2020-02-26T15:00:00Z","duration":30,"description":"My description"} # TimeEntryCreateOrUpdate | The time entry object you are creating +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a time entry for a specific project - api_response = api_instance.create_time_entry(xero_tenant_id, project_id, time_entry_create_or_update) + api_response = api_instance.create_time_entry(xero_tenant_id, project_id, time_entry_create_or_update, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->create_time_entry: %s\n" % e) @@ -133,6 +208,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **project_id** | [**str**](.md)| You can specify an individual project by appending the projectId to the endpoint | **time_entry_create_or_update** | [**TimeEntryCreateOrUpdate**](TimeEntryCreateOrUpdate.md)| The time entry object you are creating | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -149,6 +225,72 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **delete_task** +> delete_task(xero_tenant_id, project_id, task_id) + +Allows you to delete a task + +Allows you to delete a specific task + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.project import ProjectApi + + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = ProjectApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +project_id = 'project_id_example' # str | You can specify an individual project by appending the projectId to the endpoint +task_id = 'task_id_example' # str | You can specify an individual task by appending the id to the endpoint +try: + # Allows you to delete a task + api_instance.delete_task(xero_tenant_id, project_id, task_id) +except ApiException as e: + print("Exception when calling ProjectApi->delete_task: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **project_id** | [**str**](.md)| You can specify an individual project by appending the projectId to the endpoint | + **task_id** | [**str**](.md)| You can specify an individual task by appending the id to the endpoint | + +### Return type + +void (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **delete_time_entry** > delete_time_entry(xero_tenant_id, project_id, time_entry_id) @@ -211,7 +353,7 @@ void (empty response body) ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: Not defined + - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -524,7 +666,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant project_id = 'project_id_example' # str | You can specify an individual project by appending the projectId to the endpoint page = 1 # int | Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. (optional) page_size = 10 # int | Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. (optional) -task_ids = 'task_ids_example' # str | taskIdsSearch for all tasks that match a comma separated list of taskIds, i.e. GET https://.../tasks?taskIds={taskID},{taskID} (optional) +task_ids = 'task_ids_example' # str | Search for all tasks that match a comma separated list of taskIds, i.e. GET https://.../tasks?taskIds={taskID},{taskID} (optional) charge_type = xero_python.project.ChargeType() # ChargeType | (optional) try: # Retrieves all project tasks @@ -542,7 +684,7 @@ Name | Type | Description | Notes **project_id** | [**str**](.md)| You can specify an individual project by appending the projectId to the endpoint | **page** | **int**| Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. | [optional] **page_size** | **int**| Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. | [optional] - **task_ids** | **str**| taskIdsSearch for all tasks that match a comma separated list of taskIds, i.e. GET https://.../tasks?taskIds={taskID},{taskID} | [optional] + **task_ids** | **str**| Search for all tasks that match a comma separated list of taskIds, i.e. GET https://.../tasks?taskIds={taskID},{taskID} | [optional] **charge_type** | [**ChargeType**](.md)| | [optional] ### Return type @@ -713,7 +855,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **patch_project** -> patch_project(xero_tenant_id, project_id, project_patch) +> patch_project(xero_tenant_id, project_id, project_patch, idempotency_key=idempotency_key) creates a project for the specified contact @@ -748,9 +890,10 @@ api_instance = ProjectApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant project_id = 'project_id_example' # str | You can specify an individual project by appending the projectId to the endpoint project_patch = { "status": "INPROGRESS" } # ProjectPatch | Update the status of an existing Project +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # creates a project for the specified contact - api_instance.patch_project(xero_tenant_id, project_id, project_patch) + api_instance.patch_project(xero_tenant_id, project_id, project_patch, idempotency_key=idempotency_key) except ApiException as e: print("Exception when calling ProjectApi->patch_project: %s\n" % e) ``` @@ -762,6 +905,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **project_id** | [**str**](.md)| You can specify an individual project by appending the projectId to the endpoint | **project_patch** | [**ProjectPatch**](ProjectPatch.md)| Update the status of an existing Project | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -779,7 +923,7 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_project** -> update_project(xero_tenant_id, project_id, project_create_or_update) +> update_project(xero_tenant_id, project_id, project_create_or_update, idempotency_key=idempotency_key) Updates a specific project @@ -814,9 +958,10 @@ api_instance = ProjectApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant project_id = 'project_id_example' # str | You can specify an individual project by appending the projectId to the endpoint project_create_or_update = { "name": "New Kitchen", "deadlineUtc": "2017-04-23T18:25:43.511Z", "estimateAmount": 99.99 } # ProjectCreateOrUpdate | Request of type ProjectCreateOrUpdate +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a specific project - api_instance.update_project(xero_tenant_id, project_id, project_create_or_update) + api_instance.update_project(xero_tenant_id, project_id, project_create_or_update, idempotency_key=idempotency_key) except ApiException as e: print("Exception when calling ProjectApi->update_project: %s\n" % e) ``` @@ -828,6 +973,77 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **project_id** | [**str**](.md)| You can specify an individual project by appending the projectId to the endpoint | **project_create_or_update** | [**ProjectCreateOrUpdate**](ProjectCreateOrUpdate.md)| Request of type ProjectCreateOrUpdate | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_task** +> update_task(xero_tenant_id, project_id, task_id, task_create_or_update, idempotency_key=idempotency_key) + +Allows you to update a task + +Allows you to update a specific task + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.project import ProjectApi + + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = ProjectApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +project_id = 'project_id_example' # str | You can specify an individual project by appending the projectId to the endpoint +task_id = 'task_id_example' # str | You can specify an individual task by appending the id to the endpoint +task_create_or_update = xero_python.project.TaskCreateOrUpdate() # TaskCreateOrUpdate | The task object you are updating +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) +try: + # Allows you to update a task + api_instance.update_task(xero_tenant_id, project_id, task_id, task_create_or_update, idempotency_key=idempotency_key) +except ApiException as e: + print("Exception when calling ProjectApi->update_task: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **project_id** | [**str**](.md)| You can specify an individual project by appending the projectId to the endpoint | + **task_id** | [**str**](.md)| You can specify an individual task by appending the id to the endpoint | + **task_create_or_update** | [**TaskCreateOrUpdate**](TaskCreateOrUpdate.md)| The task object you are updating | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -845,7 +1061,7 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_time_entry** -> update_time_entry(xero_tenant_id, project_id, time_entry_id, time_entry_create_or_update) +> update_time_entry(xero_tenant_id, project_id, time_entry_id, time_entry_create_or_update, idempotency_key=idempotency_key) Updates a time entry for a specific project @@ -880,10 +1096,11 @@ api_instance = ProjectApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant project_id = 'project_id_example' # str | You can specify an individual project by appending the projectId to the endpoint time_entry_id = 'time_entry_id_example' # str | You can specify an individual time entry by appending the id to the endpoint -time_entry_create_or_update = { "userId": "00000000-0000-0000-0000-000000000000", "taskId": "00000000-0000-0000-0000-000000000000", "dateUtc": "2020-02-27T15:00:00Z", "duration":45, "description": "My UPDATED description" } # TimeEntryCreateOrUpdate | The time entry object you are updating +time_entry_create_or_update = {"userId":"00000000-0000-0000-0000-000000000000","taskId":"00000000-0000-0000-0000-000000000000","dateUtc":"2020-02-27T15:00:00Z","duration":45,"description":"My UPDATED description"} # TimeEntryCreateOrUpdate | The time entry object you are updating +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a time entry for a specific project - api_instance.update_time_entry(xero_tenant_id, project_id, time_entry_id, time_entry_create_or_update) + api_instance.update_time_entry(xero_tenant_id, project_id, time_entry_id, time_entry_create_or_update, idempotency_key=idempotency_key) except ApiException as e: print("Exception when calling ProjectApi->update_time_entry: %s\n" % e) ``` @@ -896,6 +1113,7 @@ Name | Type | Description | Notes **project_id** | [**str**](.md)| You can specify an individual project by appending the projectId to the endpoint | **time_entry_id** | [**str**](.md)| You can specify an individual time entry by appending the id to the endpoint | **time_entry_create_or_update** | [**TimeEntryCreateOrUpdate**](TimeEntryCreateOrUpdate.md)| The time entry object you are updating | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -908,7 +1126,7 @@ void (empty response body) ### HTTP request headers - **Content-Type**: application/json - - **Accept**: Not defined + - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/xero_python/project/docs/Task.md b/xero_python/project/docs/Task.md index a579df7b..a1d7c492 100644 --- a/xero_python/project/docs/Task.md +++ b/xero_python/project/docs/Task.md @@ -7,14 +7,14 @@ Name | Type | Description | Notes **name** | **str** | Name of the task. | [optional] **rate** | [**Amount**](Amount.md) | | [optional] **charge_type** | [**ChargeType**](ChargeType.md) | | [optional] -**estimate_minutes** | **float** | An estimated time to perform the task | [optional] +**estimate_minutes** | **int** | An estimated time to perform the task | [optional] **project_id** | **str** | Identifier of the project task belongs to. | [optional] -**total_minutes** | **float** | Total minutes which have been logged against the task. Logged by assigning a time entry to a task | [optional] +**total_minutes** | **int** | Total minutes which have been logged against the task. Logged by assigning a time entry to a task | [optional] **total_amount** | [**Amount**](Amount.md) | | [optional] -**minutes_invoiced** | **float** | Minutes on this task which have been invoiced. | [optional] -**minutes_to_be_invoiced** | **float** | Minutes on this task which have not been invoiced. | [optional] -**fixed_minutes** | **float** | Minutes logged against this task if its charge type is `FIXED`. | [optional] -**non_chargeable_minutes** | **float** | Minutes logged against this task if its charge type is `NON_CHARGEABLE`. | [optional] +**minutes_invoiced** | **int** | Minutes on this task which have been invoiced. | [optional] +**minutes_to_be_invoiced** | **int** | Minutes on this task which have not been invoiced. | [optional] +**fixed_minutes** | **int** | Minutes logged against this task if its charge type is `FIXED`. | [optional] +**non_chargeable_minutes** | **int** | Minutes logged against this task if its charge type is `NON_CHARGEABLE`. | [optional] **amount_to_be_invoiced** | [**Amount**](Amount.md) | | [optional] **amount_invoiced** | [**Amount**](Amount.md) | | [optional] **status** | **str** | Status of the task. When a task of ChargeType is `FIXED` and the rate amount is invoiced the status will be set to `INVOICED` and can't be modified. A task with ChargeType of `TIME` or `NON_CHARGEABLE` cannot have a status of `INVOICED`. A `LOCKED` state indicates that the task is currently changing state (for example being invoiced) and can't be modified. | [optional] diff --git a/xero_python/project/docs/TaskCreateOrUpdate.md b/xero_python/project/docs/TaskCreateOrUpdate.md index 0866e1f0..81f75a8b 100644 --- a/xero_python/project/docs/TaskCreateOrUpdate.md +++ b/xero_python/project/docs/TaskCreateOrUpdate.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes **name** | **str** | Name of the task. Max length 100 characters. | **rate** | [**Amount**](Amount.md) | | **charge_type** | [**ChargeType**](ChargeType.md) | | -**estimate_minutes** | **int** | Estimated time to perform the task. EstimateMinutes has to be greater than 0 if provided. | [optional] +**estimate_minutes** | **int** | An estimated time to perform the task | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/project/models/__init__.py b/xero_python/project/models/__init__.py index 44e170f1..8151657a 100644 --- a/xero_python/project/models/__init__.py +++ b/xero_python/project/models/__init__.py @@ -2,12 +2,12 @@ # flake8: noqa """ - Xero Projects API +Xero Projects API - This is the Xero Projects API # noqa: E501 +This is the Xero Projects API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/amount.py b/xero_python/project/models/amount.py index b1953818..83866b09 100644 --- a/xero_python/project/models/amount.py +++ b/xero_python/project/models/amount.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Projects API +Xero Projects API - This is the Xero Projects API # noqa: E501 +This is the Xero Projects API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/charge_type.py b/xero_python/project/models/charge_type.py index 94e30a15..b0dcf602 100644 --- a/xero_python/project/models/charge_type.py +++ b/xero_python/project/models/charge_type.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Projects API +Xero Projects API - This is the Xero Projects API # noqa: E501 +This is the Xero Projects API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/currency_code.py b/xero_python/project/models/currency_code.py index be0693ad..f7641aa2 100644 --- a/xero_python/project/models/currency_code.py +++ b/xero_python/project/models/currency_code.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Projects API +Xero Projects API - This is the Xero Projects API # noqa: E501 +This is the Xero Projects API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -187,4 +187,3 @@ class CurrencyCode(Enum): ZMW = "ZMW" ZMK = "ZMK" ZWD = "ZWD" - EMPTY = "" diff --git a/xero_python/project/models/error.py b/xero_python/project/models/error.py index d11c925a..4bdb2e34 100644 --- a/xero_python/project/models/error.py +++ b/xero_python/project/models/error.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Projects API +Xero Projects API - This is the Xero Projects API # noqa: E501 +This is the Xero Projects API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/pagination.py b/xero_python/project/models/pagination.py index 858f2cea..9336dacc 100644 --- a/xero_python/project/models/pagination.py +++ b/xero_python/project/models/pagination.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Projects API +Xero Projects API - This is the Xero Projects API # noqa: E501 +This is the Xero Projects API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/project.py b/xero_python/project/models/project.py index 59aab234..b9a727ee 100644 --- a/xero_python/project/models/project.py +++ b/xero_python/project/models/project.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Projects API +Xero Projects API - This is the Xero Projects API # noqa: E501 +This is the Xero Projects API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/project_create_or_update.py b/xero_python/project/models/project_create_or_update.py index 50c032d7..ebf350e8 100644 --- a/xero_python/project/models/project_create_or_update.py +++ b/xero_python/project/models/project_create_or_update.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Projects API +Xero Projects API - This is the Xero Projects API # noqa: E501 +This is the Xero Projects API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/project_patch.py b/xero_python/project/models/project_patch.py index 0e5fbaa6..d6f1318c 100644 --- a/xero_python/project/models/project_patch.py +++ b/xero_python/project/models/project_patch.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Projects API +Xero Projects API - This is the Xero Projects API # noqa: E501 +This is the Xero Projects API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/project_status.py b/xero_python/project/models/project_status.py index 47dc5d1f..0b573eaf 100644 --- a/xero_python/project/models/project_status.py +++ b/xero_python/project/models/project_status.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Projects API +Xero Projects API - This is the Xero Projects API # noqa: E501 +This is the Xero Projects API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/project_user.py b/xero_python/project/models/project_user.py index 758c9c84..2c1775e5 100644 --- a/xero_python/project/models/project_user.py +++ b/xero_python/project/models/project_user.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Projects API +Xero Projects API - This is the Xero Projects API # noqa: E501 +This is the Xero Projects API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/project_users.py b/xero_python/project/models/project_users.py index c414e8e5..7c0c7f07 100644 --- a/xero_python/project/models/project_users.py +++ b/xero_python/project/models/project_users.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Projects API +Xero Projects API - This is the Xero Projects API # noqa: E501 +This is the Xero Projects API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/projects.py b/xero_python/project/models/projects.py index c2d76485..21eead9c 100644 --- a/xero_python/project/models/projects.py +++ b/xero_python/project/models/projects.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Projects API +Xero Projects API - This is the Xero Projects API # noqa: E501 +This is the Xero Projects API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/task.py b/xero_python/project/models/task.py index 8faa5c28..5244df2d 100644 --- a/xero_python/project/models/task.py +++ b/xero_python/project/models/task.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Projects API +Xero Projects API - This is the Xero Projects API # noqa: E501 +This is the Xero Projects API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -34,14 +34,14 @@ class Task(BaseModel): "name": "str", "rate": "Amount", "charge_type": "ChargeType", - "estimate_minutes": "float", + "estimate_minutes": "int", "project_id": "str", - "total_minutes": "float", + "total_minutes": "int", "total_amount": "Amount", - "minutes_invoiced": "float", - "minutes_to_be_invoiced": "float", - "fixed_minutes": "float", - "non_chargeable_minutes": "float", + "minutes_invoiced": "int", + "minutes_to_be_invoiced": "int", + "fixed_minutes": "int", + "non_chargeable_minutes": "int", "amount_to_be_invoiced": "Amount", "amount_invoiced": "Amount", "status": "str", @@ -228,7 +228,7 @@ def estimate_minutes(self): An estimated time to perform the task # noqa: E501 :return: The estimate_minutes of this Task. # noqa: E501 - :rtype: float + :rtype: int """ return self._estimate_minutes @@ -239,7 +239,7 @@ def estimate_minutes(self, estimate_minutes): An estimated time to perform the task # noqa: E501 :param estimate_minutes: The estimate_minutes of this Task. # noqa: E501 - :type: float + :type: int """ self._estimate_minutes = estimate_minutes @@ -274,7 +274,7 @@ def total_minutes(self): Total minutes which have been logged against the task. Logged by assigning a time entry to a task # noqa: E501 :return: The total_minutes of this Task. # noqa: E501 - :rtype: float + :rtype: int """ return self._total_minutes @@ -285,7 +285,7 @@ def total_minutes(self, total_minutes): Total minutes which have been logged against the task. Logged by assigning a time entry to a task # noqa: E501 :param total_minutes: The total_minutes of this Task. # noqa: E501 - :type: float + :type: int """ self._total_minutes = total_minutes @@ -318,7 +318,7 @@ def minutes_invoiced(self): Minutes on this task which have been invoiced. # noqa: E501 :return: The minutes_invoiced of this Task. # noqa: E501 - :rtype: float + :rtype: int """ return self._minutes_invoiced @@ -329,7 +329,7 @@ def minutes_invoiced(self, minutes_invoiced): Minutes on this task which have been invoiced. # noqa: E501 :param minutes_invoiced: The minutes_invoiced of this Task. # noqa: E501 - :type: float + :type: int """ self._minutes_invoiced = minutes_invoiced @@ -341,7 +341,7 @@ def minutes_to_be_invoiced(self): Minutes on this task which have not been invoiced. # noqa: E501 :return: The minutes_to_be_invoiced of this Task. # noqa: E501 - :rtype: float + :rtype: int """ return self._minutes_to_be_invoiced @@ -352,7 +352,7 @@ def minutes_to_be_invoiced(self, minutes_to_be_invoiced): Minutes on this task which have not been invoiced. # noqa: E501 :param minutes_to_be_invoiced: The minutes_to_be_invoiced of this Task. # noqa: E501 - :type: float + :type: int """ self._minutes_to_be_invoiced = minutes_to_be_invoiced @@ -364,7 +364,7 @@ def fixed_minutes(self): Minutes logged against this task if its charge type is `FIXED`. # noqa: E501 :return: The fixed_minutes of this Task. # noqa: E501 - :rtype: float + :rtype: int """ return self._fixed_minutes @@ -375,7 +375,7 @@ def fixed_minutes(self, fixed_minutes): Minutes logged against this task if its charge type is `FIXED`. # noqa: E501 :param fixed_minutes: The fixed_minutes of this Task. # noqa: E501 - :type: float + :type: int """ self._fixed_minutes = fixed_minutes @@ -387,7 +387,7 @@ def non_chargeable_minutes(self): Minutes logged against this task if its charge type is `NON_CHARGEABLE`. # noqa: E501 :return: The non_chargeable_minutes of this Task. # noqa: E501 - :rtype: float + :rtype: int """ return self._non_chargeable_minutes @@ -398,7 +398,7 @@ def non_chargeable_minutes(self, non_chargeable_minutes): Minutes logged against this task if its charge type is `NON_CHARGEABLE`. # noqa: E501 :param non_chargeable_minutes: The non_chargeable_minutes of this Task. # noqa: E501 - :type: float + :type: int """ self._non_chargeable_minutes = non_chargeable_minutes diff --git a/xero_python/project/models/task_create_or_update.py b/xero_python/project/models/task_create_or_update.py index 1850094b..d1b77e17 100644 --- a/xero_python/project/models/task_create_or_update.py +++ b/xero_python/project/models/task_create_or_update.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Projects API +Xero Projects API - This is the Xero Projects API # noqa: E501 +This is the Xero Projects API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -141,7 +141,7 @@ def charge_type(self, charge_type): def estimate_minutes(self): """Gets the estimate_minutes of this TaskCreateOrUpdate. # noqa: E501 - Estimated time to perform the task. EstimateMinutes has to be greater than 0 if provided. # noqa: E501 + An estimated time to perform the task # noqa: E501 :return: The estimate_minutes of this TaskCreateOrUpdate. # noqa: E501 :rtype: int @@ -152,7 +152,7 @@ def estimate_minutes(self): def estimate_minutes(self, estimate_minutes): """Sets the estimate_minutes of this TaskCreateOrUpdate. - Estimated time to perform the task. EstimateMinutes has to be greater than 0 if provided. # noqa: E501 + An estimated time to perform the task # noqa: E501 :param estimate_minutes: The estimate_minutes of this TaskCreateOrUpdate. # noqa: E501 :type: int diff --git a/xero_python/project/models/tasks.py b/xero_python/project/models/tasks.py index b6dd038d..4a07c612 100644 --- a/xero_python/project/models/tasks.py +++ b/xero_python/project/models/tasks.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Projects API +Xero Projects API - This is the Xero Projects API # noqa: E501 +This is the Xero Projects API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/time_entries.py b/xero_python/project/models/time_entries.py index 1147f620..cf7b6058 100644 --- a/xero_python/project/models/time_entries.py +++ b/xero_python/project/models/time_entries.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Projects API +Xero Projects API - This is the Xero Projects API # noqa: E501 +This is the Xero Projects API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/time_entry.py b/xero_python/project/models/time_entry.py index 0e37eeb8..332fb2b3 100644 --- a/xero_python/project/models/time_entry.py +++ b/xero_python/project/models/time_entry.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Projects API +Xero Projects API - This is the Xero Projects API # noqa: E501 +This is the Xero Projects API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/time_entry_create_or_update.py b/xero_python/project/models/time_entry_create_or_update.py index 2d78afb2..7a5b1549 100644 --- a/xero_python/project/models/time_entry_create_or_update.py +++ b/xero_python/project/models/time_entry_create_or_update.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero Projects API +Xero Projects API - This is the Xero Projects API # noqa: E501 +This is the Xero Projects API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ diff --git a/xero_python/rest.py b/xero_python/rest.py index 6bcf709b..db0e84a6 100644 --- a/xero_python/rest.py +++ b/xero_python/rest.py @@ -1,12 +1,12 @@ # coding: utf-8 """ - Xero OAuth 2 Identity Service API +Xero OAuth 2 Identity Service API - These endpoints are related to managing authentication tokens and identity for Xero API # noqa: E501 +These endpoints are related to managing authentication tokens and identity for Xero API # noqa: E501 - Contact: api@xero.com - Generated by: https://openapi-generator.tech +Contact: api@xero.com +Generated by: https://openapi-generator.tech """ @@ -30,6 +30,7 @@ class RESTResponse(io.IOBase): + def __init__(self, resp): self.urllib3_response = resp self.status = resp.status @@ -52,6 +53,7 @@ def getheader(self, name, default=None): class RESTClientObject(object): + def __init__(self, configuration, pools_size=4, maxsize=None): # urllib3.PoolManager will pass all kw parameters to connectionpool # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75 # noqa: E501 @@ -74,9 +76,9 @@ def __init__(self, configuration, pools_size=4, maxsize=None): addition_pool_args = {} if configuration.assert_hostname is not None: - addition_pool_args[ - "assert_hostname" - ] = configuration.assert_hostname # noqa: E501 + addition_pool_args["assert_hostname"] = ( + configuration.assert_hostname + ) # noqa: E501 if maxsize is None: if configuration.connection_pool_maxsize is not None: