Budgets

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

_28

POST /admin/webhooks

_28

HTTP/1.1

_28

content-type: application/json; charset=utf-8

_28

accept: application/json

_28

User-Agent: HTTPClient/1.0 (2.7.1, ruby 2.2.2

_28

(2015-09-02)) Date: Thu, 14 Apr 2016 04:26:04 GMT Content-Length: 231

_28

Host: abc.com

_28

{

_28

"action": "created",

_28

"budget": {

_28

"amount": 200,

_28

"category_guid": "CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874",

_28

"client_id": "C-1234",

_28

"created_at": 1486158088,

_28

"guid": "BGT-bef4174f-cb78-2c12-2cbe-56dd55852198",

_28

"is_exceeded": false,

_28

"is_off_track": false,

_28

"metadata": null,

_28

"name": "Auto & Transport",

_28

"parent_guid": null,

_28

"projected_spending": "72.25428571428571",

_28

"revision": 4,

_28

"transaction_total": null,

_28

"updated_at": 1487166546,

_28

"user_guid": "USR-dfb1b536-692d-f172-88c6-643a2691b30c",

_28

"user_id": "0128372140"

_28

}

_28

}