{ "opencollection": "1.0.0", "info": { "name": "Sibill Integration Account Transaction API", "version": "1.0.0" }, "items": [ { "info": { "name": "Transaction", "type": "folder" }, "items": [ { "info": { "name": "List all transactions for the company", "type": "http" }, "http": { "method": "GET", "url": "http://integration.app.svc.cluster.local:4000/api/v1/companies/:company_id/transactions", "params": [ { "name": "company_id", "value": "", "type": "path", "description": "The company the transactions belong to" }, { "name": "page_size", "value": "", "type": "query", "description": "The page size" }, { "name": "cursor", "value": "", "type": "query", "description": "The pagination cursor. A cursor is used to paginate through a large set of data.\nIt is a unique identifier that represents a specific position in the dataset.\n" }, { "name": "expand", "value": "", "type": "query", "description": "Fields that will be expanded. Expandable fields: `category`, `subcategory`, `reconciliations`, `reconciliations.flow`" }, { "name": "filter", "value": "", "type": "query", "description": "List of filters on the resource. Currently the fields that allow to be filtered are: `account_id`, `booking_date_time`, `clean_description`, `counterpart_name`, `date`, `type`" }, { "name": "sort", "value": "", "type": "query", "description": "Fields for which we can order the results. Sortable fields: `amount`, `created_at`, `date`" } ] }, "docs": "The return value is paginated. By default the response contains 25 elements per page but can be instructed to return more elements per page.\nA cursor is needed to traverse the results.\n" }, { "info": { "name": "Get a transaction", "type": "http" }, "http": { "method": "GET", "url": "http://integration.app.svc.cluster.local:4000/api/v1/companies/:company_id/transactions/:id", "params": [ { "name": "company_id", "value": "", "type": "path", "description": "The company the transaction belongs to" }, { "name": "id", "value": "", "type": "path", "description": "The transaction identifier" }, { "name": "expand", "value": "", "type": "query", "description": "Fields that will be expanded. Expandable fields: `category`, `subcategory`, `reconciliations`, `reconciliations.flow`" } ] }, "docs": "Returns all the information for a specific transaction from its identifier" }, { "info": { "name": "Update an existing transaction", "type": "http" }, "http": { "method": "PATCH", "url": "http://integration.app.svc.cluster.local:4000/api/v1/companies/:company_id/transactions/:id", "params": [ { "name": "company_id", "value": "", "type": "path", "description": "The company where to execute the operation" }, { "name": "id", "value": "", "type": "path", "description": "The transaction identifier" }, { "name": "expand", "value": "", "type": "query", "description": "Fields that will be expanded. Expandable fields: `category`, `subcategory`, `reconciliations`, `reconciliations.flow`" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing transaction" } ] } ], "bundled": true }