Get bill

GET

/Bill/:idBill

GET

/api/Bill/:idBill

1 curl https://api-sandbox.payabli.com/api/Bill/285 \
2      -H "requestToken: <apiKey>"

1 {
2   "isSuccess": true,
3   "responseData": {
4     "AdditionalData": "AdditionalData",
5     "DocumentRefs": {
6       "key": "value"
7     },
8     "Transaction": {
9       "Bills": [
10         {
11           "AccountingField1": "MyInternalId",
12           "AccountingField2": "MyInternalId",
13           "AdditionalData": "AdditionalData",
14           "attachments": [
15             {
16               "fContent": "TXkgdGVzdCBmaWxlHJ==...",
17               "filename": "my-doc.pdf",
18               "ftype": "pdf",
19               "furl": "https://mysite.com/my-doc.pdf"
20             }
21           ],
22           "billId": 123,
23           "comments": "Deposit for materials",
24           "dueDate": "2025-07-01",
25           "invoiceDate": "2025-07-01",
26           "invoiceNumber": "INV-2345",
27           "netAmount": "netAmount",
28           "Terms": "NET30"
29         }
30       ],
31       "CheckData": {
32         "fContent": "TXkgdGVzdCBmaWxlHJ==...",
33         "filename": "my-doc.pdf",
34         "ftype": "pdf",
35         "furl": "https://mysite.com/my-doc.pdf"
36       },
37       "CheckNumber": "12345",
38       "Comments": "Deposit for materials",
39       "CreatedDate": "2022-07-01T15:00:01Z",
40       "Events": [
41         {
42           "EventData": {
43             "key": "value"
44           },
45           "EventTime": "2023-11-07T05:31:56Z",
46           "TransEvent": "Approved"
47         }
48       ],
49       "FeeAmount": 10.25,
50       "Gateway": "TSYS",
51       "IdOut": 236,
52       "LastUpdated": "2022-07-01T15:00:01Z",
53       "NetAmount": 100,
54       "parentOrgName": "PropertyManager Pro",
55       "PaymentData": {
56         "AccountExp": "11/29",
57         "AccountType": "visa",
58         "AccountZip": "90210",
59         "binData": {
60           "binCardBrand": "Visa",
61           "binCardCategory": "PLATINUM",
62           "binCardIssuer": "Bank of Example",
63           "binCardIssuerCountry": "United States",
64           "binCardIssuerCountryCodeA2": "US",
65           "binCardIssuerCountryNumber": 840,
66           "binCardType": "Credit",
67           "binMatchedLength": 6
68         },
69         "HolderName": "Chad Mercia",
70         "Initiator": "payor",
71         "MaskedAccount": "4XXXXXXXX1111",
72         "orderDescription": "Depost for materials for 123 Walnut St",
73         "paymentDetails": {
74           "totalAmount": 100,
75           "categories": [
76             {
77               "amount": 1000,
78               "label": "Deposit",
79               "description": "Deposit for materials",
80               "qty": 123
81             }
82           ],
83           "checkImage": {
84             "key": "value"
85           },
86           "checkNumber": "107",
87           "currency": "USD",
88           "serviceFee": 0,
89           "splitFunding": [
90             {
91               "accountId": "187-782",
92               "amount": 456.23,
93               "description": "Split for annual dues",
94               "recipientEntryPoint": "41035afaa7"
95             }
96           ]
97         },
98         "Sequence": "subsequent",
99         "StoredId": "1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440",
100         "StoredMethodUsageType": "subscription"
101       },
102       "PaymentGroup": "2345667-ddd-fff",
103       "PaymentId": "2345667-ddd-fff",
104       "PaymentMethod": "ach",
105       "PaymentStatus": "Processed",
106       "paypointDbaname": "Sunshine Gutters",
107       "paypointLegalname": "Sunshine Services, LLC",
108       "Source": "api",
109       "Status": 1,
110       "StatusText": "Captured",
111       "TotalAmount": 110.25,
112       "Vendor": {
113         "additionalData": {
114           "key1": {
115             "key": "value"
116           },
117           "key2": {
118             "key": "value"
119           },
120           "key3": {
121             "key": "value"
122           }
123         },
124         "address1": "123 Ocean Drive",
125         "address2": "Suite 400",
126         "billingData": {
127           "accountNumber": "1XXXXXX3123",
128           "bankAccountFunction": 0,
129           "bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
130           "bankAccountHolderType": "Business",
131           "bankName": "Country Bank",
132           "id": 123,
133           "routingAccount": "123123123",
134           "typeAccount": "Checking"
135         },
136         "city": "Bristol",
137         "contacts": [
138           {
139             "contactEmail": "herman@hermanscoatings.com",
140             "contactName": "Herman Martinez",
141             "contactPhone": "3055550000",
142             "contactTitle": "Owner"
143           }
144         ],
145         "country": "US",
146         "createdDate": "2022-07-01T15:00:01Z",
147         "customerVendorAccount": "123-456",
148         "ein": "123456789",
149         "email": "example@example.com",
150         "externalPaypointId": "Paypoint-100",
151         "internalReferenceId": 123,
152         "lastUpdated": "2022-07-01T15:00:01Z",
153         "locationCode": "LOC123",
154         "mcc": "7777",
155         "name1": "Herman's Coatings",
156         "name2": "Herman's Coating Supply Company, LLC",
157         "parentOrgName": "PropertyManager Pro",
158         "paymentMethod": {
159           "method": "managed"
160         },
161         "paypointDbaname": "Sunshine Gutters",
162         "paypointEntryname": "d193cf9a46",
163         "paypointLegalname": "Sunshine Services, LLC",
164         "phone": "212-555-1234",
165         "remitAddress1": "123 Walnut Street",
166         "remitAddress2": "Suite 900",
167         "remitCity": "Miami",
168         "remitCountry": "US",
169         "remitState": "FL",
170         "remitZip": "31113",
171         "state": "GA",
172         "summary": {
173           "inTransitBills": 123,
174           "inTransitBillsAmount": 123,
175           "overdueBills": 123,
176           "overdueBillsAmount": 123,
177           "paidBills": 123,
178           "paidBillsAmount": 123,
179           "pendingBills": 123,
180           "pendingBillsAmount": 123,
181           "totalBills": 123,
182           "totalBillsAmount": 123
183         },
184         "vendorId": 1,
185         "vendorNumber": "1234",
186         "vendorStatus": 1,
187         "zip": "31113"
188       }
189     },
190     "accountingField1": "MyInternalId",
191     "accountingField2": "MyInternalId",
192     "billDate": "2025-07-01",
193     "billItems": [
194       {
195         "itemCost": 5,
196         "itemCommodityCode": "010",
197         "itemDescription": "Deposit for materials.",
198         "itemMode": 0,
199         "itemProductCode": "M-DEPOSIT",
200         "itemProductName": "Materials deposit",
201         "itemQty": 1,
202         "itemTaxAmount": 7,
203         "itemTaxRate": 0.075,
204         "itemTotalAmount": 123,
205         "itemUnitOfMeasure": "SqFt"
206       }
207     ],
208     "billNumber": "ABC-123",
209     "comments": "Deposit for materials",
210     "dueDate": "2025-07-01",
211     "endDate": "2025-07-01",
212     "frequency": "monthly",
213     "mode": 0,
214     "netAmount": "netAmount",
215     "status": -99,
216     "terms": "NET30",
217     "vendor": {
218       "AdditionalData": "AdditionalData",
219       "address1": "123 Ocean Drive",
220       "address2": "Suite 400",
221       "billingData": {
222         "accountNumber": "1XXXXXX3123",
223         "bankAccountFunction": 0,
224         "bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
225         "bankAccountHolderType": "Business",
226         "bankName": "Country Bank",
227         "id": 123,
228         "routingAccount": "123123123",
229         "typeAccount": "Checking"
230       },
231       "city": "Miami",
232       "contacts": [
233         {
234           "contactEmail": "herman@hermanscoatings.com",
235           "contactName": "Herman Martinez",
236           "contactPhone": "3055550000",
237           "contactTitle": "Owner"
238         }
239       ],
240       "country": "US",
241       "customerVendorAccount": "A-37622",
242       "ein": "XXXX6789",
243       "email": "contact@hermanscoatings.com",
244       "internalReferenceId": 123,
245       "locationCode": "MIA123",
246       "mcc": "7777",
247       "name1": "Herman's Coatings and Masonry",
248       "paymentMethod": "vcard",
249       "phone": "5555555555",
250       "remitAddress1": "123 Walnut Street",
251       "remitAddress2": "Suite 900",
252       "remitCity": "Miami",
253       "remitCountry": "US",
254       "remitState": "FL",
255       "remitZip": "31113",
256       "state": "FL",
257       "vendorId": 1,
258       "vendorNumber": "1234",
259       "vendorStatus": 1,
260       "zip": "33139"
261     }
262   },
263   "responseText": "Success"
264 }

Retrieves a bill by ID from an entrypoint.

Authentication

requestTokenstring

API Key authentication via header

Path parameters

idBillintegerRequired

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

Response

Success

isSuccessboolean

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

responseDataobject

responseTextstring

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

Errors

400

Bad Request Error

400

Bad Request Error

401

Unauthorized Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error