v1

latestOpenAPI 3.1.02026-07-2438302.6 MB

Get all Invoice

get/invoice

Query parameters

pagestring

countstring

sort'DESC' | 'ASC'

sort_by'invoice_no' | 'reference_no' | 'created_at' | 'invoice_date' | 'due_date'

filter.keywordstring

filter.is_deletedboolean

filter.is_paidboolean

filter.is_activeboolean

filter.jobstring

filter.estimatestring

filter.customerstring

filter.payment_termstring

filter.payment_modestring

filter.due_from_datestring date

filter.due_to_datestring date

filter.created_from_datestring date

filter.created_to_datestring date

filter.invoice_from_datestring date

filter.invoice_to_datestring date

filter.created_bystring

filter.updated_atstring date

filter.updated_at_fromstring date

filter.updated_at_tostring date

filter.invoice_uidstring

filter.over_dueboolean

filter.propertystring

filter.organizationstring

filter.team_uidstring

filter.custom_fieldstring

filter.has_card_on_fileboolean

filter.financingboolean

filter.tagsstring

filter.service_contractstring

filter.projectstring

filter.business_unitstring

Response

200

typestring

total_recordsinteger

current_pageinteger

total_pagesinteger

Example response

{
  "type": "success",
  "data": [
    {
      "invoice_uid": "a53a5920-9a80-11ee-8a1f-49ba020888f8",
      "invoice_date": "2023-12-13T18:30:00.000Z",
      "due_date": "2024-02-12T18:29:59.000Z",
      "customer": {
        "customer_uid": "35279010-93bd-11ec-b675-b9a129ac10eb",
        "customer_first_name": "Santhanapandian",
        "customer_organization": {
          "is_active": true,
          "organization_billing_address": {
            "city": "Chennai",
            "state": "Tamil Nadu",
            "street": "Turyaa Chennai, Rajiv Gandhi Salai, Elango Nagar, Perungudi, India",
            "_id": "6464bdc1eb32d67c9816b3d1"
          },
          "organization_address": {
            "city": "Chennai",
            "state": "Tamil Nadu",
            "street": "Turyaa Chennai, Rajiv Gandhi Salai, Elango Nagar, Perungudi, India",
            "geo_cordinates": [
              12.9733389
            ],
            "_id": "6464bdc1eb32d67c9816b3d2"
          },
          "organization_description": "<p>Test Org Desc</p>",
          "organization_name": "TEST ORG 0005",
          "organization_uid": "becf61e0-b9b3-11ed-b623-1b22cc5dd28b"
        },
        "customer_email": "santhanapandian@zuper.co",
        "is_active": true,
        "customer_contact_no": {
          "mobile": "9000932246",
          "home": "9000932245"
        }
      },
      "organization": {
        "organization_billing_address": {
          "city": "Chennai",
          "state": "Tamil Nadu",
          "street": "Turyaa Chennai, Rajiv Gandhi Salai, Elango Nagar, Perungudi, India",
          "_id": "6464bdc1eb32d67c9816b3d1"
        },
        "organization_address": {
          "city": "Chennai",
          "state": "Tamil Nadu",
          "street": "Turyaa Chennai, Rajiv Gandhi Salai, Elango Nagar, Perungudi, India",
          "geo_cordinates": [
            12.9733389
          ],
          "_id": "6464bdc1eb32d67c9816b3d2"
        },
        "no_of_customers": 4,
        "organization_description": "<p>Test Org Desc</p>",
        "organization_name": "TEST ORG 0005",
        "organization_uid": "becf61e0-b9b3-11ed-b623-1b22cc5dd28b"
      },
      "property": {
        "property_address": {
          "city": "Bengaluru ",
          "state": "Karnataka ",
          "street": "Whitefield Main Road Pattandur Agrahara ",
          "country": "India",
          "landmark": "Whitefield Bus stop",
          "zip_code": "560066",
          "geo_cordinates": [
            12.9874885
          ],
          "_id": "64e4c0dc7c0c9e18fa178bac"
        },
        "property_image": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/361cf1c0-7d59-11eb-8302-750c30d4731b.jpg",
        "no_of_jobs": 80,
        "property_name": "Ascendas IT Park",
        "property_uid": "6b33fd30-7d5a-11eb-8302-750c30d4731b"
      },
      "prefix": "AC_Auto_Invoice",
      "invoice_status": "PAID",
      "service_contract": {
        "contract_uid": "f1ae7dc0-a091-11ed-9cee-1d71b5cbf00e",
        "contract_name": "Contract",
        "description": "<p>Contract Test</p>",
        "start_date": "2023-01-31T18:30:00.000Z",
        "end_date": "2024-01-31T18:29:59.000Z",
        "contract_number": 680
      },
      "is_paid": true,
      "is_active": true,
      "created_by": {
        "user_uid": "15e00bfa-fbcb-4d46-a7c1-c7b5910441c0",
        "first_name": "Marlon",
        "last_name": "S A",
        "email": "santhanapandian@zuper.co",
        "designation": "Admin",
        "emp_code": "Z082",
        "profile_picture": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/80c94b80-20b1-11ee-9dcd-affe7f3e9b1d.jpg",
        "hourly_labor_charge": 120,
        "is_active": true,
        "created_at": "2022-02-22T06:03:54.000Z",
        "updated_at": "2023-11-17T07:14:24.000Z"
      },
      "financing": {
        "is_enabled": true
      },
      "created_at": "2023-12-14T12:59:41.441Z",
      "updated_at": "2023-12-14T13:07:29.582Z",
      "invoice_no": 4175,
      "id": "undefined"
    }
  ],
  "total_records": 4303,
  "current_page": 1,
  "total_pages": 431
}