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

feeslist of objects

amountinteger

statusinteger

addressstring

dueDatedate

fullnamestring

paymentslist of objects

createdAtdatetime

issueDatedate

paidAmountinteger

emailany

telephoneany

publicNotesany

invoiceRefIdany

privateNotesany

Headers

Response