Invoices

List Invoices

Here you can find all the listed invoices and if you want to search any specific invoice use the filter option and find it directly.

Sample Code / Result:
Language

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://apiv1.chargemonk.com/listInvoices?api_token=test_fEZhxDQuOmIMBAVC7K0wtNoPpGgRyed1",   
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

	          

{
    "status": "success",
    "list": 
    {
        "invoice": 
        [
            {
                "invoiceId": "YKCCRVpL",
                "planId": "basic_plan",
                "invoiceNumber": 1000,
                "invoiceStatus": "success",
                "invoiceTotal": "1100.00",
                "invoiceType": "Recurring",
                "invoiceUrl": "https://chargemonk.s3.amazonaws.com/upload/live/Q2hhcmdlTW9uay01/invoice/3bVmDt6E_1033.pdf",      
                "invoiceDate": 1574922298,
                "invoiceCreatedAt": 1574922298,
                "invoiceRetryDate": 1574932298,
                "invoiceUpdatedAt": null,
                "invoiceCurrencyCode": "USD",
                "dunning": "4,9",
                "subscription": 
                {
                    "subscriptionId": "gRFQdzVg",
                    "subscriptionStartDate": 1574922298,
                    "subscriptionNextBilling": 1574965800,
                    "pricingModel": "flat_fee",
                    "planQuantity": 1
                },
                "customer": 
                {
                    "customerId": "3bVmDt6E",
                    "firstName": "Sunil",
                    "lastName": "Pal"
                },
                "billing": 
                {
                    "billingFirstName": "Sunil",
                    "billingLastName": "Pal",
                    "billingAddress": "Sej Plaza",
                    "billingCity": "Mumbai",
                    "billingState": "Maharashtra",
                    "billingZip": "400069",
                    "billingCountry": "India"
                }
                "cards": 
                {
                    "cardId": "wLTbogtt",
                    "firstName": "Sunil",
                    "lastName": "Pal",
                    "last4": "1111",
                    "cardType": "visa",
                    "expiryMonth": "02",
                    "expiryYear": "2021"
                    "transaction": 
                    [               
                        {
                            "transactionId": "IVG4I1RY",
                            "paymentGatewayToken": "chm_2S3UZOVof8",
                            "gatewayAccountName": "Braintree",
                            "transactionAmount": 1100,
                            "transactionCurrency": "USD",
                            "transactionType": "Refund",
                            "status": "active",
                            "createdAt": 1581060556
                        }
                    ]
                }
                "customerRefundNote": 
                {
                    "refundCode": "0aBbHNnO",
                    "reasonCode": "Chargeback",
                    "refundType": "refunded",
                    "refundDate": 1574929783,
                    "refundAmount": "110.00",
                    "refundTotal": "209.00"
                },

            }
        ]
    }
}

List Invoices attributes

Key R/O Description
api_token required Token generated by ChargeMonk.
string
limit optional Limits the number of records to be shown.
integer,  default=25
page optional The page number depending upon the limit.
eg. In 100 records, limit 10, page 2 will show records from 11-20.
integer,  default=0
search_value optional First name, Last name and Subscription code, Invoice number can be searched.
string
order_by optional Display records in ascending or descending order.
asc, desc,  default=desc
order_param optional You can sort created at or updated at alone as well as with order by field.
eg. order_param = invoice_created_at
invoice_created_at, invoice_date,  default=invoice_created_at
subscriptionCode optional To filter based on Subscription Id.
Operators supported: is, is_not, starts_with, ends_with, contains, does_not_contain
eg. filter[subscriptionCode][is] = 9DpnXa7ks
string
customerCode optional To filter based on Subscription Customer Id.
Operators supported: is, is_not, starts_with, ends_with, contains, does_not_contain
eg. filter[customerCode][ends_with] = a7ks
string
firstName optional First name of the invoice.
Operators supported: is, is_not, starts_with, ends_with, contains, does_not_contain
eg. filter[firstName][is] = John
string
lastName optional Last name of the invoice.
Operators supported: is, is_not, starts_with, ends_with, contains, does_not_contain
eg. filter[lastName][is] = Doe
string
invoiceCreatedAt optional To filter based on Invoice Created at.
Operators supported: is, is_not, less_than, less_than_equal, greater_than, greater_than_equal, between
eg. filter[invoiceCreatedAt][is] = [1579602740]
eg. filter[invoiceCreatedAt][between] = [1579602740,1580301626]
integer, In timestamp(UTC) in seconds format
invoiceNumber optional The invoice number that you want to search.
Operators supported: is, is_not, less_than, less_than_equal, greater_than, greater_than_equal, between
eg. filter[invoiceNumber][is] = 10
eg. filter[invoiceNumber][between] = [10,15]
integer
status optional Current status of the invoice.
Operators supported: is, is_not
eg. filter[status][is] = pending
'pending', 'success', 'due', 'failed', 'not_paid', 'voided', 'write_off', 'reverse_invoice'
invoiceType optional Type of Invoice.
Operators supported: is, is_not
eg. filter[invoiceType][is] = Recurring
'One Time', 'Recurring'
invoiceDate optional To filter based on Invoice date.
Operators supported: is, is_not, less_than, less_than_equal, greater_than, greater_than_equal, between
eg. filter[invoiceDate][greater_than] = [1579602740]
eg. filter[invoiceNumber][between] = [1579602740,1580301626]
integer, In timestamp(UTC) in seconds format
totalAmount optional Total amount of the invoice.
Operators supported: is, is_not, less_than, less_than_equal, greater_than, greater_than_equal, between
eg. filter[totalAmount][is] = 100
eg. filter[totalAmount][between] = [100,150]
integer
filter[match] optional 'All' will take 'AND' whereas 'ANY' will take 'OR' as condition.
eg. filter[match]= ALL, filter[subscriptionCode][is] = 9DpnXa7ks, filter[invoice_created_at][is] = [1579602740] Will be read as Filter if the filed has subscription code like 9DpnXa7ks OR invoice_created_at is [1579602740].
ANY, ALL