Get full invoice details by order ID

GET /v1/invoices/order/{orderId}

Get full invoice details by order ID

cURL

curl --request GET \
  --url https://api.example.com/v1/invoices/order/{orderId} \
  --header 'Authorization: Bearer <token>'

200

{
  "invoiceNo": "<string>",
  "orderNo": "<string>",
  "invoiceDate": "<string>",
  "paymentTerms": "<string>",
  "status": "PENDING",
  "dueDate": "<string>",
  "billedTo": {
    "businessName": "<string>",
    "address": "<string>",
    "contactFullName": "<string>",
    "contactPhone": "<string>",
    "contactEmail": "<string>"
  },
  "items": [
    {
      "productName": "<string>",
      "size": "<string>",
      "quantity": 123,
      "price": 123,
      "total": 123
    }
  ],
  "subtotalAmount": 123,
  "discountAmount": 123,
  "deliveryFee": 123,
  "totalAmount": 123,
  "amountPaid": 123,
  "amountDue": 123,
  "payments": [
    {
      "id": "<string>",
      "amount": 123,
      "note": "<string>",
      "recordedByAdminId": "<string>",
      "createdAt": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

orderId · string · required

Response

200 - application/json

invoiceNo · string · required

orderNo · string · required

invoiceDate · string · required

paymentTerms · string · required

status · enum<string> · required

Available options: PENDING, PARTIALLY_PAID, PAID, CANCELLED

dueDate · string · required

billedTo · object · required

Show child attributes

items · object[] · required

Show child attributes

subtotalAmount · number · required

discountAmount · number · required

Taken off the subtotal by the order's discount

deliveryFee · number · required

totalAmount · number · required

amountPaid · number · required

amountDue · number · required

payments · object[] · required

Show child attributes