> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.caresquareapi.com/api-reference/invoices-and-claims/invoices/list-invoices/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.caresquareapi.com/_mcp/server. # List invoices GET https://api.caresquareapi.com/api/public/v1/invoices Paginated list of invoices for the plan manager. Optional filters: participant_id, provider_id, claim_status, approval_status, invoice_number. Paginate with limit/offset, or pass after for a stable id-ascending cursor (start with after=0, then pagination.next_cursor). Requires X-Plan-Manager-Id header. Reference: https://docs.caresquareapi.com/api-reference/invoices-and-claims/invoices/list-invoices ## Authentication - `Authorization` header (bearer token, required) — API key issued for your account. Send as Bearer token in the Authorization header. - `X-Plan-Manager-Id` header (required) — Plan manager UUID. Required on all public API requests to scope data access. ## Request ### Query parameters - `participant_id` (string, optional) — Filter by participant UUID - `provider_id` (string, optional) — Filter by provider UUID (pm_provider_id) - `claim_status` (string, optional) — Filter by claim status - `approval_status` (string, optional) — Filter by approval status - `invoice_number` (string, optional) — Filter by exact invoice number - `limit` (integer, optional, default: 20) — Items per page (max 1000) - `offset` (integer, optional, default: 0) — Number of items to skip. Cannot be combined with after. - `after` (string, optional) — Keyset cursor. Returns records after this id (or error_code for the error catalogue), ordered by that field ascending. Pass pagination.next_cursor from the previous page. Start a cursor walk with after=0. Cannot be combined with a non-zero offset. ## Response ### 200 List of invoices - `data` (list of InvoiceResponse, required) - `pagination` (PaginationMeta, required) ## Errors ### 400 Bad Request Error Invalid request parameters - `success` (boolean, optional) - `error` (string, optional) — Error type or code - `detail` (string, optional) — Human-readable error message ### 403 Forbidden Error Access denied for plan manager - `success` (boolean, optional) - `error` (string, optional) — Error type or code - `detail` (string, optional) — Human-readable error message ### 500 Internal Server Error Internal server error - `success` (boolean, optional) - `error` (string, optional) — Error type or code - `detail` (string, optional) — Human-readable error message ## Types ### InvoiceResponse Invoice (list item or summary; no line items). - `id` (string, optional) - `invoice_number` (string, optional) - `invoice_date` (date, optional) - `total` (double, optional) - `tax` (double, optional) - `subtotal` (double, optional) - `plan_manager` (string, optional) - `participant_id` (string, optional) - `claim_status` (string, optional) - `approval_status` (string, optional) - `created_at` (datetime, optional) - `pm_provider_id` (string, optional) - `s3_key` (string, optional) - `email_message_id` (string, optional) — Email message ID associated with the invoice - `errors` (boolean, optional) - `state_management` (InvoiceResponseStateManagement, optional) — State management (object with errors/ignored_errors or string) - `is_deleted` (boolean, optional) - `wont_claim` (boolean, optional) - `is_reimbursement` (boolean, optional) - `is_duplicate` (boolean, optional) ### PaginationMeta - `limit` (integer, required) — Maximum number of items per page - `offset` (integer, required) — Number of items skipped - `has_more` (boolean, required) — Whether there are more items after this page - `total` (integer, optional, nullable) — Total matching items. Null for cursor pagination, which skips a full-table count. - `next_cursor` (string, optional, nullable) — Pass as `after` to fetch the next page. Set when using cursor pagination and has_more is true. ### InvoiceResponseStateManagement State management (object with errors/ignored_errors or string) ## Examples **Response** ```json { "data": [ { "id": "string", "invoice_number": "string", "invoice_date": "2023-01-15", "total": 1.1, "tax": 1.1, "subtotal": 1.1, "plan_manager": "string", "participant_id": "string", "claim_status": "string", "approval_status": "string", "created_at": "2024-01-15T09:30:00Z", "pm_provider_id": "string", "s3_key": "string", "email_message_id": "string", "errors": true, "state_management": {}, "is_deleted": true, "wont_claim": true, "is_reimbursement": true, "is_duplicate": true } ], "pagination": { "limit": 1, "offset": 1, "has_more": true, "total": 1, "next_cursor": "string" } } ``` **SDK Code** ```python import requests url = "https://api.caresquareapi.com/api/public/v1/invoices" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.caresquareapi.com/api/public/v1/invoices'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.caresquareapi.com/api/public/v1/invoices" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.caresquareapi.com/api/public/v1/invoices") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.caresquareapi.com/api/public/v1/invoices") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.caresquareapi.com/api/public/v1/invoices', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.caresquareapi.com/api/public/v1/invoices"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.caresquareapi.com/api/public/v1/invoices")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```