Sign in
cost

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

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}/cost

Path parameters

portfolioIdstring required

ID of the Portfolio

Query parameters

start_datestring date required
Example:2021-12-31

Start date of the cost data request. Must not precede the earliest pop_start_date of the given Portfolio's Task Orders.

end_datestring date required
Example:2026-12-31

End date of the cost data request. Must not succeed the latest pop_end_date of the given Portfolio's Task Orders.

Headers

X-Target-Impact-Level'IL2' | 'IL4' | 'IL5' | 'IL6' | 'TS'

List of available Impact Levels for target Cloud Environments

Target Impact Level for this request. Optional header which allows an ATAT implementation to route a request to a more specific environment if more than one is available at a given endpoint.

X-Atat-Api-Versionstring

This header may be provided by an ATAT client implementation to provide context for the ATAT API specification that it expects to be compatible with. Implementations may choose to adapt their response to conform to the expected API version. If not provided by the client, the server should assume the client supports the latest version of this specification.

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