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

Provides the constants for the type of the invoice entity. See Link: https://docs.jframework.io/lap-trinh/thiet-ke-database/phan-loai-theo-logic/logic-tables/payment-financial-tables/invoice/hang-so

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.

StartDatestringOptional

The start date date for which the invoice is generated. The date is in MM-DD-YYYY format.

EndDatestringOptional

The end date for which the invoice is generated. The date is in MM-DD-YYYY format.

SortDataFieldstringOptional

The sort data field to sort. By default, the value is ID.

SortOrderstring · enumOptional

Specifies the sorting order type for a collection.

Possible values:

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

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

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

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

/api/v1/invoices

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": [
      {
        "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": "[e-mail]",
          "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": "2026-01-26T01:03:23.790642Z",
          "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": "2026-01-28T01:03:23.790643Z",
        "invoiceDate": "2026-01-26T01:03:23.790643Z",
        "dueDate": "2026-02-02T01:03:23.790643Z",
        "overdueDate": "2026-02-25T01:03:23.790643Z",
        "billingPeriodStartDate": "2026-01-26T01:03:23.790643Z",
        "billingPeriodEndDate": "2026-02-26T01:03:23.790643Z",
        "status": "Paid",
        "testMode": false,
        "items": [
          {
            "id": "sApKpllz4sAplsmzha",
            "name": "Premium - 30 days",
            "quantity": 1,
            "amount": 59,
            "currencyCode": "USD"
          }
        ]
      }
    ],
    "totalItems": 1,
    "pageNumber": 0,
    "pageSize": 10
  },
  "errors": []
}