CreditUpdate

Service used for register and view credit applications.

ActionEvent

Triggers a action event.

Examples

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

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

AddInstalment

Add instalment

Examples

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

ResultType result = client.AddInstalment(
    new AddInstalmentRequest
    {
        CustomerLookup = new CustomerLookup
        {
            CustomerIdentification = CustomerIdentificationType.CustomerNOSSNOrCompanyNo,
            CustomerIdentificationValue = "431211-4269",
            JuridicalType = CustomerJuridicalType.Physical
        },
        CreditorReference = "1000",
        CustomerAccountReference = "30000008827",
        Instalment = new Instalment
        {
            AmountToPay = 100,
            BillingDate = new DateTime(2019, 3, 20),
            PaymentDate = new DateTime(2019, 3, 30),
            PrincipalAmount = 60,
            InterestAmount = 30,
            FeeAmount = 10
        }
    });
Sample soap request: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
   <soapenv:Header/>
     <urn:AddInstalment>
        <urn:addInstalmentRequest>
            <urn:CreditorReference>1000</urn:CreditorReference>
            <urn:CustomerAccountReference>30000008827</urn:CustomerAccountReference>
            <urn:CustomerLookup>
               <urn:CustomerIdentification>CustomerSESSNOrCompanyNo</urn:CustomerIdentification>
               <urn:CustomerIdentificationValue>431211-4269</urn:CustomerIdentificationValue>
               <urn:JuridicalType>Physical</urn:JuridicalType>
            </urn:CustomerLookup>
            <urn:Instalment>
               <urn:AmountToPay>200</urn:AmountToPay>
               <urn:BillingDate>2018-09-15</urn:BillingDate>
               <urn:FeeAmount>10</urn:FeeAmount>
               <urn:InterestAmount>90</urn:InterestAmount>
               <urn:PaymentDate>2018-09-28</urn:PaymentDate>
               <urn:PrincipalAmount>100</urn:PrincipalAmount>
            </urn:Instalment>
         </urn:addInstalmentRequest>
     </urn:AddInstalment>
   </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Add instalment information
    Object

    AddInstalment

    AddInstalment

    • addInstalmentRequest

      Add instalment request
      Object

      AddInstalmentRequest

      Add instalment information

      • CreditorReference

        Party reference code.

        string

      • CustomerAccountReference Mandatory

        Loan reference number.

        string

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

      • Instalment Mandatory

        Instalment information.
        Object

        Instalment

        Instalment information

        • AmountToPay Mandatory

          Amount to pay.

          decimal

        • BillingDate Mandatory

          Billing/Letter date

          DateTime

        • FeeAmount

          Fee amount

          decimal

        • InterestAmount

          Interest amount

          decimal

        • PaymentDate

          Payment date

          DateTime

        • PrincipalAmount

          Principal amount

          decimal

Output

Returns result code 0 if instalment successfully added.
Error codes:
  • 1 : Error message from ARC server
  • 80100 : Not enough parameters
  • 80200 : Invalid parameter
  • 80300 : No customer account was found
  • 80400 : More than one customer account was found
  • 80500 : Another active paymentplan exists
  • 80600 : Payment period already exists
  • 80700 : The specified amount to pay is not equal to the sum of the provided amount types
Object

AddInstalmentResponse

AddInstalmentResponse

  • AddInstalmentResult

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

AlterInstalment

Alters instalment

Examples

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

ResultType result = client.AlterInstalment(
	new AlterInstalmentRequest
	{
		CustomerLookup = new CustomerLookup
		{
			CustomerIdentification = CustomerIdentificationType.CustomerNOSSNOrCompanyNo,
			CustomerIdentificationValue = "580711-2643",
			JuridicalType = CustomerJuridicalType.Physical
		},
		BillingDate = new DateTime(2019, 10, 10),
		DueDate = new DateTime(2019, 10, 10),
		LetterTriggeredAt = new DateTime(2019, 10, 10),
		ReminderTriggeredAt = new DateTime(2019, 10, 10),
		FeeAmount = 10,
		InterestAmount = 10,
		PrincipalAmount = 10,
		LoanReferenceNumber = "124124",
		TriggerSettlement = false,
		Service = InstalmentService.InstalmentInvoiced
	});
Sample soap request: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
   <soapenv:Header/>
     <urn:AlterInstalment>
        <urn:alterInstalmentRequest>
            <urn:BillingDate>2019-10-10</urn:BillingDate>
            <urn:CustomerLookup>
               <urn:CustomerIdentification>CustomerSESSNOrCompanyNo</urn:CustomerIdentification>
               <urn:CustomerIdentificationValue>580711-2643</urn:CustomerIdentificationValue>
               <urn:JuridicalType>Physical</urn:JuridicalType>
            </urn:CustomerLookup>
            <urn:DueDate>2019-10-10</urn:DueDate>
            <urn:FeeAmount>10</urn:FeeAmount>
            <urn:InterestAmount>10</urn:InterestAmount>
            <urn:LetterTriggeredAt>2019-10-10</urn:LetterTriggeredAt>
            <urn:LoanReferenceNumber>124124</urn:LoanReferenceNumber>
            <urn:PrincipalAmount>10</urn:PrincipalAmount>
            <urn:ReminderTriggeredAt>2019-10-10</urn:ReminderTriggeredAt>
            <urn:Service>InstalmentInvoiced</urn:Service>
            <urn:TriggerSettlement>true</urn:TriggerSettlement>
         </urn:alterInstalmentRequest>
     </urn:AlterInstalment>
   </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Alter instalment information
    Object

    AlterInstalment

    AlterInstalment

    • alterInstalmentRequest

      AlterInstalment request
      Object

      AlterInstalmentRequest

      Alter instalment information

      • BillingDate

        Letter date/Billing date. The billing date of the payment notification.

        DateTime

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

      • DueDate Mandatory

        Due date.

        DateTime

      • FeeAmount Mandatory

        Fee amount.

        decimal

      • InterestAmount Mandatory

        Interest amount.

        decimal

      • LetterTriggeredAt

        Letter triggered at.

        DateTime

      • LoanReferenceNumber Mandatory

        Loan reference number.

        string

      • PrincipalAmount Mandatory

        Principal amount.

        decimal

      • ReminderTriggeredAt

        Reminder triggered at.

        DateTime

      • Service

        Instalment service. Default value is ‘Instalment invoiced (0)’.
        Enum

        InstalmentService

        Instalment service.

        • InstalmentInvoiced

          Payment notification (instalment invoice).

        • Reminder

          Reminder.

        • Termination

          Termination.

      • TriggerSettlement

        Trigger or not trigger settlement boolean flag. Default value is false.

        bool

Output

Returns result code 0 if instalment successfully altered.
Error codes:
  • 1 : error message from ARC server
  • 80100 : Not enough parameters
  • 80200 : Invalid parameter
  • 80300 : No customer account was found
  • 80400 : More than one customer account was found
  • 80500 : Another active paymentplan exists
  • 80800 : The account you are trying to select have a status that is not allowed.
Object

AlterInstalmentResponse

AlterInstalment response

  • AlterInstalmentResult

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

InitiatePretermination

Closes the loan

Examples

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

SetClosureOnAccountResult result = client.SetClosureOnAccount(null, "30000008782", "1001", "PAIDINFULL", 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/>
     <urn:SetClosureOnAccount>
        <urn:ClosureCode>PAIDINFULL</urn:ClosureCode>
        <urn:CreditorReference>1001</urn:CreditorReference>
        <urn:CustomerAccountReference>30000008782</urn:CustomerAccountReference>
        <urn:Transactions>
           <urn:ClosureTransaction>
              <urn:Amount>100</urn:Amount>
              <urn:TransDate>2019-09-24</urn:TransDate>
              <urn:TransType>Credit</urn:TransType>
           </urn:ClosureTransaction>
        </urn:Transactions>
     </urn:SetClosureOnAccount>
   </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    InitiatePretermination

    InitiatePretermination

    • InitiatePreterminationReq

      InitiatePretermination request
      Object

      InitiatePreterminationRequest

      Initiate pretermination request structure

      • CreditAccount

        Credit account to update.
        Object

        Account

        Account

        • Accountnumber

          The account number

          string

        • Brokerreferencecode

          Broker reference code

          string

        • Calcrate

          Current interest rate (Debit)

          decimal

        • Collectiondate

          Date for debt collection

          DateTime

        • Collector

          User code for preferred collector

          string

        • Creditcalcrate

          Current interest rate (Credit)

          decimal

        • Creditinterestcode

          Interest type code (Credit)

          string

        • Creditinterestrate

          Interest rate (Credit)

          decimal

        • Creditlimit

          Credit limit for this account

          decimal

        • Creditlimitfeepercent

          Credit limit fee in percent

          decimal

        • Creditstop

          Is the account stopped for purchase

          bool

        • Creditstopcausedescription

          Description of the cause of the credit stop

          string

        • Creditstopcauseid

          Bit masked 64 bit integer defining multiple causes for credit stop

          string

        • Currencycode

          3 chars ISO 4217 currency code

          string

        • Currentbalance

          The current balance of the account

          decimal

        • Customeraccounttypecode Mandatory

          Type of account

          string

        • Customers Mandatory

          Customers
          Array
          Object

          Customer

          Customer

          • Addresses

            addresses
            Array
            Object

            Address

            Address

            • Addressnotvalid

              Address not valid from this date

              DateTime

            • Addressnotvalidoverride

              Do not perform any checkups on the address, assume it's correct

              bool

            • Addresstype Mandatory

              Address type; legal, avi or invoice
              Enum

              Address.AddresstypeEnum

              Address type; legal, avi or invoice

              • Legal

                Legal

              • Avi

                Avi

              • Invoice

                Invoice

            • Careof

              Care of

              string

            • City

              City

              string

            • Country

              Country

              string

            • Countrycode

              Country code - 2 chars ISO 3166-1 alpha-2

              string

            • Defaultaddress

              True if this is the default address

              bool

            • Fulladdress

              Full address in one field

              string

            • Fullname

              Full name

              string

            • Houseno

              House number

              string

            • Housenoextension

              House number extension

              string

            • Statecode

              State code

              string

            • Street

              Street

              string

            • Updateexisting

              True if existing matching address should be update with new data

              bool

            • Zipcode

              Zip code

              string

          • Addressnotvalidoverride

            Do not perform any checkups on the address, assume it's correct

            bool

          • Autotransferbankaccount

            Auto transfer bank account number

            string

          • Autotransferrefno

            Auto transfer reference number

            string

          • Bankaccounts

            bankaccounts
            Array
            Object

            Bankaccount

            Customer bank account number for disbursement

            • Bankaccountno

              Customer bank account number (national or IBAN)

              string

            • Bankcode

              Bank code

              string

            • Bankdescription

              Description of bankaccount

              string

            • Bic

              BIC code for the bank

              string

            • Blz

              BLZ/clearing number

              string

            • Countrycode

              Country where the bank account is located

              string

            • Currencycode

              Currency code for the bank account

              string

            • Iban

              IBAN bank account number (if national account is used)

              string

            • Swift

              SWIFT number

              string

          • Careof

            Care of

            string

          • Cellularphone

            Cellular phone

            string

          • City

            City

            string

          • Companyname

            Name of the company

            string

          • Country

            Country name

            string

          • Countrycode

            Country code 2 chars ISO 3166-1 alpha-2

            string

          • Currencycode

            3 chars ISO 4217 currency code

            string

          • Customerref

            Customer number/reference

            string

          • Customerrole

            Customer role
            Enum

            CustomerroleEnum

            CustomerroleEnum

            • Debtor

              Debtor

            • Guarantor

              Guarantor

            • Co_Applicant

              Co_Applicant

            • Estatebeneficiary

              Estatebeneficiary

            • Tradingcompany_Partner

              Tradingcompany_Partner

            • General_Partner

              General_Partner

            • Custodian

              Custodian

            • Solvent_Person

              Solvent_Person

          • Dataprovisions

            Data provisions, connected to customer
            Array
            Object

            Dataprovision

            Dataprovision

            • Code Mandatory

              Dataprovision code

              string

            • Text

              Extra information regarding the data provision

              string

            • Version

              Version number of the dataprovision

              string

          • Dateofbirth

            Date of birth

            DateTime

          • Domicile

            Domicile

            string

          • Einvoicereceiverid

            Receiver identity for electronic invoicing

            string

          • Email

            Email address

            string

          • Establishmentdate

            Establishment date

            DateTime

          • Extrafields

            extrafields
            Array
            Object

            Extrafield

            Extrafield

            • Data Mandatory

              Data contents of the extra field

              string

            • Name Mandatory

              Name of the extra field, defined in cfg_extrafield

              string

          • Firstname Mandatory

            First/company name

            string

          • Fulladdress

            Full address in one field

            string

          • Gender

            Gender
            Enum

            GendertypeEnum

            GendertypeEnum

            • Female

              Female

            • Male

              Male

            • Unknown

              Unknown

          • Glnnumber

            GLN - Global Location Number

            string

          • Homephone

            Home phone

            string

          • Houseno

            House number

            string

          • Housenoextension

            House number extension

            string

          • Id

            The value for the attribute id

            string

          • Idnumber

            Customer id number

            string

          • Initials

            Initials

            string

          • Juridicaltype

            Customer juridical type
            Enum

            JuridicaltypeEnum

            JuridicaltypeEnum

            • Value1

              Person

            • Value2

              Company

          • Languagecode

            Language code

            string

          • Lastname

            Last name

            string

          • Leinumber

            LEI - Legal Entity Identifier

            string

          • Maritalstatus

            Marital status
            Enum

            MaritalstatustypeEnum

            MaritalstatustypeEnum

            • Unmarried

              Unmarried

            • Married

              Married

            • Common_Law_Spouse

              Common_Law_Spouse

            • Widow

              Widow

            • Divorced

              Divorced

            • Partner

              Partner

          • Middlename

            Middle name

            string

          • Municipalcode

            Municipal code

            string

          • Nacecode

            NACE classification code

            string

          • Namesuffix

            Name suffix

            string

          • Originationdetails

            Originationdetails
            Object

            Originationdetails

            Loan origination details per applicant

            • Annualincome

              Annual income/salary

              decimal

            • Employer

              Name of employer

              string

            • Employerphone

              Phone number to employer

              string

            • Employmenttype

              Type of employment
              Enum

              EmploymenttypeEnum

              EmploymenttypeEnum

              • Student

                Disability_Pension

              • Disability_Pension

                Disability_Pension

              • Unemployed

                Unemployed

              • Temporary_Employed

                Temporary_Employed

              • Permanent_Employed

                Permanent_Employed

              • Self_Employed

                Self_Employed

              • Retired

                Retired

            • Extrafields

              Extra fields, connected to credit applicant
              Array
              Object

              Extrafield

              Extrafield

              • Data Mandatory

                Data contents of the extra field

                string

              • Name Mandatory

                Name of the extra field, defined in cfg_extrafield

                string

            • Maritalstatus

              Marital status
              Enum

              MaritalstatustypeEnum

              MaritalstatustypeEnum

              • Unmarried

                Unmarried

              • Married

                Married

              • Common_Law_Spouse

                Common_Law_Spouse

              • Widow

                Widow

              • Divorced

                Divorced

              • Partner

                Partner

            • Monthlycostforothercreditsandloans

              Monthly cost for other loans and credits

              decimal

            • Monthlyincome

              Monthly income/salary

              decimal

            • Monthlyrentalcost

              Rental cost per month

              decimal

            • Numberofadults

              No of adults at home

              int

            • Numberofdependentchildren

              No of children at home

              int

            • Othersecuredloans

              Other loans with collaterals

              decimal

            • Othertotalcreditsandloans

              Other loans and credits

              decimal

            • Otherunsecuredloans

              Other unsecured loans (blanco)

              decimal

            • Residentdescription

              Free text description of the resident

              string

            • Shareofaccommodationcost

              Your share of accommodation cost per month

              decimal

            • Typeofresident

              Type of resident
              Enum

              ResidenttypeEnum

              ResidenttypeEnum

              • Rented_Apartment

                Rented_Apartment

              • Co_Operative_Apartment

                Co_Operative_Apartment

              • Detached_House

                Detached_House

              • Roomer_Or_Second_Hand

                Roomer_Or_Second_Hand

          • Parentcustomer

            Parentcustomer
            Object

            Parentcustomer

            Parentcustomer

            • Ref_ Mandatory

              The value for the attribute ref

              string

          • Placeofbirth

            Place of birth

            string

          • Preferredchannel

            Code for preferred channel

            string

          • Representatives

            Representatives
            Array
            Object

            Representative

            Representative

            • Mandate

              Mandate

              string

            • Ref_ Mandatory

              Ref_

              string

            • Representativerole

              Representativerole

              string

          • Statecode

            State code

            string

          • Street

            Street

            string

          • Telefax

            Telefax

            string

          • Title

            Customer title

            string

          • Underage

            True if customer is underaged

            bool

          • Updateexisting

            True if matching existing customer should be updated with new info

            bool

          • Vatnumber

            VAT registration number

            string

          • Workphone

            Work phone

            string

          • Zipcode

            Zip code

            string

        • Dataprovisions

          Data provisions, connected to account
          Array
          Object

          Dataprovision

          Dataprovision

          • Code Mandatory

            Dataprovision code

            string

          • Text

            Extra information regarding the data provision

            string

          • Version

            Version number of the dataprovision

            string

        • Deductioninterval

          Deduction interval in days. 30 equals a month

          int

        • Deliverysystemcode

          Delivering system

          string

        • Documents

          Documents
          Array
          Object

          Document

          Documents on credit account, eg. loan agreement

          • Documenttype

            Type of document
            Enum

            DocumenttypeEnum

            DocumenttypeEnum

            • Unspecified

              Unspecified

            • Original_Invoice

              Original_Invoice

            • Contract

              Contract

          • Externallink

            Link to an external repository

            string

          • Filecontents

            Base64 encoded file contents

            string

          • Loggedat

            Note time stamp

            DateTime

          • Note Mandatory

            Textual note/description regarding the document

            string

          • Originalfilename

            Original file name

            string

        • Extrafields

          Extrafields
          Array
          Object

          Extrafield

          Extrafield

          • Data Mandatory

            Data contents of the extra field

            string

          • Name Mandatory

            Name of the extra field, defined in cfg_extrafield

            string

        • Fixedinteresttermstart

          Date for current fixed interest term start. Required for fixed term interest rates

          DateTime

        • Interestcapitalizationdate

          Next interest capitalization

          DateTime

        • Interestcode

          Interest type code (Debit)

          string

        • Interestfrom

          Interest calulated from date

          DateTime

        • Interestrate

          Interest rate (Debit)

          decimal

        • Interestto

          Interest calulated to date

          DateTime

        • Loantosettles

          Loantosettles
          Array
          Object

          Loantosettle

          Loantosettle

          • Accruedinterest

            Accrued interest to disbursement date of the settlement amount

            decimal

          • Bankaccount

            Bank account to use for settlement payment
            Object

            Bankaccount

            Customer bank account number for disbursement

            • Bankaccountno

              Customer bank account number (national or IBAN)

              string

            • Bankcode

              Bank code

              string

            • Bankdescription

              Description of bankaccount

              string

            • Bic

              BIC code for the bank

              string

            • Blz

              BLZ/clearing number

              string

            • Countrycode

              Country where the bank account is located

              string

            • Currencycode

              Currency code for the bank account

              string

            • Iban

              IBAN bank account number (if national account is used)

              string

            • Swift

              SWIFT number

              string

          • Bankname Mandatory

            Bank that holds the previous loan

            string

          • Currencycode Mandatory

            Currency code for the loan

            string

          • Disbursementdate

            End date for disbursement of settled amount

            DateTime

          • Fees

            Other fees of the settlement amount

            decimal

          • Loanreferencenumber Mandatory

            Loan account number

            string

          • Netineterestlosscompensation

            Compensation for net interest loss, included in settlement amount

            decimal

          • Paymentreferencenumber

            Payment reference number for the settlement payment to the bank

            string

          • Principalamount

            The principal part of the settlement amount

            decimal

          • Settlementamount Mandatory

            Total amount to settle the loan

            decimal

        • Mincreditinterestamount

          Minimum interest amount

          decimal

        • Nextdeductiondate

          Date for next deduction of the account

          DateTime

        • Nextpaymentdate

          Due date for next payment

          DateTime

        • Notes

          Notes
          Array
          Object

          Note

          Notes shown on credit account

          • Histnotetypeid

            System specific note type id. Only used for migration purpose

            int

          • Histownertypeid

            System specific owner type id. Only used for migration purpose

            int

          • Important

            Important note = true

            bool

          • Loggedat

            Note time stamp

            DateTime

          • Note Mandatory

            Note text

            string

          • Systemcode

            System code

            string

          • Usercode

            User code

            string

        • Origination

          Origination
          Object

          Origination

          Loan origination information

          • Applicationdate

            Date when the application was filed

            DateTime

          • Appliedcreditamount Mandatory

            Credit amount applied for

            decimal

          • Durationinmonths Mandatory

            Duration of the loan in months

            int

          • Economicccalculation

            Economic calculation details

            string

          • Extrafields

            Extra fields, connected to credit application
            Array
            Object

            Extrafield

            Extrafield

            • Data Mandatory

              Data contents of the extra field

              string

            • Name Mandatory

              Name of the extra field, defined in cfg_extrafield

              string

          • Interestcode

            Interest type code

            string

          • Interestrate

            Interest rate

            decimal

          • Originalappliedcreditamount

            Original credit amount applied for

            decimal

          • Originaldurationinmonths

            Original duration of the loan in months

            int

          • Reason

            Reason for the loan in clear text

            string

          • Startdate Mandatory

            Start date for the loan

            DateTime

        • Paymentoccasionoffset

          Offset for next payment day calculation

          int

        • Paymentoccasiontype

          Type of calculation for next payment day
          Enum

          PaymentoccasiontypeEnum

          PaymentoccasiontypeEnum

          • Value1

            Represents the value '1' in the XML

          • Value2

            Represents the value '2' in the XML

        • Paymentplan

          Paymentplan
          Object

          Paymentplan

          Amortization plan for loans

          • Interval

            Interval/days of amortization plan, default 30 (one month)

            int

          • Intervaltype

            Interval type of amortization plan
            Enum

            LoanpaymentplanintervaltypeEnum

            LoanpaymentplanintervaltypeEnum

            • StartOfMonth

              StartOfMonth

            • EndOfMonth

              EndOfMonth

            • Month

              Month

            • Day

              Day

          • Loanpaymentplantype Mandatory

            Type of amortization plan
            Enum

            LoanpaymentplantypetypeEnum

            LoanpaymentplantypetypeEnum

            • Flat

              Flat

            • Annuity

              Annuity

            • InterestOnly

              InterestOnly

            • Virtual

              Virtual

          • Maturitydate

            The maturity date of amortization plan

            DateTime

          • Numpayments Mandatory

            Number of payments in amortization plan

            int

          • Payments

            All payment occasions in amortization plan
            Array
            Object

            Payment

            Amortization plan payment occasion

            • Amount

              Total amount to pay on the occasion

              decimal

            • Fixedinterest

              Fixed interest rate

              decimal

            • Paymentdate Mandatory

              Payment (due) date

              DateTime

            • Principalamount

              Part of the payment that should be allocated as amortization

              decimal

          • Startdate

            Starting date of amortization plan

            DateTime

        • Paymentreference

          Payment reference / OCR number

          string

        • Pledges

          Pledges
          Array
          Object

          Pledge

          Pledge information for this account

          • Customers Mandatory

            Customers
            Array
            Object

            Pledge.CustomerPledge

            CustomerPledge

            • Customer

              Customer
              Array
              Object

              Customerref

              Customerref

              • Ref_ Mandatory

                The value for the attribute ref

                string

            • Idnumber

              Personal number for guarantor in customer-element
              Array

              string

          • Description

            Description of the pledge

            string

          • Fullguarantee

            Full guarantee information
            Object

            Fullguarantee

            Full guarantee information

            • Generalfordebtor

              Id number of debtor that this pledge is a general guarantee for

              string

            • Guaranteetypeid Mandatory

              Guarantee type

              int

          • Guarantee

            Guarantee information
            Object

            Guarantee

            Guarantee information

            • Currencycode Mandatory

              Guarantee currency

              string

            • Generalfordebtor

              Id number of customer that this pledge is a general guarantee for

              string

            • Guaranteetypeid Mandatory

              Guarantee type

              int

            • Interestamount Mandatory

              Guarantee interest amount

              string

            • Interestcode

              Interest type code

              string

            • Interestfrom

              Interest calulated from date

              DateTime

            • Interestrate

              Interest rate

              decimal

            • Interestto

              Interest calulated to date

              DateTime

            • Principalamount Mandatory

              Guarantee principal amount

              string

            • Remaininginterest

              Remaining interest amount in guarantee

              decimal

            • Remainingprincipal

              Remaining principal amount in guarantee

              decimal

            • Validuntil

              Guarantee valid until

              DateTime

          • Insuranceexpirydate

            Expiry date of the insurance for this pledge

            DateTime

          • Insurancenumber

            Insurance number for this pledge

            string

          • Insuredamount

            Insured amount for this pledge

            decimal

          • Insurer

            Insurer for this pledge

            string

          • Mortgagecompanies

            Mortgage companies information
            Object

            Mortgagecompanies

            Mortgage companies information

            • Amountfrom

              Mortgage companies from amount (obsolete, use mortgagelienpriorities instead)

              decimal

            • Amountto

              Mortgage companies to amount (obsolete, use mortgagelienpriorities instead)

              decimal

            • Collateralcode

              Pre defined collateral code

              string

            • Companyname

              Companyname

              string

            • Mortgagelienpriorities

              All known mortgage lien priorities
              Object

              Mortgagelienpriorities

              Mortgagelienpriorities

              • Lienpriorities

                Lienpriorities
                Array
                Object

                Mortgagelienpriorities.LienpriorityElm

                LienpriorityElm

                • Date

                  Date

                  DateTime

                • Lienpriorityamount Mandatory

                  Lienpriorityamount

                  decimal

                • Note

                  Note

                  string

                • Owner

                  Owner

                  string

                • Pledgedamount

                  Pledgedamount

                  decimal

                • Priorityorder

                  Priorityorder

                  int

                • Referencenumber

                  Referencenumber

                  string

          • Movableproperty

            Movable property information
            Object

            Movableproperty

            Movable property information

            • Collateralcode

              Pre defined collateral code

              string

            • Mortgagelienpriorities

              All known mortgage lien priorities
              Object

              Mortgagelienpriorities

              Mortgagelienpriorities

              • Lienpriorities

                Lienpriorities
                Array
                Object

                Mortgagelienpriorities.LienpriorityElm

                LienpriorityElm

                • Date

                  Date

                  DateTime

                • Lienpriorityamount Mandatory

                  Lienpriorityamount

                  decimal

                • Note

                  Note

                  string

                • Owner

                  Owner

                  string

                • Pledgedamount

                  Pledgedamount

                  decimal

                • Priorityorder

                  Priorityorder

                  int

                • Referencenumber

                  Referencenumber

                  string

            • Propertytypeid Mandatory

              Movable property type

              int

            • Valueamount

              Value amount

              decimal

            • Valuedat

              Valued at

              DateTime

            • Valuedby

              Valued by

              string

          • Note

            Notes for this pledge

            string

          • Pledgeamount

            Pledge amount

            decimal

          • Pledgedate Mandatory

            Pledge date

            DateTime

          • Pledgetypeid

            Type of pledge (not needed as the choice of extra information determines type)

            int

          • Realproperty

            Real property information
            Object

            Realproperty

            Real property information

            • Amountfrom

              Mortgage companies from amount (obsolete, use mortgagelienpriorities instead)

              decimal

            • Amountto

              Mortgage companies to amount (obsolete, use mortgagelienpriorities instead)

              decimal

            • Collateralcode

              Pre defined collateral code

              string

            • Estate Mandatory

              Real estate identification

              string

            • Estatetypeid Mandatory

              Estate type

              int

            • Landcertificate

              Landcertificate
              Object

              Landcertificate

              Landcertificate

              • Owners Mandatory

                Owners
                Object

                Landcertificate_Owners

                Landcertificate_Owners

                • Owner

                  Owner
                  Array
                  Object

                  Landcertificate_Owners.OwnerElm

                  OwnerElm

                  • Fullname

                    Fullname

                    string

                  • Idnumber

                    Idnumber

                    string

                  • Ownership

                    Percentage of ownership for the current real property.

                    decimal

            • Mortgagelienpriorities

              All known mortgage lien priorities
              Object

              Mortgagelienpriorities

              Mortgagelienpriorities

              • Lienpriorities

                Lienpriorities
                Array
                Object

                Mortgagelienpriorities.LienpriorityElm

                LienpriorityElm

                • Date

                  Date

                  DateTime

                • Lienpriorityamount Mandatory

                  Lienpriorityamount

                  decimal

                • Note

                  Note

                  string

                • Owner

                  Owner

                  string

                • Pledgedamount

                  Pledgedamount

                  decimal

                • Priorityorder

                  Priorityorder

                  int

                • Referencenumber

                  Referencenumber

                  string

            • Reportingcode

              Reportingcode

              string

            • Reportingdate

              Reportingdate

              DateTime

            • Taxvalue

              Tax value amount

              decimal

            • Valueamount

              Value amount

              decimal

            • Valuedat

              Valued at

              DateTime

            • Valuedby

              Valued by

              string

          • Referencenumber Mandatory

            Reference or identification number for pledge

            string

        • Remindedat

          Date for last reminder

          DateTime

        • Remindercount

          Number of reminders sent

          int

        • Settleimmediately

          Settle any transactions immediately

          bool

        • Transactions

          Transactions
          Array
          Object

          Transaction

          Transaction record.

          • Amount Mandatory

            Total amount incl. VAT for this transaction

            decimal

          • Amountspecs

            Detailed specification of the sub transactions
            Array
            Object

            Amountspec

            Amountspec

            • Amount Mandatory

              The amount (+ for new debt, - for payments)

              decimal

            • Amounttype

              Amount type. 1 for principal, 2 for interest

              int

            • Currencycode

              Currency code if other than the main transaction

              string

            • Debttype

              Debt type. 5 for credit, 2 for imported fee, 7 for capitalized interest

              int

            • Feecode

              The fee code (i.e. REMIND)

              string

            • Transspectypecode

              Transaction specification code. To be used for different accounting behaviour

              string

            • Transsubtype

              Sub transaction type

              int

            • Transtype

              Transaction type. 121 for payments and 120 for purchases (default)

              int

          • Cashregisternumber

            Cash register number that handled the purchase

            string

          • Deliverycondition

            Delivery condition from purchase processing system. Only stored as information in Aptic ARC.

            string

          • Deliverydate

            Delivery date from purchase processing system. Only stored as information in Aptic ARC.

            DateTime

          • Deliverymethod

            Delivery method from purchase processing system. Only stored as information in Aptic ARC.

            string

          • Deliverynoteid

            Delivery number from purchase processing system. Only stored as information in Aptic ARC.

            string

          • Description

            Description of this transaction in clear text

            string

          • Duedate

            Due date from purchase processing system. Only stored as information in Aptic ARC.

            DateTime

          • Externalinvoicenumber

            External invoicenumber from purchase processing system. Only stored as information in Aptic ARC.

            string

          • Externalpaymentreference

            External payment reference from purchase processing system. Only stored as information in Aptic ARC.

            string

          • Invoicenumber

            Invoicenumber from purchase processing system. Only stored as information in Aptic ARC.

            string

          • Itemcount

            Number of units of the items purchased

            int

          • Itemprincipal

            Price per item incl. vat.

            decimal

          • Message

            Message from purchase processing system. Only stored as information in Aptic ARC.

            string

          • Ourorder

            Our order number from purchase processing system. Only stored as information in Aptic ARC.

            string

          • Ourreference

            Our reference contact from purchase processing system. Only stored as information in Aptic ARC.

            string

          • Paymentcondition

            Payment condition from purchase processing system. Only stored as information in Aptic ARC.

            int

          • Placeofpurchase

            Place of purchase if store isn't used

            string

          • Printcode

            Print code to control printing of invoice.

            string

          • Receiptnumber

            Receipt number of the purchase

            string

          • Receivercity

            Receiver city

            string

          • Receivercountrycode

            Receiver country code - 2 chars ISO 3166-1 alpha-2

            string

          • Receiverfulladdress

            Receiver full address

            string

          • Receiverfullname

            Receiver full name

            string

          • Receiverhouseno

            House number

            string

          • Receiverhousenoextension

            House number extension

            string

          • Receiverstatecode

            Receiver state code

            string

          • Receiverstreet

            Receiver street

            string

          • Receiverzipcode

            Receiver zip code

            string

          • Referencenumber

            Referencenumber for this transaction

            string

          • Rounding

            Rounding amount for this transaction

            decimal

          • Storereferencecode

            The store that handled the purchase. This store must be in Aptic ARC

            string

          • Transdate Mandatory

            Date for this transaction

            DateTime

          • Transspectypecode

            Transaction specification code. To be used for different accounting behaviour

            string

          • Transtype

            Transaction type. 121 for payments and 120 for purchases (default)

            int

          • Unittype

            Units of item in clear text

            string

          • Yourorder

            Your order number from purchase processing system. Only stored as information in Aptic ARC.

            string

          • Yourreference

            Your reference contact from purchase processing system. Only stored as information in Aptic ARC.

            string

        • Yearlyconsumption

          Yearly consumption for utility accounts (formatted and including unit)

          string

        • Yearlyconsumptionamount

          Calculated yearly consumption for utility accounts (in account's currency)

          decimal

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

      • LoanReferenceNumber Mandatory

        Loan reference number.

        string

      • MinAmountBackToNormal

        Minimal amount to be paid to reserver back to normal Loan from (pre)termination status

        decimal

      • NextStatusCheck

        Next status check date for pre-termination

        DateTime

      • TerminationStatus Mandatory

        Status of pre-termination.
        Enum

        TerminationStatus

        Termination status

        • Pretermination

          Pre-termination

        • Performing

          Performing

Output

Ok if operation was performed successfully
Error codes:
  • 1 : error message from ARC server
Object

InitiatePreterminationResponse

InitiatePretermination response

  • InitiatePreterminationResult

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

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

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 credit update 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

RegisterAndUpdateCreditAccount

Register or Update CreditAccount For update existing account field "Accountnumber" might be settled For update existing customer field set Updateexisting = true, fill fields "Id", "Customerref", "Idnumber" in Customer object

Examples

Sample usage in C# generated client: 
CreditUpdateClient client = new CreditUpdateClient();
RegisterCreditAccountResult result = client.RegisterAndUpdateCreditAccount(new RegisterCreditAccountRequest()
{
    CreditorReference = "1001",
    CreditAccount = new Account
    {
        Creditlimit = 123,
        Currencycode = "SEK",
        Customers = new List <Customer>()
        {
            new Customer()
            {
                Cellularphone = "123123",
                Currencycode = "sek",
                Customerref = "9212128019",
                Dateofbirth = new DateTime(1990, 1, 1),
                Firstname = "Firstname",
                Gender = GendertypeEnum.Male,
                Id = "12106009",
                Juridicaltype = JuridicaltypeEnum.Value1,
                Languagecode = "SE",
                Lastname = "Lastname",
                Leinumber = "1493006stf3jbeysn481",
                Maritalstatus = MaritalstatustypeEnum.Married,
                Preferredchannel = "email",
                Street = "Street",
                Updateexisting = true,
                Zipcode = "23232"
            }
        }.ToArray()
    }
});
</code>
Sample soap request:
<code class="xml">
<![CDATA[
<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.CreditUpdate" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">	
	<soapenv:Header/>
		<soapenv:Body>
		<urn:RegisterAndUpdateCreditAccount>
			<urn:registerCreditAccountRequest>
				<urn:CreditAccount>	
					<urn:Accountnumber>61000136475</urn:Accountnumber>
					<urn:Creditlimit>275000.00</urn:Creditlimit>
					<urn:Currencycode>SEK</urn:Currencycode>
					<urn:Customers>
						<urn:Customer>
							<urn:Cellularphone>0457-111111142</urn:Cellularphone>
							<urn:City>somecity</urn:City>
							<urn:Currencycode>sek</urn:Currencycode>
							<urn:Customerref>3229128079</urn:Customerref>
							<urn:Dateofbirth>2001-07-02</urn:Dateofbirth>
							<urn:Firstname>Firstname</urn:Firstname>
							<urn:Gender>Male</urn:Gender>
							<urn:Id>12196009</urn:Id>
							<urn:Idnumber>9219128079</urn:Idnumber>
							<urn:Juridicaltype>Value1</urn:Juridicaltype>
							<urn:Languagecode>SE</urn:Languagecode>
							<urn:Lastname>lastname</urn:Lastname>
							<urn:Leinumber>1493006stf3jbeysn481</urn:Leinumber>
							<urn:Maritalstatus>Married</urn:Maritalstatus>
							<urn:Preferredchannel>email</urn:Preferredchannel>
							<urn:Street>Street</urn:Street>
							<urn:Updateexisting>true</urn:Updateexisting>
							<urn:Zipcode>21223</urn:Zipcode>
						</urn:Customer>
					</urn:Customers>
					<urn:Customeraccounttypecode>KLUBBKONTO</urn:Customeraccounttypecode>
				</urn:CreditAccount>
				<urn:CreditorReference>1001</urn:CreditorReference>
			</urn:registerCreditAccountRequest>
		</urn:RegisterAndUpdateCreditAccount>
	</soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    register CreditAccount information
    Object

    RegisterAndUpdateCreditAccount

    RegisterAndUpdateCreditAccount

    • RegisterCreditAccountRequest

      RegisterAndUpdateCreditAccount request
      Object

      RegisterCreditAccountRequest

      General class for representing method output.

      • CreditAccount Mandatory

        Credit accounts.
        Object

        Account

        Account

        • Accountnumber

          The account number

          string

        • Brokerreferencecode

          Broker reference code

          string

        • Calcrate

          Current interest rate (Debit)

          decimal

        • Collectiondate

          Date for debt collection

          DateTime

        • Collector

          User code for preferred collector

          string

        • Creditcalcrate

          Current interest rate (Credit)

          decimal

        • Creditinterestcode

          Interest type code (Credit)

          string

        • Creditinterestrate

          Interest rate (Credit)

          decimal

        • Creditlimit

          Credit limit for this account

          decimal

        • Creditlimitfeepercent

          Credit limit fee in percent

          decimal

        • Creditstop

          Is the account stopped for purchase

          bool

        • Creditstopcausedescription

          Description of the cause of the credit stop

          string

        • Creditstopcauseid

          Bit masked 64 bit integer defining multiple causes for credit stop

          string

        • Currencycode

          3 chars ISO 4217 currency code

          string

        • Currentbalance

          The current balance of the account

          decimal

        • Customeraccounttypecode Mandatory

          Type of account

          string

        • Customers Mandatory

          Customers
          Array
          Object

          Customer

          Customer

          • Addresses

            addresses
            Array
            Object

            Address

            Address

            • Addressnotvalid

              Address not valid from this date

              DateTime

            • Addressnotvalidoverride

              Do not perform any checkups on the address, assume it's correct

              bool

            • Addresstype Mandatory

              Address type; legal, avi or invoice
              Enum

              Address.AddresstypeEnum

              Address type; legal, avi or invoice

              • Legal

                Legal

              • Avi

                Avi

              • Invoice

                Invoice

            • Careof

              Care of

              string

            • City

              City

              string

            • Country

              Country

              string

            • Countrycode

              Country code - 2 chars ISO 3166-1 alpha-2

              string

            • Defaultaddress

              True if this is the default address

              bool

            • Fulladdress

              Full address in one field

              string

            • Fullname

              Full name

              string

            • Houseno

              House number

              string

            • Housenoextension

              House number extension

              string

            • Statecode

              State code

              string

            • Street

              Street

              string

            • Updateexisting

              True if existing matching address should be update with new data

              bool

            • Zipcode

              Zip code

              string

          • Addressnotvalidoverride

            Do not perform any checkups on the address, assume it's correct

            bool

          • Autotransferbankaccount

            Auto transfer bank account number

            string

          • Autotransferrefno

            Auto transfer reference number

            string

          • Bankaccounts

            bankaccounts
            Array
            Object

            Bankaccount

            Customer bank account number for disbursement

            • Bankaccountno

              Customer bank account number (national or IBAN)

              string

            • Bankcode

              Bank code

              string

            • Bankdescription

              Description of bankaccount

              string

            • Bic

              BIC code for the bank

              string

            • Blz

              BLZ/clearing number

              string

            • Countrycode

              Country where the bank account is located

              string

            • Currencycode

              Currency code for the bank account

              string

            • Iban

              IBAN bank account number (if national account is used)

              string

            • Swift

              SWIFT number

              string

          • Careof

            Care of

            string

          • Cellularphone

            Cellular phone

            string

          • City

            City

            string

          • Companyname

            Name of the company

            string

          • Country

            Country name

            string

          • Countrycode

            Country code 2 chars ISO 3166-1 alpha-2

            string

          • Currencycode

            3 chars ISO 4217 currency code

            string

          • Customerref

            Customer number/reference

            string

          • Customerrole

            Customer role
            Enum

            CustomerroleEnum

            CustomerroleEnum

            • Debtor

              Debtor

            • Guarantor

              Guarantor

            • Co_Applicant

              Co_Applicant

            • Estatebeneficiary

              Estatebeneficiary

            • Tradingcompany_Partner

              Tradingcompany_Partner

            • General_Partner

              General_Partner

            • Custodian

              Custodian

            • Solvent_Person

              Solvent_Person

          • Dataprovisions

            Data provisions, connected to customer
            Array
            Object

            Dataprovision

            Dataprovision

            • Code Mandatory

              Dataprovision code

              string

            • Text

              Extra information regarding the data provision

              string

            • Version

              Version number of the dataprovision

              string

          • Dateofbirth

            Date of birth

            DateTime

          • Domicile

            Domicile

            string

          • Einvoicereceiverid

            Receiver identity for electronic invoicing

            string

          • Email

            Email address

            string

          • Establishmentdate

            Establishment date

            DateTime

          • Extrafields

            extrafields
            Array
            Object

            Extrafield

            Extrafield

            • Data Mandatory

              Data contents of the extra field

              string

            • Name Mandatory

              Name of the extra field, defined in cfg_extrafield

              string

          • Firstname Mandatory

            First/company name

            string

          • Fulladdress

            Full address in one field

            string

          • Gender

            Gender
            Enum

            GendertypeEnum

            GendertypeEnum

            • Female

              Female

            • Male

              Male

            • Unknown

              Unknown

          • Glnnumber

            GLN - Global Location Number

            string

          • Homephone

            Home phone

            string

          • Houseno

            House number

            string

          • Housenoextension

            House number extension

            string

          • Id

            The value for the attribute id

            string

          • Idnumber

            Customer id number

            string

          • Initials

            Initials

            string

          • Juridicaltype

            Customer juridical type
            Enum

            JuridicaltypeEnum

            JuridicaltypeEnum

            • Value1

              Person

            • Value2

              Company

          • Languagecode

            Language code

            string

          • Lastname

            Last name

            string

          • Leinumber

            LEI - Legal Entity Identifier

            string

          • Maritalstatus

            Marital status
            Enum

            MaritalstatustypeEnum

            MaritalstatustypeEnum

            • Unmarried

              Unmarried

            • Married

              Married

            • Common_Law_Spouse

              Common_Law_Spouse

            • Widow

              Widow

            • Divorced

              Divorced

            • Partner

              Partner

          • Middlename

            Middle name

            string

          • Municipalcode

            Municipal code

            string

          • Nacecode

            NACE classification code

            string

          • Namesuffix

            Name suffix

            string

          • Originationdetails

            Originationdetails
            Object

            Originationdetails

            Loan origination details per applicant

            • Annualincome

              Annual income/salary

              decimal

            • Employer

              Name of employer

              string

            • Employerphone

              Phone number to employer

              string

            • Employmenttype

              Type of employment
              Enum

              EmploymenttypeEnum

              EmploymenttypeEnum

              • Student

                Disability_Pension

              • Disability_Pension

                Disability_Pension

              • Unemployed

                Unemployed

              • Temporary_Employed

                Temporary_Employed

              • Permanent_Employed

                Permanent_Employed

              • Self_Employed

                Self_Employed

              • Retired

                Retired

            • Extrafields

              Extra fields, connected to credit applicant
              Array
              Object

              Extrafield

              Extrafield

              • Data Mandatory

                Data contents of the extra field

                string

              • Name Mandatory

                Name of the extra field, defined in cfg_extrafield

                string

            • Maritalstatus

              Marital status
              Enum

              MaritalstatustypeEnum

              MaritalstatustypeEnum

              • Unmarried

                Unmarried

              • Married

                Married

              • Common_Law_Spouse

                Common_Law_Spouse

              • Widow

                Widow

              • Divorced

                Divorced

              • Partner

                Partner

            • Monthlycostforothercreditsandloans

              Monthly cost for other loans and credits

              decimal

            • Monthlyincome

              Monthly income/salary

              decimal

            • Monthlyrentalcost

              Rental cost per month

              decimal

            • Numberofadults

              No of adults at home

              int

            • Numberofdependentchildren

              No of children at home

              int

            • Othersecuredloans

              Other loans with collaterals

              decimal

            • Othertotalcreditsandloans

              Other loans and credits

              decimal

            • Otherunsecuredloans

              Other unsecured loans (blanco)

              decimal

            • Residentdescription

              Free text description of the resident

              string

            • Shareofaccommodationcost

              Your share of accommodation cost per month

              decimal

            • Typeofresident

              Type of resident
              Enum

              ResidenttypeEnum

              ResidenttypeEnum

              • Rented_Apartment

                Rented_Apartment

              • Co_Operative_Apartment

                Co_Operative_Apartment

              • Detached_House

                Detached_House

              • Roomer_Or_Second_Hand

                Roomer_Or_Second_Hand

          • Parentcustomer

            Parentcustomer
            Object

            Parentcustomer

            Parentcustomer

            • Ref_ Mandatory

              The value for the attribute ref

              string

          • Placeofbirth

            Place of birth

            string

          • Preferredchannel

            Code for preferred channel

            string

          • Representatives

            Representatives
            Array
            Object

            Representative

            Representative

            • Mandate

              Mandate

              string

            • Ref_ Mandatory

              Ref_

              string

            • Representativerole

              Representativerole

              string

          • Statecode

            State code

            string

          • Street

            Street

            string

          • Telefax

            Telefax

            string

          • Title

            Customer title

            string

          • Underage

            True if customer is underaged

            bool

          • Updateexisting

            True if matching existing customer should be updated with new info

            bool

          • Vatnumber

            VAT registration number

            string

          • Workphone

            Work phone

            string

          • Zipcode

            Zip code

            string

        • Dataprovisions

          Data provisions, connected to account
          Array
          Object

          Dataprovision

          Dataprovision

          • Code Mandatory

            Dataprovision code

            string

          • Text

            Extra information regarding the data provision

            string

          • Version

            Version number of the dataprovision

            string

        • Deductioninterval

          Deduction interval in days. 30 equals a month

          int

        • Deliverysystemcode

          Delivering system

          string

        • Documents

          Documents
          Array
          Object

          Document

          Documents on credit account, eg. loan agreement

          • Documenttype

            Type of document
            Enum

            DocumenttypeEnum

            DocumenttypeEnum

            • Unspecified

              Unspecified

            • Original_Invoice

              Original_Invoice

            • Contract

              Contract

          • Externallink

            Link to an external repository

            string

          • Filecontents

            Base64 encoded file contents

            string

          • Loggedat

            Note time stamp

            DateTime

          • Note Mandatory

            Textual note/description regarding the document

            string

          • Originalfilename

            Original file name

            string

        • Extrafields

          Extrafields
          Array
          Object

          Extrafield

          Extrafield

          • Data Mandatory

            Data contents of the extra field

            string

          • Name Mandatory

            Name of the extra field, defined in cfg_extrafield

            string

        • Fixedinteresttermstart

          Date for current fixed interest term start. Required for fixed term interest rates

          DateTime

        • Interestcapitalizationdate

          Next interest capitalization

          DateTime

        • Interestcode

          Interest type code (Debit)

          string

        • Interestfrom

          Interest calulated from date

          DateTime

        • Interestrate

          Interest rate (Debit)

          decimal

        • Interestto

          Interest calulated to date

          DateTime

        • Loantosettles

          Loantosettles
          Array
          Object

          Loantosettle

          Loantosettle

          • Accruedinterest

            Accrued interest to disbursement date of the settlement amount

            decimal

          • Bankaccount

            Bank account to use for settlement payment
            Object

            Bankaccount

            Customer bank account number for disbursement

            • Bankaccountno

              Customer bank account number (national or IBAN)

              string

            • Bankcode

              Bank code

              string

            • Bankdescription

              Description of bankaccount

              string

            • Bic

              BIC code for the bank

              string

            • Blz

              BLZ/clearing number

              string

            • Countrycode

              Country where the bank account is located

              string

            • Currencycode

              Currency code for the bank account

              string

            • Iban

              IBAN bank account number (if national account is used)

              string

            • Swift

              SWIFT number

              string

          • Bankname Mandatory

            Bank that holds the previous loan

            string

          • Currencycode Mandatory

            Currency code for the loan

            string

          • Disbursementdate

            End date for disbursement of settled amount

            DateTime

          • Fees

            Other fees of the settlement amount

            decimal

          • Loanreferencenumber Mandatory

            Loan account number

            string

          • Netineterestlosscompensation

            Compensation for net interest loss, included in settlement amount

            decimal

          • Paymentreferencenumber

            Payment reference number for the settlement payment to the bank

            string

          • Principalamount

            The principal part of the settlement amount

            decimal

          • Settlementamount Mandatory

            Total amount to settle the loan

            decimal

        • Mincreditinterestamount

          Minimum interest amount

          decimal

        • Nextdeductiondate

          Date for next deduction of the account

          DateTime

        • Nextpaymentdate

          Due date for next payment

          DateTime

        • Notes

          Notes
          Array
          Object

          Note

          Notes shown on credit account

          • Histnotetypeid

            System specific note type id. Only used for migration purpose

            int

          • Histownertypeid

            System specific owner type id. Only used for migration purpose

            int

          • Important

            Important note = true

            bool

          • Loggedat

            Note time stamp

            DateTime

          • Note Mandatory

            Note text

            string

          • Systemcode

            System code

            string

          • Usercode

            User code

            string

        • Origination

          Origination
          Object

          Origination

          Loan origination information

          • Applicationdate

            Date when the application was filed

            DateTime

          • Appliedcreditamount Mandatory

            Credit amount applied for

            decimal

          • Durationinmonths Mandatory

            Duration of the loan in months

            int

          • Economicccalculation

            Economic calculation details

            string

          • Extrafields

            Extra fields, connected to credit application
            Array
            Object

            Extrafield

            Extrafield

            • Data Mandatory

              Data contents of the extra field

              string

            • Name Mandatory

              Name of the extra field, defined in cfg_extrafield

              string

          • Interestcode

            Interest type code

            string

          • Interestrate

            Interest rate

            decimal

          • Originalappliedcreditamount

            Original credit amount applied for

            decimal

          • Originaldurationinmonths

            Original duration of the loan in months

            int

          • Reason

            Reason for the loan in clear text

            string

          • Startdate Mandatory

            Start date for the loan

            DateTime

        • Paymentoccasionoffset

          Offset for next payment day calculation

          int

        • Paymentoccasiontype

          Type of calculation for next payment day
          Enum

          PaymentoccasiontypeEnum

          PaymentoccasiontypeEnum

          • Value1

            Represents the value '1' in the XML

          • Value2

            Represents the value '2' in the XML

        • Paymentplan

          Paymentplan
          Object

          Paymentplan

          Amortization plan for loans

          • Interval

            Interval/days of amortization plan, default 30 (one month)

            int

          • Intervaltype

            Interval type of amortization plan
            Enum

            LoanpaymentplanintervaltypeEnum

            LoanpaymentplanintervaltypeEnum

            • StartOfMonth

              StartOfMonth

            • EndOfMonth

              EndOfMonth

            • Month

              Month

            • Day

              Day

          • Loanpaymentplantype Mandatory

            Type of amortization plan
            Enum

            LoanpaymentplantypetypeEnum

            LoanpaymentplantypetypeEnum

            • Flat

              Flat

            • Annuity

              Annuity

            • InterestOnly

              InterestOnly

            • Virtual

              Virtual

          • Maturitydate

            The maturity date of amortization plan

            DateTime

          • Numpayments Mandatory

            Number of payments in amortization plan

            int

          • Payments

            All payment occasions in amortization plan
            Array
            Object

            Payment

            Amortization plan payment occasion

            • Amount

              Total amount to pay on the occasion

              decimal

            • Fixedinterest

              Fixed interest rate

              decimal

            • Paymentdate Mandatory

              Payment (due) date

              DateTime

            • Principalamount

              Part of the payment that should be allocated as amortization

              decimal

          • Startdate

            Starting date of amortization plan

            DateTime

        • Paymentreference

          Payment reference / OCR number

          string

        • Pledges

          Pledges
          Array
          Object

          Pledge

          Pledge information for this account

          • Customers Mandatory

            Customers
            Array
            Object

            Pledge.CustomerPledge

            CustomerPledge

            • Customer

              Customer
              Array
              Object

              Customerref

              Customerref

              • Ref_ Mandatory

                The value for the attribute ref

                string

            • Idnumber

              Personal number for guarantor in customer-element
              Array

              string

          • Description

            Description of the pledge

            string

          • Fullguarantee

            Full guarantee information
            Object

            Fullguarantee

            Full guarantee information

            • Generalfordebtor

              Id number of debtor that this pledge is a general guarantee for

              string

            • Guaranteetypeid Mandatory

              Guarantee type

              int

          • Guarantee

            Guarantee information
            Object

            Guarantee

            Guarantee information

            • Currencycode Mandatory

              Guarantee currency

              string

            • Generalfordebtor

              Id number of customer that this pledge is a general guarantee for

              string

            • Guaranteetypeid Mandatory

              Guarantee type

              int

            • Interestamount Mandatory

              Guarantee interest amount

              string

            • Interestcode

              Interest type code

              string

            • Interestfrom

              Interest calulated from date

              DateTime

            • Interestrate

              Interest rate

              decimal

            • Interestto

              Interest calulated to date

              DateTime

            • Principalamount Mandatory

              Guarantee principal amount

              string

            • Remaininginterest

              Remaining interest amount in guarantee

              decimal

            • Remainingprincipal

              Remaining principal amount in guarantee

              decimal

            • Validuntil

              Guarantee valid until

              DateTime

          • Insuranceexpirydate

            Expiry date of the insurance for this pledge

            DateTime

          • Insurancenumber

            Insurance number for this pledge

            string

          • Insuredamount

            Insured amount for this pledge

            decimal

          • Insurer

            Insurer for this pledge

            string

          • Mortgagecompanies

            Mortgage companies information
            Object

            Mortgagecompanies

            Mortgage companies information

            • Amountfrom

              Mortgage companies from amount (obsolete, use mortgagelienpriorities instead)

              decimal

            • Amountto

              Mortgage companies to amount (obsolete, use mortgagelienpriorities instead)

              decimal

            • Collateralcode

              Pre defined collateral code

              string

            • Companyname

              Companyname

              string

            • Mortgagelienpriorities

              All known mortgage lien priorities
              Object

              Mortgagelienpriorities

              Mortgagelienpriorities

              • Lienpriorities

                Lienpriorities
                Array
                Object

                Mortgagelienpriorities.LienpriorityElm

                LienpriorityElm

                • Date

                  Date

                  DateTime

                • Lienpriorityamount Mandatory

                  Lienpriorityamount

                  decimal

                • Note

                  Note

                  string

                • Owner

                  Owner

                  string

                • Pledgedamount

                  Pledgedamount

                  decimal

                • Priorityorder

                  Priorityorder

                  int

                • Referencenumber

                  Referencenumber

                  string

          • Movableproperty

            Movable property information
            Object

            Movableproperty

            Movable property information

            • Collateralcode

              Pre defined collateral code

              string

            • Mortgagelienpriorities

              All known mortgage lien priorities
              Object

              Mortgagelienpriorities

              Mortgagelienpriorities

              • Lienpriorities

                Lienpriorities
                Array
                Object

                Mortgagelienpriorities.LienpriorityElm

                LienpriorityElm

                • Date

                  Date

                  DateTime

                • Lienpriorityamount Mandatory

                  Lienpriorityamount

                  decimal

                • Note

                  Note

                  string

                • Owner

                  Owner

                  string

                • Pledgedamount

                  Pledgedamount

                  decimal

                • Priorityorder

                  Priorityorder

                  int

                • Referencenumber

                  Referencenumber

                  string

            • Propertytypeid Mandatory

              Movable property type

              int

            • Valueamount

              Value amount

              decimal

            • Valuedat

              Valued at

              DateTime

            • Valuedby

              Valued by

              string

          • Note

            Notes for this pledge

            string

          • Pledgeamount

            Pledge amount

            decimal

          • Pledgedate Mandatory

            Pledge date

            DateTime

          • Pledgetypeid

            Type of pledge (not needed as the choice of extra information determines type)

            int

          • Realproperty

            Real property information
            Object

            Realproperty

            Real property information

            • Amountfrom

              Mortgage companies from amount (obsolete, use mortgagelienpriorities instead)

              decimal

            • Amountto

              Mortgage companies to amount (obsolete, use mortgagelienpriorities instead)

              decimal

            • Collateralcode

              Pre defined collateral code

              string

            • Estate Mandatory

              Real estate identification

              string

            • Estatetypeid Mandatory

              Estate type

              int

            • Landcertificate

              Landcertificate
              Object

              Landcertificate

              Landcertificate

              • Owners Mandatory

                Owners
                Object

                Landcertificate_Owners

                Landcertificate_Owners

                • Owner

                  Owner
                  Array
                  Object

                  Landcertificate_Owners.OwnerElm

                  OwnerElm

                  • Fullname

                    Fullname

                    string

                  • Idnumber

                    Idnumber

                    string

                  • Ownership

                    Percentage of ownership for the current real property.

                    decimal

            • Mortgagelienpriorities

              All known mortgage lien priorities
              Object

              Mortgagelienpriorities

              Mortgagelienpriorities

              • Lienpriorities

                Lienpriorities
                Array
                Object

                Mortgagelienpriorities.LienpriorityElm

                LienpriorityElm

                • Date

                  Date

                  DateTime

                • Lienpriorityamount Mandatory

                  Lienpriorityamount

                  decimal

                • Note

                  Note

                  string

                • Owner

                  Owner

                  string

                • Pledgedamount

                  Pledgedamount

                  decimal

                • Priorityorder

                  Priorityorder

                  int

                • Referencenumber

                  Referencenumber

                  string

            • Reportingcode

              Reportingcode

              string

            • Reportingdate

              Reportingdate

              DateTime

            • Taxvalue

              Tax value amount

              decimal

            • Valueamount

              Value amount

              decimal

            • Valuedat

              Valued at

              DateTime

            • Valuedby

              Valued by

              string

          • Referencenumber Mandatory

            Reference or identification number for pledge

            string

        • Remindedat

          Date for last reminder

          DateTime

        • Remindercount

          Number of reminders sent

          int

        • Settleimmediately

          Settle any transactions immediately

          bool

        • Transactions

          Transactions
          Array
          Object

          Transaction

          Transaction record.

          • Amount Mandatory

            Total amount incl. VAT for this transaction

            decimal

          • Amountspecs

            Detailed specification of the sub transactions
            Array
            Object

            Amountspec

            Amountspec

            • Amount Mandatory

              The amount (+ for new debt, - for payments)

              decimal

            • Amounttype

              Amount type. 1 for principal, 2 for interest

              int

            • Currencycode

              Currency code if other than the main transaction

              string

            • Debttype

              Debt type. 5 for credit, 2 for imported fee, 7 for capitalized interest

              int

            • Feecode

              The fee code (i.e. REMIND)

              string

            • Transspectypecode

              Transaction specification code. To be used for different accounting behaviour

              string

            • Transsubtype

              Sub transaction type

              int

            • Transtype

              Transaction type. 121 for payments and 120 for purchases (default)

              int

          • Cashregisternumber

            Cash register number that handled the purchase

            string

          • Deliverycondition

            Delivery condition from purchase processing system. Only stored as information in Aptic ARC.

            string

          • Deliverydate

            Delivery date from purchase processing system. Only stored as information in Aptic ARC.

            DateTime

          • Deliverymethod

            Delivery method from purchase processing system. Only stored as information in Aptic ARC.

            string

          • Deliverynoteid

            Delivery number from purchase processing system. Only stored as information in Aptic ARC.

            string

          • Description

            Description of this transaction in clear text

            string

          • Duedate

            Due date from purchase processing system. Only stored as information in Aptic ARC.

            DateTime

          • Externalinvoicenumber

            External invoicenumber from purchase processing system. Only stored as information in Aptic ARC.

            string

          • Externalpaymentreference

            External payment reference from purchase processing system. Only stored as information in Aptic ARC.

            string

          • Invoicenumber

            Invoicenumber from purchase processing system. Only stored as information in Aptic ARC.

            string

          • Itemcount

            Number of units of the items purchased

            int

          • Itemprincipal

            Price per item incl. vat.

            decimal

          • Message

            Message from purchase processing system. Only stored as information in Aptic ARC.

            string

          • Ourorder

            Our order number from purchase processing system. Only stored as information in Aptic ARC.

            string

          • Ourreference

            Our reference contact from purchase processing system. Only stored as information in Aptic ARC.

            string

          • Paymentcondition

            Payment condition from purchase processing system. Only stored as information in Aptic ARC.

            int

          • Placeofpurchase

            Place of purchase if store isn't used

            string

          • Printcode

            Print code to control printing of invoice.

            string

          • Receiptnumber

            Receipt number of the purchase

            string

          • Receivercity

            Receiver city

            string

          • Receivercountrycode

            Receiver country code - 2 chars ISO 3166-1 alpha-2

            string

          • Receiverfulladdress

            Receiver full address

            string

          • Receiverfullname

            Receiver full name

            string

          • Receiverhouseno

            House number

            string

          • Receiverhousenoextension

            House number extension

            string

          • Receiverstatecode

            Receiver state code

            string

          • Receiverstreet

            Receiver street

            string

          • Receiverzipcode

            Receiver zip code

            string

          • Referencenumber

            Referencenumber for this transaction

            string

          • Rounding

            Rounding amount for this transaction

            decimal

          • Storereferencecode

            The store that handled the purchase. This store must be in Aptic ARC

            string

          • Transdate Mandatory

            Date for this transaction

            DateTime

          • Transspectypecode

            Transaction specification code. To be used for different accounting behaviour

            string

          • Transtype

            Transaction type. 121 for payments and 120 for purchases (default)

            int

          • Unittype

            Units of item in clear text

            string

          • Yourorder

            Your order number from purchase processing system. Only stored as information in Aptic ARC.

            string

          • Yourreference

            Your reference contact from purchase processing system. Only stored as information in Aptic ARC.

            string

        • Yearlyconsumption

          Yearly consumption for utility accounts (formatted and including unit)

          string

        • Yearlyconsumptionamount

          Calculated yearly consumption for utility accounts (in account's currency)

          decimal

      • CreditorReference Mandatory

        Party reference code.

        string

Output

Returns result code 0 if registration or update successfully.
ImpCreditDebtId of restered or updated account LedgerAccountId of restered or updated account JournalId of restered or updated account
Object

RegisterAndUpdateCreditAccountResponse

RegisterAndUpdateCreditAccount response

  • RegisterAndUpdateCreditAccountResult

    Result of RegisterAndUpdateCreditAccount
    Object

    RegisterCreditAccountResult

    General class for representing method output.

    • ImpCreditDebtId

      Import ledger account ID.

      int

    • JournalId

      Journal ID.

      int

    • LedgerAccountId

      Ledger account ID.

      int

    • Result Mandatory

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

      ResultType

      Common result type.

      • ResultCode Mandatory

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

        int

      • ResultText Mandatory

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

        string

SetClosureOnAccount

Closes the loan

Examples

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

SetClosureOnAccountResult result = client.SetClosureOnAccount(null, "30000008782", "1001", "PAIDINFULL", 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/>
     <urn:SetClosureOnAccount>
        <urn:ClosureCode>PAIDINFULL</urn:ClosureCode>
        <urn:CreditorReference>1001</urn:CreditorReference>
        <urn:CustomerAccountReference>30000008782</urn:CustomerAccountReference>
        <urn:Transactions>
           <urn:ClosureTransaction>
              <urn:Amount>100</urn:Amount>
              <urn:TransDate>2019-09-24</urn:TransDate>
              <urn:TransType>Credit</urn:TransType>
           </urn:ClosureTransaction>
        </urn:Transactions>
     </urn:SetClosureOnAccount>
   </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data.
    Object

    SetClosureOnAccount

    SetClosureOnAccount

    • ClosureCode

      Closure code

      string

    • CreditorReference

      Optional. Loan creditor reference number

      string

    • CustomerAccountReference

      Loan reference number

      string

    • CustomerLookup

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

    • Transactions

      Optional. List of transactions to be applied on loan before closure
      Array
      Object

      ClosureTransaction

      Additional closure transaction information

      • Amount Mandatory

        Total amount incl. VAT for this transaction

        decimal

      • AmountSpec

        Detailed specification of the sub transactions
        Array
        Object

        AmountSpecType

        Detailed specification of the sub transaction

        • Amount Mandatory

          The amount (+ for new debt, - for payments)

          decimal

        • AmountType

          Amount type
          Enum

          TransAmountType

          Transaction amount type.

          • Principal

            Principal.

          • Interest

            Interest.

          • VAT

            VAT.

        • CurrencyCode

          Currency code if other than the main transaction

          string

        • DebtType

          Debt type
          Enum

          DebtType

          Debt type.

          • Unknown

            None.

          • Principal

            Principal.

          • ImportedFee

            ImportedFee.

          • Fee

            Fee.

          • Outlay

            Outlay.

          • Credit

            Credit.

          • Reservation

            Reservation.

          • CapitalizedInterest

            CapitalizedInterest.

          • Billed

            Billed.

          • Due

            Due.

          • PenaltyInterestOnPrincipal

            PenaltyInterestOnPrincipal.

          • PenaltyInterestOnInterest

            PenaltyInterestOnInterest.

          • Pretermination

            Pretermination.

          • Termination

            Termination.

        • FeeCode

          The fee code (i.e. REMIND)

          string

        • TransSpecTypeCode

          Transaction specification code. To be used for different accounting behaviour

          string

        • TransSubType

          Sub transaction type
          Enum

          TransactionSubType

          Transaction sub type.

          • Unknown

            Unknown

          • VAT

            VAT Amount

          • Payment_Unplaced

            Unplaced payment

          • Payment_Overpayment

            Overpayment

          • CreditDebt_Incoming

            Incoming Credit balance

          • CreditDebt_Outgoing

            Outgoing Credit Balance

          • TrustAcc_LedgerPayment

            LedgerPayment Accounted

          • TrustAcc_Kickback

            Kickback Accounted

          • TrustAcc_Overpayment

            Overpayment Accounted

          • TrustAcc_LedgerCommission

            LedgerCommission Accounted

          • TrustAcc_LedgerCommissionVat

            LedgerCommissionVat Accounted

          • TrustAcc_Deposit

            Deposit Accounted

          • TrustAcc_CollectionPayment

            CollectionPayment Accounted

          • TrustAcc_CollectionCommission

            CollectionCommission Accounted

          • TrustAcc_CollectionCommissionVat

            CollectionCommissionVat Accounted

          • Rounding

            Rounding

          • CreditDebt_Fee

            Credit Fee

          • CreditDebt_RevolvingCreditInterest

            Revolving Credit Interest

          • CreditDebt_CampaignInterest

            Campaign Interest

          • CreditDebt_MinimumInterest

            Minimum Interest

          • CreditDebt_CreditLimitFee

            Credit Limit Fee

          • CreditDebt_Invoice

            Invoice on Credit

          • CreditDebt_PurchaseReturn

            Purchase Return

          • CreditDebt_PenaltyInterest

            Penalty Interest

          • CreditDebt_LoanInterest

            Loan Interest

          • CreditDebt_PenaltyInterestOnInterest

            Penalty Interest On Interest

          • CreditDebt_DebitInterest

            Debit Interest

          • CreditDebt_CreditInterest

            Credit Interest

          • CollectionInterest

            Collection Interest

          • Ledger_Return

            Return on ledger

          • Ledger_Delete

            Deletion on ledger

          • OriginalInterest_Limitation

            Interest limitation

          • TrustAcc_KickbackVat

            Kickback's VAT Accounted

          • PayableToThirdParty_InvoiceReceived

            3rd party remmittance operation

          • PayableToThirdParty_CreditInvoiceReceived

            3rd party remmittance operation

          • PayableToThirdParty_RepaidByThirdParty

            3rd party remmittance operation

          • PayableToThirdParty_KeptByThirdParty

            3rd party remmittance operation

          • PayableToThirdParty_PaidByDebtor

            3rd party remmittance operation

          • PayableToThirdParty_Credited

            3rd party remmittance operation

          • PayableToThirdParty_Discounted

            3rd party remmittance operation

          • EarlyRepaymentInterestCompensation

            3rd party remmittance operation

          • ReturnedPayment

            Returned disbursement

        • TransType

          Transaction type. 121 for payments and 120 for purchases (default)
          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.

      • CashRegisterNumber

        Cash register number that handled the purchase

        string

      • DeliveryCondition

        Delivery condition from purchase processing system. Only stored as information in Aptic ARC.

        string

      • DeliveryDate

        Delivery date from purchase processing system. Only stored as information in Aptic ARC.

        DateTime

      • DeliveryMethod

        Delivery method from purchase processing system. Only stored as information in Aptic ARC.

        string

      • DeliveryNoteId

        Delivery number from purchase processing system. Only stored as information in Aptic ARC.

        string

      • Description

        Description of this transaction in clear text

        string

      • DueDate

        Due date from purchase processing system. Only stored as information in Aptic ARC.

        DateTime

      • ExternalInvoiceNumber

        External invoicenumber from purchase processing system. Only stored as information in Aptic ARC.

        string

      • ExternalPaymentReference

        External payment reference from purchase processing system. Only stored as information in Aptic ARC.

        string

      • InvoiceNumber

        Invoicenumber from purchase processing system. Only stored as information in Aptic ARC.

        string

      • ItemCount

        Number of units of the items purchased

        int

      • ItemPrincipal

        Price per item incl. vat.

        decimal

      • Message

        Message from purchase processing system. Only stored as information in Aptic ARC.

        string

      • OurOrder

        Our order number from purchase processing system. Only stored as information in Aptic ARC.

        string

      • OurReference

        Our reference contact from purchase processing system. Only stored as information in Aptic ARC.

        string

      • PaymentCondition

        Payment condition from purchase processing system. Only stored as information in Aptic ARC.

        int

      • PlaceOfPurchase

        Place of purchase if store isn't used

        string

      • PrintCode

        Print code to control printing of invoice.

        string

      • ReceiptNumber

        Receipt number of the purchase

        string

      • ReceiverCity

        Receiver city

        string

      • ReceiverCountryCode

        Receiver country code - 2 chars ISO 3166-1 alpha-2

        string

      • ReceiverFullAddress

        Receiver full address

        string

      • ReceiverFullname

        Receiver full name

        string

      • ReceiverHouseNo

        House number

        string

      • ReceiverHouseNoExtension

        House number extension

        string

      • ReceiverStateCode

        Receiver state code

        string

      • ReceiverStreet

        Receiver street

        string

      • ReceiverZipCode

        Receiver zip code

        string

      • ReferenceNumber

        Referencenumber for this transaction

        string

      • Rounding

        Rounding amount for this transaction

        decimal

      • StoreReferenceCode

        The store that handled the purchase. This store must be in Aptic ARC

        string

      • TransDate Mandatory

        Date for this transaction

        DateTime

      • TransspecTypeCode

        Transaction specification code. To be used for different accounting behaviour

        string

      • TransType

        Transaction type. 121 for payments and 120 for purchases (default)
        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.

      • UnitType

        Units of item in clear text

        string

      • YourOrder

        Your order number from purchase processing system. Only stored as information in Aptic ARC.

        string

      • YourReference

        Your reference contact from purchase processing system. Only stored as information in Aptic ARC.

        string

Output

Ok if operation was performed successfully
Error codes:
  • 1 : error message from ARC server
Object

SetClosureOnAccountResponse

SetClosureOnAccount response

  • SetClosureOnAccountResult

    Result of SetClosureOnAccount
    Object

    SetClosureOnAccountResult

    General class for representing method output.

    • Result Mandatory

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

      ResultType

      Common result type.

      • ResultCode Mandatory

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

        int

      • ResultText Mandatory

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

        string