Registration

Service for registering data, e.g. invoices, payments, collection cases, into the journal system.

ActionEvent

Triggers a action event.

Examples

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

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

ApproveJournal

Approves journal for import.

Examples

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

ApproveJournalResult result = client.ApproveJournal(
   journalId: 2511,
   journalType: JournalType.DirectPayments
);
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:ApproveJournal>
            <urn:journalId>2511</urn:journalId>
            <urn:journalType>DirectPayments</urn:journalType>
        </urn:ApproveJournal>
    </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    ApproveJournal

    ApproveJournal

    • journalId

      Journal ID.

      int

    • journalType

      Optional journal type indication (default value is MultipleInvoices).
      Enum

      JournalType

      Journal type.

      • SingleInvoice

        Single invoice.

      • MultipleInvoices

        Multiple invoices.

      • SingleCollectionCase

        Single collection case.

      • MultipleCollectionCases

        Multiple collection cases.

      • DirectPayments

        Direct payments.

Output

Result code 0 if the journal has been approved.
Error codes:
  • 1: error message from ARC server
Object

ApproveJournalResponse

ApproveJournal response

  • ApproveJournalResult

    Result of ApproveJournal
    Object

    ApproveJournalResult

    General class for representing method output.

    • Result

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

      ResultType

      Common result type.

      • ResultCode Mandatory

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

        int

      • ResultText Mandatory

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

        string

CustomAction

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

Examples

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

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

Input

  • request Mandatory

    Request data
    Object

    CustomAction

    CustomAction

    • serviceDefinition

      The invoke service definition request.
      Object

      InvokeServiceDefinitionRequest

      A request for invoking a service definition.

      • AsyncCall

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

        bool

      • Input

        An XML structure used for input into service definition call.

        XmlElement

      • InputXml

        An XML string used for input into service definition call.

        string

      • ServiceDefinitionName Mandatory

        Name of the service definition to invoke.

        string

Output

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

CustomActionResponse

CustomAction response

  • CustomActionResult

    Result of CustomAction
    Object

    CustomActionResult

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

    • CData

      Raw CData from service definition response.

      XmlElement

    • Result

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

      ResultType

      Common result type.

      • ResultCode Mandatory

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

        int

      • ResultText Mandatory

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

        string

DeleteJournal

Deletes journal.

Examples

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

GeneralResult result = client.DeleteJournal(
   journalId: 2511,
   journalType: JournalType.DirectPayments
);
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:DeleteJournal>
            <urn:journalId>2511</urn:journalId>
            <urn:journalType>DirectPayments</urn:journalType>
        </urn:DeleteJournal>
    </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    DeleteJournal

    DeleteJournal

    • journalId

      Journal ID.

      int

    • journalType

      Optional journal type indication (default value is MultipleInvoices).
      Enum

      JournalType

      Journal type.

      • SingleInvoice

        Single invoice.

      • MultipleInvoices

        Multiple invoices.

      • SingleCollectionCase

        Single collection case.

      • MultipleCollectionCases

        Multiple collection cases.

      • DirectPayments

        Direct payments.

Output

Result code 0 if the journal has been deleted.
Error codes:
  • 1: error message from ARC server
Object

DeleteJournalResponse

DeleteJournal response

  • DeleteJournalResult

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

GetJournalInfo

Returns journal details.

Examples

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

GetJournalInfoResult result = client.GetJournalInfo(
   journalId: 2511,
   journalType: JournalType.DirectPayments
);
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:GetJournalInfo>
            <urn:journalId>2511</urn:journalId>
            <urn:journalType>DirectPayments</urn:journalType>
        </urn:GetJournalInfo>
    </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    GetJournalInfo

    GetJournalInfo

    • journalId

      Journal ID.

      int

    • journalType

      Optional journal type indication (default value is MultipleInvoices).
      Enum

      JournalType

      Journal type.

      • SingleInvoice

        Single invoice.

      • MultipleInvoices

        Multiple invoices.

      • SingleCollectionCase

        Single collection case.

      • MultipleCollectionCases

        Multiple collection cases.

      • DirectPayments

        Direct payments.

Output

Invoices / collection cases information for the journal
Error codes:
  • 1: error message from ARC server
Object

GetJournalInfoResponse

GetJournalInfo response

  • GetJournalInfoResult

    Result of GetJournalInfo
    Object

    GetJournalInfoResult

    General class for representing method output.

    • CollectionCases

      List of journal's collection cases.
      Array
      Object

      GetJournalInfoResult.CollectionCase

      Holds journal's collection case details.

      • CaseNumber

        Collection case number.

        string

      • CollectionAccountId

        Collection account ID.

        int

      • ImpCollectionAccountId

        Import collection account ID.

        int

    • Invoices

      List of journal's invoices.
      Array
      Object

      GetJournalInfoResult.Invoice

      Holds journal's invoice details.

      • ImpLedgerAccountId

        Import ledger account ID.

        int

      • InvoiceNumber

        Debt reference (invoice number).

        string

      • LedgerAccountId

        Ledger account ID.

        int

    • Payments

      List of direct payments.
      Array
      Object

      GetJournalInfoResult.Payment

      Holds direct payment details.

      • ImpPaymentId

        Import payment ID.

        int

      • PaymentId

        Payment ID.

        int

    • Result

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

      ResultType

      Common result type.

      • ResultCode Mandatory

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

        int

      • ResultText Mandatory

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

        string

GetJournalList

Returns list of the specified type journals' identifiers.

Examples

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

GetJournalListResult result = client.GetJournalList(
   JournalType: JournalType.DirectPayments
);
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:GetJournalList>
            <urn:journalType>DirectPayments</urn:journalType>
        </urn:GetJournalList>
    </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    GetJournalList

    GetJournalList

    • journalType

      Optional journal type indication (default value is MultipleInvoices).
      Enum

      JournalType

      Journal type.

      • SingleInvoice

        Single invoice.

      • MultipleInvoices

        Multiple invoices.

      • SingleCollectionCase

        Single collection case.

      • MultipleCollectionCases

        Multiple collection cases.

      • DirectPayments

        Direct payments.

Output

List of the specified type journals' identifiers.
Error codes:
  • 1: error message from ARC server
Object

GetJournalListResponse

GetJournalList response

  • GetJournalListResult

    Result of GetJournalList
    Object

    GetJournalListResult

    General class for representing method output.

    • Journals

      List of journals' identifiers.
      Array
      Object

      GetJournalListResult.Journal

      Holds journal details

      • JournalId

        Journal ID

        int

    • Result

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

      ResultType

      Common result type.

      • ResultCode Mandatory

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

        int

      • ResultText Mandatory

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

        string

ImportJournal

Imports registered journal.
If polling is needed instead of waiting till import is done - provide true for wait parameter, it means import is being run directly, not via asynchronous job

Examples

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

ImportJournalResult result = client.ImportJournal(
   journalId: 2512,
   wait: true,
   journalType: JournalType.DirectPayments
);
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:ImportJournal>
            <urn:journalId>2512</urn:journalId>
            <urn:journalType>DirectPayments</urn:journalType>
            <urn:wait>true</urn:wait>
        </urn:ImportJournal>
    </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    ImportJournal

    ImportJournal

    • journalId

      Journal ID.

      int

    • journalType

      Optional journal type indication (default value is MultipleInvoices).
      Enum

      JournalType

      Journal type.

      • SingleInvoice

        Single invoice.

      • MultipleInvoices

        Multiple invoices.

      • SingleCollectionCase

        Single collection case.

      • MultipleCollectionCases

        Multiple collection cases.

      • DirectPayments

        Direct payments.

    • wait

      Should method wait till import is done

      bool

Output

Imported invoices / collection cases / payments information in case of successful import (result code 0) and server / job information in case of asynchronous import call.
Error codes:
  • 1: error message from ARC server
Object

ImportJournalResponse

ImportJournal response

  • ImportJournalResult

    Result of ImportJournal
    Object

    ImportJournalResult

    General class for representing method output.

    • CollectionCases

      List of imported collection cases.
      Array
      Object

      ImportJournalResult.CollectionCase

      Holds imported collection case details.

      • CaseNumber

        Collection case number.

        string

      • CollectionAccountId

        Collection account ID.

        int

      • ImpCollectionAccountId

        Import collection account ID.

        int

    • Invoices

      List of imported invoices.
      Array
      Object

      ImportJournalResult.Invoice

      Holds imported invoice details.

      • ImpLedgerAccountId

        Import ledger account ID.

        int

      • InvoiceNumber

        Debt reference (invoice number).

        string

      • LedgerAccountId

        Ledger account ID.

        int

    • JobId

      Job identification.

      int

    • Payments

      List of imported payments.
      Array
      Object

      ImportJournalResult.Payment

      Holds imported payment details.

      • ImpPaymentId

        Import payment ID.

        int

      • PaymentId

        Payment ID.

        int

    • Result

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

      ResultType

      Common result type.

      • ResultCode Mandatory

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

        int

      • ResultText Mandatory

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

        string

    • Running

      Is import job running (if it's a direct import call - always false).

      bool

    • ServerId

      Job server identification.

      long

NewJournal

Creates collection case(s) / invoice(s) / direct payment(s) journal.

Examples

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

NewJournalResult result = client.NewJournal(
    new NewJournalRequest {
        CreditorReference = "1000",
        Currency = "SEK",
        JournalType = JournalType.SingleInvoice
    }
);
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:NewJournal>
            <urn:journal>
                <urn:CreditorReference>1000</urn:CreditorReference>
                <urn:Currency>SEK</urn:Currency>
                <urn:JournalType>SingleInvoice</urn:JournalType>
            </urn:journal>
        </urn:NewJournal>
    </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    NewJournal

    NewJournal

    • journal

      Journal identification parameters.
      Object

      NewJournalRequest

      General class for representing method input.

      • CreditorReference

        Party reference code.

        string

      • Currency

        Currency code.

        string

      • Description

        Journal description.

        string

      • JournalType

        Journal type.
        Enum

        JournalType

        Journal type.

        • SingleInvoice

          Single invoice.

        • MultipleInvoices

          Multiple invoices.

        • SingleCollectionCase

          Single collection case.

        • MultipleCollectionCases

          Multiple collection cases.

        • DirectPayments

          Direct payments.

Output

Journal id of created journal.
Error codes:
  • 1: error message from ARC server
Object

NewJournalResponse

NewJournal response

  • NewJournalResult

    Result of NewJournal
    Object

    NewJournalResult

    General class for representing method output.

    • JournalId

      Journal ID.

      int

    • Result

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

      ResultType

      Common result type.

      • ResultCode Mandatory

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

        int

      • ResultText Mandatory

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

        string

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

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

RegisterCollectionCase

Registers new collection case in journal.
Supply journal id to register collection case in existing journal, otherwise new journal will be created

Examples

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

RegisterCollectionCaseResult result = client.RegisterCollectionCase(
    new RegisterCollectionCaseRequest {
        CreditorReference = "1000"
    }
);
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:RegisterCollectionCase>
            <urn:collectionCase>
                <urn:CreditorReference>1000</urn:CreditorReference>
                <urn:Debtors />
                <urn:Debts />
            </urn:collectionCase>
        </urn:RegisterCollectionCase>
    </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    RegisterCollectionCase

    RegisterCollectionCase

    • collectionCase

      Collection case identification parameters.
      Object

      RegisterCollectionCaseRequest

      General class for representing method input.

      • ActionDates

        List of action dates for the collection case.
        Array
        Object

        ActionDate

        Holds action date details.

        • ActionGroupCode Mandatory

          Action group (predefined category for history actions, probably should be changed to ActionGroup type).

          string

        • Date Mandatory

          Action date.

          DateTime

      • Claimant

        Holds claimant details.
        Object

        Claimant

        Holds collection claimant details.

        • City Mandatory

          Claimant's city.

          string

        • Country

          Claimant's country.

          string

        • CountryCode

          Claimant's country code.

          string

        • CurrencyCode

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

          string

        • Email

          Claimant's e-mail.

          string

        • FullName Mandatory

          Claimant's full name.

          string

        • HouseNo

          Claimant's house number.

          string

        • HouseNoExtension

          Claimant's house number extension.

          string

        • IdNumber

          Claimant's ID number.

          string

        • InternalPhone

          Claimant's internal phone number.

          string

        • LanguageCode

          Claimant's language code.

          string

        • ReferenceCode Mandatory

          Claimant's reference code.

          string

        • StateCode

          Claimant's state code.

          string

        • Street Mandatory

          Claimant's street.

          string

        • Telefax

          Claimant's telefax number.

          string

        • WorkPhone

          Claimant's work phone number.

          string

        • ZipCode Mandatory

          Claimant's zipcode.

          string

      • ClaimantName

        Claimant name.

        string

      • ClaimType

        Claim type code (one of predefined types, currently only TRUSTACCNT).

        string

      • CollectionAccountType

        Collection account type.
        Enum

        CollectionAccountTypes

        Collection account type.

        • CollectionCase

          Collection case.

        • JournalCase

          Journal case.

      • Collector

        Collector identifier.

        string

      • Contracts

        List of contracts for the collection case.
        Array
        Object

        Contract

        Holds collection contract details.

        • ContractDescription

          Contract description.

          string

        • ContractLength

          Contract duration (probably, not confirmed).

          int

        • ContractNumber Mandatory

          Contract number.

          string

        • ContractTerminationtype

          Contract termination reason (no lookup table found for it).

          int

        • Documents

          List of contract documents.
          Array
          Object

          Document

          Holds history action document information.

          • DocumentType

            Document code (one of predefined types idoc / invoice / gjeldsbrev / verdict / domforlik).

            string

          • ExternalLink

            Link to the document, if it has to be copied from external source.

            string

          • FileDataBase64

            Base64-encoded file body.

            string

          • Important

            Document importancy flag.

            bool

          • LoggedAt

            Document creation date.

            DateTime

          • Note Mandatory

            Free extra information related to the document.

            string

          • OriginalFileName

            The file name to be generated instead of an auto-generated one.

            string

        • EndDate

          Contract expiration date.

          DateTime

        • ExtraFields

          List of contract extra fields.
          Array
          Object

          ExtraField

          Extra field contains custom data.

          • Data

            Value of extra field.

            string

          • Name

            Name of extra field.

            string

        • Note

          Contract note (difference with contract description is not known).

          string

        • ObjectValue

          Contract object value.

          decimal

        • StartDate

          Contract commencement date.

          DateTime

        • TerminationDate

          Contract termination date.

          DateTime

      • CreditorReference

        Party reference code.

        string

      • CreditRegistryStatus

        Credit registry status
        Enum

        CreditRegistryStatus

        CreditRegistryStatus

        • DoNotRegister

          DoNotRegister

        • Register

          Register

        • Registered

          Registered

        • Terminated

          Terminated

        • Recalled

          Recalled

      • CreditRegistrySubmissionDate

        Credit registry submission date

        DateTime

      • CurrencyCode

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

        string

      • DataProvisions

        List of data provisions for the collection case.
        Array
        Object

        DataProvision

        Holds data provision details.

        • Code Mandatory

          Data provision code.

          string

        • Text

          Data provision text.

          string

        • Version

          Data provision version.

          string

      • Debtors Mandatory

        List of debtors for the collection case.
        Array
        Object

        Debtor

        Holds debtor information.

        • Address

          List of debtor's addresses.
          Array
          Object

          DebtorAddress

          Holds debtor's address information.

          • AddressNotValid

            Date of address invalidation.

            DateTime

          • AddressNotValidOverride

            Should address be validated.

            bool

          • AddressType Mandatory

            Address type (one of predefined codes LEGAL / AVI / INVOICE / SITE / DELIVERY / TRUSTACCNT).

            string

          • CareOf

            C/o address.

            string

          • City

            City.

            string

          • Country

            Country.

            string

          • CountryCode

            Country code.

            string

          • DefaultAddress

            Is default address.

            bool

          • FullAddress

            Full address.

            string

          • FullName

            Full name.

            string

          • HouseNo

            House number.

            string

          • HouseNoextension

            House number extension.

            string

          • StateCode

            State code.

            string

          • Street

            Street.

            string

          • UpdateExisting

            Should update debtor's existing address

            bool

          • ValidFrom

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

            DateTime

          • ValidTo

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

            DateTime

          • ZipCode

            Zipcode.

            string

        • AlternativeEmail

          Debtor's alternative e-mail.

          string

        • AutoTransferBankaccount

          Ledger autotransfer bank account number.

          string

        • AutoTransferReferenceNo

          Ledger autotransfer reference number.

          string

        • BankAccounts

          List of debtor's bank accounts.
          Array
          Object

          BankAccount

          Holds bank account information.

          • AllowDisbursementsFrom

            Is disbursement allowed from this account.

            bool

          • AllowDisbursementsTo

            Is disbursement allowed to this account.

            bool

          • AllowPayments

            Account payment allowance type.
            Enum

            BankAccountAllowPayments

            How bank account will allow payments.

            • No

              Not at all.

            • AllowPayments

              Allow payments.

            • AllowNettings

              Allow nettings.

          • BankAccountClass

            Account class number, corresponding to one of predefined types (Unknown / Plusgiro / Bankgiro / Bank account(Netherlands) / Foreign bank account / Bankgiro(Denmark) / Bankgiro(Norway) / Bankaccount(Norway) / Bankaccount(Sweden) / Bank account(Finland)).

            int

          • BankAccountNo Mandatory

            Account number.

            string

          • BankAccountOwnerType Mandatory

            Account owner type.
            Enum

            BankAccountOwnerType

            Type of owner for bank account.

            • Solicitor

              Solicitor.

            • Creditor

              Creditor.

            • Debtor

              Debtor.

          • BankCode

            Account code (probably one of predefined values).

            string

          • BankDescription

            Bank description.

            string

          • BusinessAccount

            Is a business account.

            bool

          • CountryCode Mandatory

            Account country code.

            string

          • CurrencyCode Mandatory

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

            string

          • DefaultAccount

            Is a default account.

            bool

          • Description Mandatory

            Account description.

            string

        • Bankruptcy

          Bankruptcy details.
          Object

          Bankruptcy

          Holds bankruptcy details.

          • ApplicationDate

            Application date.

            DateTime

          • BankruptcyDate

            Bankruptcy date.

            DateTime

          • ConclusiveDate

            Conclusion date.

            DateTime

          • EnclosureBankruptcyNotice

            Enclosure bankruptcy notice.

            bool

          • Enclosures

            Enclosures.

            string

          • Info

            Any relevant info.

            string

          • JournalNo

            Journal number.

            string

          • LiquidationDate

            Liquidation date.

            DateTime

          • PartyReferenceCode

            Party reference code.

            string

          • PublishDate

            Publish date.

            DateTime

          • RegDate Mandatory

            Registration date.

            DateTime

          • TotalDebts

            Total debts amount.

            decimal

          • WrittenOffDate

            Written-off date.

            DateTime

        • CareOf

          Debtor's c/o address.

          string

        • CellularPhone

          Debtor's cellular phone number.

          string

        • City

          Debtor's city.

          string

        • CompanyType

          Debtor's company type (one of predefined types SLK / AB / EKF / SIF / HB / LTD / PLC / YE / KY / AY / OY / OSK / RY / EENMANSZAAK / BV / NV / MAATSCHAP / VOF / CV / VERENIGING_VOLL / VERENIGING_BEPK / COORPORATIE / STICHTING / KERKGENOOTSCHAP / VVE / OVERHEID / BUITVENN which depends on country code as well).

          string

        • Country

          Debtor's country.

          string

        • CountryCode

          Debtor's country code.

          string

        • CreditorDebtorRef

          Debtor reference.

          string

        • CultureCode

          Debtor's time and currency format.

          string

        • CurrencyCode

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

          string

        • DataProvisions

          List of debtor's data provisions.
          Array
          Object

          DataProvision

          Holds data provision details.

          • Code Mandatory

            Data provision code.

            string

          • Text

            Data provision text.

            string

          • Version

            Data provision version.

            string

        • DateOfBirth

          Debtor's date of birth.

          DateTime

        • DebtorRole

          Debtor role.
          Enum

          DebtorRole

          Debtor role.

          • Debtor

            Debtor.

          • Guarantor

            Guarantor.

          • Coapplicant

            Co-applicant.

          • Estatebeneficiary

            Estate beneficiary.

          • Tradingcompanypartner

            Trading company partner.

          • Generalpartner

            General partner.

          • Custodian

            Custodian.

          • LimitedPartner

            Limited partner.

          • Repurchaser

            Repurchaser.

          • BankGuarantor

            Bank guarantor.

          • OtherPledger

            Other pledger.

          • BoardMember

            Board member.

          • GuarantorAndOtherPledger

            Guarantor and other pledger.

          • GuarantorAndCompanyPartner

            Guarantor and company partner.

          • SoleProprietorUsingATradeName

            Sole proprietor using a trade name.

          • SolventPerson

            Solvent person.

        • Deceased

          Details about the deceased.
          Object

          Deceased

          Holds details about the deceased.

          • AmountPercent

            Estate inventory percent.

            decimal

          • ApplicationDate

            Application date.

            DateTime

          • DeathDate

            Death date.

            DateTime

          • EstateInvAmount

            Estate inventory amount.

            decimal

          • EstateInvDate

            Estate inventory date.

            DateTime

          • EstateType

            Property estate type.
            Enum

            DeceasedEstateType

            Deceased estate type.

            • Public

              Public.

            • Private

              Private.

          • InterestStop

            Is interest calculation stopped.

            bool

          • JournalNo

            Journal number.

            string

          • Note

            Any relevant short note.

            string

          • PartyReferenceCode

            Party reference code.

            string

          • PriorityDebts

            Priority debts amount.

            decimal

          • RegDate Mandatory

            Registration date.

            DateTime

          • TotalAssets

            Total assets amount.

            decimal

          • TotalDebt

            Total debt amount.

            decimal

          • TotalDebts

            Total debts amount.

            decimal

        • Domicile

          Debtor's domicile.

          string

        • Email

          Debtor's e-mail.

          string

        • ExtraFields

          List of debtor's extra fields.
          Array
          Object

          ExtraField

          Extra field contains custom data.

          • Data

            Value of extra field.

            string

          • Name

            Name of extra field.

            string

        • Firstname

          Debtor's first name.

          string

        • Gender

          Debtor's gender.
          Enum

          GenderType

          Gender of a person.

          • Female

            Female gender, a woman.

          • Male

            Male gender, a man.

          • Unknown

            Unknown gender, or neither Female nor Male.

        • HomePhone

          Debtor's domestic phone number.

          string

        • HouseNo

          Debtor's house number.

          string

        • HouseNoExtension

          Debtor's house number extension.

          string

        • IdNumber

          Debtor ID number.

          string

        • Infix

          Debtor's infix.

          string

        • Initials

          Debtor's initials.

          string

        • JuridicalType

          Debtor person juridical type.
          Enum

          JuridicalType

          Type of person, juridically.

          • NaturalPerson

            Actual person.

          • JuridicalPerson

            Juridical person, e.g a company.

        • LanguageCode

          Debtor's language code.

          string

        • Lastname

          Debtor's last name.

          string

        • Middlename

          Debtor's middle name.

          string

        • MunicipalCode

          Debtor's municipal code.

          string

        • NaceCode

          Debtor's NACE code.

          string

        • NameSuffix

          Debtor's name suffix.

          string

        • PeriodOfLimitation

          Period of limitation.

          int

        • PlaceOfbirth

          Debtor's place of birth.

          string

        • Protected

          Is debtor account information is protected.

          bool

        • StateCode

          Debtor's state code.

          string

        • Street

          Debtor's street.

          string

        • Telefax

          Debtor's telefax number.

          string

        • Title

          Debtor's salutation.

          string

        • UnderAged

          Is the debtor underaged.

          bool

        • ValidFrom

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

          DateTime

        • ValidTo

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

          DateTime

        • WorkPhone

          Debtor's work phone number.

          string

        • ZipCode

          Debtor's zipcode.

          string

      • Debts Mandatory

        List of collection debts.
        Array
        Object

        CollectionDebt

        Holds collection debt information.

        • AccountReference

          Debt account reference.

          string

        • AccountReferenceType

          Debt account reference type.

          string

        • BillDate Mandatory

          Bill date.

          DateTime

        • CurrencyCode

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

          string

        • DebtGroup

          Debt group code (probably one of predefined values).

          string

        • DebtPrincipalType

          Debt Principal Type
          Enum

          CollectionDebtPrincipalType

          Debt principal type.

          • INVOICE

            INVOICE

          • CREDIT_INVOICE

            CREDIT_INVOICE

          • INTEREST_INVOICE

            INTEREST_INVOICE

          • FINAL_INVOICE_CREDITDEBT

            FINAL_INVOICE_CREDITDEBT

          • OFFER_INVOICE

            OFFER_INVOICE

          • BILLING

            BILLING

          • CAPITALIZED_INTEREST

            CAPITALIZED_INTEREST

          • INTEREST_COMPENSATION

            INTEREST_COMPENSATION

          • TERMINATED_ACCOUNT

            TERMINATED_ACCOUNT

          • PREREDEMPTION

            PREREDEMPTION

          • LOAN_INTEREST

            LOAN_INTEREST

          • CREDIT_EXPENSE

            CREDIT_EXPENSE

        • Description

          Collection debt description.

          string

        • DueDate

          Due date.

          DateTime

        • ExchangeDate

          Exchange date.

          DateTime

        • ExchangeRate

          Exchange rate.

          decimal

        • ExtraFields

          List of debt extra fields.
          Array
          Object

          ExtraField

          Extra field contains custom data.

          • Data

            Value of extra field.

            string

          • Name

            Name of extra field.

            string

        • FixedInterestTermStart

          Fixed interest term date.

          DateTime

        • GoodsRelatedCredit

          Goods related credit

          bool

        • GrantedCreditAmount

          Granted credit amount

          decimal

        • IgnoreOfficialReferenceInterestChange

          Should stop automatic interest change.

          bool

        • InterestCondition

          Interest payment period in days.

          int

        • Interests

          List of debt interests.
          Array
          Object

          Interest

          Holds interest information.

          • DebtGroupInterestCode

            Debt group interest code (probably one of predefined values).

            string

          • FixedInterestTermStart

            Debt fixed interest term date.

            DateTime

          • InterestCode

            Interest code (one of predefined values depending on country).

            string

          • InterestFrom

            Interest calculation start date.

            DateTime

          • InterestRate

            Interest rate.

            decimal

          • InterestStop

            Interest calculation stop date.

            DateTime

          • InterestTo

            Interest calculation end date.

            DateTime

          • OriginalInterest

            Original interest.

            decimal

          • PaidInterest

            Paid interest.

            decimal

          • RemainingInterest

            Remaining interest.

            decimal

        • LedgerReference

          Debt ledger reference.

          string

        • LenderName

          Debt Principal Type

          string

        • LimitationDate

          Limitation date.

          DateTime

        • LoanPurpose

          Loan purpose
          Enum

          LoanPurpose

          LoanPurpose

          • HomeLoan

            HomeLoan

          • HomeLoanForFirstHome

            HomeLoanForFirstHome

          • HomeLoanForLeisureHouse

            HomeLoanForLeisureHouse

          • HomeLoanForInvestmentPurposes

            HomeLoanForInvestmentPurposes

          • StudentLoan

            StudentLoan

          • LoanForPurchaseOfVehicleOrCraft

            LoanForPurchaseOfVehicleOrCraft

          • OtherConsumerCredit

            OtherConsumerCredit

          • OtherLoan

            OtherLoan

          • LoanForBusinessActivities

            LoanForBusinessActivities

          • GuaranteeReceivable

            GuaranteeReceivable

        • LoanTypeCode

          Loan type code
          Enum

          LoanTypeCode

          LoanTypeCode

          • LumpSumLoan

            LumpSumLoan

          • RunningAccountLoan

            RunningAccountLoan

          • Leasing

            Leasing

          • GuaranteeReceivable

            GuaranteeReceivable

        • Objects

          List of objects.
          Array
          Object

          DebtObject

          DebtObject

          • Address

            Address.
            Object

            DebtObjectAddress

            DebtObjectAddress

            • AccountSpecific

              Account specific.

              bool

            • AddressNotValid

              Set address as not valid.

              DateTime

            • CareOf

              Care of address.

              string

            • City Mandatory

              City.

              string

            • Country

              Country

              string

            • CountryCode Mandatory

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

              string

            • DefaultAddress

              Whether this is the default address.

              bool

            • FullName Mandatory

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

              string

            • HouseNo

              House number.

              string

            • HouseNoExtension

              House number extension.

              string

            • StateCode

              State code if applicable.

              string

            • Street Mandatory

              Street address.

              string

            • TypeCode Mandatory

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

              string

            • UpdateExisting

              Whether this should update existing or create new address.

              bool

            • ZipCode Mandatory

              Zip code, i.e. postal code.

              string

          • Code Mandatory

            Code

            string

          • CreateCreditorLink

            Create Creditor link.

            bool

          • Details

            Object details.
            Object

            DebtObjectDetails

            DebtObjectDetails

            • CurrencyCode

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

              string

            • CurrentValue

              Current value.

              decimal

            • Description Mandatory

              Description

              string

            • Location

              Location (geography)

              string

            • Mileage

              Mileage

              int

            • OriginalValue

              Original value.

              decimal

            • OwnerPartyRef

              Owner party reference.

              string

            • RegistrationNumber

              Registration number.

              string

            • ResidualValue

              Residual value.

              decimal

            • ValidUntil

              Valid until.

              DateTime

            • VendorPartyRef

              Vendor party reference.

              string

            • YearOfManufacture

              The year of manufacture (example 2019)

              int

          • Fields

            Object fields.
            Array
            Object

            Field

            Extra field contains custom data.

            • Name Mandatory

              Name of field.

              string

            • Value Mandatory

              Value of field.

              string

          • ReferenceNumber Mandatory

            Reference number.

            string

          • RegistrationDate

            Registration date.

            DateTime

        • OneTimeServiceFees

          One time service fees.

          decimal

        • OriginalPrincipal

          Original principal.

          decimal

        • OurReference

          Our reference.

          string

        • PaymentCondition

          Debt payment period in days.

          int

        • Periodoflimitation

          Period of limitation.

          int

        • PeriodOfLimitationInterest

          Period of limitation interest.

          int

        • ReferenceNumber

          Collection debt reference number.

          string

        • RemainingPrincipal Mandatory

          Remaining principal.

          decimal

        • UniqueId

          Collection debt unique identifier.

          string

        • UsedCreditAmount

          Used credit amount

          decimal

        • YourReference

          Your reference.

          string

      • DeliverySystemCode

        Delivery system code.

        string

      • Description

        Description for imported collection case.

        string

      • Documents

        List of documents for the collection case.
        Array
        Object

        Document

        Holds history action document information.

        • DocumentType

          Document code (one of predefined types idoc / invoice / gjeldsbrev / verdict / domforlik).

          string

        • ExternalLink

          Link to the document, if it has to be copied from external source.

          string

        • FileDataBase64

          Base64-encoded file body.

          string

        • Important

          Document importancy flag.

          bool

        • LoggedAt

          Document creation date.

          DateTime

        • Note Mandatory

          Free extra information related to the document.

          string

        • OriginalFileName

          The file name to be generated instead of an auto-generated one.

          string

      • EnergyDebt

        Holds energy debt details.
        Object

        EnergyDebt

        Holds collection rental object information.

        • Disconnect Mandatory

          Should the facility be disconnected.

          bool

        • Disconnected

          Is the facility disconnected.

          bool

        • DisconnectionWeek

          Facility disconnection week.

          int

        • DisconnectionYear

          Facility disconnection year.

          int

        • FacilityCity

          Facility city.

          string

        • FacilityHouseNo

          Facility house number.

          string

        • FacilityHouseNoExtension

          Facility house number extension.

          string

        • FacilityStreet

          Facility street.

          string

        • FacilityZipCode

          Facility zipcode.

          string

        • HasMoved Mandatory

          Is the facility moved.

          bool

        • InstallationId Mandatory

          Facility installation identifier.

          string

        • NetOwnerReference

          Net owner identifier.

          string

        • ServedAt

          Facility last service date.

          DateTime

      • ExtraFields

        List of extra fields for the collection case.
        Array
        Object

        ExtraField

        Extra field contains custom data.

        • Data

          Value of extra field.

          string

        • Name

          Name of extra field.

          string

      • FeeBasePrincipalAmount

        Fee base principal amount.

        decimal

      • Fees

        List of collection fees.
        Array
        Object

        CollectionFee

        Holds collection fee information.

        • CurrencyCode

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

          string

        • Description

          Collection fee description.

          string

        • FeeDate Mandatory

          Collection fee date.

          DateTime

        • InterestAmount

          Collection fee interest.

          decimal

        • InterestCode

          Collection fee interest code (one of predefined interest calculation types).

          string

        • InterestFrom

          Fee interest calculation start date.

          DateTime

        • InterestRate

          Collection fee interest rate.

          decimal

        • InterestTo

          Fee interest calculation end date.

          DateTime

        • Name Mandatory

          Collection fee code (probably one of predefined values).

          string

        • OriginalDebtReferenceCode

          Reference to debt

          string

        • PrincipalAmount Mandatory

          Collection fee principal.

          decimal

        • UniqueId

          Collection fee unique identifier.

          string

        • VatAmount

          Collection fee VAT.

          decimal

      • JournalId

        Journal ID.

        int

      • LegalClaimType

        Legal claim type (one of predefined numeric codes).

        string

      • Notes

        List of collection notes.
        Array
        Object

        CollectionNote

        Detailed information about collection note.

        • HistNoteTypeId

          History note type number corresponding to one of predefined history note types.

          int

        • HistOwnerTypeId

          History owner type number corresponding to one of predefined history owner types Collector / System note / Creditor note / Debtor note / Customernote).

          int

        • Important

          Is the note important.

          bool

        • LoggedAt

          Collection note logging date.

          DateTime

        • NoteText Mandatory

          Collection note text.

          string

        • SystemCode

          Free-form system or process identifier, which created the note (probably, not confirmed).

          string

        • UserCode

          Free-form user identifier, who created the note - not only user code (probably, not confirmed).

          string

      • PaymentReference

        Payment reference.

        string

      • Pledges

        List of collection pledges.
        Array
        Object

        Pledge

        Holds collection pledge information.

        • Debtors

          List of debtor identification details for pledge.
          Array
          Object

          DebtorLink

          Holds debtor identification details.

          • CreditorDebtorRef

            Debtor reference.

            string

          • IdNumber

            Debtor ID number.

            string

        • Description

          Pledge description.

          string

        • ExtraFields

          List of pledge extra fields.
          Array
          Object

          ExtraField

          Extra field contains custom data.

          • Data

            Value of extra field.

            string

          • Name

            Name of extra field.

            string

        • FullGuarantee

          Full guarantee's debtor identification details.
          Object

          FullGuarantee

          Holds full guarantee's debtor identification details.

          • GeneralForDebtor

            General guarantee's debtor identification.
            Object

            DebtorLink

            Holds debtor identification details.

            • CreditorDebtorRef

              Debtor reference.

              string

            • IdNumber

              Debtor ID number.

              string

        • Guarantee

          Detailed guarantee information.
          Object

          Guarantee

          Holds detailed guarantee information.

          • CurrencyCode Mandatory

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

            string

          • GeneralForDebtor

            General guarantee's debtor identification.
            Object

            DebtorLink

            Holds debtor identification details.

            • CreditorDebtorRef

              Debtor reference.

              string

            • IdNumber

              Debtor ID number.

              string

          • Guarantors

            List of interests for guarantee.
            Array
            Object

            Guarantor

            Holds guarantee details.

            • Active

              Is the guarantor active.

              bool

            • DebtorLink

              Debtor identification.
              Object

              DebtorLink

              Holds debtor identification details.

              • CreditorDebtorRef

                Debtor reference.

                string

              • IdNumber

                Debtor ID number.

                string

            • Interests

              List of guarantor's interests.
              Array
              Object

              Interest

              Holds interest information.

              • DebtGroupInterestCode

                Debt group interest code (probably one of predefined values).

                string

              • FixedInterestTermStart

                Debt fixed interest term date.

                DateTime

              • InterestCode

                Interest code (one of predefined values depending on country).

                string

              • InterestFrom

                Interest calculation start date.

                DateTime

              • InterestRate

                Interest rate.

                decimal

              • InterestStop

                Interest calculation stop date.

                DateTime

              • InterestTo

                Interest calculation end date.

                DateTime

              • OriginalInterest

                Original interest.

                decimal

              • PaidInterest

                Paid interest.

                decimal

              • RemainingInterest

                Remaining interest.

                decimal

            • PaidPrincipal

              Principal amount paid.

              decimal

            • PrincipalAmount

              Principal amount guaranteed.

              decimal

            • RemainingPrincipal

              Principal amount remained.

              decimal

          • InterestAmount

            Interest guaranteed.

            decimal

          • Interests

            List of interests for guarantee.
            Array
            Object

            Interest

            Holds interest information.

            • DebtGroupInterestCode

              Debt group interest code (probably one of predefined values).

              string

            • FixedInterestTermStart

              Debt fixed interest term date.

              DateTime

            • InterestCode

              Interest code (one of predefined values depending on country).

              string

            • InterestFrom

              Interest calculation start date.

              DateTime

            • InterestRate

              Interest rate.

              decimal

            • InterestStop

              Interest calculation stop date.

              DateTime

            • InterestTo

              Interest calculation end date.

              DateTime

            • OriginalInterest

              Original interest.

              decimal

            • PaidInterest

              Paid interest.

              decimal

            • RemainingInterest

              Remaining interest.

              decimal

          • PrincipalAmount

            Principal amount.

            decimal

          • RemainingAmount

            Remaining amount.

            decimal

          • ValidUntil

            Valid until date.

            DateTime

        • MergePledge

          Should the same pledge object be merged across guarantees.

          bool

        • MortgageCompanies

          Chattel mortgage details.
          Object

          MortgageCompanies

          Holds chattel mortgage details.

          • AmountFrom

            Low limit of estimated amount.

            decimal

          • AmountTo

            Upper limit of estimated amount.

            decimal

          • CollateralCode

            Collateral code (one of predefined values, not confirmed).

            string

          • CompanyName

            Company name.

            string

          • MortgageLienPriorities

            List of mortgage lien priorities.
            Array
            Object

            MortgageLienPriority

            Holds mortgage lien priority details.

            • Date

              Date.

              DateTime

            • LienPriorityAmount Mandatory

              Lien priority amount, within.

              decimal

            • Note

              Note.

              string

            • Owner

              Bank / owner identifier.

              string

            • PledgeAmount

              Pledge amount.

              decimal

            • PriorityOrder

              Priority order.

              int

            • ReferenceNumber

              Reference number.

              string

        • MovableProperty

          Movable property details.
          Object

          MovableProperty

          Holds movable property details.

          • CollateralCode

            Collateral code (one of predefined values, not confirmed).

            string

          • MortgageLienPriorities

            List of mortgage lien priorities.
            Array
            Object

            MortgageLienPriority

            Holds mortgage lien priority details.

            • Date

              Date.

              DateTime

            • LienPriorityAmount Mandatory

              Lien priority amount, within.

              decimal

            • Note

              Note.

              string

            • Owner

              Bank / owner identifier.

              string

            • PledgeAmount

              Pledge amount.

              decimal

            • PriorityOrder

              Priority order.

              int

            • ReferenceNumber

              Reference number.

              string

          • ValueAmount

            Property value amount.

            decimal

          • ValuedAt

            Property valuation date.

            DateTime

          • ValuedBy

            Property valued by.

            string

        • Note

          Pledge note.

          string

        • PledgeAmount

          Pledge amount.

          decimal

        • PledgeDate Mandatory

          Pledge date.

          DateTime

        • RealProperty

          Real property details.
          Object

          RealProperty

          Holds real property details.

          • CollateralCode

            Collateral code (one of predefined values, not confirmed).

            string

          • CollateralEstateType Mandatory

            Type of estate.
            Enum

            CollateralEstateType

            Collateral estate type.

            • RealEstate

              Real estate.

            • Condominium

              Condominium.

            • IndustrialPremises

              Industrial premises.

            • Land

              Land.

            • Other

              Other.

            • RecreationalProperty

              Recreational property.

          • Estate Mandatory

            Estate identification.

            string

          • LandCertificateOwners

            List of land certificate owners.
            Array
            Object

            LandCertificateOwner

            Holds land certificate owner details

            • FullName

              Owner full name

              string

            • IdNumber

              Owner ID number

              string

            • Ownership

              Ownership percentage

              decimal

          • MortgageLienPriorities

            List of mortgage lien priorities.
            Array
            Object

            MortgageLienPriority

            Holds mortgage lien priority details.

            • Date

              Date.

              DateTime

            • LienPriorityAmount Mandatory

              Lien priority amount, within.

              decimal

            • Note

              Note.

              string

            • Owner

              Bank / owner identifier.

              string

            • PledgeAmount

              Pledge amount.

              decimal

            • PriorityOrder

              Priority order.

              int

            • ReferenceNumber

              Reference number.

              string

          • ReportingCode

            Reporting code (probably some predefined value, not confirmed).

            string

          • ReportingDate

            Date of reporting.

            DateTime

          • TaxValue

            Tax value.

            decimal

          • ValueAmount

            Property value amount.

            decimal

          • ValuedAt

            Property valuation date.

            DateTime

          • ValuedBy

            Property valued by.

            string

        • ReferenceNumber Mandatory

          Pledge identity number.

          string

      • ProhibitTrustAccounting

        Should prohibit trust accounting.

        bool

      • ReceivedBy

        Identifier of subject the case received by.

        string

      • ReceivedFrom

        Identifier of subject the case received from.

        string

      • ReferenceNumber

        Debtor reference number.

        string

      • RentalObjects

        List of collection rental objects.
        Array
        Object

        RentalObject

        Holds collection rental object information.

        • City

          Rental object city.

          string

        • CountryCode

          Rental object counry code.

          string

        • EvictDate

          Rental object evict date.

          DateTime

        • HouseNo

          Rental object house number.

          string

        • HouseNoExtension

          Rental object house number extension.

          string

        • MovingDate

          Rental object moving date.

          DateTime

        • NoticeDate

          Rental object collection call notice date.

          DateTime

        • ObjectDescription

          Rental object description.

          string

        • ObjectNumber Mandatory

          Rental object identifier.

          string

        • PropertyDescription

          Property description.

          string

        • RentalObjectType

          Rental object type number corresponding to one of predefined rental object types (Leasehold estate / Housing association / Garage / Parking space / Premise / Lease / Community association).

          string

        • ResidentialArea

          Residential area (should be a number probably, not confirmed).

          string

        • Rooms

          Number of rooms (should be a number probably, not confirmed).

          string

        • ServingDate

          Rental object serving date.

          DateTime

        • Street

          Rental object street.

          string

        • ZipCode

          Rental object zipcode.

          string

      • Service

        Service name (Invoicing / ReceivableLdg / Paymentplan / PreCollection / Collection / Legal / Surveillance / External / JournalCase). This is default values that may be used as servicecode but via configuration changes may be made, for an exact list, contact the service provider.

        string

      • StopPayments

        Should automatic payments be stopped.

        bool

      • SystemInfoActions

        List of system info actions for the collection case.
        Array
        Object

        SystemInfoAction

        Detailed information about collection system info action.

        • BookForGroup

          Id of user group the action is booked for (probably should be a number).

          string

        • BookForUser

          Id of user the action is booked for (probably should be a number).

          string

        • Message Mandatory

          Action message.

          string

        • Priority

          Priority level number (probably a free-form, not confirmed).

          int

Output

Import collection account ID and journal id of registered collection case, collection account ID is not set since the journal is currently not imported.
Error codes:
  • 1: error message from ARC server
Object

RegisterCollectionCaseResponse

RegisterCollectionCase response

  • RegisterCollectionCaseResult

    Result of RegisterCollectionCase
    Object

    RegisterCollectionCaseResult

    General class for representing method output.

    • CollectionAccountId

      Collection account ID.

      int

    • ImpCollectionAccountId

      Import collection account ID.

      int

    • JournalId

      Journal ID.

      int

    • Result

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

      ResultType

      Common result type.

      • ResultCode Mandatory

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

        int

      • ResultText Mandatory

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

        string

RegisterDirectPayment

Registers new direct payment in journal.
Supply journal id to register direct payment in existing journal, otherwise new journal will be created

Examples

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

RegisterDirectPaymentResult result = client.RegisterDirectPayment(
    new RegisterDirectPaymentRequest {
        CreditorReference = "1000",
        InvoiceNumber = "30077",
        PaymentDate = new DateTime(2019, 1, 2),
        PaidAmount = 4500m,
        CurrencyCode = "SEK"
    }
);
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:RegisterDirectPayment>
            <urn:payment>
                <urn:CreditorReference>1000</urn:CreditorReference>
                <urn:CurrencyCode>SEK</urn:CurrencyCode>
                <urn:InvoiceNumber>30077</urn:InvoiceNumber>
                <urn:PaidAmount>4500</urn:PaidAmount>
                <urn:PaymentDate>2019-01-02</urn:PaymentDate>
            </urn:payment>
        </urn:RegisterDirectPayment>
    </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    RegisterDirectPayment

    RegisterDirectPayment

    • payment

      Direct payment identification parameters.
      Object

      RegisterDirectPaymentRequest

      General class for representing method input.

      • CaseNumber

        Collection case number.

        string

      • CreditorReference Mandatory

        Party reference code.

        string

      • CurrencyCode Mandatory

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

        string

      • Deduction

        List of direct payment deductions.
        Array
        Object

        RegisterDirectPaymentDeduction

        Holds direct payment deduction details

        • Amount Mandatory

          Deduction amount

          decimal

        • AmountType Mandatory

          Direct payment amount type
          Enum

          DirectPaymentAmountType

          Register direct payment amount type.

          • Principal

            Principal.

          • Interest

            Interest.

          • Fee

            Fee.

        • DebtReferenceNumber

          Debt reference number

          string

        • FeeCode

          Type of debt fee (one of predefined values INVOICECHARGE / PACKANDSHIP / BRPF / ORDERDISCOUNT).

          string

      • InvoiceNumber

        Debt reference (invoice number).

        string

      • JournalId

        Journal ID.

        int

      • PaidAmount Mandatory

        Paid amount.

        decimal

      • PaymentDate Mandatory

        Payment date.

        DateTime

Output

Import payment ID and journal id of registered direct payment.
Error codes:
  • 1: error message from ARC server
Object

RegisterDirectPaymentResponse

RegisterDirectPayment response

  • RegisterDirectPaymentResult

    Result of RegisterDirectPayment
    Object

    RegisterDirectPaymentResult

    General class for representing method output.

    • ImpPaymentId

      Import payment ID.

      int

    • JournalId

      Journal ID.

      int

    • Result

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

      ResultType

      Common result type.

      • ResultCode Mandatory

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

        int

      • ResultText Mandatory

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

        string

RegisterInvoice

Registers new invoice in journal.
Supply journal id to register invoice in existing journal, otherwise new journal will be created

Examples

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

RegisterInvoiceResult result = client.RegisterInvoice(
    new RegisterInvoiceRequest {
        CreditorReference = "1000",
        Customer = new Customer { CustomerReference = "555555555555555" },
        Debts = new List<Debt> {
            new Debt {
                BillDate = new DateTime(2018, 11, 13),
                CurrencyCode = "SEK"
            }
        }.ToArray()
    }
);
);
Sample soap request: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:RegisterInvoice>
            <urn:invoice>
                <urn:CreditorReference>1000</urn:CreditorReference>
                <urn:Customer>
                    <urn:CustomerReference>555555555555555</urn:CustomerReference>
                </urn:Customer>
                <urn:Debts>
                    <urn:Debt>
                        <urn:BillDate>2018-11-13</urn:BillDate>
                        <urn:CurrencyCode>SEK</urn:CurrencyCode>
                    </urn:Debt>
                </urn:Debts>
            </urn:invoice>
        </urn:RegisterInvoice>
    </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    RegisterInvoice

    RegisterInvoice

    • invoice

      Invoice identification parameters.
      Object

      RegisterInvoiceRequest

      General class for representing method input.

      • AccountingFactor

        Accounting factor (percentage of system amount).

        double

      • Aconto

        Is payment account 'aconto' (special type of account supposing partial payments of total cost).

        bool

      • ClaimantName

        Claimant name.

        string

      • CreditorReference Mandatory

        Party reference code.

        string

      • Customer Mandatory

        Holds customer details.
        Object

        Customer

        Holds customer information.

        • Address

          List of customer's addresses.
          Array
          Object

          Address

          Holds customer's address information.

          • AddressNotValid

            Date of address invalidation.

            DateTime

          • AddressNotValidOverride

            Should address be validated.

            bool

          • AddressType Mandatory

            Address type (one of predefined codes LEGAL / AVI / INVOICE / SITE / DELIVERY / TRUSTACCNT).

            string

          • CareOf

            C/o address.

            string

          • City

            City.

            string

          • Country

            Country.

            string

          • CountryCode

            Country code.

            string

          • DefaultAddress

            Is default address.

            bool

          • FullAddress

            Full address.

            string

          • FullName

            Full name.

            string

          • HouseNo

            House number.

            string

          • HouseNoextension

            House number extension.

            string

          • StateCode

            State code.

            string

          • Street

            Street.

            string

          • UpdateExisting

            Should update customer's existing address

            bool

          • ValidFrom

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

            DateTime

          • ValidTo

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

            DateTime

          • ZipCode

            Zipcode.

            string

        • AddressNotValidOverride

          Should address be validated.

          bool

        • AutoTransfer

          Autotransfer details.
          Object

          AutoTransfer

          Holds autotransfer information.

          • ApprovedAt

            Autotransfer date of approval.

            DateTime

          • AutoTransferType

            Autotransfer type.
            Enum

            AutoTransferType

            The type of automatic transfer of money.

            • SwedishAutogiro

              Autogiro (Sweden).

            • DutchIncasso

              Incasso (the Netherlands).

            • DutchSEPAConsumerRecurring

              SEPA consumer recurring (the Netherlands).

            • DutchSEPAConsumerOneoOff

              SEPA consumer one-off (the Netherlands).

            • DutchSEPABusinessRecurring

              SEPA business recurring (the Netherlands).

            • DutchSEPABusinessOneOff

              SEPA business one-off (the Netherlands).

          • BankAccountNo

            Autotransfer bank account number.

            string

          • ReferenceNo

            Autotransfer reference number.

            string

          • RequestedAt

            Autotransfer date of request.

            DateTime

          • SignedDate

            Autotransfer date of signature.

            DateTime

          • Validfrom

            Autotransfer "valid from" date.

            DateTime

          • Validuntil

            Autotransfer "valid till" date.

            DateTime

        • AutoTransferBankaccount

          Ledger autotransfer bank account number.

          string

        • AutoTransferReferenceNo

          Ledger autotransfer reference number.

          string

        • CareOf

          Customer's c/o address.

          string

        • CellularPhone

          Customer's cellular phone number.

          string

        • City

          Customer's city.

          string

        • Country

          Customer's country.

          string

        • CountryCode

          Customer's country code.

          string

        • CultureCode

          Customer's time and currency format.

          string

        • CurrencyCode

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

          string

        • CustomerReference

          Customer reference.

          string

        • CustomerRole

          Customer role.
          Enum

          CustomerRole

          Customer role.

          • Debtor

            Debtor.

          • Guarantor

            Guarantor.

          • Coapplicant

            Co-applicant.

          • Estatebeneficiary

            Estate beneficiary.

          • Tradingcompanypartner

            Trading company partner.

          • Generalpartner

            General partner.

          • Custodian

            Custodian.

          • Solventperson

            Solvent person.

        • DateOfBirth

          Customer's date of birth.

          DateTime

        • Domicile

          Customer's domicile.

          string

        • EInvoiceBankCode

          Clearning bank code (einvoiceb2b or einvoiceb2c, depending on juridical type of customer).

          string

        • EInvoiceReceiverId

          Customer's GLN number.

          string

        • Email

          Customer's e-mail.

          string

        • ExternPaymentTypeCode

          External payment type code (BGCAUTOGIRO / E-INVOICE or some others).

          string

        • ExtraFields

          List of customer's extra fields.
          Array
          Object

          ExtraField

          Extra field contains custom data.

          • Data

            Value of extra field.

            string

          • Name

            Name of extra field.

            string

        • Firstname

          Customer's first name.

          string

        • FullAddress

          Customer's full address.

          string

        • Gender

          Customer's gender.
          Enum

          GenderType

          Gender of a person.

          • Female

            Female gender, a woman.

          • Male

            Male gender, a man.

          • Unknown

            Unknown gender, or neither Female nor Male.

        • GlnNumber

          Customer's GLN number.

          string

        • HomePhone

          Customer's domestic phone number.

          string

        • HouseNo

          Customer's house number.

          string

        • HouseNoExtension

          Customer's house number extension.

          string

        • IdNumber

          Customer ID number.

          string

        • InvoiceChannel

          Preferred channel of per invoice communication (Letter / Email / SMS / E-invoice).

          string

        • JuridicalType

          Customer person juridical type.
          Enum

          JuridicalType

          Type of person, juridically.

          • NaturalPerson

            Actual person.

          • JuridicalPerson

            Juridical person, e.g a company.

        • LanguageCode

          Customer's language code.

          string

        • Lastname

          Customer's last name.

          string

        • Middlename

          Customer's middle name.

          string

        • MunicipalCode

          Customer's municipal code.

          string

        • NaceCode

          Customer's NACE code.

          string

        • NameSuffix

          Customer's name suffix.

          string

        • PlaceOfbirth

          Customer's place of birth.

          string

        • Preferredchannel

          Customer's preferred channel of communication (Letter / Email / SMS / E-invoice).

          string

        • StateCode

          Customer's state code.

          string

        • Street

          Customer's street.

          string

        • Telefax

          Customer's telefax number.

          string

        • Title

          Customer's salutation.

          string

        • UnderAged

          Is the customer underaged.

          bool

        • UpdateExisting

          Should update customer's existing address

          bool

        • ValidFrom

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

          DateTime

        • ValidTo

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

          DateTime

        • VatNumber

          Customer's VAT number.

          string

        • WorkPhone

          Customer's work phone number.

          string

        • ZipCode

          Customer's zipcode.

          string

      • Debts Mandatory

        List of debts for the invoice.
        Array
        Object

        Debt

        Detailed information about ledger account debt.

        • BillDate

          Bill date.

          DateTime

        • CashRegisterNumber

          Cash register number.

          string

        • CreditCardTransactionId

          Credit card transaction (probably short info text).

          string

        • CurrencyCode Mandatory

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

          string

        • DebtGroup

          Debt group code (probably one of predefined values).

          string

        • DebtPrincipalType

          Debt principal type.
          Enum

          DebtPrincipalType

          Debt principal type.

          • Invoice

            Invoice.

          • CreditInvoice

            Credit invoice.

          • InterestInvoice

            Interest invoice.

          • FinalInvoiceCreditDebt

            Final invoice for credit debt.

        • DebtRows

          List of debt rows.
          Array
          Object

          DebtRow

          Detailed information about ledger account debt row.

          • AccountChartCode

            Account chart code (one of predefined values).

            string

          • AccountDim1

            Account dimension 1.

            string

          • AccountDim2

            Account dimension 2.

            string

          • AccountDim3

            Account dimension 3.

            string

          • AccountDim4

            Account dimension 4.

            string

          • AccountDim5

            Account dimension 5.

            string

          • AccountDim6

            Account dimension 6.

            string

          • AccountDim7

            Account dimension 7.

            string

          • AccountDim8

            Account dimension 8.

            string

          • CallLength

            Phone call length (probably, not confirmed).

            int

          • CallNumber

            Phone call number dialed regarding current debt operation (probably, not confirmed).

            string

          • DebtFeeCode

            Type of debt fee (one of predefined values INVOICECHARGE / PACKANDSHIP / BRPF / ORDERDISCOUNT).

            string

          • Description

            Debt row description.

            string

          • Discount

            Item(s) discount.

            decimal

          • EanCode

            EAN code.

            string

          • ExtraFields

            List of debt row extra fields.
            Array
            Object

            ExtraField

            Extra field contains custom data.

            • Data

              Value of extra field.

              string

            • Name

              Name of extra field.

              string

          • IncludingVAT

            Is VAT included.

            bool

          • ItemCount

            Order item(s) count.

            decimal

          • ItemNetAmount

            Item(s) principal amount.

            decimal

          • ItemReference

            Debt row item reference.

            string

          • ItemSystemNetAmount

            Item(s) system amount (probably, not confirmed).

            decimal

          • OrderCount

            Order count.

            int

          • RemainingCount

            Remaining item(s) count.

            int

          • RowPrincipalAmount

            Row principal amount.

            decimal

          • RowReference

            Debt row reference.

            string

          • SummaryOnly

            Is a summary information.

            bool

          • SystemRowPrincipalAmount

            Row system amount (probably, not confirmed).

            decimal

          • SystemVatAmount

            System VAT amount.

            decimal

          • TextOnly

            Is a textual information.

            bool

          • UnitTypeId

            Unit type id (corresponds to one of predefined types Pcs / Hours / VAT / Litres / etc.).

            int

          • VatAccountChartCode

            VAT account chart code (one of predefined values).

            string

          • VatAmount

            VAT amount.

            decimal

          • VatCode

            VAT code (one of predefined values depending on country code SE25 / SE0 / NO0 / NO25 / DK0 / DK25 / SE12 / NL19 / NO8 / NO14 / SE21 / SE6 / NO15 / EU0 / EXP0 / SRV0 / FI0 / FI10 / FI14 / FI24).

            string

        • DeliveryCity

          Delivery subject city.

          string

        • DeliveryCondition

          Delivery condition (probably free-form text).

          string

        • DeliveryCountryCode

          Delivery subject country code.

          string

        • DeliveryDate

          Delivery date.

          DateTime

        • DeliveryFullAddress

          Delivery subject full address.

          string

        • DeliveryFullName

          Delivery subject full name.

          string

        • DeliveryHouseNo

          Delivery subject house number.

          string

        • DeliveryHouseNoExtension

          Delivery subject house number extension.

          string

        • DeliveryMethod

          Delivery method (probably free-form text).

          string

        • DeliveryNoteId

          Delivery note (probably short info text).

          string

        • DeliveryStateCode

          Delivery subject state code.

          string

        • DeliveryStreet

          Delivery subject street.

          string

        • DeliveryZipCode

          Delivery subject zipcode.

          string

        • Description

          Debt description.

          string

        • DocumentDate

          Document creation date.

          DateTime

        • DueDate

          Due date.

          DateTime

        • ExchangeRate

          Exchange rate.

          decimal

        • ExtraFields

          List of debt extra fields.
          Array
          Object

          ExtraField

          Extra field contains custom data.

          • Data

            Value of extra field.

            string

          • Name

            Name of extra field.

            string

        • GoodsMark

          Goods mark.

          string

        • InterestCode

          Debt interest code (one of predefined interest calculation types).

          string

        • InterestCondition

          Debt interest period in days.

          int

        • InterestFrom

          Debt interest calculation start date.

          DateTime

        • InterestRate

          Debt interest rate.

          decimal

        • InterestTo

          Debt interest calculation end date.

          DateTime

        • InvoiceNumber

          Debt reference (invoice number).

          string

        • LedgerReference

          Debt ledger reference.

          string

        • LimitationDate

          Limitation date.

          DateTime

        • Message

          Debt message (probably short info text).

          string

        • OrderDate

          Order date.

          DateTime

        • OriginalReferenceNumber

          Original reference number.

          string

        • OurOrder

          Our order number.

          string

        • OurReference

          Our reference.

          string

        • PaymentCondition

          Debt payment period in days.

          int

        • PaymentReference

          Payment reference.

          string

        • Periodoflimitation

          Period of limitation.

          int

        • ReceiptNumber

          Debt receipt number.

          string

        • ReceiverCity

          Receiver city.

          string

        • ReceiverCountryCode

          Receiver country code.

          string

        • ReceiverFullAddress

          Receiver full address.

          string

        • ReceiverFullName

          Receiver full name.

          string

        • ReceiverHouseNo

          Receiver house number.

          string

        • ReceiverHouseNoExtension

          Receiver house number extension

          string

        • ReceiverStateCode

          Receiver state code.

          string

        • ReceiverStreet

          Receiver street.

          string

        • ReceiverZipCode

          Receiver zipcode.

          string

        • RemainingInterest

          Remaining interest.

          decimal

        • Rounding

          Rounding.

          decimal

        • Seller

          Seller identifier.

          string

        • Store

          Store reference code (probably, not confirmed).

          string

        • Systemrounding

          System rounding.

          decimal

        • VendorReferenceCode

          Vendor reference code.

          string

        • YourOrder

          Your order number.

          string

        • YourReference

          Your reference.

          string

      • DeliverySystemCode

        Delivery system code.

        string

      • DenyConversion

        Is conversion to revolving credit allowed.

        bool

      • Document

        List of documents for the invoice.
        Array
        Object

        Document

        Holds history action document information.

        • DocumentType

          Document code (one of predefined types idoc / invoice / gjeldsbrev / verdict / domforlik).

          string

        • ExternalLink

          Link to the document, if it has to be copied from external source.

          string

        • FileDataBase64

          Base64-encoded file body.

          string

        • Important

          Document importancy flag.

          bool

        • LoggedAt

          Document creation date.

          DateTime

        • Note Mandatory

          Free extra information related to the document.

          string

        • OriginalFileName

          The file name to be generated instead of an auto-generated one.

          string

      • ExternalReferenceCode

        External ledger reference code.

        string

      • ExtraFields

        List of extra fields for the invoice.
        Array
        Object

        ExtraField

        Extra field contains custom data.

        • Data

          Value of extra field.

          string

        • Name

          Name of extra field.

          string

      • Fees

        List of fees for the invoice.
        Array
        Object

        Fee

        Detailed information about ledger account fee.

        • CurrencyCode

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

          string

        • Description

          Ledger account fee description.

          string

        • ExchangeRate

          Exchange rate.

          decimal

        • FeeDate

          Ledger account fee date.

          DateTime

        • ImportedFee

          Is imported fee.

          bool

        • InterestAmount

          Ledger account fee interest.

          decimal

        • InterestCode

          Ledger account fee interest code (one of predefined interest calculation types).

          string

        • InterestFrom

          Fee interest calculation start date.

          DateTime

        • InterestRate

          Ledger account fee interest rate.

          decimal

        • InterestTo

          Fee interest calculation end date.

          DateTime

        • Name

          Ledger account fee code (probably one of predefined values).

          string

        • PrincipalAmount

          Ledger account fee principal.

          decimal

        • VatAmount

          Ledger account fee VAT.

          decimal

      • FormCode

        Form code (customer specific values).

        string

      • InvoiceDate

        Date of invoice.

        DateTime

      • JournalId

        Journal ID.

        int

      • LoanFlag

        Is debt loan functionality enabled for invoice.

        bool

      • LoanPercent

        Amount to be disbursed for invoice (percent of invoice amount). If not indicated, creditor settings used

        decimal

      • MarketplaceReferenceCode

        Marketplace reference code.

        string

      • Note

        List of notes for the invoice.
        Array
        Object

        Note

        Detailed information about ledger account note.

        • HistNoteTypeId

          History note type number corresponding to one of predefined history note types.

          string

        • HistOwnerTypeId

          History owner type number corresponding to one of predefined history owner types Collector / System note / Creditor note / Debtor note / Customernote).

          string

        • Important

          Is the note important.

          bool

        • LoggedAt

          Ledger account note logging date.

          DateTime

        • NoteText

          Ledger account note text.

          string

        • SystemCode

          Free-form system or process identifier, which created the note (probably, not confirmed).

          string

        • UserCode

          Free-form user identifier, who created the note - not only user code (probably, not confirmed).

          string

      • PaymentCode

        Payment code.

        string

      • PaymentProductCode

        Payment product code (ACCOUNT / INVOICE or some others).

        string

      • PaymentReference

        Payment reference.

        string

      • PreferredChannel

        Preferred way of communication (Letter / Email / SMS / E-invoice).

        string

      • PrintCode

        Print code (customer specific values).

        string

      • Purchasable

        Is invoice purchasable.
        Enum

        Purchasable

        Purchasable (Invoice).

        • NotPurchasable

          Not purchasable.

        • Purchasable

          Purchaseble.

        • OnlyWithRegress

          Purchasble only with regress.

      • PurchaseFee

        Purchase fee.

        string

      • ReceiverReference

        Receiver reference - usualy e-mail address.

        string

      • ReferenceNumber

        Customer reference number.

        string

      • Service

        Service name (Invoicing / ReceivableLdg / Paymentplan / PreCollection / Collection / Legal / Surveillance / External / JournalCase). This is default values that may be used as servicecode but via configuration changes may be made, for an exact list, contact the service provider.

        string

      • TryComplementExisting

        If we need to try to complement existing matching invoice with debt rows instead of creating a new one

        bool

Output

Import ledger account ID and journal id of registered invoice, ledger account ID is not set since the journal is currently not imported.
Error codes:
  • 1: error message from ARC server
Object

RegisterInvoiceResponse

RegisterInvoice response

  • RegisterInvoiceResult

    Result of RegisterInvoice
    Object

    RegisterInvoiceResult

    General class for representing method output.

    • ImpLedgerAccountId

      Import ledger account ID.

      int

    • JournalId

      Journal ID.

      int

    • LedgerAccountId

      Ledger account ID.

      int

    • Result

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

      ResultType

      Common result type.

      • ResultCode Mandatory

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

        int

      • ResultText Mandatory

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

        string