Partner API v3

Get specific content

Content metadata

Get metadata about a specific content in JSON format.

Content file data

A given content can contain multiple files ("parts"). Fetching of such parts is done by passing the part query parameter.

A part can also be selected by setting the Accept header to the MIME type of the part you want (see parts in the metadata JSON response). You will receive the first part that matches the given MIME type.

get/v3/partner/company/{companyKey}/content/{contentKey}

Request

  • Base URL: https://sender.api.kivra.com
  • URL: https://sender.api.kivra.com/v3/partner/company/{companyKey}/content/{contentKey}
  • Auth: none declared

Path parameters

companyKeystring required

The key for a company

Example:156077433683911cdca5fd4563bded979572454cb9
contentKeystring required

The key for a content

Example:156077433683911cdca5fd4563bded979572454cb9

Query parameters

partinteger

The content part to retrive, 1-indexed

Response

Content metadata

interpreted_fieldsstring[] required

Used to indicate which fields, in dot notation, have been interpreted. Now it is always set to the empty array.

created_atstring date-time required

This is the same date and time as transaction_at, except for reminder invoices, where it is the reminder date and not the original invoice date.

keystring required

The key for a content

received_atstring date-time required

When the content was received by Kivra

receiver_namestring required

The name of the recipient company

receiver_vat_numberstring required

A Swedish VAT number ("momsregistreringsnummer").

sender_icon_urlstring url nullable required

A url to the icon used by the sender within Kivra, or null if no corresponding icon exists.

sender_namestring nullable required

The name of the sender

sender_vat_numbersVatNumber[] nullable required

VAT numbers representing the sender

origin'kivra' | 'minameddelanden' | 'user' | 'physical' | 'email'

The origin of the content. Indicates how the content was delivered to Kivra.

  • kivra: Sent directly through Kivra.
  • minameddelanden: Sent via Mina Meddelanden. Used by governmental organisations.
  • user: Uploaded by an user. Companies with Kivra företag+ can also receive:
  • physical: Physical post scanned by Kivra.
  • email: Sent via the company's kivramail.com email address.
subjectstring required

Subject of the content

transaction_atstring date-time nullable required

The date and time this content conceptually took place.

  • For a normal invoice it is the invoice date.
  • For a reminder invoice it the original invoice date and not the reminders invoice date.
  • For all other types of content it is null.
  • If no date could be found, it is null.
type'invoice' | 'other' required

The type of the content

Example response

{
  "interpreted_fields": [],
  "parts": [
    {
      "name": "faktura.pdf",
      "sha256": "060bed374498fe2f36a5f2e1abf217a90beb46e8fe4ec1d9d5ce7746",
      "size": 4711,
      "url": "https://sender.sandbox-api.kivra.com/v3/partner/company/1691677086a57b73569d594df5abad7fd2575c1070/content/1691677075a9813e08f783496382b0bff743ec34ae?part=1",
      "responsive_body": "<h1>Faktura</h1>\n<p>Totalt: 1 500,00 kr/p>"
    }
  ],
  "payment_options": [
    {
      "account": "12345678",
      "amount": 150000,
      "currency": "SEK",
      "description": "12 month subscription",
      "due_at": "2022-03-30T00:00:00Z",
      "reference_type": "OCR",
      "type": "bankgiro",
      "vat_amount": 1500
    }
  ],
  "references": {
    "our": "Gustav Larsson"
  },
  "sender_contact_info": {
    "email_address": "support@example.com",
    "logo_url": "https://example.com/logo.png",
    "phone_number": "+46700000000",
    "text": "Customer Support",
    "url": "https://example.com/support"
  },
  "key": "156077433683911cdca5fd4563bded979572454cb9",
  "receiver_name": "Developers Developers Developers AB",
  "receiver_vat_number": "SE556000475501",
  "sender_icon_url": "https://sandbox-static.kivra.com/img/tenant/1341573157b3a1c55f220f4007b2e44789d2d04015/icon.png",
  "sender_name": "Lenas Konditori AB",
  "sender_vat_numbers": [
    "SE556000475501"
  ],
  "subject": "Invoice: a thousand Swiss rolls"
}

Changes

No recorded changes to this operation across all 1 revision of this API.