There are two options for scheduling a report, depending on the service and reporting needs. Each option uses different input parameters and returns different output fields:

Integrated services—Users of Vertex for e-Commerce, Vertex for Marketplaces, and Vertex O Series Online Commerce can use this option to schedule a general audit report.
Standalone services—Users of Standalone Vertex Validator can use this option to generate a report on tax identification number validation.

📘
Note
This request schedules a single report.

To schedule a report, use the following URL and the POST method:

{service_url}/api/v3/reports

Here, {service_url} is the URL of the sandbox or production environment.

Example:

https://reporting-api.marketplace.taxamo.com/api/v3/reports

Details

Endpoint	Method
`/api/v3/reports`	POST

Parameters

For more information, see Schedule Report Input Parameters.

Example requests

Integrated services

The following example request applies to integrated services, including Vertex for e-Commerce, Vertex for Marketplaces, and Vertex O Series Online Commerce:

curl --request POST \
     --url https://reporting-api.marketplace.taxamo.com/api/v3/reports \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "report-type": "Audit",
  "parameters": {
    "fx-source": "ECB",
    "fx-date-type": "day",
    "format": "csv",
    "product-classes": "p",
    "end-date": "20-07-2023",
    "tax-country-subdivision-code": "US-FL",
    "tax-country-code": "US",
    "currency-code": "USD",
    "tax-region-key": "US",
    "report-scope": "full",
    "transaction-type": "sale",
    "start-date": "01-01-2024",
    "fx-date-field": "tax-timestamp"
  }
}
'

Standalone services

The following example request applies to Standalone Vertex Validator:

curl --request POST \
     --url https://reporting-api.marketplace.taxamo.com/api/v3/reports \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "report-type": "Tax-ID",
  "parameters": {
    "fx-source": "ECB",
    "fx-date-type": "day",
    "start-date": "01-01-2023",
    "end-date": "01-03-2023",
    "tax-ids": [
      "ABC23232, DEF430923"
    ],
    "region-keys": [
      "unknown",
      "EU"
    ],
    "validation-statuses": [
      "syntax-valid-full-valid-cache-not-used",
      "syntax-valid-full-invalid-cache-not-used"
    ],
    "result-changed": true
  }
}
'

Response examples

Integrated services

The following example response applies to integrated services, including Vertex for e-Commerce, Vertex for Marketplaces, and Vertex O Series Online Commerce:

{
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "Queued",
  "message": "string"
}

Standalone services

The following example response applies to Standalone Vertex Validator:

curl --request POST \
     --url https://reporting-api.marketplace.taxamo.com/api/v3/reports \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "report-type": "Tax-ID",
  "parameters": {
    "fx-source": "ECB",
    "fx-date-type": "day",
    "start-date": "01-01-2023",
    "end-date": "01-03-2023",
    "tax-ids": [
      "ABC23232, DEF430923"
    ],
    "region-keys": [
      "unknown",
      "EU"
    ],
    "validation-statuses": [
      "syntax-valid-full-valid-cache-not-used",
      "syntax-valid-full-invalid-cache-not-used"
    ],
    "result-changed": true
  }
}
'