Get an invoice

Get an invoice.

get

Path parameters

idstringRequired

The id of the invoice.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/invoices/{id} HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "currencyCode": "USD",
    "id": "sApKpllz4sAplsmzha",
    "amountDue": 0,
    "amountPaid": 99,
    "totalAmount": 99,
    "taxAmount": 9,
    "taxRate": 0.1,
    "discountAmount": 10,
    "subtotalAmount": 100,
    "discountRate": 0.1,
    "user": {
      "id": "Plamxinzg18snza",
      "code": "EXAMPLE",
      "avatar": "https://www.gravatar.com/avatar/205e460b479e2e5b48aec07710c08d50",
      "packageId": "1Plamxinzg18snza",
      "packageCode": "PACKAGE",
      "emailAddress": "[email protected]",
      "phoneNumber": "[phone]",
      "nickName": "example",
      "roles": [
        "admin",
        "support"
      ]
    },
    "payment": {
      "code": null,
      "name": null,
      "amountGross": 100,
      "amountFee": 10,
      "amountNet": 90,
      "commission": 10,
      "currencyCode": "USD",
      "description": "Description",
      "invoiceNo": "INV-001",
      "paymentType": "PaymentType",
      "paymentDate": "2025-09-19T04:20:20.3872323Z",
      "notes": "Notes",
      "status": "Completed",
      "id": "sApKpllz4sAplsmzha"
    },
    "packageCode": "PACKAGE_ID",
    "userAddressId": "USER_ADDRESS_ID",
    "subscriptionTypeId": "SUBSCRIPTION_TYPE_ID",
    "type": "Provisional",
    "code": "INV-20240304",
    "name": "Monthly Subscription",
    "description": "Invoice for the monthly subscription package.",
    "notes": "Payment due within 7 days.",
    "tags": "subscription, monthly",
    "reminderedCount": 1,
    "deliveryInstructions": "Send via email",
    "confirmedDeliveryDate": "2025-09-21T04:20:20.3872335Z",
    "invoiceDate": "2025-09-19T04:20:20.3872337Z",
    "dueDate": "2025-09-26T04:20:20.3872337Z",
    "overdueDate": "2025-10-19T04:20:20.3872338Z",
    "billingPeriodStartDate": "2025-09-19T04:20:20.3872339Z",
    "billingPeriodEndDate": "2025-10-19T04:20:20.387234Z",
    "status": "Paid",
    "testMode": false,
    "items": [
      {
        "id": "sApKpllz4sAplsmzha",
        "name": "Premium - 30 days",
        "quantity": 1,
        "amount": 59,
        "currencyCode": "USD"
      }
    ]
  },
  "errors": []
}