Get Invoices

GET

1 curl https://api.trykeet.com/v1/agility/invoices \
2      -H "X-Account-Token: X-Account-Token" \
3      -H "Authorization: Bearer <token>"

Play

200Retrieved

1 {
2   "status": "status",
3   "invoices": [
4     {
5       "totalPremium": 1.1,
6       "totalAmountDue": 1.1,
7       "totalAdjustment": 1.1,
8       "paidAmount": 1.1,
9       "name": "name",
10       "invoiceStatus": "invoiceStatus",
11       "id": "id",
12       "hasPaymentRecord": true,
13       "pdfUrl": "pdfUrl",
14       "dueDate": "2023-01-15",
15       "currentBalance": 1.1,
16       "billingPeriodStartDate": "2023-01-15",
17       "billingPeriodEndDate": "2023-01-15",
18       "isPayable": true
19     },
20     {
21       "totalPremium": 1.1,
22       "totalAmountDue": 1.1,
23       "totalAdjustment": 1.1,
24       "paidAmount": 1.1,
25       "name": "name",
26       "invoiceStatus": "invoiceStatus",
27       "id": "id",
28       "hasPaymentRecord": true,
29       "pdfUrl": "pdfUrl",
30       "dueDate": "2023-01-15",
31       "currentBalance": 1.1,
32       "billingPeriodStartDate": "2023-01-15",
33       "billingPeriodEndDate": "2023-01-15",
34       "isPayable": true
35     }
36   ],
37   "hasUnpaidInvoice": true,
38   "hasMoreThanOneUnpaidInvoice": true,
39   "recurringPayment": true
40 }

Get invoices

Response

This endpoint returns an object.

statusstring

invoiceslist of objects

hasUnpaidInvoicebooleanOptional

hasMoreThanOneUnpaidInvoicebooleanOptional

recurringPaymentbooleanOptional

Get Invoices

Headers

Response

Errors