ZUzuper

Get Invoice

Changed on
get/v2/customer_portal/invoices/

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/v2/customer_portal/invoices/
  • Auth
    API key in header x-api-key

Query parameters

filter.invoice_from_datestring date
filter.invoice_to_datestring date
filter.invoice_due_from_datestring date
filter.invoice_due_to_datestring date
filter.invoice_status'AWAIT_PAYMENT' | 'PARTIALLY_PAID' | 'PAID' | 'BAD_DEBT' | 'CLOSED' | 'CANCELED' | 'READY_TO_INVOICE'
filter.payment_statusboolean
filter.propertystring
filter.organizationstring
filter.jobstring
filter.service_contractstring
filter.keywordstring

Response

200

typestring
current_page_recordsinteger
total_recordsinteger
current_pageinteger
total_pagesinteger

Example response

{
  "type": "success",
  "data": [
    {
      "invoice_uid": "45449e82-aace-4785-b953-61064d0ca9e1",
      "invoice_date": "2024-09-05T18:30:00.000Z",
      "due_date": "2024-10-06T18:29:00.000Z",
      "customer": {
        "customer_uid": "3b9a2a60-3d5f-11ed-a77f-7d639323b89a",
        "customer_first_name": "Ashin",
        "customer_last_name": "customer OG",
        "customer_email": "ashinthankachan1999@gmail.com",
        "customer_contact_no": {
          "mobile": "8301907278",
          "home": "123123",
          "work": "8301907278"
        },
        "is_active": true
      },
      "organization": {
        "organization_uid": "bd0a62d0-6cbc-11ee-83ad-4531910aaa26",
        "organization_name": "org17test2",
        "organization_email": "org17test2@mail.com",
        "no_of_customers": 4
      },
      "job": {
        "job_uid": "0e6bdc2f-f6b9-4356-81df-c18542c37db2",
        "job_title": "sdfsdf",
        "job_priority": "LOW",
        "work_order_number": 28189
      },
      "total": 10404,
      "invoice_status": "PAID",
      "custom_fields": [
        {
          "label": "QB Invoice ID",
          "type": "SINGLE_LINE",
          "module_name": "PRODUCT",
          "_id": "66dade825b44a0a98ec2083e"
        }
      ],
      "is_paid": true,
      "payment_url": "https://c.zuper.co/ucfZhGG5aYbnSeU98",
      "financing": {
        "is_enabled": true
      },
      "created_at": "2024-09-06T10:50:42.027Z",
      "updated_at": "2024-09-06T10:52:38.454Z",
      "invoice_no": 5788
    }
  ],
  "current_page_records": 1,
  "total_records": 51,
  "current_page": 1,
  "total_pages": 51
}

Changes