MENU navbar-image

Introduction

Api documentation for Forecasted Finance.

Authenticating requests

This API is not authenticated.

Endpoints

GET api/admin-price/listAllPrices

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/admin-price/listAllPrices" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/admin-price/listAllPrices"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/admin-price/listAllPrices

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/admin-price/listAllProducts

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/admin-price/listAllProducts" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/admin-price/listAllProducts"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/admin-price/listAllProducts

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/admin-price/listAllPaymentPlans

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/admin-price/listAllPaymentPlans" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/admin-price/listAllPaymentPlans"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/admin-price/listAllPaymentPlans

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/admin-price/createPrice

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/admin-price/createPrice" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"product\": \"velit\",
    \"unit_amount\": 58614383.48056589,
    \"interval\": \"nostrum\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/admin-price/createPrice"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "product": "velit",
    "unit_amount": 58614383.48056589,
    "interval": "nostrum"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/admin-price/createPrice

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

product   string   

Example: velit

unit_amount   number   

Example: 58614383.480566

interval   string   

Example: nostrum

POST api/admin-price/updatePaymentPlan/{id}

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/admin-price/updatePaymentPlan/accusamus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"unit_amount\": 5910716
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/admin-price/updatePaymentPlan/accusamus"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "unit_amount": 5910716
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/admin-price/updatePaymentPlan/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the updatePaymentPlan. Example: accusamus

Body Parameters

unit_amount   number   

Example: 5910716

GET api/admin-subscription/listAllSubcriptions

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/admin-subscription/listAllSubcriptions" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/admin-subscription/listAllSubcriptions"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/admin-subscription/listAllSubcriptions

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/admin-subscription/getInvoicesForSubscription/{stripe_subscription_id}

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/admin-subscription/getInvoicesForSubscription/velit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/admin-subscription/getInvoicesForSubscription/velit"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/admin-subscription/getInvoicesForSubscription/{stripe_subscription_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

stripe_subscription_id   string   

The ID of the stripe subscription. Example: velit

GET api/admin-users/listUsers

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/admin-users/listUsers" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"page\": \"et\",
    \"kw\": \"consequuntur\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/admin-users/listUsers"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "page": "et",
    "kw": "consequuntur"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/admin-users/listUsers

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

page   string   

Example: et

kw   string  optional  

Example: consequuntur

GET api/admin-users/updateStatus

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/admin-users/updateStatus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"asperiores\",
    \"status\": \"quia\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/admin-users/updateStatus"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "id": "asperiores",
    "status": "quia"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/admin-users/updateStatus

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

id   string   

Example: asperiores

status   string   

Example: quia

POST api/assumptions

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/assumptions" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"dt_from\": \"2025-09-08\",
    \"dt_to\": \"2025-09-08\",
    \"org_id\": 11.049757,
    \"amount\": 123098.13,
    \"percent_or_value\": \"odit\",
    \"description\": \"rerum\",
    \"assumption_type\": \"officiis\",
    \"categories_csv\": \"aut\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/assumptions"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "dt_from": "2025-09-08",
    "dt_to": "2025-09-08",
    "org_id": 11.049757,
    "amount": 123098.13,
    "percent_or_value": "odit",
    "description": "rerum",
    "assumption_type": "officiis",
    "categories_csv": "aut"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/assumptions

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

dt_from   string   

Must be a valid date. Must be a valid date in the format Y-m-d. Example: 2025-09-08

dt_to   string   

Must be a valid date. Must be a valid date in the format Y-m-d. Example: 2025-09-08

org_id   number   

Example: 11.049757

amount   number   

Example: 123098.13

percent_or_value   string   

Example: odit

description   string   

Example: rerum

assumption_type   string   

Example: officiis

categories_csv   string  optional  

Example: aut

POST api/assumptions/update/{assumption_master_id}

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/assumptions/update/ducimus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"org_id\": 7237.49710879,
    \"dt_from\": \"2025-09-08\",
    \"dt_to\": \"2025-09-08\",
    \"amount\": 47,
    \"percent_or_value\": \"vel\",
    \"description\": \"omnis\",
    \"assumption_type\": \"optio\",
    \"categories_csv\": \"perspiciatis\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/assumptions/update/ducimus"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "org_id": 7237.49710879,
    "dt_from": "2025-09-08",
    "dt_to": "2025-09-08",
    "amount": 47,
    "percent_or_value": "vel",
    "description": "omnis",
    "assumption_type": "optio",
    "categories_csv": "perspiciatis"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/assumptions/update/{assumption_master_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

assumption_master_id   string   

The ID of the assumption master. Example: ducimus

Body Parameters

org_id   number   

Example: 7237.49710879

dt_from   string   

Must be a valid date. Must be a valid date in the format Y-m-d. Example: 2025-09-08

dt_to   string   

Must be a valid date. Must be a valid date in the format Y-m-d. Example: 2025-09-08

amount   number   

Example: 47

percent_or_value   string   

Example: vel

description   string   

Example: omnis

assumption_type   string   

Example: optio

categories_csv   string  optional  

Example: perspiciatis

GET api/assumptions/listPaginatedMasterForOrganization

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/assumptions/listPaginatedMasterForOrganization" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"org_id\": 14,
    \"page\": 5,
    \"page_size\": 17
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/assumptions/listPaginatedMasterForOrganization"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "org_id": 14,
    "page": 5,
    "page_size": 17
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/assumptions/listPaginatedMasterForOrganization

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

org_id   integer   

Example: 14

page   integer   

Example: 5

page_size   integer   

Example: 17

GET api/assumptions/assumptionDetails/{master_id}

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/assumptions/assumptionDetails/tenetur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/assumptions/assumptionDetails/tenetur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/assumptions/assumptionDetails/{master_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

master_id   string   

The ID of the master. Example: tenetur

DELETE api/assumptions/deleteMaster/{id}

Example request:
curl --request DELETE \
    "https://prod.forecastedfinance.com/api/api/assumptions/deleteMaster/voluptatem" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/assumptions/deleteMaster/voluptatem"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/assumptions/deleteMaster/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the deleteMaster. Example: voluptatem

POST api/assumptions-v2/createMaster

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/assumptions-v2/createMaster" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"org_id\": 43527125.62202,
    \"description\": \"sint\",
    \"dt_from\": \"2025-09-08\",
    \"dt_to\": \"2025-09-08\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/assumptions-v2/createMaster"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "org_id": 43527125.62202,
    "description": "sint",
    "dt_from": "2025-09-08",
    "dt_to": "2025-09-08"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/assumptions-v2/createMaster

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

org_id   number   

Example: 43527125.62202

description   string   

Example: sint

dt_from   string   

Must be a valid date. Must be a valid date in the format Y-m-d. Example: 2025-09-08

dt_to   string   

Must be a valid date. Must be a valid date in the format Y-m-d. Example: 2025-09-08

POST api/assumptions-v2/createChild

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/assumptions-v2/createChild" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"dt_from\": \"2025-09-08\",
    \"dt_to\": \"2025-09-08\",
    \"amount\": 9.243060439,
    \"percent_or_value\": \"enim\",
    \"assumption_type\": \"qui\",
    \"master_id\": \"rerum\",
    \"vcategory_id\": \"tempora\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/assumptions-v2/createChild"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "dt_from": "2025-09-08",
    "dt_to": "2025-09-08",
    "amount": 9.243060439,
    "percent_or_value": "enim",
    "assumption_type": "qui",
    "master_id": "rerum",
    "vcategory_id": "tempora"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/assumptions-v2/createChild

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

dt_from   string   

Must be a valid date. Must be a valid date in the format Y-m-d. Example: 2025-09-08

dt_to   string   

Must be a valid date. Must be a valid date in the format Y-m-d. Example: 2025-09-08

amount   number   

Example: 9.243060439

percent_or_value   string   

Example: enim

assumption_type   string   

Example: qui

master_id   string   

Example: rerum

vcategory_id   string   

Example: tempora

POST api/assumptions-v2/editChild/{master_id}

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/assumptions-v2/editChild/ea" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"dt_from\": \"2025-09-08\",
    \"dt_to\": \"2025-09-08\",
    \"amount\": 30436.552797955,
    \"percent_or_value\": \"magnam\",
    \"assumption_type\": \"laboriosam\",
    \"vcategory_id\": \"tenetur\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/assumptions-v2/editChild/ea"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "dt_from": "2025-09-08",
    "dt_to": "2025-09-08",
    "amount": 30436.552797955,
    "percent_or_value": "magnam",
    "assumption_type": "laboriosam",
    "vcategory_id": "tenetur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/assumptions-v2/editChild/{master_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

master_id   string   

The ID of the master. Example: ea

Body Parameters

dt_from   string   

Must be a valid date. Must be a valid date in the format Y-m-d. Example: 2025-09-08

dt_to   string   

Must be a valid date. Must be a valid date in the format Y-m-d. Example: 2025-09-08

amount   number   

Example: 30436.552797955

percent_or_value   string   

Example: magnam

assumption_type   string   

Example: laboriosam

vcategory_id   string   

Example: tenetur

GET api/assumptions-v2/findMaster/{master_id}

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/assumptions-v2/findMaster/aperiam" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/assumptions-v2/findMaster/aperiam"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/assumptions-v2/findMaster/{master_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

master_id   string   

The ID of the master. Example: aperiam

DELETE api/assumptions-v2/deleteChild/{master_id}/{vcategory_id}

Example request:
curl --request DELETE \
    "https://prod.forecastedfinance.com/api/api/assumptions-v2/deleteChild/rerum/qui" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/assumptions-v2/deleteChild/rerum/qui"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/assumptions-v2/deleteChild/{master_id}/{vcategory_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

master_id   string   

The ID of the master. Example: rerum

vcategory_id   string   

The ID of the vcategory. Example: qui

POST api/auth/login

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/auth/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"roxane91@example.org\",
    \"password\": \"velit\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/auth/login"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "roxane91@example.org",
    "password": "velit"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/auth/login

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

Must be a valid email address. Example: roxane91@example.org

password   string   

Example: velit

POST api/auth/register

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/auth/register" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"nader.alda@example.com\",
    \"password\": \"accusantium\",
    \"name\": \"ut\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/auth/register"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "nader.alda@example.com",
    "password": "accusantium",
    "name": "ut"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/auth/register

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

Must be a valid email address. Must not be greater than 255 characters. Example: nader.alda@example.com

password   string   

Example: accusantium

name   string   

Example: ut

GET api/auth/getUser

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/auth/getUser" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/auth/getUser"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/auth/getUser

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/auth/logout

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/auth/logout" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/auth/logout"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST api/auth/logout

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/auth/updateNameEmailAndPassword

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/auth/updateNameEmailAndPassword" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"bmarks@example.com\",
    \"password\": \"at\",
    \"name\": \"consequatur\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/auth/updateNameEmailAndPassword"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "bmarks@example.com",
    "password": "at",
    "name": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/auth/updateNameEmailAndPassword

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

Must be a valid email address. Must not be greater than 255 characters. Example: bmarks@example.com

password   string   

Example: at

name   string   

Example: consequatur

POST api/auth/updateNameEmail

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/auth/updateNameEmail" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"hmraz@example.com\",
    \"name\": \"sed\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/auth/updateNameEmail"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "hmraz@example.com",
    "name": "sed"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/auth/updateNameEmail

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

Must be a valid email address. Must not be greater than 255 characters. Example: hmraz@example.com

name   string   

Example: sed

POST api/auth/updatePassword

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/auth/updatePassword" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"password\": \"necessitatibus\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/auth/updatePassword"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "password": "necessitatibus"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/auth/updatePassword

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

password   string   

Example: necessitatibus

POST api/auth/sendOtpEmail

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/auth/sendOtpEmail" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"schuyler.veum@example.org\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/auth/sendOtpEmail"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "schuyler.veum@example.org"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/auth/sendOtpEmail

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

Must be a valid email address. Example: schuyler.veum@example.org

POST api/auth/verifyOtpEmail

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/auth/verifyOtpEmail" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"oritchie@example.org\",
    \"otp\": \"666995\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/auth/verifyOtpEmail"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "oritchie@example.org",
    "otp": "666995"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/auth/verifyOtpEmail

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

Must be a valid email address. Example: oritchie@example.org

otp   string   

Must match the regex /^[0-9]{6}$/. Example: 666995

GET api/auth/getToken

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/auth/getToken" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/auth/getToken"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/auth/getToken

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/engine/getDetails

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/engine/getDetails" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"org_id\": \"natus\",
    \"dt_from\": \"2025-09-08\",
    \"dt_to\": \"2025-09-08\",
    \"week_count\": 0.63
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/engine/getDetails"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "org_id": "natus",
    "dt_from": "2025-09-08",
    "dt_to": "2025-09-08",
    "week_count": 0.63
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/engine/getDetails

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

org_id   string   

Example: natus

dt_from   string   

Must be a valid date. Must be a valid date in the format Y-m-d. Example: 2025-09-08

dt_to   string   

Must be a valid date. Must be a valid date in the format Y-m-d. Example: 2025-09-08

week_count   number   

Example: 0.63

POST api/engine/getDetailsV2

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/engine/getDetailsV2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"org_id\": \"voluptatem\",
    \"dt_from\": \"2025-09-08\",
    \"dt_to\": \"2025-09-08\",
    \"week_count\": 2.536523
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/engine/getDetailsV2"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "org_id": "voluptatem",
    "dt_from": "2025-09-08",
    "dt_to": "2025-09-08",
    "week_count": 2.536523
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/engine/getDetailsV2

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

org_id   string   

Example: voluptatem

dt_from   string   

Must be a valid date. Must be a valid date in the format Y-m-d. Example: 2025-09-08

dt_to   string   

Must be a valid date. Must be a valid date in the format Y-m-d. Example: 2025-09-08

week_count   number   

Example: 2.536523

POST api/engine/exportCSV

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/engine/exportCSV" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"org_id\": \"sed\",
    \"dt_from\": \"2025-09-08\",
    \"dt_to\": \"2025-09-08\",
    \"week_count\": 293.8
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/engine/exportCSV"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "org_id": "sed",
    "dt_from": "2025-09-08",
    "dt_to": "2025-09-08",
    "week_count": 293.8
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/engine/exportCSV

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

org_id   string   

Example: sed

dt_from   string   

Must be a valid date. Must be a valid date in the format Y-m-d. Example: 2025-09-08

dt_to   string   

Must be a valid date. Must be a valid date in the format Y-m-d. Example: 2025-09-08

week_count   number   

Example: 293.8

GET api/invite/listForOrganization/{organization_id}

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/invite/listForOrganization/tenetur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/invite/listForOrganization/tenetur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/invite/listForOrganization/{organization_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

organization_id   string   

The ID of the organization. Example: tenetur

GET api/invite/listForEmail/{email}

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/invite/listForEmail/larissa.cruickshank@example.com" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/invite/listForEmail/larissa.cruickshank@example.com"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/invite/listForEmail/{email}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

email   string   

Example: larissa.cruickshank@example.com

GET api/invite/listForOwner

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/invite/listForOwner" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/invite/listForOwner"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/invite/listForOwner

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/invite/sendInviteByAdmin

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/invite/sendInviteByAdmin" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": \"qui\",
    \"email\": \"emiliano47@example.org\",
    \"name\": \"doloremque\",
    \"permission_type\": \"facere\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/invite/sendInviteByAdmin"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": "qui",
    "email": "emiliano47@example.org",
    "name": "doloremque",
    "permission_type": "facere"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/invite/sendInviteByAdmin

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

organization_id   string   

Example: qui

email   string   

Must be a valid email address. Example: emiliano47@example.org

name   string  optional  

Example: doloremque

permission_type   string   

Example: facere

GET api/invite/resendInvite/{id}

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/invite/resendInvite/sapiente" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/invite/resendInvite/sapiente"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/invite/resendInvite/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the resendInvite. Example: sapiente

GET api/invite/accept/{hash}

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/invite/accept/numquam" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/invite/accept/numquam"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (422):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Record  does not exist",
    "errors": {
        "id": [
            "Invalid Invite "
        ]
    }
}

Request   

GET api/invite/accept/{hash}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

hash   string   

Example: numquam

POST api/invite/updatePermissionType

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/invite/updatePermissionType" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"minus\",
    \"permission_type\": \"voluptas\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/invite/updatePermissionType"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "id": "minus",
    "permission_type": "voluptas"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/invite/updatePermissionType

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

id   string   

Example: minus

permission_type   string   

Example: voluptas

GET api/org/getActiveForUser

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/org/getActiveForUser" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/org/getActiveForUser"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (500):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Server Error"
}

Request   

GET api/org/getActiveForUser

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/org/listOwndedOrganizations

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/org/listOwndedOrganizations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/org/listOwndedOrganizations"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/org/listOwndedOrganizations

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/org/listWithMembers

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/org/listWithMembers" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/org/listWithMembers"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/org/listWithMembers

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/org/search" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"kw\": \"quisquam\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/org/search"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "kw": "quisquam"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

[]

DELETE api/org/incomplete

Example request:
curl --request DELETE \
    "https://prod.forecastedfinance.com/api/api/org/incomplete" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/org/incomplete"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/org/incomplete

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/org

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/org" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/org"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/org

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/org/{id}

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/org/culpa" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/org/culpa"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/org/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the org. Example: culpa

POST api/org/setupBalance/{organization_id}

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/org/setupBalance/est" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"initial_balance\": 3371322.877962,
    \"start_date\": \"2025-09-08\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/org/setupBalance/est"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "initial_balance": 3371322.877962,
    "start_date": "2025-09-08"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/org/setupBalance/{organization_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

organization_id   string   

The ID of the organization. Example: est

Body Parameters

initial_balance   number   

Example: 3371322.877962

start_date   string   

Must be a valid date in the format Y-m-d. Example: 2025-09-08

POST api/org

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/org" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\",
    \"currency\": \"rem\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/org"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "consequatur",
    "currency": "rem"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/org

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Example: consequatur

currency   string   

Example: rem

POST api/org/createWithBalanceAndDate

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/org/createWithBalanceAndDate" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"est\",
    \"currency\": \"earum\",
    \"initial_balance\": \"quod\",
    \"start_date\": \"2025-09-08\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/org/createWithBalanceAndDate"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "est",
    "currency": "earum",
    "initial_balance": "quod",
    "start_date": "2025-09-08"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/org/createWithBalanceAndDate

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Example: est

currency   string   

Example: earum

initial_balance   string   

Example: quod

start_date   string   

Must be a valid date in the format Y-m-d. Example: 2025-09-08

POST api/org/updateForecastGenerationType/{id}

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/org/updateForecastGenerationType/corporis" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"forecast_generation_type\": \"aut\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/org/updateForecastGenerationType/corporis"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "forecast_generation_type": "aut"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/org/updateForecastGenerationType/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the updateForecastGenerationType. Example: corporis

Body Parameters

forecast_generation_type   string   

Example: aut

POST api/org/updateInitialBalanceAndStartDate/{id}

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/org/updateInitialBalanceAndStartDate/nihil" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"initial_balance\": \"et\",
    \"start_date\": \"2025-09-08\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/org/updateInitialBalanceAndStartDate/nihil"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "initial_balance": "et",
    "start_date": "2025-09-08"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/org/updateInitialBalanceAndStartDate/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the updateInitialBalanceAndStartDate. Example: nihil

Body Parameters

initial_balance   string   

Example: et

start_date   string   

Must be a valid date in the format Y-m-d. Example: 2025-09-08

PUT api/org/{id}

Example request:
curl --request PUT \
    "https://prod.forecastedfinance.com/api/api/org/atque" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"maiores\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/org/atque"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "maiores"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PUT api/org/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the org. Example: atque

Body Parameters

name   string   

Example: maiores

DELETE api/org/{id}

Example request:
curl --request DELETE \
    "https://prod.forecastedfinance.com/api/api/org/voluptatem" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/org/voluptatem"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/org/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the org. Example: voluptatem

POST api/org/updateStatus

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/org/updateStatus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"laborum\",
    \"status\": \"qui\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/org/updateStatus"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "id": "laborum",
    "status": "qui"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/org/updateStatus

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

id   string   

Example: laborum

status   string   

Example: qui

POST api/org-user

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/org-user" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": \"accusamus\",
    \"organization_id\": \"earum\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/org-user"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user_id": "accusamus",
    "organization_id": "earum"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/org-user

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

user_id   string   

Example: accusamus

organization_id   string   

Example: earum

POST api/org-user/delete

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/org-user/delete" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": \"ducimus\",
    \"organization_id\": \"sint\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/org-user/delete"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user_id": "ducimus",
    "organization_id": "sint"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/org-user/delete

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

user_id   string   

Example: ducimus

organization_id   string   

Example: sint

POST api/org-user/assignOrg

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/org-user/assignOrg" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": \"fugiat\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/org-user/assignOrg"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": "fugiat"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/org-user/assignOrg

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

organization_id   string   

Example: fugiat

POST api/org-user/joinRequest/{organization_id}

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/org-user/joinRequest/repellat" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/org-user/joinRequest/repellat"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST api/org-user/joinRequest/{organization_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

organization_id   string   

The ID of the organization. Example: repellat

GET api/org-user/getPendingOrgList

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/org-user/getPendingOrgList" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/org-user/getPendingOrgList"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/org-user/getPendingOrgList

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/org-user/getPendingListForOrganization/{organization_id}

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/org-user/getPendingListForOrganization/nulla" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/org-user/getPendingListForOrganization/nulla"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/org-user/getPendingListForOrganization/{organization_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

organization_id   string   

The ID of the organization. Example: nulla

GET api/org-user/getPendingListForOwner

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/org-user/getPendingListForOwner" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/org-user/getPendingListForOwner"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/org-user/getPendingListForOwner

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/org-user/getPendingListForUser

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/org-user/getPendingListForUser" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/org-user/getPendingListForUser"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/org-user/getPendingListForUser

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/org-user/updateStatus

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/org-user/updateStatus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"iusto\",
    \"status\": \"sed\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/org-user/updateStatus"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "id": "iusto",
    "status": "sed"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/org-user/updateStatus

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

id   string   

Example: iusto

status   string   

Example: sed

GET api/org-user/pendingRequestsForOwndedOrganizations

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/org-user/pendingRequestsForOwndedOrganizations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/org-user/pendingRequestsForOwndedOrganizations"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/org-user/pendingRequestsForOwndedOrganizations

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/organization-image/store-image

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/organization-image/store-image" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "id=ut"\
    --form "file=@/tmp/phptw3xC6" 
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/organization-image/store-image"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('id', 'ut');
body.append('file', document.querySelector('input[name="file"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request   

POST api/organization-image/store-image

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

id   string   

Example: ut

file   file   

Must be a file. Must not be greater than 16384 kilobytes. Example: /tmp/phptw3xC6

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/password-recovery/send-password-recovery-link" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"rossie25@example.org\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/password-recovery/send-password-recovery-link"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "rossie25@example.org"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

POST api/password-recovery/initiate-password-recovery

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/password-recovery/initiate-password-recovery" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"santino74@example.com\",
    \"otp\": \"439329\",
    \"salt\": \"culpa\",
    \"password\": \"laboriosam\",
    \"confirm_password\": \"repellat\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/password-recovery/initiate-password-recovery"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "santino74@example.com",
    "otp": "439329",
    "salt": "culpa",
    "password": "laboriosam",
    "confirm_password": "repellat"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/password-recovery/initiate-password-recovery

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

Must be a valid email address. Example: santino74@example.com

otp   string   

Must match the regex /^[0-9]{6}$/. Example: 439329

salt   string   

Example: culpa

password   string   

Example: laboriosam

confirm_password   string   

Example: repellat

GET api/stripe-customer/addStripeCustomerIdTouser/{id}

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/stripe-customer/addStripeCustomerIdTouser/quasi" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/stripe-customer/addStripeCustomerIdTouser/quasi"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/stripe-customer/addStripeCustomerIdTouser/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the addStripeCustomerIdTouser. Example: quasi

GET api/stripe-customer/getCustomer/{stripe_customer_id}

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/stripe-customer/getCustomer/doloribus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/stripe-customer/getCustomer/doloribus"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/stripe-customer/getCustomer/{stripe_customer_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

stripe_customer_id   string   

The ID of the stripe customer. Example: doloribus

GET api/stripe-product/listAllProducts

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/stripe-product/listAllProducts" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/stripe-product/listAllProducts"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "object": "list",
    "data": [
        {
            "id": "prod_SY8TPhLkPwr5X9",
            "object": "product",
            "active": true,
            "attributes": [],
            "created": 1750653684,
            "default_price": "price_1Rd2C9RvbeGYHkrCqglc2zgS",
            "description": "Basic Monthly",
            "images": [],
            "livemode": true,
            "marketing_features": [],
            "metadata": [],
            "name": "Basic Monthly",
            "package_dimensions": null,
            "shippable": null,
            "statement_descriptor": null,
            "tax_code": "txcd_10000000",
            "type": "service",
            "unit_label": null,
            "updated": 1750653685,
            "url": null
        },
        {
            "id": "prod_SY8S6cyjSitO90",
            "object": "product",
            "active": true,
            "attributes": [],
            "created": 1750653662,
            "default_price": "price_1Rd2BnRvbeGYHkrCWN5JL97o",
            "description": "Basic Yearly",
            "images": [],
            "livemode": true,
            "marketing_features": [],
            "metadata": [],
            "name": "Basic Yearly",
            "package_dimensions": null,
            "shippable": null,
            "statement_descriptor": null,
            "tax_code": "txcd_10000000",
            "type": "service",
            "unit_label": null,
            "updated": 1750653663,
            "url": null
        },
        {
            "id": "prod_SY8SArM4qEKZUs",
            "object": "product",
            "active": true,
            "attributes": [],
            "created": 1750653630,
            "default_price": "price_1Rd2BHRvbeGYHkrCScsv04kd",
            "description": "Business Monthly",
            "images": [],
            "livemode": true,
            "marketing_features": [],
            "metadata": [],
            "name": "Business Monthly",
            "package_dimensions": null,
            "shippable": null,
            "statement_descriptor": null,
            "tax_code": "txcd_10000000",
            "type": "service",
            "unit_label": null,
            "updated": 1750653631,
            "url": null
        },
        {
            "id": "prod_SY8RM22KYK3flb",
            "object": "product",
            "active": true,
            "attributes": [],
            "created": 1750653594,
            "default_price": "price_1Rd2AgRvbeGYHkrCMpVPZ5Ga",
            "description": "Business Yearly",
            "images": [],
            "livemode": true,
            "marketing_features": [],
            "metadata": [],
            "name": "Business Yearly",
            "package_dimensions": null,
            "shippable": null,
            "statement_descriptor": null,
            "tax_code": "txcd_10000000",
            "type": "service",
            "unit_label": null,
            "updated": 1750653595,
            "url": null
        }
    ],
    "has_more": false,
    "url": "/v1/products"
}

Request   

GET api/stripe-product/listAllProducts

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/stripe-product/findProductByName

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/stripe-product/findProductByName" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"voluptatibus\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/stripe-product/findProductByName"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "voluptatibus"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "object": "search_result",
    "data": [],
    "has_more": false,
    "next_page": null,
    "url": "/v1/products/search"
}

Request   

GET api/stripe-product/findProductByName

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Example: voluptatibus

GET api/stripe-product/findProductById

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/stripe-product/findProductById" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"cupiditate\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/stripe-product/findProductById"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "id": "cupiditate"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{}

Request   

GET api/stripe-product/findProductById

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

id   string   

Example: cupiditate

POST api/stripe-product/createProduct

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/stripe-product/createProduct" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"dolorem\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/stripe-product/createProduct"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "dolorem"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/stripe-product/createProduct

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Example: dolorem

GET api/stripe-price/listAllPrices

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/stripe-price/listAllPrices" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/stripe-price/listAllPrices"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "object": "list",
    "data": [
        {
            "id": "price_1Rd2C9RvbeGYHkrCqglc2zgS",
            "object": "price",
            "active": true,
            "billing_scheme": "per_unit",
            "created": 1750653685,
            "currency": "usd",
            "custom_unit_amount": null,
            "livemode": true,
            "lookup_key": null,
            "metadata": [],
            "nickname": null,
            "product": "prod_SY8TPhLkPwr5X9",
            "recurring": {
                "interval": "month",
                "interval_count": 1,
                "meter": null,
                "trial_period_days": null,
                "usage_type": "licensed"
            },
            "tax_behavior": "unspecified",
            "tiers_mode": null,
            "transform_quantity": null,
            "type": "recurring",
            "unit_amount": 3900,
            "unit_amount_decimal": "3900"
        },
        {
            "id": "price_1Rd2BnRvbeGYHkrCWN5JL97o",
            "object": "price",
            "active": true,
            "billing_scheme": "per_unit",
            "created": 1750653663,
            "currency": "usd",
            "custom_unit_amount": null,
            "livemode": true,
            "lookup_key": null,
            "metadata": [],
            "nickname": null,
            "product": "prod_SY8S6cyjSitO90",
            "recurring": {
                "interval": "year",
                "interval_count": 1,
                "meter": null,
                "trial_period_days": null,
                "usage_type": "licensed"
            },
            "tax_behavior": "unspecified",
            "tiers_mode": null,
            "transform_quantity": null,
            "type": "recurring",
            "unit_amount": 37440,
            "unit_amount_decimal": "37440"
        },
        {
            "id": "price_1Rd2BHRvbeGYHkrCScsv04kd",
            "object": "price",
            "active": true,
            "billing_scheme": "per_unit",
            "created": 1750653631,
            "currency": "usd",
            "custom_unit_amount": null,
            "livemode": true,
            "lookup_key": null,
            "metadata": [],
            "nickname": null,
            "product": "prod_SY8SArM4qEKZUs",
            "recurring": {
                "interval": "month",
                "interval_count": 1,
                "meter": null,
                "trial_period_days": null,
                "usage_type": "licensed"
            },
            "tax_behavior": "unspecified",
            "tiers_mode": null,
            "transform_quantity": null,
            "type": "recurring",
            "unit_amount": 5900,
            "unit_amount_decimal": "5900"
        },
        {
            "id": "price_1Rd2AgRvbeGYHkrCMpVPZ5Ga",
            "object": "price",
            "active": true,
            "billing_scheme": "per_unit",
            "created": 1750653594,
            "currency": "usd",
            "custom_unit_amount": null,
            "livemode": true,
            "lookup_key": null,
            "metadata": [],
            "nickname": null,
            "product": "prod_SY8RM22KYK3flb",
            "recurring": {
                "interval": "year",
                "interval_count": 1,
                "meter": null,
                "trial_period_days": null,
                "usage_type": "licensed"
            },
            "tax_behavior": "unspecified",
            "tiers_mode": null,
            "transform_quantity": null,
            "type": "recurring",
            "unit_amount": 56640,
            "unit_amount_decimal": "56640"
        }
    ],
    "has_more": false,
    "url": "/v1/prices"
}

Request   

GET api/stripe-price/listAllPrices

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/stripe-price/priceListForProduct/{product_id}

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/stripe-price/priceListForProduct/et" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/stripe-price/priceListForProduct/et"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "object": "search_result",
    "data": [],
    "has_more": false,
    "next_page": null,
    "url": "/v1/prices/search"
}

Request   

GET api/stripe-price/priceListForProduct/{product_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

product_id   string   

The ID of the product. Example: et

POST api/stripe-price/createPrice

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/stripe-price/createPrice" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"product\": \"odit\",
    \"unit_amount\": 1816.7526099,
    \"interval\": \"ad\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/stripe-price/createPrice"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "product": "odit",
    "unit_amount": 1816.7526099,
    "interval": "ad"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/stripe-price/createPrice

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

product   string   

Example: odit

unit_amount   number   

Example: 1816.7526099

interval   string   

Example: ad

POST api/stripe-payment/attachPaymentMethod

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/stripe-payment/attachPaymentMethod" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"stripe_payment_method_id\": \"ut\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/stripe-payment/attachPaymentMethod"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "stripe_payment_method_id": "ut"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/stripe-payment/attachPaymentMethod

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

stripe_payment_method_id   string   

Example: ut

GET api/stripe-payment/paymentMethodListForStripeCustomer/{stripe_customer_id}

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/stripe-payment/paymentMethodListForStripeCustomer/veniam" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/stripe-payment/paymentMethodListForStripeCustomer/veniam"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/stripe-payment/paymentMethodListForStripeCustomer/{stripe_customer_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

stripe_customer_id   string   

The ID of the stripe customer. Example: veniam

GET api/stripe-subscription/findSubscription/{stripe_subscription_id}

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/stripe-subscription/findSubscription/perspiciatis" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/stripe-subscription/findSubscription/perspiciatis"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/stripe-subscription/findSubscription/{stripe_subscription_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

stripe_subscription_id   string   

The ID of the stripe subscription. Example: perspiciatis

GET api/stripe-subscription/subscriptionTrialCancel/{stripe_subscription_id}

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/stripe-subscription/subscriptionTrialCancel/in" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/stripe-subscription/subscriptionTrialCancel/in"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/stripe-subscription/subscriptionTrialCancel/{stripe_subscription_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

stripe_subscription_id   string   

The ID of the stripe subscription. Example: in

GET api/stripe-subscription/subscriptionCancel/{stripe_subscription_id}

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/stripe-subscription/subscriptionCancel/dicta" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/stripe-subscription/subscriptionCancel/dicta"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/stripe-subscription/subscriptionCancel/{stripe_subscription_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

stripe_subscription_id   string   

The ID of the stripe subscription. Example: dicta

POST api/stripe-subscription/createSubscription

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/stripe-subscription/createSubscription" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"stripe_payment_method_id\": \"unde\",
    \"price_id\": \"aut\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/stripe-subscription/createSubscription"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "stripe_payment_method_id": "unde",
    "price_id": "aut"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/stripe-subscription/createSubscription

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

stripe_payment_method_id   string   

Example: unde

price_id   string   

Example: aut

GET api/stripe-subscription/subscriptionListForCustomer/{stripe_customer_id}

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/stripe-subscription/subscriptionListForCustomer/officiis" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/stripe-subscription/subscriptionListForCustomer/officiis"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "object": "search_result",
    "data": [],
    "has_more": false,
    "next_page": null,
    "url": "/v1/subscriptions/search"
}

Request   

GET api/stripe-subscription/subscriptionListForCustomer/{stripe_customer_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

stripe_customer_id   string   

The ID of the stripe customer. Example: officiis

GET api/stripe-subscription/invoicesForCustomer/{stripe_customer_id}

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/stripe-subscription/invoicesForCustomer/alias" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/stripe-subscription/invoicesForCustomer/alias"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (500):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Server Error"
}

Request   

GET api/stripe-subscription/invoicesForCustomer/{stripe_customer_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

stripe_customer_id   string   

The ID of the stripe customer. Example: alias

POST api/stripe-subscription/updatePaymentMethod

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/stripe-subscription/updatePaymentMethod" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"stripe_subscription_id\": \"est\",
    \"stripe_payment_method_id\": \"totam\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/stripe-subscription/updatePaymentMethod"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "stripe_subscription_id": "est",
    "stripe_payment_method_id": "totam"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/stripe-subscription/updatePaymentMethod

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

stripe_subscription_id   string   

Example: est

stripe_payment_method_id   string   

Example: totam

GET api/stripe-payment-plan/listAll

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/stripe-payment-plan/listAll" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/stripe-payment-plan/listAll"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

[
    {
        "id": 1,
        "title": "Basic",
        "amount": 39,
        "monthly_or_yearly": "monthly",
        "stripe_price_id": "price_1Rd2C9RvbeGYHkrCqglc2zgS",
        "sub_title": "Perfect for solo entrepreneurs or freelancers just getting started.",
        "point_1": "Up to 3 organizations",
        "point_2": "2 user seats",
        "point_3": "Team collaboration features",
        "point_4": "Custom categories & advanced dashboards",
        "point_5": "",
        "point_6": "",
        "point_7": "",
        "point_8": "",
        "point_9": "",
        "point_10": "",
        "status": "ACTIVE",
        "created_at": "2025-06-24T18:04:29.000000Z",
        "updated_at": "2025-06-24T18:04:29.000000Z",
        "workspace_count": 1,
        "seat_count": 2,
        "stripe_product_id": "prod_SY8TPhLkPwr5X9"
    },
    {
        "id": 2,
        "title": "Business",
        "amount": 59,
        "monthly_or_yearly": "monthly",
        "stripe_price_id": "price_1Rd2BHRvbeGYHkrCScsv04kd",
        "sub_title": "Ideal for growing businesses with multiple clients or team members.",
        "point_1": "Up to 5 organizations",
        "point_2": "3 user seats",
        "point_3": "Team collaboration features",
        "point_4": "Custom categories & advanced dashboards",
        "point_5": "",
        "point_6": "",
        "point_7": "",
        "point_8": "",
        "point_9": "",
        "point_10": "",
        "status": "ACTIVE",
        "created_at": "2025-06-24T18:04:29.000000Z",
        "updated_at": "2025-06-24T18:04:29.000000Z",
        "workspace_count": 5,
        "seat_count": 3,
        "stripe_product_id": "prod_SY8SArM4qEKZUs"
    },
    {
        "id": 3,
        "title": "Basic",
        "amount": 374.4,
        "monthly_or_yearly": "yearly",
        "stripe_price_id": "price_1Rd2BnRvbeGYHkrCWN5JL97o",
        "sub_title": "Perfect for solo entrepreneurs or freelancers just getting started.",
        "point_1": "Up to 3 organizations",
        "point_2": "2 user seats",
        "point_3": "Team collaboration features",
        "point_4": "Custom categories & advanced dashboards",
        "point_5": "",
        "point_6": "",
        "point_7": "",
        "point_8": "",
        "point_9": "",
        "point_10": "",
        "status": "ACTIVE",
        "created_at": "2025-06-24T18:04:29.000000Z",
        "updated_at": "2025-06-24T18:04:29.000000Z",
        "workspace_count": 1,
        "seat_count": 2,
        "stripe_product_id": "prod_SY8S6cyjSitO90"
    },
    {
        "id": 4,
        "title": "Business",
        "amount": 566.4,
        "monthly_or_yearly": "yearly",
        "stripe_price_id": "price_1Rd2AgRvbeGYHkrCMpVPZ5Ga",
        "sub_title": "Ideal for growing businesses with multiple clients or team members.",
        "point_1": "Up to 5 organizations",
        "point_2": "3 user seats",
        "point_3": "Team collaboration features",
        "point_4": "Custom categories & advanced dashboards",
        "point_5": "",
        "point_6": "",
        "point_7": "",
        "point_8": "",
        "point_9": "",
        "point_10": "",
        "status": "ACTIVE",
        "created_at": "2025-06-24T18:04:29.000000Z",
        "updated_at": "2025-06-24T18:04:29.000000Z",
        "workspace_count": 5,
        "seat_count": 3,
        "stripe_product_id": "prod_SY8RM22KYK3flb"
    }
]

Request   

GET api/stripe-payment-plan/listAll

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/stripe-payment-plan/listAllActive

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/stripe-payment-plan/listAllActive" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/stripe-payment-plan/listAllActive"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

[
    {
        "id": 1,
        "title": "Basic",
        "amount": 39,
        "monthly_or_yearly": "monthly",
        "stripe_price_id": "price_1Rd2C9RvbeGYHkrCqglc2zgS",
        "sub_title": "Perfect for solo entrepreneurs or freelancers just getting started.",
        "point_1": "Up to 3 organizations",
        "point_2": "2 user seats",
        "point_3": "Team collaboration features",
        "point_4": "Custom categories & advanced dashboards",
        "point_5": "",
        "point_6": "",
        "point_7": "",
        "point_8": "",
        "point_9": "",
        "point_10": "",
        "status": "ACTIVE",
        "created_at": "2025-06-24T18:04:29.000000Z",
        "updated_at": "2025-06-24T18:04:29.000000Z",
        "workspace_count": 1,
        "seat_count": 2,
        "stripe_product_id": "prod_SY8TPhLkPwr5X9"
    },
    {
        "id": 2,
        "title": "Business",
        "amount": 59,
        "monthly_or_yearly": "monthly",
        "stripe_price_id": "price_1Rd2BHRvbeGYHkrCScsv04kd",
        "sub_title": "Ideal for growing businesses with multiple clients or team members.",
        "point_1": "Up to 5 organizations",
        "point_2": "3 user seats",
        "point_3": "Team collaboration features",
        "point_4": "Custom categories & advanced dashboards",
        "point_5": "",
        "point_6": "",
        "point_7": "",
        "point_8": "",
        "point_9": "",
        "point_10": "",
        "status": "ACTIVE",
        "created_at": "2025-06-24T18:04:29.000000Z",
        "updated_at": "2025-06-24T18:04:29.000000Z",
        "workspace_count": 5,
        "seat_count": 3,
        "stripe_product_id": "prod_SY8SArM4qEKZUs"
    },
    {
        "id": 3,
        "title": "Basic",
        "amount": 374.4,
        "monthly_or_yearly": "yearly",
        "stripe_price_id": "price_1Rd2BnRvbeGYHkrCWN5JL97o",
        "sub_title": "Perfect for solo entrepreneurs or freelancers just getting started.",
        "point_1": "Up to 3 organizations",
        "point_2": "2 user seats",
        "point_3": "Team collaboration features",
        "point_4": "Custom categories & advanced dashboards",
        "point_5": "",
        "point_6": "",
        "point_7": "",
        "point_8": "",
        "point_9": "",
        "point_10": "",
        "status": "ACTIVE",
        "created_at": "2025-06-24T18:04:29.000000Z",
        "updated_at": "2025-06-24T18:04:29.000000Z",
        "workspace_count": 1,
        "seat_count": 2,
        "stripe_product_id": "prod_SY8S6cyjSitO90"
    },
    {
        "id": 4,
        "title": "Business",
        "amount": 566.4,
        "monthly_or_yearly": "yearly",
        "stripe_price_id": "price_1Rd2AgRvbeGYHkrCMpVPZ5Ga",
        "sub_title": "Ideal for growing businesses with multiple clients or team members.",
        "point_1": "Up to 5 organizations",
        "point_2": "3 user seats",
        "point_3": "Team collaboration features",
        "point_4": "Custom categories & advanced dashboards",
        "point_5": "",
        "point_6": "",
        "point_7": "",
        "point_8": "",
        "point_9": "",
        "point_10": "",
        "status": "ACTIVE",
        "created_at": "2025-06-24T18:04:29.000000Z",
        "updated_at": "2025-06-24T18:04:29.000000Z",
        "workspace_count": 5,
        "seat_count": 3,
        "stripe_product_id": "prod_SY8RM22KYK3flb"
    }
]

Request   

GET api/stripe-payment-plan/listAllActive

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/stripe-payment-plan/findByStripePriceId/{stripe_price_id}

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/stripe-payment-plan/findByStripePriceId/sint" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/stripe-payment-plan/findByStripePriceId/sint"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{}

Request   

GET api/stripe-payment-plan/findByStripePriceId/{stripe_price_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

stripe_price_id   string   

The ID of the stripe price. Example: sint

POST api/stripe-payment-intent/create

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/stripe-payment-intent/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"amount\": 6.0927,
    \"stripe_price_id\": \"nihil\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/stripe-payment-intent/create"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "amount": 6.0927,
    "stripe_price_id": "nihil"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/stripe-payment-intent/create

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

amount   number   

Example: 6.0927

stripe_price_id   string  optional  

Example: nihil

GET api/stripe-payment-intent/listForCustomer/{stripe_customer_id}

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/stripe-payment-intent/listForCustomer/nam" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/stripe-payment-intent/listForCustomer/nam"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/stripe-payment-intent/listForCustomer/{stripe_customer_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

stripe_customer_id   string   

The ID of the stripe customer. Example: nam

GET api/getEventFromStripeWebhook

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/getEventFromStripeWebhook" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/getEventFromStripeWebhook"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (500):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Server Error"
}

Request   

GET api/getEventFromStripeWebhook

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/getEventFromStripeWebhook

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/getEventFromStripeWebhook" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/getEventFromStripeWebhook"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST api/getEventFromStripeWebhook

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/stripe-user/listSubscriptions

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/stripe-user/listSubscriptions" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/stripe-user/listSubscriptions"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/stripe-user/listSubscriptions

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/stripe-user/listPaymentMethods

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/stripe-user/listPaymentMethods" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/stripe-user/listPaymentMethods"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/stripe-user/listPaymentMethods

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/stripe-user/listStripeCustomers

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/stripe-user/listStripeCustomers" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/stripe-user/listStripeCustomers"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/stripe-user/listStripeCustomers

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/transactions/listPaginated

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/transactions/listPaginated" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"page\": 8,
    \"page_size\": 10
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/transactions/listPaginated"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "page": 8,
    "page_size": 10
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/transactions/listPaginated

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

page   integer   

Example: 8

page_size   integer   

Example: 10

POST api/transactions/assignVendor

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/transactions/assignVendor" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"vendor_id\": 2.890354,
    \"transaction_id\": 11.62063
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/transactions/assignVendor"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "vendor_id": 2.890354,
    "transaction_id": 11.62063
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/transactions/assignVendor

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

vendor_id   number   

Example: 2.890354

transaction_id   number   

Example: 11.62063

POST api/transactions/updateOneTimeStatus

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/transactions/updateOneTimeStatus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"transaction_id\": 6003.56,
    \"is_one_time_event\": \"est\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/transactions/updateOneTimeStatus"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "transaction_id": 6003.56,
    "is_one_time_event": "est"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/transactions/updateOneTimeStatus

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

transaction_id   number   

Example: 6003.56

is_one_time_event   string   

Example: est

POST api/transactions/updateVendorCategory

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/transactions/updateVendorCategory" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"transaction_id\": 94956677.174,
    \"vcategory_id\": 1.503660551
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/transactions/updateVendorCategory"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "transaction_id": 94956677.174,
    "vcategory_id": 1.503660551
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/transactions/updateVendorCategory

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

transaction_id   number   

Example: 94956677.174

vcategory_id   number   

Example: 1.503660551

POST api/transactions/updateVendorDescription

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/transactions/updateVendorDescription" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"transaction_id\": 1090.62,
    \"description\": \"facilis\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/transactions/updateVendorDescription"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "transaction_id": 1090.62,
    "description": "facilis"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/transactions/updateVendorDescription

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

transaction_id   number   

Example: 1090.62

description   string   

Example: facilis

DELETE api/transactions/deleteMaster/{id}

Example request:
curl --request DELETE \
    "https://prod.forecastedfinance.com/api/api/transactions/deleteMaster/debitis" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/transactions/deleteMaster/debitis"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/transactions/deleteMaster/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the deleteMaster. Example: debitis

DELETE api/transactions/deleteTransaction/{id}

Example request:
curl --request DELETE \
    "https://prod.forecastedfinance.com/api/api/transactions/deleteTransaction/sit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/transactions/deleteTransaction/sit"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/transactions/deleteTransaction/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the deleteTransaction. Example: sit

POST api/transactions/listVendorsForDescription

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/transactions/listVendorsForDescription" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"quia\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/transactions/listVendorsForDescription"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "description": "quia"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/transactions/listVendorsForDescription

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

description   string   

Example: quia

GET api/transactions/getLastBatchId

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/transactions/getLastBatchId" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/transactions/getLastBatchId"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/transactions/getLastBatchId

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/transactions/calculateVendorsForBatch/{batch_id}

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/transactions/calculateVendorsForBatch/aut" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/transactions/calculateVendorsForBatch/aut"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/transactions/calculateVendorsForBatch/{batch_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

batch_id   string   

The ID of the batch. Example: aut

GET api/transactions/calculateVendorsForBatchV2/{batch_id}

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/transactions/calculateVendorsForBatchV2/corporis" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/transactions/calculateVendorsForBatchV2/corporis"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/transactions/calculateVendorsForBatchV2/{batch_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

batch_id   string   

The ID of the batch. Example: corporis

POST api/transactions/splitTransaction

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/transactions/splitTransaction" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/transactions/splitTransaction"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST api/transactions/splitTransaction

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/transaction-master/listPaginated

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/transaction-master/listPaginated" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"org_id\": 2,
    \"page\": 17,
    \"page_size\": 5
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/transaction-master/listPaginated"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "org_id": 2,
    "page": 17,
    "page_size": 5
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/transaction-master/listPaginated

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

org_id   integer   

Example: 2

page   integer   

Example: 17

page_size   integer   

Example: 5

POST api/transaction-master/findAllChildren/{id}

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/transaction-master/findAllChildren/officia" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"org_id\": 19
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/transaction-master/findAllChildren/officia"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "org_id": 19
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/transaction-master/findAllChildren/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the findAllChild. Example: officia

Body Parameters

org_id   integer   

Example: 19

POST api/transaction-master/updateNameAndDate/{id}

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/transaction-master/updateNameAndDate/sapiente" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"transaction_name\": \"et\",
    \"start_date\": \"2025-09-08\",
    \"end_date\": \"2025-09-08\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/transaction-master/updateNameAndDate/sapiente"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "transaction_name": "et",
    "start_date": "2025-09-08",
    "end_date": "2025-09-08"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/transaction-master/updateNameAndDate/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the updateNameAndDate. Example: sapiente

Body Parameters

transaction_name   string   

Example: et

start_date   string   

Must be a valid date. Must be a valid date in the format Y-m-d. Example: 2025-09-08

end_date   string   

Must be a valid date. Must be a valid date in the format Y-m-d. Example: 2025-09-08

POST api/user-image/store-image

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/user-image/store-image" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "id=amet"\
    --form "file=@/tmp/php12ifJO" 
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/user-image/store-image"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('id', 'amet');
body.append('file', document.querySelector('input[name="file"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request   

POST api/user-image/store-image

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

id   string   

Example: amet

file   file   

Must be a file. Must not be greater than 16384 kilobytes. Example: /tmp/php12ifJO

POST api/uploader/uploadCsv/{id}

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/uploader/uploadCsv/est" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "file=@/tmp/phpGbD3mT" 
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/uploader/uploadCsv/est"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('file', document.querySelector('input[name="file"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request   

POST api/uploader/uploadCsv/{id}

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the uploadCsv. Example: est

Body Parameters

file   file   

Must be a file. Must not be greater than 2048 kilobytes. Example: /tmp/phpGbD3mT

GET api/vendors

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/vendors" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/vendors"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/vendors

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/vendors/findVendorWithCategory/{id}

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/vendors/findVendorWithCategory/cupiditate" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/vendors/findVendorWithCategory/cupiditate"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/vendors/findVendorWithCategory/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the findVendorWithCategory. Example: cupiditate

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/vendors/search" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/vendors/search"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

POST api/vendors

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/vendors" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"debitis\",
    \"vcategory_id\": 1344.27
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/vendors"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "debitis",
    "vcategory_id": 1344.27
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/vendors

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Example: debitis

vcategory_id   number   

Example: 1344.27

POST api/vendors/updateCategory

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/vendors/updateCategory" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"vendor_id\": 30.884423536,
    \"vcategory_id\": 5471.0038393
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/vendors/updateCategory"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "vendor_id": 30.884423536,
    "vcategory_id": 5471.0038393
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/vendors/updateCategory

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

vendor_id   number   

Example: 30.884423536

vcategory_id   number   

Example: 5471.0038393

POST api/vendors/updateName

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/vendors/updateName" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"vendor_id\": 61013478.252,
    \"name\": \"quasi\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/vendors/updateName"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "vendor_id": 61013478.252,
    "name": "quasi"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/vendors/updateName

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

vendor_id   number   

Example: 61013478.252

name   string   

Example: quasi

POST api/vendors/updateStatus

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/vendors/updateStatus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"vendor_id\": 39449.18655783,
    \"status\": \"nobis\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/vendors/updateStatus"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "vendor_id": 39449.18655783,
    "status": "nobis"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/vendors/updateStatus

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

vendor_id   number   

Example: 39449.18655783

status   string   

Example: nobis

GET api/vendors/searchPaginated

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/vendors/searchPaginated" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"page\": 1,
    \"page_size\": 4,
    \"kw\": \"quidem\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/vendors/searchPaginated"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "page": 1,
    "page_size": 4,
    "kw": "quidem"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/vendors/searchPaginated

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

page   integer   

Example: 1

page_size   integer   

Example: 4

kw   string  optional  

Example: quidem

POST api/vendors/mergeVendors

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/vendors/mergeVendors" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id1\": 2,
    \"id2\": 16
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/vendors/mergeVendors"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "id1": 2,
    "id2": 16
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/vendors/mergeVendors

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

id1   integer   

Example: 2

id2   integer   

Example: 16

DELETE api/vendors/{id}

Example request:
curl --request DELETE \
    "https://prod.forecastedfinance.com/api/api/vendors/sint" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/vendors/sint"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/vendors/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the vendor. Example: sint

GET api/vendor-categories

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/vendor-categories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/vendor-categories"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/vendor-categories

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/vendor-categories/assoc

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/vendor-categories/assoc" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/vendor-categories/assoc"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/vendor-categories/assoc

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/vendor-categories/updateStatus

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/vendor-categories/updateStatus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 7372.6942,
    \"status\": \"omnis\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/vendor-categories/updateStatus"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "id": 7372.6942,
    "status": "omnis"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/vendor-categories/updateStatus

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

id   number   

Example: 7372.6942

status   string   

Example: omnis

POST api/vendor-categories/create

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/vendor-categories/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"sit\",
    \"category_type\": \"repellendus\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/vendor-categories/create"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "sit",
    "category_type": "repellendus"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/vendor-categories/create

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Example: sit

category_type   string   

Example: repellendus

GET api/vendor-categories-for-org/{organization_id}

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/vendor-categories-for-org/quisquam" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/vendor-categories-for-org/quisquam"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/vendor-categories-for-org/{organization_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

organization_id   string   

The ID of the organization. Example: quisquam

GET api/vendor-categories-for-org/assoc/{organization_id}

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/vendor-categories-for-org/assoc/voluptates" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/vendor-categories-for-org/assoc/voluptates"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request   

GET api/vendor-categories-for-org/assoc/{organization_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

organization_id   string   

The ID of the organization. Example: voluptates

POST api/vendor-categories-for-org/updateStatus

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/vendor-categories-for-org/updateStatus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 99877.83,
    \"status\": \"et\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/vendor-categories-for-org/updateStatus"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "id": 99877.83,
    "status": "et"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/vendor-categories-for-org/updateStatus

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

id   number   

Example: 99877.83

status   string   

Example: et

POST api/vendor-categories-for-org/updateRecurrence

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/vendor-categories-for-org/updateRecurrence" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 9094,
    \"recurrence\": \"consequatur\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/vendor-categories-for-org/updateRecurrence"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "id": 9094,
    "recurrence": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/vendor-categories-for-org/updateRecurrence

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

id   number   

Example: 9094

recurrence   string   

Example: consequatur

POST api/vendor-categories-for-org/create/{organization_id}

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/vendor-categories-for-org/create/ad" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"et\",
    \"category_type\": \"autem\"
}"

const url = new URL(
    "https://prod.forecastedfinance.com/api/api/vendor-categories-for-org/create/ad"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "et",
    "category_type": "autem"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/vendor-categories-for-org/create/{organization_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

organization_id   string   

The ID of the organization. Example: ad

Body Parameters

name   string   

Example: et

category_type   string   

Example: autem

DELETE api/vendor-categories-for-org/{id}

Example request:
curl --request DELETE \
    "https://prod.forecastedfinance.com/api/api/vendor-categories-for-org/et" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/vendor-categories-for-org/et"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/vendor-categories-for-org/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the vendor categories for org. Example: et

POST api/test-csv/upload

Example request:
curl --request POST \
    "https://prod.forecastedfinance.com/api/api/test-csv/upload" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "file=@/tmp/php4Hf8zO" 
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/test-csv/upload"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('file', document.querySelector('input[name="file"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request   

POST api/test-csv/upload

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

file   file   

Must be a file. Must not be greater than 2048 kilobytes. Example: /tmp/php4Hf8zO

GET api/testEmail

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/testEmail" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/testEmail"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

"DISABLED"

Request   

GET api/testEmail

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/test

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/test" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/test"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (500):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Server Error"
}

Request   

GET api/test

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/test-ai

Example request:
curl --request GET \
    --get "https://prod.forecastedfinance.com/api/api/test-ai" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://prod.forecastedfinance.com/api/api/test-ai"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (500):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Server Error"
}

Request   

GET api/test-ai

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json