Usage report
BuildingIn development for the v1 API. The contract is set; the route is not served yet.
What you used in the period, per service. It matches your invoice from heru.
Needs the reports:read scope.
oauth2 reports:readAuthorizationBearer <token>OAuth 2.0 client credentials. Exchange your client_id and client_secret at /oauth/token of the environment for a bearer token valid for one hour. The playground of every operation asks for your own client and keeps it in your browser tab only.
Scope: reports:read
period?stringYYYY-MM.
OK
application/json- response
period?stringactive_merchants?integerby_service?array<>curl -X GET 'https://api.dev.b2b.heru.app/v1/reports/usage'{ "period": "2026-10", "active_merchants": 3, "by_service": [ { "service": "fiscal_validations", "units": 4417 }, { "service": "social_security_validations", "units": 1212 }, { "service": "invoices", "units": 18640 }, { "service": "retention_certificates", "units": 2896 }, { "service": "charges", "units": 9318 } ]}Monthly retentions reportGET
Per worker and month: gross amounts, VAT and ISR withheld and the certificates that back them. The basis for your monthly informative return (DIAT). Needs the `reports:read` scope.
Create a webhook subscriptionPOST
Registers a URL to receive the events listed, signed with a secret of its own. The answer carries `secret` once: store it, it is never shown again. Retrying with the same `Idempotency-Key` and body returns the same subscription, `secret` included. A company can hold up to 10 subscriptions. See the [Webhooks guide](/guides/webhooks) for signature verification, idempotency and retries. Needs the `webhooks:write` scope.