v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Liability

List liabilities

Returns a collection with all Liabilities

get/api/v1/liabilities

Query parameters

OR
{
  "id": [
    "17"
  ]
}
numberstring required

Page number should be an integer greater than or equal to 1

sizestring required

Page size should usually be an integer between 10 and 50.

field'id' | 'documentNumber' | 'status' | 'project' | 'createdAt'
dir'asc' | 'desc'

Response

Operation completed successfully.

Example response

{
  "data": [
    {
      "id": "123456",
      "documentNumber": "LB-100001",
      "date": "2020-01-15",
      "createdAt": "2020-01-01 12:00:00+02:00",
      "createdBy": {
        "name": "John Doe"
      },
      "updatedAt": "2020-01-01 13:00:00+02:00",
      "status": "PENDING",
      "supplier": {
        "id": "123456",
        "name": "Test",
        "number": "123456"
      },
      "supplierInvoiceNumber": "INV-23456",
      "receiptDate": "2020-01-01",
      "financials": {
        "amountGross": {
          "amount": "100.0",
          "currency": "EUR"
        },
        "freightCharge": 10,
        "taxation": "VAT",
        "taxes": {
          "normalTax": {
            "rate": 19,
            "amount": 19
          },
          "reducedTax": {
            "rate": 7,
            "amount": 7
          },
          "customTax1": {
            "rate": 8.1,
            "amount": 50.5
          },
          "customTax2": {
            "rate": 10,
            "amount": 50.5
          }
        },
        "paymentTerms": {
          "dueDate": "2020-01-31",
          "earlyPaymentDate": "2020-01-15",
          "earlyPaymentDiscount": 2
        },
        "bookingText": "Liability booking text",
        "payment": {
          "methodName": "Bank transfer",
          "paidAmount": 100,
          "paidOnDate": "2020-01-01",
          "discountReceived": 2
        },
        "bank": {
          "iban": "MK641692T03H5L89810",
          "bic": "CNSXFR6D"
        },
        "amountNet": {
          "amount": "14.5300",
          "currency": "EUR"
        },
        "remainingSum": {
          "amount": "10.00",
          "currency": "EUR"
        },
        "totalAmount": {
          "amount": "20.00",
          "currency": "EUR"
        }
      },
      "purchaseOrder": {
        "id": "123"
      },
      "project": {
        "id": "1"
      },
      "icons": {
        "goodsReceiptCheck": "ok",
        "invoiceCheck": "ok",
        "accountAssignment": "ok",
        "paymentStatus": "partially_paid",
        "accountLink": "missing"
      },
      "tags": [
        {
          "id": "1",
          "name": "Erledigt",
          "color": "339966"
        },
        {
          "id": "2",
          "name": "Zu klären",
          "color": "ff0000"
        }
      ]
    }
  ],
  "extra": {
    "totalCount": 1,
    "page": {
      "number": 1,
      "size": 10
    }
  }
}