API Documentation
\
billythekid
v12finance
models
exceptions
requests
responses

\billythekid\v12finance\models\requestsDownloadDocumentRequest

Class DownloadDocumentRequest

Summary

Methods
Properties
Constants
__construct()
setApplicationId()
setDocumentType()
getRetailer()
getApplicationId()
getDocumentType()
jsonSerialize()
No public properties found
ALLOWED_DOCUMENT_TYPES
No protected methods found
No protected properties found
N/A
No private methods found
$retailer
$applicationId
$documentType
N/A

Constants

ALLOWED_DOCUMENT_TYPES

ALLOWED_DOCUMENT_TYPES

Holds the document types allowed

Properties

$applicationId

$applicationId : string

The application ID

Type

string

$documentType

$documentType : string

The document type required

Type

string

Methods

setDocumentType()

setDocumentType(string  $documentType) : \billythekid\v12finance\models\requests\DownloadDocumentRequest

Sets the document type

Parameters

string $documentType

Throws

\billythekid\v12finance\models\exceptions\InvalidDocumentException

Returns

\billythekid\v12finance\models\requests\DownloadDocumentRequest

getApplicationId()

getApplicationId() : string

Gets the application ID

Returns

string

getDocumentType()

getDocumentType() : string

Gets the document type

Returns

string

jsonSerialize()

jsonSerialize() : mixed

Specify data which should be serialized to JSON

Returns

mixed —

data which can be serialized by json_encode, which is a value of any type other than a resource.