Partner API v3

List company inbox

List the content the company has received. This may be filtered by certain labels and specific fields may be selected using field.

Note that more content metadata is available via the Get specific content endpoint.

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

Request

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

Path parameters

companyKeystring required

The key for a company

Example:156077433683911cdca5fd4563bded979572454cb9

Query parameters

handledboolean

The content has been marked as handled, previously known as paid.

viewedboolean

The content has been viewed. This can be toggled by the user, i.e. "Mark as unread".

fieldFieldQueryParameter[] 
[
  "key"
]

Response

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

[
  {
    "key": "156077433683911cdca5fd4563bded979572454cb9",
    "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>"
      }
    ],
    "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.