e-Próspera
Reference

Create or resume a quarterly VAT draft

View as Markdown
POST
/api/v1/me/tax/vat/filings

Use personal for the caller or a consented legal-entity UUID. Taxpayer+quarter is the retry key: returns an existing original draft without replacing figures. Already-filed quarters, multiple drafts, and BTC/amendment drafts return 409. USD originals only. A registered RPN and eligible quarter are required.

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

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

application/json

curl -X POST "https://example.com/api/v1/me/tax/vat/filings" \  -H "Content-Type: application/json" \  -d '{    "subject": "personal",    "year": 2020,    "quarter": 1  }'
{  "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"    }  }}

Identify VAT taxpayers and open quarters GET

Returns registered taxpayer identity (name, UUID, RPN), candidate open quarters, and the declaration text. Personal and entity scopes authorize only their respective subjects. Entities also require current representation and token-specific consent. Eligibility is rechecked on writes. No identity-document images are returned. 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.

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.