Default Page Size: Difference between revisions

(9 intermediate revisions by 2 users not shown)

Line 8:

Increasing the default page size decreases the calls required to fetch data, which in turn makes refreshes faster.

== ~~Xero Accounting Models ==~~

== How to change the Default Page Size for a model ==

~~The default page size for Xero Accounting models is set~~ to ~~100, which is~~ the ~~default page size~~ for ~~all Xero APIs.~~

The ~~current~~ page size ~~can range~~ from 50 to 1000 ~~records returned~~ per page.

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 [[Models|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 [[OdataLink Error Code 8002: MYOB timed out while servicing the request|error 8002]] or [[OdataLink Error Code 8003: MYOB encountered a runtime exception while servicing the request|error 8003]].

The page size settings apply to all the endpoints ''except'' the following:

*[[MYOB Endpoint: Company|Company]]

*[[MYOB Endpoint: CompanyPreferences|CompanyPreferences]]

*[[MYOB Endpoint: TaxCodes|TaxCodes]]

*[[MYOB Endpoint: BalanceSheetSummaryReport|BalanceSheetSummaryReport]],

*[[MYOB Endpoint: BalanceSheetSummaryReportTable|BalanceSheetSummaryReportTable]],

*[[MYOB Endpoint: BalanceSheetSummaryReportMultiPeriodTable|BalanceSheetSummaryReportMultiPeriodTable]]

*[[MYOB Endpoint: PayrollTaxes|PayrollTaxes]]

*[[MYOB Endpoint: PayrollTaxTables|PayrollTaxTables]]

*[[MYOB Endpoint: PayrollWages|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:

Line 28:

Line 65:

*[[Xero Accounting Endpoint: PurchaseOrders|PurchaseOrders]]

== Xero Assets Models ==

The ~~legacy~~ page size for Xero Assets API ~~was 10 Assets per page.~~

=== Xero Assets Models ===

~~The current page size for a Xero Assets model can range~~ from 10 to 200 records per page.

~~''Note: We strongly recommend you set the Page Size to 200.''~~

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 Assets Endpoint: Assets|Assets]]

== Xero Projects Models ==

The ~~default~~ page size for Xero Projects API is ~~50 Projects per page.~~

=== Xero Projects Models ===

~~The current page size for a Xero Projects Model can range~~ from 50 to 500 ~~records per page~~.

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:

*[[Xero Projects Endpoint: Projects|Projects]]

Line 45:

Line 85:

*[[Xero Projects Endpoint: GetTimes|GetTimes]]

~~== MYOB Models ==~~

~~The default page size for MYOB Business API is 400 records per page, with a maximum of 1000 results per page.~~

~~The page size settings apply to all the endpoints ''except'' the following:~~

*[[MYOB Endpoint: Company|Company]]

*[[MYOB Endpoint: CompanyPreferences|CompanyPreferences]]

*[[MYOB Endpoint: TaxCodes|TaxCodes]]

*[[MYOB Endpoint: BalanceSheetSummaryReport|BalanceSheetSummaryReport]], [[MYOB Endpoint: BalanceSheetSummaryReportTable|BalanceSheetSummaryReportTable]], [[MYOB Endpoint: BalanceSheetSummaryReportMultiPeriodTable|BalanceSheetSummaryReportMultiPeriodTable]]

*[[MYOB Endpoint: PayrollTaxes|PayrollTaxes]]

*[[MYOB Endpoint: PayrollTaxTables|PayrollTaxTables]]

*[[MYOB Endpoint: PayrollWages|PayrollWages]]

== Related Topics ==

[[Editing a model's details]]

== References ==

~~== Related Topics ==~~

[https://odatalink.com/2025-03-increase-the-performance-of-your-xero-odata-feed-using-the-page-size-setting/ Increase the performance of your Xero OData Feed using the Page Size setting]

[https://developer.xero.com/documentation/best-practices/~~integration~~-~~health~~/paging/#overview Xero Paging Overview]

[https://developer.xero.com/documentation/best-practices/api-call-efficiencies/paging/#overview Xero Paging Overview]

[https://developer.myob.com/api/myob-business-api/api-overview/retrieving-data/#PAGING MYOB Paging Overview]

__NOTOC__

@@ Line 8: / Line 8: @@
 Increasing the default page size decreases the calls required to fetch data, which in turn makes refreshes faster.
-== Xero Accounting Models ==
+== How to change the Default Page Size for a model ==
-The default page size for Xero Accounting models is set to 100, which is the default page size for all Xero APIs.
-The current page size can range from 50 to 1000 records returned per page.
+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 [[Models|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 [[OdataLink Error Code 8002: MYOB timed out while servicing the request|error 8002]] or [[OdataLink Error Code 8003: MYOB encountered a runtime exception while servicing the request|error 8003]].
+The page size settings apply to all the endpoints ''except'' the following:
+*[[MYOB Endpoint: Company|Company]]
+*[[MYOB Endpoint: CompanyPreferences|CompanyPreferences]]
+*[[MYOB Endpoint: TaxCodes|TaxCodes]]
+*[[MYOB Endpoint: BalanceSheetSummaryReport|BalanceSheetSummaryReport]],
+*[[MYOB Endpoint: BalanceSheetSummaryReportTable|BalanceSheetSummaryReportTable]],
+*[[MYOB Endpoint: BalanceSheetSummaryReportMultiPeriodTable|BalanceSheetSummaryReportMultiPeriodTable]]
+*[[MYOB Endpoint: PayrollTaxes|PayrollTaxes]]
+*[[MYOB Endpoint: PayrollTaxTables|PayrollTaxTables]]
+*[[MYOB Endpoint: PayrollWages|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:
@@ Line 28: / Line 65: @@
 *[[Xero Accounting Endpoint: PurchaseOrders|PurchaseOrders]]
-== Xero Assets Models ==
-The legacy page size for Xero Assets API was 10 Assets per page.
+=== Xero Assets Models ===
-The current page size for a Xero Assets model can range from 10 to 200 records per page.
-''Note: We strongly recommend you set the Page Size to 200.''
+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 Assets Endpoint: Assets|Assets]]
-== Xero Projects Models ==
-The default page size for Xero Projects API is 50 Projects per page.
+=== Xero Projects Models ===
-The current page size for a Xero Projects Model can range from 50 to 500 records per page.
+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:
 *[[Xero Projects Endpoint: Projects|Projects]]
@@ Line 45: / Line 85: @@
 *[[Xero Projects Endpoint: GetTimes|GetTimes]]
-== MYOB Models ==
-The default page size for MYOB Business API is 400 records per page, with a maximum of 1000 results per page.
-The page size settings apply to all the endpoints ''except'' the following:
-*[[MYOB Endpoint: Company|Company]]
-*[[MYOB Endpoint: CompanyPreferences|CompanyPreferences]]
-*[[MYOB Endpoint: TaxCodes|TaxCodes]]
-*[[MYOB Endpoint: BalanceSheetSummaryReport|BalanceSheetSummaryReport]], [[MYOB Endpoint: BalanceSheetSummaryReportTable|BalanceSheetSummaryReportTable]], [[MYOB Endpoint: BalanceSheetSummaryReportMultiPeriodTable|BalanceSheetSummaryReportMultiPeriodTable]]
-*[[MYOB Endpoint: PayrollTaxes|PayrollTaxes]]
-*[[MYOB Endpoint: PayrollTaxTables|PayrollTaxTables]]
-*[[MYOB Endpoint: PayrollWages|PayrollWages]]
+== Related Topics ==
+[[Editing a model's details]]
+== References ==
-== Related Topics ==
+[https://odatalink.com/2025-03-increase-the-performance-of-your-xero-odata-feed-using-the-page-size-setting/ Increase the performance of your Xero OData Feed using the Page Size setting]
-[https://developer.xero.com/documentation/best-practices/integration-health/paging/#overview Xero Paging Overview]
+[https://developer.xero.com/documentation/best-practices/api-call-efficiencies/paging/#overview Xero Paging Overview]
 [https://developer.myob.com/api/myob-business-api/api-overview/retrieving-data/#PAGING MYOB Paging Overview]
 __NOTOC__