Update A Draft Or Created Invoice

Authorization

bearer

AuthorizationBearer <token>

In: header

Path Parameters

reference*string

Invoice reference number (IRN)

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

invoiceNumber?string

Invoice number

invoiceType?string

Invoice type

Value in"380" | "381" | "384" | "385" | "388" | "389"

billingReferences?array<>

Original invoice references. Required when changing invoiceType to credit note or debit note. Accepts billingReference or billingReferences in request payloads.

billingReference?array<>

Alias for billingReferences. Original invoice references required when changing invoiceType to credit note or debit note.

issueDate?string

Invoice issue date (ISO 8601 format)

taxPointDate?string

Actual date when the tax becomes applicable.

documentCurrency?string

Document currency (ISO 4217 code)

Default"NGN"

taxCurrency?string

Tax currency (ISO 4217 code)

Default"NGN"

paymentStatus?string

Payment status

Value in"pending" | "paid" | "partially_paid" | "overdue"

paymentDate?|

Date the invoice was paid (ISO 8601). Set when paymentStatus transitions to paid; pass null to clear.

supplierData?

Supplier information

customerId?string

Customer ID (if using existing customer)

buyerData?

Buyer information (if not using customerId)

payeeData?

Payee information

taxRepresentativeData?

Tax representative information

items?array<>

Invoice line items

discount?

Discount information

notes?string

Additional notes (min 3, max 50 characters)

paymentTerms?string

Payment terms (min 3, max 50 characters)

paymentDetails?

Payment details payload (optional).

saveAsDraft?boolean

Toggle the invoice between draft and created states. true moves the invoice to draft; false moves it to created. Only applies while the invoice is still in a pre-validation state (draft or created).

Response Body

`application/json`

curl -X POST "https://example.com/api/e-invoicing/invoices/string/update" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "businessId": "123e4567-e89b-12d3-a456-426614174000",
  "businessState": "live",
  "invoiceNumber": "INV-2024-001",
  "systemInvoiceNumber": "DUP00000001",
  "invoiceReferenceNumber": "DUP00000001-2A3A045D-20240123",
  "invoiceType": "381",
  "issueDate": "2024-01-23",
  "taxPointDate": "2024-01-23",
  "documentCurrency": "NGN",
  "taxCurrency": "NGN",
  "paymentStatus": "pending",
  "billingReferences": [
    {
      "irn": "ITW001-E9E0C0D3-20240619",
      "issueDate": "2024-05-14"
    }
  ],
  "customer": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "businessId": "f3f3c6a1-45e3-44aa-b05a-1fbe98d52d09",
    "reference": "CUST_INV_ABC123XYZ456",
    "modules": [
      "invoice"
    ],
    "firstName": "John",
    "lastName": "Doe",
    "email": "customer@example.com",
    "phone": "+2348098765432",
    "tin": "98765432-0001",
    "country": "Nigeria",
    "state": "Lagos",
    "city": "Yaba",
    "address": "456 Market Street, Yaba",
    "postcode": "023401",
    "createdAt": "2024-01-23T10:00:00.000Z",
    "updatedAt": "2024-01-23T10:00:00.000Z"
  },
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "supplierData": {
    "name": "Acme Corporation Ltd.",
    "email": "contact@acmecorp.com",
    "phoneNumber": "+2348012345678",
    "tin": "12345678-0001",
    "country": "Nigeria",
    "state": "Lagos",
    "city": "Ikeja",
    "address": "123 Main Street, Victoria Island"
  },
  "payeeData": {
    "name": "Payee Corporation Ltd.",
    "email": "payee@example.com",
    "phoneNumber": "+2348011111111",
    "tin": "11111111-0001",
    "country": "Nigeria",
    "state": "Lagos",
    "city": "Ikeja",
    "address": "789 Payee Street, Victoria Island"
  },
  "taxRepresentativeData": {
    "name": "Tax Representative Corporation Ltd.",
    "email": "taxrepresentative@example.com",
    "phoneNumber": "+2348011111111",
    "tin": "11111111-0001",
    "country": "Nigeria",
    "state": "Lagos",
    "city": "Ikeja",
    "address": "999 Tax Rep Street, Victoria Island",
    "postcode": "023401"
  },
  "invoiceLineItems": [
    {
      "lineNumber": 1,
      "description": "Web Development Services",
      "quantity": 40,
      "unitPrice": 5000,
      "unit": "Hour",
      "itemAmount": 200000,
      "taxes": [
        {
          "name": "Standard Value-Added Tax",
          "rate": 0.075,
          "amount": 15000
        }
      ],
      "taxAmount": 15000,
      "lineTotalExcludingTax": 200000,
      "lineTotalIncludingTax": 215000
    }
  ],
  "discountData": {
    "type": "percentage",
    "value": 0.1,
    "amount": 21500
  },
  "subtotalAmount": 450000,
  "taxTotal": 33750,
  "allowanceTotal": 0,
  "chargeTotal": 0,
  "totalAmount": 435375,
  "amountDue": 435375,
  "status": "draft",
  "firsStatus": "pending",
  "firsRejectionReason": "invalid auth credentials",
  "qrCodeData": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
  "qrCodeImageUrl": "https://bucket.s3.region.amazonaws.com/business-1/invoice-qr-codes/key.png",
  "direction": "outbound",
  "incomingAction": "pending",
  "incomingActionAt": "2026-06-10T11:32:00Z",
  "incomingRejectionReason": "Incorrect line item amounts; please re-issue.",
  "transmissionStatus": "not_sent",
  "notes": "Payment due within 30 days",
  "paymentTerms": "Payment due within 30 days",
  "paymentDetails": {
    "type": "local",
    "accountName": "Acme Corporation Ltd.",
    "accountNumber": "1234567890",
    "bankName": "Wema Bank"
  },
  "paymentDate": "2026-01-15",
  "createdAt": "2024-01-23T10:00:00Z",
  "updatedAt": "2024-01-23T10:00:00Z",
  "auditLog": [
    {
      "id": "b3f0…",
      "action": "INVOICE_CREATED",
      "attributes": {
        "invoiceReferenceNumber": "DBQ-0001-X-20260609",
        "lineCount": 1
      },
      "failureReason": null,
      "profileId": "d841…",
      "createdAt": "2026-06-09T13:39:03.275Z"
    }
  ]
}

Empty