Tamio
Type to search all API docs, webhooks, and appendix pages
↑↓ Navigate ↵ Open Esc Close
Accounting API Invoices & Orders

List all invoices

GET https://api.tamio.com/v2/invoices/list

Returns a paginated list of invoices with comprehensive filtering options including date ranges, customer, product, subscription, payment status, currency, price ranges, and more.

Query Parameters

page integer*
per_page integer*
order string
ascdesc
sort_by string
pricedateboughtinvoice_idname
filter string

Text search against invoice numbers, customer names, or product names

from string

Start date for date range filter (ISO format or Unix timestamp)

to string

End date for date range filter (ISO format or Unix timestamp)

customer_id string

Filter by customer UUID

client_id string

Filter by client UUID (for agency/multi-client setups)

subscription_id string

Filter by subscription UUID (for recurring invoices)

product_id string

Filter by product UUID

warehouse_id string

Filter by warehouse/fulfillment location UUID

discount_id string

Filter by discount code UUID

shipping_id string

Filter by shipping method UUID

domain_id string

Filter by domain/site UUID

payout_id string

Filter by payout batch UUID

asset_id string

Filter by digital asset UUID

site_id string

Filter by website/storefront UUID

affiliate_partner_id string

Filter by affiliate partner UUID

affiliate_program_id string

Filter by affiliate program UUID

public_affiliate_program_id string

Filter by public affiliate program UUID

instalment_plan_id string

Filter by instalment payment plan UUID

processing_orders boolean

Include only orders currently being processed

past_orders boolean

Include only completed/historical orders

affiliate_sales boolean

Include only invoices generated through affiliate sales

currency string

Filter by currency code

minimum_price number

Minimum total amount filter

maximum_price number

Maximum total amount filter

shipping string

Filter by shipping status

enableddisabled
status string

Filter by payment status

paidunpaid
gateway string

Filter by payment gateway/method used

attributes array of string

Additional data to include in each invoice object

Responses

200 Invoices retrieved successfully

Invoices retrieved successfully

status integer
total_results integer

Total number of invoices matching the query

invoices array of Invoice
id string

Unique invoice identifier

object string
currency string

Three-letter ISO currency code

paid boolean

Whether the invoice has been paid

processing_payment boolean

Whether a payment is currently being processed

prefix string

Invoice number prefix

number integer

Invoice number

total integer

Total amount in smallest currency unit

payment string

Payment method used

date integer

Invoice date as Unix timestamp

status string

Invoice payment status

subscription string

Associated subscription UUID (for recurring invoices)

locale string

Language code

payment_retried boolean

Whether payment has been retried

payment_charge_date integer

Scheduled payment charge date as Unix timestamp

3d_secure_failure boolean

Whether 3D Secure authentication failed

authorization_expiry integer

Payment authorization expiry as Unix timestamp

affiliate_program string

Associated affiliate program UUID

affiliate string

Associated affiliate partner UUID

late_failure boolean

Whether a late payment failure occurred

has_subscriptions boolean

Whether this invoice has subscription items

is_instalment boolean

Whether this is an instalment payment invoice

fortnox_submitted boolean

Whether submitted to Fortnox accounting

start_date integer

Subscription period start as Unix timestamp

end_date integer

Subscription period end as Unix timestamp

has_notes boolean

Whether the invoice has notes attached

customer_information object

Customer details with billing and shipping information

id string

Customer UUID

name string

Customer full name

country string

Customer billing country code

email string

Customer email address

stripe_customer_id string

Stripe customer ID for payment processing

client_id string

Client UUID for agency/multi-client setups

billing_information object

Billing address and contact details

name string

Billing contact name

country string

Billing country code

email string

Billing email address

phone string

Billing phone number

address string

Billing street address

postcode string

Billing postal code

city string

Billing city

ip string

IP address used during checkout

state string

Billing state or province

vat string

VAT identification number

company string

Billing company name

shipping_information object

Shipping address and contact details (null if no shipping required)

address string

Shipping street address

postcode string

Shipping postal code

country string

Shipping country code

city string

Shipping city

state string

Shipping state or province

name string

Shipping recipient name

email string

Shipping contact email

phone string

Shipping contact phone

company string

Shipping company name

products array of object

Invoice line items. Each entry represents a purchased product or variation with its pricing, tax, shipping, and fulfillment details.

id string

Product UUID

name string

Product name in the transaction locale

quantity integer

Number of units purchased

type string

Product type classification

physical_productdigital_productbilling_plandigital_servicephysical_service
classification string

Tax classification category

currency string

Order currency (ISO 4217)

discount_allowed boolean

Whether discount codes were applicable

is_moss_product boolean

Whether the product falls under EU MOSS rules

is_oss_product boolean

Whether the product falls under EU OSS rules

billing_cycle string

Billing cycle for subscription products

dayweekmonthyear
interval integer

Billing interval for subscription products

is_metered boolean

Whether this is a metered billing product

stripe_price_id string

Stripe price ID (if Stripe billing)

stripe_product_id string

Stripe product ID (if Stripe billing)

stripe_metered_id string

Stripe metered usage price ID

invoice_item_id string

Unique line item identifier (used for partial payments/refunds)

variation_id string

Variation UUID if this line item is a product variant

variation_label string

Human-readable variation label (e.g. 'Large / Blue')

is_variant boolean

Whether this line item is a product variant

delivered boolean

Whether this line item has been fulfilled/delivered

cancelled boolean

Whether this line item has been cancelled

sku string

Stock Keeping Unit

has_shipping boolean

Whether this line item requires physical shipping

weight number

Product weight in kg

height number

Product height in cm

width number

Product width in cm

length number

Product length in cm

detailed_description string

Detailed product description for customs/shipping

nshift_parcel_amount integer

Number of parcels for nShift shipping

nshift_quick_id string

nShift quick shipping profile ID

parcels array of object

Parcel configurations for shipping integrations

trial_period integer

Trial period in days (for subscription products)

charge_shipping_during_trial boolean

Whether shipping is charged during trial (physical subscriptions)

taxes object

Tax configuration for this line item

inclusive boolean

Whether taxes are inclusive in the displayed price

eu_tax boolean

Whether EU tax rules apply

tax_rates array of object

Applied tax rates

id string

Tax rate UUID

label string

Tax rate display label

rate_percent number

Tax rate percentage

rate_amount integer

Calculated tax amount (smallest unit)

tax integer

Total tax for this rate

inclusive boolean

Whether this rate is price-inclusive

moss boolean

Whether this is a MOSS tax

oss boolean

Whether this is an OSS tax

jurisdiction string

Tax jurisdiction (country code)

applies_to array of string

Product UUIDs this tax applies to

shipping_tax_rates array of object

Tax rates applied to shipping

totals object

Financial totals for this line item (all amounts in smallest currency unit)

unit_price integer

Price per unit

item_total integer

Total before tax (unit_price × quantity minus discounts)

total integer

Total amount payable including tax and shipping

discount integer

Discount amount applied

tax integer

Tax amount

subtotal integer

Subtotal before discounts

item_total_with_tax integer

Item total including tax

shipping integer

Base shipping cost

shipping_subtotal integer

Shipping subtotal before discounts

shipping_discount integer

Shipping discount applied

shipping_tax integer

Tax applied to shipping

shipping_total integer

Final shipping total (shipping + tax - discount)

exchange_rate number

Exchange rate applied for currency conversion

price_conversion boolean

Whether a price conversion was applied

moss_taxable_amount integer

MOSS taxable amount

moss_tax_total integer

MOSS tax total

oss_taxable_amount integer

OSS taxable amount

oss_tax_total integer

OSS tax total

full_price integer

Original full price before any discounts

amount_paid integer

Amount paid so far for this line item

amount_refunded integer

Amount refunded for this line item

amount_cancelled integer

Amount cancelled for this line item

recurring_shipping_discount integer

Recurring shipping discount for subscriptions

recurring_shipping_cost integer

Recurring shipping cost for subscriptions

discounts array of object

Discount codes applied to this line item

id string

Discount UUID

code string

Discount code string

discount integer

Discount amount applied (smallest unit)

applies_to array of string

Product UUIDs this discount applies to

reservations array of object

Stock reservations for this line item

shipping object

Shipping status and details

has_shipping boolean

Whether the invoice includes physical shipping

method string

Shipping method label

tracking string

Shipping tracking number from carrier

shipped boolean

Whether the order has been shipped

nshift_shipment_prepared boolean

Whether the nShift shipment has been prepared

nshift_shipment_stored boolean

Whether the nShift shipment has been stored

is_nshift_shipment boolean

Whether this shipment uses nShift integration

totals object

Financial totals breakdown

total integer

Total amount in smallest currency unit

gateway_fees integer

Payment gateway processing fees

affiliate_revenue integer

Revenue attributed to affiliate partner

refunded_total integer

Total amount refunded

amount_paid integer

Amount already paid on this invoice

amount_cancelled integer

Amount cancelled from this invoice

subtotal integer

Subtotal before tax and shipping

discount integer

Total discount amount applied

item_count integer

Total number of items across all line items

tax integer

Total tax amount

shipping integer

Base shipping cost before tax

shipping_total integer

Total shipping cost including tax

shipping_discount integer

Discount applied to shipping cost

shipping_tax integer

Tax applied to shipping cost

moss_tax_total integer

MOSS (Mini One-Stop Shop) tax total for EU digital services

moss_taxable_amount integer

Amount subject to MOSS taxation

item_total integer

Total of all line items before tax

item_total_with_tax integer

Total of all line items including tax

oss_taxable_amount integer

Amount subject to OSS (One-Stop Shop) EU taxation

oss_tax_total integer

OSS (One-Stop Shop) tax total

interest integer

Interest charges applied to the invoice

amount_due integer

Remaining amount due (total - amount_paid - amount_cancelled)

taxes object

Aggregated tax breakdown for the entire invoice. Returned when taxes is included in the attributes query parameter.

tax_rates array of object

Aggregated tax rates applied across all line items

id string

Tax rate UUID

rate_percent number

Tax rate percentage

rate_amount integer

Fixed tax amount (smallest unit)

label string

Tax rate display label

tax integer

Total tax amount for this rate

moss boolean

Whether this is a MOSS tax

jurisdiction string

Tax jurisdiction (country code)

inclusive boolean

Whether this rate is price-inclusive

vat_tax boolean

Whether this is a VAT tax

applies_to array of string

Product names this tax applies to

shipping_tax_rates array of object

Tax rates applied to shipping

has_vat boolean

Whether any VAT tax was applied

discounts array of object

Order-level discount codes applied. Returned when discounts is included in the attributes query parameter.

id string

Discount UUID

code string

Discount code

discount integer

Discount amount (smallest unit)

licenses array of object

Digital product license keys issued. Returned when licenses is included in the attributes query parameter.

key string

License key string

product_id string

Product UUID this license belongs to

refunds array of object

Refund records associated with this invoice

amount integer

Refund amount in smallest currency unit

date string

Refund date in ISO 8601 format

reason string

Refund reason

requested_by_customerduplicatefraudulentother
consents object

Customer consent records captured during checkout

appendix string

Additional notes or appendix text attached to the invoice

transaction_id string

Associated transaction UUID (checkout session that created this invoice)

400 Validation or business-logic error.
401 Missing or invalid API key
Next
Retrieve an invoice
/invoices/list 
1const response = await fetch("https://api.tamio.com/v2/invoices/list", {
2  headers: {
3    "Authorization": "Bearer YOUR_API_KEY",
4    "Accept": "application/json"
5  }
6});
7const data = await response.json();
Responses 
{
  "status": 200,
  "total_results": 42,
  "invoices": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "object": "invoice",
      "currency": "EUR",
      "paid": true,
      "processing_payment": false,
      "prefix": "INV-",
      "number": 1001,
      "total": 5000,
      "payment": "stripe_creditcard",
      "date": 1700000000,
      "status": "paid",
      "subscription": "660e8400-e29b-41d4-a716-446655440001",
      "locale": "en",
      "payment_retried": false,
      "payment_charge_date": 1700100000,
      "3d_secure_failure": false,
      "authorization_expiry": 1700604800,
      "affiliate_program": "770e8400-e29b-41d4-a716-446655440002",
      "affiliate": "880e8400-e29b-41d4-a716-446655440003",
      "late_failure": false,
      "has_subscriptions": false,
      "is_instalment": false,
      "fortnox_submitted": false,
      "start_date": 1700000000,
      "end_date": 1702592000,
      "has_notes": false,
      "customer_information": {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "name": "John Doe",
        "country": "NL",
        "email": "[email protected]",
        "stripe_customer_id": "cus_OxR5p8k3nM2qYz",
        "client_id": null,
        "billing_information": {
          "name": "John Doe",
          "country": "NL",
          "email": "[email protected]",
          "phone": "+31612345678",
          "address": "Keizersgracht 123",
          "postcode": "1015 CJ",
          "city": "Amsterdam",
          "ip": "203.0.113.42",
          "state": "Noord-Holland",
          "vat": "NL123456789B01",
          "company": "Acme B.V."
        },
        "shipping_information": {
          "address": "Prinsengracht 456",
          "postcode": "1016 HN",
          "country": "NL",
          "city": "Amsterdam",
          "state": "Noord-Holland",
          "name": "John Doe",
          "email": "[email protected]",
          "phone": "+31612345678",
          "company": "Acme B.V."
        }
      },
      "products": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "Premium Widget",
          "quantity": 2,
          "type": "physical_product",
          "classification": "Tangible Goods",
          "currency": "EUR",
          "discount_allowed": true,
          "is_moss_product": false,
          "is_oss_product": false,
          "billing_cycle": null,
          "interval": null,
          "is_metered": false,
          "stripe_price_id": "price_1O2p3Q4r5S6t7U8v",
          "stripe_product_id": "prod_A1b2C3d4E5f6G7",
          "stripe_metered_id": null,
          "invoice_item_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "variation_id": "660e8400-e29b-41d4-a716-446655440001",
          "variation_label": "Large / Blue",
          "is_variant": false,
          "delivered": false,
          "cancelled": false,
          "sku": "WDG-PRM-001",
          "has_shipping": true,
          "weight": 2.5,
          "height": 10,
          "width": 20,
          "length": 30,
          "detailed_description": "string",
          "nshift_parcel_amount": 1,
          "nshift_quick_id": "string",
          "parcels": [],
          "trial_period": 14,
          "charge_shipping_during_trial": false,
          "taxes": {
            "inclusive": true,
            "eu_tax": true,
            "tax_rates": [],
            "shipping_tax_rates": []
          },
          "totals": {
            "unit_price": 2999,
            "item_total": 5998,
            "total": 7258,
            "discount": 0,
            "tax": 1260,
            "subtotal": 5998,
            "item_total_with_tax": 7258,
            "shipping": 500,
            "shipping_subtotal": 500,
            "shipping_discount": 0,
            "shipping_tax": 105,
            "shipping_total": 605,
            "exchange_rate": null,
            "price_conversion": false,
            "moss_taxable_amount": 0,
            "moss_tax_total": 0,
            "oss_taxable_amount": 0,
            "oss_tax_total": 0,
            "full_price": 0,
            "amount_paid": 7258,
            "amount_refunded": 0,
            "amount_cancelled": 0,
            "recurring_shipping_discount": 0,
            "recurring_shipping_cost": 500
          },
          "discounts": [
            {
              "id": "880e8400-e29b-41d4-a716-446655440003",
              "code": "SUMMER20",
              "discount": 600,
              "applies_to": []
            }
          ],
          "reservations": []
        }
      ],
      "shipping": {
        "has_shipping": true,
        "method": "Standard Delivery",
        "tracking": "3SXYZ1234567890",
        "shipped": false,
        "nshift_shipment_prepared": false,
        "nshift_shipment_stored": false,
        "is_nshift_shipment": false
      },
      "totals": {
        "total": 5000,
        "gateway_fees": 145,
        "affiliate_revenue": 0,
        "refunded_total": 0,
        "amount_paid": 5000,
        "amount_cancelled": 0,
        "subtotal": 4132,
        "discount": 0,
        "item_count": 2,
        "tax": 868,
        "shipping": 0,
        "shipping_total": 0,
        "shipping_discount": 0,
        "shipping_tax": 0,
        "moss_tax_total": 0,
        "moss_taxable_amount": 0,
        "item_total": 4132,
        "item_total_with_tax": 5000,
        "oss_taxable_amount": 0,
        "oss_tax_total": 0,
        "interest": 0,
        "amount_due": 0
      },
      "taxes": {
        "tax_rates": [
          {
            "id": "770e8400-e29b-41d4-a716-446655440002",
            "rate_percent": 21,
            "rate_amount": null,
            "label": "VAT 21%",
            "tax": 868,
            "moss": false,
            "jurisdiction": "de",
            "inclusive": true,
            "vat_tax": true,
            "applies_to": [
              "Premium Widget"
            ]
          }
        ],
        "shipping_tax_rates": [],
        "has_vat": true
      },
      "discounts": [
        {
          "id": "880e8400-e29b-41d4-a716-446655440003",
          "code": "SUMMER20",
          "discount": 600
        }
      ],
      "licenses": [
        {
          "key": "XXXX-YYYY-ZZZZ-1111",
          "product_id": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "refunds": [
        {
          "amount": 5000,
          "date": "2024-01-15T14:30:00+00:00",
          "reason": "requested_by_customer"
        }
      ],
      "consents": {},
      "appendix": null,
      "transaction_id": "adf5c33d-3799-4d84-bf62-3b724c073ccf"
    }
  ]
}