Get Customer Invoice Details
Changed onget/v2/customer_portal/invoices/{invoice_uid}
Request
- Base URLhttps://dc-region.zuperpro.com/api
- URLhttps://dc-region.zuperpro.com/api/v2/customer_portal/invoices/{invoice_uid}
- AuthAPI key in header x-api-key
Path parameters
invoice_uidstring required
Response
200
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_billing_address": {
"landmark": "near jain college",
"city": "Thoraipakkam ",
"state": "Tamil Nadu ",
"street": "Jain College, D B Jain College main enterence, Jothi Nagar",
"geo_cordinates": [
12.9469543
],
"first_name": "Ashin",
"last_name": "customer",
"phone_number": "8301907278",
"email": "ashinthankachan1999@gmail.com"
},
"customer_service_address": {
"landmark": "near jain college",
"city": "Thoraipakkam ",
"state": "Tamil Nadu ",
"street": "Jain College, D B Jain College main enterence, Jothi Nagar",
"geo_cordinates": [
12.9469543
],
"first_name": "Ashin",
"last_name": "customer",
"phone_number": "8301907278",
"email": "ashinthankachan1999@gmail.com"
},
"job": {
"job_uid": "0e6bdc2f-f6b9-4356-81df-c18542c37db2",
"job_title": "sdfsdf",
"job_priority": "LOW",
"work_order_number": 28189
},
"line_items": [
{
"line_item_uid": "e563eb4b-8303-46b6-9608-ae62087c8be0",
"line_item_type": "ITEM",
"product_id": "852",
"product_uid": "022b9930-a96a-11e9-a952-716e2bba4402",
"name": "Product#2",
"description": "Test product description",
"quantity": 2,
"unit_price": 5100,
"discount_type": "FIXED",
"total": 10404,
"tax": {
"tax_name": "Custom tax",
"tax_rate": 2,
"tax_amount": 204
},
"_id": "66dade815b44a0a98ec20837"
}
],
"sub_total": 10404,
"discount": {
"type": "PERCENTAGE",
"discount_applicability": "TRANSACTION",
"discount_label": "Discount"
},
"total": 10404,
"tax": [
{
"tax_uid": "cb3f7b70-fbbd-11ee-b23b-b9743bfe06c8",
"tax_name": "VAT",
"tax_percent": 3,
"_id": "66dade825b44a0a98ec20838"
}
],
"taxation_meta": {
"tax_provider": "66d557715d443577740f1428",
"message": {
"error": {
"code": "GetTaxError",
"message": "Address.Line1 length must be between 0 and 50 characters.",
"target": "Unknown",
"details": [
{
"code": "GetTaxError",
"number": 300,
"message": "Address.Line1 length must be between 0 and 50 characters.",
"faultCode": "GetTaxError",
"faultSubCode": "LengthError",
"helpLink": "https://developer.avalara.com/avatax/errors/GetTaxError",
"refersTo": "Addresses[1] - TaxDate: 2024-09-05 00:00:00Z.Line1",
"severity": "Error"
}
]
}
},
"current_status": "ERROR",
"status_history": [
{
"status": "ERROR",
"date": "2024-09-06T10:50:41.311Z",
"_id": "66dade825b44a0a98ec2083d"
}
]
},
"invoice_status": "PAID",
"custom_fields": [
{
"label": "QB Invoice ID",
"type": "SINGLE_LINE",
"module_name": "PRODUCT",
"_id": "66dade825b44a0a98ec2083e"
}
],
"status_history": [
{
"status_name": "DRAFT",
"done_by_type": "EMPLOYEE",
"created_at": "2024-09-06T10:50:42.026Z"
}
],
"amount_paid": 10404,
"is_paid": true,
"public_url": "https://c.zuper.co/maSPTtv6X2hnecAMA",
"payment_url": "https://c.zuper.co/ucfZhGG5aYbnSeU98",
"financing": {
"is_enabled": true
},
"payment_history": [
{
"amount": 10200,
"payment_mode": {
"payment_mode_uid": "a9120231-0bac-4dd4-8d50-e45526a8a933",
"payment_mode_name": "Card",
"payment_mode_type": "ONLINE",
"payment_mode_description": "This is to test stripe",
"created_at": "2024-05-29T12:04:10.981Z",
"updated_at": "2024-05-29T12:04:10.982Z"
},
"payment_transaction": {
"payment_transaction_uid": "d5ccb4aa-af1e-4728-9608-29fd2e15b212",
"currency": "INR",
"amount": 10200,
"description": "Transaction via offline payment",
"action_uid": "45449e82-aace-4785-b953-61064d0ca9e1",
"type": "OFFLINE",
"source": "BACK_OFFICE",
"status": "SUCCESS",
"created_at": "2024-09-06T10:51:13.839Z",
"updated_at": "2024-09-06T10:51:13.840Z"
},
"payment_date": "2024-09-06T10:50:50.000Z",
"done_by_type": "EMPLOYEE",
"_id": "66dadea15b44a0a98ec20957",
"created_at": "2024-09-06T10:51:13.850Z"
}
],
"created_at": "2024-09-06T10:50:42.027Z",
"updated_at": "2024-09-06T10:52:38.454Z",
"invoice_no": 5788,
"__v": 3,
"invoice_no_string": "5788"
}
}Changes
- info
endpoint added
- info