e-Próspera
Reference

List submitted tax filings

View as Markdown
GET
/api/v1/me/tax/filings

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.read

Query Parameters

subject?|
type?string

Value in

  • "income"
  • "vat"
year?integer
Range2020 <= value <= 9999
limit?integer
Range1 <= value <= 100
cursor?string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/me/tax/filings"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "subject": {        "type": "natural_person",        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "name": "string",        "residentPermitNumber": "string"      },      "type": "income",      "period": {        "year": 0,        "quarter": 1      },      "submittedAt": "2019-08-24T14:15:22Z",      "amended": true,      "currency": "usd",      "accountingMethod": "string",      "reported": {        "grossIncome": "string",        "taxCredit": "string",        "taxWithheld": "string"      },      "usdEquivalent": {        "grossIncome": "string",        "taxCredit": "string",        "taxWithheld": "string"      },      "taxLiability": "string",      "exchangeRate": {        "btcUsdRate": "string",        "capturedAt": "2019-08-24T14:15:22Z",        "source": "string"      },      "invoice": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "status": "string"      },      "availableDocuments": [        "assessment"      ]    }  ],  "meta": {    "nextCursor": "string"  }}

Get tax obligations and lump-sum election status GET

Personal VAT obligations honor staff-recorded ongoing applicability. Period-specific reviewed decisions and active manual filing requirements take precedence. Changes to filing applicability do not remove submitted filings or payment balances. 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.

Get a submitted tax filing GET

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.