List Benefit Payment Beneficiary
Estimated reading: 1 minute
4 views
POST /api/v1/BenefitPaymentBeneficiary/list
๐ Auth required (JWT bearer, enforced by global filter)
Request body (required): ListRequest
ย
| Field | Type | Required | Nullable |
|---|---|---|---|
Filter | array of FilterRequest | no | yes |
Sort | SortRequest | yes | no |
Start | int | no | yes |
Length | int | no | yes |
Response body (200 OK)
ListResponse<T> where T = BenefitPaymentBeneficiaryResponse โ envelope: { Code, Succeeded, Message, Description, Count, Filtered, List }, with List: T[].
ย
BenefitPaymentBeneficiaryResponse fields(one list item)
| Field | Type |
|---|---|
Id | Guid |
AddressLine | string |
AnnuityCompany | long |
BankAccountName | string |
BankAccountNumber | string |
BankBranchName | string |
BankName | string |
BenefitPaymentId | Guid |
CoreParticipantBeneficiaryId | long |
CreatedAt | DateTime |
CreatedBy | string |
CurrentFactor | decimal |
District | string |
Email | string |
EmployerContribution | decimal |
EmploymentStartDate | DateTime |
IdCardNumber | string |
InvestmentReturn | decimal |
LengthOfServiceYears | int |
LumpSumAmount | decimal |
LumpSumFactor | decimal |
LumpSumPensionDeduction | decimal |
LumpSumPercentage | decimal |
MobilePhone | string |
MonthlyPensionBenefit | decimal |
Municipal | string |
BeneficiaryRelation | MasterValueReferenceModel |
Name | string |
ParticipantContribution | decimal |
ParticipantType | ParticipantType (enum) |
PaymentMethodType | PaymentMethodType (enum) |
PaymentPeriodMonths | int |
PensionBenefit | decimal |
PensionBenefitDeduction | decimal |
PeriodicAmountPerMonth | decimal |
PeriodicPaymentType | PeriodicPaymentType (enum) |
PeriodicPensionDeduction | decimal |
PeriodicPercentage | decimal |
PhDp | decimal |
Province | string |
PtkpstatusId | long |
Relation | string |
RewardFactor | decimal |
Rt | string |
Rw | string |
Tin | string |
TotalLumpSumPensionBenefit | decimal |
TotalPensionBenefit | decimal |
TotalPeriodicPensionBenefit | decimal |
InsuranceCompany | InsuranceCompaniesResponse |
Gender | MasterValueReferenceModel |
UpdatedAt | DateTime |
UpdatedBy | string |
UrbanVillage | string |
VoluntaryContribution | decimal |
ZipCode | string |
PensionWithdrawalPercentage | decimal |
InvestmentReturnRegular | decimal |
InvestmentReturnVoluntary | decimal |
ValuePensionBenefitDeductionRegular | decimal |
IsLumpSumVoluntary | bool |
LumpSumVoluntary | decimal |
PensionBenefitRegular | decimal |
PensionBenefitVoluntary | decimal |
ValuePensionBenefitDeductionVoluntary | decimal |
TotalPensionBenefitVoluntary | decimal |
TotalPensionBenefitRegular | decimal |