Invoices

  • GET /invoice/all List Invoice(s)
  • GET /invoice/{id} Get Invoice
  • POST /invoice/add Add / Create Invoice
  • PUT /invoice/{id} Edit / Update Invoice
  • POST /invoice/send Send Invoice
  • POST /invoice/record-payment Record Payment
  • GET /invoice/paid/{id} Mark Invoice As Paid
  • GET /invoice/not-paid/{id} Mark Invoice As Not-Paid
  • DELETE /invoice/{id} Delete Invoice

List Invoice(s)

HTTP Request

GET https://api.getinvoice.co/v1/invoice/all

Response HTTP/1.1 200 OK
{
    "status": "success",
    "data": [
        {
            "id": "787714923851009",
            "short_code": "ZDWEUITXGA",
            "invoice_no": "INV-01",
            "description": "GSVBS Website Project",
            "customer_id": "606213207287745",
            "customer_name": "Dana K. Adrian",
            "customer_phone": "+145677312965",
            "customer_address": "Plot 64A, Ajaguna Street, Lekki Phase 1,  Lagos.",
            "payment_status": "Paid",
            "currency": "NGN",
            "tax_rate": 5,
            "tax_amount": 8000,
            "sub_total": 160000,
            "total": 168000,
            "amount_paid": "0",
            "outstanding_balance": "168000",
            "issue_date": "2017-06-06",
            "due_date": "2017-06-20",
            "note": "Thank you for your patronage.",
            "created_at": "2017-06-06 11:11:07",
            "updated_at": "2017-06-06 11:11:07"
        },
        ...
    ]
}

Get Invoice

HTTP Request

GET https://api.getinvoice.co/v1/invoice/{id}

Response HTTP/1.1 200 OK
{
    "status": "success",
    "invoice": [
        {
            "id": "787714923851009",
            "short_code": "ZDWEUITXGA",
            "invoice_no": "INV-01",
            "description": "GSVBS Website Project",
            "customer_id": "621216506875950",
            "customer_id": "606213207287745",
            "customer_name": "Dana K. Adrian",
            "customer_phone": "+145677312965",
            "customer_address": "Plot 64A, Ajaguna Street, Lekki Phase 1,  Lagos.",
            "currency": "NGN",
            "payment_status": "Not Paid",
            "tax_rate": 5,
            "tax_amount": 8000,
            "sub_total": 160000,
            "total": 168000,
            "amount_paid": "0",
            "outstanding_balance": "168000",
            "issue_date": "2017-06-06",
            "due_date": "2017-06-20",
            "note": ""
        }
    ],
    "items": [
        {
            "description": "Web Development Fee",
            "quantity": 1,
            "rate": "150000",
            "amount": "150000"
        },
        {
            "description": "Domain Registration",
            "quantity": 4,
            "rate": "2500",
            "amount": "10000"
        },                
        ...
    ],
    "payments": [
        {
            "status": "success",
            "reference": "FLW_PT023kV3",
            "amount": 157000,
            "bank": "Access Bank",
            "created_at": "2017-05-02 21:24:46"
        },
        ...
    ],
    "send_log": [
        {
            "email": "info@google.xyz",
            "date": "2017-05-02 21:24:46"
        },
        ...
    ]
}

Create / Add Invoice

HTTP Request

POST https://api.getinvoice.co/v1/invoice/add

Parameters
Parameter Type Description
client string Client unique ID (required)
invoice_no string Invoice number (required)
payment_status string Payment status ('Paid' or 'Not Paid') (required)
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 was issued for payment (YYYY-MM-DD) (optional)
due_date date Date invoice will be due for payment (YYYY-MM-DD) (optional)
note text Invoice footer note (optional)
items [ ] array Invoice 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",
    "invoice": [
        {
            "id": "787714923851009",
            "short_code": "ZDWEUITXGA",
            "invoice_no": "INV-01",
            "description": "GSVBS Website Project",
            "customer_id": "621216506875950",
            "customer_id": "606213207287745",
            "customer_name": "Dana K. Adrian",
            "customer_phone": "+145677312965",
            "customer_address": "Plot 64A, Ajaguna Street, Lekki Phase 1,  Lagos.",
            "currency": "NGN",
            "payment_status": "Not Paid",
            "tax_rate": 5,
            "tax_amount": 8000,
            "sub_total": 160000,
            "total": 168000,
            "amount_paid": "0",
            "outstanding_balance": "168000",
            "issue_date": "2017-06-06",
            "due_date": "2017-06-20",
            "note": "",
            "created_at": "2017-06-14 10:17:26",
            "updated_at": "2017-06-16 15:31:21"
        }
    ],
    "items": [
        {
            "description": "Web Development Fee",
            "quantity": 1,
            "rate": "150000"
        },
        {
            "description": "Domain Registration",
            "quantity": 4,
            "rate": "2500"
        },                
        ...
    ]
}

Update / Edit Invoice

HTTP Request

PUT https://api.getinvoice.co/v1/invoice/{id}

Query Parameters
Parameter Type Description
client string Client unique ID (required)
invoice_no string Invoice number (required)
payment_status string Payment status (required)
description string Description or project summary (optional)
currency string Biiling currency (optional)
tax_rate numeric Tax rate in % (optional)
issue_date date Date invoice will be due for payment (YYYY-MM-DD) (optional)
due_date date Date invoice will be due for payment (YYYY-MM-DD) (optional)
note text Invoice footer note (optional)
items [ ] array Invoice 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",
    "invoice": [
        {
            "id": "787714923851009",
            "short_code": "ZDWEUITXGA",
            "invoice_no": "INV-01",
            "description": "GSVBS Website Project",
            "customer_id": "621216506875950",
            "customer_id": "606213207287745",
            "customer_name": "Dana K. Adrian",
            "customer_phone": "+145677312965",
            "customer_address": "Plot 64A, Ajaguna Street, Lekki Phase 1,  Lagos.",
            "currency": "NGN",
            "payment_status": "Not Paid",
            "tax_rate": 5,
            "tax_amount": 8000,
            "sub_total": 160000,
            "total": 168000,
            "amount_paid": "0",
            "outstanding_balance": "168000",
            "issue_date": "2017-06-06",
            "due_date": "2017-06-20",
            "note": "",
            "created_at": "2017-06-14 10:17:26",
            "updated_at": "2017-06-16 15:31:21"
        }
    ],
    "items": [
        {
            "description": "Web Development Fee",
            "quantity": 1,
            "rate": "150000"
        },
        {
            "description": "Domain Registration",
            "quantity": 4,
            "rate": "2500"
        },        
        ...
    ]
}

Send Invoice

HTTP Request

POST https://api.getinvoice.co/v1/invoice/send

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

Record Invoice Payment

HTTP Request

POST https://api.getinvoice.co/v1/invoice/record-payment

Query Parameters
Parameter Type Description
id string Invoice ID (required)
payment_date date Payment Date (YYYY-MM-DD) (required)
amount_paid numeric Amount Paid (required)
payment_method string Payment Method (E.g. 'Cash' | 'Bank Transfer' | 'Cheque' | 'Credit Card' | 'Others') (optional)
Response HTTP/1.1 200 OK
{
    "status": "success",
    "message": "Invoice payment update was successful."
}

Mark Invoice As Paid

HTTP Request

GET https://api.getinvoice.co/v1/invoice/paid/{id}

Response HTTP/1.1 200 OK
{
    "status": "success",
    "message": "Invoice update was successful."
}

Mark Invoice As Not-Paid

HTTP Request

GET https://api.getinvoice.co/v1/invoice/not-paid/{id}

Response HTTP/1.1 200 OK
{
    "status": "success",
    "message": "Invoice update was successful."
}

Delete Invoice

HTTP Request

DELETE https://api.getinvoice.co/v1/invoice/{id}

Response HTTP/1.1 200 OK
{
    "status": "success",
    "message": "Invoice was successfully deleted."
}

© 2024 InvoiceApp Inc. All Rights Reserved.