Revenue schedule lines

Line items in a contract revenue schedule represent a single revenue for a contract line. You create, update, and delete revenue schedule line objects through operations on the owning contract revenue schedule.

List contract revenue schedules

get/objects/contracts/revenue-schedule-line

Returns up to 100 object references from the collection with a key, ID, and link for each revenue schedule line. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": [
    • {
      • "key": "84",
      • "id": "84",
      • "href": "/objects/contracts/revenue-schedule-line/84"
      },
    • {
      • "key": "85",
      • "id": "85",
      • "href": "/objects/contracts/revenue-schedule-line/85"
      },
    • {
      • "key": "60",
      • "id": "60",
      • "href": "/objects/contracts/revenue-schedule-line/60"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}

Get a contract revenue schedule line

get/objects/contracts/revenue-schedule-line/{key}

Returns detailed information for a specified contract revenue schedule line.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the contract revenue schedule line.

Example: 897
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "key": "14424",
    • "id": "14424",
    • "contractRevenueSchedule": {
      • "id": "1578",
      • "key": "1578",
      • "href": "/objects/contracts/revenue-schedule/1578"
      },
    • "scheduledOperationKey": null,
    • "scheduledAmount": "16666.66",
    • "scheduledBaseAmount": "16666.66",
    • "postedBaseAmount": null,
    • "scheduledExchangeRate": "1.000000000000",
    • "scheduledPostingDate": "2024-02-29",
    • "actualPostingDate": null,
    • "derivedPostingDate": "2024-02-29",
    • "posted": false,
    • "isHistorical": false,
    • "state": "open",
    • "journalEntry": {
      • "key": null,
      • "id": null
      },
    • "computationMemo": null,
    • "meaDetails": null,
    • "adjustedFor": "",
    • "approvedHours": null,
    • "sourceHours": null,
    • "percentageRecognized": null,
    • "audit": {
      • "createdDateTime": "2024-02-01T06:14:00Z",
      • "modifiedDateTime": "2024-03-28T04:14:44Z",
      • "createdBy": "1",
      • "modifiedBy": null
      },
    • "linkedBillingScheduleLine": {
      • "id": null,
      • "key": null
      },
    • "href": "/objects/contracts/revenue-schedule-line/14424"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Query revenue schedule lines

post/services/core/query

Use the query service to find revenue schedule lines that meet certain criteria and to specify the properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}