GetInvoices | DreamClass

curl -X POST https://https//https/dreamclassapi/v1/financial/invoices/list \
     -H "tenant: {{tenant}}" \
     -H "schoolCode: {{schoolCode}}" \
     -H "Content-Type: application/json" \
     -d '{
  "status": 1,
  "dueDateFrom": "2022-12-01",
  "dueDateΤο": "2022-12-31",
  "issueDateFrom": "2022-12-01",
  "issueDateΤο": "2022-12-31"
}'

[
  {
    "id": 3,
    "fees": [
      {
        "id": 18,
        "name": "Registration Fee",
        "amount": 10,
        "status": "PAID",
        "paidamount": 10
      }
    ],
    "amount": 10,
    "status": 3,
    "address": "123 Clement Street",
    "dueDate": "2024-04-30",
    "fullname": "John  Johnson",
    "payments": [
      {
        "id": 2,
        "amount": 5,
        "createdAt": "2024-04-21T12:24:06.877+00:00",
        "invoiceId": 3
      },
      {
        "id": 1,
        "amount": 5,
        "createdAt": "2024-04-21T12:23:07.533+00:00",
        "invoiceId": 3,
        "paymentmethod": null
      }
    ],
    "createdAt": "2024-04-21T12:22:40.661+00:00",
    "issueDate": "2024-04-01",
    "paidAmount": 10
  }
]

Returns a list of invoices based on issue date, due date and status

Input variables

json representation of an Invoicefilters object with properties
1. issueDateFrom
2. issueDateTo
3. dueDateFrom
4. dueDateTo
5. status of Invoice (1 unpaid, 2 partially paid, 3 fully paid)

Returns a list of invoices based on issue date, due date and status Input variables 1. json representation of an Invoicefilters object with properties 1. issueDateFrom 2. issueDateTo 3. dueDateFrom 4. dueDateTo 5. status of Invoice (1 unpaid, 2 partially paid, 3 fully paid)

Request

This endpoint expects an object.

statusintegerRequired

dueDateFromdateRequired

dueDateΤοdateRequired

issueDateFromdateRequired

issueDateΤοdateRequired

Response

idinteger

feeslist of objects

amountinteger

statusinteger

addressstring

dueDatedate

fullnamestring

paymentslist of objects

createdAtdatetime

issueDatedate

paidAmountinteger

emailany

telephoneany

publicNotesany

invoiceRefIdany

privateNotesany

Headers

Request

Response