Budgets - MX Documentation

Budget webhooks notify you when a budget is created, updated, or deleted in the MX system for any user on that partner’s client.

Field	Data Type	Definition
`amount`	String	A budget amount set by the user for a category’s transaction total during a month.
`category_guid`	String	The unique identifier for the budget category. Defined by MX.
`client_id`	String	The unique partner-defined identifier for the client.
`created_at`	Integer	The date and time the budget was created.
`guid`	String	The unique identifier for the budget. Defined by MX.
`is_exceeded`	Boolean	This indicates whether the budget has been exceeded.
`is_off_track`	Boolean	This indicates whether the budget is off track.
`metadata`	String	Additional information a partner can store on the budget.
`name`	String	The name of the budget.
`parent_guid`	String	The unique identifier for the parent budget. Defined by MX.
`projected_spending`	Decimal	The projected amount of spending for the budget.
`revision`	Integer	The revision number for the budget.
`transaction_total`	Decimal	The cumulative amount of all transactions under the budget.
`updated_at`	Integer	The date and time the budget was updated.
`user_guid`	String	The unique partner-defined identifier for the user the budget is attached to. Defined by MX.
`user_id`	String	The unique partner-defined identifier for the user.

Example Payload

JSON

POST /admin/webhooks
HTTP/1.1
content-type: application/json; charset=utf-8
accept: application/json
User-Agent: HTTPClient/1.0 (2.7.1, ruby 2.2.2
(2015-09-02)) Date: Thu, 14 Apr 2016 04:26:04 GMT Content-Length: 231
Host: abc.com
{
  "action": "created",
  "budget": {
    "amount": 200,
    "category_guid": "CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874",
    "client_id": "C-1234",
    "created_at": 1486158088,
    "guid": "BGT-bef4174f-cb78-2c12-2cbe-56dd55852198",
    "is_exceeded": false,
    "is_off_track": false,
    "metadata": null,
    "name": "Auto & Transport",
    "parent_guid": null,
    "projected_spending": "72.25428571428571",
    "revision": 4,
    "transaction_total": null,
    "updated_at": 1487166546,
    "user_guid": "USR-dfb1b536-692d-f172-88c6-643a2691b30c",
    "user_id": "0128372140"
  }
}