Projects

Get a project's budget

Returns the project's budget: its divisions in display order, each with its budget line items in display order. A project without a budget returns an empty divisions list.

get/projects/{projectId}/budget

Request

  • Base URL: https://api.rabbet.com/v1
  • URL: https://api.rabbet.com/v1/projects/{projectId}/budget
  • Auth: OAuth 2 (client credentials, token URL https://api.rabbet.com/oauth/token, scopes: read)

Path parameters

projectIdstring uuid required

Rabbet project UUID. To resolve your own identifier to a project, use GET /projects?custom_id=....

Response

The project's budget.

Example response

{
  "data": {
    "divisions": [
      {
        "id": "f7a55f21-9c62-4a5e-8f2b-2b1f0f6f3d10",
        "name": "Hard Costs",
        "line_items": [
          {
            "id": "a3fc8f60-2f8e-4de4-9436-5cf0bb1c1a77",
            "name": "Concrete",
            "number": "03-3000",
            "amount": {
              "amount": "123.45",
              "currency": "USD"
            },
            "line_item_type": "hard_costs",
            "retainage_percentage": 0.1
          }
        ]
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.