1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace Speicher210\Fastbill\Api\Service\Customer\Get; |
4
|
|
|
|
5
|
|
|
use JMS\Serializer\Annotation as JMS; |
6
|
|
|
use Speicher210\Fastbill\Api\AbstractRequestData; |
7
|
|
|
|
8
|
|
|
/** |
9
|
|
|
* The request data for getting the customers. |
10
|
|
|
*/ |
11
|
|
|
final class RequestData extends AbstractRequestData |
12
|
|
|
{ |
13
|
|
|
/** |
14
|
|
|
* The customer ID. |
15
|
|
|
* |
16
|
|
|
* @var integer |
17
|
|
|
* |
18
|
|
|
* @JMS\Type("integer") |
19
|
|
|
* @JMS\SerializedName("CUSTOMER_ID") |
20
|
|
|
*/ |
21
|
|
|
protected $customerId; |
22
|
|
|
|
23
|
|
|
/** |
24
|
|
|
* The customer external ID. |
25
|
|
|
* |
26
|
|
|
* @var string |
27
|
|
|
* |
28
|
|
|
* @JMS\Type("string") |
29
|
|
|
* @JMS\SerializedName("CUSTOMER_EXT_UID") |
30
|
|
|
*/ |
31
|
|
|
protected $customerExternalUid; |
32
|
|
|
|
33
|
|
|
/** |
34
|
|
|
* The customer number. |
35
|
|
|
* |
36
|
|
|
* @var integer |
37
|
|
|
* |
38
|
|
|
* @JMS\Type("integer") |
39
|
|
|
* @JMS\SerializedName("CUSTOMER_NUMBER") |
40
|
|
|
*/ |
41
|
|
|
protected $customerNumber; |
42
|
|
|
|
43
|
|
|
/** |
44
|
|
|
* The customer country code (ISO 3166 ALPHA-2). |
45
|
|
|
* |
46
|
|
|
* @var string |
47
|
|
|
* |
48
|
|
|
* @JMS\Type("string") |
49
|
|
|
* @JMS\SerializedName("COUNTRY_CODE") |
50
|
|
|
*/ |
51
|
|
|
protected $countryCode; |
52
|
|
|
|
53
|
|
|
/** |
54
|
|
|
* The customer city. |
55
|
|
|
* |
56
|
|
|
* @var string |
57
|
|
|
* |
58
|
|
|
* @JMS\Type("string") |
59
|
|
|
* @JMS\SerializedName("CITY") |
60
|
|
|
*/ |
61
|
|
|
protected $city; |
62
|
|
|
|
63
|
|
|
/** |
64
|
|
|
* Search for the term in fields: ORGANIZATION, FIRST_NAME, LAST_NAME, ADDRESS, ADDRESS_2, ZIPCODE, EMAIL. |
65
|
|
|
* |
66
|
|
|
* @var string |
67
|
|
|
* |
68
|
|
|
* @JMS\Type("string") |
69
|
|
|
* @JMS\SerializedName("TERM") |
70
|
|
|
*/ |
71
|
|
|
protected $term; |
72
|
|
|
|
73
|
|
|
/** |
74
|
|
|
* Comment. |
75
|
|
|
* |
76
|
|
|
* @var string |
77
|
|
|
* |
78
|
|
|
* @JMS\Type("string") |
79
|
|
|
* @JMS\SerializedName("COMMENT") |
80
|
|
|
*/ |
81
|
|
|
protected $comment; |
82
|
|
|
|
83
|
|
|
/** |
84
|
|
|
* URL leading to Dashboard. |
85
|
|
|
* |
86
|
|
|
* @var string |
87
|
|
|
* |
88
|
|
|
* @JMS\Type("string") |
89
|
|
|
* @JMS\SerializedName("DASHBOARD_URL") |
90
|
|
|
*/ |
91
|
|
|
protected $dashboardUrl; |
92
|
|
|
|
93
|
|
|
/** |
94
|
|
|
* URL for changing Master data and invoice data. |
95
|
|
|
* |
96
|
|
|
* @var string |
97
|
|
|
* |
98
|
|
|
* @JMS\Type("string") |
99
|
|
|
* @JMS\SerializedName("CHANGEDATA_URL") |
100
|
|
|
*/ |
101
|
|
|
protected $changeDataUrl; |
102
|
|
|
|
103
|
|
|
/** |
104
|
|
|
* Filter for hash. |
105
|
|
|
* |
106
|
|
|
* @var string |
107
|
|
|
* |
108
|
|
|
* @JMS\Type("string") |
109
|
|
|
* @JMS\SerializedName("HASH") |
110
|
|
|
*/ |
111
|
|
|
protected $hash; |
112
|
|
|
|
113
|
|
|
/** |
114
|
|
|
* Get the customer ID of the request body. |
115
|
|
|
* |
116
|
|
|
* @return integer |
117
|
|
|
*/ |
118
|
|
|
public function getCustomerId() |
119
|
|
|
{ |
120
|
|
|
return $this->customerId; |
121
|
|
|
} |
122
|
|
|
|
123
|
|
|
/** |
124
|
|
|
* Set the customer ID. |
125
|
|
|
* |
126
|
|
|
* @param integer $customerId The customer ID. |
127
|
|
|
* @return RequestData |
128
|
|
|
*/ |
129
|
6 |
|
public function setCustomerId($customerId) |
130
|
|
|
{ |
131
|
6 |
|
$this->customerId = $customerId; |
132
|
|
|
|
133
|
6 |
|
return $this; |
134
|
|
|
} |
135
|
|
|
|
136
|
|
|
/** |
137
|
|
|
* Get the customer external UID. |
138
|
|
|
* |
139
|
|
|
* @return string |
140
|
|
|
*/ |
141
|
|
|
public function getCustomerExternalUid() |
142
|
|
|
{ |
143
|
|
|
return $this->customerExternalUid; |
144
|
|
|
} |
145
|
|
|
|
146
|
|
|
/** |
147
|
|
|
* Set the customer external UID. |
148
|
|
|
* |
149
|
|
|
* @param string $customerExternalUid The external UID. |
150
|
|
|
* @return RequestData |
151
|
|
|
*/ |
152
|
3 |
|
public function setCustomerExternalUid($customerExternalUid) |
153
|
|
|
{ |
154
|
3 |
|
$this->customerExternalUid = $customerExternalUid; |
155
|
|
|
|
156
|
3 |
|
return $this; |
157
|
|
|
} |
158
|
|
|
|
159
|
|
|
/** |
160
|
|
|
* Get the customer number. |
161
|
|
|
* |
162
|
|
|
* @return integer |
163
|
|
|
*/ |
164
|
|
|
public function getCustomerNumber() |
165
|
|
|
{ |
166
|
|
|
return $this->customerNumber; |
167
|
|
|
} |
168
|
|
|
|
169
|
|
|
/** |
170
|
|
|
* Set the customer number. |
171
|
|
|
* |
172
|
|
|
* @param integer $customerNumber The customer number. |
173
|
|
|
* @return RequestData |
174
|
|
|
*/ |
175
|
|
|
public function setCustomerNumber($customerNumber) |
176
|
|
|
{ |
177
|
|
|
$this->customerNumber = $customerNumber; |
178
|
|
|
|
179
|
|
|
return $this; |
180
|
|
|
} |
181
|
|
|
|
182
|
|
|
/** |
183
|
|
|
* Get the country code. |
184
|
|
|
* |
185
|
|
|
* @return string |
186
|
|
|
*/ |
187
|
|
|
public function getCountryCode() |
188
|
|
|
{ |
189
|
|
|
return $this->countryCode; |
190
|
|
|
} |
191
|
|
|
|
192
|
|
|
/** |
193
|
|
|
* Set the country code (ISO 3166 ALPHA-2). |
194
|
|
|
* |
195
|
|
|
* @param string $countryCode The country code. |
196
|
|
|
* @return RequestData |
197
|
|
|
*/ |
198
|
|
|
public function setCountryCode($countryCode) |
199
|
|
|
{ |
200
|
|
|
$this->countryCode = $countryCode; |
201
|
|
|
|
202
|
|
|
return $this; |
203
|
|
|
} |
204
|
|
|
|
205
|
|
|
/** |
206
|
|
|
* Get the customer city. |
207
|
|
|
* |
208
|
|
|
* @return string |
209
|
|
|
*/ |
210
|
|
|
public function getCity() |
211
|
|
|
{ |
212
|
|
|
return $this->city; |
213
|
|
|
} |
214
|
|
|
|
215
|
|
|
/** |
216
|
|
|
* Set the customer city. |
217
|
|
|
* |
218
|
|
|
* @param string $city The city. |
219
|
|
|
* @return RequestData |
220
|
|
|
*/ |
221
|
|
|
public function setCity($city) |
222
|
|
|
{ |
223
|
|
|
$this->city = $city; |
224
|
|
|
|
225
|
|
|
return $this; |
226
|
|
|
} |
227
|
|
|
|
228
|
|
|
/** |
229
|
|
|
* Get the filter term. |
230
|
|
|
* |
231
|
|
|
* @return string |
232
|
|
|
*/ |
233
|
|
|
public function getTerm() |
234
|
|
|
{ |
235
|
|
|
return $this->term; |
236
|
|
|
} |
237
|
|
|
|
238
|
|
|
/** |
239
|
|
|
* Set the filter term. |
240
|
|
|
* |
241
|
|
|
* @param string $term The term to use for search. |
242
|
|
|
* @return RequestData |
243
|
|
|
*/ |
244
|
|
|
public function setTerm($term) |
245
|
|
|
{ |
246
|
|
|
$this->term = $term; |
247
|
|
|
|
248
|
|
|
return $this; |
249
|
|
|
} |
250
|
|
|
|
251
|
|
|
/** |
252
|
|
|
* Get the comment. |
253
|
|
|
* |
254
|
|
|
* @return string |
255
|
|
|
*/ |
256
|
|
|
public function getComment() |
257
|
|
|
{ |
258
|
|
|
return $this->comment; |
259
|
|
|
} |
260
|
|
|
|
261
|
|
|
/** |
262
|
|
|
* Set the comment. |
263
|
|
|
* |
264
|
|
|
* @param string $comment The comment. |
265
|
|
|
* @return RequestData |
266
|
|
|
*/ |
267
|
|
|
public function setComment($comment) |
268
|
|
|
{ |
269
|
|
|
$this->comment = $comment; |
270
|
|
|
|
271
|
|
|
return $this; |
272
|
|
|
} |
273
|
|
|
|
274
|
|
|
/** |
275
|
|
|
* Get the dashboard URL. |
276
|
|
|
* |
277
|
|
|
* @return string |
278
|
|
|
*/ |
279
|
|
|
public function getDashboardUrl() |
280
|
|
|
{ |
281
|
|
|
return $this->dashboardUrl; |
282
|
|
|
} |
283
|
|
|
|
284
|
|
|
/** |
285
|
|
|
* Set the dashboard URL. |
286
|
|
|
* |
287
|
|
|
* @param string $dashboardUrl The dashboard URL. |
288
|
|
|
* @return RequestData |
289
|
|
|
*/ |
290
|
|
|
public function setDashboardUrl($dashboardUrl) |
291
|
|
|
{ |
292
|
|
|
$this->dashboardUrl = $dashboardUrl; |
293
|
|
|
|
294
|
|
|
return $this; |
295
|
|
|
} |
296
|
|
|
|
297
|
|
|
/** |
298
|
|
|
* Get the URL for changing master data and invoice data. |
299
|
|
|
* |
300
|
|
|
* @return string |
301
|
|
|
*/ |
302
|
|
|
public function getChangeDataUrl() |
303
|
|
|
{ |
304
|
|
|
return $this->changeDataUrl; |
305
|
|
|
} |
306
|
|
|
|
307
|
|
|
/** |
308
|
|
|
* Set the URL for changing master data and invoice data. |
309
|
|
|
* |
310
|
|
|
* @param string $changeDataUrl The change data URl. |
311
|
|
|
* @return RequestData |
312
|
|
|
*/ |
313
|
|
|
public function setChangeDataUrl($changeDataUrl) |
314
|
|
|
{ |
315
|
|
|
$this->changeDataUrl = $changeDataUrl; |
316
|
|
|
|
317
|
|
|
return $this; |
318
|
|
|
} |
319
|
|
|
|
320
|
|
|
/** |
321
|
|
|
* Get the hash. |
322
|
|
|
* |
323
|
|
|
* @return string |
324
|
|
|
*/ |
325
|
|
|
public function getHash() |
326
|
|
|
{ |
327
|
|
|
return $this->hash; |
328
|
|
|
} |
329
|
|
|
|
330
|
|
|
/** |
331
|
|
|
* Set the hash. |
332
|
|
|
* |
333
|
|
|
* @param string $hash The hash. |
334
|
|
|
* @return RequestData |
335
|
|
|
*/ |
336
|
|
|
public function setHash($hash) |
337
|
|
|
{ |
338
|
|
|
$this->hash = $hash; |
339
|
|
|
|
340
|
|
|
return $this; |
341
|
|
|
} |
342
|
|
|
} |
343
|
|
|
|