Get Sent Invoice Details
GET
{{baseUrl}}/{{stage}}/external/businesses/{{businessID}}/invoices/{{InvoiceIRN}}
GET {{baseUrl}}/{{stage}}/external/businesses/{{businessID}}/invoices/{{InvoiceIRN}}Request
Headers
| Header | Value | Required |
|---|---|---|
Content-Type | application/json or */* | Yes |
Accept | application/json or */* | Yes |
X-Business-Key | businessKey | Yes |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
businessId | string (UUID) | ✅ | Business identifier |
invoiceIrn | string | ✅ | Invoice Reference Number |
Example Request
GET {{baseUrl}}/{{stage}}/external/businesses/{{businessID}}/invoices/{{InvoiceIRN}}Response (200)
{
"responseCode": "00",
"responseMessage": "Completed successfully",
"data": {
"requestType": "B2B",
"invoiceNumber": "INV0001",
"invoiceId": null,
"invoiceBusinessId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"invoiceEntityId": null,
"invoiceIssueDate": "2025-01-01",
"invoiceIrn": "INV0001-XXXXXXXX-20250101",
"invoiceDueDate": "2025-02-01",
"invoiceIssueTime": "08:00:00",
"invoiceTypeCode": "384",
"invoicePaymentStatus": "PENDING",
"invoiceNote": "Sample invoice note",
"invoiceTaxPointDate": "2025-01-01",
"invoiceDocumentCurrencyCode": "NGN",
"invoiceTaxCurrencyCode": "NGN",
"invoiceAccountingCost": null,
"invoiceBuyerReference": "REF-00000001",
"invoiceOrderReference": "ORD-00000001",
"invoiceActualDeliveryDate": null,
"invoicePaymentTermsNote": "Payment is expected on or before EOM Jan 2025",
"invoiceCustomerPartyId": null,
"invoiceCustomerPartyTin": "00000000-0001",
"invoiceCustomerPartyEmail": "customer@example.com",
"invoiceCustomerPartyTelephone": "+2340000000000",
"invoiceCustomerPartyBusinessDescription": "Sample Customer Business Description",
"invoiceCustomerPartyName": "Customer Company LTD",
"invoiceCustomerCityName": "Lagos",
"invoiceCustomerPostalZone": "100001",
"invoiceCustomerCountry": "NG",
"invoiceCustomerStreetName": "1, Sample Street",
"invoiceSupplierPartyId": null,
"invoiceSupplierPartyTin": "00000000-0001",
"invoiceSupplierPartyEmail": "supplier@example.com",
"invoiceSupplierPartyTelephone": "+2340000000000",
"invoiceSupplierPartyBusinessDescription": "Sample Supplier Business Description",
"invoiceSupplierPartyName": "Supplier Company LTD",
"invoiceSupplierLga": "NG-LA-EOS",
"invoiceSupplierState": "LA",
"invoiceCustomerLga": "NG-LA-EOS",
"invoiceCustomerState": "NG-LA",
"invoiceSupplierCityName": "Lagos",
"invoiceSupplierPostalZone": "100001",
"invoiceSupplierCountry": "NG",
"invoiceSupplierStreetName": "2, Sample Street",
"invoiceLineExtensionAmount": 20000000.00,
"invoiceTaxExclusiveAmount": 20000000.00,
"invoiceTaxInclusiveAmount": 21500000.00,
"invoicePayableAmount": 21500000.00,
"invoiceContractDocumentIrn": null,
"invoiceContractDocumentIssueDate": null,
"invoiceOriginatorDocumentIrn": null,
"invoiceOriginatorDocumentIssueDate": null,
"invoiceReceiptDocumentIrn": null,
"invoiceReceiptDocumentIssueDate": null,
"invoiceDispatchDocumentIrn": null,
"invoiceDispatchDocumentIssueDate": null,
"invoiceDeliveryPeriodStartDate": null,
"invoiceDeliveryPeriodEndDate": null,
"invoiceStatus": "TRANSMITTED",
"invoiceCreatedAt": null,
"invoiceUpdatedAt": null,
"invoiceAdditionalDocumentReference": [],
"invoiceAllowanceCharge": [],
"invoiceBillingReference": [],
"invoiceLine": [
{
"invoiceLineInvoiceId": 0,
"invoiceLineProductCategory": "Sample Product Category",
"invoiceLineDiscountRate": 0.0,
"invoiceLineDiscountAmount": 0.0,
"invoiceLineFeeRate": 0.0,
"invoiceLineFeeAmount": 0.0,
"invoiceLineInvoicedQuantity": 1000.0,
"invoiceLineExtensionAmount": 20000000.00,
"invoiceLineHsnCode": "0000",
"invoiceLineItemDescription": "Sample item description",
"invoiceLineItemSellersItemIdentification": "ITEM-001",
"invoiceLineItemName": "Sample Item Name",
"invoiceLinePriceBaseQuantity": 1,
"invoiceLinePriceUnit": "NGN PER 1",
"invoiceLinePriceAmount": 20000.00
}
],
"invoicePaymentMeans": [
{
"invoicePaymentMeansInvoiceId": null,
"invoicePaymentMeansDueDate": "2025-01-31",
"invoicePaymentMeansCode": "10"
}
],
"invoiceTaxTotal": [
{
"invoiceTaxTotalInvoiceId": 0,
"invoiceTaxTotalAmount": 1500000.00,
"invoiceTaxTotalSubTotal": [
{
"taxSubTotalTaxableAmount": 20000000.00,
"taxSubTotalTaxAmount": 1500000.00,
"taxSubTotalCategoryId": "STANDARD_VAT",
"taxSubTotalCategoryPercent": 7.5
}
]
}
],
"invoiceWebhookUrl": null,
"invoiceWebhookAuth": null,
"invoiceWebhookAuthValue": null
}
}```
---
## Validation Rules
- `businessId` must be a valid UUID
- `invoiceIrn` must belong to the specified business
- Only **sent** invoices are retrievable — drafts and deleted invoices return `422`
---
## Error Responses
| HTTP Code | Message | Cause |
|-----------|---------|-------|
| `404` | Invoice not found | IRN doesn't exist for this business |
| `403` | Access denied | Insufficient permissions |
| `400` | Invalid parameters | Malformed UUID or IRN |
| `422` | Invoice not available | Invoice is in draft or deleted status |
```json
{
"data": null,
"responseCode": "404",
"responseMessage": "Invoice not found with IRN: INV999-INVALID for business: b4009129-ece8-45fc-9584-976fcbe35f8d"
}Request
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff '{{baseUrl}}/{{stage}}/external/businesses/{{businessID}}/invoices/{{InvoiceIRN}}' \
--header 'X-Business-Key: BK-26EDE24BAC50475FAACC5EA6339F0863-DEV-B2Z6QCEHI3X9' \
--header 'Accept: */*'Response Response Example
{
"data": {
"accountingCost": "string",
"accountingCustomerParty": {
"businessDescription": "string",
"email": "string",
"id": "string",
"partyName": "string",
"postalAddress": {
"postalAddressCityName": "string",
"postalAddressCountry": "string",
"postalAddressCreatedAt": "string",
"postalAddressId": 5867,
"postalAddressPostalZone": "string",
"postalAddressStatus": "string",
"postalAddressStreetName": "string",
"postalAddressType": "string",
"postalAddressTypeId": 3035,
"postalAddressUpdatedAt": "string"
},
"telephone": "string",
"tin": "string"
},
"accountingSupplierParty": {
"businessDescription": "string",
"email": "string",
"id": "string",
"partyName": "string",
"postalAddress": {
"postalAddressCityName": "string",
"postalAddressCountry": "string",
"postalAddressCreatedAt": "string",
"postalAddressId": 6102,
"postalAddressPostalZone": "string",
"postalAddressStatus": "string",
"postalAddressStreetName": "string",
"postalAddressType": "string",
"postalAddressTypeId": 5195,
"postalAddressUpdatedAt": "string"
},
"telephone": "string",
"tin": "string"
},
"actualDeliveryDate": "string",
"additionalDocumentReference": [
{
"irn": "string",
"issueDate": "string"
},
{
"irn": "string",
"issueDate": "string"
}
],
"allowanceCharge": [
{
"amount": 3215.1323717528267,
"chargeIndicator": true
},
{
"amount": 3688.3162369364,
"chargeIndicator": false
}
],
"billingReference": [
{
"irn": "string",
"issueDate": "string"
},
{
"irn": "string",
"issueDate": "string"
}
],
"businessId": "string",
"buyerReference": "string",
"contractDocumentReference": {
"irn": "string",
"issueDate": "string"
},
"dispatchDocumentReference": {
"irn": "string",
"issueDate": "string"
},
"documentCurrencyCode": "string",
"dueDate": "string",
"invoiceDeliveryPeriod": {
"endDate": "string",
"startDate": "string"
},
"invoiceLine": [
{
"invoiceLineCreatedAt": "string",
"invoiceLineDiscountAmount": "string",
"invoiceLineDiscountRate": "string",
"invoiceLineExtensionAmount": "string",
"invoiceLineFeeAmount": "string",
"invoiceLineFeeRate": "string",
"invoiceLineHsnCode": "string",
"invoiceLineId": 2938,
"invoiceLineInvoiceId": 4435,
"invoiceLineInvoicedQuantity": "string",
"invoiceLineItemDescription": "string",
"invoiceLineItemName": "string",
"invoiceLineItemSellersItemIdentification": "s",
"invoiceLinePriceAmount": "string",
"invoiceLinePriceBaseQuantity": "string",
"invoiceLinePriceUnit": "string",
"invoiceLineProductCategory": "string",
"invoiceLineStatus": "strin",
"invoiceLineUpdatedAt": "string"
},
{
"invoiceLineCreatedAt": "string",
"invoiceLineDiscountAmount": "st",
"invoiceLineDiscountRate": "string",
"invoiceLineExtensionAmount": "string",
"invoiceLineFeeAmount": "string",
"invoiceLineFeeRate": "string",
"invoiceLineHsnCode": "string",
"invoiceLineId": 4165,
"invoiceLineInvoiceId": 9908,
"invoiceLineInvoicedQuantity": "string",
"invoiceLineItemDescription": "s",
"invoiceLineItemName": "string",
"invoiceLineItemSellersItemIdentification": "string",
"invoiceLinePriceAmount": "string",
"invoiceLinePriceBaseQuantity": "string",
"invoiceLinePriceUnit": "string",
"invoiceLineProductCategory": "string",
"invoiceLineStatus": "st",
"invoiceLineUpdatedAt": "string"
}
],
"invoiceTypeCode": "string",
"irn": "string",
"issueDate": "st",
"issueTime": "string",
"legalMonetaryTotal": {
"lineExtensionAmount": 908.2547030087485,
"payableAmount": 2273.936786951596,
"taxExclusiveAmount": 6402.532206076486,
"taxInclusiveAmount": 8290.990822965116
},
"note": "string",
"orderReference": "string",
"originatorDocumentReference": {
"irn": "string",
"issueDate": "string"
},
"paymentMeans": [
{
"paymentDueDate": "st",
"paymentMeansCode": "string"
},
{
"paymentDueDate": "string",
"paymentMeansCode": "string"
}
],
"paymentStatus": "str",
"paymentTermsNote": "string",
"receiptDocumentReference": {
"irn": "string",
"issueDate": "string"
},
"taxCurrencyCode": "string",
"taxPointDate": "string",
"taxTotal": [
{
"taxAmount": 7943.853271992729,
"taxSubTotal": [
{
"taxAmount": 1303.3060221146632,
"taxCategory": {
"taxCategoryCreatedAt": "string",
"taxCategoryId": 3371,
"taxCategoryPercent": "string",
"taxCategoryStatus": "st",
"taxCategoryTaxSubTotalId": 7444,
"taxCategoryUpdatedAt": "string"
},
"taxableAmount": 2181.56938307138
},
{
"taxAmount": 5673.186532943712,
"taxCategory": {
"taxCategoryCreatedAt": "string",
"taxCategoryId": 436,
"taxCategoryPercent": "string",
"taxCategoryStatus": "string",
"taxCategoryTaxSubTotalId": 2289,
"taxCategoryUpdatedAt": "string"
},
"taxableAmount": 4853.111626140605
}
]
},
{
"taxAmount": 2272.7707969936173,
"taxSubTotal": [
{
"taxAmount": 8183.941412690803,
"taxCategory": {
"taxCategoryCreatedAt": "string",
"taxCategoryId": 5726,
"taxCategoryPercent": "string",
"taxCategoryStatus": "string",
"taxCategoryTaxSubTotalId": 7231,
"taxCategoryUpdatedAt": "string"
},
"taxableAmount": 3826.3445125896524
},
{
"taxAmount": 2557.1596241112916,
"taxCategory": {
"taxCategoryCreatedAt": "string",
"taxCategoryId": 6065,
"taxCategoryPercent": "string",
"taxCategoryStatus": "string",
"taxCategoryTaxSubTotalId": 2034,
"taxCategoryUpdatedAt": "string"
},
"taxableAmount": 3616.1648363787613
}
]
}
]
},
"responseCode": "string",
"responseMessage": "string"
}Modified at 2026-08-21 08:50:42