Get financial analytics

Returns aggregate financial analytics for a date range.

RBAC · financial

Query parameters

pagestringOptional

limitstringOptional

sortstringOptional

orderstringOptional

searchstringOptional

created_fromstringOptional

created_tostringOptional

updated_fromstringOptional

updated_tostringOptional

client_idstring <uuid>Optional

invoice_idstring <uuid>Optional

typestringOptional

statusstringOptional

amount_minstringOptional

amount_maxstringOptional

include_expiredstringOptional

expiring_soonstringOptional

has_remainingstringOptional

has_expirationstringOptional

date_fromstringOptional

date_tostringOptional

group_bystringOptional

include_projectionsstringOptional

as_of_datestringOptional

Response body

Success response 200 · schema FinancialInvoiceApiSuccess

dataanyOfRequired

anyOf (option 1)object

anyOf (option 2)array of object

itemsobject

metaobject

Response codes

200

Report returned.

400

Invalid report query parameters.

401

API key missing/invalid.

403

financial:read permission denied.

500

Unexpected report failure.

GET /api/v1/financial/reports/analytics

cURL

curl -X GET "https://algapsa.com/api/v1/financial/reports/analytics?page=string&limit=string&sort=string&order=asc&search=string&created_from=string" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/financial/reports/analytics?page=string&limit=string&sort=string&order=asc&search=string&created_from=string", {
  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/financial/reports/analytics?page=string&limit=string&sort=string&order=asc&search=string&created_from=string");
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": {},
  "meta": {}
}