v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Invoice

View invoice

Returns details of a single invoice.

get/api/v1/invoices/{id}

Path parameters

idstring required

Resource identifier.

Example:17

The resource's identifier.

Response

Operation completed successfully.

Example response

{
  "data": {
    "id": "142",
    "documentNumber": "1200132",
    "documentDate": "2022-01-07T00:00:00+01:00",
    "log": {
      "createdAt": "2022-01-07T13:43:12+01:00",
      "sentAt": "2022-01-07T13:43:12+01:00",
      "createdBy": {
        "name": "John Doe"
      },
      "sentBy": {
        "name": "John Doe"
      },
      "updatedAt": "2022-03-31T00:16:03+02:00"
    },
    "amountGross": 49.99,
    "amountNet": 42.01,
    "costCenter": "3456",
    "status": "sent",
    "project": {
      "id": "6",
      "name": "Shopware",
      "abbreviation": "B2C-SW"
    },
    "customer": {
      "id": "3099",
      "name": "John Doe"
    },
    "externalOrderReference": "62720",
    "devCustomer": "50161",
    "billingAddress": {
      "id": "1",
      "name": "John Doe",
      "contactPerson": "",
      "department": "",
      "subdivision": "",
      "street": "Street 10",
      "additionalDetails": "",
      "city": "Berlin",
      "zipCode": "10101",
      "country": "DE",
      "email": "john.doe@email.de"
    },
    "paymentMethodName": "paypal",
    "paymentStatus": "pending",
    "dunning": "zahlungserinnerung",
    "dunningDate": null,
    "gln": "12345",
    "taxation": 0,
    "tags": [],
    "salesOrder": {
      "id": "147",
      "documentNumber": "2024-200135"
    },
    "positions": [
      {
        "id": 421,
        "position": 1,
        "saleOrderPositionId": 13521,
        "salesOrderId": "147",
        "createdAt": "2022-01-07T13:43:12+01:00",
        "productId": 864,
        "productNumber": "FR5232501",
        "description": "Example Product",
        "quantity": 1,
        "price": {
          "amount": "49.99",
          "currency": "EUR"
        },
        "vatCategory": "normal",
        "taxRate": 0,
        "discount": 0
      }
    ],
    "paymentTerms": {
      "earlyPaymentDiscount": 0,
      "earlyPaymentDate": "2022-01-17T00:00:00+01:00",
      "dueDate": "2022-02-06T00:00:00+01:00"
    }
  }
}