FolioActions

Posts allowances for a folio

Allowance value posted must not exceed sum of charges minus existing allowances<br>You must have at least one of these scopes: 'allowances.post, folios.manage'.<br>For fine-grained clients, you must have this permission: 'core.folios.post_charge_allowance'.

post/finance/v1/folio-actions/{folioId}/bulk-allowances

Request

Base URL
https://api.apaleo.com (the document declares no server; this is the origin it was published from)
URL
https://api.apaleo.com/finance/v1/folio-actions/{folioId}/bulk-allowances
Auth
OAuth 2
Implicit: https://identity.apaleo.com/connect/authorize
Scopes: allowances.post, folios.manage, admin

Path parameters

folioIdstring required

The ID of the folio.

Headers

Idempotency-Keystring

Unique key for safely retrying requests without accidentally performing the same operation twice. We'll always send back the same response for requests made with the same key, and keys can't be reused with different request parameters. Keys expire after 24 hours.

Request body

reasonstring required

Description of why allowances are added

businessDatestring date nullable

The business date of the allowance. Defaults to the current date. In some cases you might want to post the allowances to the previous business date, this is only possible until 6 AM of the current day.

Example request

{
  "items": [
    {
      "chargeId": "IDDQD-1-1-TS-1",
      "amount": {
        "amount": 13,
        "currency": "EUR"
      }
    },
    {
      "chargeId": "IDDQD-1-1-ES-2",
      "amount": {
        "amount": 37,
        "currency": "EUR"
      }
    }
  ],
  "reason": "discount"
}

Response

Success.

Example response

{
  "items": [
    {
      "id": "IDFKA-1-1-A-1",
      "sourceChargeId": "IDKFA-1-1-TS-1"
    },
    {
      "id": "IDFKA-1-1-A-2",
      "sourceChargeId": "IDKFA-1-1-ES-2"
    }
  ]
}

Changes

No recorded changes to this operation across all 3 revisions of this API.