CollectionInformation

Service for accessing collection information.

ActionEvent

Triggers a action event.

Examples

Sample usage in C# with generated client: 
CollectionInformationClient client = new CollectionInformationClient();

GeneralResult result = client.ActionEvent(
    "UNKNOWN",
    "undefined",
    1,
    2,
    "someArgument1",
    "someArgument2",
    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:ActionEvent>
            <urn:Argument1>someArgument1.</urn:Argument1>
            <urn:Argument2>someArgument2.</urn:Argument2>
            <urn:BaseExtraLinkId>2.</urn:BaseExtraLinkId>
            <urn:BaseId>1</urn:BaseId>
            <urn:BaseType>undefined</urn:BaseType>
            <urn:EventType>UNKNOWN</urn:EventType>
            <urn:ProcessImmediately>true</urn:ProcessImmediately>
        </urn:ActionEvent>
    </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    ActionEvent

    ActionEvent

    • Argument1

      Value corresponding to event argument in action package handling.

      string

    • Argument2

      Value corresponding to event argument in action package handling.

      string

    • BaseExtraLinkId

      Value corresponding to action event BaseExtraLinkID.

      int

    • BaseId

      Value corresponding to action event baseID.

      int

    • BaseType

      Value corresponding to action event base type.
      Enum

      ActionBaseType

      ActionBaseType.

      • Undefined

        Undefined.

      • CollectionAccount

        CollectionAccount.

      • PaymentPlan

        PaymentPlan.

      • Legal

        Legal.

      • Offer

        Offer.

      • Bankruptcy

        Bankruptcy.

      • Deceased

        Deceased.

      • DebtRelief

        DebtRelief.

      • CompanyReorganisation

        CompanyReorganisation.

      • Debtor

        Debtor.

      • LedgerAccount

        LedgerAccount.

      • LedgerAccountGroup

        LedgerAccountGroup.

      • Ticket

        Ticket.

      • CollectionAccountGroup

        CollectionAccountGroup.

    • EventType

      Value corresponding to event type code in action events.
      Enum

      ActionEventType

      ActionEventType.

      • STARTUP

        STARTUP.

      • TIMEOUT

        TIMEOUT.

      • USER_ALTERNATIVE

        USER_ALTERNATIVE.

      • TIMER

        TIMER.

      • DECISION

        DECISION.

      • UNKNOWN

        UNKNOWN.

      • PAYMENT

        PAYMENT.

      • PAYMENT_AUTHORITY

        PAYMENT_AUTHORITY.

      • CUSTOM

        CUSTOM.

      • VERIFICATION

        VERIFICATION.

      • MESSAGE_SENT

        MESSAGE_SENT.

      • AMOUNTADJUSTMENT

        AMOUNTADJUSTMENT.

      • NEWINVOICEADDED

        NEWINVOICEADDED.

      • NEWDEBTORADDED

        NEWDEBTORADDED.

      • FULLPAYMENT

        FULLPAYMENT.

      • CLOSURE

        CLOSURE.

      • NEWACCOUNTADDED

        NEWACCOUNTADDED.

      • MESSAGE_CONFIRMED

        MESSAGE_CONFIRMED.

      • MESSAGE_CONFIRM_FAILED

        MESSAGE_CONFIRM_FAILED.

      • PROCESSINGERROR

        PROCESSINGERROR.

      • OBJECTION

        OBJECTION.

      • CREDIT_ANSWER

        CREDIT_ANSWER.

      • ACTIONGROUPING_IGNORED

        ACTIONGROUPING_IGNORED.

      • DEBTOR_NEW_ADDRESS

        DEBTOR_NEW_ADDRESS.

      • DEBTOR_ADDRESS_NOTVALID

        DEBTOR_ADDRESS_NOTVALID.

      • DEBTOR_UPDATE

        DEBTOR_UPDATE.

      • PP_FIRST_PAYMENT_ADVICE

        PP_FIRST_PAYMENT_ADVICE.

      • PP_PAYMENT_ADVICE

        PP_PAYMENT_ADVICE.

      • PP_LAST_PAYMENT_ADVICE

        PP_LAST_PAYMENT_ADVICE.

      • PP_MISSED_PAYMENT

        PP_MISSED_PAYMENT.

      • PP_BROKEN_AGREEMENT

        PP_BROKEN_AGREEMENT.

      • PP_REMINDER

        PP_REMINDER.

      • PP_PAYMENT

        PP_PAYMENT.

      • PP_PARTPAYMENT

        PP_PARTPAYMENT.

      • PP_EXTERNAL_PAYMENT

        PP_EXTERNAL_PAYMENT.

      • PP_EXTERNAL_ADJUSTMENT

        PP_EXTERNAL_ADJUSTMENT.

      • PP_FIRSTPAYMENT

        PP_FIRSTPAYMENT.

      • PP_COMPLETED

        PP_COMPLETED.

      • PP_LATE_PAYMENT_ADVICE

        PP_LATE_PAYMENT_ADVICE.

      • PP_REMINDER_AND_ADVICE

        PP_REMINDER_AND_ADVICE.

      • PP_STOPPED

        PP_STOPPED.

      • PP_REPLACED

        PP_REPLACED.

      • PP_ACTIVATED

        PP_ACTIVATED.

      • LEGAL_VERDICT

        LEGAL_VERDICT.

      • LEGAL_RENEWAL

        LEGAL_RENEWAL.

      • LEGAL_CASEINFO

        LEGAL_CASEINFO.

      • LEGAL_REPORT

        LEGAL_REPORT.

      • LEGAL_LEX

        LEGAL_LEX.

      • LEGAL_BECOMINGFINAL

        LEGAL_BECOMINGFINAL.

      • LEGAL_FINALPAYMENT

        LEGAL_FINALPAYMENT.

      • LEGAL_NEWLEGALDOCUMENT

        LEGAL_NEWLEGALDOCUMENT.

      • LEGAL_FI_SUMMONS_ERROR

        LEGAL_FI_SUMMONS_ERROR.

      • CUSTOMER_UPDATE

        CUSTOMER_UPDATE.

      • CUSTOMER_ADDRESS_NOTVALID

        CUSTOMER_ADDRESS_NOTVALID.

      • BANKRUPTCY_ADDED

        BANKRUPTCY_ADDED.

      • DECEASED_ADDED

        DECEASED_ADDED.

      • DEBTRELIEF_ADDED

        DEBTRELIEF_ADDED.

      • DEBTRELIEF_UPDATED

        DEBTRELIEF_UPDATED.

      • COMPANYREORGANISATION_ADDED

        COMPANYREORGANISATION_ADDED.

      • TRANSACTION_IMPORTED

        TRANSACTION_IMPORTED.

      • PRINTLETTER_CONDITION_FALSE

        PRINTLETTER_CONDITION_FALSE.

      • INTEREST_INVOICING_INFO_CREATED

        INTEREST_INVOICING_INFO_CREATED.

      • INTEREST_INVOICING_INFO_DELETED

        INTEREST_INVOICING_INFO_DELETED.

      • DUE_DATE_CHANGED

        DUE_DATE_CHANGED.

      • AUTOTRANSFER_EVENT

        AUTOTRANSFER_EVENT.

      • OFFER_PAID_IN_FULL

        OFFER_PAID_IN_FULL.

      • USER_QUESTION_ANSWER

        USER_QUESTION_ANSWER.

      • CUSTOMERACCOUNT_FIRST_SETTLEMENT

        CUSTOMERACCOUNT_FIRST_SETTLEMENT.

      • CUSTOMERACCOUNT_SETTLEMENT

        CUSTOMERACCOUNT_SETTLEMENT.

      • CUSTOMERACCOUNT_LAST_SETTLEMENT

        CUSTOMERACCOUNT_LAST_SETTLEMENT.

      • CUSTOMERACCOUNT_MISSED_PAYMENT_MINIMUM_TO_PAY

        CUSTOMERACCOUNT_MISSED_PAYMENT_MINIMUM_TO_PAY.

      • CUSTOMERACCOUNT_BROKEN_SETTLEMENT

        CUSTOMERACCOUNT_BROKEN_SETTLEMENT.

      • CUSTOMERACCOUNT_REMINDER

        CUSTOMERACCOUNT_REMINDER.

      • CUSTOMERACCOUNT_PAYMENT

        CUSTOMERACCOUNT_PAYMENT.

      • CUSTOMERACCOUNT_PARTPAYMENT

        CUSTOMERACCOUNT_PARTPAYMENT.

      • CUSTOMERACCOUNT_PAYMENTFREE_SETTLEMENT

        CUSTOMERACCOUNT_PAYMENTFREE_SETTLEMENT.

      • CUSTOMERACCOUNT_DEBTCOLLECTION

        CUSTOMERACCOUNT_DEBTCOLLECTION.

      • CUSTOMERACCOUNT_MISSED_PAYMENT_MINIMUM_TO_PAY_INCLUDING_CAMPAIGN

        CUSTOMERACCOUNT_MISSED_PAYMENT_MINIMUM_TO_PAY_INCLUDING_CAMPAIGN.

      • CUSTOMERACCOUNT_STATEMENTOFACCOUNT

        ccCUSTOMERACCOUNT_STATEMENTOFACCOUNT.

      • CUSTOMERACCOUNT_CREDITSTOPCAUSE_ADDED

        CUSTOMERACCOUNT_CREDITSTOPCAUSE_ADDED.

      • CUSTOMERACCOUNT_CREDITSTOPCAUSE_REMOVED

        CUSTOMERACCOUNT_CREDITSTOPCAUSE_REMOVED.

      • CUSTOMERACCOUNT_CAMPAIGNEVENT

        CUSTOMERACCOUNT_CAMPAIGNEVENT.

      • CUSTOMERACCOUNT_CAMPAIGN_CREATED_RETROACTIVELY

        CUSTOMERACCOUNT_CAMPAIGN_CREATED_RETROACTIVELY.

      • CUSTOMERACCOUNT_CAMPAIGN_ACTIVATED

        CUSTOMERACCOUNT_CAMPAIGN_ACTIVATED.

      • CUSTOMERACCOUNT_LOAN_LETTER_FLOATING

        CUSTOMERACCOUNT_LOAN_LETTER_FLOATING.

      • CUSTOMERACCOUNT_LOAN_LETTER_NEWFIXEDINTERESTTERM

        CUSTOMERACCOUNT_LOAN_LETTER_NEWFIXEDINTERESTTERM.

      • CUSTOMERACCOUNT_LOAN_LETTER_INFIXEDINTERESTTERM

        CUSTOMERACCOUNT_LOAN_LETTER_INFIXEDINTERESTTERM.

      • CUSTOMERACCOUNT_LOAN_LETTER_REMINDER

        CUSTOMERACCOUNT_LOAN_LETTER_REMINDER.

      • CUSTOMERACCOUNT_LOAN_TERMINATION

        CUSTOMERACCOUNT_LOAN_TERMINATION.

      • CUSTOMERACCOUNT_LOAN_PRETERMINATION

        CUSTOMERACCOUNT_LOAN_PRETERMINATION.

      • CUSTOMERACCOUNT_LOAN_REVERSETERMINATION

        CUSTOMERACCOUNT_LOAN_REVERSETERMINATION.

      • CUSTOMERACCOUNT_VIRT_INSTALMENT_INVOICING

        CUSTOMERACCOUNT_VIRT_INSTALMENT_INVOICING.

      • CUSTOMERACCOUNT_VIRT_REMINDER

        CUSTOMERACCOUNT_VIRT_REMINDER.

      • CUSTOMERACCOUNT_VIRT_TERMINATION

        CUSTOMERACCOUNT_VIRT_TERMINATION.

      • CUSTOMERACCOUNT_INCREASED_AMOUNT_TO_PAY

        CUSTOMERACCOUNT_INCREASED_AMOUNT_TO_PAY.

      • CUSTOMERACCOUNT_CREDITDEBTINSURANCE_ADDED

        CUSTOMERACCOUNT_CREDITDEBTINSURANCE_ADDED.

      • CUSTOMERACCOUNT_CREDITDEBTINSURANCE_UPDATED

        CUSTOMERACCOUNT_CREDITDEBTINSURANCE_UPDATED.

      • CUSTOMERACCOUNT_CREDITDEBTINSURANCE_DELETED

        CUSTOMERACCOUNT_CREDITDEBTINSURANCE_DELETED.

      • CUSTOMERACCOUNT_CREDITDEBTINSURANCE_STATUSCHANGED

        CUSTOMERACCOUNT_CREDITDEBTINSURANCE_STATUSCHANGED.

      • CUSTOMERACCOUNT_USED_RIGHT_TO_WITHDRAW

        CUSTOMERACCOUNT_USED_RIGHT_TO_WITHDRAW.

      • CUSTOMERACCOUNT_ACCOUNT_TRANSFER

        CUSTOMERACCOUNT_ACCOUNT_TRANSFER.

      • LEDGER_RETURN

        LEDGER_RETURN.

      • LEDGERACCOUNT_EVENT

        LEDGERACCOUNT_EVENT.

      • COLLECTIONACCOUNTGROUP_CASE_ADDED

        COLLECTIONACCOUNTGROUP_CASE_ADDED.

      • COLLECTIONACCOUNTGROUP_CASE_REMOVED

        COLLECTIONACCOUNTGROUP_CASE_REMOVED.

      • COLLECTIONACCOUNT_AUTO_CASE_REVOKE

        COLLECTIONACCOUNT_AUTO_CASE_REVOKE.

      • AUTHSIGN_APPROVED

        AUTHSIGN_APPROVED.

      • AUTHSIGN_TIMEOUT

        AUTHSIGN_TIMEOUT.

      • AUTHSIGN_REJECTED

        AUTHSIGN_REJECTED.

      • NEWDOCUMENT

        NEWDOCUMENT.

      • LEDGERACCOUNT_MERGE

        LEDGERACCOUNT_MERGE.

      • LEDGERACCOUNT_REWRITE

        LEDGERACCOUNT_REWRITE.

      • BAILIFF_CANCELLATION

        Information on cancellation reported by the bailiff.

      • BAILIFF_LIMITATION_CREDITOR

        Information on the creditor’s liability to interrupt limitation.

      • BAILIFF_FINAL_REMITTANCE

        Information on final remittance by the bailiff.

      • BAILIFF_OBSTACLE_LACKOFFUNDS

        Obstacle: debtor lacks funds.

      • BAILIFF_OBSTACLE_LACKOFFUNDS_UNKNOWN

        Obstacle: debtor lacks funds and is unknown.

      • BAILIFF_OBSTACLE_OTHER

        Obstacle: other.

      • BAILIFF_OBSTACLE_LIMITEDENFORCEMENT

        Obstacle: limited enforcement.

      • BAILIFF_OBSTACLE_LIMITEDENFORCEMENT_UNKNOWN

        Obstacle: limited enforcement and unknown.

      • BAILIFF_DEBTOR_STATUS_UPDATE

        Debtor: status update.

      • BAILIFF_BALANCE

        Debtor: balance inquiry..

      • OBJECT_UPDATE

        OBJECT_UPDATE.

    • ProcessImmediately

      Process action event immediately.

      bool

Output

Returns result code 0 if event is triggered.
Object

ActionEventResponse

PostActionEvent response.

  • ActionEventResult

    Result of ActionEvent.
    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

CaseSearch

Returns list of collection cases.

Examples

Sample usage in C# with generated client: 
 CollectionInformationClient client = new CollectionInformationClient();

 CaseSearchCriteria caseSearch = new CaseSearchCriteria
 {
 	CriteriaType = CaseSearchCriteriaType.CaseNumber,
 	Value = "10"
 };

 List<CaseSearchCriteria> listCaseSearchCriterias = new List<CaseSearchCriteria>();
 listCaseSearchCriterias.Add(caseSearch);

 CaseSearchResult result = client.CaseSearch(
 		new CaseSearchRequest
 		{
 			PageLength = 10,
 			PageNo = 2,
 			Sorting = CaseSortingType.CaseNumber,
 			Descending = false,
 			CaseSearchCriterias = listCaseSearchCriterias.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:CaseSearch>
         <urn:caseSearchRequest>
            <urn:CaseSearchCriterias>
               <urn:CaseSearchCriteria>
                  <urn:CriteriaType>CaseNumber</urn:CriteriaType>
                  <urn:Value>10</urn:Value>
               </urn:CaseSearchCriteria>
            </urn:CaseSearchCriterias>
            <urn:Descending>true</urn:Descending>
            <urn:PageLength>3</urn:PageLength>
            <urn:PageNo>1</urn:PageNo>
            <urn:Sorting>CaseNumber</urn:Sorting>
         </urn:caseSearchRequest>
      </urn:CaseSearch>
   </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Information to search case(s), pagination and sorting.
    Object

    CaseSearch

    CaseSearch

    • caseSearchRequest

      Information to search case(s), pagination and sorting.
      Object

      CaseSearchRequest

      The way to find a collection case in DB by several predefined criteria.

      • CaseSearchCriterias Mandatory

        List criterias for search
        Array
        Object

        CaseSearchCriteria

        The way to find a collection case in DB by several predefined criteria.

        • CriteriaType Mandatory

          Collection case search criteria type.
          Enum

          CaseSearchCriteriaType

          Collection case search criteria 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.

          • DebtorSSNOrCompanyNo

            Debtor SSN or Company number

          • DebtorGuid

            Debtor unique identifier

          • DebtorName

            Debtor name

          • ClientReferenceNumber

            Client reference number provided by the client.

        • Value Mandatory

          Case search value corresponding to criteria type.

          string

      • Descending

        Is sort descendin?

        bool

      • PageLength

        Page length

        int

      • PageNo

        Page number

        int

      • Sorting

        Sorting type
        Enum

        CaseSortingType

        Sorting type for Case search request

        • CaseNumber

          Sort by case number

        • AccountReferenceNumber

          Sort by account reference number

        • SSNOrCompanyNo

          Sort by SSN or Company number

        • DebtorName

          Sort by debtor name

        • RemainingSum

          Sort by remeining sum

Output

List of collection cases filtered by parameters. If filter format is incorrect - error is returned
Error codes:
  • 1 : [CaseSearchOutput] Failed invoking RPC call
  • 1 : error message from ARC server
Object

CaseSearchResponse

CaseSearch response.

  • CaseSearchResult

    Result of CaseSearch.
    Object

    CaseSearchResult

    General class for representing case search method output.

    • Cases Mandatory

      List of collection cases.
      Array
      Object

      CaseSearchSummary

      Detailed information about collection case.

      • AccountReferenceNumber Mandatory

        Account reference number

        string

      • CaseGuid Mandatory

        Collection case unique identifier.

        string

      • CaseNumber Mandatory

        Case number.

        string

      • ClientName Mandatory

        Client name

        string

      • ClientReferenceNumber Mandatory

        Party reference code.

        string

      • CreditorDebtorRef Mandatory

        Creditor debtor reference

        string

      • CurrencyCode Mandatory

        Currency code, e.g. SEK, NOK, EUR etc.

        string

      • InvoiceNumbers Mandatory

        Invoice numbers
        Array

        string

      • MainDebtorFullName Mandatory

        Main debtor full name

        string

      • MainDebtorSSNOrCompanyNumber Mandatory

        Main debtor ssn or company number

        string

      • OriginalFee Mandatory

        Original fee.

        decimal

      • OriginalInterest Mandatory

        Original interest.

        decimal

      • OriginalPrincipal Mandatory

        Original principal.

        decimal

      • OriginalSum Mandatory

        Original total amount.

        decimal

      • PaidFee Mandatory

        Paid fee.

        decimal

      • PaidInterest Mandatory

        Paid interest.

        decimal

      • PaidPrincipal Mandatory

        Paid principal.

        decimal

      • PaidSum Mandatory

        Paid total amount.

        decimal

      • PaidToThirdParty Mandatory

        Not used now, always 0.

        decimal

      • RegistrationDate Mandatory

        Case registration date.

        DateTime

      • RemainingFee Mandatory

        Remaining fee.

        decimal

      • RemainingInterest Mandatory

        Remaining interest.

        decimal

      • RemainingPrincipal Mandatory

        Remaining principal.

        decimal

      • RemainingSum Mandatory

        Remaining total amount.

        decimal

      • Service Mandatory

        Collection account service.

        string

      • Status Mandatory

        Collection account status.

        string

      • SubStatus Mandatory

        Collection account substatus.

        string

    • PageLenght Mandatory

      Page lenght, default set to 100

      int

    • PageNo Mandatory

      Page number, default set to 1

      int

    • 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

    • TotalPages Mandatory

      pages count, default set to 0

      int

GetCaseDetails

Returns collection case detailed information.

Examples

Sample usage in C# with generated client: 
CollectionInformationClient client = new CollectionInformationClient();

GetCaseDetailsResult result = client.GetCaseDetails(
    new CaseLookup { CaseIdentification = CaseIdentificationType.CustomerNo, CaseIdentificationValue = "2" },
    CaseDetailLevel: CaseDetailLevel.IncludeHistory
);
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:CaseLookup>
                <urn:CaseIdentification>CustomerNo</urn:CaseIdentification>
                <urn:CaseIdentificationValue>2</urn:CaseIdentificationValue>
            </urn:CaseLookup>
        </urn:GetCaseSummary>
    </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    GetCaseDetails

    GetCaseDetails.

    • CaseDetailLevel

      Optional filter by party reference code.
      Enum

      CaseDetailLevel

      Case details level.

      • OnlyBasic

        OnlyBasic.

      • IncludeHistory

        IncludeHistory.

      • IncludePayments

        IncludePayments.

      • IncludeAll

        IncludeAll.

    • 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

GetCaseDetailsResponse

GetCaseDetails response.

  • 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.

Examples

Sample usage in C# with generated client: 
CollectionInformationClient client = new CollectionInformationClient();

GetCaseSummaryResult result = client.GetCaseSummary(
    new CaseLookup { CaseIdentification = CaseIdentificationType.CaseNumber, CaseIdentificationValue = "7" },
    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:GetCaseSummary>
            <urn:CaseLookup>
                <urn:CaseIdentification>CaseNumber</urn:CaseIdentification>
                <urn:CaseIdentificationValue>7</urn:CaseIdentificationValue>
            </urn:CaseLookup>
        </urn:GetCaseSummary>
    </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    GetCaseSummary

    GetCaseSummary.

    • 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

    • ClientReferenceFilter

      Optional filter by party reference code.

      string

Output

List of collection cases filtered by parameters. If filter format is incorrect - error is returned
Error codes:
  • 30701: collection account generic error
Object

GetCaseSummaryResponse

GetCaseSummary response.

  • 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

GetDebtorActionHistory

Returns list of history action items.

Examples

Sample usage in C# with generated client: 
CollectionInformationClient client = new CollectionInformationClient();

GetHistoryDocumentsResult result = client.GetDebtorActionHistory(
    new DebtorLookup { DebtorIdentification = DebtorIdentificationType.DebtorSESSNOrCompanyNo, DebtorIdentificationValue = "1212121212" },
    ClientReferenceFilter: null,
    ReferenceNumber: null,
    CaseGuid: null,
    FromDate: null,
    ToDate: null,
    ActionType: null,
    ActionGroup: 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:GetDebtorActionHistory>
            <urn:DebtorLookup>
                <urn:DebtorIdentification>DebtorSESSNOrCompanyNo</urn:DebtorIdentification>
                <urn:DebtorIdentificationValue>1212121212</urn:DebtorIdentificationValue>
            </urn:DebtorLookup>
        </urn:GetDebtorActionHistory>
    </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    GetDebtorActionHistory

    GetDebtorActionHistory.

    • ActionGroup

      Optional filter by history item action group.
      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

    • ActionType

      Optional filter by 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.

    • CaseGuid

      Optional filter by collection case unique identifier.

      string

    • ClientReferenceFilter

      Optional filter by party reference code.

      string

    • 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

    • FromDate

      Optional filter by "from" registration date.

      DateTime

    • ReferenceNumber

      Optional filter by debtor reference number.

      string

    • ToDate

      Optional filter by "to" registration date.

      DateTime

Output

List of history items filtered by parameters. If no history item(s) found - error is returned
Error codes:
  • 30701: collection account generic error
Object

GetDebtorActionHistoryResponse

GetDebtorActionHistory response.

  • GetDebtorActionHistoryResult

    Result of GetDebtorActionHistory.
    Object

    GetHistoryDocumentsResult

    General class for representing method output.

    • Histories

      List of history action items with detailed information about each item.
      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

    • 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 debtors.

Examples

Sample usage in C# with generated client: 
CollectionInformationClient client = new CollectionInformationClient();

GetDebtorDetailsResult result = client.GetDebtorDetails(
    new DebtorLookup { DebtorIdentification = DebtorIdentificationType.DebtorSESSNOrCompanyNo, DebtorIdentificationValue = "1212121212" },
    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:GetDebtorDetails>
            <urn:DebtorLookup>
                <urn:DebtorIdentification>DebtorSESSNOrCompanyNo</urn:DebtorIdentification>
                <urn:DebtorIdentificationValue>1212121212</urn:DebtorIdentificationValue>
            </urn:DebtorLookup>
        </urn:GetDebtorDetails>
    </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    GetDebtorDetails

    GetDebtorDetails.

    • ClientReferenceFilter

      Optional filter by party reference code.

      string

    • 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 debtors filtered by parameters. If no debtor(s) found - error is returned
Error codes:
  • 30701: collection account generic error
Object

GetDebtorDetailsResponse

GetDebtorDetails response.

  • 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

GetDebtorSummary

Returns debtor(s) collection cases.

Examples

Sample usage in C# with generated client: 
CollectionInformationClient client = new CollectionInformationClient();

GetDebtorSummaryResult result = client.GetDebtorSummary(
    new DebtorLookup { DebtorIdentification = DebtorIdentificationType.DebtorSESSNOrCompanyNo, DebtorIdentificationValue = "19451211-2634" },
    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:GetDebtorSummary>
            <urn:DebtorLookup>
                <urn:DebtorIdentification>DebtorSESSNOrCompanyNo</urn:DebtorIdentification>
                <urn:DebtorIdentificationValue>19451211-2634</urn:DebtorIdentificationValue>
            </urn:DebtorLookup>
        </urn:GetDebtorSummary>
    </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    GetDebtorSummary

    GetDebtorSummary.

    • ClientReferenceFilter

      Optional filter by party reference code.

      string

    • 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 cases for debtor account(s) filtered by parameters. If no debtor(s) /collection case(s) found - error is returned
Error codes:
  • 30701: collection account generic error
Object

GetDebtorSummaryResponse

GetDebtorSummary response.

  • 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: 
CollectionInformationClient client = new CollectionInformationClient();

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

    Information to lookup case(s).
    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

GetDocumentListForCaseResponse

GetDocumentListForCase response.

  • 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: 
CollectionInformationClient client = new CollectionInformationClient();

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

    Information to lookup debtor(s).
    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

GetDocumentListForDebtorResponse

GetDocumentListForDebtor response.

  • 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: 
CollectionInformationClient client = new CollectionInformationClient();

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

GetHistoryDocumentResponse

GetHistoryDocument response.

  • 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

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: 
CollectionInformationClient client = new CollectionInformationClient();

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 collection information 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

GeneralResultResponse

GeneralResult response

  • 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