List all benefit charges

get/benefits/charges

Query parameters

subscriptionIdstring

Filter charges by subscription ID

Example:zc9b3b4c-1b1d-4b3e-8b3b-4c1b1d4b3e8b

Filter charges by subscription ID

employeeIdstring

The employee whom this benefit is subscribed to

Example:91720

Filter benefits by employee ID

providerServiceCodestring

Filter charges by provider service code

Example:MEDICOVER_PREMIUM

Filter charges by provider service code

status'PENDING' | 'PAID' | 'OVERDUE' | 'CANCELLED' | 'REFUNDED'

Payment status of a benefit charge

Filter charges by status

billingPeriodFromstring date

Filter charges with billing period starting from this date

Example:2023-01-01

Filter charges with billing period starting from this date

billingPeriodTostring date

Filter charges with billing period ending before this date

Example:2023-12-31

Filter charges with billing period ending before this date

pagenumber

Page number to retrieve

Example:1

Specify the page number to retrieve

pageSizenumber

Number of elements per page

Example:1

Specify the number of items per page

Response

Successful operation

idstring uuid required

employeeIdinteger required

subscriptionIdstring required

providerServiceCodestring required

billingPeriodStartstring date required

billingPeriodEndstring date required

amountnumber required

Monetary value in EUR

status'PENDING' | 'PAID' | 'OVERDUE' | 'CANCELLED' | 'REFUNDED' required

Payment status of a benefit charge

Changes

Changed in 9 of the 28 revisions of this API.41229

Feb 3, 202591c1a6d49e8022See the full diff
- ●
  deleted the query request parameter _page
  request-parameter-removed
- ●
  deleted the query request parameter _pageSize
  request-parameter-removed
- ○
  added the new optional query request parameter page
  new-optional-request-parameter
- ○
  added the new optional query request parameter pageSize
  new-optional-request-parameter
Jan 17, 20254573748c63383See the full diff
- ○
  added the optional property errorGUID to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property errorGUID to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property errorGUID to the response with the 503 status
  response-optional-property-added
Jan 17, 20253aadb0e6d9391See the full diff
- ○
  added the new optional query request parameter _pageSize
  new-optional-request-parameter
Jan 13, 2025027398d45de53See the full diff
- ○
  api tag Pagination added
  api-tag-added
- ○
  api tag Search added
  api-tag-added
- ○
  added the new optional query request parameter _page
  new-optional-request-parameter
Jan 9, 20252bb1ebc60ebd17See the full diff
- ▲
  the query request parameter status was restricted to a list of enum values
  request-parameter-became-enum
- ○
  added the new optional query request parameter employeeId
  new-optional-request-parameter
- ○
  added the new enum value CANCELLED to the query request parameter status
  request-parameter-enum-value-added
- ○
  added the new enum value OVERDUE to the query request parameter status
  request-parameter-enum-value-added
- ○
  added the new enum value PAID to the query request parameter status
  request-parameter-enum-value-added
- ○
  added the new enum value PENDING to the query request parameter status
  request-parameter-enum-value-added
- ○
  added the new enum value REFUNDED to the query request parameter status
  request-parameter-enum-value-added
- ○
  for the query request parameter status, the type/format was generalized from / to string/
  request-parameter-type-generalized
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 9, 2025a59b7402c5143See the full diff
- ▲
  the response property code became optional for the status 400
  response-property-became-optional
- ▲
  the response property code became optional for the status 500
  response-property-became-optional
- ▲
  the response property code became optional for the status 503
  response-property-became-optional
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 9, 202529074eeb2bb53See the full diff
- ○
  added the non-success response with the status 400
  response-non-success-status-added
- ○
  added the non-success response with the status 500
  response-non-success-status-added
- ○
  added the non-success response with the status 503
  response-non-success-status-added
Jan 8, 2025ad02edd736475See the full diff
- ○
  added the new optional query request parameter billingPeriodFrom
  new-optional-request-parameter
- ○
  added the new optional query request parameter billingPeriodTo
  new-optional-request-parameter
- ○
  added the new optional query request parameter providerServiceCode
  new-optional-request-parameter
- ○
  added the new optional query request parameter status
  new-optional-request-parameter
- ○
  added the new optional query request parameter subscriptionId
  new-optional-request-parameter
Jan 7, 2025659ddbe31a58105See the full diff
- ●
  the optional response header X-Total-Count removed for the status 200
  optional-response-header-removed
- ●
  the optional response header X-Total-Pages removed for the status 200
  optional-response-header-removed
- ●
  deleted the query request parameter billingPeriodFrom
  request-parameter-removed
- ●
  deleted the query request parameter billingPeriodTo
  request-parameter-removed
- ●
  deleted the query request parameter employeeId
  request-parameter-removed
- ●
  deleted the query request parameter page
  request-parameter-removed
- ●
  deleted the query request parameter pageSize
  request-parameter-removed
- ●
  deleted the query request parameter providerServiceCode
  request-parameter-removed
- ●
  deleted the query request parameter status
  request-parameter-removed
- ●
  deleted the query request parameter subscriptionId
  request-parameter-removed
- ○
  api tag Pagination removed
  api-tag-removed
- ○
  api tag Search removed
  api-tag-removed
- ○
  removed the non-success response with the status 400
  response-non-success-status-removed
- ○
  removed the non-success response with the status 500
  response-non-success-status-removed
- ○
  removed the non-success response with the status 503
  response-non-success-status-removed
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history