List all invoices

Returns a list of all invoices created

URI

GET

https://app-api.tryduplo.com/v1/merchants/invoice?business_id=f636411f-d4c0-4dd6-86b3-93746d8f71&per_page=10&search_term=100&invoice_status=&payment_status=

Parameters

Header

Authorization string

set value to Bearer SECRET_KEY

Query Param

business_id string

Merchant business ID

page string

Specifies the current page in a list of paginated data, default is set to 1

per_page string

Specifies the number of records per page of a paginated data, default is set to 50

search_term string

Specifies a keyword to be used in filtering transactions.

invoice_status string

Invoice status

payment_status string

Payment status

Sample request

curl --location --request GET 'https://app-api.tryduplo.com/v1/merchants/invoice?business_id=f6411f-d4c0-4dd6-86b3-937e646d8f71&per_page=10&search_term=100' \
--header 'Authorization: Bearer dp_live_856879df3e6ecdb14a918e24bba6d480e054eabfdba938fc23b820ac905e54bac25a71dbcdef66c97b8c72ca7e16cf03a576857261f2f16f5335ca5024620b14268823a7d78922cfdd97cefc61050139fd92a7a0c5840e016050552ccadbbec642d2ff8d35a09225c7ec4fd1e347b'

var axios = require('axios');

var config = {
  method: 'get',
  url: 'https://app-api.tryduplo.com/v1/merchants/invoice?business_id=f636411f-d4c0-4dd6-86b3-937e68f71&per_page=10&search_term=100',
  headers: { 
    'Authorization': 'Bearer dp_live_856879df3e6ecdb14a918e24bba6d480e0564a4eabfdba938fc23b820ac905e54bac25a71dbcdef66c97b8c72ca7e16cf03a261f2f16f5335ca5024620b14268823a7d78922cfdd97cefc61050139fd92a7a0c5840e016050552ccadbbec642d2ff8d35a09225c7ec4fd1e347b'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://app-api.tryduplo.com/v1/merchants/invoice?business_id=f636411f-d4c0-4dd6-86b3-937e64f71&per_page=10&search_term=100',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer dp_live_856879df3e6ecdb14a918e24bba0e0564a4eabfdba938fc23b820ac905e54bac25a71dbcdef66c97b8c72ca7e16cf03a576857261f2f16f5335ca5024620b14268823a7d78922cfdd97cefc61050139fd92a7a0c5840e016050552ccadbbec642d2ff8d35a09225c7ec4fd1e347'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Duplo Response

{
    "data": {
        "data": [
            {
                "id": "ec07d5ef-9e9d-4b83-b5ac-d73f5f86e75b",
                "invoice_number": "78779939988",
                "title": "Invoice for Mwenda Deno",
                "recipient": "wal_ZKmo7StVZMrZ",
                "due_date": "2022-05-25T00:00:00.000Z",
                "items": [
                    {
                        "name": "sample name",
                        "total": 7510.5,
                        "quantity": 15,
                        "unit_price": 500.7
                    },
                    {
                        "name": "sample name 2",
                        "total": 3118.6,
                        "quantity": 31,
                        "unit_price": 100.6
                    }
                ],
                "shipping_fee": 670.9,
                "discount": {
                    "type": "amount",
                    "value": 400.5
                },
                "tax": {
                    "type": "percentage",
                    "value": 10.2,
                    "description": "sample description"
                },
                "total_invoice_amount": "12011.249",
                "note": "sample note",
                "status": "draft",
                "public_id": "bekBHSZwtXmUfIxtiuPtHlbvBQky7msw",
                "account": {
                    "provider": {
                        "id": "wema",
                        "default": true,
                        "prefixes": [
                            "222",
                            "919",
                            "888"
                        ],
                        "bank_code": "111",
                        "bank_name": "Wema Bank",
                        "is_prefix": true,
                        "credentials": {}
                    },
                    "account_ref": "act_vlOkGxRjKKoB",
                    "account_number": "8880000368"
                },
                "payment": {
                    "reason": null,
                    "status": "UNPAID"
                },
                "created_at": "2022-05-25T19:19:11.954Z",
                "update_at": "2022-05-25T19:19:11.955Z",
                "business_id": "80efed51-96fc-43c7-9075-9f78877d26bc"
            }
        ],
        "meta": {
            "page": 1,
            "limit": 20,
            "previousPage": false,
            "nextPage": false,
            "pageCount": 1,
            "total": 1
        },
        "additional_data": {
            "paid_invoices": {
                "amount": "12011.25",
                "count": 2
            },
            "unpaid_invoices": {
                "amount": "72067.49",
                "count": 6
            },
            "overdue_invoices": {
                "amount": "72067.49",
                "count": 6
            },
            "all_invoices": {
                "amount": "264247.48",
                "count": 23
            }
        }
    },
    "errors": {},
    "message": "Request successful"
}

PreviousResend invoice NextGet invoice details

Last updated 2 years ago

Was this helpful?