---
title: "Overview"
description: "The API settles the usage chargeback after a billing period closes successfully and makes the invoice available as a PDF."
url: "https://real-estate-agency.apim.eu/apis/chargeback-settlement/docs/overview"
image: "https://real-estate-agency.apim.eu/_og/d/c_Ocean.takumi,title_Overview,description_The+API+settles+the+usage+chargeback+after+a+billing+period+closes+successfully+and+makes+the+invoice+available+as+a+PDF.,props_eyJ0aGVtZSI6eyJtb2RlIjoiZGFyayIsImNvbG9ycyI6eyJwcmltYXJ5IjoiI0Q0QTI0QyJ9fX0,p_Ii9hcGlzL2NoYXJnZWJhY2stc2V0dGxlbWVudC9kb2NzL292ZXJ2aWV3Ig,s_m_LLi5r2aElaMUB0.png"
---

# Overview

The API settles the usage chargeback after a billing period closes successfully and makes the invoice available as a PDF.

## [Split chargeback](#split-chargeback)

For a regulated internal cost allocation - such as a cross-charge between two business units - the receiving unit's share must not exceed the owning unit's share. The API validates this when a settlement is created and otherwise responds with `422` and `code: "chargeback_not_permitted"`.

Check the same condition already on the deployment record - that's where the chargeback rate advertised in the catalog entry lives. A settlement that deviates from the advertised rate is hard to defend in a dispute.

## [Assessment basis](#assessment-basis)

| Usage type    | Basis                                               |
| :------------ | :-------------------------------------------------- |
| metered       | token/request usage recorded for the billing period |
| subscription  | monthly seat or budget allocation                   |
| committed_use | annual committed spend, prorated monthly            |

## [Payments](#payments)

`POST /settlements/{id}/payments` also records partial payments. The status only moves to `paid` once the sum of payments reaches the gross amount; until then it stays `partially_paid`. That keeps what's outstanding visible without extra accounting logic.

## [Upfront calculation](#upfront-calculation)

`POST /chargeback/calculator` runs a chargeback calculation without creating anything. That's the right call for budget conversations and for the chargeback rate shown in the catalog entry.

## [Required scope](#required-scope)

All calls require `chargeback-settlement:read`. Write operations are deliberately bound to the same role, because settlements should only ever be created by finance.