POST /invoices/search — fragment-payments-api

Invoices

Searches invoices.

post/invoices/search

Request body

Example request

{
  "filter": {
    "status": "open",
    "tags": {
      "any": [
        {
          "key": "department",
          "value": "eng*"
        }
      ],
      "all": [
        {
          "key": "department",
          "value": "engineering"
        }
      ]
    },
    "users": {
      "any": [
        {
          "id": "user_abc123"
        }
      ],
      "all": [
        {
          "id": "user_abc123"
        }
      ]
    },
    "transaction_tags": {
      "any": [
        {
          "key": "department",
          "value": "eng*"
        }
      ],
      "all": [
        {
          "key": "department",
          "value": "engineering"
        }
      ]
    },
    "user_tag_and_balance": {
      "user_tags": {
        "any": [
          {
            "key": "department",
            "value": "eng*"
          }
        ],
        "all": [
          {
            "key": "department",
            "value": "engineering"
          }
        ],
        "not_any": [
          {
            "key": "department",
            "value": "eng*"
          }
        ]
      },
      "net_remaining_balance": {
        "gt": "0"
      }
    },
    "created": {
      "after": "2026-01-01T00:00:00Z",
      "before": "2026-02-01T00:00:00Z"
    },
    "modified": {
      "after": "2026-01-01T00:00:00Z",
      "before": "2026-02-01T00:00:00Z"
    }
  },
  "page_info": {
    "limit": 20
  }
}

Response

Success

Example response

{
  "data": {
    "invoices": [
      {
        "id": "inv_1234567890",
        "workspace_id": "ws_1234567890",
        "status": "active",
        "line_items": [
          {
            "id": "item_1234567890",
            "type": "payout",
            "product_id": "prod_1234567890",
            "amount": "1000",
            "price": {
              "amount": "1000",
              "unit_price": "1000",
              "quantity": 1
            },
            "currency_code": "USD",
            "description": "Professional services for January 2026",
            "user_id": "user_ext_456",
            "tags": [
              {
                "key": "department",
                "value": "engineering"
              }
            ]
          }
        ],
        "created": "2024-01-13T00:00:00Z",
        "modified": "2024-01-13T00:00:00Z",
        "version": 1,
        "tags": [
          {
            "key": "department",
            "value": "engineering"
          }
        ],
        "users": [
          {
            "id": "user_ext_789",
            "external_id": "user_ext_789",
            "balances": [
              {
                "payins": {
                  "expected": "10000",
                  "actual": "5000",
                  "remaining": "5000"
                },
                "payouts": {
                  "expected": "10000",
                  "actual": "5000",
                  "remaining": "5000"
                },
                "net": {
                  "expected": "10000",
                  "actual": "5000",
                  "remaining": "5000"
                },
                "currency": "USD"
              }
            ]
          }
        ],
        "balances": [
          {
            "payins": {
              "expected": "10000",
              "actual": "5000",
              "remaining": "5000"
            },
            "payouts": {
              "expected": "10000",
              "actual": "5000",
              "remaining": "5000"
            },
            "net": {
              "expected": "10000",
              "actual": "5000",
              "remaining": "5000"
            },
            "currency": "USD"
          }
        ],
        "payments": [
          {
            "amount": "150",
            "currency": "USD",
            "transaction": {
              "id": "txn_dHhuX2ZyYWdfMDAx",
              "external_id": "bank_txn_123",
              "tags": [
                {
                  "key": "department",
                  "value": "engineering"
                }
              ]
            },
            "type": "payin",
            "posted": "2024-01-13T00:00:00Z",
            "user": {
              "id": "user_abc123",
              "external_id": "user_ext_001"
            }
          }
        ]
      }
    ]
  }
}

Changes

Changed in 11 of the 38 revisions of this API.14320

Jun 16, 20265a1a9ed0355e1See the full diff
- ○
  added the new optional request property /
  new-optional-request-property
May 22, 202695913ffae4311See the full diff
- ○
  added the new optional request property ///
  new-optional-request-property
May 11, 202691a072ddf86d2See the full diff
- ○
  added the new optional request property /
  new-optional-request-property
- ○
  added the new optional request property /
  new-optional-request-property
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 17, 2026091e4746720a2See the full diff
- ○
  added the new optional request property /
  new-optional-request-property
- ○
  added the new optional request property /
  new-optional-request-property
Apr 14, 20268472a9bd15ea17See the full diff
- ▲
  the ////// response's property type changed from no type to object for status
  response-property-type-changed
- ○
  the request property became optional
  request-property-became-optional
- ○
  removed subschema #2 from the ////// response property allOf list for the response status
  response-property-all-of-removed
- ○
  the response property /////// became required for the status
  response-property-became-required
- ○
  added the required property /////// to the response with the status
  response-required-property-added
- ○
  added the required property /////// to the response with the status
  response-required-property-added
- ○
  added the required property /////// to the response with the status
  response-required-property-added
- ○
  added the required property ////// to the response with the status
  response-required-property-added
This revision also has 18 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 27, 20261ac1d5e34a8f2See the full diff
- ○
  added the new optional request property /
  new-optional-request-property
- ○
  response property data/invoices/items/allOf[Invoice]/status deprecated
  response-property-deprecated
Mar 25, 2026b859481da9cf41See the full diff
- ▲
  the ////// response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  removed the required property /////// from the response with the status
  response-required-property-removed
- ▲
  removed the required property /////// from the response with the status
  response-required-property-removed
- ▲
  removed the required property /////// from the response with the status
  response-required-property-removed
- ○
  added subschema #2 to the ////// response property allOf list for the response status
  response-property-all-of-added
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 20, 2026f2aa708834d1721See the full diff
- ▲
  the // response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  removed the required property /// from the response with the status
  response-required-property-removed
- ▲
  removed the required property /// from the response with the status
  response-required-property-removed
- ▲
  removed the required property /// from the response with the status
  response-required-property-removed
- ▲
  removed the required property /// from the response with the status
  response-required-property-removed
- ▲
  removed the required property /// from the response with the status
  response-required-property-removed
- ▲
  removed the required property /// from the response with the status
  response-required-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ○
  added subschema #2 to the // response property allOf list for the response status
  response-property-all-of-added
Mar 19, 20260893c377bfd02See the full diff
- ○
  response property data/invoices/items/line_items/items/amount deprecated
  response-property-deprecated
- ○
  added the required property ///// to the response with the status
  response-required-property-added
Mar 13, 2026dd22ecbbe8e521See the full diff
- ▲
  removed the required property ///// from the response with the status
  response-required-property-removed
- ▲
  removed the required property /// from the response with the status
  response-required-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed

Full history (11 revisions)