PIT
:: services/pit module

This module allows you to download users PIT (Personal Income Tax) declarations

This module may be used only using administrative access

Methods

fetch_pdf BETA Download document (administrative)
pit BETA Get PIT details. (administrative)
user BETA User's PITs (administrative)

services/pit/fetch_pdf

Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.

Consumer: required (administrative) Token: required Scopes: n/a SSL: required
https://usosapi.panschelm.edu.pl/services/pit/fetch_pdf

This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can.

Download document
id required Document's ID
Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus required oauth_token for Token authorization.

Returned value:

File in PDF format containing PIT.

Thrown errors:

  • object_not_found - some of the referenced objects do not exist; param_name is equal to id.

services/pit/pit

Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.

Consumer: required (administrative) Token: required Scopes: n/a SSL: required
https://usosapi.panschelm.edu.pl/services/pit/pit

This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can.

Get PIT data

Note that user has access only to his documents
id required PIT's ID
fields required

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section.

format optional

Default value: json

Format in which to return values. See supported output formats.
callback optional

Required only if you've chosen jsonp as a return format.
Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus required oauth_token for Token authorization.

Returned value:

A dictionary of selected fields and their values.

Available fields:

  • id - PIT's ID;

  • type_code - string, the official code/ID of the type of this PIT declaration; every PIT declaration has its type, these types (and its codes) are defined by the Polish government;

  • user - PIT's owner.

    This field references objects returned by services/users/user method. See its returns section for possible subfields.

  • year - Tax year of PIT declaration.;

  • status - Status of document. Possible values: in_preparation, in_preparation_confirmation_required, ready, in_delivery, sent, corrected;

  • document_id - ID of document;

  • delivery_confirmation_date - If delivery is confirmed, data in USOS API format is returned..

Thrown errors:

  • object_not_found - some of the referenced objects do not exist; param_name is equal to id.

services/pit/user

Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.

Consumer: required (administrative) Token: required Scopes: n/a SSL: required
https://usosapi.panschelm.edu.pl/services/pit/user

This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can.

User's PITs
fields required

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section.

format optional

Default value: json

Format in which to return values. See supported output formats.
callback optional

Required only if you've chosen jsonp as a return format.
Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus required oauth_token for Token authorization.

Returned value:

A dictionary of selected fields and their values.

Available fields:

  • pits - List of user's pits.

    This field references objects returned by pit method. See its returns section for possible subfields.
USOS API ver. 7.1.0.0-4, 0e1fe7fc (2024-08-27)