Get Sent Invoice Details

Retrieve comprehensive information about a specific sent invoice, including customer details, line items, tax information, and payment status.

Quick Reference

Method	Endpoint	Authentication Required
GET	https://api-dev.nairainvoice.com/dev/external/businesses/:businessId/invoices/:invoiceIrn	Yes

Request Structure

Path Parameters

Parameter	Type	Required	Description	Example
businessId	string	✅	Unique identifier of the business	26ede24b-ac50-475f-aacc-5ea6339f0863
invoiceIrn	string	✅	Invoice Reference Number	INV237-1070ECE8-20250826

📤 Response Format

Success Response (200)

Copy to Clipboard

{
  "data": {
    "irn": "INV237-1070ECE8-20250826",
    "issueDate": "2025-08-26",
    "issueTime": "12:57:15",
    "dueDate": "2025-08-26",
    "invoiceTypeCode": "389",
    "documentCurrencyCode": "NGN",
    "taxCurrencyCode": "NGN",
    "paymentStatus": "PAID",
    "note": "August Electricity Bill - Mr Ridwan",
    "taxPointDate": "2025-08-26",
    "actualDeliveryDate": "2025-08-26",
    "paymentTermsNote": "Payment due within 30 days",
    "accountingCost": "COST-2025-001",
    "legalMonetaryTotal": {
      "lineExtensionAmount": 30030.0,
      "taxExclusiveAmount": 30030.0,
      "taxInclusiveAmount": 30255.22,
      "payableAmount": 30255.22
    },
    "accountingCustomerParty": {
      "id": "b1261670-67a3-44d6-b38e-2dddd5dd1454",
      "tin": "68721523-8104",
      "partyName": "Dangote Group",
      "businessDescription": "Sales of Cement and building materials",
      "email": "customer@dangote.com",
      "telephone": "+23480254099000",
      "postalAddress": {
        "cityName": "Gwarikpa",
        "postalZone": "023401",
        "countryIdentificationCode": "NG",
        "streetName": "32, owonikoko street",
        "lga": "Aba",
        "state": "Abia"
      }
    },
    "accountingSupplierParty": {
      "id": "b4009129-ece8-45fc-9584-976fcbe35f8d",
      "tin": "68721523-8104",
      "partyName": "AEDC Electricity Supply",
      "businessDescription": "Electricity supply services",
      "email": "redtech@gmail.com",
      "telephone": "+234447784433",
      "postalAddress": {
        "cityName": "Aba",
        "postalZone": "101245",
        "countryIdentificationCode": "NG",
        "streetName": "Victoria Island",
        "lga": "Aba",
        "state": "Abia"
      }
    },
    "invoiceLine": [
      {
        "id": "1",
        "invoicedQuantity": 200.0,
        "lineExtensionAmount": 30030.0,
        "item": {
          "name": "Electricity Supply",
          "description": "Electricity Units",
          "sellersItemIdentification": {
            "id": "ELEC-001"
          },
          "commodityClassification": {
            "itemClassificationCode": "2716.00"
          }
        },
        "price": {
          "priceAmount": 150.0,
          "baseQuantity": 1.0,
          "unitCode": "NGN PER 1"
        }
      }
    ],
    "taxTotal": [
      {
        "taxAmount": 225.22,
        "taxSubtotal": [
          {
            "taxableAmount": 30030.0,
            "taxAmount": 225.22,
            "taxCategory": {
              "id": "STANDARD_VAT",
              "percent": 0.75
            }
          }
        ]
      }
    ],
    "allowanceCharge": [
      {
        "chargeIndicator": false,
        "allowanceChargeReason": "Early payment discount",
        "allowanceChargeReasonCode": "95",
        "amount": 150.0,
        "baseAmount": 30030.0,
        "multiplierFactorNumeric": 0.005
      }
    ],
    "invoiceDeliveryPeriod": {
      "startDate": "2025-08-01",
      "endDate": "2025-08-31"
    },
    "contractDocumentReference": {
      "id": "CONTRACT-2025-001",
      "issueDate": "2025-08-01"
    },
    "orderReference": {
      "id": "ORDER-2025-456"
    },
    "paymentMeans": [
      {
        "paymentMeansCode": "30",
        "paymentMeansCodeDescription": "Credit transfer",
        "payeeFinancialAccount": {
          "id": "1234567890",
          "name": "AEDC Business Account"
        }
      }
    ],
    "additionalDocumentReference": [
      {
        "id": "DOC-REF-001",
        "issueDate": "2025-08-25"
      }
    ],
    "billingReference": [
      {
        "invoiceDocumentReference": {
          "id": "PREV-INV-123",
          "issueDate": "2025-07-26"
        }
      }
    ],
    "originatorDocumentReference": {
      "id": "ORIG-DOC-001",
      "issueDate": "2025-08-20"
    },
    "receiptDocumentReference": {
      "id": "RECEIPT-001",
      "issueDate": "2025-08-26"
    },
    "dispatchDocumentReference": {
      "id": "DISPATCH-001",
      "issueDate": "2025-08-25"
    }
  },
  "responseCode": "00",
  "responseMessage": "Invoice retrieved successfully"
}

📋 Response Data Structure

Core Invoice Information

Field	Type	Description
irn	string	Invoice Reference Number
issueDate	string	Date invoice was issued (YYYY-MM-DD)
issueTime	string	Time invoice was issued (HH:MM:SS)
dueDate	string	Payment due date
invoiceTypeCode	string	Type code of the invoice
documentCurrencyCode	string	Currency code for the invoice
taxCurrencyCode	string	Currency code for tax calculations
paymentStatus	string	Current payment status
note	string	Additional notes about the invoice
taxPointDate	string	Date when tax becomes due
actualDeliveryDate	string	Actual delivery date
paymentTermsNote	string	Payment terms description
accountingCost	string	Accounting cost reference

Legal Monetary Total

Field	Type	Description
legalMonetaryTotal.lineExtensionAmount	number	Total line extension amount
legalMonetaryTotal.taxExclusiveAmount	number	Amount excluding tax
legalMonetaryTotal.taxInclusiveAmount	number	Amount including tax
legalMonetaryTotal.payableAmount	number	Total payable amount

👤 Party Information

Customer Party `(accountingCustomerParty)`

Field	Type	Description
id	string	Customer unique identifier
tin	string	Tax identification number
partyName	string	Customer name
businessDescription	string	Customer business description
email	string	Customer email address
telephone	string	Customer phone number
postalAddress	object	Customer address details

Supplier Party ( `accountingSupplierParty` )

Field	Type	Description
id	string	Supplier unique identifier
tin	string	Tax identification number
partyName	string	Supplier name
businessDescription	string	Supplier business description
email	string	Supplier email address
telephone	string	Supplier phone number
postalAddress	object	Supplier address details

Postal Address Structure

Field	Type	Description
cityName	string	City name
postalZone	string	Postal/ZIP code
countryIdentificationCode	string	Country code (ISO 2-letter)
streetName	string	Street address
lga	string	Local Government Area
state	string	State/province

📋 Invoice Line Items

Invoice Line Structure (invoiceLine)

Field	Type	Description
id	string	Line item identifier
invoicedQuantity	number	Quantity of items
lineExtensionAmount	number	Total amount for line item
item	object	Item details
price	object	Pricing information

Item Details

Field	Type	Description
item.name	string	Item name
item.description	string	Item description
item.sellersItemIdentification.id	string	Seller’s item ID
item.commodityClassification.itemClassificationCode	string	HSN/commodity code

Price Information

Field	Type	Description
price.priceAmount	number	Price per unit
price.baseQuantity	number	Base quantity for pricing
price.unitCode	string	Unit of measurement

🧾 Tax Information

Tax Total Structure (taxTotal)

Field	Type	Description
taxAmount	number	Total tax amount
taxSubtotal	array	Array of tax subtotals

Tax Subtotal Details

Field	Type	Description
taxableAmount	number	Amount subject to tax
taxAmount	number	Tax amount for this subtotal
taxCategory.id	string	Tax category identifier
taxCategory.percent	number	Tax percentage

💰 Allowances & Charges

Allowance/Charge Structure (allowanceCharge)

Field	Type	Description
chargeIndicator	boolean	true for charge, false for allowance
allowanceChargeReason	string	Reason for allowance/charge
allowanceChargeReasonCode	string	Reason code
amount	number	Allowance/charge amount
baseAmount	number	Base amount for calculation
multiplierFactorNumeric	number	Multiplier factor

📄 Document References

Contract Document Reference

Field	Type	Description
contractDocumentReference.id	string	Contract document ID
contractDocumentReference.issueDate	string	Contract issue date

Order Reference

Field	Type	Description
orderReference.id	string	Order reference ID

Additional Document References

Field	Type	Description
additionalDocumentReference[].id	string	Document reference ID
additionalDocumentReference[].issueDate	string	Document issue date

💳 Payment Information

Payment Means

Field	Type	Description
paymentMeans[].paymentMeansCode	string	Payment method code
paymentMeans[].paymentMeansCodeDescription	string	Payment method description
paymentMeans[].payeeFinancialAccount.id	string	Account number
paymentMeans[].payeeFinancialAccount.name	string	Account name

Delivery Period

Field	Type	Description
invoiceDeliveryPeriod.startDate	string	Delivery period start date
invoiceDeliveryPeriod.endDate	string	Delivery period end date

📝 Example Usage

Basic Invoice Retrieval

Copy to Clipboard

✅ Validation Rules

Path Parameter Validation

businessId must be a valid UUID format
invoiceIrn must exist and belong to the specified business
Invoice must be in “sent” status to be retrievable

Business Logic Validation

Invoice must exist in the system
User must have permission to access the business’s invoices
Invoice must not be in draft or deleted status

⚠️ Error Responses

Common Error Scenarios

Error Code	Message	Description	Solution
404	Invoice not found	Invoice IRN doesn’t exist for the business	Verify invoice IRN and business ID
403	Access denied	User doesn’t have permission to access this invoice	Check user permissions for the business
400	Invalid parameters	Business ID or Invoice IRN format is invalid	Ensure correct parameter formats
422	Invoice not available	Invoice is in draft or deleted status	Only sent invoices can be retrieved

Example Error Response

Copy to Clipboard

💡 Use Cases

Common Implementation Scenarios

1. Invoice Review

Copy to Clipboard

2. Payment Processing

Copy to Clipboard

3. Audit Trail

Copy to Clipboard

4. Customer Portal

Copy to Clipboard

🔗 Related Endpoints

Invoice Management

POST /invoices – Create new invoice
POST /invoices/bulk – Bulk invoice creation
POST /invoices/update-payment/ – Update payment status
GET /invoices//qrcode – Get invoice QR code

Invoice Operations

GET /invoices – List invoices with filtering
GET /invoices//pdf – Download invoice PDF
POST /invoices//send – Send invoice via email
DELETE /invoices/ – Cancel invoice

This endpoint provides comprehensive access to invoice details, enabling businesses to efficiently manage, track, and process their invoices throughout the entire invoice lifecycle.

Request

Path Params

Parameter	Type	Required	Example
stage	string	required
businessId	string	required

Header Params

Parameter	Type	Required	Description	Example
X-Business-Key	string	required	(Required) X-Business-Key	BK-26EDE24BAC50475FAACC5EA6339F0863-DEV-B2Z6QCEHI3X9
Accept	string	required	Specifies acceptable response type	/

Response

Response Status

200 OK

401 Unauthorized
403 Forbidden
404 Not Found

Get Sent Invoice Details