Get an invoice by ID

GET

/v1/invoices/:invoice_id

GET

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

Play

200Retrieved

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

Get an invoice by 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

Successful response

metaobject

resultsobject

Get an invoice by ID

Path parameters

Headers

Query parameters

Response

Errors