--- updatedAt: 2026-06-02T21:08:59.000Z agentTools: projectIndex: https://docs.bridgeft.com/llms.txt --- # Filter all Invoices Returns a filtered list of Invoices # OpenAPI definition ```json { "openapi": "3.0.3", "info": { "title": "Wealthtech API", "description": "RESTful API for controlling and interacting with Atlas data", "version": "2.6.0" }, "servers": [ { "url": "https://api.bridgeft.com/v2" } ], "x-readme": { "explorer-enabled": false, "proxy-enabled": true, "samples-enabled": true }, "paths": { "/billing/invoices/filter": { "post": { "tags": [ "Invoices" ], "summary": "Filter all Invoices", "description": "Returns a filtered list of Invoices", "operationId": "filterInvoices", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/page" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "The unique resource ID for this Invoice", "type": "integer" }, "firm_id": { "description": "The firm ID of the managing firm", "type": "integer" }, "billing_group_id": { "description": "The billing group ID for this Invoice", "type": "integer" }, "snapshot_date": { "description": "The snapshot date for this Invoice", "type": "string", "format": "date-time" }, "billing_report_id": { "description": "The associated billing report ID for this Invoice", "type": "integer" }, "annual_fee": { "description": "The total fee and debited amount annualized just for this billing group", "type": "number", "format": "float" }, "annual_debit": { "description": "The annual debit for this Invoice", "type": "number", "format": "float" }, "total_balance": { "description": "The total group balance on the snapshot date", "type": "number", "format": "float" }, "period_debit": { "description": "The total debited amount for the period just for this billing group on the snapshot date", "type": "number", "format": "float" }, "direct_billed_period_debit": { "description": "The direct billed period debit for this Invoice.", "type": "number", "format": "float" }, "custodian_billed_period_debit": { "description": "The custodian billed period debit for this Invoice", "type": "number", "format": "float" }, "n_accounts": { "description": "The number of accounts in the report", "type": "integer" }, "n_fee_structures": { "description": "The number of fee structures in the report", "type": "integer" }, "due_date": { "description": "Invoice due date, calculated using firm settings at the time the invoice was generated", "type": "string", "format": "date-time" }, "group_id": { "description": "Group Id of this invoice", "type": "integer" } } } } } }, "responses": { "200": { "description": "An enveloped list of Invoices", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "example": "list" }, "has_next": { "type": "boolean" }, "has_previous": { "type": "boolean" }, "current_page": { "type": "integer", "example": 2 }, "total_pages": { "type": "integer", "example": 5 }, "page_size_limit": { "type": "integer", "example": 10000 }, "total_items": { "type": "integer", "example": 50 }, "data": { "$ref": "#/components/schemas/Invoices" } } } } } }, "400": { "$ref": "#/paths/~1jobs~1/get/responses/400" } } } }, "/jobs/": { "get": { "tags": [ "Jobs" ], "summary": "List all Jobs", "description": "Returns a list of jobs", "operationId": "getJobs", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/page" } ], "responses": { "200": { "description": "An enveloped list of Jobs", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "example": "list" }, "has_next": { "type": "boolean" }, "has_previous": { "type": "boolean" }, "current_page": { "type": "integer", "example": 2 }, "total_pages": { "type": "integer", "example": 5 }, "page_size_limit": { "type": "integer", "example": 10000 }, "total_items": { "type": "integer", "example": 50 }, "data": { "$ref": "#/components/schemas/Jobs" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "parameters": { "limit": { "name": "pager.limit", "in": "query", "description": "Number of items to return per page", "required": false, "schema": { "type": "integer" }, "example": 10000 }, "page": { "name": "pager.page", "in": "query", "description": "Current page number", "required": false, "schema": { "type": "integer" }, "example": 1 } }, "schemas": { "Invoice": { "type": "object", "properties": { "id": { "description": "The unique resource ID for this Invoice", "type": "integer" }, "firm_id": { "description": "The firm ID of the managing firm", "type": "integer" }, "household_id": { "description": "Household id associated with the invoice", "type": "integer" }, "minimum_ids": { "description": "The list of minumum ID's associated with this Invoice", "type": "array", "items": { "type": "integer" } }, "billing_date": { "description": "Billing date for this Invoice", "type": "string", "format": "date-time" }, "billing_group_id": { "description": "The billing group ID for this Invoice", "type": "integer" }, "snapshot_date": { "description": "The snapshot date for this Invoice", "type": "string", "format": "date-time" }, "billing_report_id": { "description": "The associated billing report ID for this Invoice", "type": "integer" }, "account_value_on_snapshot_date": { "description": "Maps account ID to total account valuation on a particular date", "type": "object" }, "account_cash_on_snapshot_date": { "description": "Maps the cash amount in the account as of the billing date", "type": "object" }, "account_value_on_run_date": { "description": "Maps account ID to total account valuation as of the report run date", "type": "object" }, "account_cash_on_run_date": { "description": "Maps the cash amount in the account as of the report run date", "type": "object" }, "group_value_on_snapshot_date": { "description": "Maps a group ID to the total value of all accounts in the group on the snapshot date", "type": "object" }, "group_cash_on_snapshot_date": { "description": "Maps group ID to the total cash value of all accounts in the group on the snapshot date", "type": "object" }, "group_value_on_run_date": { "description": "Maps a group ID to the total value of all accounts in the group on the run date", "type": "object" }, "group_cash_on_run_date": { "description": "Maps group ID to the total cash value of all accounts in the group on the run date", "type": "object" }, "annual_fee": { "description": "The total fee and debited amount annualized just for this billing group", "type": "number", "format": "float" }, "annual_debit": { "description": "The annual debit for this Invoice", "type": "number", "format": "float" }, "total_balance": { "description": "The total group balance on the snapshot date", "type": "number", "format": "float" }, "period_debit": { "description": "The total debited amount for the period just for this billing group on the snapshot date", "type": "number", "format": "float" }, "direct_billed_period_debit": { "description": "The direct billed period debit for this Invoice.", "type": "number", "format": "float" }, "custodian_billed_period_debit": { "description": "The custodian billed period debit for this Invoice", "type": "number", "format": "float" }, "account_ids": { "description": "The list of account ID's associated with this Invoice", "type": "array", "items": { "type": "integer" } }, "fee_structure_ids": { "description": "The list of fee structure ID's associated with this Invoice", "type": "array", "items": { "type": "integer" } }, "n_accounts": { "description": "The number of accounts in the report", "type": "integer" }, "n_fee_structures": { "description": "The number of fee structures in the report", "type": "integer" }, "account_df": { "description": "Serialized from the account_df data-frame on the billing calculator", "type": "object" }, "group_df": { "description": "Serialized from group_df on the billing calculator", "type": "object" }, "minfee_df": { "description": "Serialized from minimum fee on the billing calculator", "type": "object" }, "fee_structures_serialized": { "description": "A serialization of fee structures as they existed at the time the report was generated", "type": "object" }, "asset_adjustments_serialized": { "description": "Serialized asset adjustments at the time the report was generated", "type": "object" }, "billing_group_serialized": { "description": "Serialized billing group at the time the invoice was created", "type": "object" }, "download_url": { "description": "Download link which specifies the url to generate and return a binary stream for the Invoice PDF.", "type": "string" }, "due_date": { "description": "Invoice due date, calculated using firm settings at the time the invoice was generated", "type": "string", "format": "date-time" }, "account_fs_df": { "description": "Serialized from the account_fs_df dataframe on the billing calculator", "type": "object" }, "group_id": { "description": "Group Id of this invoice", "type": "integer" }, "pdf_state": { "description": "State of the billing invoice pdf state. 0 for does not exist, 1 for created, 2 for generating, 3 for success, -1 for failed", "type": "string" }, "client_name": { "description": "Name of the client associated with this invoice", "type": "string" }, "fee_structure_assignments": { "description": "Serialized fee structure assignments at the time the invoice was created", "type": "object" }, "created_at_utc": { "description": "Timestamp for when the record was created", "type": "string", "format": "date-time" }, "updated_at_utc": { "description": "Timestamp for when the record was updated", "type": "string", "format": "date-time" } } }, "Invoices": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice" } }, "Error": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" }, "validation_errors": { "type": "array", "items": { "type": "string" } } } } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "Bearer" } } }, "security": [ { "bearerAuth": [] } ] } ```