Returns a list of all PaymentTransaction

GET /api/invoice/payment_transaction

Query parameters

  • searchString string

    text to search for in the list

  • orderFieldName string

    name of the order field

  • orderFieldSort string

    sorting mode

    Values are DESC or ASC.

  • page integer

    page of the list

    Default value is 0.

  • pageSize integer

    number of entries for each page

    Minimum value is 1, maximum value is 200. Default value is 50.

  • withMaxPageNumber string

    returns the number of pages available as a header if this is set

  • iw-build-id string

    build id of the client

  • iw-package-id string

    package id of the client

Responses

  • 200 application/json

    Returns a list of all PaymentTransaction

    Hide response attributes Show response attributes object
    • auto boolean
    • incoming boolean
    • bank_transaction boolean
    • currency string
    • payment_type object
      Hide payment_type attributes Show payment_type attributes object
      • id integer
      • name string
      • auto boolean
      • conditions string
      • linked_keywords string
      • global_default boolean
      • bank_import_default boolean
      • is_direct_debit boolean
      • is_external boolean
      • deleted boolean
    • invoices array[object]
      Hide invoices attributes Show invoices attributes object
      • id integer
      • token string
      • number integer
      • manual_number_prefix string
      • manual_number integer
      • number_string string
      • generation_date string(date-time)
      • number_date string(date-time)
      • message string
      • currency string
      • name string
      • due_date string(date-time)
      • netto_value number(float)
      • brutto_value number(float)
      • tax_value number(float)
      • tax object Required
        Hide tax attributes Show tax attributes object
        • id integer
        • name string Required
        • value number(float)

          Minimum value is 0, maximum value is 1.

        • deleted boolean
        • global_default boolean
      • linked_number_title string
      • linked_number string
      • status string
      • previous_status string
      • status_updated string(date-time)
      • archived boolean
      • last_pdf_export string(date-time)
      • last_status_export string
      • search_string string
      • accounting_type object Required
        Hide accounting_type attributes Show accounting_type attributes object
        • id integer
        • name string Required
        • cancelled_name string
        • type string Required
        • deleted boolean
      • payment_type object
        Hide payment_type attributes Show payment_type attributes object
        • id integer
        • name string
        • auto boolean
        • conditions string
        • linked_keywords string
        • global_default boolean
        • bank_import_default boolean
        • is_direct_debit boolean
        • is_external boolean
        • deleted boolean
      • payment_goal object
        Hide payment_goal attributes Show payment_goal attributes object
        • id integer
        • name string
        • date_string string
        • deleted boolean
        • global_default boolean
      • buyer object
        Hide buyer attributes Show buyer attributes object
        • id integer
        • name string
        • vat_id string
        • taxnumber string
        • buyer_reference_id string
        • secondary_name string
        • address string
        • address_street string
        • address_house_number string
        • address_street_level string
        • address_co string
        • address_city string
        • address_zip string
        • address_admin_level1 string
        • address_country string
        • address_full_country string
        • address_geo_lat string
        • address_geo_lng string
        • address_external_provider_id string
        • number string
        • search_string string
        • invoice object
      • payment_date string(date-time)
      • is_payment_date_from_ext_service boolean
      • direct_debit_exported boolean
      • cancel_date string(date-time)
      • cancel_text string
    • brutto_value number(float)
    • is_fee boolean
    • due_date string(date-time)
    • deleted boolean
    • name string
    • created string(date-time)
    • updated string(date-time)
GET /api/invoice/payment_transaction
curl \
 --request GET 'https://replace-with-own-host.iw-erp.de/api/invoice/payment_transaction' \
 --header "x-session-token: $API_KEY"
Response examples (200)
[
  {
    "auto": true,
    "incoming": true,
    "bank_transaction": true,
    "currency": "string",
    "payment_type": {
      "id": 42,
      "name": "string",
      "auto": true,
      "conditions": "string",
      "linked_keywords": "string",
      "global_default": true,
      "bank_import_default": true,
      "is_direct_debit": true,
      "is_external": true,
      "deleted": true
    },
    "invoices": [
      {
        "id": 42,
        "token": "string",
        "number": 42,
        "manual_number_prefix": "string",
        "manual_number": 42,
        "number_string": "string",
        "generation_date": "2025-05-04T09:42:00Z",
        "number_date": "2025-05-04T09:42:00Z",
        "message": "string",
        "currency": "string",
        "name": "string",
        "due_date": "2025-05-04T09:42:00Z",
        "netto_value": 42.0,
        "brutto_value": 42.0,
        "tax_value": 42.0,
        "tax": {
          "id": 42,
          "name": "string",
          "value": 42.0,
          "deleted": true,
          "global_default": true
        },
        "linked_number_title": "string",
        "linked_number": "string",
        "status": "string",
        "previous_status": "string",
        "status_updated": "2025-05-04T09:42:00Z",
        "archived": true,
        "last_pdf_export": "2025-05-04T09:42:00Z",
        "last_status_export": "string",
        "search_string": "string",
        "accounting_type": {
          "id": 42,
          "name": "string",
          "cancelled_name": "string",
          "type": "string",
          "deleted": true
        },
        "payment_type": {
          "id": 42,
          "name": "string",
          "auto": true,
          "conditions": "string",
          "linked_keywords": "string",
          "global_default": true,
          "bank_import_default": true,
          "is_direct_debit": true,
          "is_external": true,
          "deleted": true
        },
        "payment_goal": {
          "id": 42,
          "name": "string",
          "date_string": "string",
          "deleted": true,
          "global_default": true
        },
        "buyer": {
          "id": 42,
          "name": "string",
          "vat_id": "string",
          "taxnumber": "string",
          "buyer_reference_id": "string",
          "secondary_name": "string",
          "address": "string",
          "address_street": "string",
          "address_house_number": "string",
          "address_street_level": "string",
          "address_co": "string",
          "address_city": "string",
          "address_zip": "string",
          "address_admin_level1": "string",
          "address_country": "string",
          "address_full_country": "string",
          "address_geo_lat": "string",
          "address_geo_lng": "string",
          "address_external_provider_id": "string",
          "number": "string",
          "search_string": "string",
          "invoice": {}
        },
        "payment_date": "2025-05-04T09:42:00Z",
        "is_payment_date_from_ext_service": true,
        "direct_debit_exported": true,
        "cancel_date": "2025-05-04T09:42:00Z",
        "cancel_text": "string"
      }
    ],
    "brutto_value": 42.0,
    "is_fee": true,
    "due_date": "2025-05-04T09:42:00Z",
    "deleted": true,
    "name": "string",
    "created": "2025-05-04T09:42:00Z",
    "updated": "2025-05-04T09:42:00Z"
  }
]