Login
DocumentationKnowledge BaseAPI ReferenceUse Cases
  • Introduction
    • Overview
  • API Reference
Login
LogoLogo
API ReferenceInvoices

GET
/v1/payable-registers/:payable_register_id
GET
/v1/payable-registers/:payable_register_id
1curl https://api.propexo.com/v1/payable-registers/payable_register_id \
2 -H "Authorization: Bearer <token>"
Try it
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": "string",
13 "created_at": "string",
14 "updated_at": "string",
15 "last_seen": "string",
16 "x_id": "string",
17 "x_property_id": "string",
18 "x_location_id": "string",
19 "x_financial_account_id": "string",
20 "x_cash_financial_account_id": "string",
21 "x_ap_financial_account_id": "string",
22 "x_vendor_id": "string",
23 "x_batch_id": "string",
24 "amount_due_in_cents": 100000,
25 "amount_paid_in_cents": 100000,
26 "custom_data": {},
27 "due_date": "string",
28 "discount_amount_in_cents": 100000,
29 "discount_date": "string",
30 "invoice_date": "string",
31 "invoice_number": "string",
32 "notes": "string",
33 "post_date": "string",
34 "post_month": "string",
35 "post_status_raw": "string",
36 "sub_total_amount_in_cents": 100000,
37 "total_amount_in_cents": 100000,
38 "status": "string",
39 "is_unpaid": true,
40 "is_adjustment": true,
41 "is_credit_memo": true,
42 "is_exempt_from_1099": true,
43 "display_type": "string",
44 "expense_type": "string",
45 "property_id": "string",
46 "financial_account_id": "string",
47 "cash_financial_account_id": "string",
48 "ap_financial_account_id": "string",
49 "integration_id": "string",
50 "integration_vendor": "SAMPLE2",
51 "payable_register_items": [
52 {
53 "x_id": "string",
54 "x_property_id": "string",
55 "x_location_id": "string",
56 "x_gl_account_id": "string",
57 "x_cash_financial_account_id": "string",
58 "payable_register_id": "string",
59 "construction_job_id": "string",
60 "amount_due_in_cents": 100000,
61 "notes": "string",
62 "total_amount_in_cents": 100000,
63 "cost_code": "string",
64 "property_id": "string",
65 "financial_account_id": "string",
66 "cash_financial_account_id": "string"
67 }
68 ]
69 }
70}
Was this page helpful?
Previous

Update a payable register

Next
Built with
Get a payable register by ID
Get a payable register by ID

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

payable_register_idstringRequired
The ID of the resource.

Query parameters

order-bystringOptionalDefaults to 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

offsetinteger or nullOptional>=0Defaults to 0
Can be used for paginating results
limitinteger or nullOptional>=0<=250Defaults to 100
A number between 1 and 250 to determine the number of results to return in a single query

Response

Successful response
metaobject
resultsobject

Errors

Can be used for paginating results
A number between 1 and 250 to determine the number of results to return in a single query
Successful response