Skip to main content
GET
/
coa
/
api
/
budgets
/
{id}
Retrieve Budget
curl --request GET \
  --url https://api.meetcampfire.com/coa/api/budgets/{id} \
  --header 'Authorization: <api-key>'
{
  "id": 123,
  "entity_name": "<string>",
  "prior_start_date": "<string>",
  "prior_end_date": "<string>",
  "department_name": "<string>",
  "tags": [
    {
      "id": 123,
      "group_name": "<string>",
      "parent_name": "<string>",
      "parent": 123,
      "is_deleted": false,
      "deleted_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "last_modified_at": "2023-11-07T05:31:56Z",
      "customer": 123,
      "group": 123
    }
  ],
  "is_deleted": false,
  "deleted_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "description": "<string>",
  "cadence": "<string>",
  "start_date": "2023-12-25",
  "end_date": "2023-12-25",
  "periods": 16383,
  "breakdown_type": "standard",
  "currency": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "last_modified_at": "2023-11-07T05:31:56Z",
  "customer": 123,
  "entity": 123,
  "department": 123
}

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

id
integer
required

Response

200 - application/json
id
integer
required
entity_name
string
required
prior_start_date
string
required
prior_end_date
string
required
department_name
string
required
tags
object[]
required
is_deleted
boolean
default:false
required
deleted_at
string<date-time> | null
required
name
string
required
start_date
string<date>
required
created_at
string<date-time>
required
last_modified_at
string<date-time>
required
customer
integer
required
description
string | null
cadence
string | null
end_date
string<date> | null
periods
integer
Required range: 0 <= x <= 32767
breakdown_type
enum<string>
  • standard - Standard (Account-based)
  • department_row - Department (Row)
Available options:
standard,
department_row
currency
string
Maximum length: 3
entity
integer | null
department
integer | null
I