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 '{
  "issueDateFrom": "2022-12-01",
  "issueDateΤο": "2022-12-31",
  "dueDateFrom": "2022-12-01",
  "dueDateΤο": "2022-12-31",
  "status": 1
}'

[
  {
    "id": 3,
    "amount": 10,
    "paidAmount": 10,
    "status": 3,
    "fullname": "John  Johnson",
    "address": "123 Clement Street",
    "createdAt": "2024-04-21T12:22:40.661+00:00",
    "issueDate": "2024-04-01",
    "dueDate": "2024-04-30",
    "fees": [
      {
        "id": 18,
        "name": "Registration Fee",
        "amount": 10,
        "paidamount": 10,
        "status": "PAID"
      }
    ],
    "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
      }
    ]
  }
]

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.

issueDateFromdateRequired

issueDateΤοdateRequired

dueDateFromdateRequired

dueDateΤοdateRequired

statusintegerRequired

Response

idinteger

amountinteger

paidAmountinteger

statusinteger

fullnamestring

addressstring

createdAtdatetime

issueDatedate

dueDatedate

feeslist of objects

paymentslist of objects

invoiceRefIdanyOptional

telephoneanyOptional

emailanyOptional

privateNotesanyOptional

publicNotesanyOptional

Headers

Request

Response