Service for handling debtor access.

AddPowerOfAttorney

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();
ResultType result = client.AddPowerOfAttorney(
    new AddPowerOfAttorneyRequest{
       GeneralForDebtor = false,
       UseExistingPartyGuid = "A4287D2A-F16C-4C38-A6E6-9F307626204D",
       PowerOfAttorneyParty = new PowerOfAttorneyParty {
          CultureCode = "CultureCode",
          Fullname = "Fullname",
          Email = "Email",
          CellularPhone = "CellularPhone",
          IdNumber = "IdNumber",
          LanguageCode = "En",
          Telefax = "Telefax",
          WorkPhone = "WorkPhone",
          Addresses = new List<Address>().ToArray(),
          ExtraFields = new List<ExtraField>().ToArray()
       },
       Cases = new List<CaseLookup>().ToArray()
    });

Sample soap request:

 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
       <urn:AddPowerOfAttorney>
          <urn:Request>
             <urn:GeneralForDebtor>true</urn:GeneralForDebtor>
             <urn:PowerOfAttorneyParty>
                <!--Optional:-->
                <urn:CellularPhone>1</urn:CellularPhone>
                <!--Optional:-->
                <urn:CultureCode>sv-FI</urn:CultureCode>
                <!--Optional:-->
                <urn:Email></urn:Email>
                <!--Optional:-->
                <urn:ExtraFields>
                   <!--Zero or more repetitions:-->
                   <urn:ExtraField>
                     <!--Optional:-->
                     <urn:Data>testdata</urn:Data>
                     <!--Optional:-->
                     <urn:Name>klientmappning</urn:Name>
                  </urn:ExtraField>
               </urn:ExtraFields>
               <!--Optional:-->
               <urn:Fullname>Fullname121</urn:Fullname>
               <!--Optional:-->
               <urn:IdNumber>9890982</urn:IdNumber>
               <!--Optional:-->
               <urn:LanguageCode>en</urn:LanguageCode>
               <!--Optional:-->
               <urn:Telefax></urn:Telefax>
               <!--Optional:-->
               <urn:WorkPhone></urn:WorkPhone>
            </urn:PowerOfAttorneyParty>
            <urn:UseExistingPartyGuid></urn:UseExistingPartyGuid>
         </urn:Request>
      </urn:AddPowerOfAttorney>
   </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
AddPowerOfAttorney

AddPowerOfAttorney
- Request
  
  Add power of attorney parameters.
  Object
  
  AddPowerOfAttorneyRequest
  
  General class for representing method input.
  
  Cases
  
  Information to find case(s) to make relation
  
  Array
  
  Object
  
  CaseLookup
  
  The way to find a collection case in DB by several predefined criteria.
  
  CaseIdentification Mandatory
  
  Collection case identification type.
  
  Enum
  
  CaseIdentificationType
  
  Collection case identification type.
  
  CaseGuid
  
  Case GUID identification.
  
  CaseNumber
  
  Case number.
  
  AccountReferenceNumber
  
  Account reference number provided by the client.
  
  InvoiceNumber
  
  Invoice number of one on the debts provided by the client.
  
  PaymentReferenceNumber
  
  Payment reference number (OCR).
  
  CustomerNo
  
  Customer number for the debtor at the creditor side.
  
  CaseIdentificationValue Mandatory
  
  Identification value corresponding to identification type.
  
  string
  
  GeneralForDebtor Mandatory
  
  If 'true' - relation should be added for debtor, 'false' - relation should be added for cases
  
  bool
  
  PowerOfAttorneyParty
  
  New party should be created in accordance with data in this structure
  
  Object
  
  PowerOfAttorneyPartyAdd
  
  Detailed information about POA party.
  
  Addresses
  
  List Addresses of party.
  
  Array
  
  Object
  
  Address
  
  Holds address information.
  
  CareOf
  
  Care of address.
  
  string
  
  City
  
  City.
  
  string
  
  CountryCode
  
  Country code, i.e. EN, SE etc.
  
  string
  
  DefaultAddress
  
  Whether this is the default address.
  
  bool
  
  FullAddress
  
  Combined address with all fields into single string.
  
  string
  
  FullName
  
  The full name of the receiving party, i.e name of person or company.
  
  string
  
  HouseNo
  
  House number.
  
  string
  
  HouseNoExtension
  
  House number extension.
  
  string
  
  StateCode
  
  State code if applicable.
  
  string
  
  Street
  
  Street address.
  
  string
  
  TypeCode Mandatory
  
  The type code of the address, i.e. what the address is used for, e.g. LEGAL, AVI, INVOICE, SITE, DELIVERY, TRUSTACCNT. Should be used one of predefined values using correct letter case.
  
  string
  
  UpdateExisting
  
  Whether this should update existing or create new address.
  
  bool
  
  ValidFrom
  
  The date when the address becomes active. If the element is missing, then do not change the current actual value.
  
  DateTime
  
  ValidTo
  
  The date after which the address becomes inactive. If the element is missing, then do not change the current actual value.
  
  DateTime
  
  ZipCode
  
  Zip code, i.e. postal code.
  
  string
  
  CellularPhone Mandatory
  
  Cellular phone of party
  
  string
  
  CultureCode
  
  Culture code of party
  
  string
  
  Email Mandatory
  
  Email of party
  
  string
  
  ExtraFields
  
  List extrafields of party.
  
  Array
  
  Object
  
  ExtraField
  
  Extra field contains custom data.
  
  Data
  
  Value of extra field.
  
  string
  
  Name
  
  Name of extra field.
  
  string
  
  Fullname Mandatory
  
  Full name of party
  
  string
  
  IdNumber Mandatory
  
  ID number of party.
  
  string
  
  LanguageCode Mandatory
  
  Language code of party
  
  string
  
  Telefax Mandatory
  
  Telefax of party
  
  string
  
  WorkPhone Mandatory
  
  Work phone of party
  
  string
  
  UseExistingPartyGuid
  
  Use existing party guid for adding relation. If this value is empty, new party is created
  
  string

Output

Result code 0 if booking is successful.
Error codes:

1: generic error message from ARC server

Object

AddPowerOfAttorneyResult

Result of AddPowerOfAttorney
Object
ResultType

Common result type.
- ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
- ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

AddUpdateConversationNotificationDetails

Return debtors payments details

Examples

Sample usage in C# with generated client:

 void UpdateConversationNotification()
{
   DebtorAccessClient client = new DebtorAccessClient();
   DebtorHeader debtorHeader = new DebtorHeader();
   SessionHeader sessionHeader = new SessionHeader();
   UpdateConversationNotificationRequest updateConversationNotificationRequest = new UpdateConversationNotificationRequest { ConversationNotificationChannel = ConversationNotificationChannel1.None };
   ResponseSessionHeader responseSessionHeader = new ResponseSessionHeader();
   ResultType resultType = new ResultType();
   client.AddUpdateConversationNotificationDetails(debtorHeader, sessionHeader, updateConversationNotificationRequest, out responseSessionHeader, out resultType);
 }

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
<soapenv:Body>
  <urn:UpdateConversationNotification>
    <urn:UpdateConversationNotificationRequest>
    <urn:ConversationNotificationChannel>EMAIL</urn:ConversationNotificationChannel>
    <!--Optional:-->
    <urn:Email>testemail @test.com</urn:Email>
    </urn:UpdateConversationNotificationRequest>
  </urn:UpdateConversationNotification>
   </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
UpdateConversationNotification

UpdateConversationNotification
- UpdateConversationNotificationRequest
  
  UpdateConversationNotification request
  Object
  
  UpdateConversationNotificationRequest
  
  General class for representing method input.
  
  CellularPhone
  
  If preferred way of notification is SMS - contains cellular phone number to notify debtor
  
  string
  
  ConversationNotificationChannel Mandatory
  
  Debtor's preferred conversation notification channel. Should be NONE, EMAIL, SMS or Both
  
  Enum
  
  ConversationNotificationChannel
  
  Type of person, juridically.
  
  None
  
  None.
  
  SMS
  
  SMS
  
  Email
  
  Email
  
  Both
  
  Both - SMS and Email
  
  DataProvision
  
  Dataprivision
  
  Object
  
  DataProvision
  
  Holds data provision details.
  
  Code Mandatory
  
  Data provision code.
  
  string
  
  Text
  
  Data provision text.
  
  string
  
  Version
  
  Data provision version.
  
  string
  
  Email
  
  If preferred way of notification is EMAIL - contains e-mail address to notify debtor
  
  string

Output

On success ResultCode = 0 and Payments collection of related payments On failure ResultCode = 1 and user readable error message

Object

UpdateConversationNotificationResult

Result of UpdateConversationNotification
Object
ResultType

Common result type.
- ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
- ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

BookPaymentReservation

Books payment reservation on bank account which should be confirmed by bank payment import file later.

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();

ResultType result = client.BookPaymentReservation(
    new BookPaymentReservationRequest {
        CaseLookups = new List<CaseLookup> {
            new CaseLookup { CaseIdentification = CaseIdentificationType.CaseGuid, CaseIdentificationValue = "4F9936C3-E67C-4E43-9313-7EB3B529F21E" }
        }.ToArray(),
        CurrencyCode = "SEK",
        PSPCode = "TestPSPCode",
        ReservationAmount = 2000m,
        ReservationNumber = "2018012203",
        Source = "TestSource"
    }
);

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:BookPaymentReservation>
            <urn:BookPaymentReservationRequest>
                <urn:CaseLookups>
                    <urn:CaseLookup>
                        <urn:CaseIdentification>CaseGuid</urn:CaseIdentification>
                        <urn:CaseIdentificationValue>4F9936C3-E67C-4E43-9313-7EB3B529F21E</urn:CaseIdentificationValue>
                    </urn:CaseLookup>
                </urn:CaseLookups>
                <urn:CurrencyCode>SEK</urn:CurrencyCode>
                <urn:PSPCode>TestPSPCode</urn:PSPCode>
                <urn:ReservationAmount>2000</urn:ReservationAmount>
                <urn:ReservationNumber>2018012203</urn:ReservationNumber>
                <urn:Source>TestSource</urn:Source>
            </urn:BookPaymentReservationRequest>
        </urn:BookPaymentReservation>
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
BookPaymentReservation

BookPaymentReservation
- BookPaymentReservationRequest
  
  Collection case and booking identification parameters.
  Object
  
  BookPaymentReservationRequest
  
  General class for representing method input.
  
  CaseLookups
  
  Information to find case(s) to book payment for
  
  Array
  
  Object
  
  CaseLookup
  
  The way to find a collection case in DB by several predefined criteria.
  
  CaseIdentification Mandatory
  
  Collection case identification type.
  
  Enum
  
  CaseIdentificationType
  
  Collection case identification type.
  
  CaseGuid
  
  Case GUID identification.
  
  CaseNumber
  
  Case number.
  
  AccountReferenceNumber
  
  Account reference number provided by the client.
  
  InvoiceNumber
  
  Invoice number of one on the debts provided by the client.
  
  PaymentReferenceNumber
  
  Payment reference number (OCR).
  
  CustomerNo
  
  Customer number for the debtor at the creditor side.
  
  CaseIdentificationValue Mandatory
  
  Identification value corresponding to identification type.
  
  string
  
  CurrencyCode Mandatory
  
  Currency of payment
  
  string
  
  DeductionOrder
  
  Deduction order to be specified in payment booking
  
  string
  
  PaymentReference
  
  Payment reference to be used to find case to book payment for
  
  string
  
  PSPCode Mandatory
  
  Payment service provider code to be used to match bankaccount
  
  string
  
  ReservationAmount Mandatory
  
  Amount to book
  
  decimal
  
  ReservationNumber Mandatory
  
  Reservation number which will be provided in cnfirmation
  
  string
  
  Source Mandatory
  
  Source to be specified in payment booking
  
  string

Output

Result code 0 if booking is successful.
Error codes:

1: generic error message from ARC server
2: invalid arguments error message from ARC server
30700: selected cases missing or invalid
40000: bank account missing or invalid
70001: booking init failed
70002: booking calculation failed

Object

BookPaymentReservationResult

Result of BookPaymentReservation
Object
ResultType

Common result type.
- ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
- ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

CalculateInstalmentPlan

Calculates instalment plan for collection case(s) of authenticated debtor.

Supply collection case(s) for authenticated debtor and at least one of two parameters: MonthlyAmount or NumberOfInstalments

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();

CalculateCollectionInstalmentPlan result = client.CalculateInstalmentPlan(
    new CalculateInstalmentPlanRequest {
       InstalmentPlanConditions = new CollectionInstalmentPlan {
          Cases = new List<CaseLookup> {
             new CaseLookup { CaseIdentification = CaseIdentificationType.CaseNumber, CaseIdentificationValue = "36168" }
          }.ToArray(),
          NumberOfInstalments = 23,
          FirstPayment = new DateTime(2019,12,20),
          InstalmentFeeAmount = 50.0m,
          PayDay = 2,
          IntervalType = CollectionIntervalType.DayInMonth,
          PaymentPlanType = CollectionPaymentPlanType.Annuity,
          RegistrationFeeAmount = 60.0m
       }
    }
);

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:CalculateInstalmentPlan>
            <urn:CalculateInstalmentPlanRequest>
                <urn:InstalmentPlanConditions>
                    <urn:Cases>
                        <urn:CaseLookup>
                            <urn:CaseIdentification>CaseNumber</urn:CaseIdentification>
                            <urn:CaseIdentificationValue>36168</urn:CaseIdentificationValue>
                        </urn:CaseLookup>
                    </urn:Cases>
                    <urn:FirstPayment>2019-09-20</urn:FirstPayment>
                    <urn:InstalmentFeeAmount>50</urn:InstalmentFeeAmount>
                    <urn:Interval>2</urn:Interval>
                    <urn:IntervalType>DayInMonth</urn:IntervalType>
                    <urn:NumberOfInstalments>23</urn:NumberOfInstalments>
                    <urn:PayDay>1</urn:PayDay>
                    <urn:PaymentPlanType>Annuity</urn:PaymentPlanType>
                    <urn:RegistrationFeeAmount>60</urn:RegistrationFeeAmount>
                </urn:InstalmentPlanConditions>
            </urn:CalculateInstalmentPlanRequest>
        </urn:CalculateInstalmentPlan>
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
CalculateInstalmentPlan

CalculateInstalmentPlan
- CalculateInstalmentPlanRequest
  
  Instalment plan identification parameters.
  Object
  
  CalculateInstalmentPlanRequest
  
  General class for representing method input.
  
  InstalmentPlanConditions Mandatory
  
  Holds information about instalment plan conditions.
  
  Object
  
  CollectionInstalmentPlan
  
  Holds information about instalment plan conditions.
  
  Cases
  
  List of lookups to collection cases.
  
  Array
  
  Object
  
  CaseLookup
  
  The way to find a collection case in DB by several predefined criteria.
  
  CaseIdentification Mandatory
  
  Collection case identification type.
  
  Enum
  
  CaseIdentificationType
  
  Collection case identification type.
  
  CaseGuid
  
  Case GUID identification.
  
  CaseNumber
  
  Case number.
  
  AccountReferenceNumber
  
  Account reference number provided by the client.
  
  InvoiceNumber
  
  Invoice number of one on the debts provided by the client.
  
  PaymentReferenceNumber
  
  Payment reference number (OCR).
  
  CustomerNo
  
  Customer number for the debtor at the creditor side.
  
  CaseIdentificationValue Mandatory
  
  Identification value corresponding to identification type.
  
  string
  
  FirstPayment
  
  First payment date.
  
  DateTime
  
  InstalmentFeeAmount
  
  Instalment fee amount.
  
  decimal
  
  Interval
  
  Interval.
  
  int
  
  IntervalType
  
  Interval type
  
  Enum
  
  CollectionIntervalType
  
  Payment plan interval type.
  
  DayInMonth
  
  Day in month payment period
  
  LastDayInMonth
  
  Last day in month payment period
  
  Monthly
  
  Monthly payment period
  
  Days
  
  Days payment period
  
  OneTime
  
  One time payment period
  
  MonthlyAmount
  
  Monthly amount.
  
  decimal
  
  NumberOfInstalments
  
  Number of instalments.
  
  int
  
  PayDay
  
  Payday.
  
  int
  
  PaymentPlanType
  
  Payment plan type.
  
  Enum
  
  CollectionPaymentPlanType
  
  Payment plan type.
  
  Annuity
  
  Annuity
  
  AnnuityLimited
  
  Annuity, limited
  
  Flat
  
  Flat
  
  FlatLimited
  
  Flat, limited
  
  RegistrationFeeAmount
  
  Registration fee amount.
  
  decimal

Output

Calculate instalment plan details, if calculated.
Error codes:

1: unknown error or error message from ARC server

Object

CalculateInstalmentPlanResult

Result of CalculateInstalmentPlan
Object
CalculateCollectionInstalmentPlan

Calculate collection instalment plan description.
- AnnualPercentageRate
  
  Annual percentage rate.
  
  decimal
- InstalmentFeeAmount
  
  Instalment fee amount.
  
  decimal
- MonthlyAmount
  
  Monthly amount.
  
  decimal
- NumberOfInstalments
  
  Number of instalments.
  
  int
- RegistrationFeeAmount
  
  Registration fee amount.
  
  decimal
- Result
  
  The result of the request. Indicating success or error.
  Object
  
  ResultType
  
  Common result type.
  
  ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
  
  ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string
- TotalAmountToPay
  
  Total amount to pay.
  
  decimal
- TotalFeeToPay
  
  Total fee to pay.
  
  decimal
- TotalImportedFeeToPay
  
  Total imported fee to pay.
  
  decimal
- TotalInterestToPay
  
  Total interest to pay.
  
  decimal
- TotalPrincipalToPay
  
  Total principal to pay.
  
  decimal

CloseConversation

Closes a conversation for authenticated debtor.

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();

ResultType result = client.CloseConversation(
    new CloseConversationRequest {
        ConversationGuid = "A4287D2A-F16C-4C38-A6E6-9F307626204D"
    }
);

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:CloseConversation>
            <urn:CloseConversationRequest>
                <urn:ConversationGuid>A4287D2A-F16C-4C38-A6E6-9F307626204D</urn:ConversationGuid>
            </urn:CloseConversationRequest>
        </urn:CloseConversation>
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
CloseConversation

CloseConversation
- CloseConversationRequest
  
  Conversation identification parameters.
  Object
  
  CloseConversationRequest
  
  General class for representing method input.
  
  ConversationGuid Mandatory
  
  Conversation unique identifier.
  
  string

Output

Returns result code 0 if conversation is closed
Error codes:

1: unknown error or error message from ARC server

Object

CloseConversationResult

Result of CloseConversation
Object
ResultType

Common result type.
- ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
- ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

CreateCollectionConversation

Creates a collection case conversation for authenticated debtor.

Supply either CaseLookup or DebtorLookup to identify the collection case where the conversation is started on.

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();

CreateConversationResult result = client.CreateCollectionConversation(
    new CreateCollectionConversationRequest {
        Subject = "Let's discuss collection case",
        CaseLookup = new CaseLookup { CaseIdentification = CaseIdentificationType.CaseNumber, CaseIdentificationValue = "7" }
    }
);

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:CreateCollectionConversation>
            <urn:CreateCollectionConversationRequest>
                <urn:CaseLookup>
                    <urn:CaseIdentification>CaseNumber</urn:CaseIdentification>
                    <urn:CaseIdentificationValue>7</urn:CaseIdentificationValue>
                </urn:CaseLookup>
                <urn:Subject>Let's discuss collection case</urn:Subject>
            </urn:CreateCollectionConversationRequest>
        </urn:CreateCollectionConversation>
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
CreateCollectionConversation

CreateCollectionConversation
- CreateCollectionConversationRequest
  
  Collection case and conversation identification parameters.
  Object
  
  CreateCollectionConversationRequest
  
  General class for representing method input.
  
  CaseLookup Mandatory
  
  Information to lookup collection case(s).
  
  Object
  
  CaseLookup
  
  The way to find a collection case in DB by several predefined criteria.
  
  CaseIdentification Mandatory
  
  Collection case identification type.
  
  Enum
  
  CaseIdentificationType
  
  Collection case identification type.
  
  CaseGuid
  
  Case GUID identification.
  
  CaseNumber
  
  Case number.
  
  AccountReferenceNumber
  
  Account reference number provided by the client.
  
  InvoiceNumber
  
  Invoice number of one on the debts provided by the client.
  
  PaymentReferenceNumber
  
  Payment reference number (OCR).
  
  CustomerNo
  
  Customer number for the debtor at the creditor side.
  
  CaseIdentificationValue Mandatory
  
  Identification value corresponding to identification type.
  
  string
  
  Subject Mandatory
  
  Conversation subject.
  
  string

Output

Unique identifier of the inserted conversation.
Error codes:

1: unknown error or error message from ARC server

Object

CreateCollectionConversationResult

Result of CreateCollectionConversation
Object
CreateConversationResult

General class for representing method output.
- Result
  
  The result of the request. Indicating success or error.
  Object
  
  ResultType
  
  Common result type.
  
  ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
  
  ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string
- ThreadGuid
  
  Topic unique identifier.
  
  string

CreateInstalmentPlan

Creates instalment plan for collection case(s) of authenticated debtor.

Supply collection case(s) for authenticated debtor and at least one of two parameters: MonthlyAmount or NumberOfInstalments

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();

CalculateCollectionInstalmentPlan result = client.CreateInstalmentPlan(
    new CreateInstalmentPlanRequest {
       InstalmentPlanConditions = new CollectionInstalmentPlan {
          Cases = new List<CaseLookup> {
             new CaseLookup { CaseIdentification = CaseIdentificationType.CaseNumber, CaseIdentificationValue = "36168" }
          }.ToArray(),
          MonthlyAmount = 543.2m,
          FirstPayment = new DateTime(2019,12,20),
          InstalmentFeeAmount = 50.0m,
          PayDay = 2,
          IntervalType = CollectionIntervalType.DayInMonth,
          PaymentPlanType = CollectionPaymentPlanType.Annuity,
          RegistrationFeeAmount = 60.0m
       }
    }
);

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:CreateInstalmentPlan>
            <urn:CreateInstalmentPlanRequest>
                <urn:InstalmentPlanConditions>
                    <urn:Cases>
                        <urn:CaseLookup>
                            <urn:CaseIdentification>CaseNumber</urn:CaseIdentification>
                            <urn:CaseIdentificationValue>36168</urn:CaseIdentificationValue>
                        </urn:CaseLookup>
                    </urn:Cases>
                    <urn:FirstPayment>2019-09-20</urn:FirstPayment>
                    <urn:InstalmentFeeAmount>50</urn:InstalmentFeeAmount>
                    <urn:Interval>2</urn:Interval>
                    <urn:IntervalType>DayInMonth</urn:IntervalType>
                    <urn:MonthlyAmount>543.2</urn:MonthlyAmount>
                    <urn:PayDay>1</urn:PayDay>
                    <urn:PaymentPlanType>Annuity</urn:PaymentPlanType>
                    <urn:RegistrationFeeAmount>60</urn:RegistrationFeeAmount>
                </urn:InstalmentPlanConditions>
            </urn:CreateInstalmentPlanRequest>
        </urn:CreateInstalmentPlan>
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
CreateInstalmentPlan

CreateInstalmentPlan
- CreateInstalmentPlanRequest
  
  Instalment plan identification parameters.
  Object
  
  CreateInstalmentPlanRequest
  
  General class for representing method input.
  
  CreateAsProposal
  
  Should instalment plan be created as a proposal.
  
  bool
  
  InstalmentPlanConditions Mandatory
  
  Holds information about instalment plan conditions.
  
  Object
  
  CollectionInstalmentPlan
  
  Holds information about instalment plan conditions.
  
  Cases
  
  List of lookups to collection cases.
  
  Array
  
  Object
  
  CaseLookup
  
  The way to find a collection case in DB by several predefined criteria.
  
  CaseIdentification Mandatory
  
  Collection case identification type.
  
  Enum
  
  CaseIdentificationType
  
  Collection case identification type.
  
  CaseGuid
  
  Case GUID identification.
  
  CaseNumber
  
  Case number.
  
  AccountReferenceNumber
  
  Account reference number provided by the client.
  
  InvoiceNumber
  
  Invoice number of one on the debts provided by the client.
  
  PaymentReferenceNumber
  
  Payment reference number (OCR).
  
  CustomerNo
  
  Customer number for the debtor at the creditor side.
  
  CaseIdentificationValue Mandatory
  
  Identification value corresponding to identification type.
  
  string
  
  FirstPayment
  
  First payment date.
  
  DateTime
  
  InstalmentFeeAmount
  
  Instalment fee amount.
  
  decimal
  
  Interval
  
  Interval.
  
  int
  
  IntervalType
  
  Interval type
  
  Enum
  
  CollectionIntervalType
  
  Payment plan interval type.
  
  DayInMonth
  
  Day in month payment period
  
  LastDayInMonth
  
  Last day in month payment period
  
  Monthly
  
  Monthly payment period
  
  Days
  
  Days payment period
  
  OneTime
  
  One time payment period
  
  MonthlyAmount
  
  Monthly amount.
  
  decimal
  
  NumberOfInstalments
  
  Number of instalments.
  
  int
  
  PayDay
  
  Payday.
  
  int
  
  PaymentPlanType
  
  Payment plan type.
  
  Enum
  
  CollectionPaymentPlanType
  
  Payment plan type.
  
  Annuity
  
  Annuity
  
  AnnuityLimited
  
  Annuity, limited
  
  Flat
  
  Flat
  
  FlatLimited
  
  Flat, limited
  
  RegistrationFeeAmount
  
  Registration fee amount.
  
  decimal

Output

The instalment plan details, if created.
Error codes:

1: unknown error or error message from ARC server

Object

CreateInstalmentPlanResult

Result of CreateInstalmentPlan
Object
CalculateCollectionInstalmentPlan

Calculate collection instalment plan description.
- AnnualPercentageRate
  
  Annual percentage rate.
  
  decimal
- InstalmentFeeAmount
  
  Instalment fee amount.
  
  decimal
- MonthlyAmount
  
  Monthly amount.
  
  decimal
- NumberOfInstalments
  
  Number of instalments.
  
  int
- RegistrationFeeAmount
  
  Registration fee amount.
  
  decimal
- Result
  
  The result of the request. Indicating success or error.
  Object
  
  ResultType
  
  Common result type.
  
  ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
  
  ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string
- TotalAmountToPay
  
  Total amount to pay.
  
  decimal
- TotalFeeToPay
  
  Total fee to pay.
  
  decimal
- TotalImportedFeeToPay
  
  Total imported fee to pay.
  
  decimal
- TotalInterestToPay
  
  Total interest to pay.
  
  decimal
- TotalPrincipalToPay
  
  Total principal to pay.
  
  decimal

CustomAction

Invokes a custom action based on a service definition.

Execute custom service definition in ARC with possibility to pass in XML into definition. The given service definition must belong to "rpcfunction" category.

Examples

Sample usage in C# generated client:

DebtorAccessClient client = new DebtorAccessClient();

CustomActionResult result = client.CustomAction(new InvokeServiceDefinitionRequest
{
    AsyncCall = false,
    InputXml = @"<?xml version=""1.0"" encoding=""ISO-8859-1"" standalone=""no"" ?>
<data>
    <value>12</value>
</data>",
    ServiceDefinitionName = "your_service_definition"
});

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:CustomAction>
            <urn:serviceDefinition>
                <urn:AsyncCall>false</urn:AsyncCall>
                <urn:InputXml><![CDATA[<?xml version="1.0" encoding="ISO-8859-1" standalone="no" ?>
                    <data>
                        <value>en</value>
                    </data>
                ]]></urn:InputXml>
                <urn:ServiceDefinitionName>your_service_definition</urn:ServiceDefinitionName>
            </urn:serviceDefinition>
        </urn:CustomAction>
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
CustomAction

CustomAction
- serviceDefinition
  
  The invoke service definition request.
  Object
  
  InvokeServiceDefinitionRequest
  
  A request for invoking a service definition.
  
  AsyncCall
  
  Whether service definition invocation is asynchronous or not, i.e. fire and forget. When true the result CData is not collected. Default value is false.
  
  bool
  
  Input
  
  An XML structure used for input into service definition call.
  
  XmlElement
  
  InputXml
  
  An XML string used for input into service definition call.
  
  string
  
  ServiceDefinitionName Mandatory
  
  Name of the service definition to invoke.
  
  string

Output

The result from service definiton invocation CData.
Error codes:

30601: General service definition error
30602: Service definition does not exist
30603: Service definition input values error
30604: Custom error

Object

CustomActionResult

Result of CustomAction
Object
CustomActionResult

The result for a custom action, i.e. a service definition call.
- CData
  
  Raw CData from service definition response.
  
  XmlElement
- Result
  
  The result of the request. Indicating success or error.
  Object
  
  ResultType
  
  Common result type.
  
  ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
  
  ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

DeleteConversationMessage

Deletes a conversation message from authenticated debtor. If all conversation messages are deleted - conversation is closed automatically

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();

ResultType result = client.DeleteConversationMessage(
    new DeleteConversationMessageRequest {
        MessageGuid = "A4287D2A-F16C-4C38-A6E6-9F307626204D"
    }
);

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:DeleteConversationMessage>
            <urn:DeleteConversationMessageRequest>
                <urn:MessageGuid>A4287D2A-F16C-4C38-A6E6-9F307626204D</urn:MessageGuid>
            </urn:DeleteConversationMessageRequest>
        </urn:DeleteConversationMessage>
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
DeleteConversationMessage

DeleteConversationMessage
- DeleteConversationMessageRequest
  
  Message identification parameters.
  Object
  
  DeleteConversationMessageRequest
  
  General class for representing method input.
  
  MessageGuid Mandatory
  
  Message unique identifier.
  
  string

Output

Unique identifier of the inserted message.
Error codes:

1: unknown error or error message from ARC server

Object

DeleteConversationMessageResult

Result of DeleteConversationMessage
Object
ResultType

Common result type.
- ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
- ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

DeletePowerOfAttorney

Deletes all records from dat_relation with corresponding partyid. After that deletes corresponding partyid.

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();

ResultType result = client.DeletePowerOfAttorney(
    new DeletePowerOfAttorneyRequest {
        PowerOfAttorneyPartyGuid = "A4287D2A-F16C-4C38-A6E6-9F307626204D"
    }
);

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:DeletePowerOfAttorney>
            <urn:DeletePowerOfAttorneyRequest>
                <urn:PowerOfAttorneyPartyGuid>A4287D2A-F16C-4C38-A6E6-9F307626204D</urn:PowerOfAttorneyPartyGuid>
            </urn:DeletePowerOfAttorneyRequest>
        </urn:DeletePowerOfAttorney>
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
DeletePowerOfAttorney

DeletePowerOfAttorney
- Request
  
  Delete power of attorney parameters.
  Object
  
  DeletePowerOfAttorneyRequest
  
  General class for representing method input.
  
  PowerOfAttorneyPartyGuid Mandatory
  
  Power of attorney party unique identifier.
  
  string

Output

Return code 0 if limitation date has been updated.
Error codes:

1: unknown error or error message from ARC server

Object

DeletePowerOfAttorneyResult

Result of DeletePowerOfAttorney
Object
ResultType

Common result type.
- ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
- ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

EstablishSession

Establishes a session for authenticated communication between debtor and server.

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();

EstablishSessionResult result = client.EstablishSession(
    new EstablishSessionRequest {
        DebtorLookup = new DebtorLookup { DebtorIdentification = DebtorIdentificationType.DebtorSESSNOrCompanyNo, DebtorIdentificationValue = "1212121212" },
        StrongAuthentication = null,
        LanguageCode = null,
        IPNumber = null,
        ClientReferenceFilter = null
    }
);

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:EstablishSession>
            <urn:EstablishSessionRequest>
                <urn:DebtorLookup>
                    <urn:DebtorIdentification>DebtorSESSNOrCompanyNo</urn:DebtorIdentification>
                    <urn:DebtorIdentificationValue>1212121212</urn:DebtorIdentificationValue>
                </urn:DebtorLookup>
            </urn:EstablishSessionRequest>
        </urn:EstablishSession>
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
EstablishSession

EstablishSession
- EstablishSessionRequest
  
  Debtor identification parameters.
  Object
  
  EstablishSessionRequest
  
  General class for representing method input.
  
  ClientReferenceFilter
  
  Party reference code.
  
  string
  
  DebtorLookup Mandatory
  
  Information to lookup debtor(s).
  
  Object
  
  DebtorLookup
  
  The way to find a debtor in DB by several predefined criteria.
  
  DebtorIdentification Mandatory
  
  Debtor identification type.
  
  Enum
  
  DebtorIdentificationType
  
  Debtor identification type.
  
  Custom
  
  Custom identification. NOT SUPPORTED.
  
  DebtorSESSNOrCompanyNo
  
  Identify by Swedish SSN or company number.
  
  DebtorNOSSNOrCompanyNo
  
  Identify by Norweigan SSN or company number.
  
  DebtorReferenceNumber
  
  Identify by debtor/client reference number.
  
  DebtorGuid
  
  Debtor identification.
  
  CustomerNo
  
  Customer number for the debtor at the creditor side. NOT SUPPORTED in DebtorAccess.EstablishSession.
  
  DebtorFISSNOrCompanyNo
  
  Identify by Finnish SSN or company number.
  
  DebtorIdentificationValue Mandatory
  
  Identification value corresponding to identification type.
  
  string
  
  IPNumber
  
  IP number, needed for bank ID authentication and some other types.
  
  string
  
  LanguageCode
  
  Language code.
  
  string
  
  PowerOfAttorneyLookup
  
  Information to lookup power of attorney.
  
  Object
  
  PowerOfAttorneyLookup
  
  The way to find a debtor in DB by several predefined criteria.
  
  PowerOfAttrneyIdentification Mandatory
  
  Debtor identification type.
  
  Enum
  
  PowerOfAttrneyIdentificationType
  
  Party of attorney identification type.
  
  PartySESSNOrCompanyNo
  
  Identify by Swedish SSN or company number.
  
  PartyNOSSNOrCompanyNo
  
  Identify by Norweigan SSN or company number.
  
  PartyReferenceNumber
  
  Identify by party reference number.
  
  PartyGuid
  
  Party identification.
  
  PartyFISSNOrCompanyNo
  
  Identify by Finnish SSN or company number.
  
  PowerOfAttrneyIdentificationValue Mandatory
  
  Identification value corresponding to identification type.
  
  string
  
  StrongAuthentication
  
  Strong authentication request needed, list of debtors not created.
  
  bool

Output

Session credentials to be used for any authenticated request from a debtor.
Error codes:

1: generic hard-coded message

Object

EstablishSessionResult

Result of EstablishSession
Object
EstablishSessionResult

General class for representing method output.
- Result
  
  The result of the request. Indicating success or error.
  Object
  
  ResultType
  
  Common result type.
  
  ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
  
  ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string
- SessionPassword
  
  Authenticated user's password.
  
  string
- SessionUsername
  
  Authenticated user's name.
  
  string

GetCaseDetails

Returns collection case detailed information.

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();

GetCaseDetailsResult result = client.GetCaseDetails(
    new CaseLookup { CaseIdentification = CaseIdentificationType.CustomerNo, CaseIdentificationValue = "41708" }
);

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetCaseDetails>
         <urn:CaseLookup>
           <urn:CaseIdentification>CaseNumber</urn:CaseIdentification>
            <urn:CaseIdentificationValue>41708</urn:CaseIdentificationValue>
         </urn:CaseLookup>
      </urn:GetCaseDetails>
   </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
GetCaseDetails

GetCaseDetails
- CaseLookup
  
  Information to lookup case.
  Object
  
  CaseLookup
  
  The way to find a collection case in DB by several predefined criteria.
  
  CaseIdentification Mandatory
  
  Collection case identification type.
  
  Enum
  
  CaseIdentificationType
  
  Collection case identification type.
  
  CaseGuid
  
  Case GUID identification.
  
  CaseNumber
  
  Case number.
  
  AccountReferenceNumber
  
  Account reference number provided by the client.
  
  InvoiceNumber
  
  Invoice number of one on the debts provided by the client.
  
  PaymentReferenceNumber
  
  Payment reference number (OCR).
  
  CustomerNo
  
  Customer number for the debtor at the creditor side.
  
  CaseIdentificationValue Mandatory
  
  Identification value corresponding to identification type.
  
  string

Output

Collection case filtered by parameters. If filter format is incorrect - error is returned
Error codes:

30701: collection account generic error

Object

GetCaseDetailsResult

Result of GetCaseDetails
Object
GetCaseDetailsResult

General class for representing method output.
- CaseDetails
  
  Collection case detailed information.
  Object
  
  CaseDetails
  
  Detailed information about collection case.
  
  ActionHistory
  
  List of collection case action history action items.
  
  Array
  
  Object
  
  History
  
  Detailed information about history action item.
  
  ActionGroup
  
  Action group (predefined category for history actions).
  
  Enum
  
  ActionGroup
  
  Action group.
  
  None
  
  None.
  
  Respite
  
  An action (e.g. letter) to be sent as a confirmation of a given respite.
  
  Legal_SE_SUPRO_reduce
  
  An export or letter action to handle reduction of a claim in Swedish injunction to pay process.
  
  Legal_SE_SUPRO_recall
  
  An export or letter action to handle a recall of a claim from the Swedish injunction to pay process.
  
  Legal_SE_enforcement_reduce
  
  An export or letter action to handle reduction of a claim in Swedish enforcement process.
  
  Legal_SE_enforcement_recall
  
  An export or letter action to handle a recall of a claim from the Swedish enforcement process.
  
  Invoice
  
  An action (e.g. letter) that is the actual invoice.
  
  Reminder
  
  An action (e.g. letter) that is a reminder of an unpaid invoice.
  
  Collection
  
  An action (e.g. export) that is the start of the debcollection process.
  
  Legal_SE_enforcement_application
  
  An export or letter action to handle an application for a Swedish enforcement process.
  
  Legal_SE_enforcement_renew
  
  An export or letter action to handle a yearly renewal in a Swedish enforcement process.
  
  Legal_SE_enforcement_respite
  
  An export or letter action to to give the debtor a respite in a Swedish enforcement process.
  
  PP_Avi
  
  Monthly payment notice in a payment (instalment) plan.
  
  Legal_SE_enforcement_message
  
  An export or letter action to handle a message to the bailiff in a Swedish enforcement process.
  
  Legal_SE_enforcement_change
  
  An export or letter action to handle an update to a case in a Swedish enforcement process.
  
  PP_Reminder
  
  Reminder of a monthly payment notice in a payment (instalment) plan.
  
  Legal_SE_SUPRO_application
  
  An export or letter action to handle application of a Swedish injunction to pay process.
  
  BOF
  
  A letter action for Norwegian debt collection notice.
  
  Varsel
  
  Norwegian reminder letter.
  
  IKVAR
  
  Norwegian reminder and debt collection warning letter.
  
  Bankruptcy_application
  
  A letter action with application for bankruptcy.
  
  XFR_application
  
  An export action for Swedish credit information at Kronofogden (XFR).
  
  Notice
  
  Action for monthly invoice of an account/loan.
  
  Promissory_Note
  
  Action for promissory note of an account/loan.
  
  BOFVarsel
  
  A letter action for Norwegian debt collection notice.
  
  TungInkasso
  
  An action for initiating double charge of the debtor in a Norwegian collection case.
  
  Legal_NO_SI_application_Forlik
  
  Norwegian action for application of simplified summons.
  
  Legal_NO_Forlik_reduce
  
  An export or letter action to handle reduction of a claim in Norwegian simplified summons process.
  
  Legal_NO_Forlik_recall
  
  An export or letter action to handle a recall of a claim in Norwegian simplified summons process.
  
  Legal_NO_DirekteUtlegg_reduce
  
  An export or letter action to handle reduction of a claim in Norwegian direct enforcement process.
  
  Legal_NO_DirekteUtlegg_recall
  
  An export or letter action to handle a recall of a claim in Norwegian direct enforcement process.
  
  Legal_NO_Utlegg_reduce
  
  An export or letter action to handle reduction of a claim in Norwegian enforcement process.
  
  Legal_NO_Utlegg_recall
  
  An export or letter action to handle a recall of a claim in Norwegian enforcement process.
  
  Legal_NO_SI_application_Utlegg
  
  Norwegian action for application of enforcement.
  
  Legal_NO_SI_application_DirekteUtlegg
  
  Norwegian action for application of direct enforcement (without prior summons).
  
  NL_WIK
  
  A letter action for Dutch debt collection notice.
  
  Legal_FI_Summons_reduce
  
  An export or letter action to handle reduction of a claim in Finnish summons process.
  
  Legal_FI_Summons_recall
  
  An export or letter action to handle a recall of a claim in Finnish summons process.
  
  Legal_FI_Enforcement_reduce
  
  An export or letter action to handle reduction of a claim in Finnish enforcement process.
  
  Legal_FI_Enforcement_recall
  
  An export or letter action to handle a recall of a claim in Finnish enforcement process.
  
  Legal_NL_WritOfSummons
  
  A letter action for Dutch writ of summons.
  
  Legal_NL_LegalDocument
  
  A letter action for Dutch document that needs to be sent to the bailiff.
  
  Legal_NL_BailiffExport
  
  An export action for exporting writ of summons or legal documents to the Dutch bailiff.
  
  Samlingsavisering
  
  Action for monthly invoice of a revolving account.
  
  Samlingsavisering_Reminder_1
  
  Action for first reminder of a revolving account.
  
  Samlingsavisering_Reminder_2
  
  Action for second reminder of a revolving account.
  
  SECCI
  
  A letter action for the Standard European Consumer Credit Information.
  
  PersonalDataReport
  
  A letter action for presenting a personal data report to the customer/debtor.
  
  Legal_FI_Summons
  
  Finnish action for writ of summons.
  
  Legal_FI_Enforcement
  
  Finnish action for application of enforcement.
  
  Dem
  
  Payment remark revoke.
  
  Legal_FI_Enforcement_Notification
  
  Finnish Enforcement notification
  
  Legal_FI_Balance_Inquiry_Response
  
  Finnish Bailiff balance inquiry response
  
  Legal_FI_Debtrecall
  
  Uljas, debt recall (FI)
  
  Back_To_Billing
  
  Back to billing
  
  ActionGroupingGuid
  
  Ledger account group unique identifier.
  
  string
  
  ActionItemCode
  
  History action item code.
  
  string
  
  ActionType
  
  History item action type.
  
  Enum
  
  ActionType
  
  Action type.
  
  Undefined
  
  Undefined.
  
  Letter
  
  Letter.
  
  WordLetter
  
  Word letter.
  
  ExportData
  
  Export data.
  
  Manual
  
  Manual collection.
  
  Phone
  
  Phone.
  
  ManualSystem
  
  Manual collection (System).
  
  InsertLegal
  
  Registration legal information.
  
  ChangeService
  
  Change service.
  
  NoOp
  
  Wait.
  
  InsertOffer
  
  Registration offer.
  
  ReturnToPrevious
  
  Return to previous.
  
  Email
  
  E-mail.
  
  UserQuestion
  
  Question to user.
  
  InsertPurchase
  
  Purchase of claim.
  
  Sms
  
  SMS message (text).
  
  Endorsement
  
  Endorsement.
  
  Reendorsement
  
  Reendorsement.
  
  List
  
  List.
  
  UpdateData
  
  Update data.
  
  Service
  
  Service call.
  
  UpdatePaymentPlan
  
  Update payment plan.
  
  NewInvoiceConfirm
  
  Merge new invoice.
  
  Grouping
  
  Grouping.
  
  Voicemail
  
  Voicemail.
  
  Decision
  
  Decsicion.
  
  UserQuestionList
  
  Question list.
  
  CaseTransfer
  
  Case transfer.
  
  AccountTransfer
  
  Account transfer.
  
  AuthSign
  
  Authentication/signing.
  
  RegisterVerdict
  
  Register Verdict.
  
  AmountToPay
  
  Amount to pay.
  
  decimal
  
  BankAccountNo
  
  Bank account number.
  
  string
  
  CaseNumber
  
  Case number.
  
  string
  
  CurrencyCode
  
  Currency code, e.g. SEK, NOK, EUR etc.
  
  string
  
  CustomerAccountNumber
  
  Customer account number.
  
  string
  
  Date
  
  History action item registration date.
  
  DateTime
  
  Description
  
  Action item description.
  
  string
  
  DueDate
  
  Due date.
  
  DateTime
  
  FileName
  
  Original file name
  
  string
  
  HasArchivedDocument
  
  If history action item has corresponding archived document.
  
  bool
  
  HistoryGuid
  
  History action item unique identifier.
  
  string
  
  InvoiceNumber
  
  Invoice number.
  
  string
  
  Name
  
  History action item name.
  
  string
  
  PaidDate
  
  Payment date.
  
  DateTime
  
  PaymentRefrence
  
  Payment reference.
  
  string
  
  PrintedAt
  
  Print date.
  
  DateTime
  
  UserCode
  
  User code
  
  string
  
  UserEmail
  
  E-mail of the action performer.
  
  string
  
  UserFullName
  
  Full name of the action performer.
  
  string
  
  UserType
  
  Party type of the action performer.
  
  Enum
  
  UserType
  
  User type.
  
  None
  
  User type is undefined.
  
  All
  
  All types.
  
  CreditorUser
  
  Creditor user type.
  
  SolicitorUser
  
  Solicitor user type.
  
  CreditorAndSolicitorUser
  
  Creditor | Solicitor user type.
  
  Debtor
  
  Debtor user type.
  
  CreditorUserAndDebtor
  
  Creditor Debtor user type
  
  SolicitorUserAndDebtor
  
  Solicito Debtor user type
  
  CreditorAndSolicitorUserAndDebtor
  
  Creditor Solicitor Debtor user type
  
  CaseNumber
  
  Case number.
  
  string
  
  ClientName
  
  Client full name
  
  string
  
  ClientReferenceNumber
  
  Party reference code.
  
  string
  
  ClosureCode
  
  Closure code
  
  string
  
  ClosureDate
  
  Closure date
  
  DateTime
  
  CurrencyCode
  
  Currency code, e.g. SEK, NOK, EUR etc.
  
  string
  
  Debtors
  
  List of collection case debtors.
  
  Array
  
  Object
  
  Debtor
  
  Detailed information about debtor.
  
  ActiveCases
  
  Active cases number.
  
  int
  
  Addresses
  
  List of debtor's addresses.
  
  Array
  
  Object
  
  Address
  
  Holds address information.
  
  CareOf
  
  Care of address.
  
  string
  
  City
  
  City.
  
  string
  
  CountryCode
  
  Country code, i.e. EN, SE etc.
  
  string
  
  DefaultAddress
  
  Whether this is the default address.
  
  bool
  
  FullAddress
  
  Combined address with all fields into single string.
  
  string
  
  FullName
  
  The full name of the receiving party, i.e name of person or company.
  
  string
  
  HouseNo
  
  House number.
  
  string
  
  HouseNoExtension
  
  House number extension.
  
  string
  
  StateCode
  
  State code if applicable.
  
  string
  
  Street
  
  Street address.
  
  string
  
  TypeCode Mandatory
  
  The type code of the address, i.e. what the address is used for, e.g. LEGAL, AVI, INVOICE, SITE, DELIVERY, TRUSTACCNT. Should be used one of predefined values using correct letter case.
  
  string
  
  UpdateExisting
  
  Whether this should update existing or create new address.
  
  bool
  
  ValidFrom
  
  The date when the address becomes active. If the element is missing, then do not change the current actual value.
  
  DateTime
  
  ValidTo
  
  The date after which the address becomes inactive. If the element is missing, then do not change the current actual value.
  
  DateTime
  
  ZipCode
  
  Zip code, i.e. postal code.
  
  string
  
  CellularPhone
  
  Debtor's cellular phone number.
  
  string
  
  ClientReference
  
  Party reference code.
  
  string
  
  ClosedCases
  
  Closed cases number.
  
  int
  
  ConversationNotificationCellularPhone
  
  Debtor's cellular phone number for conversation notification.
  
  string
  
  ConversationNotificationChannel
  
  Debtor's preferred channel for conversation notification (Email / SMS / Both Email and SMS).
  
  Enum
  
  ConversationNotificationChannel
  
  Type of person, juridically.
  
  None
  
  None.
  
  SMS
  
  SMS
  
  Email
  
  Email
  
  Both
  
  Both - SMS and Email
  
  ConversationNotificationEmail
  
  Debtor's e-mail for conversation notification.
  
  string
  
  CultureCode
  
  Debtor's time and currency format.
  
  string
  
  CurrencyCode
  
  Currency code, e.g. SEK, NOK, EUR etc.
  
  string
  
  DateOfBirth
  
  Debtor's date of birth.
  
  DateTime
  
  DebtorGuid
  
  Debtor unique identifier.
  
  string
  
  DebtorRole
  
  Debtor role.
  
  Enum
  
  DebtorRole
  
  Debtor role.
  
  Debtor
  
  Debtor.
  
  Guarantor
  
  Guarantor.
  
  Coapplicant
  
  Co-applicant.
  
  Estatebeneficiary
  
  Estate beneficiary.
  
  Tradingcompanypartner
  
  Trading company partner.
  
  Generalpartner
  
  General partner.
  
  Custodian
  
  Custodian.
  
  LimitedPartner
  
  Limited partner.
  
  Repurchaser
  
  Repurchaser.
  
  BankGuarantor
  
  Bank guarantor.
  
  OtherPledger
  
  Other pledger.
  
  BoardMember
  
  Board member.
  
  GuarantorAndOtherPledger
  
  Guarantor and other pledger.
  
  GuarantorAndCompanyPartner
  
  Guarantor and company partner.
  
  SoleProprietorUsingATradeName
  
  Sole proprietor using a trade name.
  
  SolventPerson
  
  Solvent person.
  
  Domicile
  
  Debtor's domicile.
  
  string
  
  Email
  
  Debtor's e-mail.
  
  string
  
  ExtraFields
  
  List of debtor's extrafields.
  
  Array
  
  Object
  
  ExtraField
  
  Extra field contains custom data.
  
  Data
  
  Value of extra field.
  
  string
  
  Name
  
  Name of extra field.
  
  string
  
  Firstname
  
  Debtor's first name.
  
  string
  
  Gender
  
  Debtor's gender.
  
  Enum
  
  GenderType
  
  Gender of a person.
  
  Female
  
  Female gender, a woman.
  
  Male
  
  Male gender, a man.
  
  Unknown
  
  Unknown gender, or neither Female nor Male.
  
  HistNotes
  
  History notes connected to the Debtor
  
  Array
  
  Object
  
  HistNote
  
  History note.
  
  HistNoteSubtypeDesc
  
  the History note Subtype – the description in the user’s language.
  
  string
  
  HistNoteTypeDesc Mandatory
  
  the History note Type – the description in the user’s language.
  
  string
  
  Important Mandatory
  
  the History note Importance: Important or Normal.
  
  bool
  
  LoggedAt Mandatory
  
  the History note Date and Time for when the note was logged.
  
  DateTime
  
  NoteText Mandatory
  
  the History note Message written.
  
  string
  
  HomePhone
  
  Debtor's domestic phone number.
  
  string
  
  IdNumber
  
  Debtor ID number.
  
  string
  
  JuridicalType
  
  Debtor person juridical type.
  
  Enum
  
  JuridicalType
  
  Type of person, juridically.
  
  NaturalPerson
  
  Actual person.
  
  JuridicalPerson
  
  Juridical person, e.g a company.
  
  LanguageCode
  
  Debtor's language code.
  
  string
  
  Lastname
  
  Debtor's last name.
  
  string
  
  Middlename
  
  Debtor's middle name.
  
  string
  
  MunicipalCode
  
  Debtor's municipal code.
  
  string
  
  NaceCode
  
  Debtor's NACE code.
  
  string
  
  NameSuffix
  
  Debtor's place of birth.
  
  string
  
  PlaceOfbirth
  
  Debtor's place of birth.
  
  string
  
  PreferredChannel
  
  Debtor's preferred channel of communication (Letter / Email / SMS / E-invoice).
  
  string
  
  Telefax
  
  Debtor's telefax number.
  
  string
  
  UnderAged
  
  Is the debtor underaged.
  
  bool
  
  WorkPhone
  
  Debtor's work phone number.
  
  string
  
  Debts
  
  List of collection debts.
  
  Array
  
  Object
  
  Debt
  
  Detailed information about collection debt.
  
  AccountReference
  
  Debt account reference.
  
  string
  
  BillDate
  
  Debt bill date.
  
  DateTime
  
  CurrencyCode
  
  Currency code, e.g. SEK, NOK, EUR etc.
  
  string
  
  DebtGroup
  
  Debt group code (probably one of predefined values).
  
  string
  
  DebtGuid
  
  Debt unique identifier.
  
  string
  
  Description
  
  Debt description.
  
  string
  
  DueDate
  
  Debt due date.
  
  DateTime
  
  FixedInterestTermStart
  
  Debt fixed interest term date.
  
  DateTime
  
  InterestCode
  
  Debt interest code (one of predefined interest calculation types).
  
  string
  
  InterestCondition
  
  Debt interest payment period in days.
  
  int
  
  InterestFrom
  
  Debt interest calculation start date.
  
  DateTime
  
  InterestRate
  
  Debt interest rate.
  
  decimal
  
  InterestStop
  
  Debt interest accrual stop date.
  
  DateTime
  
  InterestTo
  
  Debt interest calculation end date.
  
  DateTime
  
  InvoiceType
  
  Invoice type.
  
  Enum
  
  InvoiceType
  
  Invoice type.
  
  Unknown
  
  Unknown.
  
  Invoice
  
  Invoice.
  
  CreditInvoice
  
  CreditInvoice.
  
  InterestInvoice
  
  InterestInvoice.
  
  FinalInvoiceCreditDebt
  
  FinalInvoiceCreditDebt.
  
  OfferInvoice
  
  OfferInvoice.
  
  CollectionInvoice
  
  CollectionInvoice.
  
  Overpayment
  
  Overpayment.
  
  OnAccountPayment
  
  OnAccountPayment.
  
  LedgerReference
  
  Debt ledger reference.
  
  string
  
  OriginalInterest
  
  Original interest.
  
  decimal
  
  OriginalPrincipal
  
  Original principal.
  
  decimal
  
  OurReference
  
  Our reference.
  
  string
  
  PaidInterest
  
  Paid interest.
  
  decimal
  
  PaidPrincipal
  
  Paid principal.
  
  decimal
  
  PaymentCondition
  
  Debt payment period in days.
  
  int
  
  ReferenceNumber
  
  Debt reference number.
  
  string
  
  RemainingInterest
  
  Remaining interest.
  
  decimal
  
  RemainingPrincipal
  
  Remaining principal.
  
  decimal
  
  YourReference
  
  Your reference.
  
  string
  
  Description
  
  Case description.
  
  string
  
  ExtraFields
  
  List extrafields of case.
  
  Array
  
  Object
  
  ExtraField
  
  Extra field contains custom data.
  
  Data
  
  Value of extra field.
  
  string
  
  Name
  
  Name of extra field.
  
  string
  
  Fees
  
  List of collection case fees.
  
  Array
  
  Object
  
  Fee
  
  Detailed information about collection case fee.
  
  CurrencyCode
  
  Currency code, e.g. SEK, NOK, EUR etc.
  
  string
  
  Description
  
  Fee description.
  
  string
  
  FeeDate
  
  Fee date.
  
  DateTime
  
  FeeDebtType
  
  Fee debt type, like ImportedFee, Fee or Outlay.
  
  Enum
  
  DebtType
  
  Debt type.
  
  Unknown
  
  None.
  
  Principal
  
  Principal.
  
  ImportedFee
  
  ImportedFee.
  
  Fee
  
  Fee.
  
  Outlay
  
  Outlay.
  
  Credit
  
  Credit.
  
  Reservation
  
  Reservation.
  
  CapitalizedInterest
  
  CapitalizedInterest.
  
  Billed
  
  Billed.
  
  Due
  
  Due.
  
  PenaltyInterestOnPrincipal
  
  PenaltyInterestOnPrincipal.
  
  PenaltyInterestOnInterest
  
  PenaltyInterestOnInterest.
  
  Pretermination
  
  Pretermination.
  
  Termination
  
  Termination.
  
  FeeGuid
  
  Fee unique identifier.
  
  string
  
  InterestCode
  
  Fee interest code (one of predefined interest calculation types).
  
  string
  
  InterestFrom
  
  Fee interest calculation start date.
  
  DateTime
  
  InterestRate
  
  Fee interest rate.
  
  decimal
  
  InterestTo
  
  Fee interest calculation end date.
  
  DateTime
  
  Name
  
  Fee type.
  
  string
  
  PaidInterest
  
  Paid interest.
  
  decimal
  
  PaidPrincipal
  
  Paid principal.
  
  decimal
  
  PrincipalAmount
  
  Principal amount.
  
  decimal
  
  RemainingInterest
  
  Remaining interest.
  
  decimal
  
  RemainingPrincipal
  
  Remaining principal.
  
  decimal
  
  VatAmount
  
  VAT amount.
  
  decimal
  
  HistNotes
  
  History notes connected to the Collection case
  
  Array
  
  Object
  
  HistNote
  
  History note.
  
  HistNoteSubtypeDesc
  
  the History note Subtype – the description in the user’s language.
  
  string
  
  HistNoteTypeDesc Mandatory
  
  the History note Type – the description in the user’s language.
  
  string
  
  Important Mandatory
  
  the History note Importance: Important or Normal.
  
  bool
  
  LoggedAt Mandatory
  
  the History note Date and Time for when the note was logged.
  
  DateTime
  
  NoteText Mandatory
  
  the History note Message written.
  
  string
  
  Objects
  
  Objects
  
  XmlElement
  
  OriginalFee
  
  Original fee.
  
  decimal
  
  OriginalInterest
  
  Original interest.
  
  decimal
  
  OriginalPrincipal
  
  Original principal.
  
  decimal
  
  OriginalSum
  
  Original total amount.
  
  decimal
  
  PaidFee
  
  Paid fee.
  
  decimal
  
  PaidInterest
  
  Paid interest.
  
  decimal
  
  PaidPrincipal
  
  Paid principal.
  
  decimal
  
  PaidSum
  
  Paid total amount.
  
  decimal
  
  PaidToThirdParty
  
  Not used now, always 0.
  
  decimal
  
  PaymentPlanAllowed
  
  Allowing of payment plan
  
  bool
  
  PaymentPlanMaxNumOfOccasions
  
  Payment plan - maximum count of payments
  
  int
  
  PaymentPlanMinAmount
  
  Payment plan - minimum amount of payment
  
  decimal
  
  PaymentReferenceNumber
  
  OCR-number for case.
  
  string
  
  Payments
  
  List of collection Payments.
  
  Array
  
  Object
  
  Payment
  
  Information about collection Payment.
  
  BankAccountNumber
  
  BankAccountNumber.
  
  string
  
  CreditorIsBankAccountOwner
  
  CreditorIsBankAccountOwner.
  
  bool
  
  CurrencyCode
  
  CurrencyCode.
  
  string
  
  Distributions
  
  Distributions.
  
  Array
  
  Object
  
  PaymentDistribution
  
  Information about collection Payment distribution.
  
  CollectionAccountId
  
  CollectionAccountId.
  
  int
  
  CurrencyCode
  
  CurrencyCode.
  
  string
  
  DebtType
  
  DebtType.
  
  Enum
  
  DebtType
  
  Debt type.
  
  Unknown
  
  None.
  
  Principal
  
  Principal.
  
  ImportedFee
  
  ImportedFee.
  
  Fee
  
  Fee.
  
  Outlay
  
  Outlay.
  
  Credit
  
  Credit.
  
  Reservation
  
  Reservation.
  
  CapitalizedInterest
  
  CapitalizedInterest.
  
  Billed
  
  Billed.
  
  Due
  
  Due.
  
  PenaltyInterestOnPrincipal
  
  PenaltyInterestOnPrincipal.
  
  PenaltyInterestOnInterest
  
  PenaltyInterestOnInterest.
  
  Pretermination
  
  Pretermination.
  
  Termination
  
  Termination.
  
  FeeCode
  
  FeeCode.
  
  string
  
  InterestAmount
  
  InterestAmount.
  
  decimal
  
  InvoiceNumber
  
  InvoiceNumber.
  
  string
  
  PrincipalAmount
  
  PrincipalAmount.
  
  decimal
  
  ExternallyAccountedFor
  
  ExternallyAccountedFor.
  
  bool
  
  OverPaidAmount
  
  OverPaidAmount.
  
  decimal
  
  PaidAmount
  
  PaidAmount.
  
  decimal
  
  PaidOnOtherCases
  
  PaidOnOtherCases.
  
  decimal
  
  PaymentDate
  
  PaymentDate.
  
  DateTime
  
  PaymentGuid
  
  PaymentGuid.
  
  string
  
  PaymentReferenceNumber
  
  PaymentReferenceNumber.
  
  string
  
  RegistrationDate
  
  RegistrationDate.
  
  DateTime
  
  Reservation
  
  Reservation.
  
  bool
  
  Source
  
  Source.
  
  string
  
  PromiseToPayMaxDaysAllowed
  
  The maximum number of days allowed Promise to Pay for the case that the debtor can request.
  
  int
  
  PromiseToPayMinDaysAllowed
  
  The minimum number of days allowed Promise to Pay for the case that the debtor can request.
  
  int
  
  ReferenceNumber
  
  Debtor reference number.
  
  string
  
  RegistrationDate
  
  Case registration date.
  
  DateTime
  
  RemainingFee
  
  Remaining fee.
  
  decimal
  
  RemainingInterest
  
  Remaining interest.
  
  decimal
  
  RemainingPrincipal
  
  Remaining principal.
  
  decimal
  
  RemainingSum
  
  Remaining total amount.
  
  decimal
  
  RespiteMaxDaysAllowed
  
  Maximum allowed number of days for respite.
  
  int
  
  Service
  
  Collection account service.
  
  string
  
  Status
  
  Collection account status.
  
  string
  
  SubStatus
  
  Collection account substatus.
  
  string
- Result
  
  The result of the request. Indicating success or error.
  Object
  
  ResultType
  
  Common result type.
  
  ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
  
  ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

GetCaseSummary

Returns list of collection cases for authenticated debtor(s).

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();

GetCaseSummaryResult result = client.GetCaseSummary(
    new GetCaseSummaryRequest {
        CaseLookup = new CaseLookup { CaseIdentification = CaseIdentificationType.CaseNumber, CaseIdentificationValue = "7" }
    }
);

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:GetCaseSummary>
            <urn:GetCaseSummaryRequest>
                <urn:CaseLookup>
                    <urn:CaseIdentification>CaseNumber</urn:CaseIdentification>
                    <urn:CaseIdentificationValue>7</urn:CaseIdentificationValue>
                </urn:CaseLookup>
            </urn:GetCaseSummaryRequest>
        </urn:GetCaseSummary>
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
GetCaseSummary

GetCaseSummary
- GetCaseSummaryRequest
  
  Collection case identification parameters.
  Object
  
  GetCaseSummaryRequest
  
  General class for representing method input.
  
  CaseLookup Mandatory
  
  Information to lookup collection case(s).
  
  Object
  
  CaseLookup
  
  The way to find a collection case in DB by several predefined criteria.
  
  CaseIdentification Mandatory
  
  Collection case identification type.
  
  Enum
  
  CaseIdentificationType
  
  Collection case identification type.
  
  CaseGuid
  
  Case GUID identification.
  
  CaseNumber
  
  Case number.
  
  AccountReferenceNumber
  
  Account reference number provided by the client.
  
  InvoiceNumber
  
  Invoice number of one on the debts provided by the client.
  
  PaymentReferenceNumber
  
  Payment reference number (OCR).
  
  CustomerNo
  
  Customer number for the debtor at the creditor side.
  
  CaseIdentificationValue Mandatory
  
  Identification value corresponding to identification type.
  
  string

Output

List of collection cases for authenticated debtor(s). If filter format is incorrect - error is returned
Error codes:

30701: collection account generic error

Object

GetCaseSummaryResult

Result of GetCaseSummary
Object
GetCaseSummaryResult

General class for representing method output.
- Cases
  
  List of collection cases.
  Array
  
  Object
  
  CaseSummary
  
  Detailed information about collection case.
  
  CaseGuid
  
  Collection case unique identifier.
  
  string
  
  CaseNumber
  
  Case number.
  
  string
  
  ClientName
  
  Client full name
  
  string
  
  ClientReferenceNumber
  
  Party reference code.
  
  string
  
  ClosureCode
  
  Closure code
  
  string
  
  ClosureDate
  
  Closure date
  
  DateTime
  
  CurrencyCode
  
  Currency code, e.g. SEK, NOK, EUR etc.
  
  string
  
  OriginalFee
  
  Original fee.
  
  decimal
  
  OriginalInterest
  
  Original interest.
  
  decimal
  
  OriginalPrincipal
  
  Original principal.
  
  decimal
  
  OriginalSum
  
  Original total amount.
  
  decimal
  
  PaidFee
  
  Paid fee.
  
  decimal
  
  PaidInterest
  
  Paid interest.
  
  decimal
  
  PaidPrincipal
  
  Paid principal.
  
  decimal
  
  PaidSum
  
  Paid total amount.
  
  decimal
  
  PaidToThirdParty
  
  Not used now, always 0.
  
  decimal
  
  ReferenceNumber
  
  Debtor reference number.
  
  string
  
  RegistrationDate
  
  Case registration date.
  
  DateTime
  
  RemainingFee
  
  Remaining fee.
  
  decimal
  
  RemainingInterest
  
  Remaining interest.
  
  decimal
  
  RemainingPrincipal
  
  Remaining principal.
  
  decimal
  
  RemainingSum
  
  Remaining total amount.
  
  decimal
  
  Service
  
  Collection account service.
  
  string
  
  Status
  
  Collection account status.
  
  string
  
  SubStatus
  
  Collection account substatus.
  
  string
- Result
  
  The result of the request. Indicating success or error.
  Object
  
  ResultType
  
  Common result type.
  
  ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
  
  ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

GetCollectionConversations

Returns list of conversations related to collection cases for authenticated debtor(s).

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();

GetCollectionConversationsResult result = client.GetCollectionConversations(false);

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:GetCollectionConversations />
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
GetCollectionConversations

GetCollectionConversations
- GetClosedConversations
  
  Optional “true” will cause the backend to retrieve and return both open and closed conversations
  
  bool

Output

List of conversations related to collection cases for authenticated debtor(s).
Error codes:

1: unknown error or error message from ARC server

Object

GetCollectionConversationsResult

Result of GetCollectionConversations
Object
GetCollectionConversationsResult

General class for representing method output.
- CollectionConversations
  
  List of collection case conversations.
  Array
  
  Object
  
  CollectionConversation
  
  Holds information about collection case conversation.
  
  CaseGuid
  
  Collection case unique identifier.
  
  string
  
  CaseNumber
  
  Collection case number.
  
  string
  
  ClosureDate Mandatory
  
  Conversation closure date.
  
  DateTime
  
  ConversationGuid Mandatory
  
  Conversation unique identifier.
  
  string
  
  DebtorGuid
  
  Collection case debtor unique identifier.
  
  string
  
  DebtorName
  
  Collection case debtor name.
  
  string
  
  Messages Mandatory
  
  Conversation messages count.
  
  int
  
  Subject
  
  Conversation subject
  
  string
  
  Unread Mandatory
  
  Conversation unread messages count.
  
  int
- Result
  
  The result of the request. Indicating success or error.
  Object
  
  ResultType
  
  Common result type.
  
  ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
  
  ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

GetDebtorDetails

Returns list of authenticated debtors.

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();

GetDebtorDetailsResult result = client.GetDebtorDetails();

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:GetDebtorDetails />
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
GetDebtorDetails

GetDebtorDetails

Output

List of authenticated debtors.
Error codes:

30701: collection account generic error

Object

GetDebtorDetailsResult

Result of GetDebtorDetails
Object
GetDebtorDetailsResult

General class for representing method output.
- Debtors
  
  List of debtors with detailed information about each debtor.
  Array
  
  Object
  
  Debtor
  
  Detailed information about debtor.
  
  ActiveCases
  
  Active cases number.
  
  int
  
  Addresses
  
  List of debtor's addresses.
  
  Array
  
  Object
  
  Address
  
  Holds address information.
  
  CareOf
  
  Care of address.
  
  string
  
  City
  
  City.
  
  string
  
  CountryCode
  
  Country code, i.e. EN, SE etc.
  
  string
  
  DefaultAddress
  
  Whether this is the default address.
  
  bool
  
  FullAddress
  
  Combined address with all fields into single string.
  
  string
  
  FullName
  
  The full name of the receiving party, i.e name of person or company.
  
  string
  
  HouseNo
  
  House number.
  
  string
  
  HouseNoExtension
  
  House number extension.
  
  string
  
  StateCode
  
  State code if applicable.
  
  string
  
  Street
  
  Street address.
  
  string
  
  TypeCode Mandatory
  
  The type code of the address, i.e. what the address is used for, e.g. LEGAL, AVI, INVOICE, SITE, DELIVERY, TRUSTACCNT. Should be used one of predefined values using correct letter case.
  
  string
  
  UpdateExisting
  
  Whether this should update existing or create new address.
  
  bool
  
  ValidFrom
  
  The date when the address becomes active. If the element is missing, then do not change the current actual value.
  
  DateTime
  
  ValidTo
  
  The date after which the address becomes inactive. If the element is missing, then do not change the current actual value.
  
  DateTime
  
  ZipCode
  
  Zip code, i.e. postal code.
  
  string
  
  CellularPhone
  
  Debtor's cellular phone number.
  
  string
  
  ClientReference
  
  Party reference code.
  
  string
  
  ClosedCases
  
  Closed cases number.
  
  int
  
  ConversationNotificationCellularPhone
  
  Debtor's cellular phone number for conversation notification.
  
  string
  
  ConversationNotificationChannel
  
  Debtor's preferred channel for conversation notification (Email / SMS / Both Email and SMS).
  
  Enum
  
  ConversationNotificationChannel
  
  Type of person, juridically.
  
  None
  
  None.
  
  SMS
  
  SMS
  
  Email
  
  Email
  
  Both
  
  Both - SMS and Email
  
  ConversationNotificationEmail
  
  Debtor's e-mail for conversation notification.
  
  string
  
  CultureCode
  
  Debtor's time and currency format.
  
  string
  
  CurrencyCode
  
  Currency code, e.g. SEK, NOK, EUR etc.
  
  string
  
  DateOfBirth
  
  Debtor's date of birth.
  
  DateTime
  
  DebtorGuid
  
  Debtor unique identifier.
  
  string
  
  DebtorRole
  
  Debtor role.
  
  Enum
  
  DebtorRole
  
  Debtor role.
  
  Debtor
  
  Debtor.
  
  Guarantor
  
  Guarantor.
  
  Coapplicant
  
  Co-applicant.
  
  Estatebeneficiary
  
  Estate beneficiary.
  
  Tradingcompanypartner
  
  Trading company partner.
  
  Generalpartner
  
  General partner.
  
  Custodian
  
  Custodian.
  
  LimitedPartner
  
  Limited partner.
  
  Repurchaser
  
  Repurchaser.
  
  BankGuarantor
  
  Bank guarantor.
  
  OtherPledger
  
  Other pledger.
  
  BoardMember
  
  Board member.
  
  GuarantorAndOtherPledger
  
  Guarantor and other pledger.
  
  GuarantorAndCompanyPartner
  
  Guarantor and company partner.
  
  SoleProprietorUsingATradeName
  
  Sole proprietor using a trade name.
  
  SolventPerson
  
  Solvent person.
  
  Domicile
  
  Debtor's domicile.
  
  string
  
  Email
  
  Debtor's e-mail.
  
  string
  
  ExtraFields
  
  List of debtor's extrafields.
  
  Array
  
  Object
  
  ExtraField
  
  Extra field contains custom data.
  
  Data
  
  Value of extra field.
  
  string
  
  Name
  
  Name of extra field.
  
  string
  
  Firstname
  
  Debtor's first name.
  
  string
  
  Gender
  
  Debtor's gender.
  
  Enum
  
  GenderType
  
  Gender of a person.
  
  Female
  
  Female gender, a woman.
  
  Male
  
  Male gender, a man.
  
  Unknown
  
  Unknown gender, or neither Female nor Male.
  
  HistNotes
  
  History notes connected to the Debtor
  
  Array
  
  Object
  
  HistNote
  
  History note.
  
  HistNoteSubtypeDesc
  
  the History note Subtype – the description in the user’s language.
  
  string
  
  HistNoteTypeDesc Mandatory
  
  the History note Type – the description in the user’s language.
  
  string
  
  Important Mandatory
  
  the History note Importance: Important or Normal.
  
  bool
  
  LoggedAt Mandatory
  
  the History note Date and Time for when the note was logged.
  
  DateTime
  
  NoteText Mandatory
  
  the History note Message written.
  
  string
  
  HomePhone
  
  Debtor's domestic phone number.
  
  string
  
  IdNumber
  
  Debtor ID number.
  
  string
  
  JuridicalType
  
  Debtor person juridical type.
  
  Enum
  
  JuridicalType
  
  Type of person, juridically.
  
  NaturalPerson
  
  Actual person.
  
  JuridicalPerson
  
  Juridical person, e.g a company.
  
  LanguageCode
  
  Debtor's language code.
  
  string
  
  Lastname
  
  Debtor's last name.
  
  string
  
  Middlename
  
  Debtor's middle name.
  
  string
  
  MunicipalCode
  
  Debtor's municipal code.
  
  string
  
  NaceCode
  
  Debtor's NACE code.
  
  string
  
  NameSuffix
  
  Debtor's place of birth.
  
  string
  
  PlaceOfbirth
  
  Debtor's place of birth.
  
  string
  
  PreferredChannel
  
  Debtor's preferred channel of communication (Letter / Email / SMS / E-invoice).
  
  string
  
  Telefax
  
  Debtor's telefax number.
  
  string
  
  UnderAged
  
  Is the debtor underaged.
  
  bool
  
  WorkPhone
  
  Debtor's work phone number.
  
  string
- Result
  
  The result of the request. Indicating success or error.
  Object
  
  ResultType
  
  Common result type.
  
  ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
  
  ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

GetDebtorPaymentReference

Returns payment reference number for authenticated debtor(s).

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();

GetDebtorPaymentReferenceResult result = client.GetDebtorPaymentReference(
    new GetDebtorPaymentReferenceRequest {
        CaseLookup = new CaseLookup { CaseIdentification = CaseIdentificationType.CaseNumber, CaseIdentificationValue = "7" }
    }
);

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:GetDebtorPaymentReference>
            <urn:GetDebtorPaymentReferenceRequest>
                <urn:CaseLookup>
                    <urn:CaseIdentification>CaseNumber</urn:CaseIdentification>
                    <urn:CaseIdentificationValue>7</urn:CaseIdentificationValue>
                </urn:CaseLookup>
            </urn:GetDebtorPaymentReferenceRequest>
        </urn:GetDebtorPaymentReference>
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
GetDebtorPaymentReference

GetDebtorPaymentReference
- GetDebtorPaymentReferenceRequest
  
  Collection case and bank account identification parameters.
  Object
  
  GetDebtorPaymentReferenceRequest
  
  General class for representing method input.
  
  BankAccountCode
  
  Bank account code.
  
  string
  
  CaseLookup
  
  Information to lookup collection case(s).
  
  Object
  
  CaseLookup
  
  The way to find a collection case in DB by several predefined criteria.
  
  CaseIdentification Mandatory
  
  Collection case identification type.
  
  Enum
  
  CaseIdentificationType
  
  Collection case identification type.
  
  CaseGuid
  
  Case GUID identification.
  
  CaseNumber
  
  Case number.
  
  AccountReferenceNumber
  
  Account reference number provided by the client.
  
  InvoiceNumber
  
  Invoice number of one on the debts provided by the client.
  
  PaymentReferenceNumber
  
  Payment reference number (OCR).
  
  CustomerNo
  
  Customer number for the debtor at the creditor side.
  
  CaseIdentificationValue Mandatory
  
  Identification value corresponding to identification type.
  
  string

Output

Payment reference number for authenticated debtor(s). If filter format is incorrect - error is returned
Error codes:

30701: collection account generic error

Object

GetDebtorPaymentReferenceResult

Result of GetDebtorPaymentReference
Object
GetDebtorPaymentReferenceResult

General class for representing method output.
- PaymentReferenceNumber
  
  Payment reference number.
  
  string
- Result
  
  The result of the request. Indicating success or error.
  Object
  
  ResultType
  
  Common result type.
  
  ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
  
  ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

GetDebtorSummary

Returns authenticated debtor(s) collection cases.

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();

GetDebtorSummaryResult result = client.GetDebtorSummary();

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:GetDebtorSummary />
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
GetDebtorSummary

GetDebtorSummary

Output

List of collection cases for authenticated debtor account(s). If no collection case(s) found - error is returned
Error codes:

30701: collection account generic error

Object

GetDebtorSummaryResult

Result of GetDebtorSummary
Object
GetDebtorSummaryResult

General class for representing method output.
- DebtorTotalSummary
  
  List of collection cases with detailed information about each case.
  Array
  
  Object
  
  CaseSummary
  
  Detailed information about collection case.
  
  CaseGuid
  
  Collection case unique identifier.
  
  string
  
  CaseNumber
  
  Case number.
  
  string
  
  ClientName
  
  Client full name
  
  string
  
  ClientReferenceNumber
  
  Party reference code.
  
  string
  
  ClosureCode
  
  Closure code
  
  string
  
  ClosureDate
  
  Closure date
  
  DateTime
  
  CurrencyCode
  
  Currency code, e.g. SEK, NOK, EUR etc.
  
  string
  
  OriginalFee
  
  Original fee.
  
  decimal
  
  OriginalInterest
  
  Original interest.
  
  decimal
  
  OriginalPrincipal
  
  Original principal.
  
  decimal
  
  OriginalSum
  
  Original total amount.
  
  decimal
  
  PaidFee
  
  Paid fee.
  
  decimal
  
  PaidInterest
  
  Paid interest.
  
  decimal
  
  PaidPrincipal
  
  Paid principal.
  
  decimal
  
  PaidSum
  
  Paid total amount.
  
  decimal
  
  PaidToThirdParty
  
  Not used now, always 0.
  
  decimal
  
  ReferenceNumber
  
  Debtor reference number.
  
  string
  
  RegistrationDate
  
  Case registration date.
  
  DateTime
  
  RemainingFee
  
  Remaining fee.
  
  decimal
  
  RemainingInterest
  
  Remaining interest.
  
  decimal
  
  RemainingPrincipal
  
  Remaining principal.
  
  decimal
  
  RemainingSum
  
  Remaining total amount.
  
  decimal
  
  Service
  
  Collection account service.
  
  string
  
  Status
  
  Collection account status.
  
  string
  
  SubStatus
  
  Collection account substatus.
  
  string
- Result
  
  The result of the request. Indicating success or error.
  Object
  
  ResultType
  
  Common result type.
  
  ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
  
  ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

GetDocumentListForCase

Returns list of history action documents.

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();

GetDocumentListResult result = client.GetDocumentListForCase(
    new CaseLookup { CaseIdentification = CaseIdentificationType.CaseNumber, CaseIdentificationValue = "7" }
);

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:GetDocumentListForCase>
            <urn:CaseLookup>
                <urn:CaseIdentification>CaseNumber</urn:CaseIdentification>
                <urn:CaseIdentificationValue>7</urn:CaseIdentificationValue>
            </urn:CaseLookup>
        </urn:GetDocumentListForCase>
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
GetDocumentListForCase

GetDocumentListForCase
- caseLookup
  
  Information to lookup case(s).
  Object
  
  CaseLookup
  
  The way to find a collection case in DB by several predefined criteria.
  
  CaseIdentification Mandatory
  
  Collection case identification type.
  
  Enum
  
  CaseIdentificationType
  
  Collection case identification type.
  
  CaseGuid
  
  Case GUID identification.
  
  CaseNumber
  
  Case number.
  
  AccountReferenceNumber
  
  Account reference number provided by the client.
  
  InvoiceNumber
  
  Invoice number of one on the debts provided by the client.
  
  PaymentReferenceNumber
  
  Payment reference number (OCR).
  
  CustomerNo
  
  Customer number for the debtor at the creditor side.
  
  CaseIdentificationValue Mandatory
  
  Identification value corresponding to identification type.
  
  string

Output

List of collection case history action documents filtered by parameters. If filter format is incorrect - error is returned
Error codes:

30701: collection account generic error

Object

GetDocumentListForCaseResult

Result of GetDocumentListForCase
Object
GetDocumentListResult

General class for representing method output.
- Documents
  
  The list of history action documents with detailed information about each document.
  Array
  
  Object
  
  HistoryDocument
  
  Detailed information about history action document.
  
  CaseGuids
  
  List of unique identifiers of collection cases related to the document.
  
  Array
  
  string
  
  DebtorGuids
  
  List of unique identifiers of debtors related to the collection cases of the document.
  
  Array
  
  string
  
  DocumentDate
  
  Document creation date.
  
  DateTime
  
  DocumentTypeCode
  
  Document code (one of predefined types idoc / invoice / gjeldsbrev / verdict / domforlik).
  
  string
  
  FileName
  
  File name.
  
  string
  
  HistoryGuid
  
  History action document's unique identifier.
  
  string
  
  Important
  
  Document importancy flag.
  
  bool
  
  Note
  
  Free extra information related to the document.
  
  string
  
  UserEmail
  
  E-mail of the document author.
  
  string
  
  UserFullName
  
  Full name of the document author.
  
  string
  
  UserType
  
  Party type of the document author.
  
  Enum
  
  UserType
  
  User type.
  
  None
  
  User type is undefined.
  
  All
  
  All types.
  
  CreditorUser
  
  Creditor user type.
  
  SolicitorUser
  
  Solicitor user type.
  
  CreditorAndSolicitorUser
  
  Creditor | Solicitor user type.
  
  Debtor
  
  Debtor user type.
  
  CreditorUserAndDebtor
  
  Creditor Debtor user type
  
  SolicitorUserAndDebtor
  
  Solicito Debtor user type
  
  CreditorAndSolicitorUserAndDebtor
  
  Creditor Solicitor Debtor user type
- Result
  
  The result of the request. Indicating success or error.
  Object
  
  ResultType
  
  Common result type.
  
  ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
  
  ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

GetDocumentListForDebtor

Returns list of history action documents.

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();

GetDocumentListResult result = client.GetDocumentListForDebtor(
    new DebtorLookup { DebtorIdentification = DebtorIdentificationType.DebtorSESSNOrCompanyNo, DebtorIdentificationValue = "1212121212" }
);

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:GetDocumentListForDebtor>
            <urn:DebtorLookup>
                <urn:DebtorIdentification>DebtorSESSNOrCompanyNo</urn:DebtorIdentification>
                <urn:DebtorIdentificationValue>1212121212</urn:DebtorIdentificationValue>
            </urn:DebtorLookup>
        </urn:GetDocumentListForDebtor>
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
GetDocumentListForDebtor

GetDocumentListForDebtor
- debtorLookup
  
  Information to lookup debtor(s).
  Object
  
  DebtorLookup
  
  The way to find a debtor in DB by several predefined criteria.
  
  DebtorIdentification Mandatory
  
  Debtor identification type.
  
  Enum
  
  DebtorIdentificationType
  
  Debtor identification type.
  
  Custom
  
  Custom identification. NOT SUPPORTED.
  
  DebtorSESSNOrCompanyNo
  
  Identify by Swedish SSN or company number.
  
  DebtorNOSSNOrCompanyNo
  
  Identify by Norweigan SSN or company number.
  
  DebtorReferenceNumber
  
  Identify by debtor/client reference number.
  
  DebtorGuid
  
  Debtor identification.
  
  CustomerNo
  
  Customer number for the debtor at the creditor side. NOT SUPPORTED in DebtorAccess.EstablishSession.
  
  DebtorFISSNOrCompanyNo
  
  Identify by Finnish SSN or company number.
  
  DebtorIdentificationValue Mandatory
  
  Identification value corresponding to identification type.
  
  string

Output

List of collection case history action documents filtered by parameters. If filter format is incorrect - error is returned
Error codes:

30701: collection account generic error

Object

GetDocumentListForDebtorResult

Result of GetDocumentListForDebtor
Object
GetDocumentListResult

General class for representing method output.
- Documents
  
  The list of history action documents with detailed information about each document.
  Array
  
  Object
  
  HistoryDocument
  
  Detailed information about history action document.
  
  CaseGuids
  
  List of unique identifiers of collection cases related to the document.
  
  Array
  
  string
  
  DebtorGuids
  
  List of unique identifiers of debtors related to the collection cases of the document.
  
  Array
  
  string
  
  DocumentDate
  
  Document creation date.
  
  DateTime
  
  DocumentTypeCode
  
  Document code (one of predefined types idoc / invoice / gjeldsbrev / verdict / domforlik).
  
  string
  
  FileName
  
  File name.
  
  string
  
  HistoryGuid
  
  History action document's unique identifier.
  
  string
  
  Important
  
  Document importancy flag.
  
  bool
  
  Note
  
  Free extra information related to the document.
  
  string
  
  UserEmail
  
  E-mail of the document author.
  
  string
  
  UserFullName
  
  Full name of the document author.
  
  string
  
  UserType
  
  Party type of the document author.
  
  Enum
  
  UserType
  
  User type.
  
  None
  
  User type is undefined.
  
  All
  
  All types.
  
  CreditorUser
  
  Creditor user type.
  
  SolicitorUser
  
  Solicitor user type.
  
  CreditorAndSolicitorUser
  
  Creditor | Solicitor user type.
  
  Debtor
  
  Debtor user type.
  
  CreditorUserAndDebtor
  
  Creditor Debtor user type
  
  SolicitorUserAndDebtor
  
  Solicito Debtor user type
  
  CreditorAndSolicitorUserAndDebtor
  
  Creditor Solicitor Debtor user type
- Result
  
  The result of the request. Indicating success or error.
  Object
  
  ResultType
  
  Common result type.
  
  ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
  
  ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

GetHistoryDocument

Returns the history action document.

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();

GetHistoryDocumentResult result = client.GetHistoryDocument(
    "0C1472C0-5732-4549-A45D-BF877A6E8C76",
    eDocumentLocationHint: : DocumentLocationHint.Undefined
);

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:GetHistoryDocument>
            <urn:HistoryGuid>0C1472C0-5732-4549-A45D-BF877A6E8C76</urn:HistoryGuid>
        </urn:GetHistoryDocument>
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
GetHistoryDocument

GetHistoryDocument
- eDocumentLocationHint
  
  Optional filter by document location hint.
  Enum
  
  DocumentLocationHint
  
  Document location hint.
  
  Undefined
  
  Undefined.
  
  ActionDocument
  
  ActionDocument.
  
  CollectionDocument
  
  CollectionDocument.
  
  DebtorDocument
  
  DebtorDocument.
- HistoryGuid
  
  Collection case history action document's unique identifier.
  
  string

Output

The document corresponding to collection case history action. If document is not found - error is returned
Error codes:

30701: collection account generic error

Object

GetHistoryDocumentResult

Result of GetHistoryDocument
Object
GetHistoryDocumentResult

General class for representing method output.
- Data
  
  Base64-encoded file body.
  
  string
- Extension
  
  File extension.
  
  string
- FileName
  
  File name.
  
  string
- Result
  
  The result of the request. Indicating success or error.
  Object
  
  ResultType
  
  Common result type.
  
  ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
  
  ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

GetMessages

Returns list of conversation messages related to ledger account / collection case for authenticated debtor(s).

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();

GetMessagesResult result = client.GetMessages(new GetMessagesRequest { ConversationGuid = "A4287D2A-F16C-4C38-A6E6-9F307626204D" });

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:GetMessages>
            <urn:GetMessagesRequest>
                <urn:ConversationGuid>A4287D2A-F16C-4C38-A6E6-9F307626204D</urn:ConversationGuid>
            </urn:GetMessagesRequest>
        </urn:GetMessages>
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
GetMessages

GetMessages
- GetMessagesRequest
  
  Conversation identification parameters.
  Object
  
  GetMessagesRequest
  
  General class for representing method input.
  
  ConversationGuid
  
  Conversation unique identifier.
  
  string

Output

List of messages for the conversation identified by input parameters.
Error codes:

1: unknown error or error message from ARC server

Object

GetMessagesResult

Result of GetMessages
Object
GetMessagesResult

General class for representing method output.
- Messages
  
  List of conversation messages.
  Array
  
  Object
  
  Message
  
  Holds information about conversation message.
  
  ConversationClosed Mandatory
  
  Conversation closed flag.
  
  bool
  
  ConversationGuid Mandatory
  
  Conversation unique identifier.
  
  string
  
  MessageGuid Mandatory
  
  Message unique identifier.
  
  string
  
  MessageText Mandatory
  
  Message text.
  
  string
  
  PostedAt Mandatory
  
  Message posting date.
  
  DateTime
  
  PostedBy Mandatory
  
  Message posting author.
  
  string
  
  ReplyToMessageGuid
  
  Unique identifier of the message being replied on.
  
  string
  
  Unread Mandatory
  
  Is the message unread.
  
  bool
- Result
  
  The result of the request. Indicating success or error.
  Object
  
  ResultType
  
  Common result type.
  
  ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
  
  ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

GetPaymentDetails

Return debtors payments details

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();

GetPaymentDetailsResult result = client.GetPaymentDetails();

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:GetPaymentDetails/>
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
GetPaymentDetails

GetPaymentDetails

Output

On success ResultCode = 0 and Payments collection of related payments On failure ResultCode = 1 and user readable error message

Object

GetPaymentDetailsResult

Result of GetPaymentDetails
Object
GetPaymentDetailsResult

GetPaymentDetails main result structure
- Payments
  
  Collection of payments belonging to debtors
  Array
  
  Object
  
  PaymentDetails
  
  Payment details
  
  Bankaccount
  
  Payment bankaccount (receiveing)
  
  string
  
  Currency
  
  Payment currency
  
  string
  
  Debts
  
  Debts covered by payment
  
  Array
  
  Object
  
  PaymentDebt
  
  Detailed payment booking information per debt basis
  
  CaseGuid
  
  Case identifier. Empty for unplaced amount/overpayment
  
  string
  
  CaseNumber
  
  Case number. Empty for unplaced amount/overpayment
  
  string
  
  CreditorGuid
  
  Creditor identifier. Empty for unplaced amount/overpayment
  
  string
  
  CreditorName
  
  Creditor name. Empty for unplaced amount/overpayment
  
  string
  
  CreditorRef
  
  Creditor reference. Empty for unplaced amount/overpayment
  
  string
  
  DebtGuid
  
  Debt identifier. Empty for unplaced amount/overpayment
  
  string
  
  DebtType
  
  Debt type. "Unknown" for unplaced amount/overpayment
  
  Enum
  
  DebtType
  
  Debt type.
  
  Unknown
  
  None.
  
  Principal
  
  Principal.
  
  ImportedFee
  
  ImportedFee.
  
  Fee
  
  Fee.
  
  Outlay
  
  Outlay.
  
  Credit
  
  Credit.
  
  Reservation
  
  Reservation.
  
  CapitalizedInterest
  
  CapitalizedInterest.
  
  Billed
  
  Billed.
  
  Due
  
  Due.
  
  PenaltyInterestOnPrincipal
  
  PenaltyInterestOnPrincipal.
  
  PenaltyInterestOnInterest
  
  PenaltyInterestOnInterest.
  
  Pretermination
  
  Pretermination.
  
  Termination
  
  Termination.
  
  Description
  
  Debt description. Empty for unplaced amount/overpayment
  
  string
  
  Disbursed
  
  If overpayment was already disbursed
  
  bool
  
  Interest
  
  Paid interest amount. Zero for unplaced amount/overpayment
  
  decimal
  
  Overpaid
  
  Entry for overpayment amount
  
  bool
  
  Principal
  
  Paid principal amount. For unplaced amount entry contains unplaced amount/overpayment
  
  decimal
  
  ReferenceNumber
  
  Debt reference. Empty for unplaced amount/overpayment
  
  string
  
  RegDate
  
  Case registration date. Empty for unplaced amount/overpayment
  
  DateTime
  
  PaidAmount
  
  Paid amount
  
  decimal
  
  PaidBy
  
  Payment source
  
  Enum
  
  PaidByType
  
  Paid by payment source
  
  DEBTOR
  
  Paid by debtor
  
  OTHER
  
  Paid by other
  
  AUTHORITY
  
  Paid by authority
  
  SOCIALWELFAREOFFICE
  
  Paid by Social welfare office
  
  INSURANCECOMPANY
  
  Paid by insurance company
  
  DEBTRELIEF
  
  Paid by debtrelief
  
  PaymentDate
  
  Payment date
  
  DateTime
  
  PaymentReference
  
  Used payment reference
  
  string
- Result
  
  The result of the request. Indicating success or error.
  Object
  
  ResultType
  
  Common result type.
  
  ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
  
  ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

GetPaymentplanDetails

Returns details of paymentplans related to debtors

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();

GetPaymentplanDetailsResult result = client.GetPaymentplanDetails();

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:GetPaymentplanDetails/>
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
GetPaymentplanDetails

GetPaymentplanDetails

Output

On success ResultCode = 0 and Paymentplans collection On failure ResultCode = 1 and user readable error message

Object

GetPaymentplanDetailsResult

Result of GetPaymentplanDetails
Object
GetPaymentplanDetailsResult

GetPaymentplanDetails main result structure
- Paymentplans
  
  Collection of paymentplans
  Array
  
  Object
  
  PaymentplanDetails
  
  Debtors paymentplan
  
  AdviceFee
  
  Advice fee
  
  decimal
  
  Amount
  
  Paymentplan amount
  
  decimal
  
  Cases
  
  Paymentplan cases
  
  Array
  
  Object
  
  PaymentplanCase
  
  Case of payment plan
  
  CaseGuid
  
  Case unqiueid
  
  string
  
  CaseNumber
  
  Case number
  
  string
  
  CreditorName
  
  Creditor name
  
  string
  
  RemainingFee
  
  Remaining fee
  
  decimal
  
  RemainingImportedFee
  
  Remaining imported fee
  
  decimal
  
  RemainingInterest
  
  Remaining interest amount
  
  decimal
  
  RemainingPrinciplal
  
  Remaining principal amount
  
  decimal
  
  Role
  
  Debtor role in case
  
  Enum
  
  DebtorRole
  
  Debtor role.
  
  Debtor
  
  Debtor.
  
  Guarantor
  
  Guarantor.
  
  Coapplicant
  
  Co-applicant.
  
  Estatebeneficiary
  
  Estate beneficiary.
  
  Tradingcompanypartner
  
  Trading company partner.
  
  Generalpartner
  
  General partner.
  
  Custodian
  
  Custodian.
  
  LimitedPartner
  
  Limited partner.
  
  Repurchaser
  
  Repurchaser.
  
  BankGuarantor
  
  Bank guarantor.
  
  OtherPledger
  
  Other pledger.
  
  BoardMember
  
  Board member.
  
  GuarantorAndOtherPledger
  
  Guarantor and other pledger.
  
  GuarantorAndCompanyPartner
  
  Guarantor and company partner.
  
  SoleProprietorUsingATradeName
  
  Sole proprietor using a trade name.
  
  SolventPerson
  
  Solvent person.
  
  Service
  
  Case service
  
  string
  
  Currency
  
  Currency
  
  string
  
  FeeCurrency
  
  Fee currency
  
  string
  
  Instalments
  
  Paymentplan instalments
  
  Array
  
  Object
  
  Instalment
  
  Paymentplan payment information
  
  Amount
  
  Instalment amount
  
  decimal
  
  InstalmentNo
  
  Instalment number
  
  int
  
  PaidAmount
  
  Paid amount
  
  decimal
  
  PaymentDate
  
  Pay date of installment
  
  DateTime
  
  PaymentReference
  
  Payment reference
  
  string
  
  Payments
  
  Collection of payments booked on this payment
  
  Array
  
  Object
  
  InstalmentPayment
  
  Payments booked to a instalment
  
  Fee
  
  Fee
  
  decimal
  
  Interest
  
  Interest
  
  decimal
  
  PaymentDate
  
  Payment date
  
  DateTime
  
  Principal
  
  Principal
  
  decimal
  
  Status
  
  Instalment status
  
  Enum
  
  InstalmentStatus
  
  Paymentplan instalment status (calculated)
  
  Unknown
  
  Unknown status
  
  Inactive
  
  Paymentplan is inactive
  
  Proposal
  
  Paymentplan was not activated yet
  
  Paused
  
  Paymentplan is paused
  
  Paid
  
  Instalment is fully paid
  
  Past
  
  Instalment is past
  
  Billed
  
  Instalment is billed
  
  Reminder
  
  Reminder is sent for instalment
  
  Future
  
  Future instalment
  
  IntervalType
  
  Interval type
  
  Enum
  
  IntervalType
  
  Payment plan interval type
  
  Unknown
  
  Unknown
  
  StartOfMonth
  
  Day in month payment period
  
  EndOfMonth
  
  Last day in month payment period
  
  Month
  
  Monthly payment period
  
  Day
  
  Days payment period
  
  OneTime
  
  One time payment period
  
  NumberOfPayments
  
  Number of payments
  
  int
  
  PaymentplanFee
  
  Paymentplan fee
  
  decimal
  
  PaymentplanGuid
  
  Paymentplan unique id
  
  string
  
  RegDate
  
  Paymentplan registration date
  
  DateTime
  
  RemainingPayments
  
  Number of remaining payments
  
  int
  
  ReminderFee
  
  Reminder fee
  
  decimal
  
  Status
  
  Paymentplan status
  
  Enum
  
  PaymentplanStatus
  
  Payment plan status
  
  Inactive
  
  Deactivated
  
  Active
  
  Active
  
  Proposal
  
  Proposal
  
  Paused
  
  Paused
  
  TotalFee
  
  Total fee
  
  decimal
  
  TotalInterest
  
  Total interest
  
  decimal
  
  TotalPrincipal
  
  Total principal
  
  decimal
- Result
  
  The result of the request. Indicating success or error.
  Object
  
  ResultType
  
  Common result type.
  
  ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
  
  ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

GetPowerOfAttorney

Return a list of all “PowerOfAttorney” structure linked to the debtor or case in the request

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();
GetPowerOfAttorneyResult result = client.GetPowerOfAttorney(new GetPowerOfAttorneyRequest{GeneralForDebtor = true});

Sample soap request:

 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
<soapenv:Header/>
<soapenv:Body>
   <urn:GetPowerOfAttorney>
      <urn:Request>
         <urn:GeneralForDebtor>true</urn:GeneralForDebtor>
      </urn:Request>
   </urn:GetPowerOfAttorney>
</soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
GetPowerOfAttorney

GetPowerOfAttorney
- Request
  
  Get power of attorney parameters
  Object
  
  GetPowerOfAttorneyRequest
  
  General class for representing method input.
  
  ForThisCase
  
  Information to find case to make relation
  
  Object
  
  CaseLookup
  
  The way to find a collection case in DB by several predefined criteria.
  
  CaseIdentification Mandatory
  
  Collection case identification type.
  
  Enum
  
  CaseIdentificationType
  
  Collection case identification type.
  
  CaseGuid
  
  Case GUID identification.
  
  CaseNumber
  
  Case number.
  
  AccountReferenceNumber
  
  Account reference number provided by the client.
  
  InvoiceNumber
  
  Invoice number of one on the debts provided by the client.
  
  PaymentReferenceNumber
  
  Payment reference number (OCR).
  
  CustomerNo
  
  Customer number for the debtor at the creditor side.
  
  CaseIdentificationValue Mandatory
  
  Identification value corresponding to identification type.
  
  string
  
  GeneralForDebtor Mandatory
  
  If true relation should add for debtor, false - relation should add for case
  
  bool

Output

list of all “PowerOfAttorney” which is linked to the debtor/case in the request
Error codes:

unknown error or error message from ARC server

Object

GetPowerOfAttorneyResult

Result of GetPowerOfAttorney
Object
GetPowerOfAttorneyResult

Result type for GetPowerOfAttorney function
- PowerOfAttorneys
  
  List of PowerOfAttorneys
  Array
  
  Object
  
  PowerOfAttorney
  
  General class for representing method input.
  
  AccessGranted
  
  Access Granted value
  
  bool
  
  Cases
  
  Information to lookup collection case(s).
  
  Array
  
  Object
  
  CaseLookup
  
  The way to find a collection case in DB by several predefined criteria.
  
  CaseIdentification Mandatory
  
  Collection case identification type.
  
  Enum
  
  CaseIdentificationType
  
  Collection case identification type.
  
  CaseGuid
  
  Case GUID identification.
  
  CaseNumber
  
  Case number.
  
  AccountReferenceNumber
  
  Account reference number provided by the client.
  
  InvoiceNumber
  
  Invoice number of one on the debts provided by the client.
  
  PaymentReferenceNumber
  
  Payment reference number (OCR).
  
  CustomerNo
  
  Customer number for the debtor at the creditor side.
  
  CaseIdentificationValue Mandatory
  
  Identification value corresponding to identification type.
  
  string
  
  GeneralForDebtor
  
  General For Debtor value
  
  bool
  
  GrantedAt
  
  Granted At value
  
  DateTime
  
  PowerOfAttorneyParty
  
  Power Of Attorney Party
  
  Object
  
  PowerOfAttorneyPartyGet
  
  Detailed information about POA party.
  
  Addresses
  
  List Addresses of party.
  
  Array
  
  Object
  
  Address
  
  Holds address information.
  
  CareOf
  
  Care of address.
  
  string
  
  City
  
  City.
  
  string
  
  CountryCode
  
  Country code, i.e. EN, SE etc.
  
  string
  
  DefaultAddress
  
  Whether this is the default address.
  
  bool
  
  FullAddress
  
  Combined address with all fields into single string.
  
  string
  
  FullName
  
  The full name of the receiving party, i.e name of person or company.
  
  string
  
  HouseNo
  
  House number.
  
  string
  
  HouseNoExtension
  
  House number extension.
  
  string
  
  StateCode
  
  State code if applicable.
  
  string
  
  Street
  
  Street address.
  
  string
  
  TypeCode Mandatory
  
  The type code of the address, i.e. what the address is used for, e.g. LEGAL, AVI, INVOICE, SITE, DELIVERY, TRUSTACCNT. Should be used one of predefined values using correct letter case.
  
  string
  
  UpdateExisting
  
  Whether this should update existing or create new address.
  
  bool
  
  ValidFrom
  
  The date when the address becomes active. If the element is missing, then do not change the current actual value.
  
  DateTime
  
  ValidTo
  
  The date after which the address becomes inactive. If the element is missing, then do not change the current actual value.
  
  DateTime
  
  ZipCode
  
  Zip code, i.e. postal code.
  
  string
  
  CellularPhone Mandatory
  
  Cellular phone of party
  
  string
  
  CultureCode
  
  Culture code of party
  
  string
  
  Email Mandatory
  
  Email of party
  
  string
  
  ExtraFields
  
  List extrafields of party.
  
  Array
  
  Object
  
  ExtraField
  
  Extra field contains custom data.
  
  Data
  
  Value of extra field.
  
  string
  
  Name
  
  Name of extra field.
  
  string
  
  Fullname Mandatory
  
  Full name of party
  
  string
  
  IdNumber Mandatory
  
  ID number of party.
  
  string
  
  LanguageCode Mandatory
  
  Language code of party
  
  string
  
  PartyGuid Mandatory
  
  Unique identifier of Party.
  
  string
  
  Telefax Mandatory
  
  Telefax of party
  
  string
  
  WorkPhone Mandatory
  
  Work phone of party
  
  string
  
  RevokedAt
  
  Revoked At value
  
  DateTime
- Result
  
  The result of the request. Indicating success or error.
  Object
  
  ResultType
  
  Common result type.
  
  ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
  
  ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

GetUnreadMessageCount

Returns total count of all unread conversation messages for authenticated debtor(s).

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();

GetMessageCountResult result = client.GetUnreadMessageCount();

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:GetUnreadMessageCount />
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
GetUnreadMessageCount

GetUnreadMessageCount

Output

Message count.
Error codes:

1: unknown error or error message from ARC server

Object

GetUnreadMessageCountResult

Result of GetUnreadMessageCount
Object
GetMessageCountResult

General class for representing method output.
- Result
  
  The result of the request. Indicating success or error.
  Object
  
  ResultType
  
  Common result type.
  
  ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
  
  ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string
- Total Mandatory
  
  Total number of messages.
  
  int

GetUnreadMessages

Returns list of all unread conversation messages for authenticated debtor(s).

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();

GetMessagesResult result = client.GetUnreadMessages();

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:GetUnreadMessages />
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
GetUnreadMessages

GetUnreadMessages

Output

List of messages.
Error codes:

1: unknown error or error message from ARC server

Object

GetUnreadMessagesResult

Result of GetUnreadMessages
Object
GetMessagesResult

General class for representing method output.
- Messages
  
  List of conversation messages.
  Array
  
  Object
  
  Message
  
  Holds information about conversation message.
  
  ConversationClosed Mandatory
  
  Conversation closed flag.
  
  bool
  
  ConversationGuid Mandatory
  
  Conversation unique identifier.
  
  string
  
  MessageGuid Mandatory
  
  Message unique identifier.
  
  string
  
  MessageText Mandatory
  
  Message text.
  
  string
  
  PostedAt Mandatory
  
  Message posting date.
  
  DateTime
  
  PostedBy Mandatory
  
  Message posting author.
  
  string
  
  ReplyToMessageGuid
  
  Unique identifier of the message being replied on.
  
  string
  
  Unread Mandatory
  
  Is the message unread.
  
  bool
- Result
  
  The result of the request. Indicating success or error.
  Object
  
  ResultType
  
  Common result type.
  
  ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
  
  ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

LogoutSession

Closes current authenticated debtor's session.

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();

bool result = client.LogoutSession();

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:LogoutSession />
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
LogoutSession

LogoutSession

Output

True if current session has been closed.

Error codes:

1 : [LogoutSession] Failed invoking RPC call
1 : [LogoutSession] Error occured during RPC call execution, please see log file for details

Object

LogoutSessionResult

Result of LogoutSession

bool

MarkMessageAsRead

Mark a conversation message for authenticated debtor as read/unread.

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();

ResultType result = client.MarkMessageAsRead(
    new MarkMessageAsReadRequest {
        MessageGuid = "A4287D2A-F16C-4C38-A6E6-9F307626204D",
        MarkAsRead = true
    }
);

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:MarkMessageAsRead>
            <urn:MarkMessageAsReadRequest>
                <urn:MarkAsRead>true</urn:MarkAsRead>
                <urn:MessageGuid>A4287D2A-F16C-4C38-A6E6-9F307626204D</urn:MessageGuid>
            </urn:MarkMessageAsReadRequest>
        </urn:MarkMessageAsRead>
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
MarkMessageAsRead

MarkMessageAsRead
- MarkMessageAsReadRequest
  
  Message identification parameters.
  Object
  
  MarkMessageAsReadRequest
  
  General class for representing method input.
  
  MarkAsRead Mandatory
  
  Message read flag to be set.
  
  bool
  
  MessageGuid Mandatory
  
  Message unique identifier.
  
  string

Output

Returns result code 0 if conversation message read/unread flag set.
Error codes:

1: unknown error or error message from ARC server
40901: The message is not found
40902: The message is connected to case that does not belong to current debtor

Object

MarkMessageAsReadResult

Result of MarkMessageAsRead
Object
ResultType

Common result type.
- ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
- ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

Ping

Make a ping request to see that the service is up and running.

This operation enables to check if service is available. The service will return a result code 0 if everything went ok. If something went wrong it will return a result code other than 0 and the result text will contain information about error. However if service is unreachable, e.g. not started, the service will not respond at all.

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();

try
{
    GeneralResult result = client.Ping();

    if (result.Result.ResultCode != 0)
    {
        throw new Exception(result.Result.ResultText ?? "Unknown error");
    }
}
catch(Exception e)
{
    throw new Exception("Failed to ping debtor access service.", e);
}

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:Ping/>
     </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
Ping

Ping

Output

Returns with result code 0 if ping was successful, otherwise read result text for error information.

Object

GeneralResult

Result of GeneralResult
Object
GeneralResult

A general result containing a result with result code and result text.
- Result
  
  The result of the request.
  Object
  
  ResultType
  
  Common result type.
  
  ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
  
  ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

PostMessage

Posts a conversation message from authenticated debtor.

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();

PostMessageResult result = client.PostMessage(
    new PostMessageRequest {
        ConversationGuid = "A4287D2A-F16C-4C38-A6E6-9F307626204D",
        Message = "New message from me"
    }
);

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:PostMessage>
            <urn:PostMessageRequest>
                <urn:ConversationGuid>A4287D2A-F16C-4C38-A6E6-9F307626204D</urn:ConversationGuid>
                <urn:Message>New message from me</urn:Message>
            </urn:PostMessageRequest>
        </urn:PostMessage>
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
PostMessage

PostMessage
- PostMessageRequest
  
  Conversation and message identification parameters.
  Object
  
  PostMessageRequest
  
  General class for representing method input.
  
  AttachedDocument
  
  Attached to message document
  
  Object
  
  AttachedDocument
  
  Holds document information.
  
  FileDataBase64 Mandatory
  
  Base64-encoded file body.
  
  string
  
  OriginalFileName Mandatory
  
  The file name to be generated instead of an auto-generated one.
  
  string
  
  ConversationGuid Mandatory
  
  Conversation unique identifier.
  
  string
  
  Message Mandatory
  
  Message body.
  
  string
  
  ReplyToMessageGuid
  
  Unique identifier of the message being replied on.
  
  string

Output

Unique identifier of the inserted message.
Error codes:

1: unknown error or error message from ARC server
40900: Cannot post message into closed conversation

Object

PostMessageResult

Result of PostMessage
Object
PostMessageResult

General class for representing method output.
- MessageGuid
  
  Message unique identifier.
  
  string
- Result Mandatory
  
  The result of the request. Indicating success or error.
  Object
  
  ResultType
  
  Common result type.
  
  ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
  
  ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

RequestPromiseToPayForDays

Requests promise to pay for specified number of phisical days starting from pay date on latest debt collection letter (action group = IK), or promise to pay register date if no letter is found, or pay date is passed, for authenticated debtor(s).

Examples

Sample usage in C# with generated client:

 DebtorAccessClient client = new DebtorAccessClient();

 ResultType result = client.RequestPromiseToPayForDays(
     new RequestPromiseToPayForDaysRequest
     {
         PromiseToPayForDays = 20,
         PromiseToPayLetter = true,
         CaseLookup = new CaseLookup { CaseIdentification = CaseIdentificationType.CaseNumber, CaseIdentificationValue = "41708" }
     }
 );

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:RequestPromiseToPayForDays>
         <urn:RequestPromiseToPayForDaysRequest>
            <urn:CaseLookup>
               <urn:CaseIdentification>CaseNumber</urn:CaseIdentification>
               <urn:CaseIdentificationValue>41708</urn:CaseIdentificationValue>
            </urn:CaseLookup>
            <urn:PromiseToPayForDays>20</urn:PromiseToPayForDays>
            <urn:PromiseToPayLetter>true</urn:PromiseToPayLetter>
         </urn:RequestPromiseToPayForDaysRequest>
      </urn:RequestPromiseToPayForDays>
   </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
RequestPromiseToPayForDays

RequestPromiseToPayForDays
- RequestPromiseToPayRequest
  
  Collection case and nomber of days for promise to pay parameters.
  Object
  
  RequestPromiseToPayForDaysRequest
  
  General class for representing RequestPromiseToPayForDays method input.
  
  CaseLookup Mandatory
  
  Information to lookup collection case(s).
  
  Object
  
  CaseLookup
  
  The way to find a collection case in DB by several predefined criteria.
  
  CaseIdentification Mandatory
  
  Collection case identification type.
  
  Enum
  
  CaseIdentificationType
  
  Collection case identification type.
  
  CaseGuid
  
  Case GUID identification.
  
  CaseNumber
  
  Case number.
  
  AccountReferenceNumber
  
  Account reference number provided by the client.
  
  InvoiceNumber
  
  Invoice number of one on the debts provided by the client.
  
  PaymentReferenceNumber
  
  Payment reference number (OCR).
  
  CustomerNo
  
  Customer number for the debtor at the creditor side.
  
  CaseIdentificationValue Mandatory
  
  Identification value corresponding to identification type.
  
  string
  
  PromiseToPayForDays Mandatory
  
  Number of days, from pay date on latest debt collection letter (action group = IK), or promise to pay register date if no letter is found, or pay date is passed, the promise to pay period will be valid for.
  
  int
  
  PromiseToPayLetter
  
  If a promise to pay letter should be sent or not.
  
  bool

Output

Result code 0 if promise to pay is successful.
Error codes:

30950: Invalid person or company identity number.
30951: Not allowed, missing rights in license
30952: Promise to pay days number must be greater than 0
30953: Can't find collection account(s).
30954: 'Promise to pay' can only be used with cases in the statuses allowed by the parameter 'Allowed statuses for promise to pay'.
30955: 'Promise to pay' for creditor is disabled by the parameter 'Promise to pay for creditor' or 'Max number of promise to pay requests from the debtor'.
30956: The age of the debt collection case is 151 days. The maximum age of a case for allowing a promise to pay is specified in the parameter 'Max age on case for promise to pay' (100).
30957: 'Promise to pay' for creditor is disabled by the parameter 'Max number of promise to pay requests from the debtor' (10).
30958: The date differs from parameter settings for min/max days for promise to pay. Dates according to parameters: min date 2021-01-01, max date 2021-10-01.
30959: Parameter 'Letter action for promise to pay letters' does not have a value, no letter action item code is available.
30960: Letter action '12345' specified in parameter 'Letter action for promise to pay letters' does not exist.

Object

RequestPromiseToPayForDaysResult

Result of RequestPromiseToPayForDays
Object
ResultType

Common result type.
- ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
- ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

RequestRespite

Requests respite until specified date for authenticated debtor(s).

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();

ResultType result = client.RequestRespite(
    new RequestRespiteRequest {
        RespiteUntil = new Date(2020, 10, 1),
        CaseLookup = new CaseLookup { CaseIdentification = CaseIdentificationType.CaseNumber, CaseIdentificationValue = "7" },
        VisibilityMask = VisibilityMaskType.ClientWebVisible
    }
);

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:RequestRespite>
            <urn:RequestRespiteRequest>
                <urn:CaseLookup>
                    <urn:CaseIdentification>CaseNumber</urn:CaseIdentification>
                    <urn:CaseIdentificationValue>7</urn:CaseIdentificationValue>
                </urn:CaseLookup>
                <urn:RespiteUntil>2020-10-01</urn:RespiteUntil>
                <urn:VisibilityMask>CustomerWebVisible</urn:VisibilityMask>
            </urn:RequestRespiteRequest>
        </urn:RequestRespite>
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
RequestRespite

RequestRespite
- RequestRespiteRequest
  
  Collection case and boundary date identification parameters.
  Object
  
  RequestRespiteRequest
  
  General class for representing method input.
  
  CaseLookup
  
  Information to lookup collection case(s).
  
  Object
  
  CaseLookup
  
  The way to find a collection case in DB by several predefined criteria.
  
  CaseIdentification Mandatory
  
  Collection case identification type.
  
  Enum
  
  CaseIdentificationType
  
  Collection case identification type.
  
  CaseGuid
  
  Case GUID identification.
  
  CaseNumber
  
  Case number.
  
  AccountReferenceNumber
  
  Account reference number provided by the client.
  
  InvoiceNumber
  
  Invoice number of one on the debts provided by the client.
  
  PaymentReferenceNumber
  
  Payment reference number (OCR).
  
  CustomerNo
  
  Customer number for the debtor at the creditor side.
  
  CaseIdentificationValue Mandatory
  
  Identification value corresponding to identification type.
  
  string
  
  RespiteUntil Mandatory
  
  Boundary date respite requested up to.
  
  DateTime
  
  VisibilityMask
  
  Visibility masks for history notes.
  
  Enum
  
  VisibilityMaskType
  
  Visibility mask type.
  
  NotVisible
  
  Not visible on client web nor debtor/customer web.
  
  ClientWebVisible
  
  Visible on client web.
  
  CustomerWebVisible
  
  Visible on debtor/customer web.
  
  EverywhereVisible
  
  Visible on both client and debtor/customer web.

Output

Result code 0 if respite is successful.
Error codes:

30500: invalid respite date
30600: respite request rejected
30700: selected cases missing or invalid
30800: respite request partially succeeded

Object

RequestRespiteResult

Result of RequestRespite
Object
ResultType

Common result type.
- ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
- ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

RequestRespiteForDays

Requests respite for specified number of phisical days starting from current date for authenticated debtor(s).

Examples

Sample usage in C# with generated client:

 DebtorAccessClient client = new DebtorAccessClient();

 ResultType result = client.RequestRespiteForDays(
     new RequestRespiteForDaysRequest
     {
         RespiteForDays = 15,
         CaseLookup = new CaseLookup { CaseIdentification = CaseIdentificationType.CaseNumber, CaseIdentificationValue = "41708" },
         VisibilityMask = VisibilityMaskType.ClientWebVisible
     }
 );

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:RequestRespiteForDays>
         <urn:RequestRespiteRequest>
            <urn:CaseLookup>
               <urn:CaseIdentification>CaseNumber</urn:CaseIdentification>
               <urn:CaseIdentificationValue>41708</urn:CaseIdentificationValue>
            </urn:CaseLookup>
            <urn:RespiteForDays>15</urn:RespiteForDays>
            <urn:VisibilityMask>CustomerWebVisible</urn:VisibilityMask>
         </urn:RequestRespiteRequest>
      </urn:RequestRespiteForDays>
   </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
RequestRespiteForDays

RequestRespiteForDays
- RequestRespiteRequest
  
  Collection case and nomber of days for respite parameters.
  Object
  
  RequestRespiteForDaysRequest
  
  General class for representing RequestRespiteForDays method input.
  
  CaseLookup
  
  Information to lookup collection case(s).
  
  Object
  
  CaseLookup
  
  The way to find a collection case in DB by several predefined criteria.
  
  CaseIdentification Mandatory
  
  Collection case identification type.
  
  Enum
  
  CaseIdentificationType
  
  Collection case identification type.
  
  CaseGuid
  
  Case GUID identification.
  
  CaseNumber
  
  Case number.
  
  AccountReferenceNumber
  
  Account reference number provided by the client.
  
  InvoiceNumber
  
  Invoice number of one on the debts provided by the client.
  
  PaymentReferenceNumber
  
  Payment reference number (OCR).
  
  CustomerNo
  
  Customer number for the debtor at the creditor side.
  
  CaseIdentificationValue Mandatory
  
  Identification value corresponding to identification type.
  
  string
  
  RespiteForDays Mandatory
  
  Number of days to request respite starting from current date.
  
  int
  
  VisibilityMask
  
  Visibility masks for history notes.
  
  Enum
  
  VisibilityMaskType
  
  Visibility mask type.
  
  NotVisible
  
  Not visible on client web nor debtor/customer web.
  
  ClientWebVisible
  
  Visible on client web.
  
  CustomerWebVisible
  
  Visible on debtor/customer web.
  
  EverywhereVisible
  
  Visible on both client and debtor/customer web.

Output

Result code 0 if respite is successful.
Error codes:

30500: invalid respite date
30600: respite request rejected
30700: selected cases missing or invalid
30800: respite request partially succeeded
30900: invalid respite days number

Object

RequestRespiteForDaysResult

Result of RequestRespiteForDays
Object
ResultType

Common result type.
- ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
- ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

SetNotificationChannel

Allows setting notification channel for the specific conversation from authenticated debtor.

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();

ResultType result = client.SetNotificationChannel(
    new SetNotificationChannelRequest {
        ConversationGuid = "A4287D2A-F16C-4C38-A6E6-9F307626204D",
        PreferredChannel = "EMAIL",
        Email = "gooduser@sole.com"
    }
);

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:SetNotificationChannel>
            <urn:SetNotificationChannelRequest>
                <urn:ConversationGuid>A4287D2A-F16C-4C38-A6E6-9F307626204D</urn:ConversationGuid>
                <urn:Email>gooduser@sole.com</urn:Email>
                <urn:PreferredChannel>EMAIL</urn:PreferredChannel>
            </urn:SetNotificationChannelRequest>
        </urn:SetNotificationChannel>
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
SetNotificationChannel

SetNotificationChannel
- SetNotificationChannelRequest
  
  Communication channel and conversation identification parameters.
  Object
  
  SetNotificationChannelRequest
  
  General class for representing method input.
  
  ConversationGuid Mandatory
  
  Conversation unique identifier.
  
  string
  
  Email
  
  If preferred way of notification is EMAIL - contains e-mail address to notify debtor
  
  string
  
  MobilePhone
  
  If preferred way of notification is SMS - contains mobile phone number to notify debtor
  
  string
  
  PreferredChannel Mandatory
  
  Debtor's preferred notification channel. Should be NONE, EMAIL or SMS
  
  string

Output

Unique identifier of the inserted message.
Error codes:

1: unknown error or error message from ARC server

60400: PreferredChannel: NONE | EMAIL | SMS

60500: A valid e-mail address must be provided

60600: A valid mobile phone number must be provided

Object

SetNotificationChannelResult

Result of SetNotificationChannel
Object
ResultType

Common result type.
- ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
- ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

UpdateLimitationDate

Updates limitation date for collection cases debts of authenticated debtor.

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();

GeneralResult result = client.UpdateLimitationDate(
    new UpdateLimitationDateRequest {
        InterruptionDate = new DateTime(2020, 12, 1)
    }
);

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:UpdateLimitationDate>
            <urn:UpdateLimitationDateRequest>
                <urn:InterruptionDate>2020-12-01</urn:InterruptionDate>
            </urn:UpdateLimitationDateRequest>
        </urn:UpdateLimitationDate>
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
UpdateLimitationDate

UpdateLimitationDate
- UpdateLimitationDateRequest
  
  Limitation date identification parameters.
  Object
  
  UpdateLimitationDateRequest
  
  General class for representing method input.
  
  InterruptionDate
  
  Interruption date.
  
  DateTime

Output

Return code 0 if limitation date has been updated.
Error codes:

1: unknown error or error message from ARC server

Object

UpdateLimitationDateResult

Result of UpdateLimitationDate
Object
GeneralResult

A general result containing a result with result code and result text.
- Result
  
  The result of the request.
  Object
  
  ResultType
  
  Common result type.
  
  ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
  
  ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

UpdatePowerOfAttorney

Update party of type “PowerOfAttorney” and linked to the debtor/case in the dat_relation table

Examples

Sample usage in C# with generated client:

DebtorAccessClient client = new DebtorAccessClient();
ResultType result = client.UpdatePowerOfAttorney(
    new UpdatePowerOfAttorneyRequest{
       PowerOfAttorneyPartyGuid = "A4287D2A-F16C-4C38-A6E6-9F307626204D",
       PowerOfAttorney = new PowerOfAttorney{
          AccessGranted = true,
           GeneralForDebtor = false,
           Cases = new List<CaseLookup> {
              new CaseLookup { CaseIdentification = CaseIdentificationType.CaseNumber, CaseIdentificationValue = "36168" }
           }.ToArray(),
           PowerOfAttorneyParty = new PowerOfAttorneyParty{
           Addresses = new List<Address>().ToArray(),
           ExtraFields = new List<ExtraField>().ToArray()
       }
   },
});

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:UpdatePowerOfAttorney>
         <urn:Request>
            <urn:PowerOfAttorney>
               <!--Optional:-->
               <urn:AccessGranted>1</urn:AccessGranted>
               <!--Optional:-->
               <urn:Cases>
                  <!--Zero or more repetitions:-->
                  <urn:CaseLookup>
                     <urn:CaseIdentification>CaseNumber</urn:CaseIdentification>
                     <urn:CaseIdentificationValue>13197</urn:CaseIdentificationValue>
                  </urn:CaseLookup>
               </urn:Cases>
               <!--Optional:-->
               <urn:GeneralForDebtor>false</urn:GeneralForDebtor>
               <!--Optional:-->
               <urn:GrantedAt>2000-10-10</urn:GrantedAt>
               <!--Optional:-->
               <urn:RevokedAt>2000-10-10</urn:RevokedAt>
            </urn:PowerOfAttorney>
            <urn:PowerOfAttorneyPartyGuid>16C79619-3B51-4013-80E7-731360BCDE09</urn:PowerOfAttorneyPartyGuid>
         </urn:Request>
      </urn:UpdatePowerOfAttorney>
   </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
UpdatePowerOfAttorney

UpdatePowerOfAttorney
- Request
  
  Update power of attorney parameters.
  Object
  
  UpdatePowerOfAttorneyRequest
  
  General class for representing method input.
  
  PowerOfAttorney Mandatory
  
  Data structure with information for update
  
  Object
  
  PowerOfAttorneyUpdate
  
  General class for representing method input.
  
  AccessGranted
  
  Access Granted value
  
  bool
  
  Cases
  
  Information to lookup collection case(s).
  
  Array
  
  Object
  
  CaseLookup
  
  The way to find a collection case in DB by several predefined criteria.
  
  CaseIdentification Mandatory
  
  Collection case identification type.
  
  Enum
  
  CaseIdentificationType
  
  Collection case identification type.
  
  CaseGuid
  
  Case GUID identification.
  
  CaseNumber
  
  Case number.
  
  AccountReferenceNumber
  
  Account reference number provided by the client.
  
  InvoiceNumber
  
  Invoice number of one on the debts provided by the client.
  
  PaymentReferenceNumber
  
  Payment reference number (OCR).
  
  CustomerNo
  
  Customer number for the debtor at the creditor side.
  
  CaseIdentificationValue Mandatory
  
  Identification value corresponding to identification type.
  
  string
  
  GeneralForDebtor
  
  General For Debtor value
  
  bool
  
  GrantedAt
  
  Granted At value
  
  DateTime
  
  PowerOfAttorneyParty
  
  Power Of Attorney Party
  
  Object
  
  PowerOfAttorneyPartyUpdate
  
  Detailed information about POA party.
  
  Addresses
  
  List Addresses of party.
  
  Array
  
  Object
  
  Address
  
  Holds address information.
  
  CareOf
  
  Care of address.
  
  string
  
  City
  
  City.
  
  string
  
  CountryCode
  
  Country code, i.e. EN, SE etc.
  
  string
  
  DefaultAddress
  
  Whether this is the default address.
  
  bool
  
  FullAddress
  
  Combined address with all fields into single string.
  
  string
  
  FullName
  
  The full name of the receiving party, i.e name of person or company.
  
  string
  
  HouseNo
  
  House number.
  
  string
  
  HouseNoExtension
  
  House number extension.
  
  string
  
  StateCode
  
  State code if applicable.
  
  string
  
  Street
  
  Street address.
  
  string
  
  TypeCode Mandatory
  
  The type code of the address, i.e. what the address is used for, e.g. LEGAL, AVI, INVOICE, SITE, DELIVERY, TRUSTACCNT. Should be used one of predefined values using correct letter case.
  
  string
  
  UpdateExisting
  
  Whether this should update existing or create new address.
  
  bool
  
  ValidFrom
  
  The date when the address becomes active. If the element is missing, then do not change the current actual value.
  
  DateTime
  
  ValidTo
  
  The date after which the address becomes inactive. If the element is missing, then do not change the current actual value.
  
  DateTime
  
  ZipCode
  
  Zip code, i.e. postal code.
  
  string
  
  CellularPhone
  
  Cellular phone of party
  
  string
  
  CultureCode
  
  Culture code of party
  
  string
  
  Email
  
  Email of party
  
  string
  
  ExtraFields
  
  List extrafields of party.
  
  Array
  
  Object
  
  ExtraField
  
  Extra field contains custom data.
  
  Data
  
  Value of extra field.
  
  string
  
  Name
  
  Name of extra field.
  
  string
  
  Fullname
  
  Full name of party
  
  string
  
  IdNumber
  
  ID number of party.
  
  string
  
  LanguageCode
  
  Language code of party
  
  string
  
  Telefax
  
  Telefax of party
  
  string
  
  WorkPhone
  
  Work phone of party
  
  string
  
  RevokedAt
  
  Revoked At value
  
  DateTime
  
  PowerOfAttorneyPartyGuid Mandatory
  
  Party guid for adding relation. If this value is empty, new party is created
  
  string

Output

Result code 0 if booking is successful.
Error codes:

1: generic error message from ARC server

Object

UpdatePowerOfAttorneyResult

Result of UpdatePowerOfAttorney
Object
ResultType

Common result type.
- ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
- ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string