Single Invoice¶

Invoices Read Only

Retrieve detailed information for a specific invoice by its unique identifier. Use this endpoint to fetch complete invoice data for display, printing, or PDF generation.

Single Record

Response Type

Full Details

Invoice Data

Print Ready

Output Format

Endpoint¶

GET {{base_url}}/invoice/{{invoiceId}}

Path Parameters¶

Parameter	Type	Required	Description
`invoiceId`	string	Yes	Unique identifier of the invoice to retrieve

Sample Request¶

curl --request GET \
  --url '{{ base_url }}/invoice/INV-2024-001234' \
  --header 'Authorization: Bearer {{ token }}'

Response¶

{
  "statusCode": 200,
  "data": {
    "invoiceId": "INV-2024-001234",
    "bookingId": "BK-987654321",
    "multiPieceId": null,
    "customerId": "CUST-123456",
    "customerName": "John Doe",
    "customerEmail": "john.doe@example.com",
    "customerPhone": "+234 801 234 5678",
    "customerAddress": {
      "street": "123 Marina Road",
      "city": "Lagos",
      "state": "Lagos",
      "country": "Nigeria",
      "postalCode": "100001"
    },
    "invoiceNumber": "INV-2024-001234",
    "invoiceDate": "2024-01-15T10:30:00Z",
    "dueDate": "2024-01-30T23:59:59Z",
    "status": "PAID",
    "currency": "NGN",
    "items": [
      {
        "itemId": "ITEM-001",
        "description": "Shipping Service - Lagos to Abuja",
        "serviceType": "EXPRESS",
        "quantity": 1,
        "unitPrice": 12000.0,
        "amount": 12000.0
      },
      {
        "itemId": "ITEM-002",
        "description": "Insurance Coverage - Standard",
        "serviceType": "INSURANCE",
        "quantity": 1,
        "unitPrice": 3000.0,
        "amount": 3000.0
      }
    ],
    "subtotal": 15000.0,
    "taxBreakdown": {
      "vat": {
        "rate": 7.5,
        "amount": 1125.0
      }
    },
    "discount": {
      "code": null,
      "type": null,
      "amount": 0.0
    },
    "totalAmount": 16125.0,
    "payment": {
      "method": "CARD",
      "reference": "PAY-REF-ABC123XYZ",
      "transactionId": "TXN-2024-567890",
      "paidAt": "2024-01-15T11:45:00Z",
      "paidAmount": 16125.0
    },
    "shipmentDetails": {
      "origin": {
        "city": "Lagos",
        "state": "Lagos",
        "country": "Nigeria"
      },
      "destination": {
        "city": "Abuja",
        "state": "FCT",
        "country": "Nigeria"
      },
      "weight": 2.5,
      "weightUnit": "kg",
      "dimensions": {
        "length": 30,
        "width": 20,
        "height": 15,
        "unit": "cm"
      },
      "carrier": "AAJ Express",
      "serviceLevel": "EXPRESS"
    },
    "notes": null,
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T11:45:00Z"
  },
  "message": "Invoice retrieved successfully"
}

Response Fields¶

Invoice Object¶

Field	Type	Description
`invoiceId`	string	Unique identifier for the invoice
`bookingId`	string	Associated booking ID
`multiPieceId`	string	Multi-piece booking ID (if applicable)
`customerId`	string	Customer identifier
`customerName`	string	Full name of the customer
`customerEmail`	string	Customer's email address
`customerPhone`	string	Customer's phone number
`customerAddress`	object	Customer's billing address
`invoiceNumber`	string	Human-readable invoice number
`invoiceDate`	string	Date invoice was generated
`dueDate`	string	Payment due date
`status`	string	Current invoice status
`currency`	string	Currency code
`items`	array	Line items on the invoice
`subtotal`	number	Total before taxes and discounts
`taxBreakdown`	object	Detailed tax information
`discount`	object	Applied discount details
`totalAmount`	number	Final amount due
`payment`	object	Payment information (if paid)
`shipmentDetails`	object	Associated shipment information
`notes`	string	Additional notes
`createdAt`	string	Record creation timestamp
`updatedAt`	string	Last update timestamp

Payment Object¶

Field	Type	Description
`method`	string	Payment method (CARD, BANK_TRANSFER, WALLET)
`reference`	string	Payment reference number
`transactionId`	string	Internal transaction ID
`paidAt`	string	Timestamp of payment
`paidAmount`	number	Amount paid

Error Responses¶

{
  "statusCode": 404,
  "message": "Invoice not found",
  "error": "NOT_FOUND"
}

Related Endpoints

To retrieve all invoices with pagination, see All Invoices.