DOdod-ccpo
cost

Returns cost data for a Portfolio, broken down by Task Order & CLINs

Changed on

Queries CSP for actual or forecasted cost data across a Portfolio. Queries should return data for all months included in date ranges. For example, a start_date of "2022-01-25" and end_date of "2022-03-02" should return data for January, February and March. It is expected that actual results will be provided for all months which have been invoiced while forecast data will be provided for all future months.

get/portfolios/{portfolioId}/costs

Request

  • The document declares no server URL.
  • Auth
    OpenID Connect (https://cognito-idp-fips.us-gov-west-1.amazonaws.com/us-gov-west-1_2e6R3aYgi/.well-known/openid-configuration, scopes: atat/read-cost)

Query parameters

start_datestring date required
Example:2023-12

Start date of the cost data request in YYYY-MM format. Must not precede the earliest pop_start_date of the given Portfolio's Task Orders.

end_datestring date required
Example:2026-12

End date of the cost data request in YYYY-MM format. Must not exceed the latest pop_end_date of the given Portfolio's Task Orders.

Response

Cost operation successful

Example response

{
  "task_orders": [
    {
      "clins": [
        {
          "actual": {
            "total": "12345.67",
            "results": [
              {
                "month": "2022-12"
              }
            ]
          },
          "forecast": {
            "total": "12345.67",
            "results": [
              {
                "month": "2022-12"
              }
            ]
          }
        }
      ]
    }
  ]
}

Changes

  • 0290bea4247cRevision changes
    • warning

      deleted the header request parameter X-Atat-Api-Version

    • warning

      deleted the path request parameter portfolioId

    • info

      added the new optional header request parameter X-Atat-Api-Version to all path's operations

  • 9fbf5defc05aRevision changes
    • info

      endpoint added