Skip to content

Collections

Create collection case

cases:write
Request body fields 26
FieldTypeRequiredDescription
fordringerobject[]YesField in the request payload.
fordringer[].hovedstolOereintegerYesField in the request payload.
fordringer[].forfaldsdatostringYesField in the request payload.
fordringer[].fakturadatostringNoField in the request payload.
fordringer[].beskrivelsestringNoField in the request payload.
fordringer[].kravartstringNoField in the request payload.
fordringer[].bestridtVedOverdragelsebooleanYesField in the request payload.
fordringer[].ejendomsforbeholdobject[]NoField in the request payload.
fordringer[].ejendomsforbehold[].betegnelsestringYesField in the request payload.
fordringer[].ejendomsforbehold[].kontantprisOereintegerYesField in the request payload.
fordringer[].ejendomsforbehold[].leveretDatostringNoField in the request payload.
skyldnereobject[]YesField in the request payload.
skyldnere[].skyldnerTypestringYesField in the request payload.
skyldnere[].navnstringYesField in the request payload.
skyldnere[].cvrstringNoDanish CVR number for a company.
skyldnere[].cprstringNoField in the request payload.
skyldnere[].adresseobjectNoField in the request payload.
skyldnere[].adresse.gadestringNoField in the request payload.
skyldnere[].adresse.postnummerstringNoField in the request payload.
skyldnere[].adresse.bystringNoField in the request payload.
skyldnere[].adresse.landstringNoField in the request payload.
skyldnere[].adresse.darIdstringNoField in the request payload.
skyldnere[].adresse.kommunekodestringNoField in the request payload.
skyldnere[].emailstringNoE-mail used for delivery and contact.
skyldnere[].mobilstringNoField in the request payload.
externalReferencestringYesYour stable reference for reconciliation and idempotent imports.
Request exampleapplication/json
curl -X POST https://api.rieckflow.com/v1/cases \
-H "Authorization: Bearer $RIECK_API_KEY" \
-H "Idempotency-Key: order-2041" \
-H "Content-Type: application/json" \
-d '{
"fordringer": [
{
"hovedstolOere": 125000,
"forfaldsdato": "…",
"bestridtVedOverdragelse": true,
"kravart": "FAKTURA"
}
],
"skyldnere": [
{
"skyldnerType": "person",
"navn": "…",
"cvr": "12345678",
"adresse": {},
"email": "ap@acme.example"
}
],
"externalReference": "crm-9001"
}'
201 Success envelopeapplication/json
Response fields 5
FieldTypeDescription
data.iduuidStable collection case id.
data.caseNumberstringHuman-readable case number.
data.statusstringCurrent case state.
data.balanceOereintegerOutstanding case balance.
data.externalReferencestring | nullYour reconciliation reference.
Possible errors 10
HTTPCodeMeaning
400invalid_idempotency_keyIdempotency-Key is missing or malformed.
400invalid_requestThe request body or parameter failed validation.
401invalid_api_keyThe API key is missing, invalid, expired or revoked.
403api_not_includedThe organisation’s plan does not include API access.
403insufficient_scopeThe key does not have the required scope.
409idempotency_conflictThe same key was used with a different request.
409idempotency_in_progressThe same operation is currently being processed. Retry later.
413payload_too_largeThe JSON or uploaded file exceeds this endpoint’s size limit.
422case_rejectedThe case is valid JSON but rejected by domain rules.
429rate_limitedThe organisation’s rate budget is exhausted.
Request body — fuldt JSON Schema
{
"type": "object",
"properties": {
"fordringer": {
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"hovedstolOere": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000000000
},
"forfaldsdato": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"fakturadato": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"beskrivelse": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"kravart": {
"type": "string",
"enum": [
"FAKTURA",
"LOEBENDE_KREDIT",
"HUSLEJE",
"ERHVERVSLEJE",
"FRAFLYTNING",
"PENGELAAN",
"KREDITKOEB",
"KONTROLAFGIFT",
"OFFENTLIGT_KRAV"
]
},
"bestridtVedOverdragelse": {
"type": "boolean"
},
"ejendomsforbehold": {
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"betegnelse": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"kontantprisOere": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"leveretDato": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}
},
"required": [
"betegnelse",
"kontantprisOere"
],
"additionalProperties": false
}
}
},
"required": [
"hovedstolOere",
"forfaldsdato",
"bestridtVedOverdragelse"
],
"additionalProperties": false
}
},
"skyldnere": {
"minItems": 1,
"maxItems": 20,
"type": "array",
"items": {
"type": "object",
"properties": {
"skyldnerType": {
"type": "string",
"enum": [
"person",
"virksomhed"
]
},
"navn": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"cvr": {
"type": "string",
"pattern": "^\\d{8}$"
},
"cpr": {
"type": "string",
"maxLength": 64
},
"adresse": {
"type": "object",
"properties": {
"gade": {
"type": "string",
"maxLength": 200
},
"postnummer": {
"type": "string",
"maxLength": 10
},
"by": {
"type": "string",
"maxLength": 100
},
"land": {
"type": "string",
"maxLength": 100
},
"darId": {
"type": "string",
"maxLength": 36
},
"kommunekode": {
"type": "string",
"pattern": "^\\d{4}$"
}
},
"additionalProperties": false
},
"email": {
"type": "string",
"maxLength": 254
},
"mobil": {
"type": "string",
"maxLength": 20
}
},
"required": [
"skyldnerType",
"navn"
],
"additionalProperties": false
}
},
"externalReference": {
"type": "string",
"minLength": 1,
"maxLength": 120
}
},
"required": [
"fordringer",
"skyldnere",
"externalReference"
],
"additionalProperties": false
}

Case status (PII-free)

cases:read
ParameterInTypeRequiredDescription
caseIdpathstringYes
Request exampleNo request body
curl https://api.rieckflow.com/v1/cases/9b2f1c1e-… \
-H "Authorization: Bearer $RIECK_API_KEY"
200 Success envelopeapplication/json
Response fields 5
FieldTypeDescription
data.iduuidStable collection case id.
data.caseNumberstringHuman-readable case number.
data.statusstringCurrent case state.
data.balanceOereintegerOutstanding case balance.
data.externalReferencestring | nullYour reconciliation reference.
Possible errors 5
HTTPCodeMeaning
401invalid_api_keyThe API key is missing, invalid, expired or revoked.
403api_not_includedThe organisation’s plan does not include API access.
403insufficient_scopeThe key does not have the required scope.
404case_not_foundThe case does not exist or belongs to another organisation.
429rate_limitedThe organisation’s rate budget is exhausted.

Submit terms-acceptance evidence

terms:accept
Request body fields 6
FieldTypeRequiredDescription
fakturaIdstringNoField in the request payload.
eksternOrdreRefstringNoField in the request payload.
betingelseVersionstringYesField in the request payload.
betingelseHashstringYesField in the request payload.
accepteretKlstringYesField in the request payload.
idempotensnoeglestringYesField in the request payload.
Request exampleapplication/json
curl -X POST https://api.rieckflow.com/v1/terms-acceptance \
-H "Authorization: Bearer $RIECK_API_KEY" \
-H "Idempotency-Key: order-2041" \
-H "Content-Type: application/json" \
-d '{
"betingelseVersion": "…",
"betingelseHash": "…",
"accepteretKl": "…",
"idempotensnoegle": "…",
"fakturaId": "9b2f1c1e-…"
}'
201 Success envelopeapplication/json
Possible errors 9
HTTPCodeMeaning
400invalid_idempotency_keyIdempotency-Key is missing or malformed.
400invalid_requestThe request body or parameter failed validation.
401invalid_api_keyThe API key is missing, invalid, expired or revoked.
403api_not_includedThe organisation’s plan does not include API access.
403insufficient_scopeThe key does not have the required scope.
409idempotency_conflictThe same key was used with a different request.
409idempotency_in_progressThe same operation is currently being processed. Retry later.
413payload_too_largeThe JSON or uploaded file exceeds this endpoint’s size limit.
429rate_limitedThe organisation’s rate budget is exhausted.
Request body — fuldt JSON Schema
{
"type": "object",
"properties": {
"fakturaId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"eksternOrdreRef": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"betingelseVersion": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"betingelseHash": {
"type": "string",
"pattern": "^[0-9a-f]{64}$"
},
"accepteretKl": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"idempotensnoegle": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"betingelseVersion",
"betingelseHash",
"accepteretKl",
"idempotensnoegle"
]
}