Request an Access Token for the Incoming Invoice file

GET/contributors/{contributorId}/invoices/incoming/{contributorReceiptId}/file-access-token/

API version

v2

Request method

GET

Operation ID

contributor-receipt-get-file-access-token

---

Request

• contributorIdstring

  required
  Example:"b1b6303f-2fb9-44f5-9f7f-bc91a8f6d80e"
• contributorReceiptIdstring (uuid)

  required
  Example:"98ec55a7-3702-4800-b006-7ceec4ff52f5"

Responses

Format

application/json

Description

The File Access Token required to access the Incoming Invoice file.

Schema documentation

• accessTokenstring

  required
• expiresAtstring (date-time)

  required

Example

Content-Type: application/json

{
  "accessToken": "string",
  "expiresAt": "2025-09-23T00:30:45.657Z"
}

JSON Schema

{
  "properties": {
    "accessToken": {
      "type": "string"
    },
    "expiresAt": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "accessToken",
    "expiresAt"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/contributors/string/invoices/incoming/f0f86186-0a5a-45b2-aa33-502777496347/file-access-token

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.marketplace.contributorReceiptGetFileAccessToken({
  "contributorId": "string",
  "contributorReceiptId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Marketplace\ContributorReceiptGetFileAccessToken\ContributorReceiptGetFileAccessTokenRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new ContributorReceiptGetFileAccessTokenRequest(
  contributorId: "string",
  contributorReceiptId: "f0f86186-0a5a-45b2-aa33-502777496347"
));
$response = $client->marketplace()->contributorReceiptGetFileAccessToken($request);

var_dump($response->getBody();