---
title: "Retrives PaymentPlan Recipient by id"
method: GET
path: "/api/recipients/{paymentPlanRecipientId}"
tags: ["PaymentPlanRecipient"]
---

# Retrives PaymentPlan Recipient by id

`GET /api/recipients/{paymentPlanRecipientId}`

## Path parameters

- `paymentPlanRecipientId` integer, required

## Response `200`

OK

- IntectPaymentPlanRecipient
  - `PaymentMethod` IntectPaymentMethod
    - `RelevantCountries` IntectCountry[]
      - `IsSupported` boolean
      - `DefaultLanguageId` integer
      - `ReleaseNoteLink` string
      - `GetHelpOnlineLink` string
      - `OperatingStatus` string
      - `StaticDataId` integer
      - `Key` string
      - `Id` integer
      - `Name` string
      - `Description` string
      - `SortKey` string
    - `StaticDataId` integer
    - `Key` string
    - `Id` integer
    - `Name` string
    - `Description` string
    - `SortKey` string
  - `PaymentPlanType` IntectPaymentPlanType
    - `IsSystemPaymentPlanType` boolean
    - `RelevantCountries` IntectCountry[]
      - `IsSupported` boolean
      - `DefaultLanguageId` integer
      - `ReleaseNoteLink` string
      - `GetHelpOnlineLink` string
      - `OperatingStatus` string
      - `StaticDataId` integer
      - `Key` string
      - `Id` integer
      - `Name` string
      - `Description` string
      - `SortKey` string
    - `StaticDataId` integer
    - `Key` string
    - `Id` integer
    - `Name` string
    - `Description` string
    - `SortKey` string
  - `Id` integer
  - `Name` string
  - `PaymentPlanTypeId` integer
  - `VATRegistrationNumber` string
  - `TelFixed` string
  - `Email` string
  - `AddressId` integer
  - `IsSystemRecipient` boolean
  - `CountryId` integer, nullable
  - `CompanyId` integer, nullable
  - `AccountNumber` integer, nullable
  - `PaymentMethodId` integer
  - `ExternalIdentifier` string
  - `BasePaymentPlanRecipientId` integer, nullable
  - `KIDReference` string
  - `MainDeductionAmount` number, double, nullable
  - `MainDeductionShare` number, double, nullable
  - `MainDeductionAmountMin` number, double, nullable
  - `MainDeductionAmountMax` number, double, nullable
  - `AdditionalDeductionAmount` number, double, nullable
  - `AdditionalDeductionShare` number, double, nullable
  - `AdditionalDeductionAmountMin` number, double, nullable
  - `AdditionalDeductionAmountMax` number, double, nullable
  - `InsuranceDeductionAmount` number, double, nullable
  - `AdditionalDeductionAccountOverride` integer, nullable
  - `AdditionalDeductionKIDReferenceOverride` string
  - `InsuranceDeductionAccountOverride` integer, nullable
  - `InsuranceDeductionKIDReferenceOverride` string
  - `ERPReference` string
  - `AdditionalDeductionERPReferenceOverride` string
  - `InsuranceDeductionERPReferenceOverride` string
  - `Address` IntectAddress
    - `Id` integer
    - `Line1` string
    - `Line2` string
    - `PostalCode` string
    - `City` string
    - `CountryId` integer, nullable
    - `Created` string, date-time
    - `Updated` string, date-time
    - `Country` IntectCountry
      - `IsSupported` boolean
      - `DefaultLanguageId` integer
      - `ReleaseNoteLink` string
      - `GetHelpOnlineLink` string
      - `OperatingStatus` string
      - `StaticDataId` integer
      - `Key` string
      - `Id` integer
      - `Name` string
      - `Description` string
      - `SortKey` string
  - `Payments` IntectPayment[]
    - `DestinationCurrency` IntectCurrency
      - `StaticDataId` integer
      - `Key` string
      - `Id` integer
      - `Name` string
      - `Description` string
      - `SortKey` string
    - `Id` integer
    - `PaymentBatchId` integer, nullable
    - `DueDate` string, date-time, nullable
    - `PaymentDate` string, date-time, nullable
    - `SalaryBatchId` integer, nullable
    - `UserEmploymentId` integer, nullable
    - `SalaryStatementId` integer, nullable
    - `RecipientNetsNo` string
    - `RecipientBankRegNo` string
    - `RecipientBankAccountNo` string
    - `ReferenceIdentifier` string
    - `OwnReferenceText` string
    - `RecipientMessage` string
    - `NetsTransferType` integer, nullable
    - `NetsInfoType` integer, nullable
    - `AdditionalInfo` string
    - `CompanyId` integer
    - `Amount` number, double
    - `CompanyBankRegNo` string
    - `CompanyBankAccountNo` string
    - `UserIdentityNumber` string
    - `CollectiveAgreementCode` string
    - `RecipientName` string
    - `AutoDetermineBankAccount` boolean
    - `NovemberFirstBatchId` integer, nullable
    - `PaymentProviderId` integer
    - `RecipientIban` string
    - `RecipientBicSwift` string
    - `DestinationCurrencyId` integer, nullable
    - `PensionProviderId` integer, nullable
    - `ExternalPaymentPartnerId` integer, nullable
    - `PaymentTypeId` integer
    - `QuarterNumber` integer, nullable
    - `QuarterYear` integer, nullable
    - `PensionPolicyNumber` string
    - `PaymentPlanTypeId` integer, nullable
    - `PensionEmployeeShare` number, double, nullable
    - `PensionEmployeeShareAmount` number, double, nullable
    - `PensionCompanyShareAmount` number, double, nullable
    - `PensionCompanyShare` number, double, nullable
    - `PensionBaseAmount` number, double, nullable
    - `PensionVoluntaryShare` number, double, nullable
    - `PensionVoluntaryAmount` number, double, nullable
    - `NewFlexPensionAmount` number, double, nullable
    - `RecurringPaymentPlanId` integer, nullable
    - `Created` string, date-time
    - `Updated` string, date-time
    - `PaymentPlanRecipientId` integer, nullable
    - `KidNumber` string
    - `PaymentPlanRecipient` IntectPaymentPlanRecipient — recursive
  - `SalaryBatchRecords` IntectSalaryBatchRecord[]
    - `Id` integer
    - `SalaryTypeId` integer
    - `Amount` number, double
    - `Units` number, double, nullable
    - `Description` string
    - `CompanyUserId` integer
    - `UnitTypeId` integer, nullable
    - `UserEmploymentId` integer
    - `SalaryRecordId` integer, nullable
    - `SalaryBatchId` integer
    - `AmountPerUnit` number, double, nullable
    - `BaseAmount` number, double, nullable
    - `SalaryStatementId` integer, nullable
    - `IncludeInPayment` boolean
    - `EIncomeCategory` integer
    - `EIncomeSubCategory` integer
    - `SummaryCategoryId` integer, nullable
    - `PeriodFactor` number, double, nullable
    - `FromDate` string, date-time, nullable
    - `ToDate` string, date-time, nullable
    - `SortOrder` integer
    - `SpecialIdentifier` string
    - `BaseSalaryTypeId` integer, nullable
    - `ExternalReferenceSalaryType` string
    - `ExternalReferenceEmployee` string
    - `ExternalReferenceDepartment` string
    - `InformationOnly` boolean
    - `Dimension1Value` string
    - `Dimension2Value` string
    - `Dimension3Value` string
    - `SulinalFieldNumber` string
    - `IsReportableIncome` boolean
    - `SkatteverketAgiFieldCode` integer, nullable
    - `LegacyFlexEarningPercentage` number, double, nullable
    - `NewFlexEarningPercentage` number, double, nullable
    - `PensionPercentage` number, double, nullable
    - `DisplayDates` boolean
    - `Dimension1ValueId` integer, nullable
    - `Dimension2ValueId` integer, nullable
    - `Dimension3ValueId` integer, nullable
    - `PensionPercentageEmployee` number, double, nullable
    - `IsBaseSalary` boolean
    - `TriggersSecondaryEmployeeTax` boolean
    - `TriggersMainEmployeeTax` boolean
    - `TriggersPublicPension` boolean
    - `TriggersPrimaryVacation` boolean
    - `HideOnPayslip` boolean
    - `Formula1Expression` string
    - `EvaluatedFormula1Expression` string
    - `Formula2Expression` string
    - `EvaluatedFormula2Expression` string
    - `Formula3Expression` string
    - `EvaluatedFormula3Expression` string
    - `DeductionRecurringPaymentPlanId` integer, nullable
    - `PaymentPlanRecipientId` integer, nullable
    - `PaymentPlanRecipient` IntectPaymentPlanRecipient — recursive

---

[API](https://skmtc.dev/intect/apis/intect-rest-api.md) · [All operations](https://skmtc.dev/intect/apis/intect-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/intect/intect-rest-api/revisions/e256dcb495d4/schema)