Xero Python SDK

https://github.com/xeroapi/xero-python
Admin
The Xero Python SDK simplifies access to Xero's APIs, enabling developers to build applications...
Tokens:909,977
Snippets:4,755
Trust Score:7.7
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Get Invoice SDK Example

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/accounting/index.html

Python example demonstrating how to configure the ApiClient and call the get_invoice method.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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_invoice():
    api_instance = AccountingApi(api_client)
    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
    invoice_id = '00000000-0000-0000-0000-000000000000'
    
    try:
        api_response = api_instance.get_invoice(xero_tenant_id, invoice_id, unitdp)
        print(api_response)
    except AccountingBadRequestException as e:
        print("Exception when calling AccountingApi->getInvoice: %s\n" % e)
```

--------------------------------

### Configure and call postSetup in Python

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/accounting/index.html

This example demonstrates how to initialize the Xero API client, define the setup object with accounts and conversion details, and execute the postSetup request.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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_setup():
    api_instance = AccountingApi(api_client)
    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
    idempotency_key = 'KEY_VALUE'

    account = Account(
        code = "123",
        name = "Business supplies",
        type = AccountType.EXPENSE)
    
    accounts = []    
    accounts.append(account)

    conversion_date = ConversionDate(
        month = 10,
        year = 2020)
    
    conversion_balances = []

    setup = Setup(
        accounts = accounts,
        conversion_date = conversion_date,
        conversion_balances = conversion_balances)
    
    try:
        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)
```

--------------------------------

### Get Folders Python SDK Example

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/files/index.html

Example showing how to configure the ApiClient and call get_folders using the Xero Python SDK.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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)
```

--------------------------------

### Get Trial Balance with Python SDK

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/finance/index.html

Example showing how to configure the ApiClient and call the get_financial_statement_trial_balance method.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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)
```

--------------------------------

### Create Employee Leave Setup Python SDK Example

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/payroll-nz/index.html

Configures the Xero API client and demonstrates how to call the create_employee_leave_setup method.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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)
```

--------------------------------

### Get Employee Opening Balances Python SDK

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/payroll-nz/index.html

Example showing how to configure the API client and call the get_employee_opening_balances method.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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)
```

--------------------------------

### Get Reimbursement by ID (Python)

Source: https://github.com/xeroapi/xero-python/blob/master/xero_python/payrolluk/docs/PayrollUkApi.md

Retrieves a specific reimbursement using its unique ID. Requires OAuth2 authentication setup and provides an example of API client configuration and error handling.

```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
reimbursement_id = 'reimbursement_id_example' # str | Identifier for the reimbursement
try:
    # Retrieves a specific reimbursement by using a unique reimbursement id
    api_response = api_instance.get_reimbursement(xero_tenant_id, reimbursement_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PayrollUkApi->get_reimbursement: %s\n" % e)
```

--------------------------------

### post_setup OAuth2 Authentication Example

Source: https://github.com/xeroapi/xero-python/blob/master/xero_python/accounting/docs/AccountingApi.md

Demonstrates how to configure the Xero API client with OAuth2 credentials and call the post_setup method to initialize account data.

```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
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, idempotency_key=idempotency_key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountingApi->post_setup: %s\n" % e)
```

--------------------------------

### Get Employee Salary and Wages with OAuth2

Source: https://github.com/xeroapi/xero-python/blob/master/xero_python/payrolluk/docs/PayrollUkApi.md

Demonstrates how to retrieve a specific employee's salary and wages using the PayrollUkApi. Requires OAuth2 authentication setup and provides an example of API client configuration for token management.

```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
employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object
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)
try:
    # Retrieves a specific employee's salary and wages by using a unique employee ID
    api_response = api_instance.get_employee_salary_and_wages(xero_tenant_id, employee_id, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PayrollUkApi->get_employee_salary_and_wages: %s\n" % e)
```

--------------------------------

### Create Task SDK Example

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/projects/index.html

Example demonstrating how to configure the ApiClient and call the create_task method using the ProjectApi.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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)
```

--------------------------------

### Create Folder Python SDK Example

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/files/index.html

Example showing how to configure the ApiClient and call the create_folder method using the Xero Python SDK.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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)
```

--------------------------------

### Get Manual Journals History Python SDK Example

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/accounting/index.html

Example demonstrating how to configure the ApiClient and call the get_manual_journals_history method.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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_manual_journals_history():
    api_instance = AccountingApi(api_client)
    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
    manual_journal_id = '00000000-0000-0000-0000-000000000000'
    
    try:
        api_response = api_instance.get_manual_journals_history(xero_tenant_id, manual_journal_id)
        print(api_response)
    except AccountingBadRequestException as e:
        print("Exception when calling AccountingApi->getManualJournalsHistory: %s\n" % e)
```

--------------------------------

### Get Currencies Python SDK Example

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/accounting/index.html

Example showing how to configure the ApiClient and call get_currencies with optional filtering and ordering parameters.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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)
```

--------------------------------

### post_setup

Source: https://github.com/xeroapi/xero-python/blob/master/xero_python/accounting/docs/AccountingApi.md

Sets the chart of accounts, the conversion date and conversion balances for a Xero tenant.

```APIDOC
## post_setup

### Description
Sets the chart of accounts, the conversion date and conversion balances.

### Parameters
#### Path Parameters
- **xero_tenant_id** (str) - Required - Xero identifier for Tenant

#### Request Body
- **setup** (Setup) - Required - Object including an accounts array, a conversion balances array and a conversion date object in body of request

#### Optional Parameters
- **idempotency_key** (str) - Optional - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

### Response
- **ImportSummaryObject** - Returns an object summarizing the import results.
```

--------------------------------

### Get Inbox Python SDK Example

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/files/index.html

Example showing how to configure the ApiClient and call get_inbox using the Xero Python SDK.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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)
```

--------------------------------

### POST /Setup

Source: https://github.com/xeroapi/xero-python/blob/master/xero_python/accounting/docs/AccountingApi.md

Sets the chart of accounts, the conversion date and conversion balances.

```APIDOC
## POST /Setup

### Description
Sets the chart of accounts, the conversion date and conversion balances.

### Method
POST

### Endpoint
/Setup
```

--------------------------------

### Get File Content Python SDK Example

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/files/index.html

Example demonstrating how to configure the ApiClient and call get_file_content using the Xero Python SDK.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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)
```

--------------------------------

### Create Employee Opening Balances Python SDK Example

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/payroll-nz/index.html

Example demonstrating how to configure the API client and call the create_employee_opening_balances method using the xero-python SDK.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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)
```

--------------------------------

### Get File Associations Python SDK Example

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/files/index.html

Example demonstrating how to configure the ApiClient and call get_file_associations using the Xero Python SDK.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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)
```

--------------------------------

### Create Employment SDK Sample

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/payroll-nz/index.html

Configures the Xero API client and demonstrates how to call the create_employment method using the PayrollNzApi class.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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)
```

--------------------------------

### Get Expense Claim Python SDK Example

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/accounting/index.html

Example showing how to configure the ApiClient and call get_expense_claim using a specific expense claim UUID.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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_expense_claim():
    api_instance = AccountingApi(api_client)
    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
    expense_claim_id = '00000000-0000-0000-0000-000000000000'
    
    try:
        api_response = api_instance.get_expense_claim(xero_tenant_id, expense_claim_id)
        print(api_response)
    except AccountingBadRequestException as e:
        print("Exception when calling AccountingApi->getExpenseClaim: %s\n" % e)
```

--------------------------------

### Create Benefit Python SDK Example

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/payroll-uk/index.html

Demonstrates configuring the Xero API client and calling the create_benefit method with the required parameters.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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)
```

--------------------------------

### Get Receipts SDK Example

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/accounting/index.html

Configures the ApiClient and demonstrates calling the get_receipts method with optional filters and parameters.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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_receipts():
    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 = 'ReceiptNumber ASC'
    
    try:
        api_response = api_instance.get_receipts(xero_tenant_id, if_modified_since, where, order, unitdp)
        print(api_response)
    except AccountingBadRequestException as e:
        print("Exception when calling AccountingApi->getReceipts: %s\n" % e)
```

--------------------------------

### Initialize SDK and create an asset in Python

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/assets/index.html

Configures the ApiClient with OAuth2 credentials and demonstrates how to call the create_asset method using the xero-python SDK.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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)
```

--------------------------------

### Get Journals Python SDK Example

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/accounting/index.html

Configures the ApiClient and demonstrates calling the get_journals method with required parameters.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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_journals():
    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'
    
    try:
        api_response = api_instance.get_journals(xero_tenant_id, if_modified_since, offset, payments_only)
        print(api_response)
    except AccountingBadRequestException as e:
        print("Exception when calling AccountingApi->getJournals: %s\n" % e)
```

--------------------------------

### Initializing API Clients

Source: https://github.com/xeroapi/xero-python/blob/master/README.md

Demonstrates how to initialize different API clients (e.g., AccountingApi, AssetApi) using an ApiClient instance.

```APIDOC
## Initializing API Clients

Access different API sets and their methods through initialized clients.

```python
# Assuming 'api_client' is an initialized ApiClient instance
accounting_api = AccountingApi(api_client)
read_accounts = accounting_api.get_accounts(xero_tenant_id)

asset_api = AssetApi(api_client)
read_assets = asset_api.get_assets(xero_tenant_id)
# ... other API sets follow the same pattern
```
```

--------------------------------

### Create Credit Notes Python SDK Example

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/accounting/index.html

Example demonstrating how to configure the ApiClient and use the AccountingApi to create credit notes.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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_credit_notes():
    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(
        contact_id = "00000000-0000-0000-0000-000000000000")

    line_item = LineItem(
        description = "Foobar",
        quantity = 1.0,
        unit_amount = 20.0,
        account_code = "000")
    
    line_items = []    
    line_items.append(line_item)

    credit_note = CreditNote(
        type = "ACCPAYCREDIT",
        contact = contact,
        date = curr_date,
        line_items = line_items)

    creditNotes = CreditNotes( 
        credit_notes = [credit_note])
    
    try:
        api_response = api_instance.create_credit_notes(xero_tenant_id, creditNotes, summarize_errors, unitdp, idempotency_key)
        print(api_response)
    except AccountingBadRequestException as e:
        print("Exception when calling AccountingApi->createCreditNotes: %s\n" % e)
```

--------------------------------

### Get Associations Count Python SDK

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/files/index.html

Example of configuring the ApiClient and calling get_associations_count to retrieve association data.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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)
```

--------------------------------

### Create Time Entry Python SDK Example

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/projects/index.html

Example demonstrating how to configure the ApiClient and call the create_time_entry method using the ProjectApi.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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)
```

--------------------------------

### Get Overpayments Python SDK Example

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/accounting/index.html

Configures the ApiClient and demonstrates calling the get_overpayments method with optional filters and parameters.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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_overpayments():
    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=="AUTHORISED"'
    order = 'Status ASC'
    references = ["Ref1", "Ref2"]
    
    try:
        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)
```

--------------------------------

### Get Employee Pay Template Python SDK

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/payroll-uk/index.html

Example showing how to configure the ApiClient and call get_employee_pay_template using the PayrollUkApi.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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)
```

--------------------------------

### Get Employee Leaves Python SDK

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/payroll-uk/index.html

Example usage of the PayrollUkApi to fetch leave records for a given employee ID.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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)
```

--------------------------------

### Create Employee Python SDK Example

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/payroll-au/index.html

Configures the Xero API client and demonstrates how to create an employee using the PayrollAuApi.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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)
```

--------------------------------

### Get Employee Pay Templates Python SDK

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/payroll-nz/index.html

Example showing how to configure the API client and call the get_employee_pay_templates method.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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)
```

--------------------------------

### Create Superfund Python SDK Example

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/payroll-au/index.html

Example demonstrating how to configure the Xero API client and call the create_superfund method.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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)
```

--------------------------------

### Python SDK Implementation

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/accounting/index.html

Example showing how to configure the ApiClient and call get_purchase_order_attachments using the xero-python SDK.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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_attachments():
    api_instance = AccountingApi(api_client)
    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
    purchase_order_id = '00000000-0000-0000-0000-000000000000'
    
    try:
        api_response = api_instance.get_purchase_order_attachments(xero_tenant_id, purchase_order_id)
        print(api_response)
    except AccountingBadRequestException as e:
        print("Exception when calling AccountingApi->getPurchaseOrderAttachments: %s\n" % e)
```

--------------------------------

### Get File Python SDK

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/files/index.html

Example of configuring the ApiClient and calling get_file to retrieve details for a specific file ID.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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)
```

--------------------------------

### Create an account using OAuth2 authentication

Source: https://github.com/xeroapi/xero-python/blob/master/xero_python/accounting/docs/AccountingApi.md

This example demonstrates how to configure the Xero API client with OAuth2 credentials and call the create_account method to add a new account.

```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
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, idempotency_key=idempotency_key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountingApi->create_account: %s\n" % e)
```

--------------------------------

### Get Employee Leave Types Python SDK

Source: https://github.com/xeroapi/xero-python/blob/master/docs/v1/payroll-uk/index.html

Example usage of the PayrollUkApi to fetch leave types for a given employee ID.

```python
# configure api_client for use with xero-python sdk client
api_client = ApiClient(
    Configuration(
        debug=false,
        oauth2_token=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)
```
Tokens:
Raw