Invoice Summary

Invoice Summary

The following Invoice Summary APIs allows users to view the invoices.

1. Invoice Records¶

Description

The invoiceRecords endpoint allows users to fetch the existing Invoice information.

Request

Endpoint

    /ui/v1/invoiceRecords

Method

    POST

Header

Content-Type: application/json

ELEMENT	DESCRIPTION
startDate	*Required* Start Date to fetch the invoices from
endDate	*Required* End Date to fetch the invoices till that date
dateType name	*Required* Name of the Date Type ex: DUE, INVOICE,PAID
dateType value	*Optional* Value of the Date Type ex: DUE, INVOICE,PAID
merchantId	*Required* specific code used for each merchant

Request Body

{
    "startDate": "2021-03-23",
    "endDate": "2021-03-30",
    "invoiceStatus": [],
    "customerType": [],
    "dateType": {
        "name": "DUE",
        "value": "Due"
    },
    "customerId": [],
    "paidByUserId": [],
    "merchantId": ["1"]
}

Response

{

    "records": null,
    "recordCount": null,
    "message": {
        "code": "9999",
        "type": {
            "value": "Informational",
            "name": "INFORMATIONAL"
        },
        "text": null,
        "include_i_icon": false,
        "description": "No records were found that match the filter criteria you entered."
    }
}

Invoice Detail¶

Description

The invoiceDetail endpoint allows users to view the details of the invoices.

Request

Endpoint

    /ui/v1/invoiceDetail?invoiceid=id

Note

Replace id with the internal id of the invoice.

Method

    POST

Header

Content-Type: application/json

Request Body

{
    "invoiceId": 137
}

Response

{
    "id": 137,
    "invoiceNumber": "500000051",
    "createdDateTime": 1591980624000,
    "lastUpdatedDateTime": 1607112324000,
    "invoiceDate": 1591934400000,
    "paidDate": null,
    "dueDate": 1591848000000,
    "terms": 30,
    "aging": 0,
    "invoiceAmount": {
        "amount": 2000.000,
        "currency": {
            "id": 1,
            "currencyCode": "USD",
            "currencyText": "United States Dollar",
            "currencySymbol": "$",
            "fractionalUnit": "Cent",
            "numOfDecimalPlaces": "2",
            "supportedByVisaCheckout": true,
            "createdDateTime": 1608316900000,
            "isoNumericCode": "840",
            "isoCountryCode": "840"
        }
    },
    "paidAmount": {
        "amount": 0.000,
        "currency": {
            "id": 1,
            "currencyCode": "USD",
            "currencyText": "United States Dollar",
            "currencySymbol": "$",
            "fractionalUnit": "Cent",
            "numOfDecimalPlaces": "2",
            "supportedByVisaCheckout": true,
            "createdDateTime": 1608316900000,
            "isoNumericCode": "840",
            "isoCountryCode": "840"
        }
    },
    "amountDue": {
        "amount": 2000.000,
        "currency": {
            "id": 1,
            "currencyCode": "USD",
            "currencyText": "United States Dollar",
            "currencySymbol": "$",
            "fractionalUnit": "Cent",
            "numOfDecimalPlaces": "2",
            "supportedByVisaCheckout": true,
            "createdDateTime": 1608316900000,
            "isoNumericCode": "840",
            "isoCountryCode": "840"
        }
    },
    "createdUserId": 231,
    "lastModifiedUserId": 218,
    "invoiceStatus": {
        "value": "Unpaid",
        "name": "UNPAID"
    },
    "customerId": 64,
    "invoiceBatchId": null,
    "paidByUserId": null,
    "merchantId": 3,
    "customerType": {
        "value": "Business",
        "name": "BUSINESS"
    },
    "waiveReasonOnLateFees": null,
    "waiveLateFeesByPercentage": null,
    "waivedByUserId": null,
    "waivedDate": null,
    "memo": "Mark the invoice as Unpaid",
    "amountAdjustedReason": null,
    "customerNumber": "500020",
    "customerName": "KK Health Care",
    "merchantName": null,
    "paidByUserName": null,
    "message": null,
    "geolocation": null,
    "channelId": null,
    "roleType": null,
    "paymentAction": null,
    "addressLine1": null,
    "addressLine2": null,
    "city": null,
    "state": null,
    "zipCode": null,
    "phone": null,
    "merchantCode": null
}

Updated As Of Version 6.9.7