Tenant API - Content

List recipient companies that were added/removed since a previous request (v2)

NOTE: Access to this resource might be enabled via agreement.

This resource is used to list companies that were added/removed since diffId was obtained, either from an initial request to the /v2/tenant/{tenantKey}/company endpoint, or from a subsequent request to this endpoint. Note that all diffIds that are obtained in a series of requests expire 31 days after the initial request. Therefore, API users must fetch the complete company list at least once every 31 days.

get/v2/tenant/{tenantKey}/company/diff/{diffId}

Request

  • Base URL: https://sender.api.kivra.com
  • URL: https://sender.api.kivra.com/v2/tenant/{tenantKey}/company/diff/{diffId}
  • Auth: oAuth2Client (defined in the document in a form this page cannot read)

Path parameters

tenantKeystring hexadecimal required

The unique Key for a Tenant

diffIdstring required
Example:3831CD15163421134211695294

ID that was returned in header in a previous request and is used to calculate which companies have been added/removed between then and now

Response

Lists of added/removed companies

Example response

{
  "added": [
    {
      "vatnr": "SE556000475501"
    }
  ],
  "removed": [
    {
      "vatnr": "SE556000475501"
    }
  ]
}

Changes

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