APapaleo
FolioActions

Move multiple charges, allowances and transitory charges from one folio to another.

If one of the folios is closed, this action cannot be performed.

If any of the specified charges does not exist, this action cannot be performed.

Moving negative charges to a house folio is not supported. Create additional folios instead, and move the charges there.<br>You must have at least one of these scopes: 'charges.move, folios.manage'.<br>For fine-grained clients, you must have this permission: 'core.folios.move_charge'.

put/finance/v1/folio-actions/{folioId}/move-charges

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

Path parameters

folioIdstring required

The ID of the source folio from where the charges should be moved away.

Request body

targetFolioIdstring required

ID of the target folio

reasonstring required

Description of why the move 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

{
  "targetFolioId": "KFCSQUID-1",
  "reason": "Test",
  "chargeIds": [
    "KFCSQUID-1-C-1",
    "KFCSQUID-1-C-5"
  ],
  "allowanceIds": [
    "KFCSQUID-1-A-1",
    "KFCSQUID-1-A-2"
  ],
  "transitoryChargeIds": [
    "KFCSQUID-1-TC-1",
    "KFCSQUID-1-TC-2"
  ]
}

Response

Success.

Changes

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