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

Create Invoice

POST
{{baseURL}}/{{stage}}/external/businesses/{{businessId}}/invoices
Create and process tax-compliant E-Invoices. Validates content, signs with NRS, verifies parties, and transmits (B2B, B2G, G2B) or reports (B2C) to NRSβ€”all in one call.
POST  {{baseURL}}/{{stage}}/external/businesses/{{businessId}}/invoices
This endpoint combines multiple NRS operations:
1.
Validates invoice against UBL standards
2.
Signs invoice with NRS digital signature
3.
Looks up IRN and TIN for party verification
4.
Transmits to recipient (B2B, B2G, G2B) or reports to NRS (B2C)

Request Structure#

Headers#

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

Path Parameters#

ParameterTypeRequiredDescription
businessIdstringβœ…The unique identifier of the business

Request Body#

The request body must be a JSON / XML object containing the following sections:

πŸ“‹ Mandatory Invoice Details#

FieldTypeDescriptionExample
invoiceBusinessIdStringA unique alphanumeric ID generated when the taxpayer is registered on the NRS Dashboard"6dj03c76-1d83-4a39-a4de-51bd70547aef"
invoiceIssueDateStringThe date on which this document was issued. Format: YYYY-MM-DD"2024-05-14"
invoiceTypeCodeStringCode specifying the type of invoice being issuedCheck Resources for valid invoice type codes
invoiceDocumentCurrencyCodeStringCode specifying the default currency in which the invoice is issuedCheck Resources for valid document currency codes
invoiceTaxCurrencyCodeStringThe currency in which tax amounts are calculatedCheck Resources for valid tax currency codes
invoiceSupplierStreetNameStringThe street name where the supplier's business is located"10, Banana Island Road"
invoiceSupplierCityNameStringThe city where the supplier's business is registered"Ikoyi"
invoiceSupplierLgaStringThe local government code of the supplierCheck Resources for valid LGA codes
invoiceSupplierStateStringThe state code of the supplierCheck Resources for valid state codes
invoiceSupplierCountryStringThe country code representing the supplier's registered country (ISO 3166-1 Alpha-2)Check Resources for valid country codes
invoiceSupplierPostalZoneStringThe official postal zone address of the supplier"100243"
invoiceSupplierPartyBusinessDescriptionStringA brief description of the supplier's line of business"Import and Sales of Foreign Rice"
invoiceSupplierPartyTinStringThe Taxpayer Identification Number (TIN) assigned to the supplier for tax compliance"24058123-0001"
invoiceSupplierPartyEmailStringThe supplier's official email address used for tax communication and invoicing correspondence"supplier_business@email.com"
invoiceSupplierPartyTelephoneStringThe supplier's contact number with country code prefix (+234 for Nigeria)"+23480254099000"
invoiceSupplierPartyNameStringThe registered name of the supplier issuing the invoice. Legal business name as recognized by tax authorities"ABC Rice Ltd."
invoiceCustomerStreetNameStringThe street name where the customer's business is located"15, Glover Road"
invoiceCustomerCityNameStringThe city where the customer's business is registered"Ikoyi"
invoiceCustomerLgaStringThe local government code of the customerCheck Resources for valid LGA codes
invoiceCustomerStateStringThe state code of the customerCheck Resources for valid state codes
invoiceCustomerCountryStringThe country code representing the customer's registered country (ISO 3166-1 Alpha-2)Check Resources for valid country codes
invoiceCustomerPostalZoneStringThe official postal zone address of the customer"100243"
invoiceCustomerPartyBusinessDescriptionStringA brief description of the customer's line of business"Cement and building materials"
invoiceCustomerPartyTinStringThe Taxpayer Identification Number (TIN) assigned to the customer for tax compliance"24058123-0001"
invoiceCustomerPartyEmailStringThe customer's official email address used for tax communication and invoicing correspondence"customer_business@email.com"
invoiceCustomerPartyTelephoneStringThe customer's contact number with country code prefix (+234 for Nigeria)"+23480254099000"
invoiceCustomerPartyNameStringThe registered name of the customer. Legal business name as recognized by tax authorities"XYZ Ltd."
invoiceLineArrayArray of invoice line items-
↳ invoiceLineProductCategoryStringThe category the product belongs to"Cereals; husked (brown) rice"
↳ invoiceLineHsnCodeStringThe Harmonized System of Nomenclature (HSN) Code for the productCheck Resources for valid HSN codes e.g., "1006.2"
↳ invoiceLineItemNameStringThe name of the item/service being sold"50kg Bag of Rice"
↳ invoiceLineItemDescriptionStringThe description of the item/service being sold"Premium long-grain brown rice"
↳ invoiceLineItemSellersItemIdentificationStringSeller's SKU or item identifier"Rice-50KG-001"
↳ invoiceLineInvoicedQuantityNumberQuantity of items invoiced10
↳ invoiceLineExtensionAmountNumberTotal line amount (price Γ— quantity + fees - discounts)200000
↳ invoiceLinePriceAmountNumberPrice per unit20000
↳ invoiceLinePriceBaseQuantityNumberBase quantity for pricing1
↳ invoiceLinePriceUnitStringUnit of measurement for pricingEA
↳ invoiceLineDiscountRateNumberDiscount percentage applied to line. Range: 0-1000
↳ invoiceLineDiscountAmountNumberDiscount amount applied to line item (β‰₯ 0)0
↳ invoiceLineFeeRateNumberAdditional fee percentage (β‰₯ 0)0
↳ invoiceLineFeeAmountNumberAdditional fee amount (β‰₯ 0)0
invoiceTaxTotalArrayArray of tax totals for the invoice-
↳ invoiceTaxTotalAmountNumberTotal tax amount for all tax subtotals15000
↳ invoiceTaxTotalSubTotalArrayBreakdown of tax by category-
↳ taxSubTotalTaxableAmountNumberThe total value of goods/services on which tax is calculated2000000
↳ taxSubTotalTaxAmountNumberThe actual tax applied on the taxable amount15000
↳ taxSubTotalCategoryPercentNumberTax rate percentage applied to this subtotal7.5
↳ taxSubTotalCategoryIdStringTax category identifierCheck Resources for valid tax category identifiers e.g., "STANDARD_VAT"
invoiceLineExtensionAmountNumberThe total amount of all invoice items before tax and any discounts/charges200000
invoiceTaxInclusiveAmountNumberThe total invoice after tax is added215000
invoiceTaxExclusiveAmountNumberThe total invoice amount before tax is added200000
invoicePayableAmountNumberThe final amount the buyer must pay after applying discounts, charges, and tax215000

πŸ“ Additional Optional Fields#

FieldTypeDescriptionExample
invoiceDueDateDateThe date on which the invoice is due for payment. Format: YYYY-MM-DD"2025-03-29"
invoiceIssueTimeStringThe time at which this document was issued. Format: HH:MM:SS (24-hour)"17:59:04"
requestTypeStringSpecifies the type of invoice being sent (B2B, B2G, or B2C)"B2B"
invoicePaymentStatusStringShows whether the invoice has been paid or is still pending. Defaults to "PENDING""PENDING" or "PAID"
invoiceActualDeliveryDateDateThe date the goods or services were delivered. Format: YYYY-MM-DD"2024-05-14"
invoicePaymentMeansArrayDefines how the invoice will be paid and when payment is due-
↳ invoicePaymentMeansCodeNumberPayment method code (e.g., 10=Cash, 42=Bank transfer, 43=Credit card)Check Resources for valid payment means codes e.g., 10
↳ invoicePaymentMeansDateDateDate when payment is due. Format: YYYY-MM-DD"2024-05-14"
invoicePaymentTermsNoteStringDescribes the terms and conditions of payment"Payment due within 30 days of invoice issue."
invoiceAllowanceChargeArrayDefines any discounts (allowance) or extra charges (charge)-
↳ invoiceAllowanceChargeIndicatorBooleantrue = charge (additional fee), false = allowance (discount)true
↳ invoiceAllowanceChargeAmountNumberAmount of the charge or allowance800.6
invoiceNoteStringFree-form text pertinent to the invoice. Stored in encrypted format for security"This invoice includes a 5% discount."
invoiceTaxPointDateDateThe actual date when the tax becomes applicable. Format: YYYY-MM-DD"2024-05-14"
invoiceAccountingCostNumberRepresents the accounting category or cost center assigned to the transaction2000
invoiceBuyerReferenceStringA reference number or code provided by the buyer to track the invoice"ITW001-E9E0C0D3-20240619"
invoiceDeliveryPeriodStartDateDateStart date for when goods or services were delivered. Format: YYYY-MM-DD"2024-06-14"
invoiceDeliveryPeriodEndDateDateEnd date for when goods or services were delivered. Format: YYYY-MM-DD"2024-06-16"
invoiceOrderReferenceStringThe order number tied to the invoice"ITW001-E9E0C0D3-20240619"
invoiceBillingReferenceArrayLinks the invoice to previous billing documents (e.g., credit notes, debit notes, or prior invoices)-
↳ invoiceDocumentReferenceIrnStringInvoice Reference Number of the billing document"ITW001-E9E0C0D3-20240619"
↳ invoiceDocumentReferenceIssueDateDateIssue date of the billing document. Format: YYYY-MM-DD"2024-05-14"
invoiceDispatchDocumentIrnStringIdentifier of a referenced dispatch advice. Tracks the dispatch of goods"ITW001-E9E0C0D3-20240619"
invoiceDispatchDocumentIssueDateDateIssue date of the dispatch document. Format: YYYY-MM-DD"2024-05-14"
invoiceReceiptDocumentIrnStringReference to a Receipt Advice associated with the invoice"ITW001-E9E0C0D3-20240619"
invoiceReceiptDocumentIssueDateDateIssue date of the receipt document. Format: YYYY-MM-DD"2024-05-14"
invoiceOriginatorDocumentIrnStringReference to the original document that initiated the invoice"ITW001-E9E0C0D3-20240619"
invoiceOriginatorDocumentIssueDateDateIssue date of the originator document. Format: YYYY-MM-DD"2024-05-14"
invoiceContractDocumentIrnStringReference to a contract governing the transaction"ITW001-E9E0C0D3-20240619"
invoiceContractDocumentIssueDateDateIssue date of the contract document. Format: YYYY-MM-DD"2024-05-14"
invoiceAdditionalDocumentReferenceArrayReference to additional documents associated with the invoice-
↳ invoiceDocumentReferenceIrnStringInvoice Reference Number of the additional document"ITW001-E9E0C0D3-20240619"
↳ invoiceDocumentReferenceIssueDateDateIssue date of the additional document. Format: YYYY-MM-DD"2024-05-14"

πŸ’³ Additional Optional Fields - Payee Party#

If the payment goes to someone else, this field captures that entity's details.
FieldTypeDescriptionExample
invoicePayeeStreetNameStringThe street name where the payee's business is located"15, Glover Road"
invoicePayeeCityNameStringThe city where the payee's business is registered"Ikoyi"
invoicePayeeLgaStringThe local government code of the payeeCheck Resources for valid LGA codes
invoicePayeeStateStringThe state code of the payeeCheck Resources for valid state codes
invoicePayeeCountryStringThe country code representing the payee's registered country (ISO 3166-1 Alpha-2)Check Resources for valid country codes
invoicePayeePostalZoneStringThe official postal zone address of the payee"100243"
invoicePayeePartyBusinessDescriptionStringA brief description of the payee's line of business"Cement and building materials"
invoicePayeePartyTinStringThe Taxpayer Identification Number (TIN) assigned to the payee for tax compliance"24058123-0001"
invoicePayeePartyEmailStringThe payee's official email address used for tax communication and invoicing correspondence"payee_business@email.com"
invoicePayeePartyTelephoneStringThe payee's contact number with country code prefix (+234 for Nigeria)"+23480254099000"
invoicePayeePartyNameStringThe registered name of the payee. Legal business name as recognized by tax authorities"XYZ Ltd."

πŸ“„ Additional Optional Fields - Bill Party#

If the invoice is billed to someone else, this field captures that entity's details.
FieldTypeDescriptionExample
invoiceBillPartyStreetNameStringThe street name where the bill party's business is located"15, Glover Road"
invoiceBillPartyCityNameStringThe city where the bill party's business is registered"Ikoyi"
invoiceBillPartyLgaStringThe local government code of the bill partyCheck Resources for valid LGA codes
invoiceBillPartyStateStringThe state code of the bill partyCheck Resources for valid state codes
invoiceBillPartyCountryStringThe country code representing the bill party's registered country (ISO 3166-1 Alpha-2)Check Resources for valid country codes
invoiceBillPartyPostalZoneStringThe official postal zone address of the bill party"100243"
invoiceBillPartyBusinessDescriptionStringA brief description of the bill party's line of business"Cement and building materials"
invoiceBillPartyTinStringThe Taxpayer Identification Number (TIN) assigned to the bill party for tax compliance"24058123-0001"
invoiceBillPartyEmailStringThe bill party's official email address used for tax communication and invoicing correspondence"billparty_business@email.com"
invoiceBillPartyTelephoneStringThe bill party's contact number with country code prefix (+234 for Nigeria)"+23480254099000"
invoiceBillPartyNameStringThe registered name of the bill party. Legal business name as recognized by tax authorities"XYZ Ltd."

🚚 Additional Optional Fields - Ship Party#

If goods are shipped to someone else, this field captures that entity's details.
FieldTypeDescriptionExample
invoiceShipPartyStreetNameStringThe street name where the ship party's business is located"15, Glover Road"
invoiceShipPartyCityNameStringThe city where the ship party's business is registered"Ikoyi"
invoiceShipPartyLgaStringThe local government code of the ship partyCheck Resources for valid LGA codes
invoiceShipPartyStateStringThe state code of the ship partyCheck Resources for valid state codes
invoiceShipPartyCountryStringThe country code representing the ship party's registered country (ISO 3166-1 Alpha-2)Check Resources for valid country codes
invoiceShipPartyPostalZoneStringThe official postal zone address of the ship party"100243"
invoiceShipPartyBusinessDescriptionStringA brief description of the ship party's line of business"Cement and building materials"
invoiceShipPartyTinStringThe Taxpayer Identification Number (TIN) assigned to the ship party for tax compliance"24058123-0001"
invoiceShipPartyEmailStringThe ship party's official email address used for tax communication and invoicing correspondence"shipparty_business@email.com"
invoiceShipPartyTelephoneStringThe ship party's contact number with country code prefix (+234 for Nigeria)"+23480254099000"
invoiceShipPartyNameStringThe registered name of the ship party. Legal business name as recognized by tax authorities"XYZ Ltd."

πŸ›οΈ Additional Optional Fields - Tax Representative Party#

If a business has a tax agent handling invoicing and compliance, their details are entered here.
FieldTypeDescriptionExample
invoiceTaxRepPartyStreetNameStringThe street name where the tax representative's business is located"15, Glover Road"
invoiceTaxRepPartyCityNameStringThe city where the tax representative's business is registered"Ikoyi"
invoiceTaxRepPartyLgaStringThe local government code of the tax representativeCheck Resources for valid LGA codes
invoiceTaxRepPartyStateStringThe state code of the tax representativeCheck Resources for valid state codes
invoiceTaxRepPartyCountryStringThe country code representing the tax representative's registered country (ISO 3166-1 Alpha-2)Check Resources for valid country codes
invoiceTaxRepPartyPostalZoneStringThe official postal zone address of the tax representative"100243"
invoiceTaxRepPartyBusinessDescriptionStringA brief description of the tax representative's line of business"Tax and accounting services"
invoiceTaxRepPartyTinStringThe Taxpayer Identification Number (TIN) assigned to the tax representative for tax compliance"24058123-0001"
invoiceTaxRepPartyEmailStringThe tax representative's official email address used for tax communication and invoicing correspondence"taxrep_business@email.com"
invoiceTaxRepPartyTelephoneStringThe tax representative's contact number with country code prefix (+234 for Nigeria)"+23480254099000"
invoiceTaxRepPartyNameStringThe registered name of the tax representative. Legal business name as recognized by tax authorities"ABC Tax Consultants Ltd."

πŸ“ Example Request#

{
  // Core Invoice Details
  "invoiceBusinessId": "", // mandatory
  "invoiceIssueDate": "", // mandatory (YYYY-MM-DD)
  "invoiceTypeCode": "", // mandatory
  "invoiceDocumentCurrencyCode": "", // mandatory
  "invoiceTaxCurrencyCode": "", // mandatory
  
  // Supplier Information
  "invoiceSupplierStreetName": "", // mandatory
  "invoiceSupplierCityName": "", // mandatory
  "invoiceSupplierLga": "", // mandatory
  "invoiceSupplierState": "", // mandatory
  "invoiceSupplierCountry": "", // mandatory
  "invoiceSupplierPostalZone": "", // mandatory
  "invoiceSupplierPartyBusinessDescription": "", // mandatory
  "invoiceSupplierPartyTin": "", // mandatory
  "invoiceSupplierPartyEmail": "", // mandatory
  "invoiceSupplierPartyTelephone": "", // mandatory
  "invoiceSupplierPartyName": "", // mandatory
  
  // Customer Information
  "invoiceCustomerStreetName": "", // mandatory for B2B 
  "invoiceCustomerCityName": "", // mandatory for B2B
  "invoiceCustomerLga": "", // mandatory for B2B
  "invoiceCustomerState": "", // mandatory for B2B
  "invoiceCustomerCountry": "", // mandatory for B2B
  "invoiceCustomerPostalZone": "", // mandatory for B2B
  "invoiceCustomerPartyBusinessDescription": "", // mandatory for B2B
  "invoiceCustomerPartyTin": "", // mandatory for B2B
  "invoiceCustomerPartyEmail": "", // mandatory for B2B
  "invoiceCustomerPartyTelephone": "", // mandatory for B2B
  "invoiceCustomerPartyName": "", // mandatory for B2B
  
  // Invoice Line Items
  "invoiceLine": [ // mandatory (at least one item)
    {
      "invoiceLineProductCategory": "", // mandatory
      "invoiceLineHsnCode": "", // mandatory
      "invoiceLineItemName": "", // mandatory
      "invoiceLineItemDescription": "", // mandatory
      "invoiceLineItemSellersItemIdentification": "", // mandatory
      "invoiceLineInvoicedQuantity": 0, // mandatory
      "invoiceLineExtensionAmount": 0, // mandatory
      "invoiceLinePriceAmount": 0, // mandatory
      "invoiceLinePriceBaseQuantity": 0, // mandatory
      "invoiceLinePriceUnit": "", // mandatory
      "invoiceLineDiscountRate": 0, // optional (0-100)
      "invoiceLineDiscountAmount": 0, // optional
      "invoiceLineFeeRate": 0, // optional
      "invoiceLineFeeAmount": 0 // optional
    }
  ],
  
  // Tax Information
  "invoiceTaxTotal": [ // mandatory (at least one item)
    {
      "invoiceTaxTotalAmount": 0, // mandatory
      "invoiceTaxTotalSubTotal": [ // mandatory (at least one item)
        {
          "taxSubTotalTaxableAmount": 0, // mandatory
          "taxSubTotalTaxAmount": 0, // mandatory
          "taxSubTotalCategoryPercent": 0, // mandatory
          "taxSubTotalCategoryId": "" // mandatory
        }
      ]
    }
  ],
  
  // Financial Totals
  "invoiceLineExtensionAmount": 0, // mandatory
  "invoiceTaxInclusiveAmount": 0, // mandatory
  "invoiceTaxExclusiveAmount": 0, // mandatory
  "invoicePayableAmount": 0, // mandatory
  
  // Optional Fields
  "invoiceDueDate": "", // optional (YYYY-MM-DD)
  "invoiceIssueTime": "", // optional (HH:MM:SS)
  "requestType": "", // optional (B2B, B2G, or B2C)
  "invoicePaymentStatus": "", // optional (PENDING or PAID)
  "invoiceActualDeliveryDate": "", // optional (YYYY-MM-DD)
  
  "invoicePaymentMeans": [ // optional
    {
      "invoicePaymentMeansCode": 0, // optional
      "invoicePaymentMeansDate": "" // optional (YYYY-MM-DD)
    }
  ],
  
  "invoicePaymentTermsNote": "", // optional
  
  "invoiceAllowanceCharge": [ // optional
    {
      "invoiceAllowanceChargeIndicator": true, // optional (true=charge, false=allowance)
      "invoiceAllowanceChargeAmount": 0 // optional
    }
  ],
  
  "invoiceNote": "", // optional
  "invoiceTaxPointDate": "", // optional (YYYY-MM-DD)
  "invoiceAccountingCost": 0, // optional
  "invoiceBuyerReference": "", // optional
  "invoiceDeliveryPeriodStartDate": "", // optional (YYYY-MM-DD)
  "invoiceDeliveryPeriodEndDate": "", // optional (YYYY-MM-DD)
  "invoiceOrderReference": "", // optional
  
  // Document References
  "invoiceBillingReference": [ // optional
    {
      "invoiceDocumentReferenceIrn": "", // optional
      "invoiceDocumentReferenceIssueDate": "" // optional (YYYY-MM-DD)
    }
  ],
  
  "invoiceDispatchDocumentIrn": "", // optional
  "invoiceDispatchDocumentIssueDate": "", // optional (YYYY-MM-DD)
  "invoiceReceiptDocumentIrn": "", // optional
  "invoiceReceiptDocumentIssueDate": "", // optional (YYYY-MM-DD)
  "invoiceOriginatorDocumentIrn": "", // optional
  "invoiceOriginatorDocumentIssueDate": "", // optional (YYYY-MM-DD)
  "invoiceContractDocumentIrn": "", // optional
  "invoiceContractDocumentIssueDate": "", // optional (YYYY-MM-DD)
  
  "invoiceAdditionalDocumentReference": [ // optional
    {
      "invoiceDocumentReferenceIrn": "", // optional
      "invoiceDocumentReferenceIssueDate": "" // optional (YYYY-MM-DD)
    }
  ],
  
  // Payee Party (optional - if payment goes to someone else)
  "invoicePayeeStreetName": "", // optional
  "invoicePayeeCityName": "", // optional
  "invoicePayeeLga": "", // optional
  "invoicePayeeState": "", // optional
  "invoicePayeeCountry": "", // optional
  "invoicePayeePostalZone": "", // optional
  "invoicePayeePartyBusinessDescription": "", // optional
  "invoicePayeePartyTin": "", // optional
  "invoicePayeePartyEmail": "", // optional
  "invoicePayeePartyTelephone": "", // optional
  "invoicePayeePartyName": "", // optional
  
  // Bill Party (optional - if invoice is billed to someone else)
  "invoiceBillPartyStreetName": "", // optional
  "invoiceBillPartyCityName": "", // optional
  "invoiceBillPartyLga": "", // optional
  "invoiceBillPartyState": "", // optional
  "invoiceBillPartyCountry": "", // optional
  "invoiceBillPartyPostalZone": "", // optional
  "invoiceBillPartyBusinessDescription": "", // optional
  "invoiceBillPartyTin": "", // optional
  "invoiceBillPartyEmail": "", // optional
  "invoiceBillPartyTelephone": "", // optional
  "invoiceBillPartyName": "", // optional
  
  // Ship Party (optional - if goods are shipped to someone else)
  "invoiceShipPartyStreetName": "", // optional
  "invoiceShipPartyCityName": "", // optional
  "invoiceShipPartyLga": "", // optional
  "invoiceShipPartyState": "", // optional
  "invoiceShipPartyCountry": "", // optional
  "invoiceShipPartyPostalZone": "", // optional
  "invoiceShipPartyBusinessDescription": "", // optional
  "invoiceShipPartyTin": "", // optional
  "invoiceShipPartyEmail": "", // optional
  "invoiceShipPartyTelephone": "", // optional
  "invoiceShipPartyName": "", // optional
  
  // Tax Representative Party (optional - if tax agent handles invoicing)
  "invoiceTaxRepPartyStreetName": "", // optional
  "invoiceTaxRepPartyCityName": "", // optional
  "invoiceTaxRepPartyLga": "", // optional
  "invoiceTaxRepPartyState": "", // optional
  "invoiceTaxRepPartyCountry": "", // optional
  "invoiceTaxRepPartyPostalZone": "", // optional
  "invoiceTaxRepPartyBusinessDescription": "", // optional
  "invoiceTaxRepPartyTin": "", // optional
  "invoiceTaxRepPartyEmail": "", // optional
  "invoiceTaxRepPartyTelephone": "", // optional
  "invoiceTaxRepPartyName": "" // optional
}

πŸ“€ Response Format#

Success Response (200)#

{
  "data": {
    "invoiceId": 132,
    "invoiceCreatedAt": "2025-08-26T12:57:15Z",
    "invoiceStatus": "CREATED",
    "invoiceNumber": "INV236",
    "invoiceNote": "August Electricity Bill - Mr Ridwan",
    "invoiceBusinessId": "b4009129-ece8-45fc-9584-976fcbe35f8d",
    "invoiceEntityId": "107",
    "invoiceIssueDate": "2025-08-26",
    "invoiceDueDate": "2025-08-26",
    "invoiceIssueTime": "12:57:15",
    "invoiceTypeCode": "389",
    "invoicePaymentStatus": "PAID",
    "invoiceDocumentCurrencyCode": "NGN",
    "invoiceTaxCurrencyCode": "NGN",
    "invoicePayableAmount": 30255.22,
    "invoiceTaxExclusiveAmount": 30030.0,
    "invoiceTaxInclusiveAmount": 30255.22,
    "invoiceLineExtensionAmount": 30030.0
  },
  "responseCode": "200",
  "responseMessage": "Invoice created successfully"
}

βœ… Validation Rules#

Required Field Validation#

All fields marked mandatory must be provided
Arrays marked as required cannot be empty
supplier_party_tin: minimum 6 characters
supplier_party_email: valid email format required
supplier_party_business_description: minimum 6 characters

Data Format Validation#

Dates: Must use YYYY-MM-DD format
Numbers: Must meet minimum value requirements (β‰₯ 0 or > 0 as specified)
Strings: Accept text values
Booleans: Accept true/false values
Arrays: Must contain objects with specified structure

Business Logic Validation#

At least one invoice line item must be provided
At least one tax total must be provided
Monetary amounts must be consistent across totals
Tax calculations must align with line item amounts

Request

Body Params text/plainRequired
Examples

Responses

🟠404Not Found
application/json
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff '{{baseURL}}/{{stage}}/external/businesses/{{businessId}}/invoices' \
--header 'Content-Type: text/plain' \
--data-raw '{
    "invoiceStatus": "PENDING",
    "invoiceUpdatedAt": null,
    "invoiceCreatedAt": null,
    "invoiceIrn": "INV-XXXX001-XXXXXXXX-20260101",
    "invoicePaymentMeans": [
        {
            "invoicePaymentMeansDueDate": "2026-01-01",
            "invoicePaymentMeansCode": "10"
        }
    ],
    "invoiceBillingReference": [],
    "invoiceAllowanceCharge": [],
    "invoiceAdditionalDocumentReference": [],
    "invoicePaymentTermsNote": "Payment is expected on or before EOM Month YYYY",
    "invoiceDocumentReferenceIssueDate": "2026-01-01",
    "invoiceOriginatorDocumentIssueDate": null,
    "invoiceDocumentReferenceType": null,
    "invoiceDocumentReferenceIrn": "",
    "invoiceReceiptDocumentIrn": null,
    "invoiceReceiptDocumentIssueDate": null,
    "invoiceDispatchDocumentIssueDate": null,
    "invoiceContractDocumentIssueDate": null,
    "invoiceActualDeliveryDate": null,
    "invoiceDeliveryPeriodEndDate": null,
    "invoiceDeliveryPeriodStartDate": null,
    "invoiceDispatchDocumentIrn": null,
    "invoiceOriginatorDocumentIrn": null,
    "invoiceOrderReference": "XXXXXXXXXX",
    "invoiceBuyerReference": "XXXXXXXXXX",
    "invoiceContractDocumentIrn": null,
    "invoiceAccountingCost": null,
    "invoiceTaxTotal": [
        {
            "invoiceTaxTotalSubTotal": [
                {
                    "taxSubTotalTaxableAmount": 20000000,
                    "taxSubTotalTaxAmount": 15000000,
                    "taxSubTotalCategoryPercent": 7.5,
                    "taxSubTotalCategoryId": "STANDARD_VAT"
                }
            ],
            "invoiceTaxTotalInvoiceId": 0,
            "invoiceTaxTotalAmount": 1500000
        }
    ],
    "invoiceTaxInclusiveAmount": 21500000,
    "invoiceTaxExclusiveAmount": 20000000,
    "invoicePayableAmount": 21500000,
    "invoiceLineExtensionAmount": 20000000,
    "invoiceTaxCurrencyCode": "NGN",
    "invoiceLine": [
        {
            "invoiceLineItemName": "XX units of Sample Product",
            "invoiceLineItemDescription": "Sample Product",
            "invoiceLinePriceAmount": 20000,
            "invoiceLinePriceUnit": "NGN PER 1",
            "invoiceLineInvoicedQuantity": 1000,
            "invoiceLineItemSellersItemIdentification": "Sample Product",
            "invoiceLineDiscountAmount": 0,
            "invoiceLineDiscountRate": 0,
            "invoiceLineExtensionAmount": 20000000,
            "invoiceLineFeeAmount": 0,
            "invoiceLineFeeRate": 0,
            "invoiceLineHsnCode": "XXXX",
            "invoiceServiceCategory": "XXXX",
            "invoiceLineInvoiceId": 0,
            "invoiceLinePriceBaseQuantity": 1,
            "invoiceLineProductCategory": "Product Category"
        }
    ],
    "requestType": "B2B",
    "invoiceCustomerLga": "NG-XX-XXX",
    "invoiceCustomerStreetName": "XX, Anonymous Street",
    "invoiceCustomerCityName": "City A",
    "invoiceCustomerState": "NG-XX",
    "invoiceCustomerPostalZone": "XXXXXX",
    "invoiceCustomerCountry": "NG",
    "invoiceCustomerPartyBusinessDescription": "Manufacturing Company",
    "invoiceCustomerPartyTin": "XXXXXXXX-XXXX",
    "invoiceCustomerPartyEmail": "contact@customer-company.com",
    "invoiceCustomerPartyTelephone": "+234XXXXXXXXXX",
    "invoiceCustomerPartyName": "Customer Company LTD",
    "invoiceSupplierLga": "NG-XX-XXX",
    "invoiceSupplierStreetName": "Anonymous Street",
    "invoiceSupplierCityName": "NG-XX",
    "invoiceSupplierState": "XX",
    "invoiceSupplierCountry": "NG",
    "invoiceSupplierPostalZone": "XXXXXX",
    "invoiceSupplierPartyBusinessDescription": "Technology Services",
    "invoiceSupplierPartyTin": "XXXXXXXX-XXXX",
    "invoiceSupplierPartyEmail": "contact@supplier-company.com",
    "invoiceSupplierPartyTelephone": "+234XXXXXXXXXX",
    "invoiceSupplierPartyName": "Supplier Company Ltd",
    "invoiceNumber": "INV-XXXX001",
    "invoiceTypeCode": "380",
    "invoiceDocumentCurrencyCode": "NGN",
    "invoiceTaxPointDate": "2026-01-01",
    "invoicePaymentStatus": "PENDING",
    "invoiceIssueTime": "00:00:00",
    "invoiceIssueDate": "2026-01-01",
    "invoiceDueDate": "2026-02-01",
    "invoiceNote": "NAME1, NAME2, NAME3, NAME4",
    "invoiceBusinessId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}'
Response Response Example
{
    "responseCode": "00",
    "responseMessage": "Invoice created successfully",
    "data": {
        "requestType": "B2B",
        "invoiceNumber": "INV-XXXX001",
        "invoiceId": null,
        "invoiceBusinessId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "invoiceEntityId": null,
        "invoiceIssueDate": "2026-01-01",
        "invoiceIrn": "INV-XXXX001-XXXXXXXX-20260101",
        "invoiceDueDate": "2026-02-01",
        "invoiceIssueTime": "00:00:00",
        "invoiceTypeCode": "380",
        "invoicePaymentStatus": "PENDING",
        "invoiceNote": "NAME1, NAME2, NAME3, NAME4",
        "invoiceTaxPointDate": "2025-12-01",
        "invoiceDocumentCurrencyCode": "NGN",
        "invoiceTaxCurrencyCode": "NGN",
        "invoiceAccountingCost": null,
        "invoiceBuyerReference": "XXXXXXXXXX",
        "invoiceOrderReference": "XXXXXXXXXX",
        "invoiceActualDeliveryDate": null,
        "invoicePaymentTermsNote": null,
        "invoiceCustomerPartyId": null,
        "invoiceCustomerPartyTin": "XXXXXXXX-XXXX",
        "invoiceCustomerPartyEmail": "contact@customer-company.com",
        "invoiceCustomerPartyTelephone": null,
        "invoiceCustomerPartyBusinessDescription": "Manufacturing Company",
        "invoiceCustomerPartyName": "Customer Company LTD",
        "invoiceCustomerCityName": "City A",
        "invoiceCustomerPostalZone": "XXXXXX",
        "invoiceCustomerCountry": "NG",
        "invoiceCustomerStreetName": "XX, Anonymous Street",
        "invoiceSupplierPartyId": null,
        "invoiceSupplierPartyTin": "XXXXXXXX-XXXX",
        "invoiceSupplierPartyEmail": "contact@supplier-company.com",
        "invoiceSupplierPartyTelephone": "+234XXXXXXXXXX",
        "invoiceSupplierPartyBusinessDescription": "Technology Services",
        "invoiceSupplierPartyName": "Supplier Company Ltd",
        "invoiceSupplierLga": "NG-XX-XXX",
        "invoiceSupplierState": "XX",
        "invoiceCustomerLga": "NG-XX-XXX",
        "invoiceCustomerState": "NG-XX",
        "invoiceSupplierCityName": "NG-XX",
        "invoiceSupplierPostalZone": "XXXXXX",
        "invoiceSupplierCountry": "NG",
        "invoiceSupplierStreetName": "Anonymous Street",
        "invoiceLineExtensionAmount": 2.0E7,
        "invoiceTaxExclusiveAmount": 2.0E7,
        "invoiceTaxInclusiveAmount": 2.15E7,
        "invoicePayableAmount": 2.15E7,
        "invoiceContractDocumentIrn": null,
        "invoiceContractDocumentIssueDate": null,
        "invoiceOriginatorDocumentIrn": null,
        "invoiceOriginatorDocumentIssueDate": null,
        "invoiceReceiptDocumentIrn": null,
        "invoiceReceiptDocumentIssueDate": null,
        "invoiceDispatchDocumentIrn": null,
        "invoiceDispatchDocumentIssueDate": null,
        "invoiceDeliveryPeriodStartDate": null,
        "invoiceDeliveryPeriodEndDate": null,
        "invoiceStatus": null,
        "invoiceCreatedAt": null,
        "invoiceUpdatedAt": null,
        "invoiceAdditionalDocumentReference": null,
        "invoiceAllowanceCharge": null,
        "invoiceBillingReference": null,
        "invoiceLine": [
            {
                "invoiceLineInvoiceId": 0,
                "invoiceLineProductCategory": "Product Category",
                "invoiceLineDiscountRate": 0.0,
                "invoiceLineDiscountAmount": 0.0,
                "invoiceLineFeeRate": 0.0,
                "invoiceLineFeeAmount": 0.0,
                "invoiceLineInvoicedQuantity": 1000.0,
                "invoiceLineExtensionAmount": 2.0E7,
                "invoiceLineHsnCode": "XXXX",
                "invoiceLineItemDescription": "Sample Product",
                "invoiceLineItemSellersItemIdentification": "Sample Product",
                "invoiceLineItemName": "XX units of Sample Product",
                "invoiceLinePriceBaseQuantity": 1,
                "invoiceLinePriceUnit": "NGN PER 1",
                "invoiceLinePriceAmount": 20000.0
            }
        ],
        "invoicePaymentMeans": null,
        "invoiceTaxTotal": [
            {
                "invoiceTaxTotalInvoiceId": 0,
                "invoiceTaxTotalAmount": 1500000.0,
                "invoiceTaxTotalSubTotal": [
                    {
                        "taxSubTotalTaxableAmount": 2.0E7,
                        "taxSubTotalTaxAmount": 1.5E7,
                        "taxSubTotalCategoryId": "STANDARD_VAT",
                        "taxSubTotalCategoryPercent": 7.5
                    }
                ]
            }
        ],
        "qrCodeBase64": null,
        "invoiceWebhookUrl": null,
        "invoiceWebhookAuth": null,
        "invoiceWebhookAuthValue": null
    },
    "invoiceIrn": "INV-XXXX001-XXXXXXXX-20260101",
    "status": "Success"
}
Modified atΒ 2026-08-21 10:20:39
Previous
Business Settings - Read
Next
Get Invoice QR Code
Built with