SDK Endpoints

The SDK endpoints are used with the Android & iOS components. Each endpoint is integrated with specific view.

Category Spend

The category spend endpoint returns spend per each category in an Array of SpendCategory objects.

Used with Categories Spend Pie Chart View

AUTHORIZATIONS:

Api-Key

REQUEST HEADERS:

customer-id
required

string (Customer ID)

RESPONSE SCHEMA :

application/json

data

Array of objects (SpendCategory Object)

message

String (Error message if exists)

GET

{{HOST}}/api/v1/category/spend

Payload

application/json

Content type

{
    "data": [
     {
      	"category_id": "string",
        "category_desc": "string",
        "amount": 0.0,
        "currency_code": "string"
     }
    ],
    "message": ""
}

Brand Spend

The brand spend endpoint returns spend per each brand in an Array of BrandSpend objects within a specific month and year that is specified as query params.

Used with Brand List View

Query Params (Key)

Value

month

MM

year

YYYY

AUTHORIZATIONS:

Api-Key

REQUEST HEADERS:

customer-id
required

string (Customer ID)

RESPONSE SCHEMA :

application/json

data

Array of objects (BrandSpend Object)

message

String (Error message if exists)

GET

{{HOST}}/api/v1/brand/spend?month=02&year=2022

Payload

application/json

Content type

{
    "data": [
     {
      	"brand_id": "string",
        "brand_name": "string",
        "brand_logo_url": "string",
        "currency_code": "string",
        "amount": 0.0
     }
    ],
    "message": ""
}

Transactions

The transactions endpoint returns an Array of Transactions objects within a specific month and year that is specified as query params.

Used with Transaction List View

Query Params (Key)

Value

month

MM

year

YYYY

AUTHORIZATIONS:

Api-Key

REQUEST HEADERS:

customer-id
required

string (Customer ID)

RESPONSE SCHEMA :

application/json

data

Array of objects (Transaction Object)

message

String (Error message if exists)

GET

{{HOST}}/api/v1/transaction?month=10&year=2022

Payload

application/json

Content type

{
    "data": [
     {
      	"global_tx_id": "string",
        "raw_description": "string",
        "category_id": "string",
        "category_desc": "string",
        "brand_name": "string",
        "brand_logo": "string",
        "currency_code": "string",
        "amount": 0.0
     }
    ],
    "message": ""
}

Set Budget

The set budget endpoint allows users to create and set new budget.

Used with Budget Form View

AUTHORIZATIONS:

Api-Key

REQUEST BODY SCHEMA :

application/json

customer_id
required

string (Customer ID)

amount
required

float (Amount)

Responses

- 200 Success: Budget is created

POST

{{HOST}}/api/v1/budget

Payload

application/json

Content type

{
    "customer_id": "string"
    "amount": 0.0
}

Budget Summary

The budget summary endpoint returns current budgeted and spend amount summary in BudgetSummary object form.

Used with Budget Summary View

AUTHORIZATIONS:

Api-Key

REQUEST HEADERS:

customer-id
required

string (Customer ID)

RESPONSE SCHEMA :

application/json

data

BudgetSummary Object

message

String (Error message if exists)

GET

{{HOST}}/api/v1/budget

Payload

application/json

Content type

{
    "data": {
        "budgeted_amount": 10000.0,
        "spent_amount": 0,
        "expected_spend_value": 5000.0,
        "expected_spend_percent": 0.0
    },
    "message": ""
}

Budget Per-Category

The budget per-category endpoint returns an Array of CategoryBudgetSpend objects for each category.

Used with Category Spend List View

Query Params (Key)

Value

month

MM

year

YYYY

AUTHORIZATIONS:

Api-Key

REQUEST HEADERS:

customer-id
required

string (Customer ID)

RESPONSE SCHEMA :

application/json

data

Array of objects (CategoryBudgetSpend Object)

message

String (Error message if exists)

GET

{{HOST}}/api/v1/budget/category?month=11&year=2022

Payload

application/json

Content type

{
    "data": [
        {
            "category_id": "1",
            "category_desc": "Financial Services",
            "budgeted_amount": 0.0,
            "spent_amount": 0,
            "transactions_count": 0
        },
        {
            "category_id": "2",
            "category_desc": "Charity & Gifts",
            "budgeted_amount": 25.0,
            "spent_amount": 0,
            "transactions_count": 0
        },
        {
            "category_id": "3",
            "category_desc": "Education",
            "budgeted_amount": 50.0,
            "spent_amount": 0,
            "transactions_count": 0
        },
        {
            "category_id": "4",
            "category_desc": "Entertainment",
            "budgeted_amount": 100.0,
            "spent_amount": 0,
            "transactions_count": 0
        },
        {
            "category_id": "5",
            "category_desc": "Government Services",
            "budgeted_amount": 0.0,
            "spent_amount": 0,
            "transactions_count": 0
        },
        {
            "category_id": "6",
            "category_desc": "Groceries",
            "budgeted_amount": 100.0,
            "spent_amount": 0,
            "transactions_count": 0
        },
        {
            "category_id": "7",
            "category_desc": "Wellness",
            "budgeted_amount": 50.0,
            "spent_amount": 0,
            "transactions_count": 0
        },
        {
            "category_id": "8",
            "category_desc": "Savings & Investments",
            "budgeted_amount": 0.0,
            "spent_amount": 0,
            "transactions_count": 0
        },
        {
            "category_id": "9",
            "category_desc": "Household",
            "budgeted_amount": 200.0,
            "spent_amount": 0,
            "transactions_count": 0
        },
        {
            "category_id": "10",
            "category_desc": "Dining",
            "budgeted_amount": 100.0,
            "spent_amount": 0,
            "transactions_count": 0
        },
        {
            "category_id": "11",
            "category_desc": "Shopping",
            "budgeted_amount": 50.0,
            "spent_amount": 0,
            "transactions_count": 0
        },
        {
            "category_id": "12",
            "category_desc": "Income",
            "budgeted_amount": 0.0,
            "spent_amount": 0,
            "transactions_count": 0
        },
        {
            "category_id": "13",
            "category_desc": "Transfer",
            "budgeted_amount": 0.0,
            "spent_amount": 0,
            "transactions_count": 0
        },
        {
            "category_id": "14",
            "category_desc": "Transportation",
            "budgeted_amount": 100.0,
            "spent_amount": 0,
            "transactions_count": 0
        },
        {
            "category_id": "15",
            "category_desc": "Travel",
            "budgeted_amount": 50.0,
            "spent_amount": 0,
            "transactions_count": 0
        },
        {
            "category_id": "16",
            "category_desc": "Loans",
            "budgeted_amount": 175.0,
            "spent_amount": 0,
            "transactions_count": 0
        },
        {
            "category_id": "17",
            "category_desc": "Insurance",
            "budgeted_amount": 0.0,
            "spent_amount": 0,
            "transactions_count": 0
        }
    ],
    "message": ""
}

Update Categories Budget

The update categories budget endpoint allows users to modify categories budgeted amount.

Used with Category Spend List View

AUTHORIZATIONS:

Api-Key

REQUEST BODY SCHEMA :

application/json

customer_id
‍required

string (Customer ID)

budget
required

Array of objects (CategoryBudgetSpend Object)

Responses

- 200 Success: Updated categories budget

PUT

{{HOST}}/api/v1/budget

Payload

application/json

Content type

{
	"customer_id": "77",
	"budget" : [
	      {
		     "category_id": "1",
			  "budgeted_amount": 100
	      },
          {
		     "category_id": "2",
			  "budgeted_amount": 120
	      },
          {
		     "category_id": "3",
			  "budgeted_amount": 120
	      },
          {
		     "category_id": "4",
			  "budgeted_amount": 120
	      }
	]
}