v1

latestOpenAPI 3.0.02026-07-2455104.8 MB

Credit Note

View credit note

Returns details of a single credit note.

get/api/v1/creditNotes/{id}

Path parameters

idstring required

Resource identifier.

Example:17

The resource's identifier.

Response

Operation completed successfully.

Example response

{
  "data": {
    "id": "125",
    "number": "9000110",
    "date": "2022-02-03",
    "createdAt": "2022-02-03T10:18:40+01:00",
    "createdBy": {
      "name": "John Doe"
    },
    "sentAt": "2022-02-03T10:19:31+01:00",
    "sentBy": {
      "name": "John Doe"
    },
    "updatedAt": "2022-02-03T10:19:34+01:00",
    "grossValue": {
      "amount": "50.00",
      "currency": "EUR"
    },
    "netValue": {
      "amount": "42.02",
      "currency": "EUR"
    },
    "costCenter": "",
    "status": "sent",
    "tags": [],
    "project": {
      "id": "6",
      "name": "Shopware"
    },
    "customer": {
      "id": "3632",
      "name": "John Doe"
    },
    "externalOrderReference": "62720",
    "devCustomer": "",
    "billingAddress": {
      "id": "1",
      "name": "John Doe",
      "contactPerson": "",
      "department": "",
      "subdivision": "",
      "street": "Street 10",
      "additionalDetails": "",
      "city": "Berlin",
      "zipCode": "10101",
      "country": "DE"
    },
    "paymentMethodName": "invoice",
    "paymentStatus": "pending",
    "gln": "12345",
    "taxation": 0,
    "positions": [
      {
        "id": 418,
        "position": 1,
        "salesOrderPosition": {
          "id": "16216"
        },
        "createdAt": "2022-02-03T10:18:40+01:00",
        "productId": 1689,
        "productNumber": "FR5248977",
        "description": "Article 1",
        "quantity": 1,
        "price": {
          "amount": "47.05",
          "currency": "EUR"
        },
        "vatCategory": "normal",
        "taxRate": 0,
        "discount": 0
      }
    ]
  }
}