• GET /client/all List Client(s)
  • GET /client/{id} Get Client
  • POST /client/add Add Client
  • PUT /client/{id} Edit / Update Client
  • DELETE /client/{id} Delete Client
HTTP Request

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

Response HTTP/1.1 200 OK
{
    "status": "success",
    "data": [
        {
            "id": "627626593125951",
            "names": "Huebris Digital Labs",
            "email": "hello@huebris.co",
            "phone": "2348033445566",
            "address": "Plot 64A, Ajaguna Street, Lekki Phase 1,  Lagos.",
            "created_at": "2017-06-14 09:57:12"
        },
        ...
    ]
}                     
                                        
HTTP Request

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

Response HTTP/1.1 200 OK
{
    "status": "success",
    "data": [
        {
            "id": "627626593125951",
            "names": "Huebris Digital Labs",
            "email": "hello@huebris.co",
            "phone": "2348033445566",
            "address": "Plot 64A, Ajaguna Street, Lekki Phase 1,  Lagos.",
            "created_at": "2017-06-14 09:57:12",
            "updated_at": "2017-06-14 09:57:12"
        }
    ],
    "invoices": [
        {
            "id": "787714923851009",
            "short_code": "k2lyq39z",
            "invoice_no": "INV-01",
            "description": "GSVBS Website Project",
            "customer_id": "621216506875950",
            "customer_id": "606213207287745",
            "customer_name": "Dana J. Kamason",
            "customer_phone": "+22377312995",
            "customer_address": "Plot 64A, Ajaguna Street, Lekki Phase 1,  Lagos.",
            "currency": "NGN",
            "payment_status": "Not Paid",
            "tax_rate": 5,
            "tax_amount": 7500,
            "sub_total": 150000,
            "total": 157500,
            "amount_paid": "0",
            "outstanding_balance": "157500",
            "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"
        },
        ...
    ],
    "estimates": [
        {
            "id": "879675263930603",
            "short_code": "J9RDHESCDC",
            "reference_no": "EST-02",
            "description": "Web Design Proposal",
            "customer_id": "605345277110684",
            "customer_name": "Somide Olaoye",
            "customer_phone": "08060151398",
            "customer_address": "",
            "currency": "NGN",
            "accepted": "False",
            "tax_rate": 5,
            "tax_amount": 7500,
            "sub_total": 150000,
            "total": 157500,
            "issue_date": "2018-02-21",
            "due_date": "2018-03-23",
            "note": "",
            "created_at": "2018-02-21 17:31:29",
            "updated_at": "2017-06-16 15:31:21"
        },
        ...
    ]    
}
                                        
HTTP Request

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

Query Parameters
Parameter Type Description
names string Full name of the Client (required)
email string E-mail address of the client (optional)
phone string Phone number of the client (optional)
address string Client shipping or physical address (optional)
Response HTTP/1.1 200 OK
{
    "status": "success",
    "data": [
        {
            "id": "606213207287745",
            "names": "Dana J. Kamason",
            "email": "dana.kamason@hello.co",
            "phone": "+22377312995",
            "address": "Plot 64A, Ajaguna Street, Lekki Phase 1,  Lagos.",
            "created_at": "2017-06-14 10:08:17",
            "updated_at": "2017-06-14 10:10:07"
        }
    ]
}             
                                        
HTTP Request

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

Query Parameters
Parameter Type Description
names string Full name of the Client (required)
email string E-mail address of the client (optional)
phone string Phone number of the client (optional)
address string Biiling address of the user (optional)
Response HTTP/1.1 200 OK
{
    "status": "success",
    "data": [
        {
            "id": "606213207287745",
            "names": "Dana J. Kamason",
            "email": "dana.kamason@hello.co",
            "phone": "+22377312995",
            "address": "Plot 64A, Ajaguna Street, Lekki Phase 1,  Lagos.",
            "created_at": "2017-06-14 10:08:17",
            "updated_at": "2017-06-14 10:10:07"
        }
    ]
}             
                                        
HTTP Request

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

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

Copyright © InvoiceApp Technologies. All Rights Reserved.