Get an invoice

Get an invoice.

get

Path parameters

idstringRequired

The id of the invoice.

Query parameters

api-versionstringOptional

Header parameters

BrandUrlstringRequired

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

Example: YOUR_BRAND_URL

AuthkeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

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 AuthKey header.

application/json

429

The user has exceeded the rate limit.

application/json

get

HTTPcURLJavaScriptPython

GET /api/invoices/{id} HTTP/1.1
Host: protocol.jframework.dev
BrandUrl: text
Authkey: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "user": {
      "code": "EXAMPLE",
      "avatar": "https://www.gravatar.com/avatar/205e460b479e2e5b48aec07710c08d50",
      "packageId": "1Plamxinzg18snza",
      "packageCode": "PACKAGE",
      "emailAddress": "[e-mail]",
      "nickName": "example",
      "roles": [
        "admin",
        "support"
      ],
      "id": "Plamxinzg18snza"
    },
    "payment": {
      "code": null,
      "name": null,
      "amountGross": 100,
      "amountFee": 10,
      "amountNet": 90,
      "commission": 10,
      "currencyCode": "USD",
      "description": "Description",
      "invoiceNo": "INV-001",
      "paymentType": "PaymentType",
      "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-05-10T13:15:31.8829689Z",
    "invoiceDate": "2025-05-08T13:15:31.88297Z",
    "overdueDate": "2025-06-07T13:15:31.8829701Z",
    "status": "Paid",
    "testMode": false,
    "id": "sApKpllz4sAplsmzha"
  },
  "errors": []
}