API Documentation

POST /api/access_token

Authenticate a user and receive a JWT access token.

Request Body

{
    "username": "string",
    "password": "string"
}

Response

{
    "access_token": "string" 
}

GET /api/workspaces

Retrieve a list of workspaces attached to the authenticated account

Request Header

Authorization: bearer access_token

JSON Response

{
    "workspaces": [
        {
            "name": "Equinix",
            "pid": "AQwqbz"
        },
        {
            "name": "Digital Realty",
            "pid": "dQswle"
        },
        {
            "name": "Host Hotels & Resorts",
            "pid": "dPRfdW"
        },
        ...
    ]
}

GET /api/statements?pid={pid}

Retrieve a list of statements attached to the project ID. Balance sheet and finanial position related documents are what this refers to

Request Header

Authorization: bearer access_token

Query Parameters

• pid (required): Workspace/Project ID

JSON Response

{
    "statements": [
        {
            "name": "EQIX",
            "period": "2024-12-31",
            "sid": "EqidNf"
        }
    ]
}

GET /api/balancesheet?pid={pid}&sid={sid}

Retrieve the financial position of the a specified project and statement.

Request Header

Authorization: bearer access_token

Query Parameters

• pid (required): Project UUID
• sid (requiredl): statement UUID

JSON Response

{
    "Assets": {
        "Current Assets": {
            "Accounts receivable": 6100,
            "Bank account": 2050,
            ...
        },
        "Fixed Assets": {
            "Available-for-sale (AFS) Securities": 2222,
            "Equipment": 900,
            "Inventory - Handmade Purple Heart Board": 3000,
            "Other Intangible Crypto Price": 0,
            ...
        }
    },
    "Equity": {
        "Contributed Capital": {
            "Capital": 5000,
            ...
        },
        "Retained Earnings": {
            "Drawing": 10900,
            "Retained earnings": -9000,
            ...
        }
    },
    "Liabilities": {
        "Long-term Liabilities": {
            "Long-term debt": 2000,
            ...
        },
        "Short-term Liabilities": {
            "Accounts payable": 150,
            ...
        }
    }
}

GET /api/bid?rid={rid}

Retrieve list of bid activity on resource.

Request Header

Authorization: bearer access_token

Query Parameters

• rid (required): UUID of object being bid on

JSON Response

{

}

GET /api/journal

Retrieve a list of users.

Request Header

Authorization: bearer access_token

JSON Body

{
  "pid": "kXxqvK",
  "sid": "wkZbmw", 
  "debits": [
      { 
        "group_id": "XWSgZx",  
        "framework_id": "JssvMn",  
        "account_id": "LjSdJp", 
        "amount": 30000
      },
      { 
        "group_id": "XWSgZx", 
        "framework_id": "JssvMn",  
        "account_id": "rKmGAy", 
        "amount": 30000
      }


  ],
  "credits": [
        { 
        "group_id": "fdzQnG", 
        "framework_id": "whGGfb",    
        "account_id": "fCKoIa",   
        "amount": 30000
      }
  ]
}

JSON Body Keys

• pid (required): Project ID
• sid (required): Artifact ID
• group_id (required): Balance sheet component (Asset, Liabity, Equity)
• framework_id (required): Fixed Asset, Current-asset, Short-term libabiliy etc
• account_id (required): Ledger account name (cash account, Notes payable, Paid-in capital excess of par)

JSON Response

{

}