List Invoices

Get a list of your invoices on Terraswitch.

GET {{ BASE_URL }}/v1/corporate/invoices

Optional Query Parameters

Property	Data Type	Description	Example
limit	string	Number of records per page	50
page	string	Page number to view	1
order	string	Arrangement of records in descending or ascending order	"asc" or "desc"

Node.js

import Axios from 'axios';

// set the api url
const API_URL = `${BASE_URL}/v1/corporate/invoices`;

// make request using axios
Axios({
    method: "GET",
    url: `${API_URL}`,
    headers: {
        lg: 'en',
        ch: 'web'
        Authorization: `Bearer ${API_KEY}`,
        'Content-Type': 'application/json',
    }
}).then((resp) => {
    console.log(resp)
}).catch((err) => {
    console.log(err)
})

Response

{
    "error": false,
    "errors": [],
    "count": 1,
    "total": 1,
    "pagination": {},
    "data": [
        {
            "code": "VPIB3E319FB",
            "name": "NANST-INV",
            "number": "NANST-00124",
            "status": "pending",
            "link": "https://staging-web.vacepay.com/invoice/VPIB3E319FB",
            "VAT": {
                "title": "TAX",
                "type": "percentage",
                "value": 5
            },
            "summary": {
                "subtotal": 4001.98,
                "partialAmount": 0,
                "totalAmount": 4202.08
            },
            "description": "Invoice for nanst limited",
            "isEnabled": true,
            "inflow": {
                "value": 0,
                "count": 0
            },
            "items": [
                {
                    "label": "ITMKFMFWS",
                    "name": "Brown D&G Bag",
                    "price": 2000.99,
                    "quantity": 2,
                    "total": 4001.98
                }
            ],
            "dueAt": {
                "date": "2024-01-28",
                "time": "00:30:45",
                "ISO": "2024-01-28T00:30:45.000Z"
            },
            "issuedAt": {
                "date": "2024-01-13",
                "time": "18:31:23",
                "ISO": "2024-01-13T18:31:23.094Z"
            },
            "paymentLink": "",
            "recipient": {
                "type": "business",
                "businessName": "NANST Solutions Limited",
                "firstName": "Oluwatobi",
                "lastName": "Immanuel",
                "email": "[email protected]",
                "phoneNumber": "08137031202",
                "phoneCode": "+234",
                "countryCode": "NG",
                "address": "Alausa, Ikeja Lagos.",
                "city": "Ikeja",
                "state": "Lagos"
            },
            "createdAt": "2024-01-13T18:31:23.061Z",
            "updatedAt": "2024-01-13T18:31:23.113Z"
        }
    ],
    "message": "successful",
    "status": 200
}