v1
latestOpenAPI 3.1.02026-07-2438302.6 MBGet Invoice Details
get/invoice/{invoice_uid}
Path parameters
invoice_uidstring required
Response
200
Example response
{
"type": "success",
"data": {
"invoice_uid": "a53a5920-9a80-11ee-8a1f-49ba020888f8",
"description": "Auto generated from Contract",
"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_category": {
"_id": "5abb5a0d421b2c5ed273a3a7",
"category_name": "Residential",
"category_uid": "b02dba80-3266-11e8-8c01-4905acc8cfc0"
},
"customer_organization": {
"updated_at": "2023-08-02T04:11:04.727Z",
"created_at": "2023-03-03T11:08:36.995Z",
"is_active": true,
"custom_fields": [
{
"label": "LookUp",
"type": "LOOKUP",
"module_name": "PRODUCT",
"_id": "6405855f380003cea418cac6"
}
],
"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",
"customer_all_addresses": [
{
"first_name": "Santhanapandian",
"phone_number": "9000932246",
"email": "santhanapandian@zuper.co",
"city": "Chennai ",
"state": "Tamil Nadu ",
"street": "SKCL Harmony Tower, Gangai Karai Puram, T. Nagar",
"country": "India",
"zip_code": "600017",
"geo_cordinates": [
13.0494258
],
"_id": "64c7a3b7ccb5f89a13dd3b42"
}
],
"customer_address": {
"city": "Cortland ",
"state": "New York ",
"street": "NY, USA",
"country": "United States",
"zip_code": "13045",
"geo_cordinates": [
42.6011813
],
"first_name": "Santhanapandian",
"phone_number": "9000932246",
"email": "santhanapandian@zuper.co"
},
"customer_billing_address": {
"city": "Cortland ",
"state": "New York ",
"street": "NY, USA",
"country": "United States",
"zip_code": "13045",
"geo_cordinates": [
42.6011813
],
"first_name": "Santhanapandian",
"phone_number": "9000932246",
"email": "santhanapandian@zuper.co"
},
"custom_fields": [
{
"label": "default input",
"type": "SINGLE_LINE",
"_id": "652cd055888b9b1b3cccfea9"
}
],
"accounts": {
"ltv": 4300.1,
"receivables": 80000.7,
"credits": 600,
"billing_frequency": "623c04a7378fd521b0e340af",
"payment_term": "5d84c1693954a6638587479a",
"tax_group": "64c7982dccb5f89a13db03ca"
},
"is_active": true,
"has_card_on_file": true,
"created_at": "2022-02-22T08:55:39.170Z",
"updated_at": "2023-12-14T13:07:29.467Z",
"customer_contact_no": {
"mobile": "9000932246",
"home": "9000932245"
}
},
"organization": {
"updated_at": "2023-08-02T04:11:04.727Z",
"created_at": "2023-03-03T11:08:36.995Z",
"is_active": true,
"custom_fields": [
{
"label": "LookUp",
"type": "LOOKUP",
"module_name": "PRODUCT",
"_id": "6405855f380003cea418cac6"
}
],
"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": {
"updated_at": "2023-11-03T10:42:18.434Z",
"created_at": "2023-08-21T11:58:00.578Z",
"is_active": true,
"custom_fields": [
{
"label": "DateTime Input",
"value": "2023-08-01 22:58:00",
"type": "DATETIME",
"_id": "64e4c0dc7c0c9e18fa178b83"
}
],
"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",
"customer_billing_address": {
"city": "Chennai ",
"state": "Tamil Nadu ",
"street": "T. Nagar",
"geo_cordinates": [
13.0417591
],
"first_name": "Santhanapandian",
"email": "santhanapandian@zuper.co"
},
"customer_service_address": {
"city": "Chennai ",
"state": "Tamil Nadu ",
"street": "SKCL Harmony Tower, Gangai Karai Puram, T. Nagar",
"geo_cordinates": [
13.0494258
],
"first_name": "Santhanapandian",
"email": "santhanapandian@zuper.co"
},
"template": {
"type": "INVOICE",
"template_name": "Invoice Hilton",
"template_description": "Invoice",
"template": "<meta charset=\"utf-8\">\n <title>LinkNet\n </title>\n <!-- <link rel=\"stylesheet\" href=\"https://cdnjs.cloudflare.com/ajax/libs/normalize/7.0.0/normalize.min.css\"> -->\n <link href=\"https://fonts.googleapis.com/css2?family=Source+Sans+Pro:ital,wght@0,200;0,400;0,600;0,700;0,900;1,400&display=swap\" rel=\"stylesheet\">\n \n <style>\n\t @page { margin: 0 }\n\t body { margin: 0; font-family: \"Source Sans Pro\"; zoom: 0.85;}\n\t .sheet {\n\t margin: 0;\n\t overflow: hidden;\n\t position: relative;\n\t box-sizing: border-box;\n\t page-break-after: always;\n \n\t }\n\n\t /** Paper sizes **/\n\t body.A3 .sheet { width: 297mm; height: 419mm }\n\t body.A3.landscape .sheet { width: 420mm; height: 296mm }\n\t body.A4 .sheet { width: 210mm; height: 296mm }\n\t body.A4.landscape .sheet { width: 297mm; height: 209mm }\n\t body.A5 .sheet { width: 148mm; height: 209mm }\n\t body.A5.landscape .sheet { width: 210mm; height: 147mm }\n\t body.letter .sheet { width: 216mm; height: 279mm }\n\t body.letter.landscape .sheet { width: 280mm; height: 215mm }\n\t body.legal .sheet { width: 216mm; height: 356mm }\n\t body.legal.landscape .sheet { width: 357mm; height: 215mm }\n\n\t /** Padding area **/\n\t .sheet.padding-10mm { padding: 10mm }\n\t .sheet.padding-15mm { padding: 15mm }\n\t .sheet.padding-20mm { padding: 20mm }\n\t .sheet.padding-25mm { padding: 25mm }\n\n\t /** For screen preview **/\n\t @media screen {\n\t body { background: #e0e0e0 }\n\t .sheet {\n\t background: white;\n\t box-shadow: 0 .5mm 2mm rgba(0,0,0,.3);\n\t margin: 5mm auto;\n\t }\n\t }\n\n\t /** Fix for Chrome issue #273306 **/\n\t @media print {\n\t body.A3.landscape { width: 420mm }\n\t body.A3, body.A4.landscape { width: 297mm }\n\t body.A4, body.A5.landscape { width: 210mm }\n\t body.A5 { width: 148mm }\n\t body.letter, body.legal { width: 216mm }\n\t body.letter.landscape { width: 280mm }\n\t body.legal.landscape { width: 357mm }\n\t }\n\n .logo {\n width: 50%;\n }\n </style>\n\n <!-- Set page size here: A5, A4 or A3 -->\n <!-- Set also \"landscape\" if you need -->\n <style> \n @page { size: A4 }\n *{font-size: 13px; font-family: \"Source Sans Pro\"; }\n .invoice-box {\n line-height: 24px;\n color: #555;\n }\n table{\n border-collapse: collapse;\n border: 1px solid #5C5C5C;\n font-weight: normal;\n }\n tr, th, td { \n border-collapse: collapse;\n /*border: 1px solid #5C5C5C;*/\n font-weight: normal;\n }\n tr{\n text-align: left;\n padding-top:5px;\n }\n table { overflow: visible !important; }\nthead { display: table-row-group }\ntfoot { display: table-row-group }\ntr { page-break-inside: avoid;}\n </style>\n\n\n<body>\n <!-- Each sheet element should have the class \"sheet\" -->\n <!-- \"padding-**mm\" is optional: you can set 10, 15, 20 or 25 -->\n <section class=\"sheet padding-10mm\">\n <div id=\"\">\n <!-- HEADER -->\n <div style=\"\">\n <table style=\"width: 100%; border: none;\">\n <tbody>\n <td style=\"width: 50%\">\n <img class=\"logo\" src=\"https://s3.ap-south-1.amazonaws.com/images.zuper/icons/color_logo.png\" />\n </td>\n <td>\n </td>\n <td style=\"text-align: right; width: 50%\">\n <h1 style=\"font-size: 25px; margin-bottom: 0\">Invoice</h1>\n <p>Invoice # <b>{{invoice_no}}</b><br>Invoice Date : <b>{{formatDateWithTimeZone invoice_date 'DD/MM/YYYY' timezone}}</b><br>Due Date : <b>{{formatDateWithTimeZone due_date 'MM/DD/YYYY' timezone}}</b> \n </td>\n </tbody>\n </table>\n <hr style=\"margin-top: 20px; margin-bottom: 10px\">\n </div>\n </div>\n\n\n <!-- BILL & SHIP TO -->\n <!-- BILL & SHIP TO -->\n <table style=\"width: 100%; border: none; margin-top: 20px;\">\n <tbody>\n <td style=\"width: 50%; vertical-align: top;\">\n <b>Service Address:</b>\n <p>{{customer.customer_first_name}} {{customer.customer_last_name}}<br>\n {{customer_service_address.street}}, <br>{{customer_service_address.city}}, <br> {{customer_service_address.state}} {{customer_service_address.zip_code}} \n {{#if customer_service_address.email}}<br><br><span> Email: </span>{{customer_service_address.email}}</span>{{/if}}\n {{#if customer_service_address.phone_number}}<br><span> Phone: </span>{{customer_service_address.phone_number}}</span>{{/if}}\n </p>\n </td>\n <td style=\"width: 50%\">\n <b>Billing Address:</b>\n <p>{{customer.customer_first_name}} {{customer.customer_last_name}}<br>\n {{customer_billing_address.street}}, <br>{{customer_billing_address.city}}, <br> {{customer_billing_address.state}} {{customer_billing_address.zip_code}} \n {{#if customer_billing_address.email}}<br><br><span> Email: </span>{{customer_billing_address.email}}</span>{{/if}}\n {{#if customer_billing_address.phone_number}}<br><span> Phone: </span>{{customer_billing_address.phone_number}}</span>{{/if}}\n </p>\n </td>\n </tbody>\n </table>\n\n\n \n <table style=\"width: 100%;margin-top: 35px;\">\n <thead>\n <tr style=\"border: 1px solid #5C5C5C; background: #25262a; color: #FFF\">\n <th style=\"width: 5%;text-align: center;\">#</th>\n <th style=\"width: 41%;text-align: center;\">Description</th>\n <th style=\"width: 10%;text-align: center;\">QTY</th>\n <th style=\"width: 10%;text-align: center;\">Unit Price</th>\n <th style=\"width: 15%;text-align: center;\">Amount</th>\n </tr>\n </thead>\n <tbody>\n \t{{#each line_items}}\n <tr>\n <td style=\"border: 1px solid #5C5C5C;padding-left: 5px;\">{{add @index 1}}</td>\n <td style=\"border: 1px solid #5C5C5C;padding-left: 5px;\">{{name}}<br> {{description}}</td>\n <td style=\"text-align: center;border: 1px solid #5C5C5C;\">{{quantity}}</td>\n <td style=\"text-align: center;border: 1px solid #5C5C5C;\">${{roundNumber unit_price 2}}</td>\n <td style=\"text-align: center;border: 1px solid #5C5C5C;\">${{roundNumber total 2}}</td>\n </tr>\n {{/each}} \n \n </tbody></table>\n\n <table style=\"width: 100%;margin-top: 15px; border: none\">\n <tbody>\n <tr>\n <td style=\"width: 40%\">\n {{#if remarks}}\n <b>Remarks:</b>{{remarks}}\n {{/if}}\n </td>\n <td style=\"width: 50%\">\n\n <table style=\"width: 100%; border: none\">\n <tbody>\n <tr>\n <td style=\"text-align: right; width: 85%\">Subtotal</td>\n <td style=\"text-align: right;\">${{roundNumber sub_total 2}}</td> \n </tr>\n {{#each tax}}\n <tr>\n <td style=\"text-align: right; width: 85%\">{{tax_name}} at {{tax_percent}}%</td>\n <td style=\"text-align: right;\">${{roundNumber tax_amount 2}}</td> \n </tr> \n {{/each}}\n <tr>\n <td style=\"text-align: right; width: 85%; font-weight: bold;\">Total Amount</td>\n <td style=\"text-align: right; font-weight: bold;\">${{roundNumber total 2}}</td> \n </tr> \n\n \n {{#each payment_history}}\n <tr>\n <td style=\"text-align: right; width: 85%\">Payment Received - {{formatDateWithTimeZone created_at 'MM/DD/YYYY' 'America/New_York'}}</td>\n <td style=\"text-align: right;\">\n ${{roundNumber amount 2}}\n </td> \n </tr>\n {{/each}}\n {{#if amount_due}}\n <tr style=\"margin-top: 20px\">\n <td style=\"text-align: right; font-weight: bold;\">Total Due as of {{now \"%d/%m/%Y\"}} :</td>\n <td style=\"text-align: right; font-weight: bold;\">${{roundNumber amount_due 2}}</td> \n </tr> \n {{/if}}\n \n </tbody>\n </table> \n\n </td>\n </tr>\n </tbody>\n </table>\n\n </section>\n\n <div id=\"pageFooter\" style=\"width: 100%;\">\n <p style=\"font-size: 9px; margin-top: 0px; text-align: center\">\n Link Net | <a href=\"http://www.linknet.co.id\" style=\"font-size: 9px;\">http://www.linknet.co.id</a>\n </p>\n </div>\n \n</body>\n</html>",
"template_uid": "1ed34d90-e4ec-11e9-9b2d-3bcbe98b969e",
"template_options": {
"format": "A4",
"orientation": "portrait",
"border": {
"top": "10",
"right": "10",
"bottom": "10",
"left": "10"
}
},
"render_engine": "PHANTOM"
},
"invoice_status": "PAID",
"status_history": [
{
"status_name": "DRAFT",
"done_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"
},
"done_by_type": "EMPLOYEE",
"_id": "657afc3d989f0dfd8de3430a",
"created_at": "2023-12-14T12:59:41.438Z"
}
],
"payment_term": {
"payment_term_name": "two month term",
"no_of_days": 60,
"payment_term_uid": "82f0e860-db9f-11e9-a35c-3301ecc1dbf7"
},
"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",
"custom_fields": [
{
"label": "Dealer",
"type": "SINGLE_LINE",
"module_name": "PRODUCT",
"_id": "649beb5665b54d91fa9ed87b"
}
],
"created_at": "2023-01-30T11:33:40.800Z",
"updated_at": "2023-12-14T13:07:29.622Z",
"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
},
"payment_history": [
{
"payment_mode": {
"_id": "5d84c1ac3954a6638587479e",
"payment_mode_name": "Cash",
"payment_mode_type": "OFFLINE",
"payment_mode_description": "Cash",
"payment_mode_uid": "9de42b50-db9f-11e9-a35c-3301ecc1dbf7"
},
"payment_transaction": {
"payment_transaction_uid": "bc434d10-9a81-11ee-adeb-6fa559e432e0"
},
"remarks": "Paid",
"done_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"
},
"payment_date": "2023-12-14T13:07:21.000Z",
"done_by_type": "EMPLOYEE",
"_id": "657afe1110cd290f1abcbed6",
"created_at": "2023-12-14T13:07:29.534Z"
}
],
"created_at": "2023-12-14T12:59:41.441Z",
"updated_at": "2023-12-14T13:07:29.582Z",
"invoice_no": 4175,
"payment_mode": {
"payment_mode_name": "Cash",
"payment_mode_type": "OFFLINE",
"payment_mode_description": "Cash",
"payment_mode_uid": "9de42b50-db9f-11e9-a35c-3301ecc1dbf7"
}
}
}