1. E-Invoice Creation
Qorpy
  • Getting Started: Qorpy API and NRS E-Invoice
  • Frequently Asked Questions
  • Qorpy API Onboarding
    • Request Business Key
      POST
    • Regenerate Business Key
      POST
    • Business Settings - Update
      POST
    • Business Settings - Read
      GET
  • E-Invoicing Lifecycle
    • E-Invoice Creation
      • Create Invoice
        POST
      • Get Invoice QR Code
        GET
      • Update Invoice Payment Status
        POST
      • Get Sent Invoices
        GET
      • Get Sent Invoice Details
        GET
    • E-Invoice Reversal
      • Invoice Reversal
    • E-Invoice Receipt
      • Fetch Received Invoices
  • Resources
    • Get NRS Invoice Quantity Codes
      GET
    • Get NRS Currencies
      GET
    • Get NRS States
      GET
    • Get NRS LGAs
      GET
    • Get NRS Countries
      GET
    • Get NRS Invoice Types
      GET
    • Get NRS Payment Means
      GET
    • Get NRS Product Codes
      GET
    • Get NRS Service Codes
      GET
    • Get NRS Tax Categories
      GET
  1. E-Invoice Creation

Get Sent Invoices

GET
{{baseUrl}}/{{stage}}/external/{{businessID}}/fetch-sent-invoices
Retrieve a paginated list of all sent invoices for a business with filtering options.
GET {{baseUrl}}/{{stage}}/external/{{businessId}}/fetch-sent-invoices?invoiceType=INVOICES&page=1&size=100

Request#

Headers#

HeaderValueRequired
Content-Typeapplication/json or */*Yes
Acceptapplication/json or */*Yes
X-Business-KeybusinessKeyYes

Path Parameters#

ParameterTypeRequiredDescription
businessIdstring (UUID)YesYour business FIRS ID

Query Parameters#

ParameterTypeRequiredDefaultDescription
invoiceTypestringNoINVOICESFilter by invoice type
pagenumberNo1Page number (starts at 1)
sizenumberNo100Number of invoices per page (1-100)
Invoice Type Options:
INVOICES - All invoices
CREDIT - Credit notes only
DEBIT - Debit notes only

Response#

Success (200)#

{
  "responseCode": "00",
  "responseMessage": "Invoices fetched successfully",
  "data": {
    "invoices": [
      {
        "invoiceIrn": "INV237-1070ECE8-20250826",
        "invoiceNumber": "INV237",
        "invoiceIssueDate": "2025-08-26",
        "invoiceDueDate": "2025-08-26",
        "invoicePaymentStatus": "PAID",
        "invoicePayableAmount": 30255.22,
        "invoiceCustomerPartyName": "Dangote Group",
        "invoiceSupplierPartyName": "AEDC Electricity Supply",
        // Full invoice object with all fields
      }
    ],
    "pagination": {
      "currentPage": 1,
      "pageSize": 100,
      "totalPages": 5,
      "totalInvoices": 487
    }
  }
}

Response Fields#

FieldDescription
invoicesArray of invoice objects (see Get Invoice Details for complete field structure)
pagination.currentPageCurrent page number
pagination.pageSizeNumber of invoices per page
pagination.totalPagesTotal number of pages
pagination.totalInvoicesTotal number of invoices matching criteria
Note: Each invoice object in the array contains the same fields as the single invoice endpoint. See "Get Invoice Details" documentation for complete field descriptions.

Errors#

404 - Business Not Found
{
  "responseCode": "404",
  "responseMessage": "Business not found with ID: {businessId}"
}
→ Verify businessId is correct
400 - Invalid Parameters
{
  "responseCode": "400",
  "responseMessage": "Invalid page or size parameter"
}
→ Ensure page ≥ 1 and size between 1-100
401 - Unauthorized
{
  "responseCode": "401",
  "responseMessage": "Invalid or expired business key"
}
→ Check Authorization header and business key validity

Example Requests#

Get First Page (Default):
Get Specific Page:
Filter by Invoice Type:

Pagination#

Navigation: First page = page=1, increment for next pages, use totalPages for last
Best Practices:
Default size (100) for most cases, smaller (20-50) for better performance
Cache responses to reduce API calls

Common Issues#

Empty results → No sent invoices or filtered out by invoiceType
"Invalid page" → Must be ≥ 1
"Invalid size" → Must be 1-100
Slow response → Reduce page size

Performance Tips#

✅ Use appropriate page size (20-50 for UI, 100 for batch)
✅ Cache frequently accessed pages
✅ Filter with invoiceType to reduce results
Related:
GET /invoices/{invoiceIrn} - Get single invoice details
POST /invoices - Create invoice
POST /invoices/update-payment/{invoiceIrn} - Update payment status
Support: support@nairainvoice.com | Docs: developer.nairainvoice.com

Request

Query Params

Header Params

Responses

🟢200OK
text/plain
🟠401Unauthorized
🟠403Forbidden
🟠404Not Found
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff '{{baseUrl}}/{{stage}}/external/{{businessID}}/fetch-sent-invoices?invoiceType=INVOICES&page=1&size=100' \
--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:31
Previous
Update Invoice Payment Status
Next
Get Sent Invoice Details
Built with