API Cloud: administrare
Utilizare
Lunile de folosire pe care ești facturat.
Rute
- GET
/api/tenants/{tenantId}/integrator/usageget-usage
Rute
GET /api/tenants/{tenantId}/integrator/usage
get-usage
Ce plătește organizația pentru o lună și ce case au produs suma: ferestrele încheiate (charges), cele în curs (coverage), ultima fereastră a fiecărei case (latestPerRegister). Sumele sunt zecimale în unități întregi, fără monedă; prețurile sunt null până la prima sincronizare a abonamentului.
O casă se facturează pe perioade: prima comandă reușită deschide o perioadă plătită de o lună, iar plata devine scadentă când perioada se încheie. Simpla deținere a unei case este gratuită.
Pragurile și prețurile din exemplu sunt ilustrative; grila ta vine din abonament.
| Câmp | Descriere |
|---|---|
period | Luna de facturare afișată, yyyy-MM, în UTC. |
isCurrentPeriod | period este luna curentă, în UTC. |
chargedCount | Perioadele încheiate în lună: liniile de pe factura acelei luni. |
coveredCount | Casele acoperite acum, indiferent când au fost plătite. |
waivedCount | Câte dintre perioadele lunii nu se facturează. |
unitAmount | La fel ca effectiveUnitAmount (denumire veche). |
effectiveUnitAmount | Prețul unei case la numărul facturabil al lunii (chargedCount minus waivedCount). |
baseUnitAmount | Prețul unitar din primul prag. |
discountPercent | Cât de mult este effectiveUnitAmount sub baseUnitAmount, în procente. |
estimatedTotal | Numărul facturabil, calculat pe grila de prețuri. O estimare cât timp luna este deschisă. |
committedTotal | Toate casele cu acoperire activă și facturabilă, calculate pe grilă. |
nextTierAt | Numărul de la care începe pragul următor. null în ultimul prag. |
nextTierUnitAmount | Prețul unitar din pragul următor. |
registersToNextTier | Casele care mai lipsesc până la pragul următor. |
tiers | Grila de prețuri pe volum, începând cu primul prag. Un preț fix este un singur prag. |
tiers[]. | Limita de sus a pragului, inclusiv. null pentru ultimul prag, fără limită. |
tiers[]. | Prețul pe casă în acest prag. |
tiers[]. | Reducerea acestui prag față de primul, în procente. |
projectedCount | Casele cu acoperire activă și facturabilă: unde se îndreaptă luna. |
projectedEffectiveUnitAmount | Prețul unitar la projectedCount. |
projectedDiscountPercent | Reducerea la projectedCount, în procente. |
projectedTotal | projectedCount calculat pe grilă. |
projectedNextTierAt | Unde începe pragul următor, pornind de la projectedCount. |
projectedRegistersToNextTier | Casele de la projectedCount până la pragul următor. |
invoicedAtUtc | Când se emite factura următoare. null până la sincronizarea abonamentului. |
charges | Perioadele încheiate în lună: liniile facturii. |
charges[]. | Seria pe care s-a folosit perioada. |
charges[]. | Înregistrarea care a folosit perioada. null după ce nu mai există. |
charges[]. | Clientul acelei înregistrări. |
charges[]. | Numele clientului. |
charges[]. | Începutul perioadei plătite: prima folosire. |
charges[]. | Sfârșitul perioadei. Plata devine scadentă în acest moment. |
charges[]. | Perioada este încă în curs. |
charges[]. | Prima comandă din perioadă. |
charges[]. | Ultima comandă din perioadă. |
charges[]. | Perioada este acoperită, dar nu se facturează: o lună oferită sau deschisă cât facturarea după utilizare era oprită. |
coverage | Perioadele în curs acum, indiferent când au fost cumpărate. Aceleași câmpuri ca charges. |
latestPerRegister | Ultima perioadă a fiecărei case care a avut vreuna. Aceleași câmpuri ca charges. O casă nefolosită nu apare. |
curl -X GET 'https://cloud-api.fiscallink.ro/api/tenants/YOUR_TENANT_ID/integrator/usage?period=2026-09' \
-H 'X-Api-Key: fsk_YOUR_API_KEY'{
"period": "2026-09",
"isCurrentPeriod": true,
"chargedCount": 1,
"coveredCount": 1,
"waivedCount": 0,
"unitAmount": 29,
"effectiveUnitAmount": 29,
"baseUnitAmount": 29,
"discountPercent": 0,
"estimatedTotal": 29,
"committedTotal": 29,
"nextTierAt": 11,
"nextTierUnitAmount": 25,
"registersToNextTier": 10,
"tiers": [
{
"upTo": 10,
"unitAmount": 29,
"discountPercent": 0
},
{
"upTo": null,
"unitAmount": 25,
"discountPercent": 13.79
}
],
"projectedCount": 1,
"projectedEffectiveUnitAmount": 29,
"projectedDiscountPercent": 0,
"projectedTotal": 29,
"projectedNextTierAt": 11,
"projectedRegistersToNextTier": 10,
"invoicedAtUtc": "2026-10-01T00:00:00.000Z",
"charges": [
{
"serialNumber": "DT123456",
"registerId": "7d2e9b4f-1a3c-4d5e-8f60-b1c2d3e4f5a6",
"clientId": "0f8a1c2e-6b3d-4e7f-9a10-2c4d6e8f0a12",
"clientName": "Acme Distribution SRL",
"coveredFromUtc": "2026-08-02T10:31:07.000Z",
"coveredUntilUtc": "2026-09-02T10:31:07.000Z",
"isActive": false,
"firstUsedAtUtc": "2026-08-02T10:31:07.000Z",
"lastUsedAtUtc": "2026-09-01T17:45:12.000Z",
"isWaived": false
}
],
"coverage": [
{
"serialNumber": "DT123456",
"registerId": "7d2e9b4f-1a3c-4d5e-8f60-b1c2d3e4f5a6",
"clientId": "0f8a1c2e-6b3d-4e7f-9a10-2c4d6e8f0a12",
"clientName": "Acme Distribution SRL",
"coveredFromUtc": "2026-09-03T08:00:41.000Z",
"coveredUntilUtc": "2026-10-03T08:00:41.000Z",
"isActive": true,
"firstUsedAtUtc": "2026-09-03T08:00:41.000Z",
"lastUsedAtUtc": "2026-09-25T07:58:02.000Z",
"isWaived": false
}
],
"latestPerRegister": [
{
"serialNumber": "DT123456",
"registerId": "7d2e9b4f-1a3c-4d5e-8f60-b1c2d3e4f5a6",
"clientId": "0f8a1c2e-6b3d-4e7f-9a10-2c4d6e8f0a12",
"clientName": "Acme Distribution SRL",
"coveredFromUtc": "2026-09-03T08:00:41.000Z",
"coveredUntilUtc": "2026-10-03T08:00:41.000Z",
"isActive": true,
"firstUsedAtUtc": "2026-09-03T08:00:41.000Z",
"lastUsedAtUtc": "2026-09-25T07:58:02.000Z",
"isWaived": false
}
]
}