Estimates

  • GET /estimate/all List Estimate(s)
  • GET /estimate/{id} Get Estimate
  • POST /estimate/add Create / Add Estimate
  • PUT /estimate/{id} Edit / Update Estimate
  • POST /estimate/send Send Estimate
  • DELETE /estimate/{id} Delete Estimate

List Estimate(s)

HTTP Request

GET https://api.invoice.ng/v1/estimate/all

Response HTTP/1.1 200 OK
{
    "status": "success",
    "data": [
        {
            "id": "879675263930603",
            "short_code": "J9RDHESCDC",
            "reference_no": "EST-02",
            "description": "Web Design Proposal",
            "customer_id": "605345277110684",
            "customer_name": "Dana K. Adrian",
            "customer_phone": "+145677312965",
            "customer_address": "",
            "currency": "NGN",
            "tax_rate": 5,
            "tax_amount": 7500,
            "sub_total": 150000,
            "total": 157500,
            "accepted": "False",
            "issue_date": "2018-02-21",
            "due_date": "2018-03-23",
            "note": ""
        },
        ...
    ]
}

Get Estimate

HTTP Request

GET https://api.invoice.ng/v1/estimate/{id}

Response HTTP/1.1 200 OK
{
    "status": "success",
    "estimate": [
        {
            "id": "879675263930603",
            "short_code": "J9RDHESCDC",
            "reference_no": "EST-02",
            "description": "Web Design Proposal",
            "customer_id": "605345277110684",
            "customer_name": "Dana K. Adrian",
            "customer_phone": "+145677312965",
            "customer_address": "",
            "currency": "NGN",
            "tax_rate": 5,
            "tax_amount": 8000,
            "sub_total": 160000,
            "total": 168000,
            "accepted": "False",
            "issue_date": "2018-02-21",
            "due_date": "2018-03-23",
            "note": ""
        }
    ],
    "items": [
        {
            "description": "Web Development Fee",
            "quantity": 1,
            "rate": "150000",
            "amount": "150000"
        },
        {
            "description": "Domain Registration",
            "quantity": 4,
            "rate": "2500",
            "amount": "10000"
        },                
        ...
    ],
    "send_log": [
        {
            "email": "info@google.xyz",
            "date": "2017-05-02 21:24:46"
        },
        ...
    ]
}

Add Estimate

HTTP Request

POST https://api.invoice.ng/v1/estimate/add

Query Parameters
Parameter Type Description
client string Client unique ID (required)
estimate_no string Estimate reference number (required)
accepted string Estimate approval status ("True" or "False") (optional)
description string Description or project summary (optional)
currency string ISO 4217 currency code e.g. USD, GBP, EUR, NGN etc. (optional)
tax_rate numeric Tax rate in % (optional)
issue_date date Date invoice will be due for payment (optional)
due_date date Date invoice will be due for payment (optional)
note text Estimate note (optional)
items [ ] array Estimate line items (required)
Items Query Parameters
Parameter Type Description
description string Item description (required)
quantity numeric Item quantity (required)
rate string Rate / Unit Price (required)
Response HTTP/1.1 200 OK
{
    "status": "success",
    "estimate": [
        {
            "id": "890752277062095",
            "short_code": "U5YVTVYRTK",
            "estimate_no": "EST-01",
            "description": "Web Project",
            "customer_id": "605345277110684",
            "customer_name": "Dana K. Adrian",
            "customer_phone": "+145677312965",
            "customer_address": "",
            "currency": "NGN",
            "tax_rate": 5,
            "tax_amount": 8000,
            "sub_total": 160000,
            "total": 168000,
            "accepted": "False",
            "issue_date": "2018-04-03",
            "due_date": "2018-04-17",
            "note": ""
        }
    ],
    "items": [
        {
            "description": "Web Development Fee",
            "quantity": 1,
            "rate": "150000"
        },
        {
            "description": "Domain Registration",
            "quantity": 4,
            "rate": "2500"
        }
    ]
}

Edit / Update Estimate

HTTP Request

PUT https://api.invoice.ng/v1/estimate/{id}

Query Parameters
Parameter Type Description
client string Client unique ID (required)
estimate_no string Estimate reference number (required)
accepted string Estimate approval status ("True" or "False") (optional)
description string Description or project summary (optional)
currency string ISO 4217 currency code e.g. USD, GBP, EUR, NGN etc. (optional)
tax_rate numeric Tax rate in % (optional)
issue_date date Date invoice will be due for payment (optional)
due_date date Date invoice will be due for payment (optional)
note text Estimate note (optional)
items [ ] array Estimate line items (optional)
Items Query Parameters
Parameter Type Description
description string Item description (required)
quantity numeric Item quantity (required)
rate string Rate / Unit Price (required)
Response HTTP/1.1 200 OK
{
    "status": "success",
    "estimate": [
        {
            "id": "890752277062095",
            "short_code": "U5YVTVYRTK",
            "estimate_no": "EST-01",
            "description": "Web Project",
            "customer_id": "605345277110684",
            "customer_name": "Dana K. Adrian",
            "customer_phone": "+145677312965",
            "customer_address": "",
            "currency": "NGN",
            "tax_rate": 10,
            "tax_amount": 8000,
            "sub_total": 160000,
            "total": 168000,
            "accepted": "False",
            "issue_date": "2018-04-03",
            "due_date": "2018-04-17",
            "note": ""
        }
    ],
    "items": [
        {
            "description": "Web Development Fee",
            "quantity": 1,
            "rate": "150000"
        },
        {
            "description": "Domain Registration",
            "quantity": 4,
            "rate": "2500"
        },  
    ]
}

Send Estimate

HTTP Request

POST https://api.invoice.ng/v1/estimate/send

Query Parameters
Parameter Type Description
id string Estimate ID (required)
email string E-mail address (required)
phone string Phone number (optional)
Response HTTP/1.1 200 OK
{
    "status": "success",
    "message": "Estimate was successfully sent."
}

Delete Estimate

HTTP Request

DELETE https://api.invoice.ng/v1/estimate/{id}

Response HTTP/1.1 200 OK
{
    "status": "success",
    "id": "741571373454983"
}

© 2024 InvoiceApp Inc. All Rights Reserved.