List invoices (v1)

GET/v1/api/store/{team_slug}/invoice

v1Legacy · deprecatedOperation ID v1_public_invoice_index

Legacy (deprecated)

A newer operation does this better.Use Filter invoices (POST /v2/api/store/{team_slug}/v2/invoice/filter) instead.

Its answers say so in the Deprecation and X-YoPrint-Successor headers; see Deprecated operations.

Returns one page of your team's invoices of saved, non-draft sales orders and quotes (invoices of deleted, draft or autosaved orders, and deleted invoices, are left out). No filters or sort: only page; the order isn't guaranteed.

Each row is a summary: number, order, customer, dates, deposit, totals (calc_total and the other calc_* fields are in thousandths, an older encoding: 12.50 is 12500; see Money and quantities), paid_amount, is_paid and PDF links (they carry their own access token).

Permission

Any member of the team.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team

Query parameters

• pageinteger

  The page to read. The page size is the team's list page size setting (50 unless the team changed it).

  • Default 1
  • Minimum 1
  • Example 1

Request body

This operation takes no request body.

Response

200Successful response.

• dataarray of objectsrequired
  Fields of each item (28)

  • billing_addressobject | null

    An address.

    Child fields (10)

    • address1string | null
    • address2string | null
    • citystring | null
    • countrystring | null
    • country_codestring | null
    • idstring

      The address.

    • labelstring | null
    • postcodestring | null
    • statestring | null
    • state_codestring | null
  • calc_delivery_totalinteger | number | string | null

    Shipping. Thousandths, an older encoding: 12500 is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (1234.5 is 1.2345), or as a string ("1234.5") when you send X-Yoprint-Decimal-Format: exact-v1. See Money and quantities.

  • calc_deposit_totalinteger | number | string | null

    Deposit amount. Thousandths, an older encoding: 12500 is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (1234.5 is 1.2345), or as a string ("1234.5") when you send X-Yoprint-Decimal-Format: exact-v1. See Money and quantities.

  • calc_discountinteger | number | string | null

    Discount. Thousandths, an older encoding: 12500 is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (1234.5 is 1.2345), or as a string ("1234.5") when you send X-Yoprint-Decimal-Format: exact-v1. See Money and quantities.

  • calc_subtotalinteger | number | string | null

    Subtotal. Thousandths, an older encoding: 12500 is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (1234.5 is 1.2345), or as a string ("1234.5") when you send X-Yoprint-Decimal-Format: exact-v1. See Money and quantities.

  • calc_taxinteger | number | string | null

    Tax. Thousandths, an older encoding: 12500 is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (1234.5 is 1.2345), or as a string ("1234.5") when you send X-Yoprint-Decimal-Format: exact-v1. See Money and quantities.

  • calc_totalinteger | number | string | null

    Total. Thousandths, an older encoding: 12500 is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (1234.5 is 1.2345), or as a string ("1234.5") when you send X-Yoprint-Decimal-Format: exact-v1. See Money and quantities.

  • created_atstring (date-time)
  • customerobject | null

    The customer (the full customer record).

    Child fields (2)

    • idstring

      The customer.

    • namestring
  • customer_idstring | null

    The customer.

  • customer_namestring | null
  • deposit_duestring (date-time) | null

    Deposit due. ISO 8601 with offset, or null.

  • deposit_requiredboolean | integer | null
  • full_amount_duestring (date-time) | null

    Full amount due. ISO 8601 with offset, or null.

  • idstring

    The invoice.

  • is_paidboolean
  • order_cust_due_datestring (date-time) | null

    Order customer due date. ISO 8601 with offset, or null.

  • order_idstring

    The order.

  • order_issue_datestring (date-time) | null

    Order issue date. ISO 8601 with offset, or null.

  • order_namestring | null
  • order_object_typestring | null
  • order_quoteboolean
  • order_scoped_idstring | null

    The order number.

  • order_ship_due_datestring (date-time) | null

    Order ship-by date. ISO 8601 with offset, or null.

  • paid_amountinteger | number | string | null

    Allocated payments. Thousandths, an older encoding: 12500 is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (1234.5 is 1.2345), or as a string ("1234.5") when you send X-Yoprint-Decimal-Format: exact-v1. See Money and quantities.

  • pdf_urlarray of objects

    PDF links (with their own access token): the standard invoice PDF first (url, is_custom: false), then one entry per enabled custom invoice template (label, type, description, url, the show_in_* flags, is_custom: true).

    Fields of each item (5)

    • descriptionstring
    • is_customboolean
    • labelstring
    • typestring
    • urlstring
  • scoped_idstring | null

    The invoice number.

  • shipping_addressobject | null

    An address.

    • Same fields as data[].billing_address.
• statusintegerrequired
• successbooleanrequired
• paginationobject
  Child fields (6)

  • countintegerrequired
  • currentPageintegerrequired
  • linksobject | array of anyrequired

    Links to the neighbouring pages: previous and next, each present only when that page exists. An empty list, [], when there is only one page.

    Child fields (2)

    • nextstring (uri)

      The next page.

    • previousstring (uri)

      The previous page.

  • perPageintegerrequired
  • totalintegerrequired
  • totalPagesintegerrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

Notes

• The response is one page with pagination. The page size is the team's list page size setting (50 unless the team changed it); per_page is not read. Send page (from 1) in the body or the query string for later pages.

Related

• POSTFilter invoices/v2/api/store/{team_slug}/v2/invoice/filter
• GETGet an invoice (v1)/v1/api/store/{team_slug}/invoice/{hash_id}

Example request

curl

curl 'https://secure.yoprint.com/v1/api/store/your-team/invoice' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": [
    {
      "billing_address": {
        "address1": "100 Example Street",
        "address2": null,
        "city": "Austin",
        "country": "United States",
        "country_code": "US",
        "id": "117KfwwfreX15N",
        "label": "Main office",
        "postcode": "78701",
        "state": "Texas",
        "state_code": "TX"
      },
      "calc_delivery_total": 15000,
      "calc_deposit_total": 169880,
      "calc_discount": 0,
      "calc_subtotal": 315000,
      "calc_tax": 24750,
      "calc_total": 339750,
      "created_at": "2026-11-03T15:00:00+00:00",
      "customer": {
        "id": "ifAHmADekGZ6id",
        "name": "Northwind Apparel"
      },
      "customer_id": "ifAHmADekGZ6id",
      "customer_name": "Northwind Apparel",
      "deposit_due": "2026-11-05T00:00:00+00:00",
      "deposit_required": true,
      "full_amount_due": "2026-11-20T00:00:00+00:00",
      "id": "cBRpSf5nw6upt5",
      "is_paid": false,
      "order_cust_due_date": "2026-11-10T00:00:00+00:00",
      "order_id": "sFbALVSYD55eXe",
      "order_issue_date": "2026-11-02T00:00:00+00:00",
      "order_name": "Team shirts",
      "order_object_type": "sales_order",
      "order_quote": false,
      "order_scoped_id": "SO1001",
      "order_ship_due_date": "2026-11-08T00:00:00+00:00",
      "paid_amount": 100000,
      "pdf_url": [
        {
          "is_custom": false,
          "url": "https://example.com/pdf/invoice.pdf"
        }
      ],
      "scoped_id": "1001",
      "shipping_address": {
        "address1": "100 Example Street",
        "address2": null,
        "city": "Austin",
        "country": "United States",
        "country_code": "US",
        "id": "117KfwwfreX15N",
        "label": "Main office",
        "postcode": "78701",
        "state": "Texas",
        "state_code": "TX"
      }
    }
  ],
  "pagination": {
    "count": 1,
    "currentPage": 1,
    "links": [],
    "perPage": 50,
    "total": 1,
    "totalPages": 1
  },
  "status": 200,
  "success": true
}