APapaleo
FolioPayments

Get a list of payments.

Returns a list of all payments for this folio ordered by creation date, newest first<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.folio_payments.read'.

get/finance/v1/folios/{folioId}/payments

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

Path parameters

folioIdstring required

Query parameters

statusCodesstring[]

Filter payments by one or more status.

pageNumberinteger

Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.

pageSizeinteger

Items per page. Default: 500. Maximum: 500.

expandstring[]

List of all embedded resources that should be expanded in the response. Possible values are: actions. All other values will be silently ignored.

Response

Success.

countinteger required

Total count of items

Example response

{
  "payments": [
    {
      "id": "PAY-1",
      "method": "BankTransfer",
      "amount": {
        "amount": 50,
        "currency": "EUR"
      },
      "receipt": "CA-147-339",
      "paymentDate": "0001-01-01T00:00:00Z",
      "status": "Success",
      "type": "Custom",
      "businessDate": "0001-01-01"
    },
    {
      "id": "PAY-2",
      "amount": {
        "amount": 2.14,
        "currency": "EUR"
      },
      "receipt": "HSKJCNDR-1",
      "paymentDate": "0001-01-01T00:00:00Z",
      "status": "Pending",
      "type": "Custom",
      "businessDate": "0001-01-01"
    }
  ],
  "count": 2
}

Changes

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