Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
Total | n/a |
0 / 0 |
n/a |
0 / 0 |
CRAP | n/a |
0 / 0 |
1 | <?php |
2 | |
3 | /** |
4 | * @apiDefine SuccessGet Response-Content |
5 | * |
6 | * @apiParam (GET) {String} page Page number of result. |
7 | * |
8 | * @apiSuccess (Response-Content) {String} current_page page called. |
9 | * @apiSuccess (Response-Content) {Array} data Array of asked data. |
10 | * @apiSuccess (Response-Content) {String} first_page_url first page url. |
11 | * @apiSuccess (Response-Content) {String} next_page_url next page url. |
12 | * @apiSuccess (Response-Content) {String} path Base url. |
13 | * @apiSuccess (Response-Content) {String} prev_page_url previous page url. |
14 | * @apiSuccess (Response-Content) {Integer} from first entry index. |
15 | * @apiSuccess (Response-Content) {Integer} per_page nb of entries by page. |
16 | * @apiSuccess (Response-Content) {Integer} to last entry index. |
17 | * |
18 | * |
19 | * |
20 | * @apiSuccessExample Response-Content (example): |
21 | * HTTP/1.1 200 OK |
22 | * { |
23 | * "current_page": "http://xxxx/xxx?page=2", |
24 | * "data": [...], |
25 | * "first_page_url": "http://xxxx/xxx?page=1", |
26 | * "next_page_url": "http://xxxx/xxx?page=3", |
27 | * "path": "http://xxxx/xxx", |
28 | * "prev_page_url": "http://xxxx/xxx?page=1", |
29 | * "from": 16, |
30 | * "per_page": 15, |
31 | * "to": 30 |
32 | * } |
33 | */ |
34 | |
35 | /** |
36 | * @apiDefine EntityError Error 422 |
37 | * |
38 | * @apiError (Error 422) {json} Unprocessable Entity Something wrong with parameters. |
39 | * |
40 | * @apiErrorExample {json} 422: |
41 | * HTTP/1.1 422 Unprocessable Entity |
42 | * { |
43 | * "error": "error description" |
44 | * } |
45 | */ |
46 | |
47 | /** |
48 | * @apiDefine UserId Request-Header |
49 | * |
50 | * @apiHeader (UserId) {Integer} X-Qwamplify-user-id User-id. |
51 | * |
52 | * @apiHeaderExample {json} Header (Example) : |
53 | * { |
54 | * "X-Qwamplify-user-id" : 1 |
55 | * } |
56 | */ |
57 | |
58 | |
59 | |
60 | /******************** ACCOUNT LINES *********************/ |
61 | |
62 | /** |
63 | * @api {get} http://service_compta/api/account-lines 1.1 Get All accounts lines |
64 | * @apiVersion 1.0.0 |
65 | * @apiName GetAllAccountLines |
66 | * @apiGroup 1.AccountLines |
67 | * @apiDescription Get all account lines. |
68 | * @apiPermission compta_manage |
69 | * |
70 | * @apiUse UserId |
71 | * |
72 | * @apiUse SuccessGet |
73 | * |
74 | * @apiUse EntityError |
75 | */ |
76 | |
77 | /** |
78 | * @api {get} http://service_compta/api/account-lines/company/{companyId}/{sincedate?}/{lastDate?} 1.2 Get All accounts lines in terms of company and date |
79 | * @apiVersion 1.0.0 |
80 | * @apiName GetAllAccountLinesCompanyDate |
81 | * @apiGroup 1.AccountLines |
82 | * @apiDescription Get all accounts lines in terms of company and date. |
83 | * @apiPermission compta_view |
84 | * |
85 | * @apiUse UserId |
86 | * |
87 | * @apiUse SuccessGet |
88 | * |
89 | * @apiUse EntityError |
90 | */ |
91 | |
92 | /** |
93 | * @api {get} http://service_compta/api/account-lines/company/{companyId}/chart/{chartId}/{sincedate?}/{lastDate?} 1.3 Get All accounts lines in terms of company, chart and date |
94 | * @apiVersion 1.0.0 |
95 | * @apiName GetAllAccountLinesCompanyChartDate |
96 | * @apiGroup 1.AccountLines |
97 | * @apiDescription Get all accounts lines in terms of company, chart account and date. |
98 | * @apiPermission compta_view |
99 | * |
100 | * @apiUse UserId |
101 | * |
102 | * @apiUse SuccessGet |
103 | * |
104 | * @apiUse EntityError |
105 | */ |
106 | |
107 | /** |
108 | * @api {get} http://service_compta/api/account-lines/{id} 1.4 Get One account line |
109 | * @apiVersion 1.0.0 |
110 | * @apiName GetOneAccountLines |
111 | * @apiGroup 1.AccountLines |
112 | * @apiDescription Get one account line. |
113 | * @apiPermission compta_view |
114 | * |
115 | * @apiUse UserId |
116 | * |
117 | * @apiParam (URL) {String} id id of account line. |
118 | * |
119 | * |
120 | * @apiSuccessExample Response-Data (example): |
121 | * HTTP/1.1 200 Ok |
122 | * { |
123 | * "id": "xxx", |
124 | * "company_id": "xxx", |
125 | * "chart_account_id": "xxx", |
126 | * "operation_id": "xxx", |
127 | * "date_at": "xxx", |
128 | * "title": "xxx", |
129 | * "debit": "xxx", |
130 | * "credit": "xxx", |
131 | * "pointed": "xxx", |
132 | * "created_at": "xxx", |
133 | * "updated_at": "xxx" |
134 | * } |
135 | * |
136 | * @apiUse EntityError |
137 | */ |
138 | |
139 | |
140 | /** |
141 | * @api {post} http://service_compta/api/account-lines 1.5 Create One account line |
142 | * @apiVersion 1.0.0 |
143 | * @apiName CreateOneAccountLines |
144 | * @apiGroup 1.AccountLines |
145 | * @apiDescription Create one account line. |
146 | * @apiPermission compta_view && compta_edit |
147 | * |
148 | * @apiUse UserId |
149 | * |
150 | * @apiParam (POST) {String} chart_account_id chart account id |
151 | * @apiParam (POST) {String} company_id company id |
152 | * @apiParam (POST) {String} operation_id operation id |
153 | * @apiParam (POST) {String} date_at date of account |
154 | * @apiParam (POST) {String} title account line description |
155 | * @apiParam (POST) {String} debit amount in debit |
156 | * @apiParam (POST) {String} credit amount in credit |
157 | * @apiParam (POST) {String} pointed pointed bank value |
158 | * |
159 | * |
160 | * @apiSuccessExample Response-Data (example): |
161 | * HTTP/1.1 200 Ok |
162 | * { |
163 | * "status": "ok" |
164 | * } |
165 | * |
166 | * @apiUse EntityError |
167 | */ |
168 | |
169 | /** |
170 | * @api {put} http://service_compta/api/account-lines/{id} 1.6 Update One account line |
171 | * @apiVersion 1.0.0 |
172 | * @apiName UpdateOneAccountLines |
173 | * @apiGroup 1.AccountLines |
174 | * @apiDescription Update one account line. |
175 | * @apiPermission compta_view && compta_edit |
176 | * |
177 | * @apiUse UserId |
178 | * |
179 | * @apiParam (URL) {String} id id of account line. |
180 | * |
181 | * @apiParam (POST) {String} chart_account_id chart account id |
182 | * @apiParam (POST) {String} company_id company id |
183 | * @apiParam (POST) {String} operation_id operation id |
184 | * @apiParam (POST) {String} date_at date of account |
185 | * @apiParam (POST) {String} title account line description |
186 | * @apiParam (POST) {String} debit amount in debit |
187 | * @apiParam (POST) {String} credit amount in credit |
188 | * @apiParam (POST) {String} pointed pointed bank value |
189 | * |
190 | * |
191 | * @apiSuccessExample Response-Data (example): |
192 | * HTTP/1.1 200 Ok |
193 | * { |
194 | * "status": "ok" |
195 | * } |
196 | * |
197 | * @apiUse EntityError |
198 | */ |
199 | |
200 | /** |
201 | * @api {delete} http://service_compta/api/account-lines/{id} 1.7 Remove One account line |
202 | * @apiVersion 1.0.0 |
203 | * @apiName RemoveOneAccountLines |
204 | * @apiGroup 1.AccountLines |
205 | * @apiDescription Remove one account line. |
206 | * @apiPermission compta_view && compta_edit |
207 | * |
208 | * @apiUse UserId |
209 | * |
210 | * @apiParam (URL) {String} id id of account line. |
211 | * |
212 | * @apiSuccessExample Response-Data (example): |
213 | * HTTP/1.1 200 Ok |
214 | * { |
215 | * "status": "ok" |
216 | * } |
217 | * |
218 | * @apiUse EntityError |
219 | */ |
220 | |
221 | |
222 | |
223 | |
224 | /******************** BANK STATEMENT *********************/ |
225 | |
226 | /** |
227 | * @api {get} http://service_compta/api/bank-stmts 2.1 Get All bank statements |
228 | * @apiVersion 1.0.0 |
229 | * @apiName GetAllBankStmts |
230 | * @apiGroup 2.BankStmts |
231 | * @apiDescription Get all bank statements. |
232 | * @apiPermission compta_manage |
233 | * |
234 | * @apiUse UserId |
235 | * |
236 | * @apiUse SuccessGet |
237 | * |
238 | * @apiUse EntityError |
239 | */ |
240 | |
241 | /** |
242 | * @api {get} http://service_compta/api/bank-stmts/company/{companyId}/{sincedate?}/{lastDate?} 2.2 Get All bank statements in terms of company and date |
243 | * @apiVersion 1.0.0 |
244 | * @apiName GetAllBankStmtsCompanyDate |
245 | * @apiGroup 2.BankStmts |
246 | * @apiDescription Get all bank statements in terms of company and date. |
247 | * @apiPermission compta_view |
248 | * |
249 | * @apiUse UserId |
250 | * |
251 | * @apiUse SuccessGet |
252 | * |
253 | * @apiUse EntityError |
254 | */ |
255 | |
256 | /** |
257 | * @api {get} http://service_compta/api/bank-stmts/{id} 2.3 Get One bank statement |
258 | * @apiVersion 1.0.0 |
259 | * @apiName GetOneBankStmts |
260 | * @apiGroup 2.BankStmts |
261 | * @apiDescription Get one bank statement. |
262 | * @apiPermission compta_view |
263 | * |
264 | * @apiUse UserId |
265 | * |
266 | * @apiParam (URL) {String} id id of bank statement. |
267 | * |
268 | * |
269 | * @apiSuccessExample Response-Data (example): |
270 | * HTTP/1.1 200 Ok |
271 | * { |
272 | * "id": "xxx", |
273 | * "company_id": "xxx", |
274 | * "date_at": "xxx", |
275 | * "title": "xxx", |
276 | * "debit": "xxx", |
277 | * "credit": "xxx", |
278 | * "pointed": "xxx", |
279 | * "created_at": "xxx", |
280 | * "updated_at": "xxx" |
281 | * } |
282 | * |
283 | * @apiUse EntityError |
284 | */ |
285 | |
286 | |
287 | /** |
288 | * @api {post} http://service_compta/api/bank-stmts 2.4 Create One bank statement |
289 | * @apiVersion 1.0.0 |
290 | * @apiName CreateOneBankStmts |
291 | * @apiGroup 2.BankStmts |
292 | * @apiDescription Create one bank statement. |
293 | * @apiPermission compta_view && compta_edit |
294 | * |
295 | * @apiUse UserId |
296 | * |
297 | * @apiParam (POST) {String} company_id company id |
298 | * @apiParam (POST) {String} date_at date of account |
299 | * @apiParam (POST) {String} title account line description |
300 | * @apiParam (POST) {String} debit amount in debit |
301 | * @apiParam (POST) {String} credit amount in credit |
302 | * @apiParam (POST) {String} pointed pointed bank value |
303 | * |
304 | * |
305 | * @apiSuccessExample Response-Data (example): |
306 | * HTTP/1.1 200 Ok |
307 | * { |
308 | * "status": "ok" |
309 | * } |
310 | * |
311 | * @apiUse EntityError |
312 | */ |
313 | |
314 | /** |
315 | * @api {put} http://service_compta/api/bank-stmts/{id} 2.5 Update One bank statement |
316 | * @apiVersion 1.0.0 |
317 | * @apiName UpdateOneBankStmts |
318 | * @apiGroup 2.BankStmts |
319 | * @apiDescription Update one bank statement. |
320 | * @apiPermission compta_view && compta_edit |
321 | * |
322 | * @apiUse UserId |
323 | * |
324 | * @apiParam (URL) {String} id id of bank statement. |
325 | * |
326 | * @apiParam (POST) {String} company_id company id |
327 | * @apiParam (POST) {String} date_at date of account |
328 | * @apiParam (POST) {String} title account line description |
329 | * @apiParam (POST) {String} debit amount in debit |
330 | * @apiParam (POST) {String} credit amount in credit |
331 | * @apiParam (POST) {String} pointed pointed bank value |
332 | * |
333 | * |
334 | * @apiSuccessExample Response-Data (example): |
335 | * HTTP/1.1 200 Ok |
336 | * { |
337 | * "status": "ok" |
338 | * } |
339 | * |
340 | * @apiUse EntityError |
341 | */ |
342 | |
343 | /** |
344 | * @api {delete} http://service_compta/api/bank-stmts/{id} 2.6 Remove One bank statement |
345 | * @apiVersion 1.0.0 |
346 | * @apiName RemoveOneBankStmts |
347 | * @apiGroup 2.BankStmts |
348 | * @apiDescription Remove one bank statement. |
349 | * @apiPermission compta_view && compta_edit |
350 | * |
351 | * @apiUse UserId |
352 | * |
353 | * @apiParam (URL) {String} id id of account line. |
354 | * |
355 | * @apiSuccessExample Response-Data (example): |
356 | * HTTP/1.1 200 Ok |
357 | * { |
358 | * "status": "ok" |
359 | * } |
360 | * |
361 | * @apiUse EntityError |
362 | */ |
363 | |
364 | |
365 | |
366 | /******************** CHART ACCOUNT *********************/ |
367 | |
368 | /** |
369 | * @api {get} http://service_compta/api/chart-accounts 3.1 Get All chart accounts |
370 | * @apiVersion 1.0.0 |
371 | * @apiName GetAllChartAccounts |
372 | * @apiGroup 3.ChartAccounts |
373 | * @apiDescription Get all chart accounts. |
374 | * @apiPermission compta_view |
375 | * |
376 | * @apiUse UserId |
377 | * |
378 | * @apiUse SuccessGet |
379 | * |
380 | * @apiUse EntityError |
381 | */ |
382 | |
383 | /** |
384 | * @api {get} http://service_compta/api/chart-accounts/{id} 3.2 Get One chart account |
385 | * @apiVersion 1.0.0 |
386 | * @apiName GetOneChartAccounts |
387 | * @apiGroup 3.ChartAccounts |
388 | * @apiDescription Get one chart account. |
389 | * @apiPermission compta_view |
390 | * |
391 | * @apiUse UserId |
392 | * |
393 | * @apiParam (URL) {String} id id of bank statement. |
394 | * |
395 | * |
396 | * @apiSuccessExample Response-Data (example): |
397 | * HTTP/1.1 200 Ok |
398 | * { |
399 | * "id": "xxx", |
400 | * "group": "xxx", |
401 | * "code": "xxx", |
402 | * "name": "xxx", |
403 | * "created_at": "xxx", |
404 | * "updated_at": "xxx" |
405 | * } |
406 | * |
407 | * @apiUse EntityError |
408 | */ |
409 | |
410 | |
411 | /** |
412 | * @api {post} http://service_compta/api/chart-accounts 3.3 Create One chart account |
413 | * @apiVersion 1.0.0 |
414 | * @apiName CreateOneChartAccounts |
415 | * @apiGroup 3.ChartAccounts |
416 | * @apiDescription Create one chart account. |
417 | * @apiPermission compta_manage |
418 | * |
419 | * @apiUse UserId |
420 | * |
421 | * @apiParam (POST) {String} group group of chart account (ex: 7) |
422 | * @apiParam (POST) {String} code chart account code (ex: 644) |
423 | * @apiParam (POST) {String} name Chart account description |
424 | * |
425 | * |
426 | * @apiSuccessExample Response-Data (example): |
427 | * HTTP/1.1 200 Ok |
428 | * { |
429 | * "status": "ok" |
430 | * } |
431 | * |
432 | * @apiUse EntityError |
433 | */ |
434 | |
435 | /** |
436 | * @api {put} http://service_compta/api/chart-accounts/{id} 3.4 Update One chart account |
437 | * @apiVersion 1.0.0 |
438 | * @apiName UpdateOneChartAccounts |
439 | * @apiGroup 3.ChartAccounts |
440 | * @apiDescription Update one chart account. |
441 | * @apiPermission compta_manage |
442 | * |
443 | * @apiUse UserId |
444 | * |
445 | * @apiParam (URL) {String} id id of bank statement. |
446 | * |
447 | * @apiParam (POST) {String} group group of chart account (ex: 7) |
448 | * @apiParam (POST) {String} code chart account code (ex: 644) |
449 | * @apiParam (POST) {String} name Chart account description |
450 | * |
451 | * |
452 | * @apiSuccessExample Response-Data (example): |
453 | * HTTP/1.1 200 Ok |
454 | * { |
455 | * "status": "ok" |
456 | * } |
457 | * |
458 | * @apiUse EntityError |
459 | */ |
460 | |
461 | /** |
462 | * @api {delete} http://service_compta/api/chart-accounts/{id} 3.5 Remove One chart account |
463 | * @apiVersion 1.0.0 |
464 | * @apiName RemoveOneChartAccounts |
465 | * @apiGroup 3.ChartAccounts |
466 | * @apiDescription Remove one chart account. |
467 | * @apiPermission compta_manage |
468 | * |
469 | * @apiUse UserId |
470 | * |
471 | * @apiParam (URL) {String} id id of account line. |
472 | * |
473 | * @apiSuccessExample Response-Data (example): |
474 | * HTTP/1.1 200 Ok |
475 | * { |
476 | * "status": "ok" |
477 | * } |
478 | * |
479 | * @apiUse EntityError |
480 | */ |
481 | |
482 | |
483 | |
484 | /******************** COMPANY *********************/ |
485 | |
486 | /** |
487 | * @api {get} http://service_compta/api/companies 4.1 Get All companies |
488 | * @apiVersion 1.0.0 |
489 | * @apiName GetAllCompanies |
490 | * @apiGroup 4.Companies |
491 | * @apiDescription Get all companies for connected user |
492 | * @apiPermission compta_view |
493 | * |
494 | * @apiUse UserId |
495 | * |
496 | * @apiUse SuccessGet |
497 | * |
498 | * @apiUse EntityError |
499 | */ |
500 | |
501 | /** |
502 | * @api {get} http://service_compta/api/companies/{id} 4.2 Get One company |
503 | * @apiVersion 1.0.0 |
504 | * @apiName GetOneCompanies |
505 | * @apiGroup 4.Companies |
506 | * @apiDescription Get one company. |
507 | * @apiPermission compta_view |
508 | * |
509 | * @apiUse UserId |
510 | * |
511 | * @apiParam (URL) {String} id id of bank statement. |
512 | * |
513 | * |
514 | * @apiSuccessExample Response-Data (example): |
515 | * HTTP/1.1 200 Ok |
516 | * { |
517 | * "id": "xxx", |
518 | * "name": "xxx", |
519 | * "fiscal_year_date_at": "xxx", |
520 | * "created_at": "xxx", |
521 | * "updated_at": "xxx" |
522 | * } |
523 | * |
524 | * @apiUse EntityError |
525 | */ |
526 | |
527 | |
528 | /** |
529 | * @api {post} http://service_compta/api/companies 4.3 Create One company |
530 | * @apiVersion 1.0.0 |
531 | * @apiName CreateOneCompanies |
532 | * @apiGroup 4.Companies |
533 | * @apiDescription Create one company. |
534 | * @apiPermission compta_manage |
535 | * |
536 | * @apiUse UserId |
537 | * |
538 | * @apiParam (POST) {String} name Description of company |
539 | * @apiParam (POST) {String} fiscal_year_date_at Fiscal date for begin comptability year |
540 | * |
541 | * |
542 | * @apiSuccessExample Response-Data (example): |
543 | * HTTP/1.1 200 Ok |
544 | * { |
545 | * "status": "ok" |
546 | * } |
547 | * |
548 | * @apiUse EntityError |
549 | */ |
550 | |
551 | /** |
552 | * @api {put} http://service_compta/api/companies/{id} 4.4 Update One company |
553 | * @apiVersion 1.0.0 |
554 | * @apiName UpdateOneCompanies |
555 | * @apiGroup 4.Companies |
556 | * @apiDescription Update one company. |
557 | * @apiPermission compta_manage |
558 | * |
559 | * @apiUse UserId |
560 | * |
561 | * @apiParam (URL) {String} id id of bank statement. |
562 | * |
563 | * @apiParam (POST) {String} name Description of company |
564 | * @apiParam (POST) {String} fiscal_year_date_at Fiscal date for begin comptability year |
565 | * |
566 | * |
567 | * @apiSuccessExample Response-Data (example): |
568 | * HTTP/1.1 200 Ok |
569 | * { |
570 | * "status": "ok" |
571 | * } |
572 | * |
573 | * @apiUse EntityError |
574 | */ |
575 | |
576 | /** |
577 | * @api {delete} http://service_compta/api/companies/{id} 4.5 Remove One company |
578 | * @apiVersion 1.0.0 |
579 | * @apiName RemoveOneCompanies |
580 | * @apiGroup 4.Companies |
581 | * @apiDescription Remove one company. |
582 | * @apiPermission compta_manage |
583 | * |
584 | * @apiUse UserId |
585 | * |
586 | * @apiParam (URL) {String} id id of account line. |
587 | * |
588 | * @apiSuccessExample Response-Data (example): |
589 | * HTTP/1.1 200 Ok |
590 | * { |
591 | * "status": "ok" |
592 | * } |
593 | * |
594 | * @apiUse EntityError |
595 | */ |
596 | |
597 | |
598 | |
599 | /******************** JOURNAL *********************/ |
600 | |
601 | /** |
602 | * @api {get} http://service_compta/api/journals 5.1 Get All journals |
603 | * @apiVersion 1.0.0 |
604 | * @apiName GetAllJournals |
605 | * @apiGroup 5.Journals |
606 | * @apiDescription Get all journals |
607 | * @apiPermission compta_view |
608 | * |
609 | * @apiUse UserId |
610 | * |
611 | * @apiUse SuccessGet |
612 | * |
613 | * @apiUse EntityError |
614 | */ |
615 | |
616 | /** |
617 | * @api {get} http://service_compta/api/journals/{id} 5.2 Get One journals |
618 | * @apiVersion 1.0.0 |
619 | * @apiName GetOneCJournals |
620 | * @apiGroup 5.Journals |
621 | * @apiDescription Get one journal. |
622 | * @apiPermission compta_view |
623 | * |
624 | * @apiUse UserId |
625 | * |
626 | * @apiParam (URL) {String} id id of bank statement. |
627 | * |
628 | * |
629 | * @apiSuccessExample Response-Data (example): |
630 | * HTTP/1.1 200 Ok |
631 | * { |
632 | * "id": "xxx", |
633 | * "name": "xxx", |
634 | * "created_at": "xxx", |
635 | * "updated_at": "xxx" |
636 | * } |
637 | * |
638 | * @apiUse EntityError |
639 | */ |
640 | |
641 | |
642 | /** |
643 | * @api {post} http://service_compta/api/journals 5.3 Create One journal |
644 | * @apiVersion 1.0.0 |
645 | * @apiName CreateOneJournals |
646 | * @apiGroup 5.Journals |
647 | * @apiDescription Create one journal. |
648 | * @apiPermission compta_manage |
649 | * |
650 | * @apiUse UserId |
651 | * |
652 | * @apiParam (POST) {String} name Description of company |
653 | * |
654 | * |
655 | * @apiSuccessExample Response-Data (example): |
656 | * HTTP/1.1 200 Ok |
657 | * { |
658 | * "status": "ok" |
659 | * } |
660 | * |
661 | * @apiUse EntityError |
662 | */ |
663 | |
664 | /** |
665 | * @api {put} http://service_compta/api/journals/{id} 5.4 Update One journal |
666 | * @apiVersion 1.0.0 |
667 | * @apiName UpdateOneJournals |
668 | * @apiGroup 5.Journals |
669 | * @apiDescription Update one journal. |
670 | * @apiPermission compta_manage |
671 | * |
672 | * @apiUse UserId |
673 | * |
674 | * @apiParam (URL) {String} id id of bank statement. |
675 | * |
676 | * @apiParam (POST) {String} name Description of company |
677 | * |
678 | * |
679 | * @apiSuccessExample Response-Data (example): |
680 | * HTTP/1.1 200 Ok |
681 | * { |
682 | * "status": "ok" |
683 | * } |
684 | * |
685 | * @apiUse EntityError |
686 | */ |
687 | |
688 | /** |
689 | * @api {delete} http://service_compta/api/journals/{id} 4.5 Remove One journal |
690 | * @apiVersion 1.0.0 |
691 | * @apiName RemoveOneJournal |
692 | * @apiGroup 5.Journals |
693 | * @apiDescription Remove one journal. |
694 | * @apiPermission compta_manage |
695 | * |
696 | * @apiUse UserId |
697 | * |
698 | * @apiParam (URL) {String} id id of account line. |
699 | * |
700 | * @apiSuccessExample Response-Data (example): |
701 | * HTTP/1.1 200 Ok |
702 | * { |
703 | * "status": "ok" |
704 | * } |
705 | * |
706 | * @apiUse EntityError |
707 | */ |
708 | |
709 | |
710 | |
711 | |
712 | |
713 | /******************** OPERATIONS *********************/ |
714 | |
715 | /** |
716 | * @api {get} http://service_compta/api/operations 6.1 Get All operations |
717 | * @apiVersion 1.0.0 |
718 | * @apiName GetAllOperations |
719 | * @apiGroup 6.Operations |
720 | * @apiDescription Get all operations. |
721 | * @apiPermission compta_manage |
722 | * |
723 | * @apiUse UserId |
724 | * |
725 | * @apiUse SuccessGet |
726 | * |
727 | * @apiUse EntityError |
728 | */ |
729 | |
730 | /** |
731 | * @api {get} http://service_compta/api/operations/company/{companyId}/{sincedate?}/{lastDate?} 6.2 Get All operations in terms of company and date |
732 | * @apiVersion 1.0.0 |
733 | * @apiName GetAllOperationsCompanyDate |
734 | * @apiGroup 6.Operations |
735 | * @apiDescription Get all operations in terms of company and date. |
736 | * @apiPermission compta_view |
737 | * |
738 | * @apiUse UserId |
739 | * |
740 | * @apiUse SuccessGet |
741 | * |
742 | * @apiUse EntityError |
743 | */ |
744 | |
745 | /** |
746 | * @api {get} http://service_compta/api/operations/company/{companyId}/chart/{chartId}/{sincedate?}/{lastDate?} 6.3 Get All operations in terms of company, journal and date |
747 | * @apiVersion 1.0.0 |
748 | * @apiName GetAllOperationsCompanyJournalDate |
749 | * @apiGroup 6.Operations |
750 | * @apiDescription Get all operations in terms of company, journal and date. |
751 | * @apiPermission compta_view |
752 | * |
753 | * @apiUse UserId |
754 | * |
755 | * @apiUse SuccessGet |
756 | * |
757 | * @apiUse EntityError |
758 | */ |
759 | |
760 | /** |
761 | * @api {get} http://service_compta/api/operations/{id} 6.4 Get one operation |
762 | * @apiVersion 1.0.0 |
763 | * @apiName GetOneOperations |
764 | * @apiGroup 6.Operations |
765 | * @apiDescription Get one operation. |
766 | * @apiPermission compta_view |
767 | * |
768 | * @apiUse UserId |
769 | * |
770 | * @apiParam (URL) {String} id id of operation. |
771 | * |
772 | * |
773 | * @apiSuccessExample Response-Data (example): |
774 | * HTTP/1.1 200 Ok |
775 | * { |
776 | * "id": "xxx", |
777 | * "company_id": "xxx", |
778 | * "journal_id": "xxx", |
779 | * "date_at": "xxx", |
780 | * "voucher": "xxx", |
781 | * "created_at": "xxx", |
782 | * "updated_at": "xxx" |
783 | * } |
784 | * |
785 | * @apiUse EntityError |
786 | */ |
787 | |
788 | |
789 | /** |
790 | * @api {post} http://service_compta/api/operations 6.5 Create One operation |
791 | * @apiVersion 1.0.0 |
792 | * @apiName CreateOneOperations |
793 | * @apiGroup 6.Operations |
794 | * @apiDescription Create one operation. |
795 | * @apiPermission compta_view && compta_edit |
796 | * |
797 | * @apiUse UserId |
798 | * |
799 | * @apiParam (POST) {String} company_id company id |
800 | * @apiParam (POST) {String} journal_id journal id |
801 | * @apiParam (POST) {String} date_at date of operation |
802 | * @apiParam (POST) {String} voucher voucher of operation |
803 | * |
804 | * |
805 | * @apiSuccessExample Response-Data (example): |
806 | * HTTP/1.1 200 Ok |
807 | * { |
808 | * "status": "ok" |
809 | * } |
810 | * |
811 | * @apiUse EntityError |
812 | */ |
813 | |
814 | /** |
815 | * @api {put} http://service_compta/api/operations/{id} 6.6 Update One operation |
816 | * @apiVersion 1.0.0 |
817 | * @apiName UpdateOneOperations |
818 | * @apiGroup 6.Operations |
819 | * @apiDescription Update one operation. |
820 | * @apiPermission compta_view && compta_edit |
821 | * |
822 | * @apiUse UserId |
823 | * |
824 | * @apiParam (URL) {String} id id of operation. |
825 | * |
826 | * @apiParam (POST) {String} company_id company id |
827 | * @apiParam (POST) {String} journal_id journal id |
828 | * @apiParam (POST) {String} date_at date of operation |
829 | * @apiParam (POST) {String} voucher voucher of operation |
830 | * |
831 | * |
832 | * @apiSuccessExample Response-Data (example): |
833 | * HTTP/1.1 200 Ok |
834 | * { |
835 | * "status": "ok" |
836 | * } |
837 | * |
838 | * @apiUse EntityError |
839 | */ |
840 | |
841 | /** |
842 | * @api {delete} http://service_compta/api/operations/{id} 6.7 Remove One operation |
843 | * @apiVersion 1.0.0 |
844 | * @apiName RemoveOneOperation |
845 | * @apiGroup 6.Operations |
846 | * @apiDescription Remove one operation. |
847 | * @apiPermission compta_view && compta_edit |
848 | * |
849 | * @apiUse UserId |
850 | * |
851 | * @apiParam (URL) {String} id id of operation. |
852 | * |
853 | * @apiSuccessExample Response-Data (example): |
854 | * HTTP/1.1 200 Ok |
855 | * { |
856 | * "status": "ok" |
857 | * } |
858 | * |
859 | * @apiUse EntityError |
860 | */ |