API Documentation "RivalREST" - Rival Inkassosystem

Allmän information

Aktivering: RivalREST är en tilläggstjänst till Rival. Kontakta Rival Support för installation och mer information.
Versionering: Om en version v2 eller högre publiceras, kommer tidigare versioner fortsätta att fungera tills vidare, men de kommer inte längre att utvecklas.
Autentisering: Sker via Certifikat.
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) – Skapa ärende

Denna endpoint skapar ett nytt inkassoärende med tillhörande gäldenärsinformation, fakturor, noteringar och statusdetaljer. Den returnerar ett unikt CaseID vid ett lyckat anrop.

Endpointen kan även användas för att uppdatera ett befintligt ärende genom att skicka med parametern CaseIDUpdate. Vid användning av CaseIDUpdate kommer endast underobjekt och arrayer (såsom fakturor eller noteringar) att behandlas; systemet ignorerar då fält som OrgNo, Name och Address.

Metod: 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	Kontrollera dubbletter. Tillåtna värden: ”ExtRefNo”, ”ExtRefnoWithinClient” eller ”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	Separat åtgärd, inte en kedja. Standardvärde: 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	Unikt ID för det skapade ärendet.
ClientID	number	Klientens unika ID.
ExtRefNo	string	Externt referensnummer.
OrgNo	string	Gäldenärens organisationsnummer.
Name	string	Gäldenärens namn.
RemainingPrincipalAmount	number	Kvarstående kapitalbelopp.
RemainingInterestAmount	number	Kvarstående räntebelopp.
RemainingCostAmount	number	Kvarstående kostnadsbelopp.
KravStatus	string	Status för kravhanteringen.
JurStatus	string	Juridisk status för ärendet.
ExeStatus	string	Verkställighetsstatus för ärendet.
InstallmentPlan	boolean	Indikerar om det finns en aktiv avbetalningsplan.
NewOrMerged	string	Indikerar om ärendet är nytt eller sammanslaget.
Count	number	Totalt antal relaterade objekt.
Info	string	Informationsmeddelande från systemet.

Create Case (v2) – Skapa ärende

Skapar ett eller flera nya inkassoärenden samtidigt med gäldenärsinformation, fakturor (inklusive fakturarader), noteringar och statusdetaljer. Returnerar ett eller flera unika CaseID vid lyckat anrop.

Precis som i v1 kan denna endpoint användas för att uppdatera befintliga ärenden via CaseIDUpdate. Vid uppdatering används endast underobjekt och arrayer, medan fasta fält som OrgNo och Name lämnas orörda.

Metod: 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"
      },
      "Installment": {
            "DebtorNo": "number",
            "Amount": "number",
            "SetupFee": "number",
            "InvoiceFee": "number",
            "IntervalDays": "number",
            "NextPaymentDate": "string"
      }
    }
  ]
}

Request Parameters

Name	Type	Description
CheckOrgNo	boolean	Kontrollera organisationsnummer.
CheckDuplicates	string	Kontrollera dubbletter. Tillåtna värden: ”ExtRefNo”, ”ExtRefnoWithinClient” eller ”InvoicenoWithinClient”.
Merge	boolean	Slå ihop ärende med befintligt vid träff.
GetAddress	boolean	Hämta adressuppgifter automatiskt.
OrgNo	string	Gäldenärens organisationsnummer eller personnummer.
Name	string	Gäldenärens namn.
Address	string	Adressrad.
CareOf	string	C/O-adress.
PostCode	string	Postnummer.
PostTown	string	Postort.
PhoneNumber1	string	Telefonnummer 1.
Email	string	E-postadress.
SoleTraderName	string	Namn på enskild firma.
CustNo	string	Kundnummer.
CaseManager	string	Handläggare.
RegistrationDate	string	Registreringsdatum.
ResponseAction	string	Svarsåtgärd.
ClientID	number	Klientens unika ID.
ExtRefNo	string	Externt referensnummer.
StartDateResponseAction	string	Startdatum för svarsåtgärd.
CaseIDNew	number	Nytt ärende-ID.
PhoneNumber2	string	Telefonnummer 2.
Country	string	Land.
CaseIDUpdate	number	ID för det ärende som ska uppdateras.
PaymentPlacementCode	string	Kod för betalningsplacering.
SourceOfCase	string	Ärendets källa.
Currency	string	Valuta.
SourceOfAddress	string	Adressens källa.
TypeOfConsent	string	Typ av samtycke.
Collateral	string	Säkerhet.
BankAccountClearingNumber	string	Clearingnummer för bankkonto.
BankAccountNumber	string	Bankkontonummer.
ExtraFields.ExtraField1	string	Extrafält 1.
ExtraFields.ExtraField2	string	Extrafält 2.
ExtraFields.ExtraField3	string	Extrafält 3.
ExtraFields.ExtraField4	string	Extrafält 4.
ExtraFields.ExtraField5	string	Extrafält 5.
ExtraFields.ExtraField6	string	Extrafält 6.
ExtraFields.ExtraField7	string	Extrafält 7.
ExtraFields.ExtraField8	string	Extrafält 8.
ExtraFields.ExtraField9	string	Extrafält 9.
Invoices.InvoiceDate	string	Fakturadatum.
Invoices.DueDate	string	Förfallodatum.
Invoices.InterestType	string	Typ av ränta.
Invoices.InterestRate	number	Räntesats.
Invoices.PrincipalAmount	number	Kapitalbelopp.
Invoices.InvoiceNo	string	Fakturanummer.
Invoices.Description	string	Beskrivning av fakturan.
Invoices.ExtraText	string	Extratext för fakturan.
Invoices.RemainingPrincipalAmount	number	Kvarstående kapitalbelopp.
Invoices.RemainingInterestAmount	number	Kvarstående räntebelopp.
Invoices.InterestAccruedDate	string	Datum för ränteberäkning.
Linkedfiles.Date	string	Datum för länkad fil.
Linkedfiles.DocBase64	string	Dokumentfil kodad i Base64-format.
Linkedfiles.DocType	string	Filtyp för dokumentet.
Linkedfiles.Description	string	Beskrivning av den länkade filen.
Notes.Text	string	Textinnehåll för notering.
Notes.Date	string	Datum för noteringen.
Notes.UserName	string	Användarnamn för den som skapat noteringen.
Notes.ColourCode	number	Färgkod för noteringen.
Action.Date	string	Datum för åtgärden.
Action.Name	string	Namn på åtgärden.
Action.Separate	boolean	Separat åtgärd, inte en del av en kedja. Standardvärde: false.
Status.KravStatus	string	Status för kravhantering.
Status.JurStatus	string	Juridisk status för ärendet.
Status.ExeStatus	string	Verkställighetsstatus för ärendet.
Status.OverStatus	string	Övervakningsstatus.
Status.ExeTitleType	string	Typ av exekutionstitel.
Status.ExeTitleDate	string	Datum för exekutionstitel.
Status.ExeTitleNo	string	Nummer för exekutionstitel.
Status.ExeTitleTargetNo	string	Målnummer för exekutionstitel.
Status.LimitationInterruptCode	string	Kod för preskriptionsavbrott.
Status.LimitationInterruptDate	string	Datum för preskriptionsavbrott.
Status.LimitationInterruptInterval	number	Intervall för preskriptionsavbrott.
Status.LimitationDate	string	Datum för preskription.
Status.UNumber	string	U-nummer för ärendet.
Status.Trader	boolean	Indikerar om gäldenären är näringsidkare.
Status.ClosingDate	string	Datum då ärendet avslutades.
Status.ClosingCode	string	Kod för anledning till avslut.
Status.BlockOCRPayments	string	Indikerar om OCR-betalningar ska blockeras.

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	Unikt ID för det skapade ärendet.
ClientID	number	Klientens unika ID.
ExtRefNo	string	Externt referensnummer.
OrgNo	string	Gäldenärens organisationsnummer.
Name	string	Gäldenärens namn.
RemainingPrincipalAmount	number	Kvarstående kapitalbelopp.
RemainingInterestAmount	number	Kvarstående räntebelopp.
RemainingCostAmount	number	Kvarstående kostnadsbelopp.
KravStatus	string	Status för kravhanteringen.
JurStatus	string	Juridisk status för ärendet.
ExeStatus	string	Verkställighetsstatus för ärendet.
InstallmentPlan	boolean	Indikerar om det finns en aktiv avbetalningsplan.
NewOrMerged	string	Indikerar om ärendet är nytt eller sammanslaget.
Count	number	Totalt antal relaterade objekt.
Info	string	Informationsmeddelande från systemet.

Create Client (v1) – Skapa klient

Används för att skapa eller uppdatera en klient i systemet med tillhörande organisationsuppgifter och kontaktinformation.

Metod: 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 Parameters

Name	Type	Description
ClientID	number	Unik identifierare för klienten.
OrganisationNumber	string	Organisationsnummer (OrgNo).
Name	string	Klientens namn.
Address1	string	Primär adressrad.
Address2	string	Sekundär adressrad.
PostCode	string	Postnummer.
PostTown	string	Postort.
PhoneNumber1	string	Huvudsakligt telefonnummer för kontakt.
PhoneNumber2	string	Sekundärt telefonnummer för kontakt.
Email	string	E-postadress för kontakt.
ContactName1	string	Primär kontaktperson.
ContactName2	string	Sekundär kontaktperson.
PlusGiro	string	PlusGiro-kontonummer.
BankGiro	string	BankGiro-kontonummer.
BankAccountClearingNumber	string	Clearingnummer för bankkonto.
BankAccountNumber	string	Bankkontonummer.
VAT	boolean	Anger om klienten är momsregistrerad.
DebtText	string	Beskrivning av skulden.
PaymentCondition	number	Betalningsvillkor angivna i antal dagar.
InterestType	string	Typ av ränta som tillämpas.
InterestRate	number	Räntesats uttryckt i procent.
SettlementCode	string	Identifierare för avräkningskod.
PeriodOfLimitation	number	Preskriptionstid angiven i antal år.
InvoiceVAT	boolean	Indikerar om fakturor inkluderar moms.
Note	string	Ytterligare noteringar.

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) – Registrera inbetalning

Registrerar en inbetalning som gjorts mot ett specifikt ärende. Kräver detaljerad information om betalningen, såsom belopp, metod och uppgifter om gäldenären.

Metod: 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",
    "Apply": "boolean"
}

Request Parameters

Name	Type	Description
CaseID	number	ID för det ärende som tar emot betalningen.
Amount	number	Betalningsbelopp.
PaymentMethod	string	Betalningsmetod (t.ex. BankTransfer, Card).
AccountingDate	string	Datum för bokföringsändamål.
DebtorNo	number	Gäldenärsnummer.
Payer	string	Namn på betalaren.
BundleName	string	Referensnamn för batch eller bunt.
CurrAmount	number	Belopp i aktuell valuta.
PaymentCode	string	Identifierare för betalningskod.
PaymentRef	string	Referensnummer för betalningen.

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	Unikt ID för betalningstransaktionen.
CaseID	number	ID för det relaterade ärendet.
Amount	number	Registrerat betalningsbelopp.
PaymentMethod	string	Metod som användes för betalningen.
AccountingDate	string	Bokföringsdatum för betalningen.
DebtorNo	number	Gäldenärens identifierare.
Payer	string	Namn på betalaren.
BundleName	string	Referens för betalningsbatchen.
CurrAmount	number	Belopp i aktuell valuta.
PaymentCode	string	Identifierare för betalningskod.
PaymentRef	string	Referensnummer för betalningen.

Retrieve Case (v1) – Hämta ärende

Hämtar en lista över ärenden som matchar de angivna sökparametrarna. Du kan söka baserat på ärende-ID (CaseID), gäldenärsnummer, organisationsnummer (personnummer) med mera. Maximalt 300 ärenden returneras per sökning.

Metod: GET
URL: /v1/Case

Request Example

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

Search Parameters

Name	Type	Description
caseid	number	Ärende-ID att söka efter.
DebtorNo	number	Gäldenärsnummer.
orgno	string	Organisationsnummer eller personnummer (SSN).
psid	string	Delgivningsman-ID (Process Server ID).
country	string	Landets namn (standardvärde: Sverige).
filter	string	Filtrera ärenden efter status: ”open”, ”closed” eller ”all” (Standardvärde: ”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) – Uppdatera sökdatum

Uppdaterar sökdatumet för ett specifikt ärende och gäldenär. Denna funktion är användbar för att uppdatera handläggningsschemat eller dokumentera sökhändelser i ett ärende.

Metod: POST
URL: /v1/SearchDate

Request

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

Request Parameters Fields

Name	Type	Description
CaseID	number	ID för ärendet som ska uppdateras.
DebtorNo	number	Gäldenärsnummer.
PSID	string	Delgivningsman-ID (Process Server ID).
SearchDate	string	Datum för sökhändelsen. Format: ÅÅÅÅ-MM-DD.

Retrieve Document (v1) – Hämta dokument

Hämtar ett dokument i Base64-format som är associerat med ett specifikt åtgärds-ID (ActionID).

Metod: 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-kodat innehåll för dokumentfilen.
DocType	string	Dokumentets filtyp (t.ex. PDF, XML).

Calculate Installment (v1) – Beräkna avbetalning

Beräknar en delbetalning/avbetalningsplan för ett befintligt ärende baserat på ny indata. Notera att denna beräkning inte sparas automatiskt i ärendet utan fungerar som ett underlag.

Metod: GET
URL: /v1/CalcInstallment

Request Example

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

Search Parameters

Name	Type	Description
CaseID	number	Ärende-ID att söka efter.
DebtorNo	number	Gäldenärsnummer.
NumbInstallments	number	Antal delbetalningar.

Response

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

Response Data Fields

Name	Type	Description
PaymentIntervalDays	number	Antal dagar mellan betalningar.
NextPaymentDate	string	Nästa betalningsdatum.
NextPaymentAmount	number	Nästa betalningsbelopp.

Felkoder (HTTP Status Codes)

Följande statuskoder används för att indikera resultatet av en begäran:

HTTP Status	Meddelande	Beskrivning
200 OK	Success	Begäran lyckades och genomfördes.
500 ERR	Server Error	Något oväntat gick fel på serversidan.

Support meny

API Documentation ”RivalREST”

Allmän information

Example POST Call

Create Case (v1) – Skapa ärende

Request

Response

Create Case (v2) – Skapa ärende

Request

Response

Create Client (v1) – Skapa klient

Request

Response

Create Payment (v1) – Registrera inbetalning

Request

Response

Retrieve Case (v1) – Hämta ärende

Request Example

Search Parameters

Response

Create Search Date (v1) – Uppdatera sökdatum

Request

Retrieve Document (v1) – Hämta dokument

Request Example

Response

Calculate Installment (v1) – Beräkna avbetalning

Request Example

Search Parameters

Response

Felkoder (HTTP Status Codes)

API Docs

API Docs

Endpoints

API Docs

API Documentation ”RivalREST”

Allmän information

Example POST Call

Create Case (v1) – Skapa ärende

Request

Response

Create Case (v2) – Skapa ärende

Request

Response

Create Client (v1) – Skapa klient

Request

Response

Create Payment (v1) – Registrera inbetalning

Request

Response

Retrieve Case (v1) – Hämta ärende

Request Example

Search Parameters

Response

Create Search Date (v1) – Uppdatera sökdatum

Request

Retrieve Document (v1) – Hämta dokument

Request Example

Response

Calculate Installment (v1) – Beräkna avbetalning

Request Example

Search Parameters

Response

Felkoder (HTTP Status Codes)

API Docs

API Docs

Endpoints

API Docs

Boka demo