CommissionRun

Provisionslauf

put

Path parameters

accountIdinteger · int64Required

Body

application/json

exportFormatstring · enumOptional

output forma für mail/file-export

Possible values:

exportFilenamestringOptional

filename (ohne extension) bei einem file-export

outputTypestringOptional

outputType

groupIdentifierstringOptional

OutputReportGroup Identifier (optional), sonst Default-Group des Moduls

publishedbooleanOptional

sollen nur bereits veröffentlichte Dokumente beachtet werden?

Responses

200

OK

*/*

Responseobject

put

/erp/commission/run/print_commission/{accountId}

HTTPcURLJavaScriptPython

PUT /api/erp/commission/run/print_commission/{accountId} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "exportFormat": "PDF",
  "exportFilename": "text",
  "outputType": "text",
  "groupIdentifier": "text",
  "published": true
}

200

OK

{}

post

Path parameters

idinteger · int64Required

id of commission run

Responses

200

OK

*/*

post

/erp/commission/run/{id}/revert

HTTPcURLJavaScriptPython

POST /api/erp/commission/run/{id}/revert HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T15:45:44.509Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T15:45:44.509Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "number": "text",
  "runState": "OPEN",
  "salesAgents": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T15:45:44.509Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T15:45:44.509Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "salesAgentAccountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "commissionType": "INVOICE",
      "taxRateRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "fees": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T15:45:44.509Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T15:45:44.509Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "accountRef": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          },
          "articleRef": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          },
          "commissionDate": "2026-02-10",
          "description": "text",
          "comment": "text",
          "valueType": "PERCENT",
          "value": 1,
          "valueCurrencyCode": "text",
          "feeOrigin": "USER_DEFINED",
          "valueOrigin": "NOT_COMMISSIONABLE",
          "originReference": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          },
          "commissionableNetPrice": 1,
          "commissionableGrossPrice": 1,
          "commissionableCurrencyCode": "text",
          "commissionableExchangeRate": 1,
          "baseCommissionableCurrencyCode": "text",
          "baseCommissionableNetPrice": 1,
          "baseCommissionableGrossPrice": 1,
          "taxRateRef": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          },
          "commissionNetPrice": 1,
          "commissionGrossPrice": 1,
          "commissionCurrencyCode": "text",
          "baseCommissionCurrencyCode": "text",
          "commissionExchangeRate": 1,
          "baseCommissionNetPrice": 1,
          "baseCommissionGrossPrice": 1
        }
      ],
      "files": [
        {
          "shelfDocumentId": 1,
          "description": "text"
        }
      ],
      "totalCommissionNetPrice": 1,
      "totalCommissionGrossPrice": 1,
      "commissionCurrencyCode": "text",
      "documentRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      }
    }
  ],
  "runDate": "2026-02-10",
  "dateFrom": "2026-02-10",
  "dateTo": "2026-02-10",
  "numberFrom": "text",
  "numberTo": "text"
}

post

Path parameters

idinteger · int64Required

id of commission run

Responses

200

OK

*/*

post

/erp/commission/run/{id}/commit

HTTPcURLJavaScriptPython

POST /api/erp/commission/run/{id}/commit HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T15:45:44.509Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T15:45:44.509Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "number": "text",
  "runState": "OPEN",
  "salesAgents": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T15:45:44.509Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T15:45:44.509Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "salesAgentAccountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "commissionType": "INVOICE",
      "taxRateRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "fees": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T15:45:44.509Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T15:45:44.509Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "accountRef": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          },
          "articleRef": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          },
          "commissionDate": "2026-02-10",
          "description": "text",
          "comment": "text",
          "valueType": "PERCENT",
          "value": 1,
          "valueCurrencyCode": "text",
          "feeOrigin": "USER_DEFINED",
          "valueOrigin": "NOT_COMMISSIONABLE",
          "originReference": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          },
          "commissionableNetPrice": 1,
          "commissionableGrossPrice": 1,
          "commissionableCurrencyCode": "text",
          "commissionableExchangeRate": 1,
          "baseCommissionableCurrencyCode": "text",
          "baseCommissionableNetPrice": 1,
          "baseCommissionableGrossPrice": 1,
          "taxRateRef": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          },
          "commissionNetPrice": 1,
          "commissionGrossPrice": 1,
          "commissionCurrencyCode": "text",
          "baseCommissionCurrencyCode": "text",
          "commissionExchangeRate": 1,
          "baseCommissionNetPrice": 1,
          "baseCommissionGrossPrice": 1
        }
      ],
      "files": [
        {
          "shelfDocumentId": 1,
          "description": "text"
        }
      ],
      "totalCommissionNetPrice": 1,
      "totalCommissionGrossPrice": 1,
      "commissionCurrencyCode": "text",
      "documentRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      }
    }
  ],
  "runDate": "2026-02-10",
  "dateFrom": "2026-02-10",
  "dateTo": "2026-02-10",
  "numberFrom": "text",
  "numberTo": "text"
}

post

Body

application/json

dateFromstring · dateOptional

date from

dateTostring · dateOptional

date to

runDatestring · dateOptional

run date

numberFromstringOptional

SalesAgent number from

numberTostringOptional

SalesAgent number to

Responses

200

OK

*/*

post

/erp/commission/run/singlerun

HTTPcURLJavaScriptPython

POST /api/erp/commission/run/singlerun HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "dateFrom": "2026-02-10",
  "dateTo": "2026-02-10",
  "runDate": "2026-02-10",
  "numberFrom": "text",
  "numberTo": "text"
}

200

OK

{
  "context": "text",
  "messageValue": "text"
}

get

Path parameters

idinteger · int64Required

id of commission run

Responses

200

OK

*/*

get

/erp/commission/run/{id}

HTTPcURLJavaScriptPython

GET /api/erp/commission/run/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T15:45:44.509Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T15:45:44.509Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "number": "text",
  "runState": "OPEN",
  "salesAgents": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T15:45:44.509Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T15:45:44.509Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "salesAgentAccountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "commissionType": "INVOICE",
      "taxRateRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "fees": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T15:45:44.509Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T15:45:44.509Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "accountRef": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          },
          "articleRef": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          },
          "commissionDate": "2026-02-10",
          "description": "text",
          "comment": "text",
          "valueType": "PERCENT",
          "value": 1,
          "valueCurrencyCode": "text",
          "feeOrigin": "USER_DEFINED",
          "valueOrigin": "NOT_COMMISSIONABLE",
          "originReference": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          },
          "commissionableNetPrice": 1,
          "commissionableGrossPrice": 1,
          "commissionableCurrencyCode": "text",
          "commissionableExchangeRate": 1,
          "baseCommissionableCurrencyCode": "text",
          "baseCommissionableNetPrice": 1,
          "baseCommissionableGrossPrice": 1,
          "taxRateRef": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          },
          "commissionNetPrice": 1,
          "commissionGrossPrice": 1,
          "commissionCurrencyCode": "text",
          "baseCommissionCurrencyCode": "text",
          "commissionExchangeRate": 1,
          "baseCommissionNetPrice": 1,
          "baseCommissionGrossPrice": 1
        }
      ],
      "files": [
        {
          "shelfDocumentId": 1,
          "description": "text"
        }
      ],
      "totalCommissionNetPrice": 1,
      "totalCommissionGrossPrice": 1,
      "commissionCurrencyCode": "text",
      "documentRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      }
    }
  ],
  "runDate": "2026-02-10",
  "dateFrom": "2026-02-10",
  "dateTo": "2026-02-10",
  "numberFrom": "text",
  "numberTo": "text"
}

get

Responses

200

OK

*/*

Responseboolean

get

/erp/commission/run/check

HTTPcURLJavaScriptPython

GET /api/erp/commission/run/check HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

true