Agave · Schema

Project

A construction project record from the linked source system.

AccountingConstructionIntegration

Properties

Name Type Description
id string Agave unified project identifier.
source_id string Project identifier in the source system.
name string Project name.
number string Project number or code.
status string Project status.
address string Project address.
start_date string Project start date.
estimated_completion_date string Estimated project completion date.
total_budget number Total approved project budget in USD.
created_at string Timestamp when the record was created.
updated_at string Timestamp when the record was last updated.
View JSON Schema on GitHub

JSON Schema

unified-api-project-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/agave/refs/heads/main/json-schema/unified-api-project-schema.json",
  "title": "Project",
  "description": "A construction project record from the linked source system.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Agave unified project identifier.",
      "example": "proj-500123"
    },
    "source_id": {
      "type": "string",
      "description": "Project identifier in the source system.",
      "example": 12345
    },
    "name": {
      "type": "string",
      "description": "Project name.",
      "example": "Downtown Office Building"
    },
    "number": {
      "type": "string",
      "description": "Project number or code.",
      "example": "2025-001"
    },
    "status": {
      "type": "string",
      "description": "Project status.",
      "enum": [
        "active",
        "inactive",
        "completed"
      ],
      "example": "active"
    },
    "address": {
      "type": "string",
      "description": "Project address.",
      "example": "123 Main St, San Francisco, CA 94105"
    },
    "start_date": {
      "type": "string",
      "format": "date",
      "description": "Project start date.",
      "example": "2025-01-15"
    },
    "estimated_completion_date": {
      "type": "string",
      "format": "date",
      "description": "Estimated project completion date.",
      "example": "2026-06-30"
    },
    "total_budget": {
      "type": "number",
      "description": "Total approved project budget in USD.",
      "example": 5000000.0
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the record was created.",
      "example": "2025-01-15T09:00:00Z"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the record was last updated.",
      "example": "2025-04-01T12:00:00Z"
    }
  }
}