List all invoices on behalf of a contributor

GET/contributors/{contributorId}/invoices/outgoing/

API version

v2

Request method

GET

Operation ID

contributor-list-onbehalf-invoices

---

List all invoices on behalf of a contributor.

Request

• contributorIdstring

  required

Responses

Format

application/json

Beschreibung

The list of invoices on behalf of a contributor.

Schema-Dokumentation

• Array[
  • *object
    • invoiceDatestring (date-time)

      required
    • invoiceIdstring

      required
    • invoiceNumberstring

      required
    • invoiceTypestring (one of: INVOICE, CREDIT_NOTE)

      required
    • pdfLinkstring

      required
    • totalGrossnumber

      required
    • totalNetnumber

      required
    • webLinkstring
  ]

Beispiel

Content-Type: application/json

[
  {
    "invoiceDate": "1985-10-26T01:21:00.000Z",
    "invoiceId": "string",
    "invoiceNumber": "string",
    "invoiceType": "INVOICE",
    "pdfLink": "string",
    "totalGross": 123,
    "totalNet": 123,
    "webLink": "string"
  }
]

JSON Schema

{
  "items": {
    "properties": {
      "invoiceDate": {
        "format": "date-time",
        "type": "string"
      },
      "invoiceId": {
        "type": "string"
      },
      "invoiceNumber": {
        "type": "string"
      },
      "invoiceType": {
        "enum": [
          "INVOICE",
          "CREDIT_NOTE"
        ],
        "type": "string"
      },
      "pdfLink": {
        "type": "string"
      },
      "totalGross": {
        "type": "number"
      },
      "totalNet": {
        "type": "number"
      },
      "webLink": {
        "type": "string"
      }
    },
    "required": [
      "invoiceId",
      "invoiceNumber",
      "invoiceDate",
      "totalNet",
      "totalGross",
      "pdfLink",
      "invoiceType"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/contributors/string/invoices/outgoing

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.contributorListOnbehalfInvoices({
  "contributorId": "string"
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new ContributorListOnbehalfInvoicesRequest(
  contributorId: "string"
));
$response = $client->marketplace()->contributorListOnbehalfInvoices($request);

var_dump($response->getBody();