DataboxDownloadWs

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
 

Methods summary

Method Return Description
__construct Constructor.
get DataboxDownloadListItem[] Get a list for your databox.
getEntry string Get one entry from your databox.

Details

public function __construct(SessionWs $sessionWs, array<string,mixed> $soapOptions=[]):

Constructor.

Parameters

Parameter Type Default Description
$sessionWs SessionWs Session webservice
$soapOptions array [] PHP SOAP client options
 
public function get(string $type='', \DateTime|null $from=null, \DateTime|null $to=null): DataboxDownloadListItem[]

Get a list for your databox.

Parameters

Parameter Type Default Description
$type string '' Filter for type. If empty all types are returned. Otherwise choose one of this: AE, AF, AK, AZ, B, DL, E, EU, FB, GM, I, KG, M, P, QL, SS
$from \DateTime | null null filter from
$to \DateTime | null null filter to

Return value

DataboxDownloadListItem[]
 
public function getEntry(string $applkey): string

Get one entry from your databox.

Parameters

Parameter Type Default Description
$applkey string You get this param if choose a record from the databox list {@see \CSoellinger\FonWebservices\DataboxDownloadWs::get}

Return value

string Base64 encoded string
 
On this page
 
Generated by Dog, a slim source code documentation generator. Printed with Dog-HtmlPrinter.
PHP Fon Webservices

DataboxDownloadWs

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
 

Methods summary

Method Return Description
__construct Constructor.
get DataboxDownloadListItem[] Get a list for your databox.
getEntry string Get one entry from your databox.

Details

public function __construct(SessionWs $sessionWs, array<string,mixed> $soapOptions=[]):

Constructor.

Parameters

Parameter Type Default Description
$sessionWs SessionWs Session webservice
$soapOptions array [] PHP SOAP client options
 
public function get(string $type='', \DateTime|null $from=null, \DateTime|null $to=null): DataboxDownloadListItem[]

Get a list for your databox.

Parameters

Parameter Type Default Description
$type string '' Filter for type. If empty all types are returned. Otherwise choose one of this: AE, AF, AK, AZ, B, DL, E, EU, FB, GM, I, KG, M, P, QL, SS
$from \DateTime | null null filter from
$to \DateTime | null null filter to

Return value

DataboxDownloadListItem[]
 
public function getEntry(string $applkey): string

Get one entry from your databox.

Parameters

Parameter Type Default Description
$applkey string You get this param if choose a record from the databox list {@see \CSoellinger\FonWebservices\DataboxDownloadWs::get}

Return value

string Base64 encoded string
 
On this page
 
Generated by Dog, a slim source code documentation generator. Printed with Dog-HtmlPrinter.