--- updatedAt: 2026-08-03T16:15:16.000Z agentTools: projectIndex: https://apidocs.taxbit.com/llms.txt --- # Get Inventory Summary Report Status Gets the status of an inventory summary report using the report ID returned from the POST endpoint. When the status is 'completed', a pre-signed download URL is included in the response (valid for 15 minutes). You can call this endpoint again to generate a fresh download URL. Reports are retained for 30 days. **Status descriptions:** - `pending`: The report is in the queue and has not yet started processing. - `processing`: The report is currently being generated. - `completed`: The report is ready for download. - `failed`: The report could not be generated. Try again or contact support if the issue persists. # OpenAPI definition ```json { "openapi": "3.0.0", "paths": { "/v1/reports/inventory-summary/{reportId}": { "get": { "description": "Gets the status of an inventory summary report using the report ID returned from the POST endpoint. When the status is 'completed', a pre-signed download URL is included in the response (valid for 15 minutes). You can call this endpoint again to generate a fresh download URL. Reports are retained for 30 days.\n\n**Status descriptions:**\n- `pending`: The report is in the queue and has not yet started processing.\n- `processing`: The report is currently being generated.\n- `completed`: The report is ready for download.\n- `failed`: The report could not be generated. Try again or contact support if the issue persists.", "operationId": "ReportsController_getInventorySummary", "parameters": [ { "name": "reportId", "required": true, "in": "path", "description": "The unique identifier for the inventory summary report.", "schema": { "format": "uuid", "type": "string", "example": "665d98a8-157d-494d-9600-2d89b539a9a1" } } ], "responses": { "200": { "description": "Inventory Summary Report Status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInventorySummaryReportResponseDto" }, "examples": { "default": { "summary": "Example", "value": { "data": { "report_id": "665d98a8-157d-494d-9600-2d89b539a9a1", "status": "completed", "as_of_timestamp": "2026-01-15T00:00:00Z", "created_at": "2026-01-15T12:00:00Z", "completed_at": "2026-01-15T12:05:00Z", "expires_at": "2026-02-14T12:05:00Z", "metadata": { "total_accounts_requested": 100, "total_accounts_included": 95, "skipped_account_ids": { "not_found_in_organization": [ "account-3" ] } }, "download_url": "https://s3.amazonaws.com/..." } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedErrorResponseDto" } } } }, "404": { "description": "Report Not Found" }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsErrorResponseDto" } } } } }, "security": [ { "bearer": [] } ], "summary": "Get Inventory Summary Report Status", "tags": [ "Reports" ] } } }, "info": { "title": "API", "description": "", "version": "1.2.0", "contact": {} }, "servers": [ { "url": "https://api.multi1.enterprise.taxbit.com" }, { "url": "https://api.eutax1.enterprise.taxbit.com" } ], "components": { "securitySchemes": { "bearer": { "scheme": "bearer", "bearerFormat": "JWT", "type": "http" } }, "schemas": { "UnauthorizedErrorResponseDto": { "type": "object", "properties": { "error": { "description": "Error name for the rejected request", "type": "string", "example": "Unauthorized" }, "message": { "description": "Reason the bearer token was rejected", "type": "string", "example": "Unauthorized Error" } }, "required": [ "message" ], "additionalProperties": false }, "TooManyRequestsErrorResponseDto": { "type": "object", "properties": { "error": { "description": "Error code emitted when the caller exceeds its rate limit", "type": "string", "example": "rate_limit_exceeded" }, "message": { "description": "How long to wait before retrying", "type": "string", "example": "Rate limit exceeded. Please retry after 30 seconds." } }, "required": [ "error", "message" ], "additionalProperties": false }, "GetInventorySummaryReportResponseDto": { "type": "object", "properties": { "data": { "type": "object", "properties": { "report_id": { "type": "string", "description": "The unique identifier for the inventory summary report.", "format": "uuid", "example": "665d98a8-157d-494d-9600-2d89b539a9a1" }, "status": { "type": "string", "enum": [ "pending", "processing", "completed", "failed" ], "description": "The current status of the report.", "example": "pending" }, "as_of_timestamp": { "description": "The point-in-time for which the inventory summary was generated.", "format": "date-time", "type": "string", "example": "2026-01-15T00:00:00Z" }, "created_at": { "description": "The timestamp when the report was created.", "format": "date-time", "type": "string", "example": "2026-01-15T12:00:00Z" }, "completed_at": { "description": "The timestamp when the report finished processing. Present only when status is 'completed'.", "format": "date-time", "type": "string", "example": "2026-01-15T12:05:00Z" }, "expires_at": { "description": "The timestamp when the report expires. Present only when status is 'completed'.", "format": "date-time", "type": "string", "example": "2026-02-14T12:05:00Z" }, "download_url": { "description": "Pre-signed URL to download the report as a ZIP file. Present only when status is 'completed'. Valid for 15 minutes.", "type": "string", "example": "https://s3.amazonaws.com/..." }, "metadata": { "type": "object", "properties": { "total_accounts_requested": { "type": "integer", "description": "The number of accounts requested in the report.", "example": 100 }, "total_accounts_included": { "type": "integer", "description": "The number of accounts included in the report.", "example": 95 }, "skipped_account_ids": { "description": "Details about accounts that were skipped.", "type": "object", "properties": { "not_found_in_organization": { "description": "Account IDs that were not found in the organization.", "type": "array", "items": { "type": "string" }, "example": [ "account-3" ] } }, "additionalProperties": false } }, "additionalProperties": false, "description": "Report metadata. Present only when status is 'completed'.", "required": [ "total_accounts_included" ] }, "error": { "description": "Error message if the report failed. Present only when status is 'failed'.", "type": "string", "example": "Report generation failed due to an internal error." } }, "required": [ "as_of_timestamp", "created_at", "report_id", "status" ], "additionalProperties": false } }, "required": [ "data" ], "title": "Get Inventory Summary Report Response", "additionalProperties": false } } }, "security": [ { "bearer": [] } ] } ``` # Sibling pages * [Trigger an Inventory Summary Report](https://apidocs.taxbit.com/reference/post_reports-inventory-summary.md) * [List Submitted Files](https://apidocs.taxbit.com/reference/get_reports-submitted-files.md) * [Get Submitted File Reports](https://apidocs.taxbit.com/reference/get_reports-submitted-files-fileid.md)