APapaleo
FolioActions

Corrects a folio by moving some charges. This operation creates a new folio with the charges from the request. The payment, equal to the sum of charges, is also split to this new folio so that both folios will have 0 balance.

Allowance value posted must not exceed sum of charges minus existing allowances<br>You must have this scope: 'folios.manage'.<br>For fine-grained clients, you must have this permission: 'core.folios.correct'.

post/finance/v1/folio-actions/{folioId}/correct

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}/correct
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: folios.manage, admin

Path parameters

folioIdstring required

The folio ID

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 the correction is performed

chargeIdsstring[] nullable

The IDs of the charges that should be moved

allowanceIdsstring[] nullable

The IDs of the allowances that should be moved Only moving global allowances is supported

transitoryChargeIdsstring[] nullable

The IDs of the transitory charges that should be moved

Example request

{
  "reason": "Minibar is not paid by the company",
  "chargeIds": [
    "IDDQD-1-C-1",
    "IDDQD-1-C-5"
  ],
  "allowanceIds": [
    "IDDQD-1-A-1",
    "IDDQD-1-A-5"
  ],
  "transitoryChargeIds": [
    "IDDQD-1-TC-1",
    "IDDQD-1-TC-5"
  ]
}

Response

Folio correction was successful. Correction folio created.

idstring required

The folio id

Example response

{
  "id": "XKCD-17"
}

Changes

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