sales.budget

Manage individual budget setting

SUPPORTED METHODS:

GET

ParametersTypeDescription
token (required)Valid token
start_date (required)dateStart date
end_date (required)dateEnd date
location (accepted)integerLocation id

UPDATE

ParametersTypeDescription
token (required)Valid token
start_date (required)dateStart date
end_date (required)dateEnd date
hours (accepted)integerHours
dollars (accepted)integerMoney amount
location (accepted)integerLocation id

DELETE

ParametersTypeDescription
token (required)Valid token
start_date (required)dateStart date
end_date (required)dateEnd date
location (accepted)integerLocation id

CREATE

ParametersTypeDescription
token (required)Valid token
start_date (required)dateStart date
end_date (required)dateEnd date
hours (accepted)integerHours
dollars (accepted)integerMoney amount
location (accepted)integerLocation id
position (accepted)integerPosition id

DOCUMENTATION

GET
Returns specific budget settings for a given time period and location.
Level 3 is required.

--

Example Request:

{
   "module":"sales.budget",
   "method":"GET",
   "request":{
      "start_date":"May 19, 2017",
      "end_date":"May 21, 2017",
      "location":"15"
   }
}

Example Response:

{
   "status":1,
   "data":{
      "id":"645",
      "store":"11",
      "start_date":{
         "id":"1545",
         "month":"5",
         "day":"19",
         "year":"2012",
         "weekday":"Mon",
         "mname":"May",
         "week":"21",
         "dayid":"2",
         "formatted":"May 19, 2017"
      },
      "end_date":{
         "id":"1556",
         "month":"5",
         "day":"21",
         "year":"2012",
         "weekday":"Fri",
         "mname":"May",
         "week":"21",
         "dayid":"5",
         "formatted":"May 21, 2017"
      },
      "location":"15",
      "hours":"8.00",
      "dolars":"0.00"
   },
   "token":"xxxxxxx"
}

CREATE
Creates specific budget settings for a given time period and location.
Level 3 is required.

--

Example Request:

{
   "module":"sales.budget",
   "method":"CREATE",
   "request":{
      "start_date":"May 19, 2017",
      "end_date":"May 21, 2017",
      "location":"38",
      "hours":"8.00",
      "dolars":"80.00"
   }
}

Example Response:

{
   "status":1,
   "data":{
      "id":"645",
      "store":"11",
      "start_date":{
         "id":"1545",
         "month":"5",
         "day":"19",
         "year":"2012",
         "weekday":"Mon",
         "mname":"May",
         "week":"21",
         "dayid":"2",
         "formatted":"May 19, 2017"
      },
      "end_date":{
         "id":"1556",
         "month":"5",
         "day":"21",
         "year":"2012",
         "weekday":"Fri",
         "mname":"May",
         "week":"21",
         "dayid":"5",
         "formatted":"May 21, 2017"
      },
      "location":"38",
      "hours":"8.00",
      "dolars":"0.00"
   },
   "token":"xxxxxxx"
}

UPDATE
Updates specific budget settings for a given time period and location.
Level 3 is required.

--

Example Request:

{
   "module":"sales.budget",
   "method":"UPDATE",
   "request":{
      "start_date":"May 19, 2017",
      "end_date":"May 21, 2017",
      "location":"15",
      "hour":"8.00",
      "dolars":"80.00"
   }
}

Example Response:

{
   "status":1,
   "data":{
      "id":"645",
      "store":"11",
      "start_date":{
         "id":"1545",
         "month":"5",
         "day":"19",
         "year":"2012",
         "weekday":"Mon",
         "mname":"May",
         "week":"21",
         "dayid":"2",
         "formatted":"May 19, 2017"
      },
      "end_date":{
         "id":"1556",
         "month":"5",
         "day":"21",
         "year":"2012",
         "weekday":"Fri",
         "mname":"May",
         "week":"21",
         "dayid":"5",
         "formatted":"May 21, 2017"
      },
      "location":"15",
      "hour":"8.00",
      "dolars":"80.00"
   },
   "token":"xxxxxxx"
}

DELETE
Deletes specific budget settings for a given time period and location.
Level 3 is required.

--
Example Request:

{
   "module":"sales.budget",
   "method":"DELETE",
   "request":{
      "start_date":"May 19, 2017",
      "end_date":"May 21, 2017",
      "location":"15"
   }
}

Example Response:

{
   "status":1,
   "data":"",
   "token":"xxxxxxx"
}