Default Page Size: Difference between revisions
No edit summary |
No edit summary |
||
| Line 18: | Line 18: | ||
# Select the required '''[[Default Page Size]]'''. | # Select the required '''[[Default Page Size]]'''. | ||
#: This controls the number of records that will be returned on a single call for most endpoints. See the recommended page size below for more information. | #: This controls the number of records that will be returned on a single call for most endpoints. See the recommended page size below for more information. | ||
# Click '''Save'''. | |||
== Recommended Default Page Size == | == Recommended Default Page Size == | ||
Revision as of 19:06, 9 September 2026
A Query or call sent to MYOB or Xero returns a Page of results wherever Pagination is possible.
The Default Page Size setting controls the number of Records returned per page.
A Record contains all Line Items details for that particular endpoint.
Increasing the default page size decreases the calls required to fetch data, which in turn makes refreshes faster.
How to change the Default Page Size for a model
To change the default page size for a [Models|model]] details, follow these steps.
- Click on Models on the menu in the left-hand side;
- Find the model you want to work on and click View;
- Select the Settings tab;
- Click on the Edit Model button;
- Select the required Default Page Size.
- This controls the number of records that will be returned on a single call for most endpoints. See the recommended page size below for more information.
- Click Save.
Recommended Default Page Size
The recommended default page size varies based on the type of model or data file you are pulling from.
MYOB Models
The recommended page size for MYOB Business API is 400 records per page, with a values ranging from 50 to 1000 results per page.
- Smaller data files will perform faster using a larger page size (1000).
- Larger data files will perform more reliably using a smaller number (200).
- MYOB recommends a value of 400 to resolve error 8002 or error 8003.
The page size settings apply to all the endpoints except the following:
- Company
- CompanyPreferences
- TaxCodes
- BalanceSheetSummaryReport,
- BalanceSheetSummaryReportTable,
- BalanceSheetSummaryReportMultiPeriodTable
- PayrollTaxes
- PayrollTaxTables
- PayrollWages
Xero Accounting Models
The recommended page size for Xero Accounting models is 1000 with values ranging from 50 to 1000.
The Page size settings apply to the following endpoints:
- BankTransactions
- BankTransactionsExpanded
- ContactsExpanded
- CreditNotesExpanded
- InvoicesExpanded
- InvoicesExpandedTable
- ManualJournalsExpanded
- OverpaymentsExpanded
- Payments
- PaymentsTable
- PrepaymentsExpanded
- PurchaseOrders
Xero Assets Models
The recommended page size for Xero Assets API is 200 with possible values ranging from 10 to 200 records per page.
The Page size settings apply to the following endpoints:
Xero Projects Models
The recommended page size for Xero Projects API is 500 with values ranging from 50 to 500.
The Page size settings apply to the following endpoints:
Related Topics
References
Increase the performance of your Xero OData Feed using the Page Size setting