Cmdlets for Xero

Build 24.0.9060

GetLimitInfo

Retrieves limit information. Use this stored procedure to monitor your API limits as you make calls against a tenant.

Procedure-Specific Information

This procedure reports information that the cmdlet caches after each API request. If no requests have been made to a tenant on a connection than this procedure will report 0 rows. Otherwise, the LastModified field reports the last time the information in the row was updated.

If the last modified time is too long ago for your application to use, then this table may be refreshed by executing a query. The query must read at least one row to ensure that an API request is triggered:

SELECT * FROM AssetTypes LIMIT 1

Result Set Columns

Name Type Description
TenantId String ID of the tenant that the limit applies to. The output contains a row for each tenant queried during the connection. Usually there is only one.
AppRemaining Integer The number of API calls the current OAuth app has this minute (max 10000). This applies across all tenants.
MinuteRemaining Integer The number of API calls the current OAuth app has this minute (max 60). This applies only to this tenant.
DayRemaining Integer The number of API calls the current OAuth app has today (max 5000). This applies only to this tenant.
RetryAfter Integer The suggested retry time, if one of the above limits was 0 on the most recent API call to the tenant.
LastModified Datetime When this information was last updated. The values in this table are only refreshed when performing API calls, so this may be older than the current time.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060