Sign in

v1

latestOpenAPI 3.0.32026-07-26362271803.3 KB
Revenue Recognition

List Contract Bundles

    Retrieve a list of contract bundles with optional filtering and sorting.

    Supports including soft-deleted records for audit and recovery purposes.
    When include_deleted=true, returns ONLY deleted records instead of active records.
    Deleted records contain minimal data: 'id', 'is_deleted=true', 'deleted_at' timestamp,
    and 'last_modified_at'. When 'false' or omitted, returns ONLY active records.
    This provides clean separation between active and deleted data.
get/rr/api/v1/contracts/{contract_id}/bundles

Path parameters

contract_idinteger required

Query parameters

include_deletedboolean

When set to 'true', returns ONLY deleted records instead of active records. Deleted records contain minimal data: 'id', 'is_deleted=true', 'deleted_at' timestamp, and 'last_modified_at'. When 'false' or omitted, returns ONLY active records. This provides clean separation between active and deleted data.

last_modified_at__gtestring

Filter for records modified on or after this timestamp. Format: ISO 8601 (e.g., '2024-01-01T00:00:00Z' or '2024-01-01'). Works with both active records and deleted records (filters by deletion time for deleted records).

last_modified_at__ltestring

Filter for records modified on or before this timestamp. Format: ISO 8601 (e.g., '2024-12-31T23:59:59Z' or '2024-12-31'). Works with both active records and deleted records (filters by deletion time for deleted records).

Response

idinteger required
is_deletedboolean required
deleted_atstring date-time nullable required
end_datestring date nullable

Bundle end date. Required for standard contracts. For evergreen contracts this may be null to follow the contract timeline, or set to a billing-period end date.

rebalance_journal_entries_indefinitelyboolean

Should only be used for Evergreen contracts. When true, linked invoice journal entries are rebalanced on each evergreen contract extension.

bundle_namestring required
bundle_descriptionstring nullable
start_datestring date required
use_daily_accountingboolean
proration_method'standard' | 'thirty_day' | 'daily'
  • standard - Standard (actual month length)
  • thirty_day - Fixed 30-day month
  • daily - Daily
use_catchupboolean
catchup_datestring date nullable
created_atstring date-time required
last_modified_atstring date-time required
customerinteger required
contractinteger required