Add Metrics to Retrieve a Company & Retrieve all Companies Endpoints

We’ve updated both GET /companies/{companyID} and GET /companies to optionally include file-processing metrics alongside core company data.

Key Highlights:

Metrics Toggle: metrics=true returns overall counts (uploadedCount, extractedCount, bookedCount, extractedAndBookedCount, extractedByBricksCount)

Type Breakdown: for each file type, returns type, averageConformity, extractedCount, bookedCount, extractedAndBookedCount

Filtering: use fileCreatedFrom/fileCreatedTo (YYYY-MM-DD HH:mm:ss) and conformityFilters to scope metrics

Pagination & Sorting: on GET /companies, control pageNumber, pageSize, sortField, and sortDirection

Why It Matters:
With the metrics toggle you get performance insights and statistics to build powerful dashboards, support tools, and audit workflows. You can even surface conformity results in customer-facing views to show how extraction is performing for them.

Sample Metrics Object

"metrics": {
"files": {
"uploadedCount": 1582,
"extractedCount": 1566,
"bookedCount": 1396,
"extractedAndBookedCount": 1393,
"extractedByBricksCount": 51,
"types": [
{
"type": "SupplierInvoice",
"averageConformity": 89.97,
"extractedCount": 355,
"bookedCount": 296,
"extractedAndBookedCount": 296
},
{
"type": "Receipt",
"averageConformity": 78.23,
"extractedCount": 1211,
"bookedCount": 1100,
"extractedAndBookedCount": 1097
}
]
}

Affected Resource:

GET ...{api}/{version}/companies/{companyID}

GET ...{api}/{version}/companies

Note: Detailed documentation is available at the endpoint level.