Budget View Snapshot API

The Budget View Snapshot API allows you to retrieve detailed information about a specific budget view snapshot. This endpoint provides comprehensive data about the state of a budget at the time the snapshot was created.

Get Budget View Snapshot

GET
/api/external/budget-view-snapshot
curl -X GET "https://api.kurrent.com/api/external/budget-view-snapshot?project_id=123&snapshot_id=789" \
  -H "x-api-key: your-api-key" \
  -H "x-organization-id: your-organization-id" \
  -H "x-company-id: your-company-id"

Query Parameters

  • Name
    project_id
    Type
    integer
    Required
    Description

    The ID of the project that the snapshot belongs to.

  • Name
    snapshot_id
    Type
    integer
    Required
    Description

    The ID of the specific budget view snapshot to retrieve.

Required Headers

  • Name
    x-api-key
    Type
    string
    Required
    Description

    Your API key for authentication.

  • Name
    x-organization-id
    Type
    string
    Required
    Description

    The ID of your organization.

  • Name
    x-company-id
    Type
    string
    Required
    Description

    The ID of the company you're accessing.

Response

dataobject

The budget view snapshot object with detailed information.

Example Response

{
  "data": {
    "id": 789,
    "name": "End of January 2025",
    "description": "Budget snapshot at the end of January 2025",
    "created_at": "2025-01-31T23:59:59Z",
    "budget_view_id": 123,
    "project_id": 456,
    "created_by": {
      "id": 101,
      "name": "John Doe",
      "email": "john.doe@example.com"
    },
    "line_items": [
      {
        "id": 1001,
        "code": "01-100",
        "description": "General Requirements",
        "original_budget": 100000.00,
        "current_budget": 105000.00,
        "committed": 95000.00,
        "spent": 75000.00,
        "projected_total": 102000.00,
        "variance": 3000.00
      },
      {
        "id": 1002,
        "code": "02-200",
        "description": "Site Construction",
        "original_budget": 250000.00,
        "current_budget": 260000.00,
        "committed": 255000.00,
        "spent": 200000.00,
        "projected_total": 265000.00,
        "variance": -5000.00
      }
    ],
    "totals": {
      "original_budget": 350000.00,
      "current_budget": 365000.00,
      "committed": 350000.00,
      "spent": 275000.00,
      "projected_total": 367000.00,
      "variance": -2000.00
    }
  }
}

Error Responses

errorstring

A description of the error that occurred.

Example Error Response

{
  "error": "snapshot_id is required in query parameters"
}

Status Codes

  • Name
    200
    Description

    The request was successful.

  • Name
    400
    Description

    Bad request - check the error message for details.

  • Name
    401
    Description

    Unauthorized - invalid or missing API key.

  • Name
    404
    Description

    Not found - the organization, project, or snapshot was not found.

  • Name
    500
    Description

    Internal server error.

Was this page helpful?