Sign in

v1

latestOpenAPI 3.0.3Proprietaryraw.githubusercontent.com2026-03-067260437.0 KB
Invoices

Search invoices

Full-text search across invoices using Typesense. Provides fast, typo-tolerant search capabilities.

gigstack Connect: Access other teams' invoices using the team parameter.

Search Capabilities:

  • Search across client name, email, invoice UUID, description, and metadata
  • Typo-tolerant fuzzy matching
  • Paginated results

Requirements:

  • Typesense must be configured for your team
  • The q (or query) parameter is required
get/invoices/search

Query parameters

teamstring

gigstack Connect: Target team ID for multi-team access.

Requires gigstack Connect enabled on your team and shared billing account.

Example: ?team=team_xyz789

qstring required

Search query text (primary parameter). Searches across relevant fields depending on the collection (e.g., client name, email, payment ID, description, metadata). The query parameter is also accepted as a backward-compatible alternative.

querystring

Alternative to q, kept for backward compatibility. If both are provided, q takes precedence.

limitinteger

Maximum number of items to return (default 50, max 100)

pageinteger

Page number for pagination (default 1)

fieldsstring[]

Comma-separated list of fields to include in the response

Response

Invoices searched successfully

messagestring required
foundinteger required

Total number of results found

pageinteger required

Current page number

per_pageinteger required

Number of results per page

successboolean required
timestampnumber required

Unix timestamp in milliseconds

Example response

{
  "message": "Invoices searched successfully",
  "data": [
    {
      "uuid": "invoice_1234567890",
      "client": {
        "id": "client_1234567890",
        "address": {
          "country": "MEX",
          "street": "Av. Insurgentes Sur",
          "zip": "03100",
          "city": "Ciudad de México",
          "state": "CDMX",
          "exterior": "123",
          "interior": "4B",
          "municipality": "Benito Juárez",
          "neighborhood": "Del Valle"
        },
        "name": "Juan Pérez García",
        "company": "Empresa SA de CV",
        "phone": "+52 55 1234 5678",
        "email": "juan.perez@ejemplo.com",
        "bcc": [
          "admin@empresa.com"
        ],
        "metadata": {
          "custom_field": "value"
        },
        "is_valid": true,
        "from": "api",
        "legal_name": "Juan Pérez García",
        "livemode": true,
        "owner": "user_1234567890",
        "tax_id": "PEGJ800101ABC",
        "use": "P01",
        "tax_system": "601",
        "team": "team_1234567890",
        "created_at": 1677651234,
        "efos": {
          "is_valid": true
        },
        "defaults": {
          "issue_invoiceable_receipts": true
        }
      },
      "created_at": 1677651234,
      "currency": "MXN",
      "exchange_rate": 1,
      "total": 1160,
      "subtotal": 1000,
      "taxes": 160,
      "series": "A",
      "folio_number": 123,
      "invoice_type": "I",
      "use": "P01",
      "payment_form": "03",
      "payment_method": "PUE",
      "status": "stamped",
      "livemode": true,
      "owner": "user_1234567890",
      "from": "api",
      "items": [
        {
          "id": "item_1234567890",
          "description": "Professional consulting services",
          "product_key": "80141503",
          "quantity": 1,
          "unit_price": 1000,
          "unit_key": "E48",
          "unit_name": "Servicio",
          "sku": "CONS-001",
          "taxability": "01",
          "taxes": [
            {
              "factor": "Tasa",
              "rate": 0.16,
              "type": "IVA"
            }
          ]
        }
      ],
      "payments": [
        "payment_1234567890"
      ],
      "invoices": [],
      "stamp": {
        "sello": "ABC123...",
        "stamp_at": 1677651234
      },
      "cancellation": {
        "cancellation_status": "cancelled",
        "cancelled_at": 1677651234,
        "motive": "02",
        "code": "201"
      },
      "verification_url": "https://verificacfdi.facturaelectronica.sat.gob.mx/default.aspx",
      "exports": "01",
      "invoice_pdf_notes": "Additional notes for PDF",
      "files": {
        "pdf": "JVBERi0xLjQKJeLjz9MKMSAwIG9ia...",
        "xml": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4..."
      }
    }
  ],
  "found": 15,
  "page": 1,
  "per_page": 10,
  "success": true,
  "timestamp": 1677651234000
}