> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.propexo.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.propexo.com/_mcp/server. # Get an invoice by ID GET https://api.propexo.com/v1/invoices/{invoice_id} Get an invoice by ID Reference: https://docs.propexo.com/api-reference/pms-generic-ap-is/invoices/get-an-invoice-by-id ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Servers - `https://api.propexo.com` (Production, default) - `https://api.sandbox.propexo.com` (Sandbox) ## Request ### Path parameters - `invoice_id` (string, required) — The ID of the resource. ### Query parameters - `order-by` (string, optional, default: created_at:desc) — Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc - `updated_at_gte` (string, optional, nullable) — Filter to records updated at or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z) - `updated_at_lte` (string, optional, nullable) — Filter to records updated at or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z) - `last_seen_gte` (string, optional, nullable) — Filter to records whose last_seen date is on or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z) - `last_seen_lte` (string, optional, nullable) — Filter to records whose last_seen date is on or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z) - `offset` (integer, optional, nullable, default: 0) — Can be used for paginating results - `limit` (integer, optional, nullable, default: 100) — A number between 1 and 250 to determine the number of results to return in a single query ## Response ### 200 Successful response - `meta` (ResponseMeta, required) - `results` (V1InvoicesInvoiceIdGetOutputResults, required) ## Errors ### 400 Bad Request Error Bad Request - `error` (ErrorResponseError, required) ## Types ### ResponseMeta - `orderBy` (list of ResponseMetaOrderByItems, required) - `offset` (integer, optional) — The offset of the first result - `limit` (integer, optional) — The number of results to return - `hasMore` (boolean, optional, nullable) — Whether there are more results - `total` (integer, optional) — The total number of results ### V1InvoicesInvoiceIdGetOutputResults - `id` (string, required) — The Propexo unique identifier for the invoice - `created_at` (string, required) — The date record first entered Propexo - `updated_at` (string, required) — The date record was last updated in Propexo - `last_seen` (string, required, nullable) — The date the record was last seen from the PMS - `x_id` (string, required) — The external ID from the integration vendor - `x_property_id` (string, required) — The external ID of the property from the integration vendor - `x_location_id` (string, required, nullable) — The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. - `x_vendor_id` (string, required, nullable) — The external ID of the vendor from the integration vendor - `x_financial_account_id` (string, required, nullable) — The external ID of the financial account from the integration vendor - `x_cash_financial_account_id` (string, required, nullable) — The external ID of the cash financial account from the integration vendor - `x_ap_financial_account_id` (string, required, nullable) — The external ID of the AP financial account from the integration vendor - `amount_due_in_cents` (double, required, nullable) — The amount due on the invoice, in cents - `amount_paid_in_cents` (double, required, nullable) — The amount paid on the invoice, in cents - `custom_data` (V1InvoicesInvoiceIdGetOutputResultsCustomData, required, nullable) - `due_date` (string, required, nullable) — The due date associated with the invoice - `discount_amount_in_cents` (double, required, nullable) — The deposit amount in cents associated with the invoice - `discount_date` (string, required, nullable) — The date a discount was issued on invoice - `invoice_date` (string, required, nullable) — The date the invoice was issued - `invoice_number` (string, required, nullable) — The reference number for the invoice - `notes` (string, required, nullable) — Notes associated with the invoice - `post_date` (string, required, nullable) — The date the invoice was posted. Some PMS systems only show the month. - `post_month` (string, required, nullable) — The month the invoice was posted. - `post_status_raw` (string, required, nullable) — The raw post status associated with the invoice - `sub_total_amount_in_cents` (double, required, nullable) — The sub total amount of the invoice - `total_amount_in_cents` (double, required, nullable) — The amount of the invoice, in cents - `property_id` (string, required) — The Propexo unique identifier for the property - `financial_account_id` (string, required, nullable) — The Propexo unique identifier for the financial account - `cash_financial_account_id` (string, required, nullable) — The Propexo unique identifier for the cash financial account - `ap_financial_account_id` (string, required, nullable) — The Propexo unique identifier for the ap financial account - `integration_id` (string, required) — The Propexo unique identifier for the integration - `integration_vendor` (enum, required) — The property management system of record - Allowed values: `APPFOLIO`, `BUILDIUM`, `ENTRATA`, `MRI`, `PROPERTYWARE`, `PROPERTYWARE_REST`, `REALPAGE`, `REALPAGE_RPX`, `RENTMANAGER`, `RENTVINE`, `RESMAN`, `YARDI`, `YARDI_REST` - `invoice_items` (list of V1InvoicesInvoiceIdGetOutputResultsInvoiceItemsItems, required) ### ErrorResponseError - `code` (string, required) - `message` (string, required) - `details` (map from string to any, optional) ### ResponseMetaOrderByItems ### V1InvoicesInvoiceIdGetOutputResultsCustomData ### V1InvoicesInvoiceIdGetOutputResultsInvoiceItemsItems - `x_id` (string, required) — The external ID from the integration vendor - `x_property_id` (string, required) — The external ID of the property from the integration vendor - `x_location_id` (string, required, nullable) — The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. - `x_gl_account_id` (string, required, nullable) — The external ID of the financial account from the integration vendor - `x_cash_financial_account_id` (string, required, nullable) — The external ID of the cash financial account from the integration vendor - `invoice_id` (string, required) — The Propexo unique identifier for the invoice - `construction_job_id` (string, required, nullable) — The Propexo unique identifier for the construction job - `amount_due_in_cents` (double, required, nullable) — The amount due on the invoice item, in cents - `notes` (string, required, nullable) — Notes associated with the invoice item - `total_amount_in_cents` (double, required, nullable) — The amount of the invoice item, in cents - `property_id` (string, required) — The Propexo unique identifier for the property - `financial_account_id` (string, required, nullable) — The Propexo unique identifier for the financial account - `cash_financial_account_id` (string, required, nullable) — The Propexo unique identifier for the cash financial account ## Examples **Request** ```json {} ``` **Response** ```json { "meta": { "orderBy": [ {} ], "offset": 0, "limit": 100, "hasMore": true, "total": 1000 }, "results": { "id": "inv_9f8b7c6d5e4a3b2c1d0e", "created_at": "2024-05-10T09:15:00Z", "updated_at": "2024-05-15T16:45:00Z", "last_seen": "2024-05-15T16:45:00Z", "x_id": "EXT123456789", "x_property_id": "PROP987654321", "x_location_id": null, "x_vendor_id": "VEND112233", "x_financial_account_id": "FA998877", "x_cash_financial_account_id": "CFA554433", "x_ap_financial_account_id": "APA667788", "amount_due_in_cents": 125000, "amount_paid_in_cents": 75000, "custom_data": {}, "due_date": "2024-06-01", "discount_amount_in_cents": 5000, "discount_date": "2024-05-20", "invoice_date": "2024-05-10", "invoice_number": "INV-20240510-001", "notes": "Payment partial, balance due by June 1st.", "post_date": "2024-05-11", "post_month": "2024-05", "post_status_raw": "Posted", "sub_total_amount_in_cents": 130000, "total_amount_in_cents": 125000, "property_id": "prop_123abc456def", "financial_account_id": "finacc_789xyz123uvw", "cash_financial_account_id": "cashacc_456def789ghi", "ap_financial_account_id": "apacc_321uvw654rst", "integration_id": "int_abc123def456", "integration_vendor": "APPFOLIO", "invoice_items": [ { "x_id": "ITEM123456", "x_property_id": "PROP987654321", "x_location_id": null, "x_gl_account_id": "GL123456789", "x_cash_financial_account_id": "CFA554433", "invoice_id": "inv_9f8b7c6d5e4a3b2c1d0e", "construction_job_id": null, "amount_due_in_cents": 50000, "notes": "Monthly maintenance fee", "total_amount_in_cents": 50000, "property_id": "prop_123abc456def", "financial_account_id": "finacc_789xyz123uvw", "cash_financial_account_id": "cashacc_456def789ghi" } ] } } ``` **SDK Code** ```python import requests url = "https://api.propexo.com/v1/invoices/invoice_id" payload = {} headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.get(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.propexo.com/v1/invoices/invoice_id'; const options = { method: 'GET', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{}' }; 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" "strings" "net/http" "io" ) func main() { url := "https://api.propexo.com/v1/invoices/invoice_id" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") 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.propexo.com/v1/invoices/invoice_id") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{}" 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.propexo.com/v1/invoices/invoice_id") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://api.propexo.com/v1/invoices/invoice_id', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.propexo.com/v1/invoices/invoice_id"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.propexo.com/v1/invoices/invoice_id")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers request.httpBody = postData as Data 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() ```