List all benefit charges for a specific subscription

Changed on Feb 3, 2025

get/benefits/{benefitId}/charges

Request

Base URL
http://localhost:3000
Auth
none declared
TypeScript
https://skmtc.dev/ducin-public/apis/itcorpo-api/docs/benefits/:benefitId/charges/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

benefitIdstring required

Query parameters

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