Api doc


SDK's


Api Modules

reports.budget



Supported Methods:

GET
Params
  • token (Required): valid token
  • start_date (Required): date
  • end_date (Required): date
  • location: integer
  • remote_site: integer
  • position: integer


Documentation

GET
Retrieves budget reports, between selected dates.
Level 3 is required.

--

Parameters:

  1. "start_date": required //Start date (date)
  2. "end_date": required //End date (date)
  3. "location": accepted //Location id (integer)
  4. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "module":"reports.budget",
  3. "method":"GET",
  4. "request":{
  5. "start_date":"Dec 1, 2012",
  6. "end_date":"Dec 10, 2012"
  7. }
  8. }

Example Response:

  1. {
  2. "status":1,
  3. "data":{
  4. "dates":[
  5. {
  6. "id":1312,
  7. "year":2012,
  8. "week":48,
  9. "last_day_in_week":true,
  10. "formatted":"Dec 1, 2012"
  11. },
  12. {
  13. "id":1313,
  14. "year":2012,
  15. "week":49,
  16. "last_day_in_week":false,
  17. "formatted":"Dec 2, 2012"
  18. },
  19. {
  20. "id":1314,
  21. "year":2012,
  22. "week":49,
  23. "last_day_in_week":false,
  24. "formatted":"Dec 3, 2012"
  25. },
  26. {
  27. "id":1315,
  28. "year":2012,
  29. "week":49,
  30. "last_day_in_week":false,
  31. "formatted":"Dec 4, 2012"
  32. },
  33. {
  34. "id":1316,
  35. "year":2012,
  36. "week":49,
  37. "last_day_in_week":false,
  38. "formatted":"Dec 5, 2012"
  39. },
  40. {
  41. "id":1317,
  42. "year":2012,
  43. "week":49,
  44. "last_day_in_week":false,
  45. "formatted":"Dec 6, 2012"
  46. },
  47. {
  48. "id":1318,
  49. "year":2012,
  50. "week":49,
  51. "last_day_in_week":false,
  52. "formatted":"Dec 7, 2012"
  53. },
  54. {
  55. "id":1319,
  56. "year":2012,
  57. "week":49,
  58. "last_day_in_week":true,
  59. "formatted":"Dec 8, 2012"
  60. },
  61. {
  62. "id":1320,
  63. "year":2012,
  64. "week":50,
  65. "last_day_in_week":false,
  66. "formatted":"Dec 9, 2012"
  67. },
  68. {
  69. "id":1321,
  70. "year":2012,
  71. "week":50,
  72. "last_day_in_week":false,
  73. "formatted":"Dec 10, 2012"
  74. }
  75. ],
  76. "weeks":{
  77. "2012":{
  78. "48":{
  79. "year":2012,
  80. "week":48,
  81. "start":1306,
  82. "end":1312
  83. },
  84. "49":{
  85. "year":2012,
  86. "week":49,
  87. "start":1313,
  88. "end":1319
  89. }
  90. }
  91. },
  92. "locations":{
  93. "0":{
  94. "id":0,
  95. "name":"Schedule Overview",
  96. "budget":[
  97.  
  98. ],
  99. "date":{
  100. "1317":3,
  101. "1321":10
  102. },
  103. "week":{
  104. "2012":{
  105. "49":{
  106. "hours":3
  107. },
  108. "50":{
  109. "hours":10
  110. }
  111. }
  112. }
  113. },
  114. "42267":{
  115. "id":"42267",
  116. "name":"New New York",
  117. "budget":[
  118.  
  119. ],
  120. "date":{
  121. "1317":3,
  122. "1321":10
  123. },
  124. "week":{
  125. "2012":{
  126. "49":{
  127. "hours":3
  128. },
  129. "50":{
  130. "hours":10
  131. }
  132. }
  133. }
  134. }
  135. }
  136. },
  137. "token":"xxxxxxx"
  138. }