API Documentation "RivalREST" - Rival Inkassosystem

Activation

RivalREST is an add-on to Rival. Contact Rival Support for more information.

Versions and depricated functions

If there is a v2 or higher, previous versions will work until furhter notice. But they will not be developed.

Description

The following documentation outlines how to interact with the API, including the request and response structure in JSON for each endpoint. For a complete description of each request parameter and response field, click the expandable table below each JSON block.

Authentication: Certificate
Content-Type: application/json

Example POST Call

curl -X POST /Case \
  -H "Content-Type: application/json" \
  -d '{
    "OrgNo": "123456789",
    "Name": "John Doe",
    "ClientID": 123,
    "Invoices": [
      {
        "InvoiceDate": "2024-05-15",
        "DueDate": "2024-06-15",
        "PrincipalAmount": 10000,
        "InvoiceNo": "INV-1001"
      }
    ],
    "Notes": [
      {
        "Text": "Customer contacted regarding payment.",
        "Date": "2024-05-10",
        "UserName": "agent.smith",
        "ColourCode": 0
      }
    ]
  }'

Create Case (v1)

Creates a new debt collection case with debtor information, invoices, notes, and status details. Returns a unique CaseID upon success. This can also be used to update an existing case by passing ”CaseIDUpdate”. When using ”CaseIDUpdate” only the sub objects and arrays will be used. Not ”OrgNo”, ”Name”, ”Address”, etc.

Method: POST
URL: /v1/Case

Request

{  
    "CaseIDUpdate": "number",
    "CheckOrgNo": "boolean",
    "CheckDuplicates": "string",
    "Merge": "boolean",
    "GetAddress": "boolean",
    "OrgNo": "string",
    "Name": "string",
    "Address": "string",
    "CareOf": "string",
    "PostCode": "string",
    "PostTown": "string",
    "PhoneNumber1": "string",
    "Email": "string",
    "SoleTraderName": "string",
    "CustNo": "string",
    "CaseManager": "string",
    "RegistrationDate": "string",
    "ResponseAction": "string",
    "ClientID": "number",
    "ExtRefNo": "string",
    "StartDateResponseAction": "string",
    "CaseIDNew": "number",
    "PhoneNumber2": "string",
    "Country": "string",
    "PaymentPlacementCode": "string",
    "SourceOfCase": "string",
    "Currency": "string",
    "SourceOfAddress": "string",
    "TypeOfConsent": "string",
    "Collateral": "string",
    "BankAccountClearingNumber": "string",
    "BankAccountNumber": "string",
    "ExtraFields": {
        "ExtraField1": "string",
        "ExtraField2": "string",
        "ExtraField3": "string",
        "ExtraField4": "string",
        "ExtraField5": "string",
        "ExtraField6": "string",
        "ExtraField7": "string",
        "ExtraField8": "string",
        "ExtraField9": "string",
    },
    "Invoices": [
        {
            "InvoiceDate": "string",
            "DueDate": "string",
            "InterestType": "string",
            "InterestRate": "number",
            "PrincipalAmount": "number",
            "InvoiceNo": "string",
            "Description": "string",
            "ExtraText": "string",
            "RemainingPrincipalAmount": "number",
            "RemainingInterestAmount": "number",
            "InterestAccruedDate": "string"
        }
    ], 
    "Linkedfiles": [
        {
            "Date": "string",
            "DocBase64": "string",
            "DocType": "string",
            "Description": "string"
        }
    ],
    "Notes": [
       {
            "Text": "string",
            "Date": "string",
            "UserName": "string",
            "ColourCode": "number"
       }
    ],
    "Action": {
            "Date": "string",
            "Name": "string",
            "Separate": "boolean"
    },
    "Status": {
            "KravStatus": "string",
            "JurStatus": "string",
            "ExeStatus": "string",
            "OverStatus": "string",
            "ExeTitleType": "string",
            "ExeTitleDate": "string",
            "ExeTitleNo": "string",
            "ExeTitleTargetNo": "string",
            "LimitationInterruptCode": "string",
            "LimitationInterruptDate": "string",
            "LimitationInterruptInterval": "number",
            "LimitationDate": "string",
            "UNumber": "string",
            "Trader": "boolean",
            "ClosingDate": "string",
            "ClosingCode": "string",
            "BlockOCRPayments": "boolean",
            "GroundApplicationOrderToPay": "string",
            "ServiceOfProcessMessageIn": "boolean",
            "ServiceOfProcessMessageOut": "boolean"
    }
}

Request Parameters

Name	Type	Description
CheckOrgNo	boolean
CheckDuplicates	string	Allowed: ”ExtRefNo” \| ”ExtRefnoWithinClient” \| ”InvoicenoWithinClient”
Merge	boolean
GetAddress	boolean
OrgNo	string
Name	string
Address	string
CareOf	string
PostCode	string
PostTown	string
PhoneNumber1	string
Email	string
SoleTraderName	string
CustNo	string
CaseManager	string
RegistrationDate	string
ResponseAction	string
ClientID	number
ExtRefNo	string
StartDateResponseAction	string
CaseIDNew	number
PhoneNumber2	string
Country	string
CaseIDUpdate	number
PaymentPlacementCode	string
SourceOfCase	string
Currency	string
SourceOfAddress	string
TypeOfConsent	string
Collateral	string
BankAccountClearingNumber	string
BankAccountNumber	string
ExtraFields.ExtraField1	string
ExtraFields.ExtraField2	string
ExtraFields.ExtraField3	string
ExtraFields.ExtraField4	string
ExtraFields.ExtraField5	string
ExtraFields.ExtraField6	string
ExtraFields.ExtraField7	string
ExtraFields.ExtraField8	string
ExtraFields.ExtraField9	string
Invoices.InvoiceDate	string
Invoices.DueDate	string
Invoices.InterestType	string
Invoices.InterestRate	number
Invoices.PrincipalAmount	number
Invoices.InvoiceNo	string
Invoices.Description	string
Invoices.ExtraText	string
Invoices.RemainingPrincipalAmount	number
Invoices.RemainingInterestAmount	number
Invoices.InterestAccruedDate	string
Linkedfiles.Date	string
Linkedfiles.DocBase64	string
Linkedfiles.DocType	string
Linkedfiles.Description	string
Notes.Text	string
Notes.Date	string
Notes.UserName	string
Notes.ColourCode	number
Action.Date	string
Action.Name	string
Action.Separate	boolean	Separate action, not a chain. Default: false
Status.KravStatus	string
Status.JurStatus	string
Status.ExeStatus	string
Status.OverStatus	string
Status.ExeTitleType	string
Status.ExeTitleDate	string
Status.ExeTitleNo	string
Status.ExeTitleTargetNo	string
Status.LimitationInterruptCode	string
Status.LimitationInterruptDate	string
Status.LimitationInterruptInterval	number
Status.LimitationDate	string
Status.UNumber	string
Status.Trader	boolean
Status.ClosingDate	string
Status.ClosingCode	string
Status.BlockOCRPayments	string

Response

{
    "CaseID": "number",
    "ClientID": " number",
    "ExtRefNo": "string",
    "OrgNo": "string",
    "Name": "string",
    "RemainingPrincipalAmount": "number",
    "RemainingInterestAmount": "number",
    "RemainingCostAmount": "number",
    "KravStatus": "string",
    "JurStatus": "string",
    "ExeStatus": "string",
    "InstallmentPlan": "boolean",
    "NewOrMerged": "string",
    "Count": "number",
    "Info": "string" 
}

Response Data Fields

Name	Type	Description
CaseID	number	Unique ID of the created case
ClientID	number	Client’s unique ID
ExtRefNo	string	External reference number
OrgNo	string	Debtor’s organisation number
Name	string	Debtor’s name
RemainingPrincipalAmount	number	Outstanding principal amount
RemainingInterestAmount	number	Outstanding interest amount
RemainingCostAmount	number	Outstanding cost amount
KravStatus	string	Status of the claim
JurStatus	string	Legal status of the case
ExeStatus	string	Execution status of the case
InstallmentPlan	boolean	If there is an active installment plan
NewOrMerged	string	Indicates if case is new or merged
Count	number	Total number of related items
Info	string	Informational message

Create Case (v2)

Creates one or multiple new debt collection case(s) with debtor information, invoices (+rows), notes, and status details. Returns one or multiple unique CaseID(s) upon success. This can also be used to update one or multiple existing case(s) by passing ”CaseIDUpdate”. When using ”CaseIDUpdate” only the sub objects and arrays will be used. Not ”OrgNo”, ”Name”, ”Address”, etc.

Method: POST
URL: /v2/Case

Request

{
  "CheckOrgNo": "boolean",
  "CheckDuplicates": "string",
  "Merge": "boolean",
  "GetAddress": "boolean",
  "Cases": [  
    {
      "CaseIDUpdate": "number",
      "OrgNo": "string",
      "Name": "string",
      "Address": "string",
      "CareOf": "string",
      "PostCode": "string",
      "PostTown": "string",
      "PhoneNumber1": "string",
      "Email": "string",
      "SoleTraderName": "string",
      "CustNo": "string",
      "CaseManager": "string",
      "RegistrationDate": "string",
      "ResponseAction": "string",
      "ClientID": "number",
      "ExtRefNo": "string",
      "StartDateResponseAction": "string",
      "CaseIDNew": "number",
      "PhoneNumber2": "string",
      "Country": "string",
      "PaymentPlacementCode": "string",
      "SourceOfCase": "string",
      "Currency": "string",
      "SourceOfAddress": "string",
      "TypeOfConsent": "string",
      "Collateral": "string",
      "BankAccountClearingNumber": "string",
      "BankAccountNumber": "string",
      "ExtraFields": {
          "ExtraField1": "string",
          "ExtraField2": "string",
          "ExtraField3": "string",
          "ExtraField4": "string",
          "ExtraField5": "string",
          "ExtraField6": "string",
          "ExtraField7": "string",
          "ExtraField8": "string",
          "ExtraField9": "string",
      },
      "Invoices": [
          {
            "InvoiceDate": "string",
            "DueDate": "string",
            "InterestType": "string",
            "InterestRate": "number",
            "PrincipalAmount": "number",
            "InvoiceNo": "string",
            "Description": "string",
            "ExtraText": "string",
            "RemainingPrincipalAmount": "number",
            "RemainingInterestAmount": "number",
            "InterestAccruedDate": "string",
            "OurOrderno": "string",
            "YourOrderno": "string,
            "OurRef": "string,
            "YourRef": "string,
            "DeliveryAddress": "string",
            "RowsIncludesVAT": "boolean",
            "InterestFromDate": "string",
            "InvoiceRows": [
                {
                  "ProductCode": "string",
                  "ProductName": "string",
                  "Qty": "number",
                  "UnitPrice": "number",
                  "DiscountOnRowTotal": "number",
                  "RowTotal": "number",
                  "VATPct": "number",
                  "Unit": "string"
                }
            ],   
            "Parking":
              {
                "NationalityCode": "string",
                "NationalityName": "string",
                "RegistrationNumber": "string",
                "CheckTimeFrom": "string",
                "CheckTimeTo": "string",
                "SignsChecked": "boolean",
                "RoadMarksChecked": "boolean",
                "IsOwnerLookupPerformed": "boolean",
                "Vehicle":
                  {
                    "Type": 
                      {
                        "Code": "string",
                        "Name": "string"
                      },
                    "Make": 
                      {
                        "Code": "string",
                        "Name": "string"
                      }
                  },
                "Reason": 
                  {
                    "Code": "string",
                    "Name": "string"
                  },
                "Location": 
                  {
                    "Area": 
                      {
                        "Code": "C-042",
                        "Name": "Norra Hamngatan",
                        "Address": "Norra Hamngatan 1-15",
                        "PostalAddress": "Box 123, 432 10 Varberg",
                        "IsVatLiable": "boolean"
                      },
                    "AreaOwner": 
                      {
                        "Name": "Varbergs Kommun",
                        "Address": "Storgatan 1",
                        "PostalAddress": "Box 124, 432 11 Varberg",
                        "Contact": 
                          {
                            "PhoneNumber": "0340-12345",
                            "Email": "kontakt@varberg.se"
                          }
                      }
                  },
                "Officer": 
                  {
                    "ServiceNumber": "9512",
                    "Signature": "AA",
                    "Name": "Anna Andersson",
                    "Employer": 
                      {
                        "Name": "P-Bolaget AB",
                        "Address": "Industrivägen 5",
                        "PostalAddress": "Box 456, 432 12 Varberg",
                        "Contact": 
                          {
                            "PhoneNumber": "0340-67890",
                            "Email": "info@pbolaget.se"
                          }
                      }
                  }
              } 
          }
      ], 
      "Linkedfiles": [
          {
            "Date": "string",
            "DocBase64": "string",
            "DocType": "string",
            "Description": "string"
          }
      ],
      "Notes": [
          {
            "Text": "string",
            "Date": "string",
            "UserName": "string",
            "ColourCode": "number"
         }
      ],
      "Action": {
            "Date": "string",
            "Name": "string",
            "Separate": "boolean"
      },
      "Status": {
            "KravStatus": "string",
            "JurStatus": "string",
            "ExeStatus": "string",
            "OverStatus": "string",
            "ExeTitleType": "string",
            "ExeTitleDate": "string",
            "ExeTitleNo": "string",
            "ExeTitleTargetNo": "string",
            "LimitationInterruptCode": "string",
            "LimitationInterruptDate": "string",
            "LimitationInterruptInterval": "number",
            "LimitationDate": "string",
            "UNumber": "string",
            "Trader": "boolean",
            "ClosingDate": "string",
            "ClosingCode": "string",
            "BlockOCRPayments": "boolean",
            "GroundApplicationOrderToPay": "string",
            "ServiceOfProcessMessageIn": "boolean",
            "ServiceOfProcessMessageOut": "boolean"
      }
    }
  ]
}

Request Parameters

Name	Type	Description
CheckOrgNo	boolean
CheckDuplicates	string	Allowed: ”ExtRefNo” \| ”ExtRefnoWithinClient” \| ”InvoicenoWithinClient”
Merge	boolean
GetAddress	boolean
OrgNo	string
Name	string
Address	string
CareOf	string
PostCode	string
PostTown	string
PhoneNumber1	string
Email	string
SoleTraderName	string
CustNo	string
CaseManager	string
RegistrationDate	string
ResponseAction	string
ClientID	number
ExtRefNo	string
StartDateResponseAction	string
CaseIDNew	number
PhoneNumber2	string
Country	string
CaseIDUpdate	number
PaymentPlacementCode	string
SourceOfCase	string
Currency	string
SourceOfAddress	string
TypeOfConsent	string
Collateral	string
BankAccountClearingNumber	string
BankAccountNumber	string
ExtraFields.ExtraField1	string
ExtraFields.ExtraField2	string
ExtraFields.ExtraField3	string
ExtraFields.ExtraField4	string
ExtraFields.ExtraField5	string
ExtraFields.ExtraField6	string
ExtraFields.ExtraField7	string
ExtraFields.ExtraField8	string
ExtraFields.ExtraField9	string
Invoices.InvoiceDate	string
Invoices.DueDate	string
Invoices.InterestType	string
Invoices.InterestRate	number
Invoices.PrincipalAmount	number
Invoices.InvoiceNo	string
Invoices.Description	string
Invoices.ExtraText	string
Invoices.RemainingPrincipalAmount	number
Invoices.RemainingInterestAmount	number
Invoices.InterestAccruedDate	string
Linkedfiles.Date	string
Linkedfiles.DocBase64	string
Linkedfiles.DocType	string
Linkedfiles.Description	string
Notes.Text	string
Notes.Date	string
Notes.UserName	string
Notes.ColourCode	number
Action.Date	string
Action.Name	string
Action.Separate	boolean	Separate action, not a chain. Default: false
Status.KravStatus	string
Status.JurStatus	string
Status.ExeStatus	string
Status.OverStatus	string
Status.ExeTitleType	string
Status.ExeTitleDate	string
Status.ExeTitleNo	string
Status.ExeTitleTargetNo	string
Status.LimitationInterruptCode	string
Status.LimitationInterruptDate	string
Status.LimitationInterruptInterval	number
Status.LimitationDate	string
Status.UNumber	string
Status.Trader	boolean
Status.ClosingDate	string
Status.ClosingCode	string
Status.BlockOCRPayments	string

Response

[
  {
    "CaseID": "number",
    "ClientID": " number",
    "ExtRefNo": "string",
    "OrgNo": "string",
    "Name": "string",
    "RemainingPrincipalAmount": "number",
    "RemainingInterestAmount": "number",
    "RemainingCostAmount": "number",
    "KravStatus": "string",
    "JurStatus": "string",
    "ExeStatus": "string",
    "InstallmentPlan": "boolean",
    "NewOrMerged": "string",
    "Count": "number",
    "Info": "string"
  }
]

Response Data Fields

Name	Type	Description
CaseID	number	Unique ID of the created case
ClientID	number	Client’s unique ID
ExtRefNo	string	External reference number
OrgNo	string	Debtor’s organisation number
Name	string	Debtor’s name
RemainingPrincipalAmount	number	Outstanding principal amount
RemainingInterestAmount	number	Outstanding interest amount
RemainingCostAmount	number	Outstanding cost amount
KravStatus	string	Status of the claim
JurStatus	string	Legal status of the case
ExeStatus	string	Execution status of the case
InstallmentPlan	boolean	If there is an active installment plan
NewOrMerged	string	Indicates if case is new or merged
Count	number	Total number of related items
Info	string	Informational message

Create Client (v1)

Creates or updates a client in the system with organisation and contact information.

Method: POST
URL: /v1/Client

Request

{
    "ClientID": "number",
    "OrganisationNumber": "string",
    "Name": "string",
    "Address1": "string",
    "Address2": "string",
    "PostCode": "string",
    "PostTown": "string",
    "PhoneNumber1": "string",
    "PhoneNumber2": "string",
    "Email": "string",
    "ContactName1": "string",
    "ContactName2": "string",
    "PlusGiro": "string",
    "BankGiro": "string",
    "BankAccountClearingNumber": "string",
    "BankAccountNumber": "string",
    "VAT": "boolean",
    "DebtText": "string",
    "PaymentCondition": number,
    "InterestType": "string",
    "InterestRate": number,
    "SettlementCode": "string",
    "PeriodOfLimitation": "number",
    "InvoiceVAT": "boolean",
    "Note": "string"
}

Request Data Fields

Name	Type	Description
ClientID	number	Unique identifier for the client
OrganisationNumber	string	Organisation number (OrgNo)
Name	string	Client’s name
Address1	string	Primary address line
Address2	string	Secondary address line
PostCode	string	Postal code
PostTown	string	Town or city
PhoneNumber1	string	Main contact phone number
PhoneNumber2	string	Secondary contact phone number
Email	string	Contact email address
ContactName1	string	Primary contact person
ContactName2	string	Secondary contact person
PlusGiro	string	PlusGiro account number
BankGiro	string	BankGiro account number
BankAccountClearingNumber	string	Clearing number for bank account
BankAccountNumber	string	Bank account number
VAT	boolean	Whether client is VAT registered
DebtText	string	Debt description
PaymentCondition	number	Payment terms in days
InterestType	string	Type of interest applied
InterestRate	number	Interest rate percentage
SettlementCode	string	Settlement code identifier
PeriodOfLimitation	number	Period of limitation in years
InvoiceVAT	boolean	Indicates if invoices include VAT
Note	string	Additional notes

Response

{
    "ClientID": "number",
    "OrganisationNumber": "string",
    "Name": "string",
    "Address1": "string",
    "Address2": "string",
    "PostCode": "string",
    "PostTown": "string",
    "PhoneNumber1": "string", 
    "PhoneNumber2": "string",
    "Email": "string",
    "ContactName1": "string",
    "ContactName2": "string",
    "PlusGiro": "string",
    "BankGiro": "string",
    "BankAccountClearingNumber": "string",
    "BankAccountNumber": "string",
    "VAT": "boolean",
    "DebtText": "string",
    "PaymentCondition": number,
    "InterestType": "string",
    "InterestRate": number,
    "SettlementCode": "string",
    "PeriodOfLimitation": number,
    "InvoiceVAT": "boolean",
    "Note": "string"
}

Response Data Fields

Name	Type	Description
ClientID	number
OrganisationNumber	string
Name	string
Address1	string
Address2	string
PostCode	string
PostTown	string
PhoneNumber1	string
PhoneNumber2	string
Email	string
ContactName1	string
ContactName2	string
PlusGiro	string
BankGiro	string
BankAccountClearingNumber	string
BankAccountNumber	string
VAT	boolean
DebtText	string
PaymentCondition	number
InterestType	string
InterestRate	number
SettlementCode	string
PeriodOfLimitation	number
InvoiceVAT	boolean
Note	string

Create Payment (v1)

Registers a payment made towards a specific case. Requires payment details such as amount, method, and debtor information.

Method: POST
URL: /v1/Payment

Request

{
    "CaseID": "number",
    "Amount": "number",
    "PaymentMethod": "string",
    "AccountingDate": "string",
    "DebtorNo": "number",
    "Payer": "string",
    "BundleName": "string",
    "CurrAmount": "number",
    "PaymentCode": "string",
    "PaymentRef": "string"
}

Request Data Fields

Name	Type	Description
CaseID	number	ID of the case receiving the payment
Amount	number	Payment amount
PaymentMethod	string	Method of payment (e.g., BankTransfer, Card)
AccountingDate	string	Date for accounting purposes
DebtorNo	number	Debtor’s number
Payer	string	Name of the payer
BundleName	string	Batch or bundle reference name
CurrAmount	number	Amount in current currency
PaymentCode	string	Payment code identifier
PaymentRef	string	Payment reference number

Response

{
    "InbDatID": "number",
    "CaseID": "number",
    "Amount": "number",
    "PaymentMethod": "string",    
    "AccountingDate": "string",
    "DebtorNo": "number",
    "Payer": "string",
    "BundleName": "string",
    "CurrAmount": "number",
    "PaymentCode": "string",
    "PaymentRef": "string"
}

Response Data Fields

Name	Type	Description
InbDatID	number	Unique ID for the payment transaction
CaseID	number	ID of the related case
Amount	number	Registered payment amount
PaymentMethod	string	Method used for payment
AccountingDate	string	Accounting date for the payment
DebtorNo	number	Debtor’s identifier
Payer	string	Name of the payer
BundleName	string	Reference for payment batch
CurrAmount	number	Amount in current currency
PaymentCode	string	Payment code identifier
PaymentRef	string	Payment reference number

Retrieve Case (v1)

Retrieves a list of cases matching the provided search parameters. You can search by case ID, debtor number, organisation number, and more. Max 300 cases returned.

Method: GET
URL: /v1/Case

Request Example

curl -X GET "/Case?caseid=12345&filter=open"

Search Parameters

Name	Type	Description
caseid	number	Case ID to search for
DebtorNo	number	Debtor number
orgno	string	Organisation number (SSN)
psid	string	Process server ID (delgivningsman ID)
country	string	Country name (default: Sverige)
filter	string	Filter cases by status: open \| closed \| all (Default: open)

Response

[
    {
        "CaseID": "number",
        "DebtorNo": "number",
        "CaseIDLong": "string",
        "OCRNumber": "string",
        "ClientID": "number",
        "OrgNo": "string",
        "Name": "string",
        "Address": "string",
        "CareOf": "string",
        "PostCode": "string",
        "PostTown": "string",
        "Country": "string",
        "CaseManager": "string",
        "RegistrationDate": "string",
        "ExtRefNo": "string",
        "RemainingPrincipalAmount": "number",
        "RemainingInterestAmount": "number",
        "RemainingCostAmount": "number",
        "RemainingTotalAmount": "number",
        "KravStatus": "string",
        "JurStatus": "string",
        "ExeStatus": "string",
        "EndDate": "string",
        "EndReasonCode": "string",
        "EndReasonDescription": "string",
        "ServiceOfProcessMessageIn": "boolean",
        "ServiceOfProcessMessageOut": "boolean",
        "Invoices": [
            {
                "InvoiceNo": "string",
                "InvoiceDate": "string",
                "DueDate": "string",
                "Description": "string",
                "InterestType": "string",
                "InterestAddPct": "number",
                "InterestTotPct": "number",
                "RemainingPrincipalAmount": "number",
                "RemainingInterestAmount": "number",
                "RemainingTotalAmount": "number",
                "RemainingPrincipalAmountCurr": "number",
                "RemainingInterestAmountCurr": "number",
                "RemainingTotalAmountCurr": "number"
            }
        ],
        "Actions": [
            {
                "ActionID": "number",
                "Date": "string",
                "Type": "number",
                "Name": "string",
                "Text": "string",
                "Processed": "number"
                "Downloadable": "boolean"
            }
        ],
        "Installment": {
            "StandardPaymentAmount": "number",
            "PaymentIntervalDays": "number",
            "RemainingPayments": "number",
            "NextPaymentDate": "string",
            "NextPaymentAmount": "number"
        }
    }
]

Response Data Fields

Name	Type	Description
CaseID	number
DebtorNo	number
CaseIDLong	string
OCRNumber	string
ClientID	number
OrgNo	string
Name	string
Address	string
CareOf	string
PostCode	string
PostTown	string
Country	string
CaseManager	string
RegistrationDate	string
ExtRefNo	string
RemainingPrincipalAmount	number
RemainingInterestAmount	number
RemainingCostAmount	number
RemainingTotalAmount	number
KravStatus	string
JurStatus	string
ExeStatus	string
EndDate	string
EndReasonCode	string
EndReasonDescription	string
Invoices.InvoiceNo	string
Invoices.InvoiceDate	string
Invoices.DueDate	string
Invoices.Description	string
Invoices.InterestType	string
Invoices.InterestAddPct	number
Invoices.InterestTotPct	number
Invoices.RemainingPrincipalAmount	number
Invoices.RemainingInterestAmount	number
Invoices.RemainingTotalAmount	number
Invoices.RemainingPrincipalAmountCurr	number
Invoices.RemainingInterestAmountCurr	number
Invoices.RemainingTotalAmountCurr	number
Actions.ActionID	number
Actions.Date	string
Actions.Type	number
Actions.Name	string
Actions.Text	string
Actions.Processed	number
Actions.Downloadable	boolean
Installment.StandardPaymentAmount	number
Installment.PaymentIntervalDays	number
Installment.RemainingPayments	number
Installment.NextPaymentDate	string
Installment.NextPaymentAmount	number

Create Search Date (v1)

Updates the search date for a specific case and debtor. Useful for updating the processing schedule or search events for a case.

Method: POST
URL: /v1/SearchDate

Request

{
    "CaseID": "number",
    "DebtorNo": "number",
    "PSID": "string",
    "SearchDate": "string"
}

Request Data Fields

Name	Type	Description
CaseID	number	ID of the case to update
DebtorNo	number	Debtor’s number
PSID	string	Process server ID (delgivningsman ID)
SearchDate	string	Date of the search event Format: YYYY-MM-DD

Retrieve Document (v1)

Retrieves a Base64-encoded document associated with the specified ActionID.

Method: GET
URL: /v1/Document/{actionid}

Request Example

curl -X GET "/Document/12345"

Response

{
    "DocBase64": "string",
    "DocType": "string"
}

Response Data Fields

Name	Type	Description
DocBase64	string	Base64 encoded document file content.
DocType	string	Document file type (e.g., PDF, XML).

Calculate Installment (v1)

Calculates an installment in an existing case using new input data.

Method: GET
URL: /v1/CalcInstallment

Request Example

curl -X GET "/CalcInstallment?CaseID=12345&DebtorNo=1&NumbInstallments=12"

Search Parameters

Name	Type	Description
CaseID	number	Case ID to search for
DebtorNo	number	Debtor number
NumbInstallments	number	Number of installments

Response

{
    "PaymentIntervalDays": "number",
    "NextPaymentDate": "string",
    "NextPaymentAmount": "number"
}

Response Data Fields

Name	Type	Description
PaymentIntervalDays	number	Number of days between payments
NextPaymentDate	string	Next payment date
NextPaymentAmount	number	Next payment amount

HTTP Status Codes

HTTP Status	Message	Description
200 OK	Success	The request was successful.
500 ERR	Server Error	Something unexpected went wrong on the server.

Support meny

API Documentation ”RivalREST”

Activation

Versions and depricated functions

Description

Example POST Call

Create Case (v1)

Request

Response

Create Case (v2)

Request

Response

Create Client (v1)

Request

Response

Create Payment (v1)

Request

Response

Retrieve Case (v1)

Request Example

Search Parameters

Response

Create Search Date (v1)

Request

Retrieve Document (v1)

Request Example

Response

Calculate Installment (v1)

Request Example

Search Parameters

Response

HTTP Status Codes

API Docs

API Docs

Endpoints

API Docs

API Documentation ”RivalREST”

Activation

Versions and depricated functions

Description

Example POST Call

Create Case (v1)

Request

Response

Create Case (v2)

Request

Response

Create Client (v1)

Request

Response

Create Payment (v1)

Request

Response

Retrieve Case (v1)

Request Example

Search Parameters

Response

Create Search Date (v1)

Request

Retrieve Document (v1)

Request Example

Response

Calculate Installment (v1)

Request Example

Search Parameters

Response

HTTP Status Codes

API Docs

API Docs

Endpoints

API Docs

Boka demo