Get a forecast budget by external ID

GET

/forecast/budgets/external/{external_id}/

curl --request GET \
  --url https://app.commitly.com/api/forecast/budgets/external/ext-123457/ \
  --header 'Authorization: Bearer <token>'

• Production

Returns the forecast budget with the given external_id.

Authorizations

• commitlyOAuth

Parameters

Path Parameters

external_id

required

string

The external_id set when the budget was created. Budgets whose external_id contains . or / cannot be addressed by this path. The trailing slash after the external_id is required.

Example

ext-123457

Responses

200

The budget.

Media typeapplication/json

Budget as returned by the API.

object

id

Internal budget ID; used in the /budgets/{id}/ paths.

integer

category

Short form of a category, embedded in transactions and budgets.

object

id

integer

name

string

description

string

inter_category

Category of the linked budget in the other company.

integer | null

inter_category_name

Name of inter_category.

string | null

depending_categories

Categories the budget depends on.

Array

base_categories

Stored dependency categories (set via depending_categories).

Array

recurring_budget

Summary of the recurrence settings; null if the budget is not recurring.

object

frequency

string

frequency_multiplier

integer

sequence_type

string

sequence_term_size

integer

d

number

r

number

settlement_date

string format: date

start_date

string | null format: date

end_date

string | null format: date

account

Bank account ID.

integer | null

tags

Array<string>

integration_tags

Array<string> | null

is_adjusted

boolean

inter_budget

The linked budget in the other company of an intercompany budget, or null.

name

string

description

string

amount

Negative for outflows, positive for inflows.

number

rate

number

base

FS forecast and scenario, S scenario, F forecast.

string

Allowed values: FS S F

time_lags

Array<integer>

frequency

string

Allowed values: daily weekly monthly quarterly yearly ""

frequency_multiplier

integer

sequence_type

string

Allowed values: AP GP HP ""

sequence_term_size

integer

d

number

r

number

is_indefinite

boolean

external_id

Your own ID for the budget.

string | null

external_source

Free-text name of the system that created the budget.

string | null

inter_company

Company ID for an intercompany budget.

integer | null

source

ID of the budget this one was copied from, or null. Not related to external_source.

integer | null

Examples

ExampleForecastBudget

Forecast budget

{
  "id": 9003,
  "category": {
    "id": 1006,
    "name": "Other taxes and fees",
    "description": ""
  },
  "inter_category_name": null,
  "depending_categories": [],
  "recurring_budget": null,
  "settlement_date": "2024-04-08",
  "start_date": null,
  "end_date": null,
  "account": null,
  "tags": [
    "my-integration",
    "direct-API"
  ],
  "integration_tags": null,
  "is_adjusted": false,
  "name": "Tax prepayment",
  "description": "Created via API",
  "amount": -78700,
  "rate": 0,
  "base": "FS",
  "time_lags": [],
  "frequency": "",
  "frequency_multiplier": 1,
  "sequence_type": "",
  "sequence_term_size": 1,
  "d": 0,
  "r": 1,
  "is_indefinite": false,
  "external_id": "ext-123457",
  "external_source": "my-integration",
  "inter_company": null,
  "source": null,
  "inter_budget": null,
  "base_categories": []
}

401

The access token is invalid or has expired. Request a new token. The message is localized (see Accept-Language).

Media typeapplication/json

object

detail

required

Error message.

string

code

Present only if the company’s edition does not include the function; value billing_plan_permission_denied.

string

Example

{
  "detail": "Invalid token."
}

Headers

WWW-Authenticate

string

Authentication scheme, Bearer.

Example

Bearer

403

No access token was sent, or the credentials are not allowed to call this endpoint. If the company’s COMMITLY edition does not include the requested function, the body additionally contains "code": "billing_plan_permission_denied".

Media typeapplication/json

object

detail

required

Error message.

string

code

Present only if the company’s edition does not include the function; value billing_plan_permission_denied.

string

Example

{
  "detail": "User must be authenticated to access this resource."
}

404

The resource does not exist or is not accessible with these credentials.

Media typeapplication/json

object

detail

required

Error message.

string

code

Present only if the company’s edition does not include the function; value billing_plan_permission_denied.

string

Example^generated

{
  "detail": "example",
  "code": "example"
}