[FEAT]: Order Invoice API Endpoint - Backend

Description

Implement a feature to send an invoice email after successful order payment/purchase or when user access a completed order (history)

Acceptance Criteria

User must have successfully paid for an order to receive an invoice

Expected Outcome

Users should be able to access payment information of an order and order-related information

Purpose

To ensure order and payment preview to users via invoice

Requirements

Specific order page/view
Successful order completion via payment

Invoice Email

Invoice Email Endpoint [GET] /api/v1/order/{orderID}/invoice

Request

Successful Response

status code - 200 Ok

[
   "invoiceDetails": {
        "invoiceNumber": "string",
        "dateOfIssue": "date",
        "dueDate": "date"
    },
    "orderSummary": {
        "items": [
            {
                "item": "string",
                "price": "float"
            },
            {
                "item": "string",
                "price": "float"
            }
        ],
        "vat": {
            "percentage": "int",
            "amount": "float"
        },
        "total": {
            "percentage": 100,
            "amount": "float"
        }

    },
    "paymentDetails": {
        "amount": "float",
        "paymentMethod": "string",
        "bankName": "string",
        "accountNumber": "string",
        "accountName": "string"
    }
]

Error Response

status code - 404 Not Found

{
    "message": "string",
    "error": "string",
    "statusCode": "int"
}

Datebase Schema

Database Schema

hngprojects / hng_boilerplate_nestjs

[FEAT]: Order Invoice API Endpoint - Backend #92