RIrillet
Contracts

Lists all contracts

Changed on

Returns contracts with pagination and rich filters (subsidiary, customer, status, date ranges). Use this to discover contract ids, check lifecycle state, or drive reporting extracts.

get/contracts

Request

Query parameters

limitinteger

Maximum number of rows to return in the page.

cursorstring

If defined, a cursor to retrieve the next page.

Example:iLQvkEj3sh3UiweC

Pagination cursor to navigate through the full response.

subsidiary_idstring uuid

Subsidiary to be used when filtering data

status'ACTIVE' | 'IN_EFFECT' | 'CANCELLED' | 'ENDED' | 'AMENDED'

Optional status filter (allowed values depend on the resource).

start_date.gtstring date

Minimum start date value to filter by (exclusive)

start_date.gtestring date

Minimum start date value to filter by (inclusive)

start_date.ltstring date

Maximum start date value to filter by (exclusive)

start_date.ltestring date

Maximum start date value to filter by (inclusive)

end_date.gtstring date

Minimum end date value to filter by (exclusive)

end_date.gtestring date

Minimum end date value to filter by (inclusive)

end_date.ltstring date

Maximum end date value to filter by (exclusive)

end_date.ltestring date

Maximum end date value to filter by (inclusive)

customer_idstring uuid

Optional UUID filter by customer.

Response

OK

Example response

{
  "contracts": [
    {
      "name": "New API Contract",
      "items": [
        {
          "price": {
            "amount": {
              "amount": "1.01",
              "currency": "USD"
            },
            "interval_months": 1
          },
          "quantity": "1",
          "total_value": {
            "amount": "1.01",
            "currency": "USD"
          },
          "progress_plan": {
            "milestones": [
              {
                "allocated_amount": {
                  "amount": "1.01",
                  "currency": "USD"
                },
                "amount": {
                  "amount": "1.01",
                  "currency": "USD"
                },
                "external_references": [
                  {
                    "type": "xyzSystemId",
                    "id": "234",
                    "url": "https://xyzsystempage.com/ids/234"
                  }
                ]
              }
            ]
          },
          "discount": {
            "amount_off": {
              "amount": "1.01",
              "currency": "USD"
            }
          },
          "tax_rate": {
            "percentage": "0",
            "tax_amount": {
              "amount": "1.01",
              "currency": "USD"
            },
            "country": "US"
          },
          "external_references": [
            {
              "type": "xyzSystemId",
              "id": "234",
              "url": "https://xyzsystempage.com/ids/234"
            }
          ],
          "usage_minimum_commitment": {
            "amount": {
              "amount": "1.01",
              "currency": "USD"
            },
            "revenue_account": "11112"
          },
          "bundle": {
            "components": [
              {
                "quantity": "1",
                "allocated_amount": {
                  "amount": "1.01",
                  "currency": "USD"
                }
              }
            ]
          },
          "declared_ssp": {
            "amount": "1.01",
            "currency": "USD"
          }
        }
      ],
      "invoicing": {
        "day": 1
      },
      "usage_configuration": {
        "contract_level_minimum_commitment": {
          "amount": {
            "amount": "1.01",
            "currency": "USD"
          },
          "revenue_account": "11112"
        }
      },
      "total_value": {
        "amount": "1.01",
        "currency": "USD"
      },
      "external_references": [
        {
          "type": "xyzSystemId",
          "id": "234",
          "url": "https://xyzsystempage.com/ids/234"
        }
      ],
      "exchange_rate": {
        "base": "USD",
        "target": "USD"
      },
      "purchase_order_number": "PO-12345",
      "billing_address": {
        "line1": "123 Main St",
        "line2": "Apt 4B",
        "city": "Nashville",
        "state": "TN",
        "zip_code": "37201",
        "country": "US"
      },
      "shipping_address": {
        "line1": "123 Main St",
        "line2": "Apt 4B",
        "city": "Nashville",
        "state": "TN",
        "zip_code": "37201",
        "country": "US"
      }
    }
  ],
  "pagination": {
    "next_cursor": "iLQvkEj3sh3UiweC"
  }
}

Changes

  • c393d0102005Revision changes
    • breaking

      the response property //// became optional for the status

    • breaking

      the //// response's property type changed from number to string, and format from no format to number for status

    • breaking

      the //// response's property type changed from string to no type for status

    • breaking

      the ///////// response's property type changed from number to string, and format from no format to number for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added to the //// response property allOf list for the response status

    • info

      added subschema #1 subschema #2 to the /// response property allOf list for the response status

    • info

      removed the DAILY enum value from the //// response property for the response status

    • info

      removed the EVEN_PERIOD enum value from the //// response property for the response status

    • info

      added the required property // to the response with the status

    • info

      added the required property //// to the response with the status