API docs by Redocly

Aptic API Gateway - Cases (v1.0)

Download OpenAPI specification:Download

Aptic AB: api@aptic.net URL: https://www.aptic.net Terms of Service

Debt collection case related API for Aptic solutions

Cases

Get cases using filters

Authorizations:
(oauth2apikey)
query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Creates new cases

Authorizations:
(oauth2apikey)
query Parameters
async
boolean

Specify if the import should be performed asynchronously, default is true

Request Body schema:

Array of one or more cases

Array
caseNumber
string or null

Case number.

clientReferenceNumber
string or null

Party reference code.

clientGuid
string or null

Party reference guid.

currencyCode
string or null

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

receivedFrom
string or null

Party or user registering the case.

referenceNumber
string or null

Additional reference number.

deliverySystemCode
string or null

Optional delivery system code

description
string or null

Case description.

paymentReferenceNumber
string or null

Payment reference for case (OCR)

originalClaimantName
string or null

Name of original claimant

service
string or null

Collection account service, e.g. PreCollection, Collection, or Surveillance

claimType
string or null

Customer specific code for the claim type of the case

legalClaimType
string or null

Legal claim type for the case, e.g. 0412, 0440, 0520, etc. for Finland

protected
boolean or null

Treat this case as protected with special access required

stopPayments
boolean or null

Prevent payments from automatic booking on this case

prohibitTrustAccounting
boolean or null

Prevent trust accounting on this case

reportPaidInterest
boolean or null

Report paid interest for this case. Is decided by default parameters if not provided.

reportPaidInterestFrom
string or null <date-time>

Which date paid interest should be reported from in CLVR

feeBasePrincipalAmount
number or null <double>

Principal amount to base some fee calculations on, e.g. the WIK fee

highCostCredit
boolean or null

Specifies if the debt is a high cost credit

highCostCreditAmount
number or null <double>

Specifies the high cost credit amount

highCostCreditUsedAmount
number or null <double>

Specifies how much that has beed used of the high cost credit amount

creditRegistryStatus
integer or null <int32>

Specifies if the status of the debt in national credit registry

0 = Do not register

1 = Register

2 = Already registered

3 = Terminated

4 = Recalled

creditRegistrySubmissionDate
string or null <date-time>

Date and time when the debt was submitted to the national credit registry

Array of objects or null (PutCaseDebtor)

All debtors in the case

Array of objects or null (PutCaseDebt)

All debts/invoices/claims in the case

Array of objects or null (PutCaseFee)

All existing fees for the claim in the case

object (PutCaseClaimant)

The actual claimant of the debt

object (PutCaseEnergyDebt)

Additional information for utility debts

Array of objects or null (PutCaseRelation)

Other parties related to the case, like a field collector

Array of objects or null (PutCaseActionDate)

Important events already happened in the case

Array of objects or null (ExtraFieldValue)

Additional extra fields in the case. Needs to already be defined in CLVR.

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "caseGuids": [
    ],
  • "impStockId": 0
}

Get case details.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The GUID representing the case.

Responses

Response samples

Content type
{
  • "caseNumber": "string",
  • "clientName": "string",
  • "clientReferenceNumber": "string",
  • "closureCode": "string",
  • "closureDate": "2019-08-24T14:15:22Z",
  • "currencyCode": "string",
  • "description": "string",
  • "originalFee": 0,
  • "originalInterest": 0,
  • "originalPrincipal": 0,
  • "originalSum": 0,
  • "paidFee": 0,
  • "paidInterest": 0,
  • "paidPrincipal": 0,
  • "paidSum": 0,
  • "paidToThirdParty": 0,
  • "paymentReferenceNumber": "string",
  • "remainingFee": 0,
  • "remainingInterest": 0,
  • "remainingPrincipal": 0,
  • "remainingSum": 0,
  • "service": "string",
  • "status": "string",
  • "subStatus": "string",
  • "registrationDate": "2019-08-24T14:15:22Z",
  • "links": [
    ]
}

Updates a case

Authorizations:
(oauth2apikey)
path Parameters
caseGuid
required
string
Request Body schema:
description
string or null

Case description.

paymentReferenceNumber
string or null

OCR-number for case.

protected
boolean or null

Treat this case as protected with special access required

prohibitTrustAccounting
boolean or null

Prevent trust accounting on this case

stopPayments
boolean or null

Prevent payments from automatic booking on this case

service
string or null

Collection account service.

status
string or null

Collection account status.

subStatus
string or null

Collection account substatus.

Responses

Request samples

Content type
{
  • "description": "string",
  • "paymentReferenceNumber": "string",
  • "protected": true,
  • "prohibitTrustAccounting": true,
  • "stopPayments": true,
  • "service": "string",
  • "status": "string",
  • "subStatus": "string"
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Deletes a case

Authorizations:
(oauth2apikey)
path Parameters
caseGuid
required
string

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Get case debts using filters

Authorizations:
(oauth2apikey)
path Parameters
caseGuid
required
string

Case guid

query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Adds a new debt to the case

Authorizations:
(oauth2apikey)
path Parameters
caseGuid
required
string

Case guid

Request Body schema:

Debt object

description
string or null

Description of the invoice/claim

referenceNumber
string or null

Reference number of the claim, e.g. the invoice number

ledgerRef
string or null

Reference number of the claim in the client ledger

debtGroup
string or null

The code for the specific group of debts, as defined in CLVR

ourReference
string or null

Our reference on the invoice

yourReference
string or null

Your reference on the invoice

currencyCode
string or null

Currency code of the claim, e.g. SEK, NOK, EUR etc.

originalPrincipal
number or null <double>

Original invoice principal amount

remainingPrincipal
number <double>

Remaining principal amount of the claim

originalInterest
number or null <double>

Total accrued interest of the claim

remainingInterest
number or null <double>

Remaining accrued interest of the claim until specified date

originalVAT
number or null <double>

Original invoice VAT amount

remainingVAT
number or null <double>

Remaining VAT amount of the claim

exchRate
number or null <double>

Exchange rate used for the invoice

exchDate
string or null <date-time>

Exchange date used for the invoice

billDate
string <date-time>

Invoice or claim date

dueDate
string or null <date-time>

Due date for the invoice/claim

paymentCondition
integer or null <int32>

Payment condition as number of days between bill date and due date

interestCondition
integer or null <int32>

Number of days after bill date when interest calculation starts

interestRate
number or null <double>

Interest rate

interestCode
string or null

Interest code as defined in CLVR, e.g. FIXED, ÖGR, F_365_BASE

interestSpecificCalculationType
string or null

Activates specific interest calculation in CLVR, e.g. FI-B2C and FI-B2B

interestSpecificCalculationCutoffDate
string or null <date-time>

Cut-off date for specific interest calculation in CLVR

fixedInterestTermStart
string or null <date-time>

Fixing date for current fixed interest term

interestFrom
string or null <date-time>

Date when current interest started to be calculated

interestTo
string or null <date-time>

Date up until interest has been calculated

accountRefType
string or null

Account reference type

oneTimeServiceFees
number or null <double>

Onetime service fees

loanPurpose
string or null

The purpose of the loan, valid codes:

HomeLoan, HomeLoanForFirstHome, HomeLoanForLeisureHouse, HomeLoanForInvestmentPurposes, StudentLoan, LoanForPurchaseOfVehicleOrCraft, OtherConsumerCredit, OtherLoan, LoanForBusinessActivities, GuaranteeReceivable

loanTypeCode
string or null

The type of loan, valid codes:

LumpSumLoan, RunningAccountLoan, Leasing, GuaranteeReceivable

agreementDate
string or null <date-time>

Date for the agreement on which the claim is based on

agreementDueDate
string or null <date-time>

Due date for the agreement on which the claim is based on

agreementEndDate
string or null <date-time>

End date for the agreement on which the claim is based on

enforceableDebtType
string or null

Enforcable debt type, as defined in CLVR

goodsRelatedCredit
boolean or null

Is the claim a credit rated to goods

effectiveYear
integer or null <int32>

Effective year of the claim

debtPrincipalType
string or null

Optional debt principal type, valid codes:

INVOICE, CREDIT_INVOICE, INTEREST_INVOICE, FINAL_INVOICE_CREDITDEBT, OFFER_INVOICE, BILLING, CAPITALIZED_INTEREST, INTEREST_COMPENSATION, TERMINATED_ACCOUNT, PREREDEMPTION, LOAN_INTEREST, SUPPLIER_INVOICE, CREDIT_EXPENSE

grantedCreditAmount
number or null <double>

Granted credit amount

usedCreditAmount
number or null <double>

Used credit amount or the original granted amount

originalEir
number or null <double>

Original EIR

lenderName
string or null

Original lender name of the loan

periodOfLimitation
string or null

Period of limitation

limitationDate
string or null <date-time>

Claim's limitation date

Array of objects or null (ExtraFieldValue)

Additional extra fields for the debt. Needs to already be defined in CLVR.

interestRateCeilingCode
string or null

Interest ceiling code

agreedInterestCode
string or null

Agreed interest code

agreedInterestRate
number or null <double>

Agreed interest rate

Responses

Request samples

Content type
{
  • "description": "string",
  • "referenceNumber": "string",
  • "ledgerRef": "string",
  • "debtGroup": "string",
  • "ourReference": "string",
  • "yourReference": "string",
  • "currencyCode": "string",
  • "originalPrincipal": 0,
  • "remainingPrincipal": 0,
  • "originalInterest": 0,
  • "remainingInterest": 0,
  • "originalVAT": 0,
  • "remainingVAT": 0,
  • "exchRate": 0,
  • "exchDate": "2019-08-24T14:15:22Z",
  • "billDate": "2019-08-24T14:15:22Z",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "paymentCondition": 0,
  • "interestCondition": 0,
  • "interestRate": 0,
  • "interestCode": "string",
  • "interestSpecificCalculationType": "string",
  • "interestSpecificCalculationCutoffDate": "2019-08-24T14:15:22Z",
  • "fixedInterestTermStart": "2019-08-24T14:15:22Z",
  • "interestFrom": "2019-08-24T14:15:22Z",
  • "interestTo": "2019-08-24T14:15:22Z",
  • "accountRefType": "string",
  • "oneTimeServiceFees": 0,
  • "loanPurpose": "string",
  • "loanTypeCode": "string",
  • "agreementDate": "2019-08-24T14:15:22Z",
  • "agreementDueDate": "2019-08-24T14:15:22Z",
  • "agreementEndDate": "2019-08-24T14:15:22Z",
  • "enforceableDebtType": "string",
  • "goodsRelatedCredit": true,
  • "effectiveYear": 0,
  • "debtPrincipalType": "string",
  • "grantedCreditAmount": 0,
  • "usedCreditAmount": 0,
  • "originalEir": 0,
  • "lenderName": "string",
  • "periodOfLimitation": "string",
  • "limitationDate": "2019-08-24T14:15:22Z",
  • "extraFields": [
    ],
  • "interestRateCeilingCode": "string",
  • "agreedInterestCode": "string",
  • "agreedInterestRate": 0
}

Response samples

Content type
{
  • "description": "string",
  • "referenceNumber": "string",
  • "ledgerRef": "string",
  • "debtGroup": "string",
  • "ourReference": "string",
  • "yourReference": "string",
  • "currencyCode": "string",
  • "originalPrincipal": 0,
  • "remainingPrincipal": 0,
  • "originalInterest": 0,
  • "remainingInterest": 0,
  • "originalVAT": 0,
  • "remainingVAT": 0,
  • "exchRate": 0,
  • "exchDate": "2019-08-24T14:15:22Z",
  • "billDate": "2019-08-24T14:15:22Z",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "paymentCondition": 0,
  • "interestCondition": 0,
  • "interestRate": 0,
  • "interestCode": "string",
  • "interestSpecificCalculationType": "string",
  • "interestSpecificCalculationCutoffDate": "2019-08-24T14:15:22Z",
  • "fixedInterestTermStart": "2019-08-24T14:15:22Z",
  • "interestFrom": "2019-08-24T14:15:22Z",
  • "interestTo": "2019-08-24T14:15:22Z",
  • "accountRefType": "string",
  • "oneTimeServiceFees": 0,
  • "loanPurpose": "string",
  • "loanTypeCode": "string",
  • "agreementDate": "2019-08-24T14:15:22Z",
  • "agreementDueDate": "2019-08-24T14:15:22Z",
  • "agreementEndDate": "2019-08-24T14:15:22Z",
  • "enforceableDebtType": "string",
  • "goodsRelatedCredit": true,
  • "effectiveYear": 0,
  • "debtPrincipalType": "string",
  • "grantedCreditAmount": 0,
  • "usedCreditAmount": 0,
  • "originalEir": 0,
  • "lenderName": "string",
  • "periodOfLimitation": "string",
  • "limitationDate": "2019-08-24T14:15:22Z",
  • "extraFields": [
    ],
  • "interestRateCeilingCode": "string",
  • "agreedInterestCode": "string",
  • "agreedInterestRate": 0
}

Get case debt details based on the case Guid and the debt Guid

Authorizations:
(oauth2apikey)
path Parameters
caseGuid
required
string

The unique GUID of the case

debtGuid
required
string

The unique GUID of the debt

Responses

Response samples

Content type
{
  • "debtGuid": "string",
  • "registrationDate": "2019-08-24T14:15:22Z",
  • "debtGroup": "string",
  • "debtPrincipalType": "string",
  • "description": "string",
  • "accountRef": "string",
  • "oldAccountRef": "string",
  • "ledgerRef": "string",
  • "objectRef": "string",
  • "originalPaymentReference": "string",
  • "currencyCode": "string",
  • "originalPrincipal": 0,
  • "remainingPrincipal": 0,
  • "originalInterest": 0,
  • "remainingInterest": 0,
  • "originalVAT": 0,
  • "remainingVAT": 0,
  • "exchRate": 0,
  • "exchDate": "2019-08-24T14:15:22Z",
  • "vatRate": 0,
  • "vatCode": "string",
  • "interestRate": 0,
  • "interestCode": "string",
  • "calcRate": 0,
  • "interestFrom": "2019-08-24T14:15:22Z",
  • "interestTo": "2019-08-24T14:15:22Z",
  • "fixedInterestTermStart": "2019-08-24T14:15:22Z",
  • "interestStop": "2019-08-24T14:15:22Z",
  • "interestSpecificCalculationType": "string",
  • "interestSpecificCalculationCutoffDate": "2019-08-24T14:15:22Z",
  • "accountRefType": "string",
  • "agreementDate": "2019-08-24T14:15:22Z",
  • "agreementDueDate": "2019-08-24T14:15:22Z",
  • "agreementEndDate": "2019-08-24T14:15:22Z",
  • "originalEir": 0,
  • "interestRateCeilingCode": "string",
  • "head": {
    },
  • "links": [
    ]
}

Updates a debt

Authorizations:
(oauth2apikey)
path Parameters
caseGuid
required
string

Case guid

debtGuid
required
string

Debt guid

Request Body schema:

Updated debt fields

description
string or null

Description of the invoice/claim

referenceNumber
string or null

Reference number of the claim, e.g. the invoice number

debtGroup
string or null

The code for the specific group of debts, as defined in CLVR

ourReference
string or null

Our reference on the invoice

yourReference
string or null

Your reference on the invoice

dueDate
string or null <date-time>

Due date for the invoice/claim

paymentCondition
integer or null <int32>

Payment condition as number of days between bill date and due date

accountRefType
string or null

Account reference type

accountRef
string or null

Account reference

oneTimeServiceFees
number or null <double>

Onetime service fees

loanPurpose
string or null

The purpose of the loan, valid codes:

HomeLoan, HomeLoanForFirstHome, HomeLoanForLeisureHouse, HomeLoanForInvestmentPurposes, StudentLoan, LoanForPurchaseOfVehicleOrCraft, OtherConsumerCredit, OtherLoan, LoanForBusinessActivities, GuaranteeReceivable

loanTypeCode
string or null

The type of loan, valid codes:

LumpSumLoan, RunningAccountLoan, Leasing, GuaranteeReceivable

agreementDate
string or null <date-time>

Date for the agreement on which the claim is based on

agreementDueDate
string or null <date-time>

Due date for the agreement on which the claim is based on

agreementEndDate
string or null <date-time>

End date for the agreement on which the claim is based on

enforceableDebtType
string or null

Enforcable debt type, as defined in CLVR

goodsRelatedCredit
boolean or null

Is the claim a credit rated to goods

effectiveYear
integer or null <int32>

Effective year of the claim

debtPrincipalType
string or null

Optional debt principal type, valid codes:

INVOICE, CREDIT_INVOICE, INTEREST_INVOICE, FINAL_INVOICE_CREDITDEBT, OFFER_INVOICE, BILLING, CAPITALIZED_INTEREST, INTEREST_COMPENSATION, TERMINATED_ACCOUNT, PREREDEMPTION, LOAN_INTEREST, SUPPLIER_INVOICE, CREDIT_EXPENSE

grantedCreditAmount
number or null <double>

Granted credit amount

usedCreditAmount
number or null <double>

Used credit amount or the original granted amount

originalEir
number or null <double>

Original EIR

lenderName
string or null

Original lender name of the loan

interestRateCeilingCode
string or null

Interest ceiling code

agreedInterestCode
string or null

Agreed interest code

agreedInterestRate
number or null <double>

Agreed interest rate

interestSpecificCalculationType
string or null

Interest Specific Calculation Type

Responses

Request samples

Content type
{
  • "description": "string",
  • "referenceNumber": "string",
  • "debtGroup": "string",
  • "ourReference": "string",
  • "yourReference": "string",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "paymentCondition": 0,
  • "accountRefType": "string",
  • "accountRef": "string",
  • "oneTimeServiceFees": 0,
  • "loanPurpose": "string",
  • "loanTypeCode": "string",
  • "agreementDate": "2019-08-24T14:15:22Z",
  • "agreementDueDate": "2019-08-24T14:15:22Z",
  • "agreementEndDate": "2019-08-24T14:15:22Z",
  • "enforceableDebtType": "string",
  • "goodsRelatedCredit": true,
  • "effectiveYear": 0,
  • "debtPrincipalType": "string",
  • "grantedCreditAmount": 0,
  • "usedCreditAmount": 0,
  • "originalEir": 0,
  • "lenderName": "string",
  • "interestRateCeilingCode": "string",
  • "agreedInterestCode": "string",
  • "agreedInterestRate": 0,
  • "interestSpecificCalculationType": "string"
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Deletes a debt from the case

Authorizations:
(oauth2apikey)
path Parameters
caseGuid
required
string

Case guid

debtGuid
required
string

Debt guid

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Adjust amounts on a debt

Authorizations:
(oauth2apikey)
path Parameters
caseGuid
required
string

Case guid

debtGuid
required
string

Debt guid

Request Body schema:

Amount adjustment

principalAdjustment
number or null <double>

Amount to adjust the principal with

interestAdjustment
number or null <double>

Amount to adjust the interest with

transSpecTypeCode
string or null

Specifies the type of transaction, available codes can be fetched using /v1/Metadata/Transspectype

note
string or null

Optional note for the adjustment

Responses

Request samples

Content type
{
  • "principalAdjustment": 0,
  • "interestAdjustment": 0,
  • "transSpecTypeCode": "string",
  • "note": "string"
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Get case fees using filters

Authorizations:
(oauth2apikey)
path Parameters
caseGuid
required
string

Case guid

query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Adds a new fee to the case

Authorizations:
(oauth2apikey)
path Parameters
caseGuid
required
string

Case guid

Request Body schema:

Fee object

name
string or null

Name of the fee as defined in CLVR, e.g. REMIND, INKVARSEL, KK

description
string or null

Description of the invoice/claim

feeDate
string or null <date-time>

Date when the fee was added to the claim

currencyCode
string or null

Currency code of the fee, e.g. SEK, NOK, EUR etc.

originalPrincipal
number or null <double>

Original invoice principal amount

remainingPrincipal
number or null <double>

Remaining principal amount of the claim

interestRate
number or null <double>

Interest rate

interestCode
string or null

Interest code as defined in CLVR, e.g. FIXED, ÖGR, F_365_BASE

interestFrom
string or null <date-time>

Date when current interest started to be calculated

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "feeDate": "2019-08-24T14:15:22Z",
  • "currencyCode": "string",
  • "originalPrincipal": 0,
  • "remainingPrincipal": 0,
  • "interestRate": 0,
  • "interestCode": "string",
  • "interestFrom": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "feeDate": "2019-08-24T14:15:22Z",
  • "currencyCode": "string",
  • "originalPrincipal": 0,
  • "remainingPrincipal": 0,
  • "interestRate": 0,
  • "interestCode": "string",
  • "interestFrom": "2019-08-24T14:15:22Z"
}

Get case fee details based on the case Guid and the fee Guid

Authorizations:
(oauth2apikey)
path Parameters
caseGuid
required
string

The unique GUID of the case

feeGuid
required
string

The unique GUID of the fee

Responses

Response samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "feeDate": "2019-08-24T14:15:22Z",
  • "currencyCode": "string",
  • "originalPrincipal": 0,
  • "remainingPrincipal": 0,
  • "originalInterest": 0,
  • "remainingInterest": 0,
  • "originalVAT": 0,
  • "remainingVAT": 0,
  • "interestRate": 0,
  • "interestCode": "string",
  • "interestFrom": "2019-08-24T14:15:22Z",
  • "interestTo": "2019-08-24T14:15:22Z"
}

Updates a debt

Authorizations:
(oauth2apikey)
path Parameters
caseGuid
required
string

Case guid

feeGuid
required
string

Fee guid

Request Body schema:

Updated fee fields

description
string or null

Description of the invoice/claim

Responses

Request samples

Content type
{
  • "description": "string"
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Deletes a fee from the case

Authorizations:
(oauth2apikey)
path Parameters
caseGuid
required
string

Case guid

feeGuid
required
string

Fee guid

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Adjust amounts on a fee

Authorizations:
(oauth2apikey)
path Parameters
caseGuid
required
string

Case guid

feeGuid
required
string

Fee guid

Request Body schema:

Amount adjustment

principalAdjustment
number or null <double>

Amount to adjust the principal with

interestAdjustment
number or null <double>

Amount to adjust the interest with

transSpecTypeCode
string or null

Specifies the type of transaction, available codes can be fetched using /v1/Metadata/Transspectype

note
string or null

Optional note for the adjustment

Responses

Request samples

Content type
{
  • "principalAdjustment": 0,
  • "interestAdjustment": 0,
  • "transSpecTypeCode": "string",
  • "note": "string"
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Get case payments using filters

Authorizations:
(oauth2apikey)
path Parameters
caseGuid
required
string

Case guid

query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Register a direct payment on the case

Authorizations:
(oauth2apikey)
path Parameters
caseGuid
required
string

Case guid

Request Body schema:

Payment information

paymentReference
string or null

Payment reference string

paymentDate
string <date-time>

Payment date

accountingDate
string or null <date-time>

Accounting date for G/L

paymentAmount
number <double>

Total paid amount

currencyCode
string or null

The currency the paid payment

receivedAmount
number or null <double>

Received amount in G/L currency

exchangeDate
string or null <date-time>

Date for currency exchange

source
string or null

Information of the origin of the payment

Array of objects or null (PaymentSpecOnCase)

Specification of invoices to pay

Responses

Request samples

Content type
{
  • "paymentReference": "string",
  • "paymentDate": "2019-08-24T14:15:22Z",
  • "accountingDate": "2019-08-24T14:15:22Z",
  • "paymentAmount": 0,
  • "currencyCode": "string",
  • "receivedAmount": 0,
  • "exchangeDate": "2019-08-24T14:15:22Z",
  • "source": "string",
  • "specification": [
    ]
}

Response samples

Content type
{
  • "paymentGuid": "string",
  • "paymentReference": "string",
  • "paymentDate": "2019-08-24T14:15:22Z",
  • "accountingDate": "2019-08-24T14:15:22Z",
  • "paymentAmount": 0,
  • "currencyCode": "string",
  • "receivedAmount": 0,
  • "exchangeDate": "2019-08-24T14:15:22Z",
  • "source": "string"
}

Get case payment details based on the case Guid and the payment Guid

Authorizations:
(oauth2apikey)
path Parameters
caseGuid
required
string

The unique GUID of the case

paymentGuid
required
string

The unique GUID of the payment

Responses

Response samples

Content type
{
  • "paymentGuid": "string",
  • "paymentDate": "2019-08-24T14:15:22Z",
  • "currencyCode": "string",
  • "paidAmount": 0,
  • "source": "string",
  • "paymentReference": "string",
  • "directPayment": true,
  • "paidBy": 0,
  • "amountNotDeducted": 0,
  • "totalAmountDeducted": 0,
  • "withdrawnCommission": 0,
  • "withdrawnVAT": 0,
  • "remittenceAmount": 0,
  • "commissionNettedOnCreditorAccount": 0,
  • "vatNettedOnCreditorAccount": 0,
  • "commissionToInvoice": 0,
  • "vatToInvoice": 0,
  • "specifications": [
    ],
  • "pledges": [
    ],
  • "links": [
    ]
}

Register a direct payment on the case

Authorizations:
(oauth2apikey)
path Parameters
caseGuid
required
string

Case guid

Request Body schema:

Payment information

closureCode
string or null

Specified closure code, e.g. RETRIEVED

note
string or null

Optional note regarding the closure

Responses

Request samples

Content type
{
  • "closureCode": "string",
  • "note": "string"
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Get case extra fields using filters

Authorizations:
(oauth2apikey)
path Parameters
caseGuid
required
string

Case guid

query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Creates a new case extra field

Authorizations:
(oauth2apikey)
path Parameters
caseGuid
required
string

Case guid

Request Body schema:

Extra field value

name
string or null

Name of Extra field data

value
Array of strings or null

The value of the extra field

Responses

Request samples

Content type
{
  • "name": "string",
  • "value": [
    ]
}

Response samples

Content type
{
  • "name": "string",
  • "value": [
    ]
}

Get case extra field details based on the unique GUID and extra field name

Authorizations:
(oauth2apikey)
path Parameters
caseGuid
required
string

The unique GUID of the case

name
required
string

The name of the extra field

Responses

Response samples

Content type
{
  • "name": "string",
  • "value": [
    ]
}

Updates a case extra field

Authorizations:
(oauth2apikey)
path Parameters
caseGuid
required
string

Case guid

name
required
string

Extrafield name

Request Body schema:

Extrafield value

name
string or null

Name of Extra field data

value
Array of strings or null

The value of the extra field

Responses

Request samples

Content type
{
  • "name": "string",
  • "value": [
    ]
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Deletes a case extra field

Authorizations:
(oauth2apikey)
path Parameters
caseGuid
required
string

Case guid

name
required
string

Extrafield name

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Get case documents using filters

Authorizations:
(oauth2apikey)
path Parameters
caseGuid
required
string

Case guid

query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Adds a document to the case

Authorizations:
(oauth2apikey)
path Parameters
caseGuid
required
string

Case guid

Request Body schema:

Document information

note
required
string non-empty

Free extra information related to the document.

documentType
string or null

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

loggedAt
string or null <date-time>

Document creation date.

originalFileName
required
string non-empty

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

searchValue
string or null

Document specific search value or reference number.

externalLink
string or null

Link to the document, if it exists on external archive.

important
boolean or null

Document importancy flag.

fileDataBase64
string or null

Base64-encoded file body.

Responses

Request samples

Content type
{
  • "note": "string",
  • "documentType": "string",
  • "loggedAt": "2019-08-24T14:15:22Z",
  • "originalFileName": "string",
  • "searchValue": "string",
  • "externalLink": "string",
  • "important": true,
  • "fileDataBase64": "string"
}

Response samples

Content type
{
  • "note": "string",
  • "documentType": "string",
  • "loggedAt": "2019-08-24T14:15:22Z",
  • "originalFileName": "string",
  • "important": true,
  • "links": [
    ]
}

Get case document details based on the unique GUID for case and document

Authorizations:
(oauth2apikey)
path Parameters
caseGuid
required
string

The unique GUID of the case

documentGuid
required
string

The unique GUID of the document

Responses

Response samples

Content type
{
  • "note": "string",
  • "documentType": "string",
  • "loggedAt": "2019-08-24T14:15:22Z",
  • "originalFileName": "string",
  • "important": true,
  • "links": [
    ]
}

Get case debtor summary.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The GUID representing the case.

Responses

Response samples

Content type
[
  • {
    }
]

Invokes a custom action based on a service definition.

Execute custom service definition in CLVR with possibility to pass in JSON into definition.

Authorizations:
(oauth2apikey)
path Parameters
caseGuid
required
string

Case unique id

serviceDefinition
required
string

The invoke service definition request.

query Parameters
async
boolean

Specify if custom action should be performed asynchronously

Request Body schema:

JSON body

any

Responses

Request samples

Content type
{
  • "name1": "string",
  • "name2": false,
  • "name3": {
    }
}

Response samples

Content type
{ }

Invokes a custom action based on a service definition.

Execute custom service definition in CLVR with possibility to pass in JSON into definition.

Authorizations:
(oauth2apikey)
path Parameters
serviceDefinition
required
string

The invoke service definition request.

query Parameters
async
boolean

Specify if custom action should be performed asynchronously

Request Body schema:

JSON body

any

Responses

Request samples

Content type
{
  • "name1": "string",
  • "name2": false,
  • "name3": {
    }
}

Response samples

Content type
{ }

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 code 200 and an empty json object.

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{ }