XOCRM icon

XOCRM

Interact with the XOCRM API to manage clients, notes, reminders, links, and more

Actions43

Expiration → Get

AI-generated

Summary

Retrieve an expiration record by its ID from the XOCRM system, with optional timezone adjustment and response simplification.

Inputs

  • Expiration ID (required) — The unique numerical identifier of the expiration record to retrieve.
  • Timezone — Select the timezone to convert date/time fields. Use 'UTC' if your input is already in UTC.
  • Simplify — If true, returns a simplified version of the expiration data with only key fields; otherwise returns the full raw API response.

Output shape

a single expiration record object

The output returns the expiration data matching the specified ID. If Simplify is enabled, only key fields like id, itemName, itemType, expirationDate, status, vendor, and clientId are included. Date/time fields are adjusted to the specified timezone. Rate limit metadata may be included under a '_rateLimit' property.

Examples

Example 1: Get a specific expiration by ID in Eastern timezone without simplification

Set Expiration ID to the desired numeric ID, Timezone to 'America/New_York', and Simplify to false.

Example 2: Get a simplified expiration record with date/time converted to UTC

Set Expiration ID to the target ID, Timezone to 'UTC', and Simplify to true.

Links

Discussion