Update a specific budget

curl --request PUT \
  --url https://int-data.moneydesktop.com/budgets/{budget_guid} \
  --header 'Content-Type: application/vnd.mx.nexus.v1+json' \
  --header 'MD-SESSION-TOKEN: <api-key>' \
  --data '
{
  "budget": [
    {
      "amount": 1000,
      "metadata": "Additional information",
      "skip_webhook": true
    }
  ]
}
'

import requests

url = "https://int-data.moneydesktop.com/budgets/{budget_guid}"

payload = { "budget": [
        {
            "amount": 1000,
            "metadata": "Additional information",
            "skip_webhook": True
        }
    ] }
headers = {
    "MD-SESSION-TOKEN": "<api-key>",
    "Content-Type": "application/vnd.mx.nexus.v1+json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'MD-SESSION-TOKEN': '<api-key>',
    'Content-Type': 'application/vnd.mx.nexus.v1+json'
  },
  body: JSON.stringify({
    budget: [{amount: 1000, metadata: 'Additional information', skip_webhook: true}]
  })
};

fetch('https://int-data.moneydesktop.com/budgets/{budget_guid}', 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-data.moneydesktop.com/budgets/{budget_guid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'budget' => [
        [
                'amount' => 1000,
                'metadata' => 'Additional information',
                'skip_webhook' => true
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/vnd.mx.nexus.v1+json",
    "MD-SESSION-TOKEN: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://int-data.moneydesktop.com/budgets/{budget_guid}"

	payload := strings.NewReader("{\n  \"budget\": [\n    {\n      \"amount\": 1000,\n      \"metadata\": \"Additional information\",\n      \"skip_webhook\": true\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("MD-SESSION-TOKEN", "<api-key>")
	req.Header.Add("Content-Type", "application/vnd.mx.nexus.v1+json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://int-data.moneydesktop.com/budgets/{budget_guid}")
  .header("MD-SESSION-TOKEN", "<api-key>")
  .header("Content-Type", "application/vnd.mx.nexus.v1+json")
  .body("{\n  \"budget\": [\n    {\n      \"amount\": 1000,\n      \"metadata\": \"Additional information\",\n      \"skip_webhook\": true\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-data.moneydesktop.com/budgets/{budget_guid}")

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

request = Net::HTTP::Put.new(url)
request["MD-SESSION-TOKEN"] = '<api-key>'
request["Content-Type"] = 'application/vnd.mx.nexus.v1+json'
request.body = "{\n  \"budget\": [\n    {\n      \"amount\": 1000,\n      \"metadata\": \"Additional information\",\n      \"skip_webhook\": true\n    }\n  ]\n}"

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.000Z",
    "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"
  }
}

PUT

budgets

{budget_guid}

Update a specific budget

curl --request PUT \
  --url https://int-data.moneydesktop.com/budgets/{budget_guid} \
  --header 'Content-Type: application/vnd.mx.nexus.v1+json' \
  --header 'MD-SESSION-TOKEN: <api-key>' \
  --data '
{
  "budget": [
    {
      "amount": 1000,
      "metadata": "Additional information",
      "skip_webhook": true
    }
  ]
}
'

import requests

url = "https://int-data.moneydesktop.com/budgets/{budget_guid}"

payload = { "budget": [
        {
            "amount": 1000,
            "metadata": "Additional information",
            "skip_webhook": True
        }
    ] }
headers = {
    "MD-SESSION-TOKEN": "<api-key>",
    "Content-Type": "application/vnd.mx.nexus.v1+json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'MD-SESSION-TOKEN': '<api-key>',
    'Content-Type': 'application/vnd.mx.nexus.v1+json'
  },
  body: JSON.stringify({
    budget: [{amount: 1000, metadata: 'Additional information', skip_webhook: true}]
  })
};

fetch('https://int-data.moneydesktop.com/budgets/{budget_guid}', 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-data.moneydesktop.com/budgets/{budget_guid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'budget' => [
        [
                'amount' => 1000,
                'metadata' => 'Additional information',
                'skip_webhook' => true
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/vnd.mx.nexus.v1+json",
    "MD-SESSION-TOKEN: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://int-data.moneydesktop.com/budgets/{budget_guid}"

	payload := strings.NewReader("{\n  \"budget\": [\n    {\n      \"amount\": 1000,\n      \"metadata\": \"Additional information\",\n      \"skip_webhook\": true\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("MD-SESSION-TOKEN", "<api-key>")
	req.Header.Add("Content-Type", "application/vnd.mx.nexus.v1+json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://int-data.moneydesktop.com/budgets/{budget_guid}")
  .header("MD-SESSION-TOKEN", "<api-key>")
  .header("Content-Type", "application/vnd.mx.nexus.v1+json")
  .body("{\n  \"budget\": [\n    {\n      \"amount\": 1000,\n      \"metadata\": \"Additional information\",\n      \"skip_webhook\": true\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-data.moneydesktop.com/budgets/{budget_guid}")

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

request = Net::HTTP::Put.new(url)
request["MD-SESSION-TOKEN"] = '<api-key>'
request["Content-Type"] = 'application/vnd.mx.nexus.v1+json'
request.body = "{\n  \"budget\": [\n    {\n      \"amount\": 1000,\n      \"metadata\": \"Additional information\",\n      \"skip_webhook\": true\n    }\n  ]\n}"

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.000Z",
    "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"
  }
}

Authorizations

MD-SESSION-TOKEN

string

header

required

MX Session Token

Request an API token using the read API token endpoint in the MX SSO API.
Exchange an API token for a session token.
- A session token is obtained by sending a POST request to /sessions
- The session token will be used in each request made for the user. It should be passed in an MD-SESSION-TOKEN HTTP header as shown below.
- This session token is valid for 30 minutes from the time it was created. The 30 minute expiration counter is refreshed with each call.
- If you send a request with an expired session token you'll receive an error code of 4011.

curl -i https://int-data.moneydesktop.com/accounts \
-H 'MD-SESSION-TOKEN: CWforZl1Vn2vC_v6H4rnQRT1DoWpDouJAV-_5TBmiQRAtA8rsOG_BoajTiOSsL0A3bd-bmHXlA-eQzc9ywItKg' \
-H 'Content-Type: application/vnd.mx.nexus.v1+json' \
-H 'Accept: application/vnd.mx.nexus.v1+json'

In documentation code examples, replace <API_KEY_VALUE> with the session token.

Path Parameters

budget_guid

string

required

The unique identifier for the budget. Defined by MX.

Body

application/vnd.mx.nexus.v1+json

budget

object[]

Hide child attributes

budget.amount

integer

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

Example:

1000

budget.metadata

string

Additional information a partner can store on the budget.

Example:

"Additional information"

budget.skip_webhook

boolean

When set to true, this parameter will prevent a webhook from being triggered by the request.

Example:

true

Response

200 - application/vnd.mx.nexus.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.000Z"

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"

Read a specific budget

Delete a budget