kashflow 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.document +5 -0
- data/Gemfile +19 -0
- data/Gemfile.lock +32 -0
- data/LICENSE.txt +20 -0
- data/README.mkd +49 -0
- data/Rakefile +53 -0
- data/VERSION +1 -0
- data/config/kf_api_methods.yml +1359 -0
- data/kashflow.gemspec +80 -0
- data/lib/kashflow/api.rb +64 -0
- data/lib/kashflow/api_method.rb +19 -0
- data/lib/kashflow/client.rb +97 -0
- data/lib/kashflow.rb +21 -0
- data/test/helper.rb +18 -0
- data/test/test_kashflow.rb +7 -0
- metadata +200 -0
|
@@ -0,0 +1,1359 @@
|
|
|
1
|
+
---
|
|
2
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
3
|
+
name: GetCustomer
|
|
4
|
+
request_attrs:
|
|
5
|
+
- :type: String
|
|
6
|
+
:desc: The unique customer code
|
|
7
|
+
:name: CustomerCode
|
|
8
|
+
response_attrs:
|
|
9
|
+
- :type: Customer
|
|
10
|
+
:desc: An object of type Customer
|
|
11
|
+
:name:
|
|
12
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
13
|
+
name: GetCustomerById
|
|
14
|
+
request_attrs:
|
|
15
|
+
- :type: Integer
|
|
16
|
+
:desc: The unique customer id
|
|
17
|
+
:name: CustomerID
|
|
18
|
+
response_attrs:
|
|
19
|
+
- :type: Customer
|
|
20
|
+
:desc: An object of type Customer
|
|
21
|
+
:name:
|
|
22
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
23
|
+
name: GetCustomerByEmail
|
|
24
|
+
request_attrs:
|
|
25
|
+
- :type: String
|
|
26
|
+
:desc: The customers email address
|
|
27
|
+
:name: CustomerEmail
|
|
28
|
+
response_attrs:
|
|
29
|
+
- :type: Customer
|
|
30
|
+
:desc: An object of type Customer
|
|
31
|
+
:name:
|
|
32
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
33
|
+
name: GetCustomers
|
|
34
|
+
request_attrs: []
|
|
35
|
+
|
|
36
|
+
response_attrs:
|
|
37
|
+
- :type: Customer
|
|
38
|
+
:desc: An array of objects of type Customer
|
|
39
|
+
:name:
|
|
40
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
41
|
+
name: GetCustomersModifiedSince
|
|
42
|
+
request_attrs:
|
|
43
|
+
- :type: DateTime
|
|
44
|
+
:desc: Only customers modified/created on or after this date will be returned
|
|
45
|
+
:name: ModDate
|
|
46
|
+
response_attrs:
|
|
47
|
+
- :type: Customer
|
|
48
|
+
:desc: An array of objects of type Customer
|
|
49
|
+
:name:
|
|
50
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
51
|
+
name: InsertCustomer
|
|
52
|
+
request_attrs:
|
|
53
|
+
- :type: Customer
|
|
54
|
+
:desc: An object of type Customer
|
|
55
|
+
:name: Customer
|
|
56
|
+
response_attrs: []
|
|
57
|
+
|
|
58
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
59
|
+
name: UpdateCustomer
|
|
60
|
+
request_attrs:
|
|
61
|
+
- :type: Customer
|
|
62
|
+
:desc: An object of type Customer
|
|
63
|
+
:name: Customer
|
|
64
|
+
response_attrs: []
|
|
65
|
+
|
|
66
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
67
|
+
name: DeleteCustomer
|
|
68
|
+
request_attrs:
|
|
69
|
+
- :type: Int
|
|
70
|
+
:desc: The unique customer code
|
|
71
|
+
:name: CustomerID
|
|
72
|
+
response_attrs: []
|
|
73
|
+
|
|
74
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
75
|
+
name: GetCustomerSources
|
|
76
|
+
request_attrs: []
|
|
77
|
+
|
|
78
|
+
response_attrs:
|
|
79
|
+
- :type: BasicDataset
|
|
80
|
+
:desc: An array of objects of type BasicDataset
|
|
81
|
+
:name:
|
|
82
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
83
|
+
name: GetCustomerVATNumber
|
|
84
|
+
request_attrs:
|
|
85
|
+
- :type: String
|
|
86
|
+
:desc: The unique customer code.
|
|
87
|
+
:name: CustomerCode
|
|
88
|
+
response_attrs:
|
|
89
|
+
- :type: String
|
|
90
|
+
:desc: A VAT Number.
|
|
91
|
+
:name: CustVATNumber
|
|
92
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
93
|
+
name: SetCustomerVATNumber
|
|
94
|
+
request_attrs:
|
|
95
|
+
- :type: String
|
|
96
|
+
:desc: A VAT Number.
|
|
97
|
+
:name: CustVATNumber
|
|
98
|
+
- :type: String
|
|
99
|
+
:desc: The unique customer code.
|
|
100
|
+
:name: CustomerCode
|
|
101
|
+
response_attrs: []
|
|
102
|
+
|
|
103
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
104
|
+
name: GetCustomerCurrency
|
|
105
|
+
request_attrs:
|
|
106
|
+
- :type: String
|
|
107
|
+
:desc: The unique customer code.
|
|
108
|
+
:name: CustomerCode
|
|
109
|
+
response_attrs:
|
|
110
|
+
- :type: String
|
|
111
|
+
:desc: A currency code e.g. GBP, USD , ZAR
|
|
112
|
+
:name: CustCurrencyCode
|
|
113
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
114
|
+
name: SetCustomerCurrency
|
|
115
|
+
request_attrs:
|
|
116
|
+
- :type: String
|
|
117
|
+
:desc: |-
|
|
118
|
+
The ISO code of a currency.
|
|
119
|
+
|
|
120
|
+
E.g. USD, GBP
|
|
121
|
+
:name: CurrencyCode
|
|
122
|
+
- :type: String
|
|
123
|
+
:desc: The unique customer code.
|
|
124
|
+
:name: CustomerCode
|
|
125
|
+
response_attrs: []
|
|
126
|
+
|
|
127
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
128
|
+
name: DeleteQuote
|
|
129
|
+
request_attrs:
|
|
130
|
+
- :type: Integer
|
|
131
|
+
:desc: An integer representing the quote number you want to delete
|
|
132
|
+
:name: QuoteNumber
|
|
133
|
+
response_attrs: []
|
|
134
|
+
|
|
135
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
136
|
+
name: DeleteQuoteByID
|
|
137
|
+
request_attrs:
|
|
138
|
+
- :type: Integer
|
|
139
|
+
:desc: An integer representing the quote id you want to delete
|
|
140
|
+
:name: QuoteID
|
|
141
|
+
response_attrs: []
|
|
142
|
+
|
|
143
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
144
|
+
name: DeleteQuoteLine
|
|
145
|
+
request_attrs:
|
|
146
|
+
- :type: Integer
|
|
147
|
+
:desc: An integer representing the quote number you want to delete
|
|
148
|
+
:name: QuoteNumber
|
|
149
|
+
- :type: Integer
|
|
150
|
+
:desc: An integer representing the quote line id you want to delete
|
|
151
|
+
:name: LineID
|
|
152
|
+
response_attrs: []
|
|
153
|
+
|
|
154
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
155
|
+
name: DeleteQuoteLineWithQuoteID
|
|
156
|
+
request_attrs:
|
|
157
|
+
- :type: Integer
|
|
158
|
+
:desc: An integer representing the quote id you want to delete
|
|
159
|
+
:name: QuoteID
|
|
160
|
+
- :type: Integer
|
|
161
|
+
:desc: An integer representing the quote line id you want to delete
|
|
162
|
+
:name: LineID
|
|
163
|
+
response_attrs: []
|
|
164
|
+
|
|
165
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
166
|
+
name: GetQuoteByNumber
|
|
167
|
+
request_attrs:
|
|
168
|
+
- :type: Integer
|
|
169
|
+
:desc: The unique quote number
|
|
170
|
+
:name: QuoteNumber
|
|
171
|
+
response_attrs:
|
|
172
|
+
- :type: Quote
|
|
173
|
+
:desc: An object of type Invoice
|
|
174
|
+
:name:
|
|
175
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
176
|
+
name: GetQuoteByID
|
|
177
|
+
request_attrs:
|
|
178
|
+
- :type: Integer
|
|
179
|
+
:desc: The unique qoute id
|
|
180
|
+
:name: QouteID
|
|
181
|
+
response_attrs:
|
|
182
|
+
- :type: Qoute
|
|
183
|
+
:desc: An object of type Invoice
|
|
184
|
+
:name:
|
|
185
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
186
|
+
name: GetQuotes
|
|
187
|
+
request_attrs: []
|
|
188
|
+
|
|
189
|
+
response_attrs:
|
|
190
|
+
- :type: Quote
|
|
191
|
+
:desc: An array object of type Invoice
|
|
192
|
+
:name:
|
|
193
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
194
|
+
name: GetQuotesForCustomer
|
|
195
|
+
request_attrs:
|
|
196
|
+
- :type: Integer
|
|
197
|
+
:desc: The ID of the customer
|
|
198
|
+
:name: CustID
|
|
199
|
+
response_attrs:
|
|
200
|
+
- :type: Invoice
|
|
201
|
+
:desc: An array of type Invoice
|
|
202
|
+
:name:
|
|
203
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
204
|
+
name: InsertQuote
|
|
205
|
+
request_attrs:
|
|
206
|
+
- :type: Quote
|
|
207
|
+
:desc: An object of type Invoice
|
|
208
|
+
:name: Quote
|
|
209
|
+
response_attrs:
|
|
210
|
+
- :type: Integer
|
|
211
|
+
:desc: An Integer representing the new, unique quote id
|
|
212
|
+
:name: QuoteID
|
|
213
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
214
|
+
name: InsertQuoteLine
|
|
215
|
+
request_attrs:
|
|
216
|
+
- :type: Integer
|
|
217
|
+
:desc: An integer value representing the quote id
|
|
218
|
+
:name: QuoteID
|
|
219
|
+
- :type: QuoteLine
|
|
220
|
+
:desc: An object of type InvoiceLine
|
|
221
|
+
:name: QuoteLine
|
|
222
|
+
response_attrs:
|
|
223
|
+
- :type: Integer
|
|
224
|
+
:desc: An Integer representing the new, unique quote line ID
|
|
225
|
+
:name: QuoteLineID
|
|
226
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
227
|
+
name: isStillQuote
|
|
228
|
+
request_attrs:
|
|
229
|
+
- :type: Integer
|
|
230
|
+
:desc: The unique qoute id
|
|
231
|
+
:name: QouteID
|
|
232
|
+
response_attrs: []
|
|
233
|
+
|
|
234
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
235
|
+
name: UpdateQuote
|
|
236
|
+
request_attrs:
|
|
237
|
+
- :type: Quote
|
|
238
|
+
:desc: An object of type Invoice
|
|
239
|
+
:name: Quote
|
|
240
|
+
response_attrs: []
|
|
241
|
+
|
|
242
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
243
|
+
name: UpdateQuoteHeader
|
|
244
|
+
request_attrs:
|
|
245
|
+
- :type: Quote
|
|
246
|
+
:desc: An object of type Invoice
|
|
247
|
+
:name: Quote
|
|
248
|
+
response_attrs: []
|
|
249
|
+
|
|
250
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
251
|
+
name: ConvertQuoteToInvoice
|
|
252
|
+
request_attrs:
|
|
253
|
+
- :type: Integer
|
|
254
|
+
:desc: The ID of the quote you wish to convert
|
|
255
|
+
:name: QuoteID
|
|
256
|
+
- :type: Integer
|
|
257
|
+
:desc: The ID of the customer you want the invoice assigned to. Leave it as 0 and it'll be assigned to the same customer as the quote.
|
|
258
|
+
:name: CustomerID
|
|
259
|
+
- :type: Integer
|
|
260
|
+
:desc: Set to 1 if you want a line on the invoice saying "Based on Quote Number x"
|
|
261
|
+
:name: CopyQuoteReference
|
|
262
|
+
- :type: Integer
|
|
263
|
+
:desc: If set to 1 then the quote will be deleted once the invoice has been created
|
|
264
|
+
:name: |-
|
|
265
|
+
deleteQuote
|
|
266
|
+
Afterconversion
|
|
267
|
+
response_attrs:
|
|
268
|
+
- :type: Invoice
|
|
269
|
+
:desc: An object of type Invoice
|
|
270
|
+
:name:
|
|
271
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
272
|
+
name: GetInvoice
|
|
273
|
+
request_attrs:
|
|
274
|
+
- :type: Integer
|
|
275
|
+
:desc: The unique invoice number
|
|
276
|
+
:name: InvoiceNumber
|
|
277
|
+
response_attrs:
|
|
278
|
+
- :type: Invoice
|
|
279
|
+
:desc: An object of type Invoice
|
|
280
|
+
:name:
|
|
281
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
282
|
+
name: GetInvoiceByID
|
|
283
|
+
request_attrs:
|
|
284
|
+
- :type: Integer
|
|
285
|
+
:desc: The unique invoice id
|
|
286
|
+
:name: InvoiceID
|
|
287
|
+
response_attrs:
|
|
288
|
+
- :type: Invoice
|
|
289
|
+
:desc: An object of type Invoice
|
|
290
|
+
:name:
|
|
291
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
292
|
+
name: GetInvoicesByDateRange
|
|
293
|
+
request_attrs:
|
|
294
|
+
- :type: DateTime
|
|
295
|
+
:desc: The start date of the range for which you'd like to view invoices
|
|
296
|
+
:name: StartDate
|
|
297
|
+
- :type: DateTime
|
|
298
|
+
:desc: The end date for the range
|
|
299
|
+
:name: EndDate
|
|
300
|
+
response_attrs:
|
|
301
|
+
- :type: Invoice
|
|
302
|
+
:desc: An array of type Invoice
|
|
303
|
+
:name:
|
|
304
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
305
|
+
name: GetInvoicesForCustomer
|
|
306
|
+
request_attrs:
|
|
307
|
+
- :type: Integer
|
|
308
|
+
:desc: The ID of the customer
|
|
309
|
+
:name: CustID
|
|
310
|
+
response_attrs:
|
|
311
|
+
- :type: Invoice
|
|
312
|
+
:desc: An array of type Invoice
|
|
313
|
+
:name:
|
|
314
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
315
|
+
name: GetInvoices_Overdue
|
|
316
|
+
request_attrs: []
|
|
317
|
+
|
|
318
|
+
response_attrs:
|
|
319
|
+
- :type: Invoice
|
|
320
|
+
:desc: An array of type Invoice
|
|
321
|
+
:name:
|
|
322
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
323
|
+
name: GetInvoices_Recent
|
|
324
|
+
request_attrs:
|
|
325
|
+
- :type: Integer
|
|
326
|
+
:desc: The number of invoices you'd like returned
|
|
327
|
+
:name: NumberOfInvoices
|
|
328
|
+
response_attrs:
|
|
329
|
+
- :type: Invoice
|
|
330
|
+
:desc: An array of type Invoice
|
|
331
|
+
:name:
|
|
332
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
333
|
+
name: GetInvoices_Unpaid
|
|
334
|
+
request_attrs: []
|
|
335
|
+
|
|
336
|
+
response_attrs:
|
|
337
|
+
- :type: Invoice
|
|
338
|
+
:desc: An array of type Invoice
|
|
339
|
+
:name:
|
|
340
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
341
|
+
name: InsertInvoice
|
|
342
|
+
request_attrs:
|
|
343
|
+
- :type: Invoice
|
|
344
|
+
:desc: An object of type Invoice
|
|
345
|
+
:name: Invoice
|
|
346
|
+
response_attrs:
|
|
347
|
+
- :type: Integer
|
|
348
|
+
:desc: An Integer representing the new, unique invoice number
|
|
349
|
+
:name: InvoiceNumber
|
|
350
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
351
|
+
name: InsertInvoiceLine
|
|
352
|
+
request_attrs:
|
|
353
|
+
- :type: Integer
|
|
354
|
+
:desc: An Integer representing the unique invoice id
|
|
355
|
+
:name: InvoiceID
|
|
356
|
+
- :type: InvoiceLine
|
|
357
|
+
:desc: An object of type InvoiceLine
|
|
358
|
+
:name: InvoiceLine
|
|
359
|
+
response_attrs:
|
|
360
|
+
- :type: Integer
|
|
361
|
+
:desc: An Integer representing the new, unique invoice line ID
|
|
362
|
+
:name: InvoiceLineID
|
|
363
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
364
|
+
name: InsertInvoiceLineWithInvoiceNumber
|
|
365
|
+
request_attrs:
|
|
366
|
+
- :type: Integer
|
|
367
|
+
:desc: An Integer representing the invoice number
|
|
368
|
+
:name: InvoiceNumber
|
|
369
|
+
- :type: InvoiceLine
|
|
370
|
+
:desc: An object of type InvoiceLine
|
|
371
|
+
:name: InvoiceLine
|
|
372
|
+
response_attrs:
|
|
373
|
+
- :type: Integer
|
|
374
|
+
:desc: An Integer representing the new, unique invoice line ID
|
|
375
|
+
:name: InvoiceLineID
|
|
376
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
377
|
+
name: UpdateInvoice
|
|
378
|
+
request_attrs:
|
|
379
|
+
- :type: Invoice
|
|
380
|
+
:desc: An object of type Invoice
|
|
381
|
+
:name: Invoice
|
|
382
|
+
response_attrs: []
|
|
383
|
+
|
|
384
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
385
|
+
name: UpdateInvoiceHeader
|
|
386
|
+
request_attrs:
|
|
387
|
+
- :type: Invoice
|
|
388
|
+
:desc: An object of type Invoice
|
|
389
|
+
:name: Invoice
|
|
390
|
+
response_attrs: []
|
|
391
|
+
|
|
392
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
393
|
+
name: DeleteInvoice
|
|
394
|
+
request_attrs:
|
|
395
|
+
- :type: Integer
|
|
396
|
+
:desc: The invoice number
|
|
397
|
+
:name: InvoiceNumber
|
|
398
|
+
response_attrs: []
|
|
399
|
+
|
|
400
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
401
|
+
name: DeleteInvoiceByID
|
|
402
|
+
request_attrs:
|
|
403
|
+
- :type: Integer
|
|
404
|
+
:desc: The unique invoice id
|
|
405
|
+
:name: InvoiceID
|
|
406
|
+
response_attrs: []
|
|
407
|
+
|
|
408
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
409
|
+
name: DeleteInvoiceLine
|
|
410
|
+
request_attrs:
|
|
411
|
+
- :type: Integer
|
|
412
|
+
:desc: An integer representing the invoice line id
|
|
413
|
+
:name: InvoiceLineID
|
|
414
|
+
- :type: Integer
|
|
415
|
+
:desc: An integer representing the invoice number
|
|
416
|
+
:name: InvoiceNumber
|
|
417
|
+
response_attrs: []
|
|
418
|
+
|
|
419
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
420
|
+
name: DeleteInvoiceLineWithInvoiceID
|
|
421
|
+
request_attrs:
|
|
422
|
+
- :type: Integer
|
|
423
|
+
:desc: An integer representing the invoice line id
|
|
424
|
+
:name: InvoiceLineID
|
|
425
|
+
- :type: Integer
|
|
426
|
+
:desc: An integer representing the invoice id
|
|
427
|
+
:name: InvoiceID
|
|
428
|
+
response_attrs: []
|
|
429
|
+
|
|
430
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
431
|
+
name: EmailInvoice
|
|
432
|
+
request_attrs:
|
|
433
|
+
- :type: Integer
|
|
434
|
+
:desc: The number of the invoice to be emailed.
|
|
435
|
+
:name: InvoiceNumber
|
|
436
|
+
- :type: String
|
|
437
|
+
:desc: The name of the sender
|
|
438
|
+
:name: FromEmail
|
|
439
|
+
- :type: String
|
|
440
|
+
:desc: The email address that the invoice should appear to have been sent from
|
|
441
|
+
:name: FromName
|
|
442
|
+
- :type: String
|
|
443
|
+
:desc: The subject line to be used on the email
|
|
444
|
+
:name: SubjectLine
|
|
445
|
+
- :type: String
|
|
446
|
+
:desc: The body of the email
|
|
447
|
+
:name: Body
|
|
448
|
+
- :type: String
|
|
449
|
+
:desc: The recipients email address
|
|
450
|
+
:name: RecipientEmail
|
|
451
|
+
response_attrs: []
|
|
452
|
+
|
|
453
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
454
|
+
name: PrintInvoice
|
|
455
|
+
request_attrs:
|
|
456
|
+
- :type: Integer
|
|
457
|
+
:desc: |-
|
|
458
|
+
The invoice number for the invoice you want to print.
|
|
459
|
+
If you are instead supplying a string of numbers in the
|
|
460
|
+
next argument then you should set this to 0
|
|
461
|
+
:name: InvoiceNumber
|
|
462
|
+
- :type: String
|
|
463
|
+
:desc: |-
|
|
464
|
+
A comma separated list of invoice numbers.
|
|
465
|
+
You can just provide an empty string if you are
|
|
466
|
+
providing a single invoice number above.
|
|
467
|
+
:name: InvoiceNumberList
|
|
468
|
+
response_attrs: []
|
|
469
|
+
|
|
470
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
471
|
+
name: GetPaypalLink
|
|
472
|
+
request_attrs: []
|
|
473
|
+
|
|
474
|
+
response_attrs:
|
|
475
|
+
- :type: String
|
|
476
|
+
:desc: A string containing the URL
|
|
477
|
+
:name:
|
|
478
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
479
|
+
name: GetInvoicePayment
|
|
480
|
+
request_attrs:
|
|
481
|
+
- :type: Integer
|
|
482
|
+
:desc: The unique invoice number for which you wish to retrieve payments
|
|
483
|
+
:name: InvoiceNumber
|
|
484
|
+
response_attrs:
|
|
485
|
+
- :type: Payment
|
|
486
|
+
:desc: An array of objects of type Payment
|
|
487
|
+
:name:
|
|
488
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
489
|
+
name: GetInvPayMethods
|
|
490
|
+
request_attrs: []
|
|
491
|
+
|
|
492
|
+
response_attrs:
|
|
493
|
+
- :type: InvoicePaymentMethod
|
|
494
|
+
:desc: An array of objects of type PaymentMethod
|
|
495
|
+
:name:
|
|
496
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
497
|
+
name: InsertInvoicePayment
|
|
498
|
+
request_attrs:
|
|
499
|
+
- :type: Payment
|
|
500
|
+
:desc: An object of type Payment
|
|
501
|
+
:name: Payment
|
|
502
|
+
response_attrs:
|
|
503
|
+
- :type: Integer
|
|
504
|
+
:desc: An integer representing the new payment number
|
|
505
|
+
:name:
|
|
506
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
507
|
+
name: DeleteInvoicePayment
|
|
508
|
+
request_attrs:
|
|
509
|
+
- :type: Integer
|
|
510
|
+
:desc: An integer representing the payment number you want to delete
|
|
511
|
+
:name: PaymentNumber
|
|
512
|
+
response_attrs: []
|
|
513
|
+
|
|
514
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
515
|
+
name: GetSupplier
|
|
516
|
+
request_attrs:
|
|
517
|
+
- :type: String
|
|
518
|
+
:desc: The unique supplier code
|
|
519
|
+
:name: SupplierCode
|
|
520
|
+
response_attrs:
|
|
521
|
+
- :type: Supplier
|
|
522
|
+
:desc: An object of type Supplier
|
|
523
|
+
:name:
|
|
524
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
525
|
+
name: GetSuppliers
|
|
526
|
+
request_attrs: []
|
|
527
|
+
|
|
528
|
+
response_attrs:
|
|
529
|
+
- :type: Supplier
|
|
530
|
+
:desc: An array object of type Supplier
|
|
531
|
+
:name:
|
|
532
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
533
|
+
name: GetSupplierById
|
|
534
|
+
request_attrs:
|
|
535
|
+
- :type: Integer
|
|
536
|
+
:desc: The unique Supplier id
|
|
537
|
+
:name: SupplierID
|
|
538
|
+
response_attrs:
|
|
539
|
+
- :type: Supplier
|
|
540
|
+
:desc: An object of type Supplier
|
|
541
|
+
:name:
|
|
542
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
543
|
+
name: InsertSupplier
|
|
544
|
+
request_attrs:
|
|
545
|
+
- :type: Supplier
|
|
546
|
+
:desc: An object of type Supplier
|
|
547
|
+
:name: Supplier
|
|
548
|
+
response_attrs: []
|
|
549
|
+
|
|
550
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
551
|
+
name: UpdateSupplier
|
|
552
|
+
request_attrs:
|
|
553
|
+
- :type: Supplier
|
|
554
|
+
:desc: An object of type Supplier
|
|
555
|
+
:name: Supplier
|
|
556
|
+
response_attrs: []
|
|
557
|
+
|
|
558
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
559
|
+
name: GetSupplierVATNumber
|
|
560
|
+
request_attrs:
|
|
561
|
+
- :type: String
|
|
562
|
+
:desc: The unique supplier code.
|
|
563
|
+
:name: SupplierCode
|
|
564
|
+
response_attrs:
|
|
565
|
+
- :type: String
|
|
566
|
+
:desc: A VAT Number.
|
|
567
|
+
:name: SupVATNumber
|
|
568
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
569
|
+
name: SetSupplierVATNumber
|
|
570
|
+
request_attrs:
|
|
571
|
+
- :type: String
|
|
572
|
+
:desc: A VAT Number.
|
|
573
|
+
:name: SupVATNumber
|
|
574
|
+
- :type: String
|
|
575
|
+
:desc: The unique supplier code.
|
|
576
|
+
:name: SupplierCode
|
|
577
|
+
response_attrs: []
|
|
578
|
+
|
|
579
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
580
|
+
name: GetSupplierCurrency
|
|
581
|
+
request_attrs:
|
|
582
|
+
- :type: String
|
|
583
|
+
:desc: The unique supplier code.
|
|
584
|
+
:name: SupplierCode
|
|
585
|
+
response_attrs:
|
|
586
|
+
- :type: String
|
|
587
|
+
:desc: A currency code e.g. GBP, USD , ZAR
|
|
588
|
+
:name: SuppCurrencyCode
|
|
589
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
590
|
+
name: SetSupplierCurrency
|
|
591
|
+
request_attrs:
|
|
592
|
+
- :type: String
|
|
593
|
+
:desc: |-
|
|
594
|
+
The ISO code of a currency.
|
|
595
|
+
|
|
596
|
+
E.g. USD, GBP
|
|
597
|
+
:name: CurrencyCode
|
|
598
|
+
- :type: String
|
|
599
|
+
:desc: The unique supplier code.
|
|
600
|
+
:name: SupplierCode
|
|
601
|
+
response_attrs: []
|
|
602
|
+
|
|
603
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
604
|
+
name: GetReceipt
|
|
605
|
+
request_attrs:
|
|
606
|
+
- :type: Integer
|
|
607
|
+
:desc: The unique receipt number
|
|
608
|
+
:name: ReceiptNumber
|
|
609
|
+
response_attrs:
|
|
610
|
+
- :type: Receipt
|
|
611
|
+
:desc: An object of type Receipt
|
|
612
|
+
:name:
|
|
613
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
614
|
+
name: GetReceipts
|
|
615
|
+
request_attrs: []
|
|
616
|
+
|
|
617
|
+
response_attrs:
|
|
618
|
+
- :type: Invoice
|
|
619
|
+
:desc: An array of type Invoice
|
|
620
|
+
:name:
|
|
621
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
622
|
+
name: GetReceiptsForSupplier
|
|
623
|
+
request_attrs:
|
|
624
|
+
- :type: Integer
|
|
625
|
+
:desc: The unique supplier id
|
|
626
|
+
:name: SupplierID
|
|
627
|
+
response_attrs:
|
|
628
|
+
- :type: Invoice
|
|
629
|
+
:desc: An array of type Invoice
|
|
630
|
+
:name:
|
|
631
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
632
|
+
name: InsertReceipt
|
|
633
|
+
request_attrs:
|
|
634
|
+
- :type: Invoice
|
|
635
|
+
:desc: An object of type Invoice
|
|
636
|
+
:name: Invoice
|
|
637
|
+
response_attrs:
|
|
638
|
+
- :type: Integer
|
|
639
|
+
:desc: An Integer representing the new, unique receipt number
|
|
640
|
+
:name: ReceiptNumber
|
|
641
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
642
|
+
name: UpdateReceipt
|
|
643
|
+
request_attrs:
|
|
644
|
+
- :type: Invoice
|
|
645
|
+
:desc: An object of type Invoice
|
|
646
|
+
:name: Receipt
|
|
647
|
+
response_attrs: []
|
|
648
|
+
|
|
649
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
650
|
+
name: UpdateReceiptHeader
|
|
651
|
+
request_attrs:
|
|
652
|
+
- :type: Invoice
|
|
653
|
+
:desc: An object of type Invoice
|
|
654
|
+
:name: Invoice
|
|
655
|
+
response_attrs: []
|
|
656
|
+
|
|
657
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
658
|
+
name: DeleteReceipt
|
|
659
|
+
request_attrs:
|
|
660
|
+
- :type: Integer
|
|
661
|
+
:desc: An integer representing the receipt number you want to delete
|
|
662
|
+
:name: ReceiptNumber
|
|
663
|
+
response_attrs: []
|
|
664
|
+
|
|
665
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
666
|
+
name: DeleteReceiptByID
|
|
667
|
+
request_attrs:
|
|
668
|
+
- :type: Integer
|
|
669
|
+
:desc: An integer representing the receipt id you want to delete
|
|
670
|
+
:name: ReceiptID
|
|
671
|
+
response_attrs: []
|
|
672
|
+
|
|
673
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
674
|
+
name: InsertReceiptLine
|
|
675
|
+
request_attrs:
|
|
676
|
+
- :type: Integer
|
|
677
|
+
:desc: The receipt id for the receipt you're adding line(s) to
|
|
678
|
+
:name: ReceiptID
|
|
679
|
+
- :type: InvoiceLine
|
|
680
|
+
:desc: An object of type InvoiceLine
|
|
681
|
+
:name: RceiptLine
|
|
682
|
+
response_attrs: []
|
|
683
|
+
|
|
684
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
685
|
+
name: InsertReceiptLineFromNumber
|
|
686
|
+
request_attrs:
|
|
687
|
+
- :type: Integer
|
|
688
|
+
:desc: The receipt number for the receipt you're adding line(s) to
|
|
689
|
+
:name: ReceiptNumber
|
|
690
|
+
- :type: InvoiceLine
|
|
691
|
+
:desc: An object of type InvoiceLine
|
|
692
|
+
:name: RceiptLine
|
|
693
|
+
response_attrs: []
|
|
694
|
+
|
|
695
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
696
|
+
name: DeleteReceiptLine
|
|
697
|
+
request_attrs:
|
|
698
|
+
- :type: Integer
|
|
699
|
+
:desc: An integer representing the receipt line id you want to delete
|
|
700
|
+
:name: LineID
|
|
701
|
+
- :type: Integer
|
|
702
|
+
:desc: An integer representing the receipt number you want to delete
|
|
703
|
+
:name: ReceiptNumber
|
|
704
|
+
response_attrs: []
|
|
705
|
+
|
|
706
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
707
|
+
name: DeleteReceiptLineWithReceiptID
|
|
708
|
+
request_attrs:
|
|
709
|
+
- :type: Integer
|
|
710
|
+
:desc: An integer representing the receipt line id you want to delete
|
|
711
|
+
:name: LineID
|
|
712
|
+
- :type: Integer
|
|
713
|
+
:desc: An integer representing the receipt id you want to delete
|
|
714
|
+
:name: ReceiptID
|
|
715
|
+
response_attrs: []
|
|
716
|
+
|
|
717
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
718
|
+
name: AttachFileToReceipt
|
|
719
|
+
request_attrs:
|
|
720
|
+
- :type: Integer
|
|
721
|
+
:desc: An integer value representing the receipt no.
|
|
722
|
+
:name: ReceiptNo
|
|
723
|
+
- :type: String
|
|
724
|
+
:desc: A base64 encoded string of the file to be attached.
|
|
725
|
+
:name: Base64String
|
|
726
|
+
- :type: String
|
|
727
|
+
:desc: The content type of the file to be attached.e.g. "plain/text"
|
|
728
|
+
:name: ContentType
|
|
729
|
+
- :type: String
|
|
730
|
+
:desc: The name and extension of the file to be attached.
|
|
731
|
+
:name: Filename
|
|
732
|
+
- :type: String
|
|
733
|
+
:desc: The extension of the file to be attached.e.g. "txt" or "pdf"
|
|
734
|
+
:name: FileExtension
|
|
735
|
+
- :type: String
|
|
736
|
+
:desc: The size of the file.e.g. "510"
|
|
737
|
+
:name: FileSize
|
|
738
|
+
response_attrs: []
|
|
739
|
+
|
|
740
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
741
|
+
name: GetReceiptAttachments
|
|
742
|
+
request_attrs:
|
|
743
|
+
- :type: Integer
|
|
744
|
+
:desc: An integer value representing the receipt id.
|
|
745
|
+
:name: ReceiptID
|
|
746
|
+
response_attrs:
|
|
747
|
+
- :type: ReceiptAttachment
|
|
748
|
+
:desc: An array of objects of type ReceiptAttachment
|
|
749
|
+
:name:
|
|
750
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
751
|
+
name: DeleteReceiptAttachment
|
|
752
|
+
request_attrs:
|
|
753
|
+
- :type: Integer
|
|
754
|
+
:desc: An integer value representing the receipt id.
|
|
755
|
+
:name: ReceiptID
|
|
756
|
+
- :type: Integer
|
|
757
|
+
:desc: An integer value representing the attachment id.
|
|
758
|
+
:name: AttachmentID
|
|
759
|
+
response_attrs: []
|
|
760
|
+
|
|
761
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
762
|
+
name: GetReceiptPayment
|
|
763
|
+
request_attrs:
|
|
764
|
+
- :type: Integer
|
|
765
|
+
:desc: The unique receipt number for which you wish to retrieve payments
|
|
766
|
+
:name: ReceiptNumber
|
|
767
|
+
response_attrs:
|
|
768
|
+
- :type: Payment
|
|
769
|
+
:desc: An array of objects of type Payment
|
|
770
|
+
:name:
|
|
771
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
772
|
+
name: GetRecPayMethods
|
|
773
|
+
request_attrs: []
|
|
774
|
+
|
|
775
|
+
response_attrs:
|
|
776
|
+
- :type: ReceiptPaymentMethod
|
|
777
|
+
:desc: An array of objects of type PaymentMethod
|
|
778
|
+
:name:
|
|
779
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
780
|
+
name: InsertReceiptPayment
|
|
781
|
+
request_attrs:
|
|
782
|
+
- :type: Payment
|
|
783
|
+
:desc: An object of type Payment
|
|
784
|
+
:name: Payment
|
|
785
|
+
response_attrs:
|
|
786
|
+
- :type: Integer
|
|
787
|
+
:desc: An integer representing the new payment number
|
|
788
|
+
:name:
|
|
789
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
790
|
+
name: DeleteReceiptPayment
|
|
791
|
+
request_attrs:
|
|
792
|
+
- :type: Integer
|
|
793
|
+
:desc: An integer representing the payment number you want to delete
|
|
794
|
+
:name: PaymentNumber
|
|
795
|
+
response_attrs: []
|
|
796
|
+
|
|
797
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
798
|
+
name: CreateBankAccount
|
|
799
|
+
request_attrs:
|
|
800
|
+
- :type: String
|
|
801
|
+
:desc: ""
|
|
802
|
+
:name: AccountName
|
|
803
|
+
- :type: Integer
|
|
804
|
+
:desc: ""
|
|
805
|
+
:name: NominalCode
|
|
806
|
+
response_attrs: []
|
|
807
|
+
|
|
808
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
809
|
+
name: GetBankAccounts
|
|
810
|
+
request_attrs: []
|
|
811
|
+
|
|
812
|
+
response_attrs:
|
|
813
|
+
- :type: BankAccount
|
|
814
|
+
:desc: An array of objects of type BankAccount
|
|
815
|
+
:name:
|
|
816
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
817
|
+
name: GetBankTXTypes
|
|
818
|
+
request_attrs: []
|
|
819
|
+
|
|
820
|
+
response_attrs:
|
|
821
|
+
- :type: BankTXType
|
|
822
|
+
:desc: An array of objects of type BankTXType
|
|
823
|
+
:name: BankTXTypes[]
|
|
824
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
825
|
+
name: GetBankBalance
|
|
826
|
+
request_attrs:
|
|
827
|
+
- :type: Integer
|
|
828
|
+
:desc: An integer representing the unique bank account id
|
|
829
|
+
:name: AccountID
|
|
830
|
+
- :type: DateTime
|
|
831
|
+
:desc: !binary |
|
|
832
|
+
wqA=
|
|
833
|
+
|
|
834
|
+
:name: BalanceDate
|
|
835
|
+
response_attrs: []
|
|
836
|
+
|
|
837
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
838
|
+
name: GetBankTransactions
|
|
839
|
+
request_attrs:
|
|
840
|
+
- :type: Integer
|
|
841
|
+
:desc: The unique bank account id
|
|
842
|
+
:name: AccountID
|
|
843
|
+
response_attrs:
|
|
844
|
+
- :type: BankTransaction
|
|
845
|
+
:desc: An array of type BankTransaction
|
|
846
|
+
:name:
|
|
847
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
848
|
+
name: InsertBankTransaction
|
|
849
|
+
request_attrs:
|
|
850
|
+
- :type: Invoice
|
|
851
|
+
:desc: An object of type BankTransaction
|
|
852
|
+
:name: BankTransaction
|
|
853
|
+
response_attrs:
|
|
854
|
+
- :type: Integer
|
|
855
|
+
:desc: An Integer representing the new, system-wide unique tx number
|
|
856
|
+
:name:
|
|
857
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
858
|
+
name: UpdateBankTransaction
|
|
859
|
+
request_attrs:
|
|
860
|
+
- :type: BankTransaction
|
|
861
|
+
:desc: An object of type BankTransaction
|
|
862
|
+
:name: BankTransaction
|
|
863
|
+
response_attrs: []
|
|
864
|
+
|
|
865
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
866
|
+
name: DeleteBankTransaction
|
|
867
|
+
request_attrs:
|
|
868
|
+
- :type: Integer
|
|
869
|
+
:desc: An integer representing the unique transaction id
|
|
870
|
+
:name: TransactionID
|
|
871
|
+
response_attrs: []
|
|
872
|
+
|
|
873
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
874
|
+
name: InsertJournal
|
|
875
|
+
request_attrs:
|
|
876
|
+
- :type: JournalEntry
|
|
877
|
+
:desc: An object of type JournalEntry
|
|
878
|
+
:name: JournalEntry
|
|
879
|
+
response_attrs:
|
|
880
|
+
- :type: Integer
|
|
881
|
+
:desc: An Integer representing the new, unique journal entry number
|
|
882
|
+
:name: JournalEntryNumber
|
|
883
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
884
|
+
name: GetJournal
|
|
885
|
+
request_attrs:
|
|
886
|
+
- :type: Integer
|
|
887
|
+
:desc: An integer representing the journal number
|
|
888
|
+
:name: JournalNumber
|
|
889
|
+
response_attrs:
|
|
890
|
+
- :type: JournalEntry
|
|
891
|
+
:desc: An object of type JournalEntry
|
|
892
|
+
:name:
|
|
893
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
894
|
+
name: GetJournals
|
|
895
|
+
request_attrs: []
|
|
896
|
+
|
|
897
|
+
response_attrs:
|
|
898
|
+
- :type: JournalEntry
|
|
899
|
+
:desc: An array of type JournalEntry
|
|
900
|
+
:name:
|
|
901
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
902
|
+
name: DeleteJournal
|
|
903
|
+
request_attrs:
|
|
904
|
+
- :type: Integer
|
|
905
|
+
:desc: An integer representing the journal number
|
|
906
|
+
:name: JournalNumber
|
|
907
|
+
response_attrs: []
|
|
908
|
+
|
|
909
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
910
|
+
name: DeleteJournalByID
|
|
911
|
+
request_attrs:
|
|
912
|
+
- :type: Integer
|
|
913
|
+
:desc: An integer representing the journal id
|
|
914
|
+
:name: JournalID
|
|
915
|
+
response_attrs: []
|
|
916
|
+
|
|
917
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
918
|
+
name: UpdateJournal
|
|
919
|
+
request_attrs:
|
|
920
|
+
- :type: JournalEntry
|
|
921
|
+
:desc: An object of type JournalEntry
|
|
922
|
+
:name: JournalEntry
|
|
923
|
+
response_attrs: []
|
|
924
|
+
|
|
925
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
926
|
+
name: UpdateJournalHeader
|
|
927
|
+
request_attrs:
|
|
928
|
+
- :type: JournalEntry
|
|
929
|
+
:desc: An object of type JournalEntry
|
|
930
|
+
:name: JournalEntry
|
|
931
|
+
response_attrs: []
|
|
932
|
+
|
|
933
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
934
|
+
name: GetAgedDebtors
|
|
935
|
+
request_attrs:
|
|
936
|
+
- :type: DateTime
|
|
937
|
+
:desc: The date you'd like the report for
|
|
938
|
+
:name: AgedDebtorsDate
|
|
939
|
+
response_attrs:
|
|
940
|
+
- :type: AgedDebtorsCreditors
|
|
941
|
+
:desc: An object of type AgedDebtorsCreditors
|
|
942
|
+
:name: AgedDebtorsCreditors
|
|
943
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
944
|
+
name: GetBalanceSheet
|
|
945
|
+
request_attrs:
|
|
946
|
+
- :type: DateTime
|
|
947
|
+
:desc: The start date for the report
|
|
948
|
+
:name: Date
|
|
949
|
+
response_attrs:
|
|
950
|
+
- :type: BalanceSheet
|
|
951
|
+
:desc: An object of type BalanceSheet
|
|
952
|
+
:name:
|
|
953
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
954
|
+
name: GetDigitaCSVFile
|
|
955
|
+
request_attrs:
|
|
956
|
+
- :type: DateTime
|
|
957
|
+
:desc: The start date for the report
|
|
958
|
+
:name: StartDate
|
|
959
|
+
- :type: DateTime
|
|
960
|
+
:desc: The end date for the report
|
|
961
|
+
:name: EndDate
|
|
962
|
+
response_attrs:
|
|
963
|
+
- :type: String
|
|
964
|
+
:desc: An string containing the data for the CSV file.
|
|
965
|
+
:name:
|
|
966
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
967
|
+
name: GetIncomeByCustomer
|
|
968
|
+
request_attrs:
|
|
969
|
+
- :type: DateTime
|
|
970
|
+
:desc: The start date for the report
|
|
971
|
+
:name: StartDate
|
|
972
|
+
- :type: DateTime
|
|
973
|
+
:desc: The end date for the report
|
|
974
|
+
:name: EndDate
|
|
975
|
+
- :type: Boolean
|
|
976
|
+
:desc: If set to True then the report will be based on invoice dates, as opposed to payment dates
|
|
977
|
+
:name: BasedOnInvoiceDate
|
|
978
|
+
response_attrs:
|
|
979
|
+
- :type: BasicDataset
|
|
980
|
+
:desc: |-
|
|
981
|
+
An array of objects of type BasicDataset.
|
|
982
|
+
The ID field contains the customer id. Name is the customer name, Description is the customer code, Value is the income from this customer in the period specified
|
|
983
|
+
:name:
|
|
984
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
985
|
+
name: GetKPIs
|
|
986
|
+
request_attrs:
|
|
987
|
+
- :type: DateTime
|
|
988
|
+
:desc: The start date for the report
|
|
989
|
+
:name: StartDate
|
|
990
|
+
- :type: DateTime
|
|
991
|
+
:desc: The end date for the report
|
|
992
|
+
:name: EndDate
|
|
993
|
+
- :type: Integer
|
|
994
|
+
:desc: If set to 1 then VAT will not be included in financial values
|
|
995
|
+
:name: ExcludeVAT
|
|
996
|
+
- :type: Integer
|
|
997
|
+
:desc: If set to 1 then invoices and receipts paid on the day of issue will not be included in calculations of how long it takes for invoices and receipts to be paid.
|
|
998
|
+
:name: ExcludeSameDayPays
|
|
999
|
+
response_attrs:
|
|
1000
|
+
- :type: BasicDataset
|
|
1001
|
+
:desc: |-
|
|
1002
|
+
An array of objects of type BasicDataset.
|
|
1003
|
+
The ID field contains the customer id. Name is the customer name, Description is the customer code, Value is the income from this customer in the period specified
|
|
1004
|
+
:name:
|
|
1005
|
+
- :type:
|
|
1006
|
+
:desc: Value
|
|
1007
|
+
:name:
|
|
1008
|
+
- :type:
|
|
1009
|
+
:desc: "17"
|
|
1010
|
+
:name:
|
|
1011
|
+
- :type:
|
|
1012
|
+
:desc: "24"
|
|
1013
|
+
:name:
|
|
1014
|
+
- :type:
|
|
1015
|
+
:desc: "24.60"
|
|
1016
|
+
:name:
|
|
1017
|
+
- :type:
|
|
1018
|
+
:desc: "170"
|
|
1019
|
+
:name:
|
|
1020
|
+
- :type:
|
|
1021
|
+
:desc: "429"
|
|
1022
|
+
:name:
|
|
1023
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
1024
|
+
name: GetMonthlyProfitAndLoss
|
|
1025
|
+
request_attrs:
|
|
1026
|
+
- :type: DateTime
|
|
1027
|
+
:desc: The start date for the report
|
|
1028
|
+
:name: StartDate
|
|
1029
|
+
- :type: DateTime
|
|
1030
|
+
:desc: The end date for the report
|
|
1031
|
+
:name: EndDate
|
|
1032
|
+
response_attrs:
|
|
1033
|
+
- :type: MonthlyProfitAndLoss
|
|
1034
|
+
:desc: An array of type ProfitAndLoss
|
|
1035
|
+
:name:
|
|
1036
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
1037
|
+
name: GetNominalLedger
|
|
1038
|
+
request_attrs:
|
|
1039
|
+
- :type: DateTime
|
|
1040
|
+
:desc: The start date for the report
|
|
1041
|
+
:name: StartDate
|
|
1042
|
+
- :type: DateTime
|
|
1043
|
+
:desc: The end date for the report
|
|
1044
|
+
:name: EndDate
|
|
1045
|
+
- :type: Integer
|
|
1046
|
+
:desc: The nominal id for the report
|
|
1047
|
+
:name: NominalID
|
|
1048
|
+
response_attrs:
|
|
1049
|
+
- :type: TransactionInformation
|
|
1050
|
+
:desc: An array of type TransactionInformation
|
|
1051
|
+
:name:
|
|
1052
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
1053
|
+
name: GetProfitAndLoss
|
|
1054
|
+
request_attrs:
|
|
1055
|
+
- :type: DateTime
|
|
1056
|
+
:desc: The start date for the report
|
|
1057
|
+
:name: StartDate
|
|
1058
|
+
- :type: DateTime
|
|
1059
|
+
:desc: The end date for the report
|
|
1060
|
+
:name: EndDate
|
|
1061
|
+
response_attrs:
|
|
1062
|
+
- :type: ProfitAndLoss
|
|
1063
|
+
:desc: An object of type ProfitAndLoss
|
|
1064
|
+
:name:
|
|
1065
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
1066
|
+
name: GetTrialBalance
|
|
1067
|
+
request_attrs:
|
|
1068
|
+
- :type: DateTime
|
|
1069
|
+
:desc: The start date for the report
|
|
1070
|
+
:name: StartDate
|
|
1071
|
+
- :type: DateTime
|
|
1072
|
+
:desc: The end date for the report
|
|
1073
|
+
:name: EndDate
|
|
1074
|
+
response_attrs:
|
|
1075
|
+
- :type: NominalCode
|
|
1076
|
+
:desc: An array of type NominalCode
|
|
1077
|
+
:name:
|
|
1078
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
1079
|
+
name: GetVATReport
|
|
1080
|
+
request_attrs:
|
|
1081
|
+
- :type: DateTime
|
|
1082
|
+
:desc: The start date for the report
|
|
1083
|
+
:name: StartDate
|
|
1084
|
+
- :type: DateTime
|
|
1085
|
+
:desc: The end date for the report
|
|
1086
|
+
:name: EndDate
|
|
1087
|
+
response_attrs:
|
|
1088
|
+
- :type: VATReport
|
|
1089
|
+
:desc: An object of type VATReport
|
|
1090
|
+
:name:
|
|
1091
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
1092
|
+
name: AddOrUpdateSubProduct
|
|
1093
|
+
request_attrs:
|
|
1094
|
+
- :type: SubProduct
|
|
1095
|
+
:desc: |-
|
|
1096
|
+
A SubProduct populated with the relevant fields.
|
|
1097
|
+
If the id is set to 0, a new SubProduct will be created. If it is non-zero then the selected SubProduct will be updated.
|
|
1098
|
+
:name: sp
|
|
1099
|
+
response_attrs:
|
|
1100
|
+
- :type: Integer
|
|
1101
|
+
:desc: An integer giving the unique ID number of the updated or newly created SubProduct
|
|
1102
|
+
:name:
|
|
1103
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
1104
|
+
name: AutoAuthIP
|
|
1105
|
+
request_attrs:
|
|
1106
|
+
- :type: String
|
|
1107
|
+
:desc: The name of your application. This is used in the comment for the IP listing so the user knows which application added the IP address
|
|
1108
|
+
:name: appName
|
|
1109
|
+
- :type: String
|
|
1110
|
+
:desc: "This is the AutoAuthKey mentioned above. It should be provided to you by the user. The AutoAuthKey is a hex string in the format: 1234ABCD-1234"
|
|
1111
|
+
:name: AutoAuthKey
|
|
1112
|
+
response_attrs: []
|
|
1113
|
+
|
|
1114
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
1115
|
+
name: createAccount
|
|
1116
|
+
request_attrs:
|
|
1117
|
+
- :type: String
|
|
1118
|
+
:desc: See above
|
|
1119
|
+
:name: AccountCreationKey
|
|
1120
|
+
- :type: String
|
|
1121
|
+
:desc: The desired username
|
|
1122
|
+
:name: Username
|
|
1123
|
+
- :type: String
|
|
1124
|
+
:desc: The password for the new account. Must be at least 5 characters
|
|
1125
|
+
:name: password
|
|
1126
|
+
- :type: String
|
|
1127
|
+
:desc: The memorable word for the new account. Must be at least 5 characters
|
|
1128
|
+
:name: memorableword
|
|
1129
|
+
- :type: String
|
|
1130
|
+
:desc: The users email address
|
|
1131
|
+
:name: "EmailAddress "
|
|
1132
|
+
- :type: String
|
|
1133
|
+
:desc: The users company name
|
|
1134
|
+
:name: CompanyName
|
|
1135
|
+
- :type: String
|
|
1136
|
+
:desc: An address for the user
|
|
1137
|
+
:name: Addr1
|
|
1138
|
+
- :type: String
|
|
1139
|
+
:desc: !binary |
|
|
1140
|
+
wqA=
|
|
1141
|
+
|
|
1142
|
+
:name: Addr2
|
|
1143
|
+
- :type: String
|
|
1144
|
+
:desc: !binary |
|
|
1145
|
+
wqA=
|
|
1146
|
+
|
|
1147
|
+
:name: Addr3
|
|
1148
|
+
- :type: String
|
|
1149
|
+
:desc: !binary |
|
|
1150
|
+
wqA=
|
|
1151
|
+
|
|
1152
|
+
:name: Addr4
|
|
1153
|
+
- :type: String
|
|
1154
|
+
:desc: The users postcode
|
|
1155
|
+
:name: Postcode
|
|
1156
|
+
- :type: String
|
|
1157
|
+
:desc: A contact name for the user. usually their full name.
|
|
1158
|
+
:name: ContactName
|
|
1159
|
+
- :type: String
|
|
1160
|
+
:desc: The users telephone number
|
|
1161
|
+
:name: Telephone
|
|
1162
|
+
- :type: Integer
|
|
1163
|
+
:desc: Set this to 1 is the user is VAT registered
|
|
1164
|
+
:name: VATRegistered
|
|
1165
|
+
- :type: String
|
|
1166
|
+
:desc: The users VAT number
|
|
1167
|
+
:name: VATNumber
|
|
1168
|
+
- :type: Integer
|
|
1169
|
+
:desc: Set this to 1 if you want the user to have the date in US format and default to $ for the currency
|
|
1170
|
+
:name: USSettings
|
|
1171
|
+
- :type: String
|
|
1172
|
+
:desc: If you've joined our affiliate scheme, you can provide your promotional code here
|
|
1173
|
+
:name: promocode
|
|
1174
|
+
response_attrs:
|
|
1175
|
+
- :type: Integer
|
|
1176
|
+
:desc: If the account was successfully created you'll receive a user id number
|
|
1177
|
+
:name:
|
|
1178
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
1179
|
+
name: GetAccountOverview
|
|
1180
|
+
request_attrs: []
|
|
1181
|
+
|
|
1182
|
+
response_attrs:
|
|
1183
|
+
- :type: AccountOverview
|
|
1184
|
+
:desc: An object of type AccountOverview
|
|
1185
|
+
:name:
|
|
1186
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
1187
|
+
name: GetBankOverview
|
|
1188
|
+
request_attrs: []
|
|
1189
|
+
|
|
1190
|
+
response_attrs:
|
|
1191
|
+
- :type: BankOverview
|
|
1192
|
+
:desc: An array of objects of type BankOverview
|
|
1193
|
+
:name:
|
|
1194
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
1195
|
+
name: GetCurrencies
|
|
1196
|
+
request_attrs: []
|
|
1197
|
+
|
|
1198
|
+
response_attrs:
|
|
1199
|
+
- :type: Currencies
|
|
1200
|
+
:desc: An array of objects of type Currencies
|
|
1201
|
+
:name:
|
|
1202
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
1203
|
+
name: GetRemoteLoginURL
|
|
1204
|
+
request_attrs: []
|
|
1205
|
+
|
|
1206
|
+
response_attrs: []
|
|
1207
|
+
|
|
1208
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
1209
|
+
name: GetProducts
|
|
1210
|
+
request_attrs: []
|
|
1211
|
+
|
|
1212
|
+
response_attrs:
|
|
1213
|
+
- :type: Product
|
|
1214
|
+
:desc: An array of objects of type Product
|
|
1215
|
+
:name:
|
|
1216
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
1217
|
+
name: GetProjects
|
|
1218
|
+
request_attrs: []
|
|
1219
|
+
|
|
1220
|
+
response_attrs:
|
|
1221
|
+
- :type: BasicDataSet
|
|
1222
|
+
:desc: |-
|
|
1223
|
+
An array of objects of type BasicDataSet.
|
|
1224
|
+
The 'ID' member contains the project ID, the 'Name' member contains the project name and the 'Description' member contains the project number.
|
|
1225
|
+
:name:
|
|
1226
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
1227
|
+
name: GetNominalCodes
|
|
1228
|
+
request_attrs: []
|
|
1229
|
+
|
|
1230
|
+
response_attrs:
|
|
1231
|
+
- :type: NominalCodes
|
|
1232
|
+
:desc: An array of objects of type NominalCode
|
|
1233
|
+
:name:
|
|
1234
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
1235
|
+
name: GetNominalCodesExtended
|
|
1236
|
+
request_attrs: []
|
|
1237
|
+
|
|
1238
|
+
response_attrs:
|
|
1239
|
+
- :type: NominalCodeExtended
|
|
1240
|
+
:desc: An array of objects of type NominalCodeExtended
|
|
1241
|
+
:name:
|
|
1242
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
1243
|
+
name: GetSubProducts
|
|
1244
|
+
request_attrs:
|
|
1245
|
+
- :type: Integer
|
|
1246
|
+
:desc: The ID of the NominalCode for which you want to retrieve SubProducts.
|
|
1247
|
+
:name: NominalID
|
|
1248
|
+
response_attrs:
|
|
1249
|
+
- :type: SubProducts
|
|
1250
|
+
:desc: An array of type SubProducts
|
|
1251
|
+
:name:
|
|
1252
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
1253
|
+
name: GetVATRates
|
|
1254
|
+
request_attrs: []
|
|
1255
|
+
|
|
1256
|
+
response_attrs:
|
|
1257
|
+
- :type: BasicDataset
|
|
1258
|
+
:desc: |-
|
|
1259
|
+
An array of objects of type BasicDataset.
|
|
1260
|
+
The ID field contains the id of the Rate. this is unlikley to be of any use to you.
|
|
1261
|
+
Name and Description contain the Rate as it should be presented to a user, ie "17.5%"
|
|
1262
|
+
Value contains the actual rate as a decimal. ie: 17.5
|
|
1263
|
+
:name:
|
|
1264
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
1265
|
+
name: InsertNominalCode
|
|
1266
|
+
request_attrs:
|
|
1267
|
+
- :type: String
|
|
1268
|
+
:desc: The name for the new nominal code
|
|
1269
|
+
:name: name
|
|
1270
|
+
- :type: Integer
|
|
1271
|
+
:desc: The code number for the new nominal code. This must be unique for the user account
|
|
1272
|
+
:name: code
|
|
1273
|
+
- :type: Integer
|
|
1274
|
+
:desc: |-
|
|
1275
|
+
Define what type of code this is. Valid properties are:
|
|
1276
|
+
1 - Turnover
|
|
1277
|
+
2 - Cost of Sale
|
|
1278
|
+
3 - Expense
|
|
1279
|
+
4 - Fixed Asset
|
|
1280
|
+
5 - Current Asset/Liability
|
|
1281
|
+
6 - Capital and Reserves
|
|
1282
|
+
:name: classification
|
|
1283
|
+
- :type: Integer
|
|
1284
|
+
:desc: |-
|
|
1285
|
+
Choose where in the system this code should be listed. Valid properties are:
|
|
1286
|
+
1 - Sales Type
|
|
1287
|
+
2 - Outgoing Type
|
|
1288
|
+
3 - Bank Transaction Type
|
|
1289
|
+
:name: nomtype
|
|
1290
|
+
response_attrs:
|
|
1291
|
+
- :type: Integer
|
|
1292
|
+
:desc: An integer giving the unique ID number of the newly created nominal code
|
|
1293
|
+
:name:
|
|
1294
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
1295
|
+
name: isUserVATRegistered
|
|
1296
|
+
request_attrs: []
|
|
1297
|
+
|
|
1298
|
+
response_attrs: []
|
|
1299
|
+
|
|
1300
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
1301
|
+
name: SetCustomerCurrency
|
|
1302
|
+
request_attrs:
|
|
1303
|
+
- :type: String
|
|
1304
|
+
:desc: |-
|
|
1305
|
+
The ISO code of a currency.
|
|
1306
|
+
|
|
1307
|
+
E.g. USD, GBP
|
|
1308
|
+
:name: CurrencyCode
|
|
1309
|
+
- :type: String
|
|
1310
|
+
:desc: The unique customer code.
|
|
1311
|
+
:name: CustomerCode
|
|
1312
|
+
response_attrs: []
|
|
1313
|
+
|
|
1314
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
1315
|
+
name: SetSupplierCurrency
|
|
1316
|
+
request_attrs:
|
|
1317
|
+
- :type: String
|
|
1318
|
+
:desc: |-
|
|
1319
|
+
The ISO code of a currency.
|
|
1320
|
+
|
|
1321
|
+
E.g. USD, GBP
|
|
1322
|
+
:name: CurrencyCode
|
|
1323
|
+
- :type: String
|
|
1324
|
+
:desc: The unique supplier code.
|
|
1325
|
+
:name: SupplierCode
|
|
1326
|
+
response_attrs: []
|
|
1327
|
+
|
|
1328
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
1329
|
+
name: SetCustomerVATNumber
|
|
1330
|
+
request_attrs:
|
|
1331
|
+
- :type: String
|
|
1332
|
+
:desc: A VAT Number.
|
|
1333
|
+
:name: CustVATNumber
|
|
1334
|
+
- :type: String
|
|
1335
|
+
:desc: The unique customer code.
|
|
1336
|
+
:name: CustomerCode
|
|
1337
|
+
response_attrs: []
|
|
1338
|
+
|
|
1339
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
1340
|
+
name: SetSupplierVATNumber
|
|
1341
|
+
request_attrs:
|
|
1342
|
+
- :type: String
|
|
1343
|
+
:desc: A VAT Number.
|
|
1344
|
+
:name: SupVATNumber
|
|
1345
|
+
- :type: String
|
|
1346
|
+
:desc: The unique supplier code.
|
|
1347
|
+
:name: SupplierCode
|
|
1348
|
+
response_attrs: []
|
|
1349
|
+
|
|
1350
|
+
- !ruby/object:Kashflow::ApiMethod
|
|
1351
|
+
name: VCFToCustomerObjects
|
|
1352
|
+
request_attrs:
|
|
1353
|
+
- :type: base64Binary
|
|
1354
|
+
:desc: A Base 64 binary array representing the .vcf file.
|
|
1355
|
+
:name: inStream
|
|
1356
|
+
response_attrs:
|
|
1357
|
+
- :type: Customer
|
|
1358
|
+
:desc: An array of objects of type Customer
|
|
1359
|
+
:name:
|