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://api.forecastedfinance.com/api/api/admin-price/listAllPrices" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/admin-price/listAllProducts" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/admin-price/listAllPaymentPlans" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/admin-price/createPrice" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"product\": \"est\",
    \"unit_amount\": 242,
    \"interval\": \"impedit\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/admin-price/createPrice"
);

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

let body = {
    "product": "est",
    "unit_amount": 242,
    "interval": "impedit"
};

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: est

unit_amount   number   

Example: 242

interval   string   

Example: impedit

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

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/admin-price/updatePaymentPlan/inventore" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"unit_amount\": 583.4
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/admin-price/updatePaymentPlan/inventore"
);

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

let body = {
    "unit_amount": 583.4
};

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: inventore

Body Parameters

unit_amount   number   

Example: 583.4

GET api/admin-subscription/listAllSubcriptions

Example request:
curl --request GET \
    --get "https://api.forecastedfinance.com/api/api/admin-subscription/listAllSubcriptions" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/admin-subscription/getInvoicesForSubscription/numquam" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/admin-subscription/getInvoicesForSubscription/numquam"
);

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: numquam

GET api/admin-users/listUsers

Example request:
curl --request GET \
    --get "https://api.forecastedfinance.com/api/api/admin-users/listUsers" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"page\": \"atque\",
    \"kw\": \"dolorem\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/admin-users/listUsers"
);

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

let body = {
    "page": "atque",
    "kw": "dolorem"
};

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: atque

kw   string  optional  

Example: dolorem

GET api/admin-users/updateStatus

Example request:
curl --request GET \
    --get "https://api.forecastedfinance.com/api/api/admin-users/updateStatus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"doloribus\",
    \"status\": \"asperiores\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/admin-users/updateStatus"
);

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

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

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: doloribus

status   string   

Example: asperiores

POST api/assumptions

Example request:
curl --request POST \
    "https://api.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\": 3333.652231437,
    \"amount\": 0.8109,
    \"percent_or_value\": \"iure\",
    \"description\": \"aperiam\",
    \"assumption_type\": \"velit\",
    \"categories_csv\": \"asperiores\"
}"
const url = new URL(
    "https://api.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": 3333.652231437,
    "amount": 0.8109,
    "percent_or_value": "iure",
    "description": "aperiam",
    "assumption_type": "velit",
    "categories_csv": "asperiores"
};

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: 3333.652231437

amount   number   

Example: 0.8109

percent_or_value   string   

Example: iure

description   string   

Example: aperiam

assumption_type   string   

Example: velit

categories_csv   string  optional  

Example: asperiores

POST api/assumptions/update/{assumption_master_id}

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/assumptions/update/ut" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"org_id\": 1.5,
    \"dt_from\": \"2025-09-08\",
    \"dt_to\": \"2025-09-08\",
    \"amount\": 1001151,
    \"percent_or_value\": \"placeat\",
    \"description\": \"sed\",
    \"assumption_type\": \"ipsum\",
    \"categories_csv\": \"est\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/assumptions/update/ut"
);

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

let body = {
    "org_id": 1.5,
    "dt_from": "2025-09-08",
    "dt_to": "2025-09-08",
    "amount": 1001151,
    "percent_or_value": "placeat",
    "description": "sed",
    "assumption_type": "ipsum",
    "categories_csv": "est"
};

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: ut

Body Parameters

org_id   number   

Example: 1.5

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: 1001151

percent_or_value   string   

Example: placeat

description   string   

Example: sed

assumption_type   string   

Example: ipsum

categories_csv   string  optional  

Example: est

GET api/assumptions/listPaginatedMasterForOrganization

Example request:
curl --request GET \
    --get "https://api.forecastedfinance.com/api/api/assumptions/listPaginatedMasterForOrganization" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"org_id\": 5,
    \"page\": 20,
    \"page_size\": 11
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/assumptions/listPaginatedMasterForOrganization"
);

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

let body = {
    "org_id": 5,
    "page": 20,
    "page_size": 11
};

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: 5

page   integer   

Example: 20

page_size   integer   

Example: 11

GET api/assumptions/assumptionDetails/{master_id}

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

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: harum

DELETE api/assumptions/deleteMaster/{id}

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

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: harum

POST api/assumptions-v2/createMaster

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/assumptions-v2/createMaster" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"org_id\": 1695.08,
    \"description\": \"aliquam\",
    \"dt_from\": \"2025-09-08\",
    \"dt_to\": \"2025-09-08\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/assumptions-v2/createMaster"
);

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

let body = {
    "org_id": 1695.08,
    "description": "aliquam",
    "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: 1695.08

description   string   

Example: aliquam

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://api.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\": 222185.7458242,
    \"percent_or_value\": \"est\",
    \"assumption_type\": \"aut\",
    \"master_id\": \"maxime\",
    \"vcategory_id\": \"sapiente\"
}"
const url = new URL(
    "https://api.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": 222185.7458242,
    "percent_or_value": "est",
    "assumption_type": "aut",
    "master_id": "maxime",
    "vcategory_id": "sapiente"
};

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: 222185.7458242

percent_or_value   string   

Example: est

assumption_type   string   

Example: aut

master_id   string   

Example: maxime

vcategory_id   string   

Example: sapiente

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

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/assumptions-v2/editChild/quas" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"dt_from\": \"2025-09-08\",
    \"dt_to\": \"2025-09-08\",
    \"amount\": 7861.80319002,
    \"percent_or_value\": \"amet\",
    \"assumption_type\": \"est\",
    \"vcategory_id\": \"et\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/assumptions-v2/editChild/quas"
);

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

let body = {
    "dt_from": "2025-09-08",
    "dt_to": "2025-09-08",
    "amount": 7861.80319002,
    "percent_or_value": "amet",
    "assumption_type": "est",
    "vcategory_id": "et"
};

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: quas

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: 7861.80319002

percent_or_value   string   

Example: amet

assumption_type   string   

Example: est

vcategory_id   string   

Example: et

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

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

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: rerum

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

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

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: deleniti

vcategory_id   string   

The ID of the vcategory. Example: id

POST api/auth/login

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/auth/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"viola.bernier@example.net\",
    \"password\": \"dignissimos\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/auth/login"
);

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

let body = {
    "email": "viola.bernier@example.net",
    "password": "dignissimos"
};

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: viola.bernier@example.net

password   string   

Example: dignissimos

POST api/auth/register

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/auth/register" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"fwyman@example.net\",
    \"password\": \"hic\",
    \"name\": \"saepe\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/auth/register"
);

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

let body = {
    "email": "fwyman@example.net",
    "password": "hic",
    "name": "saepe"
};

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: fwyman@example.net

password   string   

Example: hic

name   string   

Example: saepe

GET api/auth/getUser

Example request:
curl --request GET \
    --get "https://api.forecastedfinance.com/api/api/auth/getUser" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/auth/logout" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/auth/updateNameEmailAndPassword" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"xgulgowski@example.com\",
    \"password\": \"dolorum\",
    \"name\": \"omnis\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/auth/updateNameEmailAndPassword"
);

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

let body = {
    "email": "xgulgowski@example.com",
    "password": "dolorum",
    "name": "omnis"
};

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: xgulgowski@example.com

password   string   

Example: dolorum

name   string   

Example: omnis

POST api/auth/updateNameEmail

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/auth/updateNameEmail" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"wellington.hoppe@example.com\",
    \"name\": \"quod\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/auth/updateNameEmail"
);

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

let body = {
    "email": "wellington.hoppe@example.com",
    "name": "quod"
};

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: wellington.hoppe@example.com

name   string   

Example: quod

POST api/auth/updatePassword

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/auth/updatePassword" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"password\": \"aut\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/auth/updatePassword"
);

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

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

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: aut

POST api/auth/sendOtpEmail

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/auth/sendOtpEmail" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"elemke@example.net\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/auth/sendOtpEmail"
);

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

let body = {
    "email": "elemke@example.net"
};

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: elemke@example.net

POST api/auth/verifyOtpEmail

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/auth/verifyOtpEmail" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"emmerich.breana@example.net\",
    \"otp\": \"326172\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/auth/verifyOtpEmail"
);

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

let body = {
    "email": "emmerich.breana@example.net",
    "otp": "326172"
};

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: emmerich.breana@example.net

otp   string   

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

GET api/auth/getToken

Example request:
curl --request GET \
    --get "https://api.forecastedfinance.com/api/api/auth/getToken" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/engine/getDetails" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"org_id\": \"eius\",
    \"dt_from\": \"2025-09-08\",
    \"dt_to\": \"2025-09-08\",
    \"week_count\": 0.0071343
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/engine/getDetails"
);

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

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

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: eius

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.0071343

POST api/engine/getDetailsV2

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/engine/getDetailsV2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"org_id\": \"perferendis\",
    \"dt_from\": \"2025-09-08\",
    \"dt_to\": \"2025-09-08\",
    \"week_count\": 279580
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/engine/getDetailsV2"
);

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

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

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: perferendis

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: 279580

POST api/engine/exportCSV

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/engine/exportCSV" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"org_id\": \"consequatur\",
    \"dt_from\": \"2025-09-08\",
    \"dt_to\": \"2025-09-08\",
    \"week_count\": 1537541.852955
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/engine/exportCSV"
);

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

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

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: consequatur

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: 1537541.852955

GET api/invite/listForOrganization/{organization_id}

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

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: quaerat

GET api/invite/listForEmail/{email}

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

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: emiliano98@example.net

GET api/invite/listForOwner

Example request:
curl --request GET \
    --get "https://api.forecastedfinance.com/api/api/invite/listForOwner" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/invite/sendInviteByAdmin" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": \"ut\",
    \"email\": \"earline.stehr@example.org\",
    \"name\": \"sunt\",
    \"permission_type\": \"doloribus\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/invite/sendInviteByAdmin"
);

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

let body = {
    "organization_id": "ut",
    "email": "earline.stehr@example.org",
    "name": "sunt",
    "permission_type": "doloribus"
};

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: ut

email   string   

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

name   string  optional  

Example: sunt

permission_type   string   

Example: doloribus

GET api/invite/resendInvite/{id}

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

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: eligendi

GET api/invite/accept/{hash}

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

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: necessitatibus

POST api/invite/updatePermissionType

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/invite/updatePermissionType" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"similique\",
    \"permission_type\": \"velit\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/invite/updatePermissionType"
);

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

let body = {
    "id": "similique",
    "permission_type": "velit"
};

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: similique

permission_type   string   

Example: velit

GET api/org/getActiveForUser

Example request:
curl --request GET \
    --get "https://api.forecastedfinance.com/api/api/org/getActiveForUser" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/org/listOwndedOrganizations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/org/listWithMembers" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/org/search" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"kw\": \"iste\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/org/search"
);

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

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

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://api.forecastedfinance.com/api/api/org/incomplete" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/org" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/org/et" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/org/et"
);

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: et

POST api/org/setupBalance/{organization_id}

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/org/setupBalance/culpa" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"initial_balance\": 122128.852839318,
    \"start_date\": \"2025-09-08\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/org/setupBalance/culpa"
);

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

let body = {
    "initial_balance": 122128.852839318,
    "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: culpa

Body Parameters

initial_balance   number   

Example: 122128.85283932

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://api.forecastedfinance.com/api/api/org" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\",
    \"currency\": \"et\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/org"
);

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

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

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: et

POST api/org/createWithBalanceAndDate

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/org/createWithBalanceAndDate" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"aut\",
    \"currency\": \"minus\",
    \"initial_balance\": \"sint\",
    \"start_date\": \"2025-09-08\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/org/createWithBalanceAndDate"
);

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

let body = {
    "name": "aut",
    "currency": "minus",
    "initial_balance": "sint",
    "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: aut

currency   string   

Example: minus

initial_balance   string   

Example: sint

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://api.forecastedfinance.com/api/api/org/updateForecastGenerationType/doloremque" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"forecast_generation_type\": \"tempora\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/org/updateForecastGenerationType/doloremque"
);

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

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

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: doloremque

Body Parameters

forecast_generation_type   string   

Example: tempora

POST api/org/updateInitialBalanceAndStartDate/{id}

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/org/updateInitialBalanceAndStartDate/rerum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"initial_balance\": \"qui\",
    \"start_date\": \"2025-09-08\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/org/updateInitialBalanceAndStartDate/rerum"
);

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

let body = {
    "initial_balance": "qui",
    "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: rerum

Body Parameters

initial_balance   string   

Example: qui

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://api.forecastedfinance.com/api/api/org/qui" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"et\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/org/qui"
);

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

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

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: qui

Body Parameters

name   string   

Example: et

DELETE api/org/{id}

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

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: ad

POST api/org/updateStatus

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/org/updateStatus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"nisi\",
    \"status\": \"cumque\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/org/updateStatus"
);

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

let body = {
    "id": "nisi",
    "status": "cumque"
};

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: nisi

status   string   

Example: cumque

POST api/org-user

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/org-user" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": \"pariatur\",
    \"organization_id\": \"accusamus\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/org-user"
);

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

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

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: pariatur

organization_id   string   

Example: accusamus

POST api/org-user/delete

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/org-user/delete" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": \"quisquam\",
    \"organization_id\": \"repellendus\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/org-user/delete"
);

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

let body = {
    "user_id": "quisquam",
    "organization_id": "repellendus"
};

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: quisquam

organization_id   string   

Example: repellendus

POST api/org-user/assignOrg

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/org-user/assignOrg" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": \"omnis\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/org-user/assignOrg"
);

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

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

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: omnis

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

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

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: et

GET api/org-user/getPendingOrgList

Example request:
curl --request GET \
    --get "https://api.forecastedfinance.com/api/api/org-user/getPendingOrgList" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/org-user/getPendingListForOrganization/occaecati" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/org-user/getPendingListForOrganization/occaecati"
);

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: occaecati

GET api/org-user/getPendingListForOwner

Example request:
curl --request GET \
    --get "https://api.forecastedfinance.com/api/api/org-user/getPendingListForOwner" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/org-user/getPendingListForUser" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/org-user/updateStatus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"tempora\",
    \"status\": \"et\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/org-user/updateStatus"
);

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

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

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: tempora

status   string   

Example: et

GET api/org-user/pendingRequestsForOwndedOrganizations

Example request:
curl --request GET \
    --get "https://api.forecastedfinance.com/api/api/org-user/pendingRequestsForOwndedOrganizations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/organization-image/store-image" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "id=quos"\
    --form "file=@/tmp/phph90JPM" 
const url = new URL(
    "https://api.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', 'quos');
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: quos

file   file   

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

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/password-recovery/send-password-recovery-link" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"kaia.hamill@example.com\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/password-recovery/send-password-recovery-link"
);

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

let body = {
    "email": "kaia.hamill@example.com"
};

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://api.forecastedfinance.com/api/api/password-recovery/initiate-password-recovery" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"shaun85@example.org\",
    \"otp\": \"864788\",
    \"salt\": \"non\",
    \"password\": \"aspernatur\",
    \"confirm_password\": \"quos\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/password-recovery/initiate-password-recovery"
);

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

let body = {
    "email": "shaun85@example.org",
    "otp": "864788",
    "salt": "non",
    "password": "aspernatur",
    "confirm_password": "quos"
};

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: shaun85@example.org

otp   string   

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

salt   string   

Example: non

password   string   

Example: aspernatur

confirm_password   string   

Example: quos

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

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

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: recusandae

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

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

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: ipsum

GET api/stripe-product/listAllProducts

Example request:
curl --request GET \
    --get "https://api.forecastedfinance.com/api/api/stripe-product/listAllProducts" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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_SFcrGwaPPbCzoX",
            "object": "product",
            "active": true,
            "attributes": [],
            "created": 1746384600,
            "default_price": "price_1RdDn1RvbeGYHkrClnW6xlI8",
            "description": "Business Yearly",
            "images": [],
            "livemode": false,
            "marketing_features": [],
            "metadata": [],
            "name": "Business Yearly",
            "package_dimensions": null,
            "shippable": null,
            "statement_descriptor": null,
            "tax_code": "txcd_20030000",
            "type": "service",
            "unit_label": null,
            "updated": 1750698255,
            "url": null
        },
        {
            "id": "prod_SFcqsbLgUvZqzA",
            "object": "product",
            "active": true,
            "attributes": [],
            "created": 1746384500,
            "default_price": "price_1RdDlsRvbeGYHkrCMOMjXNxA",
            "description": "Business Monthly",
            "images": [],
            "livemode": false,
            "marketing_features": [],
            "metadata": [],
            "name": "Business Monthly",
            "package_dimensions": null,
            "shippable": null,
            "statement_descriptor": null,
            "tax_code": "txcd_20030000",
            "type": "service",
            "unit_label": null,
            "updated": 1750698185,
            "url": null
        },
        {
            "id": "prod_SFcnqGLcpXDY3B",
            "object": "product",
            "active": true,
            "attributes": [],
            "created": 1746384367,
            "default_price": "price_1RdDmcRvbeGYHkrCXuv6RPxU",
            "description": "Basic Yearly",
            "images": [],
            "livemode": false,
            "marketing_features": [],
            "metadata": [],
            "name": "Basic Yearly",
            "package_dimensions": null,
            "shippable": null,
            "statement_descriptor": null,
            "tax_code": "txcd_20030000",
            "type": "service",
            "unit_label": null,
            "updated": 1750698230,
            "url": null
        },
        {
            "id": "prod_SERiAV9TKZkry2",
            "object": "product",
            "active": true,
            "attributes": [],
            "created": 1746112509,
            "default_price": "price_1RdDlXRvbeGYHkrCjz8kKRnB",
            "description": "Basic Monthly",
            "images": [],
            "livemode": false,
            "marketing_features": [],
            "metadata": [],
            "name": "Basic Monthly",
            "package_dimensions": null,
            "shippable": null,
            "statement_descriptor": null,
            "tax_code": "txcd_20030000",
            "type": "service",
            "unit_label": null,
            "updated": 1750698163,
            "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://api.forecastedfinance.com/api/api/stripe-product/findProductByName" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"occaecati\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/stripe-product/findProductByName"
);

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

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

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: occaecati

GET api/stripe-product/findProductById

Example request:
curl --request GET \
    --get "https://api.forecastedfinance.com/api/api/stripe-product/findProductById" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"necessitatibus\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/stripe-product/findProductById"
);

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

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

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: necessitatibus

POST api/stripe-product/createProduct

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/stripe-product/createProduct" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"quis\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/stripe-product/createProduct"
);

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

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

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: quis

GET api/stripe-price/listAllPrices

Example request:
curl --request GET \
    --get "https://api.forecastedfinance.com/api/api/stripe-price/listAllPrices" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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_1RdDn1RvbeGYHkrClnW6xlI8",
            "object": "price",
            "active": true,
            "billing_scheme": "per_unit",
            "created": 1750698255,
            "currency": "usd",
            "custom_unit_amount": null,
            "livemode": false,
            "lookup_key": null,
            "metadata": {
                "product": "prod_SFcrGwaPPbCzoX"
            },
            "nickname": null,
            "product": "prod_SFcrGwaPPbCzoX",
            "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"
        },
        {
            "id": "price_1RdDmcRvbeGYHkrCXuv6RPxU",
            "object": "price",
            "active": true,
            "billing_scheme": "per_unit",
            "created": 1750698230,
            "currency": "usd",
            "custom_unit_amount": null,
            "livemode": false,
            "lookup_key": null,
            "metadata": {
                "product": "prod_SFcnqGLcpXDY3B"
            },
            "nickname": null,
            "product": "prod_SFcnqGLcpXDY3B",
            "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_1RdDlsRvbeGYHkrCMOMjXNxA",
            "object": "price",
            "active": true,
            "billing_scheme": "per_unit",
            "created": 1750698184,
            "currency": "usd",
            "custom_unit_amount": null,
            "livemode": false,
            "lookup_key": null,
            "metadata": {
                "product": "prod_SFcqsbLgUvZqzA"
            },
            "nickname": null,
            "product": "prod_SFcqsbLgUvZqzA",
            "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_1RdDlXRvbeGYHkrCjz8kKRnB",
            "object": "price",
            "active": true,
            "billing_scheme": "per_unit",
            "created": 1750698163,
            "currency": "usd",
            "custom_unit_amount": null,
            "livemode": false,
            "lookup_key": null,
            "metadata": {
                "product": "prod_SERiAV9TKZkry2"
            },
            "nickname": null,
            "product": "prod_SERiAV9TKZkry2",
            "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_1RdCzYRvbeGYHkrCQ4BJU6Y1",
            "object": "price",
            "active": true,
            "billing_scheme": "per_unit",
            "created": 1750695188,
            "currency": "usd",
            "custom_unit_amount": null,
            "livemode": false,
            "lookup_key": null,
            "metadata": [],
            "nickname": null,
            "product": "prod_SERiAV9TKZkry2",
            "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_1RdCzARvbeGYHkrCnqwUvW9E",
            "object": "price",
            "active": true,
            "billing_scheme": "per_unit",
            "created": 1750695164,
            "currency": "usd",
            "custom_unit_amount": null,
            "livemode": false,
            "lookup_key": null,
            "metadata": [],
            "nickname": null,
            "product": "prod_SFcnqGLcpXDY3B",
            "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_1RdCylRvbeGYHkrCUQrgX3L5",
            "object": "price",
            "active": true,
            "billing_scheme": "per_unit",
            "created": 1750695139,
            "currency": "usd",
            "custom_unit_amount": null,
            "livemode": false,
            "lookup_key": null,
            "metadata": [],
            "nickname": null,
            "product": "prod_SFcqsbLgUvZqzA",
            "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_1RdCy8RvbeGYHkrC35RWaDnk",
            "object": "price",
            "active": true,
            "billing_scheme": "per_unit",
            "created": 1750695100,
            "currency": "usd",
            "custom_unit_amount": null,
            "livemode": false,
            "lookup_key": null,
            "metadata": [],
            "nickname": null,
            "product": "prod_SFcrGwaPPbCzoX",
            "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"
        },
        {
            "id": "price_1RaseaRvbeGYHkrCOBodUk8q",
            "object": "price",
            "active": true,
            "billing_scheme": "per_unit",
            "created": 1750140352,
            "currency": "usd",
            "custom_unit_amount": null,
            "livemode": false,
            "lookup_key": null,
            "metadata": {
                "product": "prod_SFcqsbLgUvZqzA"
            },
            "nickname": null,
            "product": "prod_SFcqsbLgUvZqzA",
            "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": 1500,
            "unit_amount_decimal": "1500"
        },
        {
            "id": "price_1RarIGRvbeGYHkrCoSdD3N7g",
            "object": "price",
            "active": true,
            "billing_scheme": "per_unit",
            "created": 1750135124,
            "currency": "usd",
            "custom_unit_amount": null,
            "livemode": false,
            "lookup_key": null,
            "metadata": {
                "product": "prod_SFcrGwaPPbCzoX"
            },
            "nickname": null,
            "product": "prod_SFcrGwaPPbCzoX",
            "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": 1400,
            "unit_amount_decimal": "1400"
        },
        {
            "id": "price_1RarBYRvbeGYHkrCoZmgLPU1",
            "object": "price",
            "active": true,
            "billing_scheme": "per_unit",
            "created": 1750134708,
            "currency": "usd",
            "custom_unit_amount": null,
            "livemode": false,
            "lookup_key": null,
            "metadata": {
                "product": "prod_SFcrGwaPPbCzoX"
            },
            "nickname": null,
            "product": "prod_SFcrGwaPPbCzoX",
            "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": 1100,
            "unit_amount_decimal": "1100"
        },
        {
            "id": "price_1RL7bwRvbeGYHkrCpEkOoxnB",
            "object": "price",
            "active": true,
            "billing_scheme": "per_unit",
            "created": 1746384600,
            "currency": "usd",
            "custom_unit_amount": null,
            "livemode": false,
            "lookup_key": null,
            "metadata": [],
            "nickname": null,
            "product": "prod_SFcrGwaPPbCzoX",
            "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": 11520,
            "unit_amount_decimal": "11520"
        },
        {
            "id": "price_1RL7aLRvbeGYHkrCv1DGfR69",
            "object": "price",
            "active": true,
            "billing_scheme": "per_unit",
            "created": 1746384501,
            "currency": "usd",
            "custom_unit_amount": null,
            "livemode": false,
            "lookup_key": null,
            "metadata": [],
            "nickname": null,
            "product": "prod_SFcqsbLgUvZqzA",
            "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": 1200,
            "unit_amount_decimal": "1200"
        },
        {
            "id": "price_1RL7YCRvbeGYHkrCqtuwBxeu",
            "object": "price",
            "active": true,
            "billing_scheme": "per_unit",
            "created": 1746384368,
            "currency": "usd",
            "custom_unit_amount": null,
            "livemode": false,
            "lookup_key": null,
            "metadata": [],
            "nickname": null,
            "product": "prod_SFcnqGLcpXDY3B",
            "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": 10000,
            "unit_amount_decimal": "10000"
        },
        {
            "id": "price_1RK162RvbeGYHkrCfaFd39BE",
            "object": "price",
            "active": true,
            "billing_scheme": "per_unit",
            "created": 1746121230,
            "currency": "usd",
            "custom_unit_amount": null,
            "livemode": false,
            "lookup_key": null,
            "metadata": [],
            "nickname": null,
            "product": "prod_SERiAV9TKZkry2",
            "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": 1000,
            "unit_amount_decimal": "1000"
        }
    ],
    "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://api.forecastedfinance.com/api/api/stripe-price/priceListForProduct/dolorem" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/stripe-price/priceListForProduct/dolorem"
);

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: dolorem

POST api/stripe-price/createPrice

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/stripe-price/createPrice" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"product\": \"ut\",
    \"unit_amount\": 432637.129582,
    \"interval\": \"at\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/stripe-price/createPrice"
);

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

let body = {
    "product": "ut",
    "unit_amount": 432637.129582,
    "interval": "at"
};

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: ut

unit_amount   number   

Example: 432637.129582

interval   string   

Example: at

POST api/stripe-payment/attachPaymentMethod

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/stripe-payment/attachPaymentMethod" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"stripe_payment_method_id\": \"officiis\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/stripe-payment/attachPaymentMethod"
);

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

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

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: officiis

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

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

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: eum

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

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

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: non

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

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

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: ut

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

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

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: reprehenderit

POST api/stripe-subscription/createSubscription

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/stripe-subscription/createSubscription" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"stripe_payment_method_id\": \"sit\",
    \"price_id\": \"est\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/stripe-subscription/createSubscription"
);

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

let body = {
    "stripe_payment_method_id": "sit",
    "price_id": "est"
};

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: sit

price_id   string   

Example: est

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

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

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: praesentium

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

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

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: iusto

POST api/stripe-subscription/updatePaymentMethod

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/stripe-subscription/updatePaymentMethod" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"stripe_subscription_id\": \"occaecati\",
    \"stripe_payment_method_id\": \"sit\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/stripe-subscription/updatePaymentMethod"
);

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

let body = {
    "stripe_subscription_id": "occaecati",
    "stripe_payment_method_id": "sit"
};

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: occaecati

stripe_payment_method_id   string   

Example: sit

GET api/stripe-payment-plan/listAll

Example request:
curl --request GET \
    --get "https://api.forecastedfinance.com/api/api/stripe-payment-plan/listAll" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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_1RdCzYRvbeGYHkrCQ4BJU6Y1",
        "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-05-04T20:55:18.000000Z",
        "updated_at": "2025-06-23T17:02:43.000000Z",
        "workspace_count": 1,
        "seat_count": 2,
        "stripe_product_id": "prod_SERiAV9TKZkry2"
    },
    {
        "id": 2,
        "title": "Business",
        "amount": 59,
        "monthly_or_yearly": "monthly",
        "stripe_price_id": "price_1RdCylRvbeGYHkrCUQrgX3L5",
        "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-05-04T20:55:18.000000Z",
        "updated_at": "2025-06-23T17:03:05.000000Z",
        "workspace_count": 5,
        "seat_count": 3,
        "stripe_product_id": "prod_SFcqsbLgUvZqzA"
    },
    {
        "id": 3,
        "title": "Basic",
        "amount": 374.4,
        "monthly_or_yearly": "yearly",
        "stripe_price_id": "price_1RdCzARvbeGYHkrCnqwUvW9E",
        "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-05-04T20:55:18.000000Z",
        "updated_at": "2025-06-23T17:03:50.000000Z",
        "workspace_count": 1,
        "seat_count": 2,
        "stripe_product_id": "prod_SFcnqGLcpXDY3B"
    },
    {
        "id": 4,
        "title": "Business",
        "amount": 566.4,
        "monthly_or_yearly": "yearly",
        "stripe_price_id": "price_1RdCy8RvbeGYHkrC35RWaDnk",
        "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-05-04T20:55:18.000000Z",
        "updated_at": "2025-06-23T17:04:15.000000Z",
        "workspace_count": 5,
        "seat_count": 3,
        "stripe_product_id": "prod_SFcrGwaPPbCzoX"
    }
]
 

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://api.forecastedfinance.com/api/api/stripe-payment-plan/listAllActive" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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_1RdCzYRvbeGYHkrCQ4BJU6Y1",
        "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-05-04T20:55:18.000000Z",
        "updated_at": "2025-06-23T17:02:43.000000Z",
        "workspace_count": 1,
        "seat_count": 2,
        "stripe_product_id": "prod_SERiAV9TKZkry2"
    },
    {
        "id": 2,
        "title": "Business",
        "amount": 59,
        "monthly_or_yearly": "monthly",
        "stripe_price_id": "price_1RdCylRvbeGYHkrCUQrgX3L5",
        "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-05-04T20:55:18.000000Z",
        "updated_at": "2025-06-23T17:03:05.000000Z",
        "workspace_count": 5,
        "seat_count": 3,
        "stripe_product_id": "prod_SFcqsbLgUvZqzA"
    },
    {
        "id": 3,
        "title": "Basic",
        "amount": 374.4,
        "monthly_or_yearly": "yearly",
        "stripe_price_id": "price_1RdCzARvbeGYHkrCnqwUvW9E",
        "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-05-04T20:55:18.000000Z",
        "updated_at": "2025-06-23T17:03:50.000000Z",
        "workspace_count": 1,
        "seat_count": 2,
        "stripe_product_id": "prod_SFcnqGLcpXDY3B"
    },
    {
        "id": 4,
        "title": "Business",
        "amount": 566.4,
        "monthly_or_yearly": "yearly",
        "stripe_price_id": "price_1RdCy8RvbeGYHkrC35RWaDnk",
        "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-05-04T20:55:18.000000Z",
        "updated_at": "2025-06-23T17:04:15.000000Z",
        "workspace_count": 5,
        "seat_count": 3,
        "stripe_product_id": "prod_SFcrGwaPPbCzoX"
    }
]
 

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://api.forecastedfinance.com/api/api/stripe-payment-plan/findByStripePriceId/ea" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/stripe-payment-plan/findByStripePriceId/ea"
);

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: ea

POST api/stripe-payment-intent/create

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/stripe-payment-intent/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"amount\": 1647.22486,
    \"stripe_price_id\": \"porro\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/stripe-payment-intent/create"
);

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

let body = {
    "amount": 1647.22486,
    "stripe_price_id": "porro"
};

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: 1647.22486

stripe_price_id   string  optional  

Example: porro

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

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

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: placeat

GET api/getEventFromStripeWebhook

Example request:
curl --request GET \
    --get "https://api.forecastedfinance.com/api/api/getEventFromStripeWebhook" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/getEventFromStripeWebhook" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/stripe-user/listSubscriptions" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/stripe-user/listPaymentMethods" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/stripe-user/listStripeCustomers" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/transactions/listPaginated" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"page\": 12,
    \"page_size\": 20
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/transactions/listPaginated"
);

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

let body = {
    "page": 12,
    "page_size": 20
};

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: 12

page_size   integer   

Example: 20

POST api/transactions/assignVendor

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/transactions/assignVendor" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"vendor_id\": 16331.61,
    \"transaction_id\": 9951.2663289
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/transactions/assignVendor"
);

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

let body = {
    "vendor_id": 16331.61,
    "transaction_id": 9951.2663289
};

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: 16331.61

transaction_id   number   

Example: 9951.2663289

POST api/transactions/updateOneTimeStatus

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/transactions/updateOneTimeStatus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"transaction_id\": 718401.34456,
    \"is_one_time_event\": \"quibusdam\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/transactions/updateOneTimeStatus"
);

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

let body = {
    "transaction_id": 718401.34456,
    "is_one_time_event": "quibusdam"
};

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: 718401.34456

is_one_time_event   string   

Example: quibusdam

POST api/transactions/updateVendorCategory

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/transactions/updateVendorCategory" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"transaction_id\": 46633,
    \"vcategory_id\": 362782.359047
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/transactions/updateVendorCategory"
);

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

let body = {
    "transaction_id": 46633,
    "vcategory_id": 362782.359047
};

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: 46633

vcategory_id   number   

Example: 362782.359047

POST api/transactions/updateVendorDescription

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/transactions/updateVendorDescription" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"transaction_id\": 10288769.3,
    \"description\": \"facere\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/transactions/updateVendorDescription"
);

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

let body = {
    "transaction_id": 10288769.3,
    "description": "facere"
};

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: 10288769.3

description   string   

Example: facere

DELETE api/transactions/deleteMaster/{id}

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

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: consequatur

DELETE api/transactions/deleteTransaction/{id}

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

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: fuga

POST api/transactions/listVendorsForDescription

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/transactions/listVendorsForDescription" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"sapiente\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/transactions/listVendorsForDescription"
);

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

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

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: sapiente

GET api/transactions/getLastBatchId

Example request:
curl --request GET \
    --get "https://api.forecastedfinance.com/api/api/transactions/getLastBatchId" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/transactions/calculateVendorsForBatch/repudiandae" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/transactions/calculateVendorsForBatch/repudiandae"
);

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: repudiandae

GET api/transactions/calculateVendorsForBatchV2/{batch_id}

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

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: quibusdam

POST api/transactions/splitTransaction

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/transactions/splitTransaction" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/transaction-master/listPaginated" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"org_id\": 15,
    \"page\": 20,
    \"page_size\": 7
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/transaction-master/listPaginated"
);

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

let body = {
    "org_id": 15,
    "page": 20,
    "page_size": 7
};

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: 15

page   integer   

Example: 20

page_size   integer   

Example: 7

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

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/transaction-master/findAllChildren/alias" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"org_id\": 17
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/transaction-master/findAllChildren/alias"
);

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

let body = {
    "org_id": 17
};

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: alias

Body Parameters

org_id   integer   

Example: 17

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

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/transaction-master/updateNameAndDate/aut" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"transaction_name\": \"perspiciatis\",
    \"start_date\": \"2025-09-08\",
    \"end_date\": \"2025-09-08\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/transaction-master/updateNameAndDate/aut"
);

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

let body = {
    "transaction_name": "perspiciatis",
    "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: aut

Body Parameters

transaction_name   string   

Example: perspiciatis

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://api.forecastedfinance.com/api/api/user-image/store-image" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "id=id"\
    --form "file=@/tmp/phpwNCZl6" 
const url = new URL(
    "https://api.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', 'id');
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: id

file   file   

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

POST api/uploader/uploadCsv/{id}

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

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: quos

Body Parameters

file   file   

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

GET api/vendors

Example request:
curl --request GET \
    --get "https://api.forecastedfinance.com/api/api/vendors" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/vendors/findVendorWithCategory/id" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/vendors/findVendorWithCategory/id"
);

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: id

Example request:
curl --request GET \
    --get "https://api.forecastedfinance.com/api/api/vendors/search" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/vendors" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"et\",
    \"vcategory_id\": 371519326.715
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/vendors"
);

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

let body = {
    "name": "et",
    "vcategory_id": 371519326.715
};

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: et

vcategory_id   number   

Example: 371519326.715

POST api/vendors/updateCategory

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/vendors/updateCategory" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"vendor_id\": 155.488963798,
    \"vcategory_id\": 3001457.1853193506
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/vendors/updateCategory"
);

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

let body = {
    "vendor_id": 155.488963798,
    "vcategory_id": 3001457.1853193506
};

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: 155.488963798

vcategory_id   number   

Example: 3001457.1853194

POST api/vendors/updateName

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/vendors/updateName" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"vendor_id\": 333477.9479283,
    \"name\": \"nostrum\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/vendors/updateName"
);

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

let body = {
    "vendor_id": 333477.9479283,
    "name": "nostrum"
};

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: 333477.9479283

name   string   

Example: nostrum

POST api/vendors/updateStatus

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/vendors/updateStatus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"vendor_id\": 197443.398862561,
    \"status\": \"odio\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/vendors/updateStatus"
);

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

let body = {
    "vendor_id": 197443.398862561,
    "status": "odio"
};

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: 197443.39886256

status   string   

Example: odio

GET api/vendors/searchPaginated

Example request:
curl --request GET \
    --get "https://api.forecastedfinance.com/api/api/vendors/searchPaginated" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"page\": 1,
    \"page_size\": 11,
    \"kw\": \"enim\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/vendors/searchPaginated"
);

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

let body = {
    "page": 1,
    "page_size": 11,
    "kw": "enim"
};

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: 11

kw   string  optional  

Example: enim

POST api/vendors/mergeVendors

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/vendors/mergeVendors" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id1\": 1,
    \"id2\": 14
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/vendors/mergeVendors"
);

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

let body = {
    "id1": 1,
    "id2": 14
};

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: 1

id2   integer   

Example: 14

DELETE api/vendors/{id}

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

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: necessitatibus

GET api/vendor-categories

Example request:
curl --request GET \
    --get "https://api.forecastedfinance.com/api/api/vendor-categories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/vendor-categories/assoc" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/vendor-categories/updateStatus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 67.406,
    \"status\": \"sunt\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/vendor-categories/updateStatus"
);

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

let body = {
    "id": 67.406,
    "status": "sunt"
};

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: 67.406

status   string   

Example: sunt

POST api/vendor-categories/create

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/vendor-categories/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"recusandae\",
    \"category_type\": \"mollitia\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/vendor-categories/create"
);

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

let body = {
    "name": "recusandae",
    "category_type": "mollitia"
};

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: recusandae

category_type   string   

Example: mollitia

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

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

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: iste

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

Example request:
curl --request GET \
    --get "https://api.forecastedfinance.com/api/api/vendor-categories-for-org/assoc/voluptates" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/vendor-categories-for-org/updateStatus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 70,
    \"status\": \"qui\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/vendor-categories-for-org/updateStatus"
);

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

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

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: 70

status   string   

Example: qui

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

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/vendor-categories-for-org/updateRecurrence" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 613.1439278,
    \"recurrence\": \"qui\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/vendor-categories-for-org/updateRecurrence"
);

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

let body = {
    "id": 613.1439278,
    "recurrence": "qui"
};

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: 613.1439278

recurrence   string   

Example: qui

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

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/vendor-categories-for-org/create/delectus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"nihil\",
    \"category_type\": \"aliquam\"
}"
const url = new URL(
    "https://api.forecastedfinance.com/api/api/vendor-categories-for-org/create/delectus"
);

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

let body = {
    "name": "nihil",
    "category_type": "aliquam"
};

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: delectus

Body Parameters

name   string   

Example: nihil

category_type   string   

Example: aliquam

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

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

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: distinctio

POST api/test-csv/upload

Example request:
curl --request POST \
    "https://api.forecastedfinance.com/api/api/test-csv/upload" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "file=@/tmp/phpVuUGKv" 
const url = new URL(
    "https://api.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/phpVuUGKv

GET api/testEmail

Example request:
curl --request GET \
    --get "https://api.forecastedfinance.com/api/api/testEmail" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/test" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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://api.forecastedfinance.com/api/api/test-ai" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.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