Get invoices

Get invoices.

get

Query parameters

UserIdstringOptional

The id of the user. If the user is not provided, it will be the current user.

PackageIdstringOptional

The package id.

SubscriptionTypeIdstringOptional

Filter by the subscription type id.

Typestring · enumOptional

Filter by the invoice type.

Possible values:

CodestringOptional

Filter by the invoice code.

NamestringOptional

Filter by the invoice name.

DescriptionstringOptional

Filter by the invoice description.

NotesstringOptional

Filter by the invoice notes.

TagsstringOptional

Filter by the invoice tags.

ReminderedCountinteger · int32Optional

Filter by the invoice status.

DeliveryInstructionsstringOptional

Filter by the Delivery Instructions.

ConfirmedDeliveryDatestring · date-timeOptional

Filter by the Confirmed Delivery Date.

InvoiceDatestring · date-timeOptional

Filter by the Invoice Date.

OverdueDatestring · date-timeOptional

Filter by the Due Date.

Statusstring · enumOptional

Filter by the Status.

Possible values:

KeywordsstringOptional

Filter by the Keywords.

TestModebooleanOptional

Filter by the test mode. By default, it is false.

SortDataFieldstringOptional

The sort data field of the pagination.

SortOrderstringOptional

The sort order of the pagination.

PageNumberinteger · int32Optional

The page number of the pagination. Default value is 0.

PageSizeinteger · int32Optional

The page size of the pagination. Default value is 200.

Header parameters

Brand-URLstringRequired

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

Example: YOUR_BRAND_URL

Auth-KeystringRequired

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 Auth-Key header.

application/json

429

The user has exceeded the rate limit.

application/json

get

HTTPcURLJavaScriptPython

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

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "items": [
      {
        "id": "sApKpllz4sAplsmzha",
        "user": {
          "id": "Plamxinzg18snza",
          "code": "EXAMPLE",
          "avatar": "https://www.gravatar.com/avatar/205e460b479e2e5b48aec07710c08d50",
          "packageId": "1Plamxinzg18snza",
          "packageCode": "PACKAGE",
          "emailAddress": "[email protected]",
          "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",
          "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-06-25T06:56:00.5279009Z",
        "invoiceDate": "2025-06-23T06:56:00.5279013Z",
        "overdueDate": "2025-07-23T06:56:00.5279014Z",
        "status": "Paid",
        "testMode": false
      }
    ],
    "totalItems": 1,
    "pageNumber": 0,
    "pageSize": 10
  },
  "errors": []
}