Edit Beneficiary

Estimated reading: 1 minute 8 views

Endpoint

				
					PUT /api/v{version}/BenefitPaymentBeneficiary/edit/{id}
				
			

Authorization

				
					Authorization: Bearer {token}
				
			

Path Parameter

FieldTypeRequired
idinteger (int64)Yes
version

string

Yes

Request Body

Identity & Address

FieldType
AddressLinestring / null
Districtstring / null
Emailstring / null
IdCardNumberstring / null
MobilePhonestring / null
Municipalstring / null
Namestring / null
Provincestring / null
Rtstring / null
Rwstring / null
Tinstring / null
UrbanVillagestring / null
ZipCodestring / null

Banking

FieldType
BankAccountNamestring / null
BankAccountNumberstring / null
BankBranchNamestring / null
BankNamestring / null

Participant

FieldType
BenefitPaymentIdinteger (int64)
ParticipantDocumentNostring / null
ParticipantTypeinteger (int32)
BeneficiaryIdinteger (int64)
BeneficiaryRelationstring / null
Relationstring / null

Benefit Calculation

FieldType
ParticipantContributiondouble
EmployerContributiondouble
VoluntaryContributiondouble
InvestmentReturndouble
PensionBenefitdouble
PensionBenefitDeductiondouble
TotalPensionBenefitdouble
PhDpdouble
RewardFactordouble
CurrentFactordouble
LumpSumFactordouble
LumpSumPercentagedouble
LumpSumAmountdouble
LumpSumPensionDeductiondouble
TotalLumpSumPensionBenefitdouble
PeriodicPercentagedouble
PeriodicAmountPerMonthdouble
PeriodicPensionDeductiondouble
TotalPeriodicPensionBenefitdouble

Periodic / Payment

FieldType
PeriodicPaymentTypestring / null
AnnuityCompanyinteger (int64) / null
PaymentMethodTypestring / null
MonthlyPensionBenefitdouble
InvestmentReturnRegulardouble
InvestmentReturnVoluntarydouble
IsLumpSumVoluntaryboolean / null
LumpSumVoluntarydouble
PensionBenefitRegulardouble
PensionBenefitVoluntarydouble
TotalPensionBenefitVoluntarydouble
TotalPensionBenefitRegulardouble
PensionWithdrawalPercentagedouble
MvGenderstring / null

Request Example

				
					{
  "AddressLine": "string",
  "BankAccountName": "string",
  "BankAccountNumber": "string",
  "BankBranchName": "string",
  "BankName": "string",
  "BenefitPaymentId": 0,
  "District": "string",
  "Email": "string",
  "IdCardNumber": "string",
  "MobilePhone": "string",
  "Municipal": "string",
  "Name": "string",
  "ParticipantDocumentNo": "string",
  "ParticipantType": 0,
  "Province": "string",
  "Relation": "string",
  "Rt": "string",
  "Rw": "string",
  "Tin": "string",
  "UrbanVillage": "string",
  "ZipCode": "string",
  "BeneficiaryRelation": "string",
  "PtkpstatusId": 0,
  "BeneficiaryId": 0,
  "ParticipantContribution": 0,
  "EmployerContribution": 0,
  "VoluntaryContribution": 0,
  "InvestmentReturn": 0,
  "PensionBenefit": 0,
  "PensionBenefitDeduction": 0,
  "TotalPensionBenefit": 0,
  "PhDp": 0,
  "EmploymentStartDate": "2019-08-24",
  "PaymentPeriodMonths": 0,
  "LengthOfServiceYears": 0,
  "RewardFactor": 0,
  "CurrentFactor": 0,
  "LumpSumFactor": 0,
  "LumpSumPercentage": 0,
  "LumpSumAmount": 0,
  "LumpSumPensionDeduction": 0,
  "TotalLumpSumPensionBenefit": 0,
  "PeriodicPercentage": 0,
  "PeriodicAmountPerMonth": 0,
  "PeriodicPensionDeduction": 0,
  "TotalPeriodicPensionBenefit": 0,
  "PeriodicPaymentType": "string",
  "AnnuityCompany": 0,
  "PaymentMethodType": "string",
  "MonthlyPensionBenefit": 0,
  "InvestmentReturnRegular": 0,
  "InvestmentReturnVoluntary": 0,
  "ValuePensionBenefitDeductionRegular": 0,
  "IsLumpSumVoluntary": true,
  "LumpSumVoluntary": 0,
  "PensionBenefitRegular": 0,
  "PensionBenefitVoluntary": 0,
  "ValuePensionBenefitDeductionVoluntary": 0,
  "TotalPensionBenefitVoluntary": 0,
  "TotalPensionBenefitRegular": 0,
  "PensionWithdrawalPercentage": 0,
  "MvGender": "string"
}
				
			

Response

				
					200 OK
				
			
Share this Doc

Edit Beneficiary

Or copy link

CONTENTS
Antimanual

Ask our AI support assistant your questions about our platform, features, and services.

You are offline
Chatbot Avatar
What can I help you with?