Request an Access Token for the Invoice file

GET /v2/customers/{customerId}/invoices/{invoiceId}/file-access-token/

API version

v2

Request method

GET

Operation ID

invoice-get-file-access-token

---

Request

• customerIdstring

  required
  Example:"edefeee4-e8e9-4e2d-ab95-9a2eb6104cfb"
• invoiceIdstring (uuid)

  required
  Example:"154219e9-bf4a-4f41-9c72-0449a98db62f"

Responses

Format

application/json

Description

The File Access Token required to access the Invoice file.

Schema documentation

• accessTokenstring

  required
• expiresAtstring (date-time)

  required

Example

{
  "accessToken": "string",
  "expiresAt": "2024-09-16T00:26:43.686Z"
}

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/customers/string/invoices/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.contract.invoiceGetFileAccessToken({
  "customerId": "string",
  "invoiceId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Contract\InvoiceGetFileAccessToken\InvoiceGetFileAccessTokenRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new InvoiceGetFileAccessTokenRequest(
  customerId: "string",
  invoiceId: "f0f86186-0a5a-45b2-aa33-502777496347"
));
$response = $client->contract()->invoiceGetFileAccessToken($request);

var_dump($response->getBody();