{
  "opencollection": "1.0.0",
  "info": {
    "name": "Modern Treasury AccountCapability LedgerAccount API",
    "version": "v1"
  },
  "items": [
    {
      "info": {
        "name": "LedgerAccount",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "list ledger_accounts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:3000/api/ledger_accounts",
            "params": [
              {
                "name": "after_cursor",
                "value": "",
                "type": "query"
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query"
              },
              {
                "name": "metadata",
                "value": "",
                "type": "query",
                "description": "For example, if you want to query for records with metadata key `Type` and value `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query parameters."
              },
              {
                "name": "id[]",
                "value": "",
                "type": "query",
                "description": "If you have specific IDs to retrieve in bulk, you can pass them as query parameters delimited with `id[]=`, for example `?id[]=123&id[]=abc`."
              },
              {
                "name": "name[]",
                "value": "",
                "type": "query",
                "description": "If you have specific names to retrieve in bulk, you can pass them as query parameters delimited with `name[]=`, for example `?name[]=123&name[]=abc`."
              },
              {
                "name": "ledger_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "external_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "currency",
                "value": "",
                "type": "query"
              },
              {
                "name": "balances",
                "value": "",
                "type": "query",
                "description": "Use `balances[effective_at_lower_bound]` and `balances[effective_at_upper_bound]` to get the balances change between the two timestamps. The lower bound is inclusive while the upper bound is exclusive of the provided timestamps. If no value is supplied the balances will be retrieved not including that bound."
              },
              {
                "name": "pending_balance_amount",
                "value": "",
                "type": "query",
                "description": "Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), `eq` (=), or `not_eq` (!=) to filter by balance amount."
              },
              {
                "name": "posted_balance_amount",
                "value": "",
                "type": "query",
                "description": "Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), `eq` (=), or `not_eq` (!=) to filter by balance amount."
              },
              {
                "name": "available_balance_amount",
                "value": "",
                "type": "query",
                "description": "Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), `eq` (=), or `not_eq` (!=) to filter by balance amount."
              },
              {
                "name": "normal_balance",
                "value": "",
                "type": "query"
              },
              {
                "name": "created_at",
                "value": "",
                "type": "query",
                "description": "Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the created at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use created_at%5Bgt%5D=2000-01-01T12:00:00Z."
              },
              {
                "name": "updated_at",
                "value": "",
                "type": "query",
                "description": "Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the updated at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use updated_at%5Bgt%5D=2000-01-01T12:00:00Z."
              },
              {
                "name": "ledger_account_category_id",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get a list of ledger accounts."
        },
        {
          "info": {
            "name": "create ledger_account",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost:3000/api/ledger_accounts",
            "headers": [
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Create a ledger account."
        },
        {
          "info": {
            "name": "get ledger_account",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:3000/api/ledger_accounts/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ledger account id (UUID)"
              },
              {
                "name": "balances",
                "value": "",
                "type": "query",
                "description": "Use `balances[effective_at_lower_bound]` and `balances[effective_at_upper_bound]` to get the balances change between the two timestamps. The lower bound is inclusive while the upper bound is exclusive of the provided timestamps. If no value is supplied the balances will be retrieved not including that bound. Use `balances[as_of_lock_version]` to retrieve a balance as of a specific Ledger Account `lock_version`."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get details on a single ledger account."
        },
        {
          "info": {
            "name": "update ledger_account",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "http://localhost:3000/api/ledger_accounts/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ledger account id (UUID)"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Update the details of a ledger account."
        },
        {
          "info": {
            "name": "delete ledger_account",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://localhost:3000/api/ledger_accounts/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ledger account id (UUID)"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Delete a ledger account."
        }
      ]
    }
  ],
  "bundled": true
}