CustomerInformation

Service used for accessing customer information.

ActionEvent

Triggers a action event.

Examples

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

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

CustomAction

Invokes a custom action based on a service definition.
Execute custom service definition in ARC with possibility to pass in XML into definition.

Examples

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

CustomActionResult result = client.CustomAction(new InvokeServiceDefinitionRequest
{
    AsyncCall = false,
    InputXml = @"<?xml version=""1.0"" encoding=""ISO-8859-1"" standalone=""no"" ?>
<data>
    <value>12</value>
</data>",
    ServiceDefinitionName = "your_service_definition"
});
Sample soap request: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:CustomAction>
            <urn:serviceDefinition>
                <urn:AsyncCall>false</urn:AsyncCall>
                <urn:InputXml><![CDATA[
<?xml version="1.0" encoding="ISO-8859-1" standalone="no" ?>
<data>
    <value>12</value>
</data>
 ]]></urn:InputXml>
                <urn:ServiceDefinitionName>your_service_definition</urn:ServiceDefinitionName>
            </urn:serviceDefinition>
        </urn:CustomAction>
    </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    CustomAction

    CustomAction

    • serviceDefinition

      The invoke service definition request.
      Object

      InvokeServiceDefinitionRequest

      A request for invoking a service definition.

      • AsyncCall

        Whether service definition invocation is asynchronous or not, i.e. fire and forget. When true the result CData is not collected. Default value is false.

        bool

      • Input

        An XML structure used for input into service definition call.

        XmlElement

      • InputXml

        An XML string used for input into service definition call.

        string

      • ServiceDefinitionName Mandatory

        Name of the service definition to invoke.

        string

Output

The result from service definiton invocation CData.
Error codes:
  • 30601: General service definition error
  • 30602: Service definition does not exist
  • 30603: Service definition input values error
  • 30604: Custom error
Object

CustomActionResponse

CustomActionResponse class

  • CustomActionResult

    Result of CustomAction
    Object

    CustomActionResult

    The result for a custom action, i.e. a service definition call.

    • CData

      Raw CData from service definition response.

      XmlElement

    • Result

      The result of the request. Indicating success or error.
      Object

      ResultType

      Common result type.

      • ResultCode Mandatory

        The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.

        int

      • ResultText Mandatory

        Text information of the result. Usually contains a warning or error message when result code is indicating other than success.

        string

GetAuthSigns

Get authentications and signings for a customer.

Examples

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

GetAuthSignsResult result = client.GetAuthSigns(new CustomerLookup
{
    CustomerIdentification = CustomerIdentificationType.CustomerNOSSNOrCompanyNo,
    CustomerIdentificationValue = "580711-2643",
    JuridicalType = CustomerJuridicalType.Physical
}, 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:GetAuthSigns>
            <urn:CustomerLookup>
                <urn:CustomerIdentification>CustomerSESSNOrCompanyNo</urn:CustomerIdentification>
                <urn:CustomerIdentificationValue>580711-2643</urn:CustomerIdentificationValue>
                <urn:JuridicalType>Physical</urn:JuridicalType>
            </urn:CustomerLookup>
        </urn:GetAuthSigns>
    </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    GetAuthSigns

    GetAuthSigns

    • CustomerLookup

      Information used to find customer.
      Object

      CustomerLookup

      A lookup for customer.

      • CustomerIdentification Mandatory

        Type of customer identification to look up.
        Enum

        CustomerIdentificationType

        Customer identification type.

        • Custom

          Custom identification.

        • CustomerSESSNOrCompanyNo

          Identify by Swedish SSN or company number.

        • CustomerNOSSNOrCompanyNo

          Identify by Norwegian SSN or company number.

        • CustomerReferenceNumber

          Identify by customer reference number.

        • CustomerGuid

          Customer identification.

      • CustomerIdentificationValue Mandatory

        Customer identification to look up, depending on type it has different formats.

        string

      • JuridicalType

        Type of customer, e.g. physical.
        Enum

        CustomerJuridicalType

        Juridical type of the customer.

        • Physical

          Physical person, meaning a natural person.

        • Company

          A company or other organisation.

        • PersonalFirm

          A company that shares the juridical entity with a physical person.

    • CustomerOwnerReferenceFilter

      Optionally filter customer by owner reference.

      string

Output

A list of authentications and signings for a customer.
Error codes:
  • 1 : error message from ARC server
Object

GetAuthSignsResponse

GetAuthSigns response

  • GetAuthSignsResult

    Result of GetAuthSigns
    Object

    GetAuthSignsResult

    The result of getting authentications and signings.

    • AuthSigns

      List of authentications and signings.
      Array
      Object

      AuthSignDetails

      Contains details about an authentication or a signing.

      • AccountGuid Mandatory

        The account's globally unique identifier.

        string

      • AuthSignGuid Mandatory

        An identification of the authentication/signing, GUID.

        string

      • AuthSignLinkType Mandatory

        What the authentication/signing is linked to, e.g. person, account etc.
        Enum

        AuthSignLinkType

        Type of link for authentication/signing.

        • Person

          Linked to a person.

        • Customer

          Linked to a customer.

        • Account

          Linked to an account.

        • Application

          Linked to an application.

        • Document

          Linked to a document.

        • LegalAction

          Linked to a legal action.

      • AuthSignProviders Mandatory

        Providers used for this authentication/signing.
        Array
        Object

        AuthSignProvider

        Provider used for authentication/signing.

        • CountryCode

          If set the provider only works in specific country, e.g. EN, SE etc.

          string

        • Description

          Description of the provider.

          string

        • Manual

          If true the provider needs manual action to handle authentication/signing.

          bool

        • ProviderCode

          Code for the specific provider.

          string

      • AuthSignStatus Mandatory

        Current status of the authentication/signing.
        Enum

        AuthSignStatus

        Status of a authentication/signing process.

        • NotStarted

          Authentication/signing has not started.

        • Starting

          Authentication/signing is starting.

        • Pendning

          Authentication/signing is pending.

        • Approved

          Authentication/signing has been approved.

        • Rejected

          Authentication/signing has been rejected.

        • Aborted

          Authentication/signing has been aborted.

        • TimedOut

          Authentication/signing has timed out.

        • Failed

          Authentication/signing has failed.

      • AuthSignType Mandatory

        The type, either authentication or signature.
        Enum

        AuthSignType

        Specify if an authentication or a signature.

        • Authentication

          Authentication type.

        • Signature

          Signature type.

      • CountryCode Mandatory

        The country code of the authentication/signing.

        string

      • CreditApplicationGuid

        The credit application's globally unique identifier.

        string

      • CustomerGuid Mandatory

        The customer's globally unique identifier.

        string

      • Documents Mandatory

        Documents related to this authentication/signing.
        Array
        Object

        AuthSignDocumentInfo

        Information about a document linked to an authentication/signing.

        • DocumentGuid

          The document's globally unique identifier.

          string

      • RejectedAt

        If authentication/signing was rejected in some way, e.g. cancelled, the date and time of rejection.

        DateTime

      • RequestedAt Mandatory

        When the authentication/signing was initiated.

        DateTime

      • SignatureText

        The text shown when signing.

        string

      • SignedAt

        If authentication/signing was successful, the date and time of completion.

        DateTime

      • TimeoutAt

        If authentication/signing timed out, the date and time of timeout.

        DateTime

    • Result

      The result of the request. Indicating success or error.
      Object

      ResultType

      Common result type.

      • ResultCode Mandatory

        The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.

        int

      • ResultText Mandatory

        Text information of the result. Usually contains a warning or error message when result code is indicating other than success.

        string

GetAuthSignStatus

Get status of authentication/signing.
Retrieves a log of status for the specefic authentication/signing.

Examples

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

GetAuthSignStatusResult result = client.GetAuthSignStatus("9069B148-FAF3-4912-BE84-E11BDBA4E291", 0, 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:GetAuthSignStatus>
         <urn:AuthSignGuid>9069B148-FAF3-4912-BE84-E11BDBA4E291</urn:AuthSignGuid>
         <urn:WaitForStatusUpdate>0</urn:WaitForStatusUpdate>
      </urn:GetAuthSignStatus>
   </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    GetAuthSignStatus

    GetAuthSignStatus

    • AuthSignGuid

      The identifier for the authentication/signing.

      string

    • LanguageCode

      Optionally set language code to get status text in that language. Default using ARC setting.

      string

    • WaitForStatusUpdate

      Optionally set a wait time for status update. Default 0.

      int

Output

A list of status logs for authentication/signing found.
Error codes:
  • 20500: Authentication/signing was not found
Object

GetAuthSignStatusResponse

GetAuthSignStatus response

  • GetAuthSignStatusResult

    Result of GetAuthSignStatus
    Object

    GetAuthSignStatusResult

    The result of getting authentication/signing status.

    • AuthSignStatusLog

      A list of status logs for authentication/signing that matched the request.
      Array
      Object

      AuthSignStatusLog

      Status of an authentication/signing.

      • Instructions

        Instructions.

        string

      • RedirectURL

        Redirect URL.

        string

      • Status Mandatory

        Authentication/signing status.
        Enum

        AuthSignStatus

        Status of a authentication/signing process.

        • NotStarted

          Authentication/signing has not started.

        • Starting

          Authentication/signing is starting.

        • Pendning

          Authentication/signing is pending.

        • Approved

          Authentication/signing has been approved.

        • Rejected

          Authentication/signing has been rejected.

        • Aborted

          Authentication/signing has been aborted.

        • TimedOut

          Authentication/signing has timed out.

        • Failed

          Authentication/signing has failed.

      • StatusCode Mandatory

        Status code from provider.

        string

      • StatusDescription

        Status description from provider.

        string

      • StatusText

        Status text. Could be from provider, reason text from AuthSignStop or an error text in case of error.

        string

      • Time Mandatory

        The time of status.

        DateTime

      • WaitSign Mandatory

        Wait sign flag.

        bool

    • 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

GetCustomerAccounts

Get customer accounts.

Examples

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

GetCustomerAccountsResult result = client.GetCustomerAccounts(new CustomerLookup
{
    CustomerIdentification = CustomerIdentificationType.CustomerSESSNOrCompanyNo,
    CustomerIdentificationValue = "580711-2643",
}, CustomerOwnerReferenceFilter: 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:GetCustomerAccounts>
         <urn:CustomerLookup>
            <urn:CustomerIdentification>CustomerSESSNOrCompanyNo</urn:CustomerIdentification>
            <urn:CustomerIdentificationValue>580711-2643</urn:CustomerIdentificationValue>
         </urn:CustomerLookup>
      </urn:GetCustomerAccounts>
   </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    GetCustomerAccounts

    GetCustomerAccounts

    • CustomerLookup

      Information to lookup customer.
      Object

      CustomerLookup

      A lookup for customer.

      • CustomerIdentification Mandatory

        Type of customer identification to look up.
        Enum

        CustomerIdentificationType

        Customer identification type.

        • Custom

          Custom identification.

        • CustomerSESSNOrCompanyNo

          Identify by Swedish SSN or company number.

        • CustomerNOSSNOrCompanyNo

          Identify by Norwegian SSN or company number.

        • CustomerReferenceNumber

          Identify by customer reference number.

        • CustomerGuid

          Customer identification.

      • CustomerIdentificationValue Mandatory

        Customer identification to look up, depending on type it has different formats.

        string

      • JuridicalType

        Type of customer, e.g. physical.
        Enum

        CustomerJuridicalType

        Juridical type of the customer.

        • Physical

          Physical person, meaning a natural person.

        • Company

          A company or other organisation.

        • PersonalFirm

          A company that shares the juridical entity with a physical person.

    • CustomerOwnerReferenceFilter

      Optional filter by owner reference.

      string

Output

A list of accounts for customer filtered by parameters.
Error codes:
  • 20500: Customer not found
Object

GetCustomerAccountsResponse

GetCustomerAccounts response

  • GetCustomerAccountsResult

    Result of GetCustomerAccounts
    Object

    GetCustomerAccountsResult

    Get customer account result.

    • CustomerAccounts

      List of customer accounts found.
      Array
      Object

      CustomerAccount

      Customer account.

      • AccountNumber

        Account number.

        string

      • AccountStatus

        Account status.
        Enum

        CustomerAccountStatus

        Customer account status.

        • Normal

          Account is in normal state.

        • Reminder

          Payment reminder sent.

        • ReminderNoFee

          Payment reminder sent (No fee).

        • Collection

          Account has ben sent to debt collection.

        • Closed

          Account has been closed.

        • OnHold

          Account is on hold.

        • CollectionRevoked

          Account debt collection revoked.

        • PreTermination

          Account has been terminated earlier than planned.

        • Termination

          Account has been terminated.

        • UsedRightToWithdraw

          Debtor has used the right to withdraw.

      • Balance

        The current balance of the account.

        decimal

      • Campaigns

        List of campaigns used on account.
        Array
        Object

        CustomerAccountCampaign

        Campaign for customer account.

        • Active

          Whether the campaign is active.

          bool

        • Annuity

          Whether using annuity calculation for interest.

          bool

        • FailedAt

          Date when campaign failed.

          DateTime

        • FinishedAt

          Date when campaign finished.

          DateTime

        • InterestRate

          Interest rate for campaign.

          decimal

        • LastPaymentDate

          Last payment date for campaign.

          DateTime

        • NextPeriodAmount

          Amount to pay next period in campaign.

          decimal

        • NextPeriodDate

          Next period payment date for campaign.

          DateTime

        • OriginalAmount

          Original amount for the campaign.

          decimal

        • OriginalCreditorReference

          Original creditor reference.

          decimal

        • OriginalFee

          Original fee for campaign.

          decimal

        • PeriodInterval

          Number of days for each period interval.

          int

        • Periods

          List of periods for this campaign.
          Array
          Object

          CustomerAccountCampaignPeriod

          Campaign period for customer account, a period usually represents a month.

          • InterestAmount

            Amount of interest.

            decimal

          • PaidAmount

            Amount paid this period.

            decimal

          • PaymentDate

            Date of payment for this payment.

            DateTime

          • PeriodAmount

            Amount to pay this period.

            decimal

          • PeriodEnd

            When period ends.

            DateTime

          • PeriodStart

            When period begins.

            DateTime

          • RemainingCampaignAmount

            Remaining amount for this campaign.

            decimal

          • RespiteUsed

            Whether respite is used this period.

            bool

        • RegistrationDate

          Date of campaign registration.

          DateTime

        • RemainingAmount

          Remaining amount for the campaign.

          decimal

        • RemainingFee

          Remaining fee to pay for campaign.

          decimal

        • RemainingNumberOfPayments

          Remaining number of payments in the campaign.

          int

        • ReminderFeeAmount

          The fee to pay for reminder of payment.

          decimal

        • StartDate

          Start of campaign.

          DateTime

        • TotalNumberOfPayments

          Total number of payments in the campaign.

          int

      • CreditInterestRate

        Credit interest rate.

        decimal

      • DebitInterestRate

        Debit interest rate.

        decimal

      • DueDate

        Next payment due date.

        decimal

      • ExtraFields

        List of extra fields, used for custom data.
        Array
        Object

        ExtraField

        Extra field contains custom data.

        • Data

          Value of extra field.

          string

        • Name

          Name of extra field.

          string

      • Insurances

        List of payment insurances registered on account.
        Array
        Object

        CustomerAccountInsurance

        Insurance for customer's account.

        • EndDate

          Insurance end date.

          DateTime

        • FeePercent

          Fee in percent av insured amount.

          decimal

        • InsuranceCode

          Credit debt insurance code.

          string

        • InsuranceCompanyReference

          Reference for insurance company.

          string

        • InsuredAmount

          Insured amount.

          decimal

        • MinimalFee

          Minimal fee.

          decimal

        • RegistrationDate

          Date of registration of insurance.

          DateTime

        • RemainingInsuredAmount

          Remaining amount of originally insured amount.

          decimal

      • InvoicedAmount

        Invoiced amount.

        decimal

      • InvoicedFee

        Invoiced amount whereof is fees.

        decimal

      • InvoicedInterest

        Invoiced amount whereof is interest.

        decimal

      • InvoicedPrincipal

        Invoiced amount whereof is principal.

        decimal

      • MinimumToPay

        The minimum amount to pay next due date.

        decimal

      • MinimumToPayToKeepCampaign

        The minimum amount to pay next due date to keep all campaigns.

        decimal

      • PaymentBankAccountNumber

        Bank account number where payment should go, e.g. Bankgiro.

        string

      • PaymentReference

        Payment reference, e.g. OCR.

        string

      • Payments

        A list of payments made on the account.
        Array
        Object

        CustomerLoanPayment

        Customer payment on loan or account.

        • Fee

          Fees of amount paid.

          decimal

        • Interest

          Interest of amount paid.

          decimal

        • InvoiceNumber

          Invoice number.

          string

        • PaidAmount

          Amount paid.

          decimal

        • PaymentDate

          Date of payment.

          DateTime

        • PaymentGuid

          Payment's globally unique identifer.

          string

        • PenaltyInterest

          Penelty interest due to late payment.

          decimal

        • Prepayment

          Amount paid in advance of paid amount.

          decimal

        • Principal

          Principal of amount paid.

          decimal

      • Periods

        List of account periods.
        Array
        Object

        CustomerAccountPeriod

        Period for customer account, usually one payment per period and representing the length of a month.

        • DueDate

          Due date of payment.

          DateTime

        • IncomingDate

          Date at start of period.

          DateTime

        • IncomingInterest

          Incoming interest, i.e. interest amount from start of period.

          decimal

        • IncomingPrincipal

          Incoming principal, i.e principal amount from start of period.

          decimal

        • InvoicedAmount

          Total amount invoiced this period.

          decimal

        • InvoicedFee

          Fee amount invoiced this period.

          decimal

        • InvoicedInterest

          Interest amount invoiced this period.

          decimal

        • InvoicedPrincipal

          Principal amount invoiced this period.

          decimal

        • InvoiceNumber

          Invoice number for this period.

          string

        • MinimumToPay

          Minimum amount to pay this period.

          decimal

        • MinimumToPayToKeepCampaign

          Minimum amount to pay and still keep campaigns used.

          decimal

        • OutgoingDate

          Date at end of period.

          DateTime

        • OutgoingInterest

          Outgoing interest, i.e. interest amount at end of period.

          decimal

        • OutgoingPrincipal

          Outgoing principal, i.e. principal amount at end of period.

          decimal

        • OverdueFee

          The amount of fees that is overdue this period.

          decimal

        • OverdueInterest

          The amount of interest that is overdue this period.

          decimal

        • OverduePrincipal

          The amount of principal that is overdue this period.

          decimal

        • PaymentFreeMonths

          Contains months during the year that is payment free, 1-12 for Jan-Dec.
          Array

          int

        • PeriodGuid

          Period's globally unique identifier.

          string

        • ReminderCount

          Number of reminders.

          int

        • ReminderFee

          Reminder fee for period.

          decimal

        • SettlemetFee

          Settlement fee added this period.

          decimal

      • RegistrationDate

        Date of account registration.

        DateTime

      • RemainingFee

        How much of fees is remaining to pay.

        decimal

      • RemainingInterest

        How much of interest is remaining to pay.

        decimal

      • RemainingPrincipal

        How much of principal (capital) is remaining to pay.

        decimal

      • ReminderCount

        Number of reminders.

        int

      • SettlementFee

        Settlement fee, paid each per period.

        decimal

      • TypeCode

        Account type code, e.g. DEPOSIT, LOAN etc.

        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

GetCustomerAccountTransactions

Get customer account transactions.

Examples

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

GetCustomerAccountTransactionsResult result = client.GetCustomerAccountTransactions(new CustomerLookup
{
    CustomerIdentification = CustomerIdentificationType.CustomerSESSNOrCompanyNo,
    CustomerIdentificationValue = "580711-2643",
}, CustomerOwnerReferenceFilter: null, AccountNumber: null, PeriodGuid: null, FromDate: new DateTime(2018, 11, 29, 8, 0, 0), ToDate: 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:GetCustomerAccountTransactions>
         <urn:CustomerLookup>
            <urn:CustomerIdentification>CustomerSESSNOrCompanyNo</urn:CustomerIdentification>
            <urn:CustomerIdentificationValue>580711-2643</urn:CustomerIdentificationValue>
         </urn:CustomerLookup>
         <urn:FromDate>2018-11-29T08:00</urn:FromDate>
      </urn:GetCustomerAccountTransactions>
   </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    GetCustomerAccountTransactions

    GetCustomerAccountTransactions

    • AccountNumber

      Optional filter by period identifier.

      string

    • CustomerLookup

      Information to lookup customer.
      Object

      CustomerLookup

      A lookup for customer.

      • CustomerIdentification Mandatory

        Type of customer identification to look up.
        Enum

        CustomerIdentificationType

        Customer identification type.

        • Custom

          Custom identification.

        • CustomerSESSNOrCompanyNo

          Identify by Swedish SSN or company number.

        • CustomerNOSSNOrCompanyNo

          Identify by Norwegian SSN or company number.

        • CustomerReferenceNumber

          Identify by customer reference number.

        • CustomerGuid

          Customer identification.

      • CustomerIdentificationValue Mandatory

        Customer identification to look up, depending on type it has different formats.

        string

      • JuridicalType

        Type of customer, e.g. physical.
        Enum

        CustomerJuridicalType

        Juridical type of the customer.

        • Physical

          Physical person, meaning a natural person.

        • Company

          A company or other organisation.

        • PersonalFirm

          A company that shares the juridical entity with a physical person.

    • CustomerOwnerReferenceFilter

      Optional filter by owner reference.

      string

    • FromDate

      Optionally only show items after date.

      DateTime

    • PeriodGuid

      GUID of period

      string

    • ToDate

      Optionally only show items before date.

      DateTime

Output

List of transaction for a customer account filtered by parameters.
Error codes:
  • 20500: Customer not found
Object

GetCustomerAccountTransactionsResponse

GetCustomerAccountTransactions response

  • GetCustomerAccountTransactionsResult

    Result of GetCustomerAccountTransactions
    Object

    GetCustomerAccountTransactionsResult

    Get customer account transactions result.

    • 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

    • Transactions

      List of transactions.
      Array
      Object

      CustomerAccountTransaction

      Customer account transaction description.

      • Description

        Transaction description.

        string

      • PeriodGuid

        Period unique identifier.

        string

      • TransactionAmount

        Transaction amount.

        decimal

      • TransactionDate

        Transaction date.

        DateTime

      • TransactionType

        Transaction type.
        Enum

        TransactionType

        Transaction type.

        • Unknown

          Unknown transaction type.

        • New

          New transaction.

        • Transfer

          Transfer.

        • InterestUpdate

          Interest update.

        • Payment

          Payment.

        • AdjustUp

          Adjustment up.

        • AdjustDown

          Adjustment down.

        • CreditAccountAdjust

          Creditor account adjustment.

        • Service

          Service.

        • Closure

          Closure.

        • Disbursement

          Disbursement.

        • TransferCreditInvoice

          Credit invoice transfer.

        • TrustAccounting

          Trust accounting.

        • Remit

          Remit.

        • InterestLimitation

          Limitation of interest.

        • UnspecifiedPayment

          Unspecified payment.

        • CreditorFee

          Creditor fee.

        • Purchase_DirectPayment

          Purchase, direct payment.

        • PurchaseDeposit

          Purchase deposit.

        • Purchase

          Purchase.

        • Diff

          Diff.

        • Credit

          Credit.

        • SpecifyUnspecifiedPayment

          Specifying unspecified payment.

        • Regress

          Regress.

        • Payment_CreditInvoice

          Use credit invoice.

        • BlockedAccount

          Blocked account.

        • DeletePayment

          Deleted payment.

        • NettedOutlay

          Netted outlay.

        • WriteDownExpectedOutlay

          Write-down expected outlay

        • WriteUpEstablishedOutlay

          Write-up establised outlay.

        • DisbursementFee

          Disbursement fee.

        • MoveToCreditor

          Debtor fee moved to creditor

        • Factoring_Disbursement

          Factoring, disbursement.

        • Factoring_Disbursement_Loan

          Factoring, disbursement loan.

        • CreditDebt_Balance

          Balance.

        • Factoring_InterestCapitalization

          Factoring, interest capitalization.

        • Factoring_Purchase_OBSOLETE

          Enum value Factoring_Purchase_OBSOLETE is obsolete.

          Factoring, purchase.

        • Factoring_Endorse

          Factoring, Endorsement.

        • Factoring_Reendorse

          Factoring, Reendorsement.

        • Factoring_Disbursement_Pledge

          Factoring, disbursement purchase deposit.

        • Factoring_Loan

          Factoring, loan.

        • PaymentSyncronize

          Payment, syncronization.

        • PaymentSyncronize_CreditInvoice

          Payment, credit invoice, syncronization.

        • Overpayment

          Overpayment.

        • OverpaymentContraTrans

          Overpayment contra trans.

        • ExchangeDifference

          Exhchange difference.

        • ExchangeFee

          Exchange fee.

        • InterestCharge

          Interest charge

        • FeeCharge

          Fee charge.

        • BadDebtReserve

          Reserve for bad debt.

        • BadDebtWriteOff

          Write-off bad debt.

        • BadDebtRecovery

          Bad debt recovery

        • InterimPayment

          Interim payment.

        • ConfirmedDisbursement

          Disbursement (confirmed).

        • ConvertInvoiceToCredit

          Convert invoice to credit.

        • ConvertCampaignToCredit

          Campaign converted to account

        • InterimDisbursement

          Interim disbursement.

        • DisbursementToUnplacedPayment

          Disbursement transfered to unplaced payment.

        • TransferForSettlement

          Tranfer for settlement.

        • DebtlimitationAdjustment

          Debt limitation adjustment.

        • DebtlimitationPaymentOther

          Payment by other.

        • CreditDebt_Purchase

          Purchase.

        • CreditDebt_Payment

          Payment from customer.

        • CreditDebt_Disbursement

          Disbursement.

        • CreditDebt_InterestCapitalization

          Interest capitalization.

        • CreditDebt_InternalTransfer

          Internal transfer.

        • CreditDebt_ExternalTransfer

          External transfer.

        • CreditDebt_ExternalPayment

          External payment.

        • CreditDebt_Invoice

          Invoice.

        • CreditDebt_Interest

          Interest.

        • CreditDebt_Fee

          Fee.

        • CreditDebt_Adjustment

          Adjustment.

        • CreditDebt_Prepayment

          Pre-payment.

        • Return

          Return.

        • Delete

          Crediting.

        • Collection

          Collection.

        • CreditDebt_Deposit

          Deposit.

        • CreditDebt_Discount

          Discount.

        • Interest_Compensation

          Interest calculated as compensation/penalty due to preredemption.

        • CreditDebt_Billed

          Part of the loan that has been invoiced/billed.

        • CreditDebt_Due

          The invoiced/billed part of the loan that has become overdue.

        • BankaccountInterest

          Bank account interest.

        • BankaccountFee

          Bank account fee.

        • BankaccountOther

          Other bank account transaction.

        • UpdateDebtReturn

          Distribution of debt from credit debt to invoice.

        • UpdateDebtNetting

          Netting of return debtrows.

        • BankaccountTransfer

          Bank account transfer.

        • DebtAdjustment

          Debt adjustment.

        • CollectedByThirdParty

          Collected by third party.

        • NettedAtThirdParty

          Netted at 3rd party.

        • PayableToThirdParty

          Accounts payable to 3rd party.

        • InterestCapitalization

          Interest that has turned into principal amount.

        • CreditDebt_Termination_Debit

          First transaction in a pre-termination phase of a loan.

        • CreditDebt_Termination_Credit

          Second transaction in a pre-termination phase of a loan.

        • CashDiscount

          Cache discount of an invoice due to early payment.

        • VirtualAccount_Balance

          Transaction that set the intial balance of a virtual account.

        • VirtualAccount_Transaction

          Transaction that mirrors the original transaction on a virtual account

        • DisbursementOfCreditInvoice

          Disbursement of a credit invoice to the customer.

GetCustomerActionHistory

Get customer action history.
The action history can be filtered using only one of the provided values for CustomerAccountNumber or InvoiceNumber. Both values should not be provided in the same time.

Examples

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

GetHistoryDocumentsResult result = client.GetCustomerActionHistory(new CustomerLookup
{
    CustomerIdentification = CustomerIdentificationType.CustomerSESSNOrCompanyNo,
    CustomerIdentificationValue = "580711-2643",
}, CustomerOwnerReferenceFilter: null, CustomerAccountNumber: null, InvoiceNumber: null, ActionGroupingGuid: null, FromDate: new DateTime(2018, 11, 29), 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:GetCustomerActionHistory>
         <urn:CustomerLookup>
            <urn:CustomerIdentification>CustomerSESSNOrCompanyNo</urn:CustomerIdentification>
            <urn:CustomerIdentificationValue>580711-2643</urn:CustomerIdentificationValue>
         </urn:CustomerLookup>
         <urn:FromDate>2018-11-29T08:00</urn:FromDate>
      </urn:GetCustomerActionHistory>
   </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    GetCustomerActionHistory

    GetCustomerActionHistory

    • ActionGroup

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

    • ActionGroupingGuid

      Optional filter by action grouping identifier.

      string

    • ActionType

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

    • CustomerAccountNumber

      Optional filter by account number.

      string

    • CustomerLookup

      Information to lookup customer.
      Object

      CustomerLookup

      A lookup for customer.

      • CustomerIdentification Mandatory

        Type of customer identification to look up.
        Enum

        CustomerIdentificationType

        Customer identification type.

        • Custom

          Custom identification.

        • CustomerSESSNOrCompanyNo

          Identify by Swedish SSN or company number.

        • CustomerNOSSNOrCompanyNo

          Identify by Norwegian SSN or company number.

        • CustomerReferenceNumber

          Identify by customer reference number.

        • CustomerGuid

          Customer identification.

      • CustomerIdentificationValue Mandatory

        Customer identification to look up, depending on type it has different formats.

        string

      • JuridicalType

        Type of customer, e.g. physical.
        Enum

        CustomerJuridicalType

        Juridical type of the customer.

        • Physical

          Physical person, meaning a natural person.

        • Company

          A company or other organisation.

        • PersonalFirm

          A company that shares the juridical entity with a physical person.

    • CustomerOwnerReferenceFilter

      Optional filter by owner reference.

      string

    • FromDate

      Optionally only show items after date.

      DateTime

    • InvoiceNumber

      Optional filter by invoice number.

      string

    • ToDate

      Optionally only show items before date.

      DateTime

Output

A list of history items for customer filtered by parameters.
Error codes:
  • 1 : Value cannot be null.{nameof(user)} || nameof(customerLookup)
  • 1 : Cant filter by both customer account number and invoice number
Object

GetCustomerActionHistoryResponse

GetCustomerActionHistory response

  • GetCustomerActionHistoryResult

    Result of GetCustomerActionHistory
    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

GetCustomerDetails

Get customer details.

Examples

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

GetCustomerDetailsResult result = client.GetCustomerDetails(new CustomerLookup
{
    CustomerIdentification = CustomerIdentificationType.CustomerSESSNOrCompanyNo,
    CustomerIdentificationValue = "580711-2643",
}, CustomerOwnerReferenceFilter: 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:GetCustomerDetails>
         <urn:CustomerLookup>
            <urn:CustomerIdentification>CustomerSESSNOrCompanyNo</urn:CustomerIdentification>
            <urn:CustomerIdentificationValue>580711-2643</urn:CustomerIdentificationValue>
         </urn:CustomerLookup>
      </urn:GetCustomerDetails>
   </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    GetCustomerDetails

    GetCustomerDetails

    • CustomerLookup

      Information to lookup customer.
      Object

      CustomerLookup

      A lookup for customer.

      • CustomerIdentification Mandatory

        Type of customer identification to look up.
        Enum

        CustomerIdentificationType

        Customer identification type.

        • Custom

          Custom identification.

        • CustomerSESSNOrCompanyNo

          Identify by Swedish SSN or company number.

        • CustomerNOSSNOrCompanyNo

          Identify by Norwegian SSN or company number.

        • CustomerReferenceNumber

          Identify by customer reference number.

        • CustomerGuid

          Customer identification.

      • CustomerIdentificationValue Mandatory

        Customer identification to look up, depending on type it has different formats.

        string

      • JuridicalType

        Type of customer, e.g. physical.
        Enum

        CustomerJuridicalType

        Juridical type of the customer.

        • Physical

          Physical person, meaning a natural person.

        • Company

          A company or other organisation.

        • PersonalFirm

          A company that shares the juridical entity with a physical person.

    • CustomerOwnerReferenceFilter

      Optional filter customer by owner reference.

      string

Output

A list of customers filtered by parameters.
Error codes:
  • 20500: Customer not found
Object

GetCustomerDetailsResponse

GetCustomerDetails response

  • GetCustomerDetailsResult

    Result of GetCustomerDetails
    Object

    GetCustomerDetailsResult

    The result of get customer details request.

    • Customer

      List of cutomers.
      Array
      Object

      Customer

      Customer information.

      • Addresses

        List of adresses.
        Array
        Object

        Address

        Holds address information.

        • CareOf

          Care of address.

          string

        • City

          City.

          string

        • CountryCode

          Country code, i.e. EN, SE etc.

          string

        • DefaultAddress

          Whether this is the default address.

          bool

        • FullAddress

          Combined address with all fields into single string.

          string

        • FullName

          The full name of the receiving party, i.e name of person or company.

          string

        • HouseNo

          House number.

          string

        • HouseNoExtension

          House number extension.

          string

        • StateCode

          State code if applicable.

          string

        • Street

          Street address.

          string

        • TypeCode Mandatory

          The type code of the address, i.e. what the address is used for, e.g. LEGAL, AVI, INVOICE, SITE, DELIVERY, TRUSTACCNT. Should be used one of predefined values using correct letter case.

          string

        • UpdateExisting

          Whether this should update existing or create new address.

          bool

        • ValidFrom

          The date when the address becomes active. If the element is missing, then do not change the current actual value.

          DateTime

        • ValidTo

          The date after which the address becomes inactive. If the element is missing, then do not change the current actual value.

          DateTime

        • ZipCode

          Zip code, i.e. postal code.

          string

      • CellularPhone

        Cellular phone number.

        string

      • CultureCode

        Culture code.

        string

      • CurrencyCode

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

        string

      • CustomerGuid

        Customer unique identifier.

        string

      • CustomerReference

        Customer reference.

        string

      • DateOfBirth

        Date of birth.

        DateTime

      • Domicile

        Domicile.

        string

      • Email

        E-mail.

        string

      • ExtraFields

        List of extra fields.
        Array
        Object

        ExtraField

        Extra field contains custom data.

        • Data

          Value of extra field.

          string

        • Name

          Name of extra field.

          string

      • Firstname

        First name of the customer.

        string

      • Gender

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

      • GlnNumber

        GLN number.

        string

      • HomePhone

        Home phone number.

        string

      • IdNumber

        Customer ID number.

        string

      • InvoiceChannel

        Preffered invoice channel, e.g. LETTER, E-INVOICE, EMAIL, SMS etc. Should be used one of predefined values using correct letter case.

        string

      • JuridicalType

        Type of credit applicant, juridically.
        Enum

        JuridicalType

        Type of person, juridically.

        • NaturalPerson

          Actual person.

        • JuridicalPerson

          Juridical person, e.g a company.

      • LanguageCode

        Language code e.g. sv, en etc.

        string

      • Lastname

        Last name of the customer.

        string

      • LastUpdatedAt

        Date of last customer info update.

        DateTime

      • Middlename

        Middle name of the customer.

        string

      • MunicipalCode

        Municipal code.

        string

      • NaceCode

        NACE code.

        string

      • NameSuffix

        Name suffix.

        string

      • PaymentMethod

        Payment method.

        string

      • PlaceOfbirth

        Place of birth.

        string

      • PreferredChannel

        Preffered communication channel, e.g. LETTER, E-INVOICE, EMAIL, SMS etc. Should be used one of predefined values using correct letter case.

        string

      • Telefax

        Telefax number.

        string

      • UnderAged

        Under aged boolean flag.

        bool

      • VatNumber

        VAT number.

        string

      • WorkPhone

        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

GetCustomerInvoices

Get customer invoices.

Examples

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

GetCustomerInvoicesResult result = client.GetCustomerInvoices(new CustomerLookup
{
    CustomerIdentification = CustomerIdentificationType.CustomerSESSNOrCompanyNo,
    CustomerIdentificationValue = "580711-2643",
}, CustomerOwnerReferenceFilter: 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:GetCustomerInvoices>
         <urn:CustomerLookup>
            <urn:CustomerIdentification>CustomerSESSNOrCompanyNo</urn:CustomerIdentification>
            <urn:CustomerIdentificationValue>580711-2643</urn:CustomerIdentificationValue>
         </urn:CustomerLookup>
      </urn:GetCustomerInvoices>
   </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    GetCustomerInvoices

    GetCustomerInvoices

    • CustomerLookup

      Information to lookup customer.
      Object

      CustomerLookup

      A lookup for customer.

      • CustomerIdentification Mandatory

        Type of customer identification to look up.
        Enum

        CustomerIdentificationType

        Customer identification type.

        • Custom

          Custom identification.

        • CustomerSESSNOrCompanyNo

          Identify by Swedish SSN or company number.

        • CustomerNOSSNOrCompanyNo

          Identify by Norwegian SSN or company number.

        • CustomerReferenceNumber

          Identify by customer reference number.

        • CustomerGuid

          Customer identification.

      • CustomerIdentificationValue Mandatory

        Customer identification to look up, depending on type it has different formats.

        string

      • JuridicalType

        Type of customer, e.g. physical.
        Enum

        CustomerJuridicalType

        Juridical type of the customer.

        • Physical

          Physical person, meaning a natural person.

        • Company

          A company or other organisation.

        • PersonalFirm

          A company that shares the juridical entity with a physical person.

    • CustomerOwnerReferenceFilter

      Optional filter customer by owner reference.

      string

    • PurchasedInvoices

      Show purchased invoices

      bool

    • Subclients

      Show invoices for subclients

      bool

Output

A list of invoices for customer filtered by parameters.
Error codes:
  • 20500: Customer not found
Object

GetCustomerInvoicesResponse

GetCustomerInvoices response

  • GetCustomerInvoicesResult

    Result of GetCustomerInvoices
    Object

    GetCustomerInvoicesResult

    The result of get customer invoices request.

    • Invoices

      List of customer invoices.
      Array
      Object

      CustomerInvoiceDetails

      Customer invoice details.

      • ActionGroupingCode

        Action grouping code.

        string

      • ActionGroupingGuid

        Action grouping's globally unique identifier.

        string

      • ConvertedToAccountNumber

        If set it has been converted to an account with specified account number.

        string

      • CurrencyCode

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

        string

      • DueDate

        Due date of invoice.

        DateTime

      • ExtraFields

        List of extra fields for custom data.
        Array
        Object

        ExtraField

        Extra field contains custom data.

        • Data

          Value of extra field.

          string

        • Name

          Name of extra field.

          string

      • FirstLetterHistoryGuid

        First letter history item globally unique identifier.

        string

      • InvoiceAmount

        Invoiced amount.

        decimal

      • InvoiceDate

        Invoice date.

        DateTime

      • InvoiceNumber

        Invoice number.

        string

      • InvoiceStatus

        Status of the invoice.
        Enum

        InvoiceStatus

        Invoice status.

        • Unknown

          Invoice status unknown.

        • Paid

          Invoice has been paid.

        • Unpaid

          Invoice is not paid.

        • Overdue

          Invoice is overdue.

        • OverPayment

          More than requested amount has been paid on invoice.

        • Reminder

          Reminder sent for invoice.

        • Collection

          Invoice sent to debt collection.

        • Credited

          Invoice has been credited.

        • ConvertedToAccount

          Invoice has been converted to account.

      • LatestLetterHistoryGuid

        Latest letter history item globally unique identifier.

        string

      • LetterDueDate

        Letter sent has due date.

        DateTime

      • LetterPaymentAmount

        The amount to pay on letter.

        decimal

      • OriginalCreditorReference

        Original creditor reference.

        string

      • PaymentBankAccountNumber

        Bank account number where payment should go, e.g. Bankgiro.

        string

      • PaymentReferenceNumber

        Payment reference number, e.g. OCR.

        string

      • RemainingAmount

        Amount remaining to be paid.

        decimal

      • UniqueID

        Invoice unique id.

        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

GetCustomerLedgerSummary

Gets a ledger summery of a customer.

Examples

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

GetCustomerLedgerSummaryResult result = client.GetCustomerLedgerSummary(new CustomerLookup
{
    CustomerIdentification = CustomerIdentificationType.CustomerSESSNOrCompanyNo,
    CustomerIdentificationValue = "580711-2643",
}, CustomerOwnerReferenceFilter: 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:GetCustomerLedgerSummary>
         <urn:CustomerLookup>
            <urn:CustomerIdentification>CustomerSESSNOrCompanyNo</urn:CustomerIdentification>
            <urn:CustomerIdentificationValue>580711-2643</urn:CustomerIdentificationValue>
         </urn:CustomerLookup>
      </urn:GetCustomerLedgerSummary>
   </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    GetCustomerLedgerSummary

    GetCustomerLedgerSummary

    • CustomerLookup

      Information used to find a customer.
      Object

      CustomerLookup

      A lookup for customer.

      • CustomerIdentification Mandatory

        Type of customer identification to look up.
        Enum

        CustomerIdentificationType

        Customer identification type.

        • Custom

          Custom identification.

        • CustomerSESSNOrCompanyNo

          Identify by Swedish SSN or company number.

        • CustomerNOSSNOrCompanyNo

          Identify by Norwegian SSN or company number.

        • CustomerReferenceNumber

          Identify by customer reference number.

        • CustomerGuid

          Customer identification.

      • CustomerIdentificationValue Mandatory

        Customer identification to look up, depending on type it has different formats.

        string

      • JuridicalType

        Type of customer, e.g. physical.
        Enum

        CustomerJuridicalType

        Juridical type of the customer.

        • Physical

          Physical person, meaning a natural person.

        • Company

          A company or other organisation.

        • PersonalFirm

          A company that shares the juridical entity with a physical person.

    • CustomerOwnerReferenceFilter

      Optionally filter customer by owner reference.

      string

Output

Return a list of matched ledgers for that customer.
Error codes:
  • 20500: Customer not found
Object

GetCustomerLedgerSummaryResponse

GetCustomerLedgerSummary response

  • GetCustomerLedgerSummaryResult

    Result of GetCustomerLedgerSummary
    Object

    GetCustomerLedgerSummaryResult

    The result of get customer ledger summary.

    • CustomerLedgerSummary

      List of customer ledger summary, one item per customer. Should usually contain one item but can contain more if customer lookup matches more than one customer.
      Array
      Object

      CustomerLedgerSummary

      Ledger summary for customer.

      • AccountBalance

        Account balance.

        decimal

      • CurrencyCode

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

        string

      • Invoices

        List of invoices on this ledger account.
        Array
        Object

        CustomerLedgerInvoice

        Customer ledger invoice.

        • CurrencyCode

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

          string

        • CustomerAccountInvoice

          Whether the invoice is for a customer account or not.

          bool

        • Description

          Description of the invoice.

          string

        • DueDate

          Invoice due date.

          DateTime

        • InvoiceAmount

          Invoiced amount.

          decimal

        • InvoiceDate

          Invoice date.

          DateTime

        • InvoiceGroupingReference

          Grouping reference for the invoice.

          string

        • InvoiceNumber

          Invoice number.

          string

        • InvoiceStatus

          The status of the invoice.
          Enum

          InvoiceStatus

          Invoice status.

          • Unknown

            Invoice status unknown.

          • Paid

            Invoice has been paid.

          • Unpaid

            Invoice is not paid.

          • Overdue

            Invoice is overdue.

          • OverPayment

            More than requested amount has been paid on invoice.

          • Reminder

            Reminder sent for invoice.

          • Collection

            Invoice sent to debt collection.

          • Credited

            Invoice has been credited.

          • ConvertedToAccount

            Invoice has been converted to account.

        • MinimumToPay

          Minimum amount to pay for this invoice.

          decimal

        • MinimumToPayIncludingCampaign

          Minimum amount to pay including used campaigns.

          decimal

        • PaymentBankAccountNumber

          Bank account number where payment should go, e.g. Bankgiro.

          string

        • PaymentReferenceNumber

          Payment reference number, e.g. OCR.

          string

        • ReservationId

          ID of the reservation.

          int

      • Purchases

        List of purchases on this ledger account.
        Array
        Object

        CustomerLedgerPurchase

        Customer ledger purchase details.

        • ActivatedAmount

          Activated amount.

          decimal

        • CampaignCode

          Campaign code.

          string

        • CampaignDescription

          Campaign description.

          string

        • CampaignFee

          Campaign fee.

          decimal

        • ClaimantName

          Claimant name.

          string

        • ClaimantReference

          Claimant reference.

          string

        • CreditorReference

          Creditor reference.

          string

        • CurrencyCode

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

          string

        • CustomerAccountNumber

          Customer account number.

          string

        • Description

          Purchase escription.

          string

        • ExtraFields

          List of extra fields.
          Array
          Object

          ExtraField

          Extra field contains custom data.

          • Data

            Value of extra field.

            string

          • Name

            Name of extra field.

            string

        • InvoiceNo

          Invoice number.

          string

        • LastPaymentDate

          Last payment date.

          DateTime

        • NextPeriodAmount

          Next period amount.

          decimal

        • NextPeriodDate

          Next period date.

          DateTime

        • OriginalCampaignAmount

          Original campaign amount.

          decimal

        • PurchaseAmount

          Purchase amount.

          decimal

        • RemainingAmount

          Remaining amount.

          decimal

        • RemainingCampaignAmount

          Remaining campaign amount.

          decimal

        • RemainingNumberOfPayments

          Remaining number of payments.

          int

        • ReservationId

          Reservation Id.

          int

        • TotalNumberOfPayments

          Total number of payments.

          int

      • TotalBalance

        Total balance, i.e. balance of invoices and accounts combined.

        decimal

      • UnsettledPaymentBalance

        Unsettled payment balance.

        decimal

    • Result

      The result of the request. Indicating success or error.
      Object

      ResultType

      Common result type.

      • ResultCode Mandatory

        The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.

        int

      • ResultText Mandatory

        Text information of the result. Usually contains a warning or error message when result code is indicating other than success.

        string

GetCustomerLoan

Get customer loan.

Examples

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

GetCustomerLoanResult result = client.GetCustomerLoan("2911A789-9BFD-4BB6-9C7E-CF8C8CDFB992");
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:GetCustomerLoan>
         <urn:AccountGuid>2911A789-9BFD-4BB6-9C7E-CF8C8CDFB992</urn:AccountGuid>
      </urn:GetCustomerLoan>
   </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    GetCustomerLoan

    GetCustomerLoan class

    • AccountGuid

      The account identifier to get loan from.

      string

Output

The customer loan if found.
Error codes:
  • 50800: Account not found
  • 1 : Specified argument was out of the range of valid values.
Object

GetCustomerLoanResponse

GetCustomerLoanResponse class

  • GetCustomerLoanResult

    Result of GetCustomerLoan
    Object

    GetCustomerLoanResult

    The get customer loan result.

    • LoanInfo

      Loan info.
      Object

      CustomerLoan

      Customer loan description.

      • AccountGuid

        Customer account unique identifier.

        string

      • AccountNumber

        Customer account number.

        string

      • ActionFlowStatus

        Account status information
        Object

        ActionFlow

        Account status information

        • StatusCode

          Status code

          string

        • StatusDate

          Status date

          DateTime

        • StatusDescription

          Status description

          string

        • SubstatusCode

          Substatus date

          string

        • SubstatusDate

          Substatus date

          DateTime

        • SubstatusDescription

          Substatus date

          string

      • Active

        Is active boolean flag.

        bool

      • AmountSpecification

        List of customer account amount specifications.
        Array
        Object

        CustomerAccountAmount

        Customer account amount description.

        • AmountType Mandatory

          Customer account amount type.
          Enum

          CustomerAccountAmountType

          Customer account amount type.

          • Fee

            Fee.

          • CreditDebt

            Credit debt.

          • CapitalizedInterest

            Capitalized interest.

          • Billed

            Billed.

          • Due

            Due.

          • PenaltyInterestOnPrincipal

            Penalty interest on principal.

          • PenaltyInterestOnInterest

            Penalty interest on interest.

          • PrePayment

            Pre payment.

        • BilledDate

          Billed date.

          DateTime

        • DueDate

          Due date.

          DateTime

        • FeeCode

          Fee code.

          string

        • RemainingInterest Mandatory

          Remaining interest.

          decimal

        • RemainingPrincipal

          Remaining principal.

          decimal

      • BilledInterest

        Billed interest value.

        decimal

      • BilledPrincipal

        Billed principal value.

        decimal

      • ContractNumber

        Contract number.

        string

      • CreditApplicationStatus

        Credita pplication status.
        Enum

        CreditApplicationStatus

        Status of credit application.

        • NewApplication

          New credit application, initial state.

        • Analysis

          Pending analysis of credit application.

        • AwaitingConfirmation

          Awaiting confirmation for credit application.

        • AwaitingAdditionalInfo

          Awaiting additional information for credit application.

        • AwaitingSignature

          Awaiting signature from customer.

        • Rejected

          Credit application has been rejected.

        • Approved

          Credit application has been approved.

        • Terminated

          Credit application has been terminated.

      • CreditInterestRate

        Credit interest rate.

        decimal

      • CreditInterestType

        Credit interest type.

        string

      • CreditLimit

        Credit limit.

        decimal

      • DaysPassedDueInterest

        Days passed due interest.

        int

      • DaysPassedDuePrincipal

        Days passed due principal.

        int

      • Description

        Description.

        string

      • Disbursements

        Loan disbursement information
        Array
        Object

        LoanDisbursement

        Loan disbursement information

        • Amount Mandatory

          Amount

          decimal

        • CurrencyCode Mandatory

          Currency

          string

        • DisbursementDate Mandatory

          Operation date

          DateTime

      • ExtraFields

        List of extra fields.
        Array
        Object

        ExtraField

        Extra field contains custom data.

        • Data

          Value of extra field.

          string

        • Name

          Name of extra field.

          string

      • Insurances

        List of insurances.
        Array
        Object

        CustomerAccountInsurance

        Insurance for customer's account.

        • EndDate

          Insurance end date.

          DateTime

        • FeePercent

          Fee in percent av insured amount.

          decimal

        • InsuranceCode

          Credit debt insurance code.

          string

        • InsuranceCompanyReference

          Reference for insurance company.

          string

        • InsuredAmount

          Insured amount.

          decimal

        • MinimalFee

          Minimal fee.

          decimal

        • RegistrationDate

          Date of registration of insurance.

          DateTime

        • RemainingInsuredAmount

          Remaining amount of originally insured amount.

          decimal

      • LoanStatus

        Loan status.
        Enum

        CustomerLoanStatus

        Customer loan status.

        • Normal

          Loan is in normal state.

        • Reminder

          Payment reminder sent.

        • ReminderNoFee

          Payment reminder sent (No fee).

        • Collection

          Loan has been sent to debt collection.

        • Closed

          Loan has been closed.

        • OnHold

          Loan is on hold.

        • CollectionRevoked

          Loan debt collection has been revoked.

        • PreTermination

          Loan has been terminated earlier than planned.

        • Termination

          Loan has been terminated.

        • UsedRightToWithdraw

          Debtor has used the right to withdraw.

      • MaturityDate

        Maturity date.

        DateTime

      • NextDueDate

        Next due date.

        DateTime

      • OriginationCode

        Loan origination code.

        string

      • PaymentBankAccountNumber

        Payment bank account number.

        string

      • PaymentReference

        Payment reference.

        string

      • Payments

        List of payments.
        Array
        Object

        CustomerLoanPayment

        Customer payment on loan or account.

        • Fee

          Fees of amount paid.

          decimal

        • Interest

          Interest of amount paid.

          decimal

        • InvoiceNumber

          Invoice number.

          string

        • PaidAmount

          Amount paid.

          decimal

        • PaymentDate

          Date of payment.

          DateTime

        • PaymentGuid

          Payment's globally unique identifer.

          string

        • PenaltyInterest

          Penelty interest due to late payment.

          decimal

        • Prepayment

          Amount paid in advance of paid amount.

          decimal

        • Principal

          Principal of amount paid.

          decimal

      • Periods

        List of customer account periods.
        Array
        Object

        CustomerAccountPeriod

        Period for customer account, usually one payment per period and representing the length of a month.

        • DueDate

          Due date of payment.

          DateTime

        • IncomingDate

          Date at start of period.

          DateTime

        • IncomingInterest

          Incoming interest, i.e. interest amount from start of period.

          decimal

        • IncomingPrincipal

          Incoming principal, i.e principal amount from start of period.

          decimal

        • InvoicedAmount

          Total amount invoiced this period.

          decimal

        • InvoicedFee

          Fee amount invoiced this period.

          decimal

        • InvoicedInterest

          Interest amount invoiced this period.

          decimal

        • InvoicedPrincipal

          Principal amount invoiced this period.

          decimal

        • InvoiceNumber

          Invoice number for this period.

          string

        • MinimumToPay

          Minimum amount to pay this period.

          decimal

        • MinimumToPayToKeepCampaign

          Minimum amount to pay and still keep campaigns used.

          decimal

        • OutgoingDate

          Date at end of period.

          DateTime

        • OutgoingInterest

          Outgoing interest, i.e. interest amount at end of period.

          decimal

        • OutgoingPrincipal

          Outgoing principal, i.e. principal amount at end of period.

          decimal

        • OverdueFee

          The amount of fees that is overdue this period.

          decimal

        • OverdueInterest

          The amount of interest that is overdue this period.

          decimal

        • OverduePrincipal

          The amount of principal that is overdue this period.

          decimal

        • PaymentFreeMonths

          Contains months during the year that is payment free, 1-12 for Jan-Dec.
          Array

          int

        • PeriodGuid

          Period's globally unique identifier.

          string

        • ReminderCount

          Number of reminders.

          int

        • ReminderFee

          Reminder fee for period.

          decimal

        • SettlemetFee

          Settlement fee added this period.

          decimal

      • RegistrationDate

        Registration date.

        DateTime

      • RegistrationFee

        Registration fee.

        decimal

      • RemainingBilledInterest

        Remaining billed interest value.

        decimal

      • RemainingBilledPrincipal

        Remaining billed principal value.

        decimal

      • RemainingDueInterest

        Remaining due interest value.

        decimal

      • RemainingDuePrincipal

        Remaining due principal value.

        decimal

      • RemainingFee

        Remaining fee value.

        decimal

      • RemainingInterest

        Remaining interest value.

        decimal

      • RemainingPenaltyInterestOnInterest

        Remaining penalty interest on interest value.

        decimal

      • RemainingPenaltyInterestOnPrincipal

        Remaining penalty interest on principal value.

        decimal

      • RemainingPrincipal

        Remaining principal value.

        decimal

      • ReminderCount

        Reminder count.

        int

      • SettlementFee

        Settlement fee.

        decimal

      • Statuses

        List of statuses.
        Array
        Enum

        Status

        Loan status.

        • Closed

          Loan has been closed.

        • OnHold

          Loan is currently on hold.

        • Overdraft

          Loan has been overdrawn.

        • Reminder

          Loan has sent payment reminder.

        • DebtCollection

          Loan has been sent to debt collection.

        • CreditStop

          Loan has had credit stopped.

        • ManualCreditStop

          Loan has had credit stopped manually.

        • Respite

          Loan has payment respite.

        • Deceased

          Debtor has deceased.

        • Origination

          Loan in the phase of origination, to be activated.

        • Declined

          Loan was declined.

        • PreRedemption

          Loan redeemed earlier than planned.

        • Termination

          Loan has been terminated.

        • UsedRightToWithdraw

          Debtor has used right to withdraw.

        • PreTermination

          Loan is in pre termination state.

      • TypeCode

        Loan type code.

        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

GetCustomerLoanPaymentPlanDetails

Get loan payment plan details for customer.

Examples

Sample usage in C# generated client for a Swedish personal number: 
CustomerInformationClient client = new CustomerInformationClient();

GetCustomerLoanPaymentPlanDetailsResult result = client.GetCustomerLoanPaymentPlanDetails(new CustomerLoanPaymentPlanDetailsRequest
{
    CustomerLookup = new CustomerLookup
    {
        CustomerIdentification = CustomerIdentificationType.CustomerSESSNOrCompanyNo,
        CustomerIdentificationValue = "580711-2643",
        JuridicalType = CustomerJuridicalType.Physical
    },
});
Sample soap request for getting payment plans for a Swedish personal number: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b" xmlns:apt="http://schemas.datacontract.org/2004/07/Aptic.WebIntegrationPlatform.Soap.DataContracts.CustomerAccount">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetCustomerLoanPaymentPlanDetails>
         <urn:customerLoanPaymentPlanDetailsRequest>
            <apt:CustomerLookup>
               <urn:CustomerIdentification>CustomerSESSNOrCompanyNo</urn:CustomerIdentification>
               <urn:CustomerIdentificationValue>580711-2643</urn:CustomerIdentificationValue>
               <urn:JuridicalType>Physical</urn:JuridicalType>
            </apt:CustomerLookup>
         </urn:customerLoanPaymentPlanDetailsRequest>
      </urn:GetCustomerLoanPaymentPlanDetails>
   </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    GetCustomerLoanPaymentPlanDetails

    GetCustomerLoanPaymentPlanDetails

    • customerLoanPaymentPlanDetailsRequest

      A request for payment plan details.
      Object

      CustomerLoanPaymentPlanDetailsRequest

      Get customer loan payment plan details request.

      • CustomerAccountNumber

        Customer account number.

        string

      • CustomerLookup

        A lookup for customer.
        Object

        CustomerLookup

        A lookup for customer.

        • CustomerIdentification Mandatory

          Type of customer identification to look up.
          Enum

          CustomerIdentificationType

          Customer identification type.

          • Custom

            Custom identification.

          • CustomerSESSNOrCompanyNo

            Identify by Swedish SSN or company number.

          • CustomerNOSSNOrCompanyNo

            Identify by Norwegian SSN or company number.

          • CustomerReferenceNumber

            Identify by customer reference number.

          • CustomerGuid

            Customer identification.

        • CustomerIdentificationValue Mandatory

          Customer identification to look up, depending on type it has different formats.

          string

        • JuridicalType

          Type of customer, e.g. physical.
          Enum

          CustomerJuridicalType

          Juridical type of the customer.

          • Physical

            Physical person, meaning a natural person.

          • Company

            A company or other organisation.

          • PersonalFirm

            A company that shares the juridical entity with a physical person.

      • CustomerOwnerReferenceFilter

        Customer owner reference filter.

        string

      • LoanPaymentPlanStatus

        Loan payment plan status.
        Enum

        LoanPaymentPlanStatus

        Loan payment plan status.

        • Proposal

          Payment plan has been proposed but not active yet.

        • Active

          Payment plan is active.

        • Terminated

          Payment plan has been terminated.

        • Inactive

          Payment plan is inactive.

        • Renegotiated

          Payment blan has been renegotiated.

Output

A list of payment plan details found for request.
Error codes:
  • 1 : Value cannot be null.
  • 1 : error message from ARC server
Object

GetCustomerLoanPaymentPlanDetailsResponse

GetCustomerLoanPaymentPlanDetails response

  • GetCustomerLoanPaymentPlanDetailsResult

    Result of GetCustomerLoanPaymentPlanDetails
    Object

    GetCustomerLoanPaymentPlanDetailsResult

    Get customer loan payment plan details result.

    • LoanPaymentPlans

      List of loan payment plans.
      Array
      Object

      LoanPaymentPlanDetails

      Loan payment plans details.

      • APR

        Annual percentage rate.

        decimal

      • LoanPaymentPlanStatus

        Loan payment plan status.
        Enum

        LoanPaymentPlanStatus

        Loan payment plan status.

        • Proposal

          Payment plan has been proposed but not active yet.

        • Active

          Payment plan is active.

        • Terminated

          Payment plan has been terminated.

        • Inactive

          Payment plan is inactive.

        • Renegotiated

          Payment blan has been renegotiated.

      • PaymentPlanType

        Payment plan type.
        Enum

        PaymentPlanType

        Payment plan type.

        • Flat

          Flat interest, flat amortization.

        • Annuity

          Annuity, over time increase amortization as interest amount decreases.

        • InterestOnly

          Only pay for interest, no amortization.

      • Payments

        List of payments.
        Array
        Object

        LoanPaymentPlanPayment

        Loan payment details.

        • AmountToPay

          Amount to pay.

          decimal

        • BillingDate

          Billing date.

          DateTime

        • Fee

          Fee amount.

          decimal

        • FixedInterestRate

          Fixed interest rate amount.

          decimal

        • Interest

          Interest amount.

          decimal

        • PaidAmount

          Paid amount.

          decimal

        • PaymentDate

          Payment date.

          DateTime

        • Principal

          Principal amount.

          decimal

        • Status

          List of statuses of loan payment plan payment.
          Enum

          LoanPaymentPlanPaymentStatus

          Loan payment plan payment status.

          • NotBilled

            Bill not sent yet.

          • Billed

            Bill has been sent.

          • Overdue

            Payment overdue.

          • Paid

            Bill has been paid.

          • Respited

            Bill has been given respite.

          • PreTermination

            Payment plan has been terminated earlier than planned.

          • Terminated

            Payment plan has been terminated.

          • FreeMonth

            Free month. Not billed periods only.

          • FreedMonth

            Freed month. Billed and overdue periods only.

          • ZeroBilled

            Zero billed. Billed period with amount force set as 0.

      • RegistrationDate

        Payment plan registration date.

        DateTime

      • RemainingPayments

        Remaining payments.

        int

      • TotalFee

        Total fee.

        decimal

      • TotalInterest

        Total interest.

        decimal

      • TotalPayments

        Total payments.

        int

      • TotalPrincipal

        Total principal.

        decimal

    • Result

      The result of the request. Indicating success or error.
      Object

      ResultType

      Common result type.

      • ResultCode Mandatory

        The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.

        int

      • ResultText Mandatory

        Text information of the result. Usually contains a warning or error message when result code is indicating other than success.

        string

GetCustomerLoans

Get a customer's loans.

Examples

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

GetCustomerLoansResult result = client.GetCustomerLoans(new CustomerLoansRequest
{
    CustomerLookup = new CustomerLookup
    {
        CustomerIdentification = CustomerIdentificationType.CustomerSESSNOrCompanyNo,
        CustomerIdentificationValue = "580711-2643",
    },
    Active = 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:GetCustomerLoans>
         <urn:customerLoansRequest>
            <urn:Active>True</urn:Active>
            <urn:CustomerLookup>
               <urn:CustomerIdentification>CustomerSESSNOrCompanyNo</urn:CustomerIdentification>
               <urn:CustomerIdentificationValue>580711-2643</urn:CustomerIdentificationValue>
            </urn:CustomerLookup>
         </urn:customerLoansRequest>
      </urn:GetCustomerLoans>
   </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    GetCustomerLoans

    GetCustomerLoans

    • customerLoansRequest

      A request for customer loans.
      Object

      CustomerLoansRequest

      Get customer loans request details.

      • Active

        Is active boolean filter.

        bool

      • CustomerLookup

        A lookup for customer.
        Object

        CustomerLookup

        A lookup for customer.

        • CustomerIdentification Mandatory

          Type of customer identification to look up.
          Enum

          CustomerIdentificationType

          Customer identification type.

          • Custom

            Custom identification.

          • CustomerSESSNOrCompanyNo

            Identify by Swedish SSN or company number.

          • CustomerNOSSNOrCompanyNo

            Identify by Norwegian SSN or company number.

          • CustomerReferenceNumber

            Identify by customer reference number.

          • CustomerGuid

            Customer identification.

        • CustomerIdentificationValue Mandatory

          Customer identification to look up, depending on type it has different formats.

          string

        • JuridicalType

          Type of customer, e.g. physical.
          Enum

          CustomerJuridicalType

          Juridical type of the customer.

          • Physical

            Physical person, meaning a natural person.

          • Company

            A company or other organisation.

          • PersonalFirm

            A company that shares the juridical entity with a physical person.

      • CustomerOwnerReferenceFilter

        Customer owner reference filter.

        string

Output

A list of loans for customer filtered by parameters.
Error codes:
  • 50800: Account not found
Object

GetCustomerLoansResponse

GetCustomerLoans response

  • GetCustomerLoansResult

    Result of GetCustomerLoans
    Object

    GetCustomerLoansResult

    Get customer loans result.

    • CustomerLoans

      List of customer loans.
      Array
      Object

      CustomerLoan

      Customer loan description.

      • AccountGuid

        Customer account unique identifier.

        string

      • AccountNumber

        Customer account number.

        string

      • ActionFlowStatus

        Account status information
        Object

        ActionFlow

        Account status information

        • StatusCode

          Status code

          string

        • StatusDate

          Status date

          DateTime

        • StatusDescription

          Status description

          string

        • SubstatusCode

          Substatus date

          string

        • SubstatusDate

          Substatus date

          DateTime

        • SubstatusDescription

          Substatus date

          string

      • Active

        Is active boolean flag.

        bool

      • AmountSpecification

        List of customer account amount specifications.
        Array
        Object

        CustomerAccountAmount

        Customer account amount description.

        • AmountType Mandatory

          Customer account amount type.
          Enum

          CustomerAccountAmountType

          Customer account amount type.

          • Fee

            Fee.

          • CreditDebt

            Credit debt.

          • CapitalizedInterest

            Capitalized interest.

          • Billed

            Billed.

          • Due

            Due.

          • PenaltyInterestOnPrincipal

            Penalty interest on principal.

          • PenaltyInterestOnInterest

            Penalty interest on interest.

          • PrePayment

            Pre payment.

        • BilledDate

          Billed date.

          DateTime

        • DueDate

          Due date.

          DateTime

        • FeeCode

          Fee code.

          string

        • RemainingInterest Mandatory

          Remaining interest.

          decimal

        • RemainingPrincipal

          Remaining principal.

          decimal

      • BilledInterest

        Billed interest value.

        decimal

      • BilledPrincipal

        Billed principal value.

        decimal

      • ContractNumber

        Contract number.

        string

      • CreditApplicationStatus

        Credita pplication status.
        Enum

        CreditApplicationStatus

        Status of credit application.

        • NewApplication

          New credit application, initial state.

        • Analysis

          Pending analysis of credit application.

        • AwaitingConfirmation

          Awaiting confirmation for credit application.

        • AwaitingAdditionalInfo

          Awaiting additional information for credit application.

        • AwaitingSignature

          Awaiting signature from customer.

        • Rejected

          Credit application has been rejected.

        • Approved

          Credit application has been approved.

        • Terminated

          Credit application has been terminated.

      • CreditInterestRate

        Credit interest rate.

        decimal

      • CreditInterestType

        Credit interest type.

        string

      • CreditLimit

        Credit limit.

        decimal

      • DaysPassedDueInterest

        Days passed due interest.

        int

      • DaysPassedDuePrincipal

        Days passed due principal.

        int

      • Description

        Description.

        string

      • Disbursements

        Loan disbursement information
        Array
        Object

        LoanDisbursement

        Loan disbursement information

        • Amount Mandatory

          Amount

          decimal

        • CurrencyCode Mandatory

          Currency

          string

        • DisbursementDate Mandatory

          Operation date

          DateTime

      • ExtraFields

        List of extra fields.
        Array
        Object

        ExtraField

        Extra field contains custom data.

        • Data

          Value of extra field.

          string

        • Name

          Name of extra field.

          string

      • Insurances

        List of insurances.
        Array
        Object

        CustomerAccountInsurance

        Insurance for customer's account.

        • EndDate

          Insurance end date.

          DateTime

        • FeePercent

          Fee in percent av insured amount.

          decimal

        • InsuranceCode

          Credit debt insurance code.

          string

        • InsuranceCompanyReference

          Reference for insurance company.

          string

        • InsuredAmount

          Insured amount.

          decimal

        • MinimalFee

          Minimal fee.

          decimal

        • RegistrationDate

          Date of registration of insurance.

          DateTime

        • RemainingInsuredAmount

          Remaining amount of originally insured amount.

          decimal

      • LoanStatus

        Loan status.
        Enum

        CustomerLoanStatus

        Customer loan status.

        • Normal

          Loan is in normal state.

        • Reminder

          Payment reminder sent.

        • ReminderNoFee

          Payment reminder sent (No fee).

        • Collection

          Loan has been sent to debt collection.

        • Closed

          Loan has been closed.

        • OnHold

          Loan is on hold.

        • CollectionRevoked

          Loan debt collection has been revoked.

        • PreTermination

          Loan has been terminated earlier than planned.

        • Termination

          Loan has been terminated.

        • UsedRightToWithdraw

          Debtor has used the right to withdraw.

      • MaturityDate

        Maturity date.

        DateTime

      • NextDueDate

        Next due date.

        DateTime

      • OriginationCode

        Loan origination code.

        string

      • PaymentBankAccountNumber

        Payment bank account number.

        string

      • PaymentReference

        Payment reference.

        string

      • Payments

        List of payments.
        Array
        Object

        CustomerLoanPayment

        Customer payment on loan or account.

        • Fee

          Fees of amount paid.

          decimal

        • Interest

          Interest of amount paid.

          decimal

        • InvoiceNumber

          Invoice number.

          string

        • PaidAmount

          Amount paid.

          decimal

        • PaymentDate

          Date of payment.

          DateTime

        • PaymentGuid

          Payment's globally unique identifer.

          string

        • PenaltyInterest

          Penelty interest due to late payment.

          decimal

        • Prepayment

          Amount paid in advance of paid amount.

          decimal

        • Principal

          Principal of amount paid.

          decimal

      • Periods

        List of customer account periods.
        Array
        Object

        CustomerAccountPeriod

        Period for customer account, usually one payment per period and representing the length of a month.

        • DueDate

          Due date of payment.

          DateTime

        • IncomingDate

          Date at start of period.

          DateTime

        • IncomingInterest

          Incoming interest, i.e. interest amount from start of period.

          decimal

        • IncomingPrincipal

          Incoming principal, i.e principal amount from start of period.

          decimal

        • InvoicedAmount

          Total amount invoiced this period.

          decimal

        • InvoicedFee

          Fee amount invoiced this period.

          decimal

        • InvoicedInterest

          Interest amount invoiced this period.

          decimal

        • InvoicedPrincipal

          Principal amount invoiced this period.

          decimal

        • InvoiceNumber

          Invoice number for this period.

          string

        • MinimumToPay

          Minimum amount to pay this period.

          decimal

        • MinimumToPayToKeepCampaign

          Minimum amount to pay and still keep campaigns used.

          decimal

        • OutgoingDate

          Date at end of period.

          DateTime

        • OutgoingInterest

          Outgoing interest, i.e. interest amount at end of period.

          decimal

        • OutgoingPrincipal

          Outgoing principal, i.e. principal amount at end of period.

          decimal

        • OverdueFee

          The amount of fees that is overdue this period.

          decimal

        • OverdueInterest

          The amount of interest that is overdue this period.

          decimal

        • OverduePrincipal

          The amount of principal that is overdue this period.

          decimal

        • PaymentFreeMonths

          Contains months during the year that is payment free, 1-12 for Jan-Dec.
          Array

          int

        • PeriodGuid

          Period's globally unique identifier.

          string

        • ReminderCount

          Number of reminders.

          int

        • ReminderFee

          Reminder fee for period.

          decimal

        • SettlemetFee

          Settlement fee added this period.

          decimal

      • RegistrationDate

        Registration date.

        DateTime

      • RegistrationFee

        Registration fee.

        decimal

      • RemainingBilledInterest

        Remaining billed interest value.

        decimal

      • RemainingBilledPrincipal

        Remaining billed principal value.

        decimal

      • RemainingDueInterest

        Remaining due interest value.

        decimal

      • RemainingDuePrincipal

        Remaining due principal value.

        decimal

      • RemainingFee

        Remaining fee value.

        decimal

      • RemainingInterest

        Remaining interest value.

        decimal

      • RemainingPenaltyInterestOnInterest

        Remaining penalty interest on interest value.

        decimal

      • RemainingPenaltyInterestOnPrincipal

        Remaining penalty interest on principal value.

        decimal

      • RemainingPrincipal

        Remaining principal value.

        decimal

      • ReminderCount

        Reminder count.

        int

      • SettlementFee

        Settlement fee.

        decimal

      • Statuses

        List of statuses.
        Array
        Enum

        Status

        Loan status.

        • Closed

          Loan has been closed.

        • OnHold

          Loan is currently on hold.

        • Overdraft

          Loan has been overdrawn.

        • Reminder

          Loan has sent payment reminder.

        • DebtCollection

          Loan has been sent to debt collection.

        • CreditStop

          Loan has had credit stopped.

        • ManualCreditStop

          Loan has had credit stopped manually.

        • Respite

          Loan has payment respite.

        • Deceased

          Debtor has deceased.

        • Origination

          Loan in the phase of origination, to be activated.

        • Declined

          Loan was declined.

        • PreRedemption

          Loan redeemed earlier than planned.

        • Termination

          Loan has been terminated.

        • UsedRightToWithdraw

          Debtor has used right to withdraw.

        • PreTermination

          Loan is in pre termination state.

      • TypeCode

        Loan type code.

        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

GetCustomerOverpayments

Returns all overpayments on the creditors bank account.
Returns all overpayments on the creditors bank account connected to the customers directly or to the customers invoices. It should also be possible to request objects if they exists.

Examples

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

GetCustomerOverpaymentsResult result = client.GetCustomerOverpayments(new GetCustomerOverpaymentsRequest
{
    CustomerLookup = new CustomerLookup
    {
        CustomerIdentification = CustomerIdentificationType.CustomerSESSNOrCompanyNo,
        CustomerIdentificationValue = "580711-2643",
    },
    CustomerOwnerReferenceFilter = null,
    ObjectTypeFilter = "SITE,CONTRACT"
});
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:GetCustomerOverpayments>
        <urn:GetCustomerOverpaymentsRequest>
          <urn:CustomerLookup>
             <urn:CustomerIdentification>CustomerSESSNOrCompanyNo</urn:CustomerIdentification>
             <urn:CustomerIdentificationValue>580711-2643</urn:CustomerIdentificationValue>
          </urn:CustomerLookup>
          <ObjectTypeFilter>SITE,CONTRACT</ObjectTypeFilter>
        </urn:GetCustomerOverpaymentsRequest>
      </urn:GetCustomerOverpayments>
   </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    GetCustomerOverpayments

    GetCustomerOverpayments

    • customerOverpaymentsRequest

      A request for overpayments.
      Object

      GetCustomerOverpaymentsRequest

      Get customer overpayments request details.

      • CustomerLookup Mandatory

        A lookup for customer.
        Object

        CustomerLookup

        A lookup for customer.

        • CustomerIdentification Mandatory

          Type of customer identification to look up.
          Enum

          CustomerIdentificationType

          Customer identification type.

          • Custom

            Custom identification.

          • CustomerSESSNOrCompanyNo

            Identify by Swedish SSN or company number.

          • CustomerNOSSNOrCompanyNo

            Identify by Norwegian SSN or company number.

          • CustomerReferenceNumber

            Identify by customer reference number.

          • CustomerGuid

            Customer identification.

        • CustomerIdentificationValue Mandatory

          Customer identification to look up, depending on type it has different formats.

          string

        • JuridicalType

          Type of customer, e.g. physical.
          Enum

          CustomerJuridicalType

          Juridical type of the customer.

          • Physical

            Physical person, meaning a natural person.

          • Company

            A company or other organisation.

          • PersonalFirm

            A company that shares the juridical entity with a physical person.

      • CustomerOwnerReferenceFilter

        Customer owner reference filter.

        string

      • ObjectTypeFilter

        Comma-separated list of object types, e.g. SITE, CONTRACT etc. Should be used any of predefined values using correct letter case.

        string

Output

A list of overpayments for all the customers identified by filter.
Error codes:
  • 60800: Unknown objects filtering type code specified
Object

GetCustomerOverpaymentsResponse

GetCustomerOverpayments response

  • GetCustomerOverpaymentsResult

    Result of GetCustomerOverpayments
    Object

    GetCustomerOverpaymentsResult

    General class for representing method output.

    • CustomersOverpayments

      List of customer overpayments.
      Array
      Object

      CustomerOverpayments

      Customer overpayments information.

      • CustomerGuid

        Customer unique identifier.

        string

      • CustomerReference

        Customer reference.

        string

      • Overpayments

        List of overpayments.
        Array
        Object

        Overpayment

        Holds overpayment information.

        • CurrencyCode

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

          string

        • Objects

          List of objects related to payment ledger account's debts.
          Array

          XmlElement

        • OverpaymentAmount

          Overpayment amount.

          decimal

        • OverpaymentGuid

          Overpayment unique identifier.

          string

        • PaymentDate

          Payment date

          DateTime

    • Result

      The result of the request. Indicating success or error.
      Object

      ResultType

      Common result type.

      • ResultCode Mandatory

        The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.

        int

      • ResultText Mandatory

        Text information of the result. Usually contains a warning or error message when result code is indicating other than success.

        string

GetHistoryDocument

Get document from history.

Examples

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

GetHistoryDocumentResult result = client.GetHistoryDocument("C80F76D8-8B2D-4619-BE92-2070795A04C1");
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>C80F76D8-8B2D-4619-BE92-2070795A04C1</urn:HistoryGuid>
      </urn:GetHistoryDocument>
   </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    GetHistoryDocument

    GetHistoryDocument

    • HistoryGuid

      The identifier for history item.

      string

Output

File information and data if found.
Error codes:
  • 1 : Value cannot be null. {nameof(user)}
  • 1 : error message from ARC server
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: 
CustomerInformationClient client = new CustomerInformationClient();

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 customer 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

StartAuthSign

Starts an authentication/signing process.

Examples

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

GeneralResult result = client.StartAuthSign("9069B148-FAF3-4912-BE84-E11BDBA4E291", "SEMOBILEBANKID");
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:StartAuthSign>
         <urn:AuthSignGuid>9069B148-FAF3-4912-BE84-E11BDBA4E291</urn:AuthSignGuid>
         <urn:ProviderCode>SEMOBILEBANKID</urn:ProviderCode>
      </urn:StartAuthSign>
   </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    StartAuthSign

    StartAuthSign

    • AuthSignGuid

      Identifier used for authentication

      string

    • ProviderCode

      Code of the provider to use, e.g. SEMOBILEBANKID, MANUAL.

      string

Output

Returns result code 0 if it went ok.
Error codes:
  • 1 : error message from ARC server
///
Object

StartAuthSignResponse

StartAuthSign response

  • StartAuthSignResult

    Result of StartAuthSign
    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

StopAuthSign

Stops an ongoing authentication/signing.

Examples

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

GeneralResult result = client.StopAuthSign("9069B148-FAF3-4912-BE84-E11BDBA4E291", AuthSignStopReason.Abort, "Something happened");
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:StopAuthSign>
         <urn:AuthSignGuid>9069B148-FAF3-4912-BE84-E11BDBA4E291</urn:AuthSignGuid>
         <urn:Reason>Abort</urn:Reason>
         <urn:ReasonText>Something happened</urn:ReasonText>
      </urn:StopAuthSign>
   </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    StopAuthSign

    StopAuthSign

    • AuthSignGuid

      The identifier of the authentication/signing to stop.

      string

    • Reason

      The reason why authentication/signing is stopped.
      Enum

      AuthSignStopReason

      The reason an authentication/signing was stopped.

      • Abort

        Authentication/signing was aborted.

      • Reject

        Authentication/signing was rejected.

    • ReasonText

      Text describing teh reason for stopping authentication/signing.

      string

Output

Returns result code 0 if it went ok.
Error codes:
  • 1 : error message from ARC server
Object

StopAuthSignResponse

StopAuthSign response

  • StopAuthSignResult

    Result of StopAuthSign
    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

UpdateInvoiceDueDateAsync

Updates due date of specified invoice by number.

Examples

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

client.UpdateInvoiceDueDate(new UpdateInvoiceDueDateRequest
{
    InvoiceNumber = "2222222222222545702",
    NewInvouceDueDate = new DateTime(2019, 03, 30, 8, 0, 0)
});
Sample soap request: 
 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b" xmlns:apt="http://schemas.datacontract.org/2004/07/Aptic.WebIntegrationPlatform.Soap.DataContracts">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:UpdateInvoiceDueDate>
         <urn:UpdateInvoiceDueDateRequest>
            <apt:InvoiceNumber>2222222222222545702</apt:InvoiceNumber>
            <apt:NewInvouceDueDate>2019-01-30</apt:NewInvouceDueDate>
         </urn:UpdateInvoiceDueDateRequest>
      </urn:UpdateInvoiceDueDate>
   </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    UpdateInvoiceDueDateAsync

    UpdateInvoiceDueDateAsync

    • CustomerOwnerReferenceFilter

      Optional filter invoice by owner reference.

      string

    • UpdateInvoiceDueDateRequest

      Information about the invoice and its new duew date.
      Object

      UpdateInvoiceDueDateRequest

      Request to update due date of invoice.

      • InvoiceNumber Mandatory

        Invoice number.

        string

      • NewInvouceDueDate

        New due date for invoice.

        DateTime

Output

Will return with result code 0 if everything went ok. Otherwise result text will contain error message.
Error codes:
  • 1 : error message from ARC server
Object

UpdateInvoiceDueDateAsyncResponse

UpdateInvoiceDueDateAsync response

  • UpdateInvoiceDueDateAsyncResult

    Result of UpdateInvoiceDueDateAsync
    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