Get bill

GET

/Bill/:idBill

GET

/api/Bill/:idBill

$ curl https://api-sandbox.payabli.com/api/Bill/285

1 {
2   "responseText": "Success",
3   "responseCode": 1,
4   "pageIdentifier": null,
5   "roomId": 0,
6   "isSuccess": true,
7   "responseData": {
8     "BillDate": "2025-07-01",
9     "DueDate": "2025-07-01",
10     "EndDate": null,
11     "IdBill": 285,
12     "BillNumber": "ABC-123",
13     "NetAmount": 100,
14     "Discount": null,
15     "TotalAmount": 100,
16     "Comments": "Deposit for materials",
17     "BatchNumber": null,
18     "BillItems": [
19       {
20         "itemCategories": null,
21         "itemCommodityCode": "010",
22         "itemCost": 5,
23         "itemDescription": "Deposit for materials.",
24         "itemMode": 0,
25         "itemProductCode": "M-DEPOSIT",
26         "itemProductName": "Materials deposit",
27         "itemQty": 1,
28         "itemTaxAmount": 7,
29         "itemTaxRate": 0.075,
30         "itemTotalAmount": 123,
31         "itemUnitOfMeasure": "SqFt"
32       }
33     ],
34     "Mode": 0,
35     "PaymentMethod": null,
36     "PaymentId": null,
37     "AccountingField1": "MyInternalId",
38     "AccountingField2": "MyInternalId",
39     "Terms": null,
40     "Source": null,
41     "AdditionalData": null,
42     "Vendor": {
43       "VendorNumber": "VEN-123",
44       "Name1": "Herman's Coatings and Masonry",
45       "Name2": "",
46       "EIN": "XXXX6789",
47       "Phone": "5555555555",
48       "Email": "contact@hermanscoatings.com",
49       "Address1": "123 Ocean Drive",
50       "Address2": "Suite 400",
51       "City": "Miami",
52       "State": "FL",
53       "Zip": "33139",
54       "Country": "US",
55       "Mcc": "7777",
56       "LocationCode": "MIA123",
57       "Contacts": [
58         {
59           "ContactName": "Herman Martinez",
60           "ContactEmail": "herman@hermanscoatings.com",
61           "ContactTitle": "Owner",
62           "ContactPhone": "3055550000"
63         }
64       ],
65       "BillingData": {
66         "id": 123,
67         "accountId": "acct-1xxxxx3123",
68         "nickname": "Checking Account",
69         "bankName": "Country Bank",
70         "routingAccount": "123123123",
71         "accountNumber": "1XXXXXX3123",
72         "typeAccount": "Checking",
73         "bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
74         "bankAccountHolderType": "Business",
75         "bankAccountFunction": 0,
76         "verified": true,
77         "status": 1,
78         "services": [],
79         "default": true
80       },
81       "PaymentMethod": "vcard",
82       "VendorStatus": 1,
83       "VendorId": 456,
84       "Summary": {
85         "ActiveBills": 5,
86         "PendingBills": 2,
87         "InTransitBills": 1,
88         "PaidBills": 10,
89         "OverdueBills": 0,
90         "ApprovedBills": 3,
91         "DisapprovedBills": 0,
92         "TotalBills": 21,
93         "ActiveBillsAmount": 1500,
94         "PendingBillsAmount": 500,
95         "InTransitBillsAmount": 200,
96         "PaidBillsAmount": 3000,
97         "OverdueBillsAmount": 0,
98         "ApprovedBillsAmount": 800,
99         "DisapprovedBillsAmount": 0,
100         "TotalBillsAmount": 6000
101       },
102       "PaypointLegalname": "Gruzya Adventure Outfitters LLC",
103       "PaypointDbaname": "Gruzya Adventure Outfitters",
104       "PaypointEntryname": "41035afaa7",
105       "ParentOrgName": "Pilgrim Planner",
106       "ParentOrgId": 1232,
107       "CreatedDate": "2022-07-01T15:00:01Z",
108       "LastUpdated": "2022-07-01T15:00:01Z",
109       "remitAddress1": "123 Walnut Street",
110       "remitAddress2": "Suite 900",
111       "remitCity": "Miami",
112       "remitState": "FL",
113       "remitZip": "31113",
114       "remitCountry": "US",
115       "payeeName1": "Herman Martinez",
116       "payeeName2": "",
117       "customField1": "",
118       "customField2": "",
119       "InternalReferenceId": 123,
120       "additionalData": {
121         "customField": "Custom Value 1",
122         "notes": "Additional vendor information",
123         "reference": "REF-12345"
124       },
125       "externalPaypointID": "ext123",
126       "StoredMethods": [],
127       "RemitEmail": null,
128       "EnrollmentStatus": null,
129       "customerVendorAccount": "A-37622"
130     },
131     "Status": -99,
132     "CreatedAt": "2025-07-01T15:00:01Z",
133     "LastUpdated": "2025-07-01T15:00:01Z",
134     "Frequency": null,
135     "billEvents": [
136       {
137         "description": "Created Bill",
138         "eventTime": "2025-07-01T15:00:01Z",
139         "extraData": null,
140         "refData": "REF-12345",
141         "source": "API"
142       }
143     ],
144     "billApprovals": null,
145     "PaypointLegalname": "Gruzya Adventure Outfitters LLC",
146     "PaypointDbaname": "Gruzya Adventure Outfitters",
147     "ParentOrgId": 1232,
148     "ParentOrgName": "Pilgrim Planner",
149     "PaypointEntryname": "41035afaa7",
150     "paylinkId": null,
151     "DocumentsRef": {
152       "filelist": [
153         {
154           "originalName": "invoice.pdf",
155           "zipName": "0_invoice.pdf",
156           "descriptor": "Invoice document"
157         }
158       ],
159       "zipfile": "documents_285.zip"
160     },
161     "externalPaypointID": null,
162     "LotNumber": "LOT-285",
163     "EntityID": null
164   }
165 }

Retrieves a bill by ID from an entrypoint.

Path parameters

idBillintegerRequired

Payabli ID for the bill. Get this ID by querying /api/Query/bills/ for the entrypoint or the organization.

Response

Success

responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

responseCodeintegerOptional

Code for the response. Learn more in API Response Codes.

pageIdentifierstringOptional

Auxiliary validation used internally by payment pages and components.

roomIdlongOptional

Field not in use on this endpoint. It always returns 0.

isSuccessbooleanOptional

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

responseDataobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error