Auto-generate budgets

curl --request POST \
  --url https://int-api.mx.com/users/{user_guid}/budgets/generate \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://int-api.mx.com/users/{user_guid}/budgets/generate"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://int-api.mx.com/users/{user_guid}/budgets/generate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://int-api.mx.com/users/{user_guid}/budgets/generate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://int-api.mx.com/users/{user_guid}/budgets/generate"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://int-api.mx.com/users/{user_guid}/budgets/generate")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-api.mx.com/users/{user_guid}/budgets/generate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "budget": {
    "amount": 153,
    "category_guid": "CAT-bd56d35a-a9a7-6e10-66c1-5b9cc1b6c81a",
    "created_at": "2018-10-18T19:51:26+00:00",
    "guid": "BGT-6ca0e3ef-c65e-4655-8b5a-275a3c19c21d",
    "is_exceeded": true,
    "is_off_track": true,
    "metadata": "some metadata",
    "name": "Food & Dining",
    "off_track_percentage": 123,
    "parent_guid": "<string>",
    "percent_spent": 1276.34,
    "projected_spending": 3562.4,
    "revision": 561,
    "transaction_total": 1952.8,
    "updated_at": "2022-06-14T21:17:11+00:00",
    "user_guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
  }
}

POST

users

{user_guid}

budgets

generate

Auto-generate budgets

curl --request POST \
  --url https://int-api.mx.com/users/{user_guid}/budgets/generate \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://int-api.mx.com/users/{user_guid}/budgets/generate"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://int-api.mx.com/users/{user_guid}/budgets/generate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://int-api.mx.com/users/{user_guid}/budgets/generate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://int-api.mx.com/users/{user_guid}/budgets/generate"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://int-api.mx.com/users/{user_guid}/budgets/generate")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-api.mx.com/users/{user_guid}/budgets/generate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "budget": {
    "amount": 153,
    "category_guid": "CAT-bd56d35a-a9a7-6e10-66c1-5b9cc1b6c81a",
    "created_at": "2018-10-18T19:51:26+00:00",
    "guid": "BGT-6ca0e3ef-c65e-4655-8b5a-275a3c19c21d",
    "is_exceeded": true,
    "is_off_track": true,
    "metadata": "some metadata",
    "name": "Food & Dining",
    "off_track_percentage": 123,
    "parent_guid": "<string>",
    "percent_spent": 1276.34,
    "projected_spending": 3562.4,
    "revision": 561,
    "transaction_total": 1952.8,
    "updated_at": "2022-06-14T21:17:11+00:00",
    "user_guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
  }
}

This endpoint will automatically create budgets for several categories based on existing transactions; these budgets are returned as an array. Specifically, budgets will only be generated if the user has at least one transaction in a given category during each of the two previous calendar months. For example, if the request is made on March 6, and there is at least one “Bills & Utilities” transaction in both January and February, a budget will be generated for “Bills & Utilities.” If there are two “Bills & Utilities” transactions in February but none in January, no budget will be generated for that category. If budgets already exist for particular categories, new budgets will be generated and returned based on the available transactions. If one or more budgets remain unchanged, they will nevertheless be returned in the response. If no transaction data for the user meet the above criteria, a 422 Unprocessable Entity error will be returned with status code 4221 along with the message, There aren't enough transactions to automatically create any budgets.

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

user_guid

string

required

The unique identifier for a user, beginning with the prefix USR-.

Response

200 - application/vnd.mx.api.v1+json

budget

object

Hide child attributes

budget.amount

number

A goal amount set by the user for a category's transaction total during a month.

Example:

153

budget.category_guid

string

Unique identifier for the budget category. Defined by MX.

Example:

"CAT-bd56d35a-a9a7-6e10-66c1-5b9cc1b6c81a"

budget.created_at

string

Date and time the budget was created, represented in ISO 8601 format with timestamp.

Example:

"2018-10-18T19:51:26+00:00"

budget.guid

string

Unique identifier for the budget. Defined by MX.

Example:

"BGT-6ca0e3ef-c65e-4655-8b5a-275a3c19c21d"

budget.is_exceeded

boolean

If the budget has been exceeded, this field will be true. Otherwise, this field will be false.

Example:

true

budget.is_off_track

boolean

If the budget is off track, this field will be true. Otherwise, this field will be false.

Example:

true

budget.metadata

string | null

Additional information a partner can store on the budget.

Example:

"some metadata"

budget.name

string | null

The name of the budget that is visible to the user (ie "Food", "Bills", "Entertainment", etc).

Example:

"Food & Dining"

budget.off_track_percentage

number | null

The percentage amount of off track spending. (Deprecated).

budget.parent_guid

string | null

Unique identifier for the parent budget. Defined by MX.

budget.percent_spent

number | null

The percentage of a budget that has been spent during the current calendar month Calculated as the transaction total divided by the amount and then multiplied by 100.A value of zero will be returned when amount is zero.

Example:

1276.34

budget.projected_spending

number

The projected amount of spending for the budget.

Example:

3562.4

budget.revision

integer

The revision number of this budget record.

Example:

561

budget.transaction_total

any

The cumulative amount of all transactions under the budget.

Example:

1952.8

budget.updated_at

any

Date and time the budget was updated, represented in ISO 8601 format with timestamp.

Example:

"2022-06-14T21:17:11+00:00"

budget.user_guid

any

Unique identifier for the user. Defined by MX.

Example:

"USR-11141024-90b3-1bce-cac9-c06ced52ab4c"

Budgets Overview

Create a budget