Interpret invoice status

Once an invoice has been registered inside the Kravia API, it is possible to retrieve the invoice either via the search API endpoint or via the direct invoice API endpoint.

API description in order to retrieve an invoice status is described here. The section below describes how to interpret the status value.

Invoice statusCopied!

The API returns two main statuses:

  • FinancialClaimType - this is the primary category of the invoice used primarily for filtering purpose

  • FinancialClaimState - this is the current invoice status indicating what is happening

Search resultCopied!

The invoice search endpoint is available here and contains the following status

{
   "id": 1292,
   "collectionCaseNumber": "201803745",
   ...
   "claimType": "Closed",               // FinancialClaimType
   "currentState": "ClosedDueToError",  // FinancialClaimState
   ...
}

Invoice detailsCopied!

In addition , it is possible to retrieve an invoice by id in order to get additional details.

{
    "value": {
        "invoice": {
            "collectionCaseNumber": "201803745",
            "status": "Closed",                  // FinancialClaimType
            ...
            "state": "ClosedDueToError",         // FinancialClaimState
            ...

DictionaryCopied!

While all statuses in the Kravia API are defined as Enum, it is usually not recommended for partners to use them as such as we tend to define new enums regularly in order to cope with new flows and activities inside the collection process.

Instead, while using all enums as string, it is possible to look up the string value towards our dictionary API which provides a localised translation for all available enums:

curl --location 'https://api-dev.kraviainkasso.no/api/v2/dictionary' \
--header 'Accept-Language: no' \
--header 'Authorization: ••••••' 
{
    "value": {
        "claimDictionary": {
            "status": {
                "All": "Alle",
                "ReadyForCollection": "Klar for innfordring",
                "Open": "Pågående",
                "Closed": "Avsluttet",
                "Paused": "På vent",
                "ActionRequired": "Venter godkjenning",
                "Withdrawn": "Trukket",
                "Invoice": "Fakturert",
                "LegalAction": "Rettslig tiltak",
                "CreditNote": "Kreditnota",
                "Invalid": "Ugyldig status",
                "Reminder": "Purring",
                "Monitoring": "Overvåking",
                "Anonymized": "Anonymisert",
                "Deleted": "Slettet"
            },
            "state": {
                "Invalid": "Ugyldig status",
                "InvoiceDraft": "Faktura utkast",
                "InvoiceSent": "Fakturert",
                "Reminder": "Purring",
                "ReminderSent": "Betalingspåminnelse",
                "DebtCollectionWarningScheduled": "Inkassovarsel sendes",
                "DebtCollectionWarningSent": "Inkassevarsel sendt",
                "ReadyForCollection": "Klar for innfordring",
                "DebtCollectionNoticeScheduled": "Betalingsoppfordring sendes",
                "DebtCollectionNoticeSent": "Betalingsoppfordring sendt",
                "WaitingForInformation": "Oppsøker informasjon",
                "BankruptcyNoticePreparation": "Konkursvarsel klargjørelse",
                "BankruptcyNoticeSent": "Konkursvarsel sendt",
                "DebtSettlement": "Gjeldsordning",
                "SettlementComplaintPreparation": "Forliksklage klargjørelse",
                "SettlementComplaintSent": "Forliksklage sendt",
                "Paused": "På vent",
                "ActionRequired": "Venter godkjenning",
                "Monitoring": "Overvåking",
                "Closed": "Avsluttet",
                "Settled": "Oppgjort",
                "PartiallySettled": "Delvis betalt",
                "Credited": "Kreditert",
                "Withdrawn": "Trukket",
                "WaitingForApprovalBeforeReminder": "Venter godkjenning før purring",
                "Ongoing": "Pågående",
                "CreditCheck": "Kredit vurdering",
                "ForcedSaleClaimPreparation": "Tvangsalg klargjørelse",
                "ForcedSaleClaimSent": "Tvangsalg sendt",
                "ExpensesClaimPreparation": "Utlegg klargjørelse",
                "ExpensesClaimSent": "Utlegg sendt",
                "PayrollDeduction": "Lønnstrekk",
                "DeathClaimRegistrationSent": "Dødsbo, krav meldt",
                "BrankruptClaimRegistrationSent": "Konkursbo, krav sendt",
                "CreditNote": "Kreditnota",
                "RequestForDerogationSent": "Begjæring om fravikelse sendt",
                "RequestForCollectionSent": "Begjæring om avhenting sendt",
                "RequestInstructionsForCollectionSent": "Anvisning til innkrevning sendt",
                "RequestForEvictionSent": "Begjæring om utkastelse sendt",
                "LimitationCreditorInformed": "Krav nærme seg foreldelse",
                "RegisteredForBankruptcyClaim": "Konkursåpning registrert",
                "RequireBoardApprovalBeforeForcedSale": "Godkjenning før tvangsalg",
                "DebitorDisagreeWithClaim": "Kunde er uenig i saken",
                "RecommendLegalAction": "Anbefalt utlegg",
                "LegalActionNotRecommended": "Ikke anbefalt rettslig pågang",
                "CaseTransferred": "Overført til en annen sak",
                "AddressUnknown": "Ukjent adresse, oppsøkes",
                "AgencyFeeReminder": "Inkassogebyr purres",
                "TerminatedDebtorDeceased": "Avsluttet kunde avdød",
                "TerminatedDebtorInsolvent": "Avsluttet kunde insolvent",
                "TerminatedDebtorBrankrupt": "Avsluttet grunnet konkurs",
                "TerminatedCaseObsolete": "Sak foreldet",
                "DeductionScheme": "Avdragsordning",
                "DeductionSchemeDefaulted": "Avdragsordning misligholdt",
                "DeductionSchemeTerminated": "Avdragsordning slettet",
                "PayrollDeductionDefaulted": "Lønnstrekk misligholdt",
                "PayrollDeductionTerminated": "Lønnstrekk slettet",
                "NoticeOfSpecialCoerciveGrounds": "Varsel ved særlig tvangsgrunnlag",
                "NegotiationOutsideOfLegalCourt": "Forhandling i forbindelse med innsigelse",
                "DebtorClaimAlreadyPaid": "Kunde hevder å ha betalt",
                "WaitingForApprovalBeforeDebtCollectionWarning": "Venter godkjenning før inkassovarsel",
                "WaitingForApprovalBeforeDebtCollectionNotice": "Venter godkjenning før betalingsoppfordring",
                "NoticeOfUnpaidDebtPublishingSent": "Tratta",
                "ClaimInGuaranteeScheduled": "Krav i transportløyvegaranti sendes",
                "ClaimInGuaranteeSent": "Krav i transportløyvegaranti sendt",
                "BrankruptClaimRegistered": "Konkursbo, krav klargjøres",
                "ClosedDueToError": "Avsluttet på grunn av feil",
                "TerminatedDebtorMovedAbroad": "Avsluttet kunde flyttet til utlandet",
                "WaitingForCasePreProcessing": "Venter på forbehandling av sak",
                "SwedishEnforcementAuthorityPaymentOrder": "Søknad om betalingsordre",
                "SwedishEnforcementAuthorityEnforcement": "Søknad om tvangsfullbyrdelse",
                "SwedishEnforcementAuthorityCreditCheck": "Kredittopplysninger - Kronofogden",
                "DebtorDisputeUnderVerification": "Behandling av tilbakemeldinger om kundetvist",
                "FinnishEnforcementAuthorityEnforcement": "Søknad om tvangsfullbyrdelse",
                "Anonymized": "Anonymisert",
                "DeletedDueToError": "Slettet"
            },