DUducin-public
Benefits
Pagination
Search

List all benefit charges

Changed on
get/benefits/charges

Request

Query parameters

subscriptionIdstring

Filter charges by subscription ID

Example:zc9b3b4c-1b1d-4b3e-8b3b-4c1b1d4b3e8b
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
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
billingPeriodTostring date

Filter charges with billing period ending before this date

Example:2023-12-31
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

  • 91c1a6d49e80Revision changes
    • warning

      deleted the query request parameter _page

    • warning

      deleted the query request parameter _pageSize

    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter pageSize

  • 4573748c6338Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status