Invoice

GET /report/invoice

This API is to get invoice report. This is an authendicated API so we need to pass bearer token in request header to access the data.

Headers

  • Authorization string Required
  • Accept string

Query parameters

  • region number

    Id of the region to filter report

  • client number

    Id of the client to filter report

  • start_date string(date) Required

    The planned day to get report from

  • end_date string(date) Required

    The planned day to get report till

  • business_unit number

    Id of the business unit to filter report

  • business_unit_name string

    Name of business unit name to filter

  • per_page number

    Minimum value is 1 and maximum value is 100

    Default value is 100.

  • filter_type string

    Filter invoice report using date created or by using from and to date, default will be created_date

    Values are created_date or from_to_date. Default value is created_date.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • status string
    • data object

      Additional properties are allowed.

      Hide data attributes Show data attributes object
      • current_page integer
      • data array[object]
        Hide data attributes Show data attributes object
        • invoice_number string
        • from string
        • to string
        • created_on string
        • due_date string
        • total_amount string
        • vat_amount string
        • grand_total string
        • expenses_amount string
        • paid_amount string
        • status string
        • created_by integer
        • client_name string
        • business_unit string
        • business_unit_ref_code string
      • first_page_url string
      • from integer
      • last_page integer
      • last_page_url string
      • next_page_url null
      • path string
      • per_page integer
      • prev_page_url null
      • to integer
      • total integer
    • message string
  • FYI: Maximum records per page is 100

GET /report/invoice
curl \
 --request GET 'https://api-console.logezy.co/v1/report/invoice?start_date=Y-m-d&end_date=Y-m-d' \
 --header "Authorization: Bearer your-access-token" \
 --header "Accept: application/json"
Response examples (200)
{
  "data": {
    "to": 3,
    "data": [
      {
        "to": "2022-11-06",
        "from": "2022-10-31",
        "status": "over due",
        "due_date": "2022-11-07",
        "created_by": 13827,
        "created_on": "2022-11-02 09:58:14",
        "vat_amount": "0.00",
        "client_name": "A Care",
        "grand_total": "536.12",
        "paid_amount": "0.00",
        "total_amount": "536.12",
        "business_unit": "A Care Weekly - Normal Rate",
        "invoice_number": "INVNO-227",
        "expenses_amount": "0.00",
        "business_unit_ref_code": "BU73DE212"
      }
    ],
    "from": 1,
    "path": "https://api.logezydev.co.uk/v1/report/invoice",
    "total": 3,
    "per_page": 100,
    "last_page": 1,
    "current_page": 1,
    "last_page_url": "https://api.logezydev.co.uk/v1/report/invoice?page=1",
    "next_page_url": null,
    "prev_page_url": null,
    "first_page_url": "https://api.logezydev.co.uk/v1/report/invoice?page=1"
  },
  "status": "success",
  "message": "Invoice report retrieved successfully."
}