{ "opencollection": "1.0.0", "info": { "name": "Modern Treasury AccountCapability LedgerTransaction API", "version": "v1" }, "items": [ { "info": { "name": "LedgerTransaction", "type": "folder" }, "items": [ { "info": { "name": "create ledger_transaction partial post", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:3000/api/ledger_transactions/:id/partial_post", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the ledger transaction to partially post." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create a ledger transaction that partially posts another ledger transaction." }, { "info": { "name": "create ledger_transaction reversal", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:3000/api/ledger_transactions/:id/reversal", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of ledger transaction to reverse." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create a ledger transaction reversal." }, { "info": { "name": "list ledger_transaction_versions", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:3000/api/ledger_transaction_versions", "params": [ { "name": "after_cursor", "value": "", "type": "query" }, { "name": "per_page", "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 dates after Jan 1 2000 12:00 UTC, use created_at%5Bgt%5D=2000-01-01T12:00:00Z." }, { "name": "version", "value": "", "type": "query", "description": "Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the version. For example, for all versions after 2, use version%5Bgt%5D=2." }, { "name": "ledger_transaction_id", "value": "", "type": "query", "description": "Get all the ledger transaction versions corresponding to the ID of a ledger transaction." }, { "name": "ledger_account_statement_id", "value": "", "type": "query", "description": "Get all ledger transaction versions that are included in the ledger account statement." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get a list of ledger transaction versions." }, { "info": { "name": "list ledger_transactions", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:3000/api/ledger_transactions", "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": "ledger_id", "value": "", "type": "query" }, { "name": "ledger_account_id", "value": "", "type": "query" }, { "name": "effective_at", "value": "", "type": "query", "description": "Use \"gt\" (>), \"gte\" (>=), \"lt\" (<), \"lte\" (<=), or \"eq\" (=) to filter by effective at. For example, for all transactions after Jan 1 2000, use effective_at%5Bgt%5D=2000-01-01T00:00:00:00.000Z." }, { "name": "effective_date", "value": "", "type": "query", "description": "Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by effective date. For example, for all dates after Jan 1 2000, use effective_date%5Bgt%5D=2000-01-01." }, { "name": "posted_at", "value": "", "type": "query", "description": "Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the posted at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use posted_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 posted 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": "order_by", "value": "", "type": "query", "description": "Order by `created_at` or `effective_at` in `asc` or `desc` order. For example, to order by `effective_at asc`, use `order_by%5Beffective_at%5D=asc`. Ordering by only one field at a time is supported." }, { "name": "amount", "value": "", "type": "query", "description": "Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by amount." }, { "name": "status", "value": "", "type": "query" }, { "name": "external_id", "value": "", "type": "query" }, { "name": "ledger_account_category_id", "value": "", "type": "query" }, { "name": "ledger_account_settlement_id", "value": "", "type": "query" }, { "name": "reverses_ledger_transaction_id", "value": "", "type": "query" }, { "name": "partially_posts_ledger_transaction_id", "value": "", "type": "query" }, { "name": "ledgerable_id", "value": "", "type": "query" }, { "name": "ledgerable_type", "value": "", "type": "query" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get a list of ledger transactions." }, { "info": { "name": "create ledger_transaction", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:3000/api/ledger_transactions", "headers": [ { "name": "Idempotency-Key", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create a ledger transaction." }, { "info": { "name": "get ledger_transaction", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:3000/api/ledger_transactions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ledger transaction id (UUID) or external_id. If using external_id, only non-archived Ledger Transactions will be returned." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get details on a single ledger transaction." }, { "info": { "name": "update ledger_transaction", "type": "http" }, "http": { "method": "PATCH", "url": "http://localhost:3000/api/ledger_transactions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ledger transaction id (UUID)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Update the details of a ledger transaction." }, { "info": { "name": "list ledger_transaction versions", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:3000/api/ledger_transactions/:id/versions", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "after_cursor", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "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": "created_at", "value": "", "type": "query", "description": "Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the created_at timestamp. For example, for all dates after Jan 1 2000 12:00 UTC, use created_at%5Bgt%5D=2000-01-01T12:00:00Z." }, { "name": "version", "value": "", "type": "query", "description": "Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the version. For example, for all versions after 2, use version%5Bgt%5D=2." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get a list of ledger transaction versions." } ] } ], "bundled": true }