Read monthly cash flow profile - MX Documentation

Read monthly cash flow profile

curl --request GET \
  --url https://int-api.mx.com/users/{user_identifier}/monthly_cash_flow_profile \
  --header 'Accept-Version: <accept-version>' \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://int-api.mx.com/users/{user_identifier}/monthly_cash_flow_profile"

headers = {
    "Accept-Version": "<accept-version>",
    "Authorization": "Basic <encoded-value>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'Accept-Version': '<accept-version>', Authorization: 'Basic <encoded-value>'}
};

fetch('https://int-api.mx.com/users/{user_identifier}/monthly_cash_flow_profile', 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_identifier}/monthly_cash_flow_profile",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept-Version: <accept-version>",
    "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_identifier}/monthly_cash_flow_profile"

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

	req.Header.Add("Accept-Version", "<accept-version>")
	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.get("https://int-api.mx.com/users/{user_identifier}/monthly_cash_flow_profile")
  .header("Accept-Version", "<accept-version>")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-api.mx.com/users/{user_identifier}/monthly_cash_flow_profile")

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

request = Net::HTTP::Get.new(url)
request["Accept-Version"] = '<accept-version>'
request["Authorization"] = 'Basic <encoded-value>'

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

{
  "monthly_cash_flow_profile": {
    "guid": "MCF-4e431124-4a29-abf9-f059-ab232ac14dbf",
    "user_guid": "USR-6c83f63c-efcc-0189-3f14-100f0bad378a",
    "budgeted_income": 5000,
    "budgeted_expenses": 3500,
    "goals_contribution": 500,
    "estimated_goals_contribution": null,
    "uses_estimated_goals_contribution": false
  }
}

GET

/

users

/

{user_identifier}

/

monthly_cash_flow_profile

Read monthly cash flow profile

curl --request GET \
  --url https://int-api.mx.com/users/{user_identifier}/monthly_cash_flow_profile \
  --header 'Accept-Version: <accept-version>' \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://int-api.mx.com/users/{user_identifier}/monthly_cash_flow_profile"

headers = {
    "Accept-Version": "<accept-version>",
    "Authorization": "Basic <encoded-value>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'Accept-Version': '<accept-version>', Authorization: 'Basic <encoded-value>'}
};

fetch('https://int-api.mx.com/users/{user_identifier}/monthly_cash_flow_profile', 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_identifier}/monthly_cash_flow_profile",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept-Version: <accept-version>",
    "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_identifier}/monthly_cash_flow_profile"

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

	req.Header.Add("Accept-Version", "<accept-version>")
	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.get("https://int-api.mx.com/users/{user_identifier}/monthly_cash_flow_profile")
  .header("Accept-Version", "<accept-version>")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-api.mx.com/users/{user_identifier}/monthly_cash_flow_profile")

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

request = Net::HTTP::Get.new(url)
request["Accept-Version"] = '<accept-version>'
request["Authorization"] = 'Basic <encoded-value>'

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

{
  "monthly_cash_flow_profile": {
    "guid": "MCF-4e431124-4a29-abf9-f059-ab232ac14dbf",
    "user_guid": "USR-6c83f63c-efcc-0189-3f14-100f0bad378a",
    "budgeted_income": 5000,
    "budgeted_expenses": 3500,
    "goals_contribution": 500,
    "estimated_goals_contribution": null,
    "uses_estimated_goals_contribution": false
  }
}

Read monthly cash flow profile.

Authorizations

Authorization

string

header

required

The MX Platform API requires basic access authentication using your client_id and api_key. These credentials must be Base64 encoded and included in the Authorization header of each API request to ensure secure access.

Here's an example using curl to access v20250224. Replace https://int-api.mx.com/endpoint with the actual API endpoint you wish to access and your Base64 encoded client_id and api_key.

curl -L -X POST `https://int-api.mx.com/endpoint' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Accept-Version: v20250224'
-H 'Authorization: Basic BASE_64_ENCODING_OF{client_id:api_key}'

Headers

Accept-Version

string

default:v20250224

required

MX Platform API version.

Example:

"v20250224"

Path Parameters

user_identifier

string

required

Use either the user id you defined or the MX-defined user guid. See MX-Defined GUIDs vs IDs Defined by You.

Response

200 - application/json

OK

monthly_cash_flow_profile

object

Hide child attributes

monthly_cash_flow_profile.guid

string

Unique identifier for the monthly cash flow profile. Defined by MX.

Example:

"MCF-4e431124-4a29-abf9-f059-ab232ac14dbf"

monthly_cash_flow_profile.user_guid

string

Unique identifier for the user the monthly cash flow profile is attached to. Defined by MX.

Example:

"USR-6c83f63c-efcc-0189-3f14-100f0bad378a"

monthly_cash_flow_profile.budgeted_income

number

The amount of the budgeted income for the user.

Example:

5000

monthly_cash_flow_profile.budgeted_expenses

number

The amount of the budgeted expenses for the user.

Example:

3500

monthly_cash_flow_profile.goals_contribution

number

The monthly dollar amount allocated for goals.

Example:

500

monthly_cash_flow_profile.estimated_goals_contribution

number | null

The estimated monthly dollar amount allocated for goals calculated from income and budgets.

Example:

null

monthly_cash_flow_profile.uses_estimated_goals_contribution

boolean

Indicates if the user uses estimated goals contribution.

Example:

false

Monthly Cash Flow Profile Overview

Update monthly cash flow profile