Get an invoice by ID

GET

/v1/invoices/:invoice_id

Path parameters

invoice_idstringRequired

The ID of the resource.

Query parameters

order-bystringOptional

Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc

offsetintegerOptional

Can be used for paginating results

limitintegerOptional

A number between 1 and 250 to determine the number of results to return in a single query

Response

This endpoint returns an object.

metaobject

resultsobject

Errors

GET

1 curl https://api.propexo.com/v1/invoices/invoice_id \
2      -H "Authorization: Bearer <token>"

1 {
2   "meta": {
3     "orderBy": [
4       {}
5     ],
6     "offset": 42,
7     "limit": 42,
8     "hasMore": true,
9     "total": 42
10   },
11   "results": {
12     "id": "sample_value",
13     "created_at": "2024-07-01T00:00:00.000Z",
14     "updated_at": "2024-07-01T00:00:00.000Z",
15     "property_id": "sample_value",
16     "integration_id": "sample_value",
17     "integration_vendor": "sample_value",
18     "invoice_items": [
19       {
20         "invoice_id": "sample_value",
21         "construction_job_id": "sample_value",
22         "amount_due_in_cents": 1.1,
23         "notes": "sample_value",
24         "total_amount_in_cents": 1.1
25       }
26     ],
27     "last_seen": "2024-07-01T00:00:00.000Z",
28     "amount_due_in_cents": 1.1,
29     "amount_paid_in_cents": 1.1,
30     "due_date": "2024-07-01T00:00:00.000Z",
31     "discount_amount_in_cents": 1.1,
32     "discount_date": "2024-07-01T00:00:00.000Z",
33     "invoice_date": "2024-07-01T00:00:00.000Z",
34     "invoice_number": "sample_value",
35     "notes": "sample_value",
36     "post_date": "2024-07-01T00:00:00.000Z",
37     "post_month": "sample_value",
38     "post_status_raw": "sample_value",
39     "sub_total_amount_in_cents": 1.1,
40     "total_amount_in_cents": 1.1
41   }
42 }

Update invoice

Up Next

Built with

1	curl https://api.propexo.com/v1/invoices/invoice_id \
2	-H "Authorization: Bearer <token>"

1	{
2	"meta": {
3	"orderBy": [
4	{}
5	],
6	"offset": 42,
7	"limit": 42,
8	"hasMore": true,
9	"total": 42
10	},
11	"results": {
12	"id": "sample_value",
13	"created_at": "2024-07-01T00:00:00.000Z",
14	"updated_at": "2024-07-01T00:00:00.000Z",
15	"property_id": "sample_value",
16	"integration_id": "sample_value",
17	"integration_vendor": "sample_value",
18	"invoice_items": [
19	{
20	"invoice_id": "sample_value",
21	"construction_job_id": "sample_value",
22	"amount_due_in_cents": 1.1,
23	"notes": "sample_value",
24	"total_amount_in_cents": 1.1
25	}
26	],
27	"last_seen": "2024-07-01T00:00:00.000Z",
28	"amount_due_in_cents": 1.1,
29	"amount_paid_in_cents": 1.1,
30	"due_date": "2024-07-01T00:00:00.000Z",
31	"discount_amount_in_cents": 1.1,
32	"discount_date": "2024-07-01T00:00:00.000Z",
33	"invoice_date": "2024-07-01T00:00:00.000Z",
34	"invoice_number": "sample_value",
35	"notes": "sample_value",
36	"post_date": "2024-07-01T00:00:00.000Z",
37	"post_month": "sample_value",
38	"post_status_raw": "sample_value",
39	"sub_total_amount_in_cents": 1.1,
40	"total_amount_in_cents": 1.1
41	}
42	}