GetInvoice

GET

/dreamclassapi/v1/financial/invoices/get/%7BinvoiceId%7D

GET

/dreamclassapi/v1/financial/invoices/get/%7BinvoiceId%7D

1 curl https://https//https/dreamclassapi/v1/financial/invoices/get/%7BinvoiceId%7D \
2      -H "tenant: {{tenant}}" \
3      -H "schoolCode: {{schoolCode}}"

200Invoices_GetInvoice_example

1 {
2   "id": 3,
3   "amount": 10,
4   "paidAmount": 10,
5   "status": 3,
6   "fullname": "John  Johnson",
7   "address": "123 Clement Street",
8   "createdAt": "2024-04-21T12:22:40.661+00:00",
9   "issueDate": "2024-04-01",
10   "dueDate": "2024-04-30",
11   "fees": [
12     {
13       "id": 18,
14       "name": "Registration Fee",
15       "amount": 10,
16       "paidamount": 10,
17       "status": "PAID"
18     }
19   ],
20   "payments": [
21     {
22       "id": 2,
23       "amount": 5,
24       "createdAt": "2024-04-21T12:24:06.877+00:00",
25       "date": "2024-04-21",
26       "invoiceId": 3
27     },
28     {
29       "id": 1,
30       "amount": 5,
31       "createdAt": "2024-04-21T12:23:07.533+00:00",
32       "date": "2024-04-21",
33       "invoiceId": 3,
34       "paymentmethod": null
35     }
36   ]
37 }

Get details of a single invoice

Input variables

invoiceId: number of the invoice

Get details of a single invoice Input variables - invoiceId: number of the invoice

Response

idinteger

amountinteger

paidAmountinteger

statusinteger

fullnamestring

addressstring

createdAtdatetime

issueDatedate

dueDatedate

feeslist of objects

paymentslist of objects

invoiceRefIdanyOptional

telephoneanyOptional

emailanyOptional

privateNotesanyOptional

publicNotesanyOptional

Headers

Response