Create a collection case

When using an external system for invoicing, it is possible to forward overdue invoice that needs to be collected to the Kravia API. The requirements to transfer an invoice to collection are very basic:

  • Invoice details including invoice number, invoice date and due date

  • Customer contact information including postal address

    • Organization number is required for B2B claims

  • Overdue amount inc. VAT

Even though it is not strictly required, we do recommend to provide a copy of the original invoice when available.

Register the invoice

In order to register a new invoice for collection, you can use the following API endpoint.

curl https://api.kravia.ai/api/v2/invoice/register \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: YOUR_SECRET_TOKEN' \
  --data '{
    "claimType": "CollectionCase",
    "creditorId": 10759,
    "accountingInvoiceId": null,
    "debtorName":"John Doe",
    "debtorNumber": "10001",
    "email": "kevcaballero@gmail.com",
    "ssn": null,
    "organizationNumber": null,
    "isPrivateIndividual": "true",
    "postalAddress": 
    {        
        "addressAddressLine1": "Karl Johan Gate",
        "addressPostalCode":"1000",
        "addressCity":"Oslo",
        "addressCountryCode": "NO"
    },
    "invoiceNo": "20003",
    "invoiceDate":"2025-01-01",
    "dueDate":"2025-02-01",
    "originalAmount": 2250,
    "currencyCode": "NOK",
    "description": "Invoice XYZ to collection"
}'

Some key data elements:

  • You can provide all the customer details in each invoice request creation and kravia will automatically identify the customer card to use. Ensure the external customer number is used and passed as “debtorNumber” in order to ensure consistency

  • When building an integration, we do recommend passing your internal identifier as accountingInvoiceId as this can be used for reconciliation.

Upload a copy of the invoice

Kravia supports sending attachment along with the invoice that we produce. To do so, you can use the generic document endpoint

curl 'https://api.kravia.ai/api/v2/invoice/{id}/document?type=Invoice' \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --header 'Authorization: YOUR_SECRET_TOKEN' \
  --data "{"file":"BASE64_FILE_CONTENT"}"

Start the collection process

When the invoice and relevant documents are fully registered, you can trigger the invoicing process via the action API.

curl 'https://api.kravia.ai/api/v2/invoice/{invoiceId}/action?action=Start' \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --header 'Authorization: YOUR_SECRET_TOKEN' \
  --data "{"Message":"Confirming invoice action"}"