Xero Python SDK

repository·master·Indexed 41 days ago

Official SDK providing programmatic access to Xero's suite of APIs, including Accounting, Payroll, Projects, and Files. It enables developers to build integrations with small business accounting data using Python, featuring full support for OAuth 2.0 authentication, Machine-to-Machine (M2M) custom connections, and App Store subscription management.

Tokens: 376K
Snippets: 653
Records: 997
Agent score: 51%

What's inside Xero

Overview of FilesApi
master
The FilesApi provides methods to manage files and folders within Xero. This includes uploading files, creating folders, managing file associations with other Xero objects (like Contacts), and retrieving file content. All requests are relative to https://api.xero.com/files.xro/1.0.
https://github.com/xeroapi/xero-python/blob/master/xero_python/file/docs/FilesApi.md
Access RepeatingInvoices via the RepeatingInvoices model
master
The RepeatingInvoices model is a container used to hold a collection of RepeatingInvoice objects. It contains a single primary property:
- repeating_invoices: A list[RepeatingInvoice] containing the individual repeating invoice records. This property is optional.
https://github.com/xeroapi/xero-python/blob/master/xero_python/accounting/docs/RepeatingInvoices.md
Understand the TimesheetObject model
master
The TimesheetObject is a container model used in the Xero Payroll NZ API. It acts as a wrapper that can contain pagination metadata, error details (problems), or the actual Timesheet data.
Depending on the API response, one or more of the following properties may be present:
- pagination: Metadata for handling paginated results.
- problem: Details regarding API errors or issues encountered.
- timesheet: The core Timesheet data object.
https://github.com/xeroapi/xero-python/blob/master/xero_python/payrollnz/docs/TimesheetObject.md
Use the BalanceSheetAccountType model
master
The BalanceSheetAccountType model represents a grouping of accounts categorized by a specific account type within a balance sheet. It provides the total value for that category and a list of the individual account details.
https://github.com/xeroapi/xero-python/blob/master/xero_python/finance/docs/BalanceSheetAccountType.md
Understand the EmployeeLeaveBalance model
master
The EmployeeLeaveBalance model represents an employee's current balance for a specific type of leave within Xero Payroll NZ. It contains details about the leave type and the numerical balance available to the employee.
https://github.com/xeroapi/xero-python/blob/master/xero_python/payrollnz/docs/EmployeeLeaveBalance.md
Understand the Allocations model properties
master
The Allocations model in the Xero Accounting API is used to represent a collection of allocation objects. It contains a single primary property:
- allocations: A list[Allocation] containing the individual allocation records. This property is optional.
https://github.com/xeroapi/xero-python/blob/master/xero_python/accounting/docs/Allocations.md
Create a CreateUsageRecord model
master
The CreateUsageRecord model is used to define a new usage record for a product. It requires a quantity and a timestamp indicating when the consumption occurred.
Properties
Property Type Description
quantity int The initial quantity for the usage record. Must be a whole number $\ge$ 0.
timestamp datetime The UTC DateTime of when the product was consumed or used.
https://github.com/xeroapi/xero-python/blob/master/xero_python/appstore/docs/CreateUsageRecord.md
Understand the PayslipObject structure
master
The PayslipObject is a container used in the Xero Payroll UK API to return payslip data. It is a wrapper that may contain pagination metadata, error details, or the actual payslip data.
Available properties:
- pagination: [Optional] Contains pagination information if the response is a list of objects.
- problem: [Optional] Contains error details if the request encountered a problem.
- pay_slip: [Optional] Contains the actual Payslip data object.
https://github.com/xeroapi/xero-python/blob/master/xero_python/payrolluk/docs/PayslipObject.md
Understand the ReimbursementObject model
master
The ReimbursementObject is a container model used in the Payroll NZ API. It encapsulates the actual reimbursement data along with optional pagination and error information.
Properties
Name Type Description Notes
pagination Pagination Pagination metadata [optional]
problem Problem Error details if the request failed [optional]
reimbursement Reimbursement The core reimbursement data [optional]
https://github.com/xeroapi/xero-python/blob/master/xero_python/payrollnz/docs/ReimbursementObject.md

Property	Type	Description
`quantity`	`int`	The initial quantity for the usage record. Must be a whole number $\ge$ 0.
`timestamp`	`datetime`	The UTC DateTime of when the product was consumed or used.

Name	Type	Description	Notes
`pagination`	`Pagination`	Pagination metadata	[optional]
`problem`	`Problem`	Error details if the request failed	[optional]
`reimbursement`	`Reimbursement`	The core reimbursement data	[optional]

Understand the EmployeeLeaveBalances model

master

The EmployeeLeaveBalances model is a container used in the Xero Payroll UK API to return a collection of leave balances for employees. It includes metadata for pagination, potential error details via the problem field, and the actual list of leave balances.

Properties

Name	Type	Description
`pagination`	`Pagination`	[optional] Metadata for paginating through results.
`problem`	`Problem`	[optional] Details regarding any errors encountered.
`leave_balances`	`list[EmployeeLeaveBalance]`	[optional] A list of individual `EmployeeLeaveBalance` objects.

Understand the EmployeeObject model structure
master
The EmployeeObject is a wrapper model used in the Payroll NZ API. It serves as a container that can hold an Employee resource, pagination metadata, or error information if the request encountered a problem.
Possible properties include:
- employee: The actual Employee resource data (optional).
- pagination: Metadata for paginated responses (optional).
- problem: Details regarding any errors or issues encountered (optional).
https://github.com/xeroapi/xero-python/blob/master/xero_python/payrollnz/docs/EmployeeObject.md
Understand the TrackingCategories model structure
master
The TrackingCategories model is a container object used in the Xero Payroll NZ API to return a list of tracking categories. It contains the following properties:
- tracking_categories: An optional list of TrackingCategory objects.
- pagination: An optional Pagination object containing metadata about the result set.
- problem: An optional Problem object used for error reporting.
https://github.com/xeroapi/xero-python/blob/master/xero_python/payrollnz/docs/TrackingCategories.md