Search invoices

Searches invoices by free-text q with paginated response.

RBAC · invoice

Query parameters

pagestringOptional

limitstringOptional

sortstringOptional

orderstringOptional

include_itemsstringOptional

include_clientstringOptional

include_billing_cyclestringOptional

include_transactionsstringOptional

qstringOptional

fromstringOptional

tostringOptional

formatstringOptional

Response body

Success response 200 · schema FinancialInvoiceApiPaginated

dataarray of objectRequired

itemsobject

paginationobjectRequired

pageintegerRequired

limitintegerRequired

totalintegerRequired

totalPagesintegerRequired

hasNextbooleanRequired

hasPrevbooleanRequired

metaobject

Response codes

200

Search results returned.

401

API key missing/invalid.

403

invoice:read permission denied.

500

Unexpected search failure.

GET /api/v1/invoices/search

cURL

curl -X GET "https://algapsa.com/api/v1/invoices/search?page=string&limit=string&sort=string&order=asc&include_items=true&include_client=true" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/invoices/search?page=string&limit=string&sort=string&order=asc&include_items=true&include_client=true", {
  method: "GET",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://algapsa.com/api/v1/invoices/search?page=string&limit=string&sort=string&order=asc&include_items=true&include_client=true");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": [
    {}
  ],
  "pagination": {
    "page": 1,
    "limit": 1,
    "total": 1,
    "totalPages": 1,
    "hasNext": false,
    "hasPrev": false
  },
  "meta": {}
}