List Workspace Invoices

get https://{subdomain}.myclickfunnels.com/api/v2/workspaces/{workspace_id}/orders/invoices

List invoices for a specific order. Please refer to the API documentation for more information about the different types of invoices and payment processors.

time	status	user agent
Retrieving recent requests…

Loading…

Path Params

workspace_id

integer

required

Query Params

after

string

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

sort_order

string

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property

string

Sort property of a list response. The default is id and thus the created_at order.
If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

filter

object

Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.

Responses

Response body

array of objects

object

integer

required

Invoice ID

public_id

string | null

Invoice public ID

order_id

integer

required

Order ID

status

string

required

The billing status reflects the status of the invoice's payment.
Billing status can be one of the following for Payments AI orders: draft, paid, unpaid, partially-refunded, refunded, voided, disputed, past-due.

External invoice statuses of external one-time orders can be one of the following: unpaid, paid, voided and refunded, disputed, past-due.
A change in status will update the billing_status of the parent order. If the status of a one-time order is changed to paid, the order's service_status will also be flipped to completed.

due_amount

string | null

Due Amount

total_amount

string | null

Total Amt

subtotal_amount

string | null

Subtotal Amount

tax_amount

string | null

Tax Amount

shipping_amount

string | null

Invoiced shipping amount. Cannot be negative.

discount_amount

string | null

Discount Amount

currency

string | null

Currency

issued_at

date-time | null

The date the invoice was issued.

due_at

date-time | null

The date the invoice is due.

paid_at

date-time | null

The date the invoice was paid.

invoice_type

string | null

Invoice Type

initial renewal interim cancellation one_time refund charge one_time_sale

invoice_number

string

required

The number of the invoice. Usually, this is a sequential number in a certain format to be used for bookkeeping purposes.

fulfillment_status

string | null

The fulfillment status of the invoice.
This can be one of:

not_applicable - the invoice is not eligible for fulfillment
unfulfilled - the entire invoice needs to be fulfilled
partial - some items have been fulfilled, but some are pending or restocked
complete - all items are fulfilled

created_at

date-time | null

Added

updated_at

date-time | null

Updated

external_id

string

required

External ID

payment_processor

string | null

The payment processor of the invoice's order. Currently, it can be one of payments_ai and external.

eligible_for_fulfillment

boolean | null

Invoice has been paid so is eligible for fulfillment (does not indicate if the invoice has any fulfillable items)

line_items

array of objects | null

Invoice Line Items

line_items

object

integer

required

Line item ID

public_id

string | null

ClickFunnels line item public ID

invoice_id

integer

required

Invoice ID

external_id

string

required

External

payment_type

string | null

Payment Type

description

string | null

Description

quantity

integer

required

Quantity

fulfillment_status

string | null

Represents the current fulfillment status of the line item.
This can be one of the following:

unfulfilled - the line item has not been fully fulfilled (fulfilled quantity is 0)
partially_fulfilled - the line item is partially fulfilled (fulfilled quantity is less than line item quantity)
complete - the line item is completely fulfilled (fulfilled quantity is equal to line item quantity)
ignored - the line item is marked as ignored for fulfillment

unfulfilled partially_fulfilled complete ignored

external_product_id

string | null

External Product

discount_amount

number | null

Discount Amount

state_tax_amount

number | null

State Tax Amount

county_tax_amount

number | null

County Tax Amount

city_tax_amount

number | null

City Tax Amount

district_tax_amount

number | null

District Tax Amount

state_tax_rate

number | null

State Tax Rate

county_tax_rate

number | null

County Tax Rate

city_tax_rate

number | null

City Tax Rate

district_tax_rate

number | null

District Tax Rate

country_tax_jurisdiction

string | null

Country Tax Jurisdiction

state_tax_jurisdiction

string | null

State Tax Jurisdiction

county_tax_jurisdiction

string | null

County Tax Jurisdiction

city_tax_jurisdiction

string | null

City Tax Jurisdiction

period_start_at

string | null

Period Start At

period_end_at

string | null

Period End At

period_number

string | null

Period Number

created_at

string | null

Added

updated_at

string | null

Updated

amount

string

required

Amount

products_price

object

required

Product Price

products_variant

object | null

Product Variant

order

object

required

Orders

Headers

object

Pagination-Next

string

ID of the last item in the current response after which more records exist. You can use it in an after query parameter for cursor-based pagination to get to the next page.

Link

string

A direct link to the next page for the cursor-based pagination. It includes the after and the Pagination-Next ID value.

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://myworkspace.myclickfunnels.com/api/v2/workspaces/workspace_id/orders/invoices \
3
     --header 'accept: application/json'


xxxxxxxxxx
306
]
1
[
2
  {
3
    "id": 13,
4
    "public_id": "tMgAJC",
5
    "order_id": 35,
6
    "status": "paid",
7
    "payments_processor": "payments_ai",
8
    "due_amount": "0.00",
9
    "total_amount": "9.99",
10
    "subtotal_amount": "9.99",
11
    "tax_amount": "9.99",
12
    "shipping_amount": "9.99",
13
    "discount_amount": "9.99",
14
    "currency": "USD",
15
    "live_mode": false,
16
    "issued_at": "2024-08-22T09:24:47.000Z",
17
    "due_at": "2024-09-29T09:24:47.000Z",
18
    "paid_at": "2024-09-15T09:24:47.000Z",
19
    "invoice_type": null,
20
    "invoice_number": "99",
21
    "created_at": "2024-08-22T09:24:47.515Z",
22
    "updated_at": "2024-08-22T09:24:47.515Z",
23
    "external_id": null,
24
    "eligible_for_fulfillment": true,
25
    "line_items": [

200OK

401Unauthorized

404Not Found