# Vertex API

**Canonical:** https://apis.io/apis/vertex/vertex-api/  
**Provider:** Vertex — https://apis.io/providers/vertex/  
**Base URL:** https://dash.readme.com  
**Documentation:** https://developer.vertexinc.com/vat-compliance/docs/upload-customer-data-files

Vertex API is published by [Vertex](https://apis.io/providers/vertex/) on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 1 JSON Schema definition. The published artifact set on APIs.io includes an OpenAPI specification and 1 JSON Schema.

Vertex API as documented publicly: 23 operations. Contract generated from the documentation by API Evangelist (2026-10-13); not the provider's own document.

## Operations (23)

| Method | Path | Summary |
|---|---|---|
| GET | `/` | GET / |
| DELETE | `/api/v1/reports/results/{reportresultid}` | Hard-delete a report result and its generated artifact. The operation is idempotent and returns a 204 HTTP status code when the result has already been deleted. |
| GET | `/api/v1/reports/results/{reportresultid}` | Retrieve full metadata for a single report result by its ID, including pre-signed download URL. |
| POST | `/api/v1/reports/results/{reportresultid}/cancel` | Request cancelation of a report result that is currently PENDING or PROCESSING. The operation is idempotent — repeating it for an already-canceled result ret... |
| GET | `/api/v1/reports/{definitionid}/results/{reportresultid}` | Retrieve full metadata for a single report result, including pre-signed download URLs. |
| DELETE | `/api/v1/reports/{reportid}` | Soft-delete a report definition by moving it to ARCHIVED status. Archiving a report deactivates all of its schedules. Archived reports remain readable but ca... |
| GET | `/api/v1/reports/{reportid}` | Retrieve full metadata for a single report definition. |
| PUT | `/api/v1/reports/{reportid}` | Update an existing saved report definition. Only the report name plus DATA_EXTRACT filters/fields/settings or STANDARD_REPORT parameters can be changed. |
| POST | `/api/v1/reports/{reportid}/results` | Execute a report definition and create a new report result. The report is executed asynchronously, and the generated report result metadata is returned. |
| DELETE | `/api/v1/reports/{reportid}/schedules` | Delete all schedules associated with a specific report definition. |
| DELETE | `/api/v1/reports/{reportid}/schedules/{scheduleid}` | Delete a specific schedule associated with a given report definition. The schedule must belong to the specified report definition. |
| GET | `/api/v1/reports/{reportid}/{id}` | Retrieve all report results generated for a specific report definition, with optional filters for status, name, and creation date range. |
| DELETE | `/api/v1/schedules/{scheduleid}` | Delete or permanently disable a schedule. |
| GET | `/api/v1/schedules/{scheduleid}` | Retrieve full metadata for a single schedule. |
| PUT | `/api/v1/schedules/{scheduleid}` | Update an existing schedule. All updatable fields are replaced with the values provided in the request. |
| GET | `/api/v1/templates/{templateid}` | Retrieve a single template definition. |
| GET | `/api/v1/{v1id}` | Retrieve a list of report definitions, optionally filtered by template, category, name, and creation date. |
| POST | `/api/v1/{v1id}` | Create a new saved report definition based on an existing template. DATA_EXTRACT requests provide filters and field configurations, while STANDARD_REPORT req... |
| GET | `/documents/url` | GET /documents/url |
| GET | `/problems/{problemid}` | 403 Response example |
| GET | `/project/solutionreporting/v1.0/docs/using-the-solution-reporting-api` | GET /project/solutionreporting/v1.0/docs/using-the-solution-reporting-api |
| GET | `/project/vat-compliance/v1.0/docs/upload-customer-data-files` | GET /project/vat-compliance/v1.0/docs/upload-customer-data-files |
| GET | `/vertex-ws/v2/supplies` | GET /vertex-ws/v2/supplies |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/vertex/refs/heads/main/openapi/_ae-authored/vertex-openapi-generated.yml
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/vertex/refs/heads/main/json-schema/vertex-get-problems-problemid-response-schema.json
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/vertex/refs/heads/main/apis.yml

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/vertex/vertex-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/vertex/.