Request an Access Token for a file of the Invoice

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

API-Version

v2

Request-Methode

GET

Operation-ID

invoice-get-file-access-token

Request

• customerIdstringrequired
• invoiceIdstringrequired

Responses

Format

application/json

Beschreibung

The File Access Token required to access the Invoice file.

• accessTokenstringrequired
• expiresAtstring (date-time)required

Content-Type: application/json

{
  "accessToken": "string",
  "expiresAt": "1985-10-26T01:21:00.000Z"
}

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

Nutzungsbeispiele

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/customers/string/invoices/string/file-access-token?fileType=PDF

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": "string",
  "queryParameters": {
    "fileType": "PDF"
  }
});

assertStatus(response, 200);
  

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

$request = (new InvoiceGetFileAccessTokenRequest(
  customerId: "string",
  invoiceId: "string"
))
  ->withFileType("PDF");
$response = $client->contract()->invoiceGetFileAccessToken($request);

var_dump($response->getBody();