Get Invoice Detail

This operation retrieves invoice details using the specified groupCode and invoiceReference, providing key information about the invoice.

Path Parameter

Field Name	Type	Required	Description
groupCode	string	true	The unique code used to identify a subledger group
invoiceReference	string	true	The unique reference code used to identify an invoice

Response Body

When the invoice is PENDING

Field Name	Type	Description
description	string	A brief summary or details about the invoice.
customerEmail	string	The email address of the customer associated with the invoice.
customerName	string	The full name of the customer.
invoiceReference	string	A unique reference identifier for the invoice.
amount	decimal	The total amount of the invoice.
subledgergroupcode	string	A classification code for financial sub-ledger grouping.
merchantid	integer	The unique identifier of the merchant issuing the invoice.
status	string	The current status of the invoice (e.g., "PENDING").
expiryDate	string	The date when the invoice will expire if not paid.
statusDate	string	The timestamp of the last status update for the invoice.

When the invoice is PAID

Name	Type	Description
description	string	A brief summary or details about the invoice.
customerEmail	string	The email address of the customer associated with the invoice.
customerName	string	The full name of the customer.
invoiceReference	string	A unique reference identifier for the invoice.
amount	decimal	The total amount of the invoice.
subledgergroupcode	string	A classification code for financial sub-ledger grouping.
merchantid	integer	The unique identifier of the merchant issuing the invoice.
status	string	The current status of the invoice (e.g., "PAID").
allocatedNuban	string	The NUBAN (Bank Account Number) allocated for the payment.
sourceAccountNumber	string	The account number from which the payment was made.
sourceAccountName	string	The name associated with the source account.
sourceAccountBank	string	The bank where the source account is held.
sessionID	string	A unique identifier for tracking the transaction session.
expiryDate	string	The date when the invoice was originally set to expire.
statusDate	string	The timestamp of the last status update for the invoice.

Responses

🟢200Get Invoice Detail

application/json

Body

Example

{
    "description": "Test Invoice 00",
    "customerEmail": "mohdolateju@gmail.com",
    "customerName": "Mohammed",
    "invoiceReference": "3838383HGFDDDDD119651",
    "amount": 555,
    "subledgergroupcode": "RBZK2V1C26",
    "merchantid": 1873,
    "status": "Pending",
    "expiryDate": "2023-11-23T12:15:00Z",
    "statusDate": "2023-11-22T15:15:30+00:00"
}

🟢200Get Invoice Detail [Paid]

Path Parameter

Response Body

Request

Request Code Samples

Responses

Get Invoice Detail

Path Parameter#

Response Body#

Request

Request Code Samples

Responses

Path Parameter

Response Body