Final cost report

Reports module

GET/reports/final-cost-reportreports.finalCostReport

Final cost of one project by GL account: the gate 3 baseline plus approved change orders against posted actuals from the Universal Posting Line. A project without a baseline answers 422 NO_ANSWER, never zero. A rule that refuses the request returns 422 with `refusal` and `reason`.

Requires the capability finance.budget.read.
OAuth scopes: finance.
Error statuses: 400, 401, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

reports.finalCostReport: Path and query parameters
Field	Type	Required	Description
project_id	string (uuid)	Yes	The project reported on.

Response 200: ReportRowPage

reports.finalCostReport: ReportRowPage
Field	Type	Required	Description
data	array of ReportRow	Yes	Items on this page, in the documented default order.
next_cursor	string \| null	Yes	Opaque cursor for the next page; null on the last page.

{
  "data": [
    {
      "dimension": "5400",
      "budget": {
        "total_minor": 1250000,
        "currency": "USD",
        "unpriced_count": 2
      },
      "actual": {
        "total_minor": 1250000,
        "currency": "USD",
        "unpriced_count": 2
      }
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/reports/final-cost-report" \
  -H "Authorization: Bearer $XOS_API_KEY"

const { data } = await xos.reports.finalCostReport();

response = xos.reports.final_cost_report()

xos reports final-cost-report