reports.md
Reports
Report download operations
Partner Archera Premiums and Rebates by Organization
Monthly allocation of Archera premiums, rebates, and savings across child organizations for a channel partner. One row per child org with that org's invoice totals.
{"openapi":"3.0.2","info":{"title":"Archera.ai Beta API","version":"v1.0.0"},"tags":[{"name":"reports","description":"Report download operations"}],"paths":{"/beta/v1/org/{org_id}/reports/partner_archera_premiums_and_rebates_by_child_org":{"get":{"parameters":[{"in":"query","name":"format","description":"Response format: 'json' (default) or 'csv'","schema":{"type":"string","default":"json","enum":["json","csv"]},"required":false},{"in":"query","name":"year","description":"Billing year (e.g. 2026)","schema":{"type":"integer"},"required":true},{"in":"query","name":"month","description":"Billing month (1-12)","schema":{"type":"integer","minimum":1,"maximum":12},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PartnerArcheraPremiumsAndRebatesByChildOrgOutput"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"422":{"$ref":"#/components/responses/UNPROCESSABLE_CONTENT"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"default":{"$ref":"#/components/responses/DEFAULT_ERROR"}},"tags":["reports"],"summary":"Partner Archera Premiums and Rebates by Organization","description":"Monthly allocation of Archera premiums, rebates, and savings across child organizations for a channel partner. One row per child org with that org's invoice totals."}}},"components":{"schemas":{"PartnerArcheraPremiumsAndRebatesByChildOrgOutput":{"type":"object","properties":{"org_id":{"type":"string","description":"Child organization identifier"},"org_name":{"type":"string","description":"Child organization name"},"archera_premiums":{"type":"number","description":"Archera premiums for this organization"},"rebates":{"type":"number","description":"Rebates for this organization"},"gross_savings":{"type":"number","description":"Gross savings for this organization"},"net_savings":{"type":"number","description":"Net savings for this organization"}},"additionalProperties":false},"ApiErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"detail":{"nullable":true},"code":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"timestamp":{"type":"string"},"type":{"type":"string"}},"required":["message","timestamp","type"]},"Error":{"type":"object","properties":{"code":{"type":"integer","description":"Error code"},"status":{"type":"string","description":"Error name"},"message":{"type":"string","description":"Error message"},"errors":{"type":"object","description":"Errors","additionalProperties":{}}},"additionalProperties":false}},"responses":{"UNPROCESSABLE_CONTENT":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"DEFAULT_ERROR":{"description":"Default error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}
Archera Premiums and Rebates by Account
Monthly allocation of Archera premiums, rebates, and savings by cloud account.
{"openapi":"3.0.2","info":{"title":"Archera.ai Beta API","version":"v1.0.0"},"tags":[{"name":"reports","description":"Report download operations"}],"paths":{"/beta/v1/org/{org_id}/reports/archera_premiums_and_rebates_by_account":{"get":{"parameters":[{"in":"query","name":"format","description":"Response format: 'json' (default) or 'csv'","schema":{"type":"string","default":"json","enum":["json","csv"]},"required":false},{"in":"query","name":"year","description":"Billing year (e.g. 2026)","schema":{"type":"integer"},"required":true},{"in":"query","name":"month","description":"Billing month (1-12)","schema":{"type":"integer","minimum":1,"maximum":12},"required":true},{"in":"query","name":"provider","description":"Cloud provider (aws, azure, gcp, unknown)","schema":{"type":"string","enum":["aws","azure","gcp"]},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ArcheraPremiumsAndRebatesByAccountOutput"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"422":{"$ref":"#/components/responses/UNPROCESSABLE_CONTENT"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"default":{"$ref":"#/components/responses/DEFAULT_ERROR"}},"tags":["reports"],"summary":"Archera Premiums and Rebates by Account","description":"Monthly allocation of Archera premiums, rebates, and savings by cloud account."}}},"components":{"schemas":{"ArcheraPremiumsAndRebatesByAccountOutput":{"type":"object","properties":{"account_id":{"type":"string","description":"Cloud account identifier"},"account_name":{"type":"string","description":"Human-readable account name"},"archera_premiums":{"type":"number","description":"Archera premiums allocated to this account"},"rebates":{"type":"number","description":"Rebates allocated to this account"},"gross_savings":{"type":"number","description":"Gross savings allocated to this account"},"net_savings":{"type":"number","description":"Net savings allocated to this account"}},"additionalProperties":false},"ApiErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"detail":{"nullable":true},"code":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"timestamp":{"type":"string"},"type":{"type":"string"}},"required":["message","timestamp","type"]},"Error":{"type":"object","properties":{"code":{"type":"integer","description":"Error code"},"status":{"type":"string","description":"Error name"},"message":{"type":"string","description":"Error message"},"errors":{"type":"object","description":"Errors","additionalProperties":{}}},"additionalProperties":false}},"responses":{"UNPROCESSABLE_CONTENT":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"DEFAULT_ERROR":{"description":"Default error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}
Archera Premiums and Rebates Daily
Daily allocation of Archera premiums, rebates, and savings over a calendar month.
{"openapi":"3.0.2","info":{"title":"Archera.ai Beta API","version":"v1.0.0"},"tags":[{"name":"reports","description":"Report download operations"}],"paths":{"/beta/v1/org/{org_id}/reports/archera_premiums_and_rebates_daily":{"get":{"parameters":[{"in":"query","name":"format","description":"Response format: 'json' (default) or 'csv'","schema":{"type":"string","default":"json","enum":["json","csv"]},"required":false},{"in":"query","name":"year","description":"Billing year (e.g. 2026)","schema":{"type":"integer"},"required":true},{"in":"query","name":"month","description":"Billing month (1-12)","schema":{"type":"integer","minimum":1,"maximum":12},"required":true},{"in":"query","name":"provider","description":"Cloud provider (aws, azure, gcp, unknown)","schema":{"type":"string","enum":["aws","azure","gcp"]},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ArcheraPremiumsAndRebatesDailyOutput"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"422":{"$ref":"#/components/responses/UNPROCESSABLE_CONTENT"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"default":{"$ref":"#/components/responses/DEFAULT_ERROR"}},"tags":["reports"],"summary":"Archera Premiums and Rebates Daily","description":"Daily allocation of Archera premiums, rebates, and savings over a calendar month."}}},"components":{"schemas":{"ArcheraPremiumsAndRebatesDailyOutput":{"type":"object","properties":{"date":{"type":"string","format":"date","description":"Calendar date within the requested month"},"gross_savings":{"type":"number","description":"Gross savings allocated to this date"},"archera_premiums":{"type":"number","description":"Archera premiums allocated to this date"},"rebates":{"type":"number","description":"Rebates allocated to this date"},"net_savings":{"type":"number","description":"Net savings allocated to this date"}},"additionalProperties":false},"ApiErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"detail":{"nullable":true},"code":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"timestamp":{"type":"string"},"type":{"type":"string"}},"required":["message","timestamp","type"]},"Error":{"type":"object","properties":{"code":{"type":"integer","description":"Error code"},"status":{"type":"string","description":"Error name"},"message":{"type":"string","description":"Error message"},"errors":{"type":"object","description":"Errors","additionalProperties":{}}},"additionalProperties":false}},"responses":{"UNPROCESSABLE_CONTENT":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"DEFAULT_ERROR":{"description":"Default error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}
Archera Premiums and Rebates by Account Daily
Daily allocation of Archera premiums, rebates, and savings by cloud account over a calendar month.
{"openapi":"3.0.2","info":{"title":"Archera.ai Beta API","version":"v1.0.0"},"tags":[{"name":"reports","description":"Report download operations"}],"paths":{"/beta/v1/org/{org_id}/reports/archera_premiums_and_rebates_by_account_daily":{"get":{"parameters":[{"in":"query","name":"format","description":"Response format: 'json' (default) or 'csv'","schema":{"type":"string","default":"json","enum":["json","csv"]},"required":false},{"in":"query","name":"year","description":"Billing year (e.g. 2026)","schema":{"type":"integer"},"required":true},{"in":"query","name":"month","description":"Billing month (1-12)","schema":{"type":"integer","minimum":1,"maximum":12},"required":true},{"in":"query","name":"provider","description":"Cloud provider (aws, azure, gcp, unknown)","schema":{"type":"string","enum":["aws","azure","gcp"]},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ArcheraPremiumsAndRebatesByAccountDailyOutput"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"422":{"$ref":"#/components/responses/UNPROCESSABLE_CONTENT"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"default":{"$ref":"#/components/responses/DEFAULT_ERROR"}},"tags":["reports"],"summary":"Archera Premiums and Rebates by Account Daily","description":"Daily allocation of Archera premiums, rebates, and savings by cloud account over a calendar month."}}},"components":{"schemas":{"ArcheraPremiumsAndRebatesByAccountDailyOutput":{"type":"object","properties":{"date":{"type":"string","format":"date","description":"Calendar date within the requested month"},"account_id":{"type":"string","description":"Cloud account identifier"},"account_name":{"type":"string","description":"Human-readable account name"},"gross_savings":{"type":"number","description":"Gross savings allocated to this account on this date"},"archera_premiums":{"type":"number","description":"Archera premiums allocated to this account on this date"},"rebates":{"type":"number","description":"Rebates allocated to this account on this date"},"net_savings":{"type":"number","description":"Net savings allocated to this account on this date"}},"additionalProperties":false},"ApiErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"detail":{"nullable":true},"code":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"timestamp":{"type":"string"},"type":{"type":"string"}},"required":["message","timestamp","type"]},"Error":{"type":"object","properties":{"code":{"type":"integer","description":"Error code"},"status":{"type":"string","description":"Error name"},"message":{"type":"string","description":"Error message"},"errors":{"type":"object","description":"Errors","additionalProperties":{}}},"additionalProperties":false}},"responses":{"UNPROCESSABLE_CONTENT":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"DEFAULT_ERROR":{"description":"Default error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}