APapaleo
FolioActions

Splits a charge into two using the percent or amount provided Creates an allowance and two new charges.

<br>You must have at least one of these scopes: 'allowances.post, charges.create, folios.manage'.<br>For fine-grained clients, you must have this permission: 'core.folios.split_charge'.

post/finance/v1/folio-actions/{folioId}/charges/{chargeId}/split

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

Path parameters

folioIdstring required

The folio ID

chargeIdstring required

The ID of the charge

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

percentnumber double nullable

The percent to split charge (between 0 and 100)

type'ByPercent' | 'ByAmount' required

How to split the charge: by percent value, or by absolute amount

Example request

{
  "percent": 51,
  "type": "ByPercent"
}

Response

OK

allowanceIdstring required
firstChargeIdstring required
secondChargeIdstring required

Example response

{
  "allowanceId": "ABCDEF-1-1",
  "firstChargeId": "ABCDEF-1-2",
  "secondChargeId": "ABCDEF-1-2"
}

Changes

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