RIrillet
Draft Contracts

Lists all draft contracts

Changed on

Returns draft contracts with cursor pagination. Draft contracts are staged records that appear in the Rillet UI under "Draft" for a human to approve or reject before they become active contracts.

get/draft-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

customer_idstring uuid

Optional UUID filter by customer.

Response

OK

Example response

{
  "draft_contracts": [
    {
      "external_references": [
        {
          "type": "xyzSystemId",
          "id": "234",
          "url": "https://xyzsystempage.com/ids/234"
        }
      ],
      "amount": {
        "amount": "1.01",
        "currency": "USD"
      },
      "items": [
        {
          "price": {
            "amount": {
              "amount": "1.01",
              "currency": "USD"
            },
            "interval_months": 1
          },
          "discount": {
            "amount_off": {
              "amount": "1.01",
              "currency": "USD"
            }
          },
          "declared_ssp": {
            "amount": "1.01",
            "currency": "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'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