e-Próspera
Reference

Save and calculate VAT figures

View as Markdown
PUT
/api/v1/me/tax/vat/filings/{filingId}

Replace all reported figures using decimal strings and the latest revision. Stale revisions return 412. Submitted filings and processed invoices cannot be edited; an unprocessed invoice is voided before recalculation. A successful write returns a new revision. After a timeout, read the filing before retrying.

Account deactivation revokes personal API keys, including Agent Keys, and OAuth authorizations. Account reactivation requires new API keys, including new Agent Keys, and consent; previously issued credentials remain invalid.

Authorization

AuthorizationBearer <token>

In: header

Scope: eprospera:person.tax.vat.write

Path Parameters

filingId*string
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/api/v1/me/tax/vat/filings/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "revision": "string",    "currency": "usd",    "accountingMethod": "cash",    "grossIncome": "string",    "taxCredit": "string",    "taxWithheld": "string"  }'
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "subject": {      "type": "natural_person",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "residentPermitNumber": "string"    },    "period": {      "year": 0,      "quarter": 1    },    "status": "draft",    "revision": "string",    "currency": "usd",    "accountingMethod": "string",    "reported": {      "grossIncome": "string",      "taxCredit": "string",      "taxWithheld": "string"    },    "taxLiability": "string",    "readyToSubmit": true,    "creditReviewRequired": true,    "creditReviewStatus": "string",    "paymentRequired": true,    "invoice": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "status": "string"    },    "submittedAt": "2019-08-24T14:15:22Z",    "links": {      "portal": "string",      "assessment": "string"    }  }}

Read a VAT draft or submission receipt GET

Returns reported figures, server-calculated USD liability, current revision, payment readiness, and submittedAt as the submission receipt. The assessment link requires the matching tax read scope. Relative links use the current portal/API origin. Account deactivation revokes personal API keys, including Agent Keys, and OAuth authorizations. Account reactivation requires new API keys, including new Agent Keys, and consent; previously issued credentials remain invalid.

Submit a reviewed quarterly VAT filing POST

Requires the latest revision and explicit acceptance of the declaration from VAT context. Preserves server-side ownership, period, tax-credit and authoritative settlement checks. Zero-liability filings need no invoice; positive liability requires existing payment evidence. Use links.portal for payment. Repeating a successful submission with the same revision returns the existing receipt. No charges are initiated by this endpoint. Account deactivation revokes personal API keys, including Agent Keys, and OAuth authorizations. Account reactivation requires new API keys, including new Agent Keys, and consent; previously issued credentials remain invalid.