Reports

Compliance Reports

Generate reports for tax filing and compliance.

Summary Report

Get tax collected summary by jurisdiction for a period.

GET /v1/reports/summary

Query Parameters

Parameter	Type	Required	Description
from_date	string	Yes	Start date (YYYY-MM-DD)
to_date	string	Yes	End date (YYYY-MM-DD)
currency	string	No	Filter by currency (3-letter code)

curl "https://api.shipvat.com/v1/reports/summary?from_date=2024-01-01&to_date=2024-03-31" \
  -H "Authorization: Bearer sk_live_..."

Response

{
  "period": {
    "from": "2024-01-01",
    "to": "2024-03-31"
  },
  "by_jurisdiction": [
    {
      "jurisdiction_id": "DE",
      "jurisdiction_name": "Germany",
      "currency": "EUR",
      "transaction_count": 150,
      "subtotal": 45000000,
      "tax_amount": 8550000,
      "total": 53550000,
      "effective_rate": 0.19
    },
    {
      "jurisdiction_id": "FR",
      "jurisdiction_name": "France",
      "currency": "EUR",
      "transaction_count": 75,
      "subtotal": 22500000,
      "tax_amount": 4500000,
      "total": 27000000,
      "effective_rate": 0.20
    }
  ],
  "totals": [
    {
      "currency": "EUR",
      "transaction_count": 225,
      "subtotal": 67500000,
      "tax_amount": 13050000,
      "total": 80550000
    }
  ],
  "generated_at": "2024-04-01T10:00:00Z"
}

Transaction Report

Detailed list of transactions for a period.

GET /v1/reports/transactions

Query Parameters

Parameter	Type	Required	Description
from_date	string	Yes	Start date (YYYY-MM-DD)
to_date	string	Yes	End date (YYYY-MM-DD)
jurisdiction_id	string	No	Filter by jurisdiction
currency	string	No	Filter by currency (3-letter code)
limit	number	No	Results per page (default: 100, max: 1000)
offset	number	No	Pagination offset

curl "https://api.shipvat.com/v1/reports/transactions?from_date=2024-01-01&to_date=2024-01-31&jurisdiction_id=DE" \
  -H "Authorization: Bearer sk_live_..."

Response

{
  "period": {
    "from": "2024-01-01",
    "to": "2024-01-31"
  },
  "transactions": [
    {
      "id": "txn_abc123",
      "external_id": "order_001",
      "transaction_date": "2024-01-15T10:30:00Z",
      "customer_country": "DE",
      "customer_region": null,
      "jurisdiction_id": "DE",
      "jurisdiction_name": "Germany",
      "subtotal": 9999,
      "tax_rate": 0.19,
      "tax_amount": 1900,
      "total": 11899,
      "currency": "EUR"
    }
  ],
  "pagination": {
    "total": 150,
    "limit": 100,
    "offset": 0,
    "has_more": true
  },
  "generated_at": "2024-02-01T10:00:00Z"
}

Filing Report

Generate reports formatted for tax filing (EU OSS, etc.).

GET /v1/reports/filing

Query Parameters

Parameter	Type	Required	Description
from_date	string	Yes	Start date (YYYY-MM-DD)
to_date	string	Yes	End date (YYYY-MM-DD)
report_type	string	No	Report type: eu_oss, standard (default: standard)
home_country	string	No	Your home country (2-letter code)

curl "https://api.shipvat.com/v1/reports/filing?from_date=2024-01-01&to_date=2024-03-31&report_type=eu_oss" \
  -H "Authorization: Bearer sk_live_..."

Response

{
  "report_type": "eu_oss",
  "report_name": "EU One-Stop Shop Report",
  "description": "VAT collected in EU member states for OSS filing",
  "period": {
    "from": "2024-01-01",
    "to": "2024-03-31"
  },
  "lines": [
    {
      "jurisdiction_id": "DE",
      "jurisdiction_name": "Germany",
      "tax_type": "VAT",
      "taxable_amount": 45000000,
      "tax_rate": 0.19,
      "tax_amount": 8550000,
      "currency": "EUR",
      "transaction_count": 150
    },
    {
      "jurisdiction_id": "FR",
      "jurisdiction_name": "France",
      "tax_type": "VAT",
      "taxable_amount": 22500000,
      "tax_rate": 0.20,
      "tax_amount": 4500000,
      "currency": "EUR",
      "transaction_count": 75
    }
  ],
  "totals": [
    {
      "currency": "EUR",
      "taxable_amount": 67500000,
      "tax_amount": 13050000
    }
  ],
  "generated_at": "2024-04-01T10:00:00Z"
}

Export CSV

Export report data as CSV for import into accounting software.

GET /v1/reports/export

Query Parameters

Parameter	Type	Required	Description
from_date	string	Yes	Start date (YYYY-MM-DD)
to_date	string	Yes	End date (YYYY-MM-DD)
report_type	string	No	Report type: summary, transactions, filing (default: summary)
jurisdiction_id	string	No	Filter by jurisdiction
currency	string	No	Filter by currency (3-letter code)
format	string	No	Output format: csv (default: csv)

curl "https://api.shipvat.com/v1/reports/export?from_date=2024-01-01&to_date=2024-03-31&report_type=transactions" \
  -H "Authorization: Bearer sk_live_..." \
  -o report.csv

Response

transaction_id,external_id,date,country,region,jurisdiction,subtotal,tax_rate,tax_amount,total,currency
txn_abc123,order_001,2024-01-15,DE,,DE,9999,0.19,1900,11899,EUR
txn_def456,order_002,2024-01-16,FR,,FR,5000,0.20,1000,6000,EUR

Report Types

Type	Description
standard	General tax report by jurisdiction
eu_oss	EU One-Stop Shop filing report