ActionEvent
Examples
CollectionUpdateClient client = new CollectionUpdateClient();
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 dataObjectActionEventActionEvent-
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.EnumActionBaseTypeActionBaseType.-
UndefinedUndefined. -
CollectionAccountCollectionAccount. -
PaymentPlanPaymentPlan. -
LegalLegal. -
OfferOffer. -
BankruptcyBankruptcy. -
DeceasedDeceased. -
DebtReliefDebtRelief. -
CompanyReorganisationCompanyReorganisation. -
DebtorDebtor. -
LedgerAccountLedgerAccount. -
LedgerAccountGroupLedgerAccountGroup. -
TicketTicket. -
CollectionAccountGroupCollectionAccountGroup.
-
-
EventType
Value corresponding to event type code in action events.EnumActionEventTypeActionEventType.-
STARTUPSTARTUP. -
TIMEOUTTIMEOUT. -
USER_ALTERNATIVEUSER_ALTERNATIVE. -
TIMERTIMER. -
DECISIONDECISION. -
UNKNOWNUNKNOWN. -
PAYMENTPAYMENT. -
PAYMENT_AUTHORITYPAYMENT_AUTHORITY. -
CUSTOMCUSTOM. -
VERIFICATIONVERIFICATION. -
MESSAGE_SENTMESSAGE_SENT. -
AMOUNTADJUSTMENTAMOUNTADJUSTMENT. -
NEWINVOICEADDEDNEWINVOICEADDED. -
NEWDEBTORADDEDNEWDEBTORADDED. -
FULLPAYMENTFULLPAYMENT. -
CLOSURECLOSURE. -
NEWACCOUNTADDEDNEWACCOUNTADDED. -
MESSAGE_CONFIRMEDMESSAGE_CONFIRMED. -
MESSAGE_CONFIRM_FAILEDMESSAGE_CONFIRM_FAILED. -
PROCESSINGERRORPROCESSINGERROR. -
OBJECTIONOBJECTION. -
CREDIT_ANSWERCREDIT_ANSWER. -
ACTIONGROUPING_IGNOREDACTIONGROUPING_IGNORED. -
DEBTOR_NEW_ADDRESSDEBTOR_NEW_ADDRESS. -
DEBTOR_ADDRESS_NOTVALIDDEBTOR_ADDRESS_NOTVALID. -
DEBTOR_UPDATEDEBTOR_UPDATE. -
PP_FIRST_PAYMENT_ADVICEPP_FIRST_PAYMENT_ADVICE. -
PP_PAYMENT_ADVICEPP_PAYMENT_ADVICE. -
PP_LAST_PAYMENT_ADVICEPP_LAST_PAYMENT_ADVICE. -
PP_MISSED_PAYMENTPP_MISSED_PAYMENT. -
PP_BROKEN_AGREEMENTPP_BROKEN_AGREEMENT. -
PP_REMINDERPP_REMINDER. -
PP_PAYMENTPP_PAYMENT. -
PP_PARTPAYMENTPP_PARTPAYMENT. -
PP_EXTERNAL_PAYMENTPP_EXTERNAL_PAYMENT. -
PP_EXTERNAL_ADJUSTMENTPP_EXTERNAL_ADJUSTMENT. -
PP_FIRSTPAYMENTPP_FIRSTPAYMENT. -
PP_COMPLETEDPP_COMPLETED. -
PP_LATE_PAYMENT_ADVICEPP_LATE_PAYMENT_ADVICE. -
PP_REMINDER_AND_ADVICEPP_REMINDER_AND_ADVICE. -
PP_STOPPEDPP_STOPPED. -
PP_REPLACEDPP_REPLACED. -
PP_ACTIVATEDPP_ACTIVATED. -
LEGAL_VERDICTLEGAL_VERDICT. -
LEGAL_RENEWALLEGAL_RENEWAL. -
LEGAL_CASEINFOLEGAL_CASEINFO. -
LEGAL_REPORTLEGAL_REPORT. -
LEGAL_LEXLEGAL_LEX. -
LEGAL_BECOMINGFINALLEGAL_BECOMINGFINAL. -
LEGAL_FINALPAYMENTLEGAL_FINALPAYMENT. -
LEGAL_NEWLEGALDOCUMENTLEGAL_NEWLEGALDOCUMENT. -
LEGAL_FI_SUMMONS_ERRORLEGAL_FI_SUMMONS_ERROR. -
CUSTOMER_UPDATECUSTOMER_UPDATE. -
CUSTOMER_ADDRESS_NOTVALIDCUSTOMER_ADDRESS_NOTVALID. -
BANKRUPTCY_ADDEDBANKRUPTCY_ADDED. -
DECEASED_ADDEDDECEASED_ADDED. -
DEBTRELIEF_ADDEDDEBTRELIEF_ADDED. -
DEBTRELIEF_UPDATEDDEBTRELIEF_UPDATED. -
COMPANYREORGANISATION_ADDEDCOMPANYREORGANISATION_ADDED. -
TRANSACTION_IMPORTEDTRANSACTION_IMPORTED. -
PRINTLETTER_CONDITION_FALSEPRINTLETTER_CONDITION_FALSE. -
INTEREST_INVOICING_INFO_CREATEDINTEREST_INVOICING_INFO_CREATED. -
INTEREST_INVOICING_INFO_DELETEDINTEREST_INVOICING_INFO_DELETED. -
DUE_DATE_CHANGEDDUE_DATE_CHANGED. -
AUTOTRANSFER_EVENTAUTOTRANSFER_EVENT. -
OFFER_PAID_IN_FULLOFFER_PAID_IN_FULL. -
USER_QUESTION_ANSWERUSER_QUESTION_ANSWER. -
CUSTOMERACCOUNT_FIRST_SETTLEMENTCUSTOMERACCOUNT_FIRST_SETTLEMENT. -
CUSTOMERACCOUNT_SETTLEMENTCUSTOMERACCOUNT_SETTLEMENT. -
CUSTOMERACCOUNT_LAST_SETTLEMENTCUSTOMERACCOUNT_LAST_SETTLEMENT. -
CUSTOMERACCOUNT_MISSED_PAYMENT_MINIMUM_TO_PAYCUSTOMERACCOUNT_MISSED_PAYMENT_MINIMUM_TO_PAY. -
CUSTOMERACCOUNT_BROKEN_SETTLEMENTCUSTOMERACCOUNT_BROKEN_SETTLEMENT. -
CUSTOMERACCOUNT_REMINDERCUSTOMERACCOUNT_REMINDER. -
CUSTOMERACCOUNT_PAYMENTCUSTOMERACCOUNT_PAYMENT. -
CUSTOMERACCOUNT_PARTPAYMENTCUSTOMERACCOUNT_PARTPAYMENT. -
CUSTOMERACCOUNT_PAYMENTFREE_SETTLEMENTCUSTOMERACCOUNT_PAYMENTFREE_SETTLEMENT. -
CUSTOMERACCOUNT_DEBTCOLLECTIONCUSTOMERACCOUNT_DEBTCOLLECTION. -
CUSTOMERACCOUNT_MISSED_PAYMENT_MINIMUM_TO_PAY_INCLUDING_CAMPAIGNCUSTOMERACCOUNT_MISSED_PAYMENT_MINIMUM_TO_PAY_INCLUDING_CAMPAIGN. -
CUSTOMERACCOUNT_STATEMENTOFACCOUNTccCUSTOMERACCOUNT_STATEMENTOFACCOUNT. -
CUSTOMERACCOUNT_CREDITSTOPCAUSE_ADDEDCUSTOMERACCOUNT_CREDITSTOPCAUSE_ADDED. -
CUSTOMERACCOUNT_CREDITSTOPCAUSE_REMOVEDCUSTOMERACCOUNT_CREDITSTOPCAUSE_REMOVED. -
CUSTOMERACCOUNT_CAMPAIGNEVENTCUSTOMERACCOUNT_CAMPAIGNEVENT. -
CUSTOMERACCOUNT_CAMPAIGN_CREATED_RETROACTIVELYCUSTOMERACCOUNT_CAMPAIGN_CREATED_RETROACTIVELY. -
CUSTOMERACCOUNT_CAMPAIGN_ACTIVATEDCUSTOMERACCOUNT_CAMPAIGN_ACTIVATED. -
CUSTOMERACCOUNT_LOAN_LETTER_FLOATINGCUSTOMERACCOUNT_LOAN_LETTER_FLOATING. -
CUSTOMERACCOUNT_LOAN_LETTER_NEWFIXEDINTERESTTERMCUSTOMERACCOUNT_LOAN_LETTER_NEWFIXEDINTERESTTERM. -
CUSTOMERACCOUNT_LOAN_LETTER_INFIXEDINTERESTTERMCUSTOMERACCOUNT_LOAN_LETTER_INFIXEDINTERESTTERM. -
CUSTOMERACCOUNT_LOAN_LETTER_REMINDERCUSTOMERACCOUNT_LOAN_LETTER_REMINDER. -
CUSTOMERACCOUNT_LOAN_TERMINATIONCUSTOMERACCOUNT_LOAN_TERMINATION. -
CUSTOMERACCOUNT_LOAN_PRETERMINATIONCUSTOMERACCOUNT_LOAN_PRETERMINATION. -
CUSTOMERACCOUNT_LOAN_REVERSETERMINATIONCUSTOMERACCOUNT_LOAN_REVERSETERMINATION. -
CUSTOMERACCOUNT_VIRT_INSTALMENT_INVOICINGCUSTOMERACCOUNT_VIRT_INSTALMENT_INVOICING. -
CUSTOMERACCOUNT_VIRT_REMINDERCUSTOMERACCOUNT_VIRT_REMINDER. -
CUSTOMERACCOUNT_VIRT_TERMINATIONCUSTOMERACCOUNT_VIRT_TERMINATION. -
CUSTOMERACCOUNT_INCREASED_AMOUNT_TO_PAYCUSTOMERACCOUNT_INCREASED_AMOUNT_TO_PAY. -
CUSTOMERACCOUNT_CREDITDEBTINSURANCE_ADDEDCUSTOMERACCOUNT_CREDITDEBTINSURANCE_ADDED. -
CUSTOMERACCOUNT_CREDITDEBTINSURANCE_UPDATEDCUSTOMERACCOUNT_CREDITDEBTINSURANCE_UPDATED. -
CUSTOMERACCOUNT_CREDITDEBTINSURANCE_DELETEDCUSTOMERACCOUNT_CREDITDEBTINSURANCE_DELETED. -
CUSTOMERACCOUNT_CREDITDEBTINSURANCE_STATUSCHANGEDCUSTOMERACCOUNT_CREDITDEBTINSURANCE_STATUSCHANGED. -
CUSTOMERACCOUNT_USED_RIGHT_TO_WITHDRAWCUSTOMERACCOUNT_USED_RIGHT_TO_WITHDRAW. -
CUSTOMERACCOUNT_ACCOUNT_TRANSFERCUSTOMERACCOUNT_ACCOUNT_TRANSFER. -
LEDGER_RETURNLEDGER_RETURN. -
LEDGERACCOUNT_EVENTLEDGERACCOUNT_EVENT. -
COLLECTIONACCOUNTGROUP_CASE_ADDEDCOLLECTIONACCOUNTGROUP_CASE_ADDED. -
COLLECTIONACCOUNTGROUP_CASE_REMOVEDCOLLECTIONACCOUNTGROUP_CASE_REMOVED. -
COLLECTIONACCOUNT_AUTO_CASE_REVOKECOLLECTIONACCOUNT_AUTO_CASE_REVOKE. -
AUTHSIGN_APPROVEDAUTHSIGN_APPROVED. -
AUTHSIGN_TIMEOUTAUTHSIGN_TIMEOUT. -
AUTHSIGN_REJECTEDAUTHSIGN_REJECTED. -
NEWDOCUMENTNEWDOCUMENT. -
LEDGERACCOUNT_MERGELEDGERACCOUNT_MERGE. -
LEDGERACCOUNT_REWRITELEDGERACCOUNT_REWRITE. -
BAILIFF_CANCELLATIONInformation on cancellation reported by the bailiff. -
BAILIFF_LIMITATION_CREDITORInformation on the creditor’s liability to interrupt limitation. -
BAILIFF_FINAL_REMITTANCEInformation on final remittance by the bailiff. -
BAILIFF_OBSTACLE_LACKOFFUNDSObstacle: debtor lacks funds. -
BAILIFF_OBSTACLE_LACKOFFUNDS_UNKNOWNObstacle: debtor lacks funds and is unknown. -
BAILIFF_OBSTACLE_OTHERObstacle: other. -
BAILIFF_OBSTACLE_LIMITEDENFORCEMENTObstacle: limited enforcement. -
BAILIFF_OBSTACLE_LIMITEDENFORCEMENT_UNKNOWNObstacle: limited enforcement and unknown. -
BAILIFF_DEBTOR_STATUS_UPDATEDebtor: status update. -
BAILIFF_BALANCEDebtor: balance inquiry.. -
OBJECT_UPDATEOBJECT_UPDATE.
-
-
ProcessImmediately
Process action event immediately.bool
-
Output
0 if event is triggered.
ActionEventResponse
-
ActionEventResult
Result of ActionEvent.ObjectGeneralResultA general result containing a result with result code and result text.-
Result
The result of the request.ObjectResultTypeCommon result type.-
ResultCode Mandatory
The result code0means 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
-
-
AddCreditNote
Examples
CollectionUpdateClient client = new CollectionUpdateClient();
GeneralResult result = client.AddCreditNote(
new CaseLookup { CaseIdentification = CaseIdentificationType.CaseNumber, CaseIdentificationValue = "7" },
"231",
"423",
1000m,
new DateTime(2019, 3, 20),
new DateTime(2019, 3, 20)
);
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:AddCreditNote>
<urn:amount>1000</urn:amount>
<urn:bookCreditNote>false</urn:bookCreditNote>
<urn:caseLookup>
<urn:CaseIdentification>CaseNumber</urn:CaseIdentification>
<urn:CaseIdentificationValue>523235</urn:CaseIdentificationValue>
</urn:caseLookup>
<urn:creditNoteInvoiceNumber>634634</urn:creditNoteInvoiceNumber>
<urn:dueDate>2019-03-20</urn:dueDate>
<urn:invoiceDate>2019-03-20</urn:invoiceDate>
<urn:originalInvoiceNumber>634</urn:originalInvoiceNumber>
</urn:AddCreditNote>
</soapenv:Body>
</soapenv:Envelope>Input
-
request Mandatory
Request dataObjectAddCreditNoteAddCreditNote-
amount
Value corresponding to amount.decimal -
bookCreditNote
Flag to book credit note.bool -
caseLookup
Information to lookup case.ObjectCaseLookupThe way to find a collection case in DB by several predefined criteria.-
CaseIdentification Mandatory
Collection case identification type.EnumCaseIdentificationTypeCollection case identification type.-
CaseGuidCase GUID identification. -
CaseNumberCase number. -
AccountReferenceNumberAccount reference number provided by the client. -
InvoiceNumberInvoice number of one on the debts provided by the client. -
PaymentReferenceNumberPayment reference number (OCR). -
CustomerNoCustomer number for the debtor at the creditor side.
-
-
CaseIdentificationValue Mandatory
Identification value corresponding to identification type.string
-
-
creditNoteInvoiceNumber
Value corresponding to credit note invoice number.string -
dueDate
Value corresponding to due date.DateTime -
invoiceDate
Value corresponding to invoice date.DateTime -
originalInvoiceNumber
Value corresponding to original invoice number.string
-
Output
0 if credit note is inserted.
Error codes:
- 30701: collection account generic error
AddCreditNoteResponse
-
AddCreditNoteResult
Result of AddCreditNote.ObjectGeneralResultA general result containing a result with result code and result text.-
Result
The result of the request.ObjectResultTypeCommon result type.-
ResultCode Mandatory
The result code0means 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
-
-
AddDocumentInCase
Examples
CollectionUpdateClient client = new CollectionUpdateClient();
GeneralResult result = client.AddDocumentInCase(
new List<CaseLookup> {
new CaseLookup { CaseIdentification = CaseIdentificationType.CaseNumber, CaseIdentificationValue = "7" }
}.ToArray(),
new Document { Note = "Here a new file comes" }
);
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:AddDocumentInCase>
<urn:caseLookups>
<urn:CaseLookup>
<urn:CaseIdentification>CaseNumber</urn:CaseIdentification>
<urn:CaseIdentificationValue>7</urn:CaseIdentificationValue>
</urn:CaseLookup>
</urn:caseLookups>
<urn:document>
<urn:Note>Here a new file comes</urn:Note>
</urn:document>
</urn:AddDocumentInCase>
</soapenv:Body>
</soapenv:Envelope>Input
-
request Mandatory
Request dataObjectAddDocumentInCaseAddDocumentInCase.-
caseLookups
List of lookups for collection cases to attach the document to.ArrayObjectCaseLookupThe way to find a collection case in DB by several predefined criteria.-
CaseIdentification Mandatory
Collection case identification type.EnumCaseIdentificationTypeCollection case identification type.-
CaseGuidCase GUID identification. -
CaseNumberCase number. -
AccountReferenceNumberAccount reference number provided by the client. -
InvoiceNumberInvoice number of one on the debts provided by the client. -
PaymentReferenceNumberPayment reference number (OCR). -
CustomerNoCustomer number for the debtor at the creditor side.
-
-
CaseIdentificationValue Mandatory
Identification value corresponding to identification type.string
-
-
document
The document data to insert.ObjectDocumentHolds 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
-
-
Output
0 if document is inserted or no collection case(s) supplied.
Error codes:
- 30701: collection account generic error
AddDocumentInCaseResponse
-
AddDocumentInCaseResult
Result of AddDocumentInCase.ObjectGeneralResultA general result containing a result with result code and result text.-
Result
The result of the request.ObjectResultTypeCommon result type.-
ResultCode Mandatory
The result code0means 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
-
-
AddDocumentOnDebtor
Examples
CollectionUpdateClient client = new CollectionUpdateClient();
GeneralResult result = client.AddDocumentOnDebtor(
new List<DebtorLookup> {
new DebtorLookup { DebtorIdentification = DebtorIdentificationType.DebtorSESSNOrCompanyNo, DebtorIdentificationValue = "19451211-2634" },
}.ToArray(),
new Document { Note = "Here a new file comes" }
);
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:AddDocumentOnDebtor>
<urn:debtorLookups>
<urn:DebtorLookup>
<urn:DebtorIdentification>DebtorSESSNOrCompanyNo</urn:DebtorIdentification>
<urn:DebtorIdentificationValue>19451211-2634</urn:DebtorIdentificationValue>
</urn:DebtorLookup>
</urn:debtorLookups>
<urn:document>
<urn:Note>Here a new file comes</urn:Note>
</urn:document>
</urn:AddDocumentOnDebtor>
</soapenv:Body>
</soapenv:Envelope>Input
-
request Mandatory
Request dataObjectAddDocumentOnDebtorAddDocumentOnDebtor.-
debtorLookups
List of lookups for collection cases' debtors to attach the document to.ArrayObjectDebtorLookupThe way to find a debtor in DB by several predefined criteria.-
DebtorIdentification Mandatory
Debtor identification type.EnumDebtorIdentificationTypeDebtor identification type.-
CustomCustom identification. NOT SUPPORTED. -
DebtorSESSNOrCompanyNoIdentify by Swedish SSN or company number. -
DebtorNOSSNOrCompanyNoIdentify by Norweigan SSN or company number. -
DebtorReferenceNumberIdentify by debtor/client reference number. -
DebtorGuidDebtor identification. -
CustomerNoCustomer number for the debtor at the creditor side. NOT SUPPORTED in DebtorAccess.EstablishSession. -
DebtorFISSNOrCompanyNoIdentify by Finnish SSN or company number.
-
-
DebtorIdentificationValue Mandatory
Identification value corresponding to identification type.string
-
-
document
The document data to insert.ObjectDocumentHolds 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
-
-
Output
0 if document is inserted or no debtor(s) supplied.
Error codes:
- 30701: collection account generic error
AddDocumentOnDebtorResponse
-
AddDocumentOnDebtorResult
Result of AddDocumentOnDebtor.ObjectGeneralResultA general result containing a result with result code and result text.-
Result
The result of the request.ObjectResultTypeCommon result type.-
ResultCode Mandatory
The result code0means 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
Examples
CustomerInformationClient client = new CustomerInformationClient();
CustomActionResult result = client.CustomAction(new InvokeServiceDefinitionRequest
{
AsyncCall = false,
InputXml = @"<?xml version=""1.0"" encoding=""ISO-8859-1"" standalone=""no"" ?>
<data>
<value>12</value>
</data>",
ServiceDefinitionName = "your_service_definition"
});
Sample soap request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
<soapenv:Header/>
<soapenv:Body>
<urn:CustomAction>
<urn:serviceDefinition>
<urn:AsyncCall>false</urn:AsyncCall>
<urn:InputXml><![CDATA[
<?xml version="1.0" encoding="ISO-8859-1" standalone="no" ?>
<data>
<value>12</value>
</data>
]]></urn:InputXml>
<urn:ServiceDefinitionName>your_service_definition</urn:ServiceDefinitionName>
</urn:serviceDefinition>
</urn:CustomAction>
</soapenv:Body>
</soapenv:Envelope>Input
-
request Mandatory
Request dataObjectCustomActionCustom action-
serviceDefinition
The invoke service definition request.ObjectInvokeServiceDefinitionRequestA 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
CData.
Error codes:
- 30601: General service definition error
- 30602: Service definition does not exist
- 30603: Service definition input values error
- 30604: Custom error
CustomActionResultResponse
-
CustomActionResult
Result of CustomAction.ObjectCustomActionResultThe 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.ObjectResultTypeCommon result type.-
ResultCode Mandatory
The result code0means 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
-
-
MatchCreditNote
Examples
CollectionUpdateClient client = new CollectionUpdateClient();
GeneralResult result = client.MatchCreditNote(
new CaseLookup { CaseIdentification = CaseIdentificationType.CaseNumber, CaseIdentificationValue = "7" },
"231",
"423",
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:MatchCreditNote>
<urn:amount>1000</urn:amount>
<urn:caseLookup>
<urn:CaseIdentification>CaseNumber</urn:CaseIdentification>
<urn:CaseIdentificationValue>523235</urn:CaseIdentificationValue>
</urn:caseLookup>
<urn:creditNoteInvoiceNumber>634634</urn:creditNoteInvoiceNumber>
<urn:originalInvoiceNumber>634</urn:originalInvoiceNumber>
</urn:MatchCreditNote>
</soapenv:Body>
</soapenv:Envelope>Input
-
request Mandatory
Request dataObjectMatchCreditNoteMatchCreditNote-
amount
Value corresponding to credit note amount.decimal -
caseLookup
Information to lookup case.ObjectCaseLookupThe way to find a collection case in DB by several predefined criteria.-
CaseIdentification Mandatory
Collection case identification type.EnumCaseIdentificationTypeCollection case identification type.-
CaseGuidCase GUID identification. -
CaseNumberCase number. -
AccountReferenceNumberAccount reference number provided by the client. -
InvoiceNumberInvoice number of one on the debts provided by the client. -
PaymentReferenceNumberPayment reference number (OCR). -
CustomerNoCustomer number for the debtor at the creditor side.
-
-
CaseIdentificationValue Mandatory
Identification value corresponding to identification type.string
-
-
creditNoteInvoiceNumber
Value corresponding to credit note invoice number.string -
originalInvoiceNumber
Value corresponding to original invoice number.string
-
Output
0 if credit note is matched.
Error codes:
- 30701: collection account generic error
MatchCreditNoteResponse
-
MatchCreditNoteResult
Result of MatchCreditNoteObjectGeneralResultA general result containing a result with result code and result text.-
Result
The result of the request.ObjectResultTypeCommon result type.-
ResultCode Mandatory
The result code0means 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
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
CollectionUpdateClient client = new CollectionUpdateClient();
try
{
GeneralResult result = client.Ping();
if (result.Result.ResultCode != 0)
{
throw new Exception(result.Result.ResultText ?? "Unknown error");
}
}
catch(Exception e)
{
throw new Exception("Failed to ping collection update service.", e);
}
Sample soap request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
<soapenv:Header/>
<soapenv:Body>
<urn:Ping/>
</soapenv:Body>
</soapenv:Envelope>Input
-
request Mandatory
Request dataObjectPingPing
Output
0 if ping was successful, otherwise read result text for error information.
GeneralResultResponse
-
GeneralResult
Result of GeneralResultObjectGeneralResultA general result containing a result with result code and result text.-
Result
The result of the request.ObjectResultTypeCommon result type.-
ResultCode Mandatory
The result code0means 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
-
-
PostActionEvent
eventCode and eventArgument are considered in this action packageExamples
CollectionUpdateClient client = new CollectionUpdateClient();
GeneralResult result = client.PostActionEvent(
new CaseLookup { CaseIdentification = CaseIdentificationType.CaseNumber, CaseIdentificationValue = "7" },
"someCustomEventCode",
"someCustomEventArgumentValue"
);
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:PostActionEvent>
<urn:CaseLookup>
<urn:CaseIdentification>CaseNumber</urn:CaseIdentification>
<urn:CaseIdentificationValue>7</urn:CaseIdentificationValue>
</urn:CaseLookup>
<urn:eventArgument>someCustomEventArgumentValue.</urn:eventArgument>
<urn:eventCode>someCustomEventCode</urn:eventCode>
</urn:PostActionEvent>
</soapenv:Body>
</soapenv:Envelope>Input
-
request Mandatory
Request dataObjectPostActionEventPostActionEvent.-
caseLookup
Information to lookup case(s).ObjectCaseLookupThe way to find a collection case in DB by several predefined criteria.-
CaseIdentification Mandatory
Collection case identification type.EnumCaseIdentificationTypeCollection case identification type.-
CaseGuidCase GUID identification. -
CaseNumberCase number. -
AccountReferenceNumberAccount reference number provided by the client. -
InvoiceNumberInvoice number of one on the debts provided by the client. -
PaymentReferenceNumberPayment reference number (OCR). -
CustomerNoCustomer number for the debtor at the creditor side.
-
-
CaseIdentificationValue Mandatory
Identification value corresponding to identification type.string
-
-
eventArgument
Value corresponding to custom event argument in action package handling.string -
eventCode
Value corresponding to custom event name in action package handling.string
-
Output
0 if collection case custom event is triggered.
Error codes:
- 30701: collection account generic error
PostActionEventResponse
-
PostActionEventResult
Result of PostActionEvent.ObjectGeneralResultA general result containing a result with result code and result text.-
Result
The result of the request.ObjectResultTypeCommon result type.-
ResultCode Mandatory
The result code0means 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
-
-
RemoveCreditNote
Examples
CollectionUpdateClient client = new CollectionUpdateClient();
GeneralResult result = client.RemoveCreditNote(
new CaseLookup { CaseIdentification = CaseIdentificationType.CaseNumber, CaseIdentificationValue = "7" },
"e657a351-ae8c-42c5-b083-ebe5dcda5c0b",
"423"
);
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:RemoveCreditNote>
<urn:caseLookup>
<urn:CaseIdentification>CaseNumber</urn:CaseIdentification>
<urn:CaseIdentificationValue>523235</urn:CaseIdentificationValue>
</urn:caseLookup>
<urn:creditNoteInvoiceNumber>12345</urn:creditNoteInvoiceNumber>
<urn:debtGuid>e657a351-ae8c-42c5-b083-ebe5dcda5c0b</urn:debtGuid>
</urn:RemoveCreditNote>
</soapenv:Body>
</soapenv:Envelope>Input
-
request Mandatory
Request dataObjectRemoveCreditNoteRemove credit note.-
caseLookup
Information to lookup case.ObjectCaseLookupThe way to find a collection case in DB by several predefined criteria.-
CaseIdentification Mandatory
Collection case identification type.EnumCaseIdentificationTypeCollection case identification type.-
CaseGuidCase GUID identification. -
CaseNumberCase number. -
AccountReferenceNumberAccount reference number provided by the client. -
InvoiceNumberInvoice number of one on the debts provided by the client. -
PaymentReferenceNumberPayment reference number (OCR). -
CustomerNoCustomer number for the debtor at the creditor side.
-
-
CaseIdentificationValue Mandatory
Identification value corresponding to identification type.string
-
-
creditNoteInvoiceNumber
Value corresponding to credit note invoice number.string -
debtGuid
Uuid of the credit note debtstring
-
Output
0 if credit note is deleted.
Error codes:
- 30701: collection account generic error
RemoveCreditNoteResponse
-
RemoveCreditNoteResult
Result of RemoveCreditNoteObjectGeneralResultA general result containing a result with result code and result text.-
Result
The result of the request.ObjectResultTypeCommon result type.-
ResultCode Mandatory
The result code0means 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
-
-
RevokeCase
Examples
CollectionUpdateClient client = new CollectionUpdateClient();
GeneralResult result = client.RevokeCase(
new CaseLookup { CaseIdentification = CaseIdentificationType.CaseNumber, CaseIdentificationValue = "7" },
"PAIDINFULL",
"This collection case has already been paid."
);
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:RevokeCase>
<urn:CaseLookup>
<urn:CaseIdentification>CaseNumber</urn:CaseIdentification>
<urn:CaseIdentificationValue>7</urn:CaseIdentificationValue>
</urn:CaseLookup>
<urn:code>PAIDINFULL</urn:code>
<urn:reason>This collection case has already been paid.</urn:reason>
</urn:RevokeCase>
</soapenv:Body>
</soapenv:Envelope>Input
-
request Mandatory
Request dataObjectRevokeCaseRevokeCase.-
caseLookup
Information to lookup case(s).ObjectCaseLookupThe way to find a collection case in DB by several predefined criteria.-
CaseIdentification Mandatory
Collection case identification type.EnumCaseIdentificationTypeCollection case identification type.-
CaseGuidCase GUID identification. -
CaseNumberCase number. -
AccountReferenceNumberAccount reference number provided by the client. -
InvoiceNumberInvoice number of one on the debts provided by the client. -
PaymentReferenceNumberPayment reference number (OCR). -
CustomerNoCustomer number for the debtor at the creditor side.
-
-
CaseIdentificationValue Mandatory
Identification value corresponding to identification type.string
-
-
code
A predefined closure code. These are customized in each system and could e.g. be:- PAIDINFULL
- RETRIEVED
- BANKRUPTCY
- PREPAID
- PAID
- CREDITED
- DECEASED
string -
reason
Short description of reason for returning collection case.string
-
Output
0 if collection case is returned.
Error codes:
- 30701: collection account generic error
RevokeCaseResponse
-
RevokeCaseResult
Result of RevokeCase.ObjectGeneralResultA general result containing a result with result code and result text.-
Result
The result of the request.ObjectResultTypeCommon result type.-
ResultCode Mandatory
The result code0means 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
-
-
UpdateObject
Examples
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
<soapenv:Header/>
<soapenv:Body>
<urn:UpdateObject>
<urn:creditorReference>1</urn:creditorReference>
<urn:fields>
<urn:field>
<urn:Name></urn:Name>
<urn:value></urn:Value>
<urn:Field>
<urn:Fields>
<urn:objectReference>1234</urn:objectReference>
<urn:type>SITE</urn:type>
</urn:UpdateObject>
</soapenv:Body>
</soapenv:Envelope>Input
-
request Mandatory
Request data.ObjectUpdateObjectUpdateObject.-
creditorReference
Creditor reference.string -
fields
Object fields.ArrayObjectFieldExtra field contains custom data.-
Name Mandatory
Name of field.string -
Value Mandatory
Value of field.string
-
-
objectReference
Object reference.string -
type
Object type.string
-
Output
Error codes:
- 20500: Customer not found
UpdateObjectResponse
-
ResultType
Result of UpdateObject.ObjectResultTypeCommon result type.-
ResultCode Mandatory
The result code0means 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
-