Allocation Reports (Beta)

Calendar-month tabular breakdowns that spread Archera premiums, rebates, savings, and commitment costs across accounts, services, or child orgs.

List available allocation reports

get

Catalog of allocation/showback reports a caller can fetch via GET /allocation-reports/<report_type>. Each entry declares the query parameters it accepts and the columns its rows will contain.

Path parameters

org_idstring · uuidRequired

Responses

200

OK

application/json

400

Bad request

application/json

messagestringRequired

detailany · nullableOptional

codestring · nullableOptional

urlstring · nullableOptional

timestampstringRequired

typestringRequired

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

405

Method not allowed

application/json

409

Conflict

application/json

500

Internal server error

application/json

default

Default error response

application/json

get

/beta/v1/org/{org_id}/allocation-reports

HTTPcURLJavaScriptPython

GET /beta/v1/org/{org_id}/allocation-reports HTTP/1.1
Accept: */*

[
  {
    "report_type": "text",
    "name": "text",
    "description": "text",
    "category": "text",
    "row_grain": "text",
    "update_cadence": "text",
    "params": [
      {
        "name": "text",
        "type": "text",
        "required": true,
        "description": "text"
      }
    ],
    "output_fields": [
      {
        "name": "text",
        "type": "text",
        "description": "text"
      }
    ]
  }
]

Fetch one allocation report

get

Returns one report's rows for the requested calendar month. Accepted query parameters and returned columns vary by report_type — call the list endpoint to discover them. Pass ?format=csv for a CSV download (default is JSON). Returns 404 for unknown or per-org-hidden reports, and 404 with code: period_not_available when the requested (year, month) isn't in this report's available periods — call the /periods endpoint to enumerate what is. marshmallow.ValidationError on bad query params is handled globally as a 400.

Path parameters

org_idstring · uuidRequired

report_typestring · min: 1Required

Responses

400

Bad request

application/json

messagestringRequired

detailany · nullableOptional

codestring · nullableOptional

urlstring · nullableOptional

timestampstringRequired

typestringRequired

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

405

Method not allowed

application/json

409

Conflict

application/json

500

Internal server error

application/json

default

Default error response

application/json

get

/beta/v1/org/{org_id}/allocation-reports/{report_type}

HTTPcURLJavaScriptPython

GET /beta/v1/org/{org_id}/allocation-reports/{report_type} HTTP/1.1
Accept: */*

{
  "message": "text",
  "detail": null,
  "code": "text",
  "url": "text",
  "timestamp": "text",
  "type": "text"
}

List periods available for an allocation report

get

Returns the (year, month) periods this report can be queried for, given the supplied filter params (same shape as the get endpoint minus year/month — those are the dimensions being enumerated). Each entry has status: "finalized" for past months backed by an invoice, or "in_progress" for the current calendar month when the report's update_cadence is "daily". Sorted most-recent first.

Path parameters

org_idstring · uuidRequired

report_typestring · min: 1Required

Responses

400

Bad request

application/json

messagestringRequired

detailany · nullableOptional

codestring · nullableOptional

urlstring · nullableOptional

timestampstringRequired

typestringRequired

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

405

Method not allowed

application/json

409

Conflict

application/json

500

Internal server error

application/json

default

Default error response

application/json

get

/beta/v1/org/{org_id}/allocation-reports/{report_type}/periods

HTTPcURLJavaScriptPython

GET /beta/v1/org/{org_id}/allocation-reports/{report_type}/periods HTTP/1.1
Accept: */*

{
  "message": "text",
  "detail": null,
  "code": "text",
  "url": "text",
  "timestamp": "text",
  "type": "text"
}