e-Próspera
Reference

Get tax obligations and lump-sum election status

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

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.

Authorization

AuthorizationBearer <token>

In: header

Scope: eprospera:person.tax.read

Query Parameters

subject?|

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/summary"
{  "data": {    "subjects": [      {        "subject": {          "type": "natural_person",          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "name": "string",          "residentPermitNumber": "string"        },        "obligations": [          {            "type": "income",            "period": {              "year": 0,              "quarter": 1            },            "dueDate": "2019-08-24T14:15:22Z",            "status": "open",            "filingId": "79ada8ef-98e4-495b-8d26-4e319d7aff7f"          }        ],        "lumpSumElections": [          {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "taxYear": 0,            "effectiveDate": "2019-08-24T14:15:22Z",            "terminationDate": "2019-08-24T14:15:22Z",            "status": "active"          }        ]      }    ]  }}

List documents for a consented legal entity 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.

List submitted tax filings 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.