Table of Contents
In this documentation, you will get to know a detailed description of Propovoice API Endpoint Invoices. Read out the complete API documentation.
List Invoices #
Description here
Request Method GET
API Endpoint /ndpv/v1/invoices?path=invoice
Response Status Code 200 OK
{
"success": true,
"data": {
"prefix": "Inv-",
"result": [
{
"id": 3545,
"num": "Inv-3545",
"token": "53353a6377fbbb47e3d046a6f16d40de078d8345",
"path": "invoice",
"date": "2023-04-02T08:24:18.384Z",
"due_date": "2023-05-02T08:24:18.393Z",
"project": {
"name": ""
},
"from": {
"id": "43",
"name": "Cris Miller"
},
"to": {
"id": 3540,
"type": "person",
"first_name": "John Smith",
"org_name": "",
"email": "[email protected]"
},
"invoice": {
"id": 3545,
"num": "Inv-3545",
"token": "53353a6377fbbb47e3d046a6f16d40de078d8345",
"style": {
"primary_color": "#4c6fff",
"body_font": "",
"title_font": ""
},
"date": "2023-04-02T08:24:18.384Z",
"due_date": "2023-05-02T08:24:18.393Z",
"currency": "USD",
"lang": "en",
"template": 8,
"from": 43,
"to": 3540,
"to_type": "person",
"module_id": null,
"project": {
"id": null,
"title": "",
"desc": ""
},
"top_sections": [
{
"label": "Title",
"content": "<p>UniqueGraph, is a start-up company that provides a unique social networking experience to its users. UniqueGraph is looking to launch a mobile application that will allow their users to access the platform on the go. The client is seeking a UX/UI design that will provide an intuitive and engaging user experience for their mobile application.</p>"
}
],
"item_label": {
"id": "ID",
"desc": "Description",
"qty": "Quantity",
"price": "Rate",
"tax": "Tax",
"amount": "Amount"
},
"items": [
{
"id": "init",
"title": "Research and Ideate",
"desc": "This phase will include meetings with the client to discuss their requirements.",
"qty": "50",
"qty_type": "",
"price": "120",
"tax": 0,
"tax_type": "fixed"
},
{
"id": "1680423930058",
"title": "Wireframe",
"desc": "A wireframe is a visual blueprint that outlines the basic structure and layout of mobile application",
"qty": "20",
"qty_type": "",
"price": "120",
"tax": 0,
"tax_type": "fixed"
}
],
"paid": 0,
"item_tax": false,
"extra_field": [
{
"id": "55",
"name": "Tax",
"type": "tax",
"val": "10",
"val_type": "percent"
},
{
"id": "56",
"name": "Discount",
"type": "discount",
"val": "20",
"val_type": "percent",
"tax_cal": "",
"fee_cal": "1"
}
],
"payment_methods": [],
"reminder": {
"status": true,
"due_date": false,
"before": [
1
],
"after": []
},
"recurring": {
"status": false,
"interval_type": "week",
"interval_in": "month",
"interval": 1,
"limit_type": 0,
"limit": 5,
"subscription": false,
"send_me": false,
"delivery": 1
},
"sections": [
{
"label": "Note",
"content": ""
},
{
"label": "Terms & Conditions",
"content": "<p>50% deposit due upon acceptance of this invoice<br>50% due upon completion of the project</p>"
}
],
"attach": [],
"sign": null,
"path": "invoice",
"status": "draft"
},
"total": "8400",
"paid": 0,
"due": 0,
"feedback": "",
"payment_method": "",
"payment_info": "",
"status": "draft"
}
],
"total": 1
}
}Create Invoice #
Description here
Request Method POST
API Endpoint /ndpv/v1/invoices
Request Payload application/json
- attach:
array - currency:
string - date:
string - due_date:
string - extra_field:
array - from:
integer - id:
null - item_label: Item Label Object
- item_tax:
boolean - items:
arrayof Item Object - lang:
string - module_id:
null - num:
string - paid:
integer - path:
string”invoice” - payment_methods:
object - project: Project Object
- recurring: Recurring Object
- reminder: Reminder Object
- sections:
arrayof Section Object - sign:
null - style: Style Object
- template:
integer - to:
integer - to_type:
string - token:
string - top_sections:
arrayof Section Object
Item Label Object
- amount:
string - desc:
string - id:
string - price:
string - qty:
string - tax:
string
Item Object
- desc:
string - id:
string - price:
string - qty:
string - qty_type:
string - tax:
integer - tax_type:
string - title:
string
Project Object
- desc:
string - id:
null - title:
string
Recurring Object
- delivery:
integer - interval:
integer - interval_in:
string - interval_type:
string - limit:
integer - limit_type:
integer - send_me:
boolean - status:
boolean - subscription:
boolean
Reminder Object
- after:
arrayofinteger - before:
arrayofinteger - due_date:
boolean - status:
boolean
Section Object
- content:
string - label:
string
Style Object
- body_font:
string - primary_color:
string - title_font:
string
{
"attach": [],
"currency": "USD",
"date": "2023-04-05T09:14:25.369Z",
"due_date": "2023-05-05T09:14:25.380Z",
"extra_field": [
{
"id": "55",
"name": "Tax",
"type": "tax",
"val": "10",
"val_type": "percent"
},
{
"id": "56",
"name": "Discount",
"type": "discount",
"val": "20",
"val_type": "percent"
}
],
"from": 43,
"id": null,
"item_label": {
"amount": "Amount",
"desc": "Description",
"id": "ID",
"price": "Rate",
"qty": "Quantity",
"tax": "Tax"
},
"item_tax": false,
"items": [
{
"desc": "This phase will include meetings with the client to discuss their requirements.",
"id": "init",
"price": "120",
"qty": "50",
"qty_type": "",
"tax": 0,
"tax_type": "fixed",
"title": "Research and Ideate"
},
{
"desc": "A wireframe is a visual blueprint that outlines the basic structure and layout of mobile application",
"id": "1680686106975",
"price": "120",
"qty": "20",
"qty_type": "",
"tax": 0,
"tax_type": "fixed",
"title": "Wireframe"
}
],
"lang": "en",
"module_id": null,
"num": "",
"paid": 0,
"path": "invoice",
"payment_methods": {},
"project": {
"desc": "",
"id": null,
"title": ""
},
"recurring": {
"delivery": 1,
"interval": 1,
"interval_in": "month",
"interval_type": "week",
"limit": 5,
"limit_type": 0,
"send_me": false,
"status": false,
"subscription": false
},
"reminder": {
"after": [],
"before": [],
"due_date": false,
"status": false
},
"sections": [
{
"content": "<p>50% deposit due upon acceptance of this invoice<br>50% due upon completion of the project</p>",
"label": "Terms & Conditions"
}
],
"sign": null,
"style": {
"body_font": "",
"primary_color": "#4c6fff",
"title_font": ""
},
"template": 1,
"to": 3556,
"to_type": "person",
"token": "",
"top_sections": [
{
"content": "<p>UniqueGraph, is a start-up company that provides a unique social networking experience to its users. UniqueGraph is looking to launch a mobile application that will allow their users to access the platform on the go. The client is seeking a UX/UI design that will provide an intuitive and engaging user experience for their mobile application.</p>",
"label": "Title"
}
]
}Response Status Code 200 OK
{
"success": true,
"data": {
"id": 3562,
"token": "620992ccbc50c7b081a936b37346a656b7050680"
}
}Read Invoice #
Description here
Request Method GET
API Endpoint /ndpv/v1/invoices/{INVOICE_ID}
Query String Parameters
- INVOICE_ID
Response Status Code 200 OK
{
"success": true,
"data": {
"id": 3545,
"token": "53353a6377fbbb47e3d046a6f16d40de078d8345",
"date": "2023-04-02T08:24:18.384Z",
"due_date": "2023-05-02T08:24:18.393Z",
"module_id": "",
"status": "draft",
"fromData": {
"id": "43",
"name": "Cris Miller",
"org_name": "",
"email": "[email protected]",
"mobile": "1451451451",
"web": "",
"address": "",
"logo": {
"id": "3544",
"src": "http://propovoice.local/wp-content/uploads/2023/04/nurencylogo.png"
}
},
"toData": {
"id": 3540,
"type": "person",
"first_name": "John Smith",
"org_name": "",
"email": "[email protected]",
"mobile": "+1 650-555-0199",
"web": "",
"country": "",
"region": "",
"address": ""
},
"paymentBankData": null,
"prefix": "Inv-",
"wc": false,
"invoice": {
"id": 3545,
"num": "Inv-3545",
"token": "53353a6377fbbb47e3d046a6f16d40de078d8345",
"style": {
"primary_color": "#4c6fff",
"body_font": "",
"title_font": ""
},
"date": "2023-04-02T08:24:18.384Z",
"due_date": "2023-05-02T08:24:18.393Z",
"currency": "USD",
"lang": "en",
"template": 8,
"from": 43,
"to": 3540,
"to_type": "person",
"module_id": null,
"project": {
"id": null,
"title": "",
"desc": ""
},
"top_sections": [
{
"label": "Title",
"content": "<p>UniqueGraph, is a start-up company that provides a unique social networking experience to its users. UniqueGraph is looking to launch a mobile application that will allow their users to access the platform on the go. The client is seeking a UX/UI design that will provide an intuitive and engaging user experience for their mobile application.</p>"
}
],
"item_label": {
"id": "ID",
"desc": "Description",
"qty": "Quantity",
"price": "Rate",
"tax": "Tax",
"amount": "Amount"
},
"items": [
{
"id": "init",
"title": "Research and Ideate",
"desc": "This phase will include meetings with the client to discuss their requirements.",
"qty": "50",
"qty_type": "",
"price": "120",
"tax": 0,
"tax_type": "fixed"
},
{
"id": "1680423930058",
"title": "Wireframe",
"desc": "A wireframe is a visual blueprint that outlines the basic structure and layout of mobile application",
"qty": "20",
"qty_type": "",
"price": "120",
"tax": 0,
"tax_type": "fixed"
}
],
"paid": 0,
"item_tax": false,
"extra_field": [
{
"id": "55",
"name": "Tax",
"type": "tax",
"val": "10",
"val_type": "percent"
},
{
"id": "56",
"name": "Discount",
"type": "discount",
"val": "20",
"val_type": "percent",
"tax_cal": "",
"fee_cal": "1"
}
],
"payment_methods": [],
"reminder": {
"status": true,
"due_date": false,
"before": [
1
],
"after": []
},
"recurring": {
"status": false,
"interval_type": "week",
"interval_in": "month",
"interval": 1,
"limit_type": 0,
"limit": 5,
"subscription": false,
"send_me": false,
"delivery": 1
},
"sections": [
{
"label": "Note",
"content": ""
},
{
"label": "Terms & Conditions",
"content": "<p>50% deposit due upon acceptance of this invoice<br>50% due upon completion of the project</p>"
}
],
"attach": [],
"sign": null,
"path": "invoice",
"status": "draft"
}
}
}Update Invoice #
Description here
Request Method PUT
API Endpoint /ndpv/v1/invoices/{INVOICE_ID}
Query String Parameters
- INVOICE_ID
Request Payload application/json
- attach:
array - currency:
string - date:
string - due_date:
string - extra_field:
array - from:
integer - id:
integer - item_label: Item Label Object
- item_tax:
boolean - items:
arrayof Item Object - lang:
string - module_id:
null - num:
string - paid:
integer - path:
string”invoice” - payment_methods:
object - project: Project Object
- recurring: Recurring Object
- reminder: Reminder Object
- sections:
arrayof Section Object - sign:
null - style: Style Object
- template:
integer - to:
integer - to_type:
string - token:
string - top_sections:
arrayof Section Object
Item Label Object
- amount:
string - desc:
string - id:
string - price:
string - qty:
string - tax:
string
Item Object
- desc:
string - id:
string - price:
string - qty:
string - qty_type:
string - tax:
integer - tax_type:
string - title:
string
Project Object
- desc:
string - id:
null - title:
string
Recurring Object
- delivery:
integer - interval:
integer - interval_in:
string - interval_type:
string - limit:
integer - limit_type:
integer - send_me:
boolean - status:
boolean - subscription:
boolean
Reminder Object
- after:
arrayofinteger - before:
arrayofinteger - due_date:
boolean - status:
boolean
Section Object
- content:
string - label:
string
Style Object
- body_font:
string - primary_color:
string - title_font:
string
{
"attach": [],
"currency": "USD",
"date": "2023-04-05T09:14:25.369Z",
"due_date": "2023-05-05T09:14:25.380Z",
"extra_field": [
{
"id": "55",
"name": "Tax",
"type": "tax",
"val": "10",
"val_type": "percent"
},
{
"id": "56",
"name": "Discount",
"type": "discount",
"val": "20",
"val_type": "percent"
}
],
"from": 43,
"id": 3562,
"item_label": {
"amount": "Amount",
"desc": "Description",
"id": "ID",
"price": "Rate",
"qty": "Quantity",
"tax": "Tax"
},
"item_tax": false,
"items": [
{
"desc": "This phase will include meetings with the client to discuss their requirements.",
"id": "init",
"price": "120",
"qty": "50",
"qty_type": "",
"tax": 0,
"tax_type": "fixed",
"title": "Research and Ideate"
},
{
"desc": "A wireframe is a visual blueprint that outlines the basic structure and layout of mobile application",
"id": "1680686106975",
"price": "120",
"qty": "20",
"qty_type": "",
"tax": 0,
"tax_type": "fixed",
"title": "Wireframe"
}
],
"lang": "en",
"module_id": null,
"num": "",
"paid": 0,
"path": "invoice",
"payment_methods": {},
"project": {
"desc": "",
"id": null,
"title": ""
},
"recurring": {
"delivery": 1,
"interval": 1,
"interval_in": "month",
"interval_type": "week",
"limit": 5,
"limit_type": 0,
"send_me": false,
"status": false,
"subscription": false
},
"reminder": {
"after": [],
"before": [],
"due_date": false,
"status": false
},
"sections": [
{
"content": "<p>50% deposit due upon acceptance of this invoice<br>50% due upon completion of the project</p>",
"label": "Terms & Conditions"
}
],
"sign": null,
"style": {
"body_font": "",
"primary_color": "#4c6fff",
"title_font": ""
},
"template": 1,
"to": 3556,
"to_type": "person",
"token": "620992ccbc50c7b081a936b37346a656b7050680",
"top_sections": [
{
"content": "<p>UniqueGraph, is a start-up company that provides a unique social networking experience to its users. UniqueGraph is looking to launch a mobile application that will allow their users to access the platform on the go. The client is seeking a UX/UI design that will provide an intuitive and engaging user experience for their mobile application.</p>",
"label": "Title"
}
]
}Response Status Code200 OK
{
"success": true,
"data": 3562
}Delete Invoice #
Description here
Request Method DELETE
API Endpoint /ndpv/v1/invoices/{INVOICE_ID}
Query String Parameters
- INVOICE_ID
Response Status Code 200 OK
{
"success": true,
"data": [
"3562"
]
}