Folio

Returns the list of paid charges for a folio.

This is an internal API subject to change at any moment.<br>You must have at least one of these scopes: 'folios.read, folios.manage'.<br>For fine-grained clients, you must have this permission: 'core.folios.read'.

get/finance/v0-nsfw/folios/{id}/paid-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/v0-nsfw/folios/{id}/paid-charges
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: folios.read, folios.manage, admin

Path parameters

idstring required

The ID of the folio.

Response

Success

Example response

{
  "paidCharges": [
    {
      "chargeId": "IDDQD-1",
      "amount": 10,
      "paymentId": "IDKFA"
    },
    {
      "chargeId": "IDDQD-1",
      "amount": 20,
      "paymentId": "IDCLIP"
    },
    {
      "chargeId": "IDDQD-2",
      "amount": 30,
      "paymentId": "IDCLIP"
    }
  ]
}

Changes

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