CompareToInput

A Compare to request for one page of the Contracts table (CRM-9612).

Row ids come from the caller because the comparison is a companion to the table's own paginated read, not a replacement for it: the client already holds the page and asks only for the movement on those rows. That keeps this endpoint out of the shared /filter router, which cannot express a request-scoped computed column.

  • contractIds
    Type: array of string 1…200
    required

    Contract IDs to compare, normally the current page. Capped so one request cannot fan out across a whole tenant.

  • period
    Type: stringenum
    required

    Comparison timeframe. MTD, QTD and YTD follow the account's fiscal calendar; last30Days and last12Months are counted back from today.

    values
    last30Daysmtdqtdytdlast12Monthscustom
  • customStart
    Type: stringFormat: datenullable

    Start date, required when period is 'custom' and ignored otherwise