1. class
  2. CSoellinger
  3. \
  4. FonWebservices
  5. \
  6. DataboxDownloadWs

DataboxDownloadWs

class DataboxDownloadWs extends SoapClient (View source)

FinanzOnline databox download webservice.

Requirements for this service:

  • A registration for FinanzOnline
  • A user for the web service, which can be created in the user administration of FinanzOnline

Error codes

  • 0 = All fine :)
  • -1 = The session ID is invalid or expired.
  • -2 = The web service is currently not available due to maintenance work.
  • -3 = A technical error has occurred.
  • -4 = "ts_zust_von" AND "ts_zust_bis" have to be set.
  • -5 = "ts_zust_von" can not be before 31 days
  • -6 = "ts_zust_bis" can not be after 7 days

Constants

WSDL

Online WSDL url.
WSDL_LOCAL

Local WSDL file.
TYPES

All supported databox types.

Methods

__construct(SessionWs $sessionWs, array $soapOptions = [])

Constructor.

array
get(DataboxType|string $type = '', DateTime|null $from = null, DateTime|null $to = null)

Get a list for your databox.

string
getEntry(string $applkey)

Get one entry from your databox.

Details

at line 92
__construct(SessionWs $sessionWs, array $soapOptions = [])

Constructor.

Parameters

SessionWs $sessionWs

Session webservice
array $soapOptions

PHP SOAP client options

at line 114
array get(DataboxType|string $type = '', DateTime|null $from = null, DateTime|null $to = null)

Get a list for your databox.

Parameters

DataboxType|string $type

Filter type (use DataboxType enum, empty string for all, string support deprecated)
DateTime|null $from

filter from
DateTime|null $to

filter to

Return Value

array

Exceptions

Exception

at line 157
string getEntry(string $applkey)

Get one entry from your databox.

Parameters

string $applkey

You get this param if choose a record from the databox list {\CSoellinger\FonWebservices\DataboxDownloadWs::get}

Return Value

string

Base64 encoded string

Exceptions

Exception