#EProcurement REST API Description <br/> [**Contact the product owner**](mailto:anne.koster@dedalus-group.com) <br/> **Version** 08.04.42.00 # APIs <hr/> ## /external/eprocurement/authconfig ### GET <a id="getAuthConfig">Returns the authentication configuration.</a> #### Request ##### Parameters #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/AuthenticationInformation">AuthenticationInformation</a>| <hr/> ## /external/eprocurement/divisions ### GET <a id="getDivisions">Returns a list of logistic divisions.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>Range</b></th> <td>header</td> <td>no</td> <td>pagination</td> <td>items=0-100</td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | Array[<a href="#/definitions/LogisticDivision">LogisticDivision</a>]| <hr/> ## /external/eprocurement/divisions/{tsnDivision} ### GET <a id="getDivision">Returns the logistic division identified by its tsn (thirdpartySystemNumber).</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/LogisticDivision">LogisticDivision</a>| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/articles ### GET <a id="getArticles">Returns a list of articles of the logistic division.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>articleNumber</b></th> <td>query</td> <td>no</td> <td>articleNumber of article</td> <td> - </td> <td>string </td> </tr> <tr> <td><b>includePackingUnits</b></th> <td>query</td> <td>no</td> <td>include packingUnits in response</td> <td>false</td> <td>boolean </td> </tr> <tr> <td><b>Range</b></th> <td>header</td> <td>no</td> <td>pagination</td> <td>items=0-100</td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | Array[<a href="#/definitions/Article">Article</a>]| ### POST <a id="createArticle">Returns the created article.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>body</b></th> <td>body</td> <td>no</td> <td>article to be created</td> <td> - </td> <td> <a href="#/definitions/Article">Article</a> </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/Article">Article</a>| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/articles/{articleId} ### GET <a id="getArticle">Returns the article identified by its identifier.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>articleId</b></th> <td>path</td> <td>yes</td> <td>identifier of article</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>includePackingUnits</b></th> <td>query</td> <td>no</td> <td>include packingUnits in response</td> <td>false</td> <td>boolean </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/Article">Article</a>| ### PUT <a id="updateArticle">Returns the modified article.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>articleId</b></th> <td>path</td> <td>yes</td> <td>identifier of article</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>body</b></th> <td>body</td> <td>no</td> <td>article to be modified</td> <td> - </td> <td> <a href="#/definitions/Article">Article</a> </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/Article">Article</a>| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/articles/{articleId}/packingunits ### GET <a id="getArticlePackingUnits">Returns a list of packingUnits for the given article.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>articleId</b></th> <td>path</td> <td>yes</td> <td>identifier of article</td> <td> - </td> <td>integer (int64)</td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | Array[<a href="#/definitions/PackingUnit">PackingUnit</a>]| ### PUT <a id="updatePackingUnits">Returns the modified list of packingUnits.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>articleId</b></th> <td>path</td> <td>yes</td> <td>identifier of article</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>body</b></th> <td>body</td> <td>no</td> <td>list of all packingUnits of article to be modified</td> <td> - </td> <td> Array[<a href="#/definitions/PackingUnit">PackingUnit</a>] </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | Array[<a href="#/definitions/PackingUnit">PackingUnit</a>]| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/costcentres ### GET <a id="getCostCentres">Returns a list of costcentres.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>costCentreNumber</b></th> <td>query</td> <td>no</td> <td>number of the costcentre</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>own</b></th> <td>query</td> <td>no</td> <td>show costcentres of own facility</td> <td>true</td> <td>boolean </td> </tr> <tr> <td><b>foreign</b></th> <td>query</td> <td>no</td> <td>show costcentres of customers</td> <td>false</td> <td>boolean </td> </tr> <tr> <td><b>Range</b></th> <td>header</td> <td>no</td> <td>pagination</td> <td>items=0-100</td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | Array[<a href="#/definitions/CostCentre">CostCentre</a>]| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/costcentres/{costCentreId} ### GET <a id="getCostCentre">Returns the costcentre identified by its identifier.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>costCentreId</b></th> <td>path</td> <td>yes</td> <td>identifier of costcentre</td> <td> - </td> <td>integer (int64)</td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/CostCentre">CostCentre</a>| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/currencies ### GET <a id="getCurrencies">Returns a list of currencies.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | Array[<a href="#/definitions/Currency">Currency</a>]| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/currencies/{identifier} ### GET <a id="getCurrency">Returns the currency identified by its identifier.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>identifier</b></th> <td>path</td> <td>yes</td> <td>identifier of currency</td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/Currency">Currency</a>| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/deductiontypes ### GET <a id="getDeductions">Returns a list of deductiontypes.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | Array[<a href="#/definitions/DeductionType">DeductionType</a>]| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/deductiontypes/{identifier} ### GET <a id="getDeductionType">Returns the deductiontype identified by its identifier.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>identifier</b></th> <td>path</td> <td>yes</td> <td>identifier of the deductiontype</td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/DeductionType">DeductionType</a>| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/dynamiccatalogs ### GET <a id="getDynamicCatalogs">Returns a list of dynamicCatalogs.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>shortName</b></th> <td>query</td> <td>no</td> <td>shortname of dynamicCatalog</td> <td> - </td> <td>string </td> </tr> <tr> <td><b>Range</b></th> <td>header</td> <td>no</td> <td>pagination</td> <td>items=0-100</td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | Array[<a href="#/definitions/DynamicCatalog">DynamicCatalog</a>]| ### POST <a id="create">Returns the created dynamicCatalog.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>body</b></th> <td>body</td> <td>no</td> <td>dynamicCatalog to be created</td> <td> - </td> <td> <a href="#/definitions/DynamicCatalog">DynamicCatalog</a> </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/DynamicCatalog">DynamicCatalog</a>| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/dynamiccatalogs/{catalogIdentifier}/articles ### GET <a id="getDynamicCatalogEntries">Returns a list of dynamicCatalogsEnries.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>catalogIdentifier</b></th> <td>path</td> <td>yes</td> <td>catalogIdentifier</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>catalogEntryId</b></th> <td>query</td> <td>no</td> <td>identifier of dynamicCatalog</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>articleId</b></th> <td>query</td> <td>no</td> <td>identifier of article</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>Range</b></th> <td>header</td> <td>no</td> <td>pagination</td> <td>items=0-100</td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | Array[<a href="#/definitions/DynamicCatalogArticle">DynamicCatalogArticle</a>]| ### POST <a id="create">Returns the created dynamicCatalogArticle.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>catalogIdentifier</b></th> <td>path</td> <td>yes</td> <td>catalogIdentifier</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>body</b></th> <td>body</td> <td>no</td> <td>articleDynamicCatalog to be created</td> <td> - </td> <td> <a href="#/definitions/DynamicCatalogArticle">DynamicCatalogArticle</a> </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/DynamicCatalogArticle">DynamicCatalogArticle</a>| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/dynamiccatalogs/{catalogIdentifier}/articles/{identifier} ### GET <a id="getDynamicCatalogArticle">Returns the dynamicCatalogarticle identified by its identifier.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>catalogIdentifier</b></th> <td>path</td> <td>yes</td> <td>catalogIdentifier</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>id</b></th> <td>path</td> <td>yes</td> <td>identifier</td> <td> - </td> <td>integer (int64)</td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/DynamicCatalogArticle">DynamicCatalogArticle</a>| ### PUT <a id="update">Returns the modified dynamicCatalogArticle.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>catalogIdentifier</b></th> <td>path</td> <td>yes</td> <td>catalogIdentifier</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>identifier</b></th> <td>path</td> <td>yes</td> <td>identifier</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>body</b></th> <td>body</td> <td>no</td> <td>dynamicCatalog to be modified</td> <td> - </td> <td> <a href="#/definitions/DynamicCatalogArticle">DynamicCatalogArticle</a> </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/DynamicCatalogArticle">DynamicCatalogArticle</a>| ### DELETE <a id="delete">deletes dynamicCatalogArticle.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>catalogIdentifier</b></th> <td>path</td> <td>yes</td> <td>catalogIdentifier</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>identifier</b></th> <td>path</td> <td>yes</td> <td>identifier</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>body</b></th> <td>body</td> <td>no</td> <td>dynamicCatalog to be modified</td> <td> - </td> <td> <a href="#/definitions/DynamicCatalogArticle">DynamicCatalogArticle</a> </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | default | successful operation | - | <hr/> ## /external/eprocurement/divisions/{tsnDivision}/dynamiccatalogs/{catalogIdentifier}/entries ### GET <a id="getDynamicCatalogEntries">Returns a list of dynamicCatalogsEnries.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>catalogIdentifier</b></th> <td>path</td> <td>yes</td> <td>catalogIdentifier</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>shortName</b></th> <td>query</td> <td>no</td> <td>shortname of dynamicCatalog</td> <td> - </td> <td>string </td> </tr> <tr> <td><b>parentId</b></th> <td>query</td> <td>no</td> <td>parent of dynamicCatalog</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>Range</b></th> <td>header</td> <td>no</td> <td>pagination</td> <td>items=0-100</td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | Array[<a href="#/definitions/DynamicCatalogEntry">DynamicCatalogEntry</a>]| ### POST <a id="createEntry">Returns the created dynamicCatalogEntry.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>catalogIdentifier</b></th> <td>path</td> <td>yes</td> <td>catalogIdentifier</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>body</b></th> <td>body</td> <td>no</td> <td>dynamicCatalog to be created</td> <td> - </td> <td> <a href="#/definitions/DynamicCatalogEntry">DynamicCatalogEntry</a> </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/DynamicCatalogEntry">DynamicCatalogEntry</a>| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/dynamiccatalogs/{catalogIdentifier}/entries/{identifier} ### GET <a id="getDynamicCatalogEntry">Returns the dynamicCatalogEntry identified by its identifier.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>catalogIdentifier</b></th> <td>path</td> <td>yes</td> <td>catalogIdentifier</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>id</b></th> <td>path</td> <td>yes</td> <td>identifier</td> <td> - </td> <td>integer (int64)</td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/DynamicCatalogEntry">DynamicCatalogEntry</a>| ### PUT <a id="updateEntry">Returns the modified dynamicCatalogEntry.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>catalogIdentifier</b></th> <td>path</td> <td>yes</td> <td>catalogIdentifier</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>identifier</b></th> <td>path</td> <td>yes</td> <td>identifier</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>body</b></th> <td>body</td> <td>no</td> <td>dynamicCatalog to be modified</td> <td> - </td> <td> <a href="#/definitions/DynamicCatalogEntry">DynamicCatalogEntry</a> </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/DynamicCatalogEntry">DynamicCatalogEntry</a>| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/dynamiccatalogs/{identifier} ### GET <a id="getDynamicCatalog">Returns the dynamicCatalog identified by its identifier.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>identifier</b></th> <td>path</td> <td>yes</td> <td>identifier</td> <td> - </td> <td>integer (int64)</td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/DynamicCatalog">DynamicCatalog</a>| ### PUT <a id="update">Returns the modified dynamicCatalog.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>identifier</b></th> <td>path</td> <td>yes</td> <td>identifier</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>body</b></th> <td>body</td> <td>no</td> <td>dynamicCatalog to be modified</td> <td> - </td> <td> <a href="#/definitions/DynamicCatalog">DynamicCatalog</a> </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/DynamicCatalog">DynamicCatalog</a>| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/materialgroups ### GET <a id="getMaterialGroup">Returns a list of materialgroups.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>shortName</b></th> <td>query</td> <td>no</td> <td>shortname of material group</td> <td> - </td> <td>string </td> </tr> <tr> <td><b>parentId</b></th> <td>query</td> <td>no</td> <td>parent of material group</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>onlyLeaf</b></th> <td>query</td> <td>no</td> <td>only leaf level, no parent material groups</td> <td>true</td> <td>boolean </td> </tr> <tr> <td><b>Range</b></th> <td>header</td> <td>no</td> <td>pagination</td> <td>items=0-100</td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | Array[<a href="#/definitions/MaterialGroup">MaterialGroup</a>]| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/materialgroups/{identifier} ### GET <a id="getMaterialGroup">Returns the materialgroup identified by its identifier.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>identifier</b></th> <td>path</td> <td>yes</td> <td>identifier of the material group</td> <td> - </td> <td>integer (int64)</td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/MaterialGroup">MaterialGroup</a>| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/packingunits ### GET <a id="getPackingUnits">Returns a list of packing units.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>articleId</b></th> <td>query</td> <td>no</td> <td>identifier of the article</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>gtin</b></th> <td>query</td> <td>no</td> <td>gtin</td> <td> - </td> <td>string </td> </tr> <tr> <td><b>pzn</b></th> <td>query</td> <td>no</td> <td>pzn</td> <td> - </td> <td>string </td> </tr> <tr> <td><b>hibc</b></th> <td>query</td> <td>no</td> <td>hibc</td> <td> - </td> <td>string </td> </tr> <tr> <td><b>isReceipt</b></th> <td>query</td> <td>no</td> <td>only packing units for receipt process</td> <td> - </td> <td>boolean </td> </tr> <tr> <td><b>isReceiptDefault</b></th> <td>query</td> <td>no</td> <td>only default packing units for receipt process</td> <td> - </td> <td>boolean </td> </tr> <tr> <td><b>isOutgoing</b></th> <td>query</td> <td>no</td> <td>only packing units for outgoing process</td> <td> - </td> <td>boolean </td> </tr> <tr> <td><b>isOutgoingDefault</b></th> <td>query</td> <td>no</td> <td>only default packing units for outgoing process</td> <td> - </td> <td>boolean </td> </tr> <tr> <td><b>Range</b></th> <td>header</td> <td>no</td> <td>pagination</td> <td>items=0-100</td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | Array[<a href="#/definitions/PackingUnit">PackingUnit</a>]| ### POST <a id="createPackingUnit">Returns the new packing unit.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>body</b></th> <td>body</td> <td>yes</td> <td>new packing unit</td> <td> - </td> <td> <a href="#/definitions/PackingUnit">PackingUnit</a> </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/PackingUnit">PackingUnit</a>| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/packingunits/{packingUnitId} ### GET <a id="getPackingUnit">Returns the packing unit identified by its identifier.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>packingUnitId</b></th> <td>path</td> <td>yes</td> <td>identifier of the packing unit</td> <td> - </td> <td>integer (int64)</td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/PackingUnit">PackingUnit</a>| ### PUT <a id="updatePackingUnit">Returns the updated packing unit.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>packingUnitId</b></th> <td>path</td> <td>yes</td> <td>identifier of the packing unit</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>body</b></th> <td>body</td> <td>yes</td> <td>packing unit to be modified</td> <td> - </td> <td> <a href="#/definitions/PackingUnit">PackingUnit</a> </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/PackingUnit">PackingUnit</a>| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/purchorders ### POST <a id="createPurchOrder">Returns the created purchOrder.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>body</b></th> <td>body</td> <td>no</td> <td>purchOrder to be created</td> <td> - </td> <td> <a href="#/definitions/PurchOrder">PurchOrder</a> </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/PurchOrder">PurchOrder</a>| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/purchorders/{identifier} ### GET <a id="getPurchOrder">Returns the purchOrder identified by its documentNumber.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>identifier</b></th> <td>path</td> <td>yes</td> <td>documentNumber of purchOrder</td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/PurchOrder">PurchOrder</a>| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/supplierarticles ### GET <a id="getSupplierArticles">Returns a list of supplier article relations.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>tsnSupplier</b></th> <td>query</td> <td>no</td> <td>thirdpartySystemNumber of supplier</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>articleId</b></th> <td>query</td> <td>no</td> <td>identifier of the article</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>Range</b></th> <td>header</td> <td>no</td> <td>pagination</td> <td>items=0-100</td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | Array[<a href="#/definitions/SupplierArticle">SupplierArticle</a>]| ### POST <a id="create">Returns the created supplier article relation.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>body</b></th> <td>body</td> <td>yes</td> <td>supplier article relation to be created</td> <td> - </td> <td> <a href="#/definitions/SupplierArticle">SupplierArticle</a> </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/SupplierArticle">SupplierArticle</a>| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/supplierarticles/{supplierArticleId} ### GET <a id="getSupplierArticle">Returns supplier article relation identified by its identifier.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>supplierArticleId</b></th> <td>path</td> <td>yes</td> <td>identifier of the supplier article relation</td> <td> - </td> <td>integer (int64)</td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/SupplierArticle">SupplierArticle</a>| ### PUT <a id="update">Returns the updated supplier article relation.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>supplierArticleId</b></th> <td>path</td> <td>yes</td> <td>identifier of the supplier article relation</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>body</b></th> <td>body</td> <td>yes</td> <td>supplier article relation to be modified</td> <td> - </td> <td> <a href="#/definitions/SupplierArticle">SupplierArticle</a> </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/SupplierArticle">SupplierArticle</a>| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/supplierarticles/{supplierArticleId}/prices ### GET <a id="getSupplierArticlePrices">Returns a list of supplier article prices.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>supplierArticleId</b></th> <td>path</td> <td>yes</td> <td>identifier of supplier article relation</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>validOn</b></th> <td>query</td> <td>no</td> <td>date when price is valid (if no date is given, validon is today)</td> <td> - </td> <td>string </td> </tr> <tr> <td><b>validFrom</b></th> <td>query</td> <td>no</td> <td>date from when price is valid</td> <td> - </td> <td>string </td> </tr> <tr> <td><b>validTo</b></th> <td>query</td> <td>no</td> <td>date to when price is valid</td> <td> - </td> <td>string </td> </tr> <tr> <td><b>Range</b></th> <td>header</td> <td>no</td> <td>pagination</td> <td>items=0-100</td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | Array[<a href="#/definitions/SupplierArticlePrice">SupplierArticlePrice</a>]| ### POST <a id="createPrice">Returns the created supplier article price relation.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>supplierArticleId</b></th> <td>path</td> <td>yes</td> <td>identifier of supplier article relation</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>body</b></th> <td>body</td> <td>yes</td> <td>supplier article price relation to be created</td> <td> - </td> <td> <a href="#/definitions/SupplierArticlePrice">SupplierArticlePrice</a> </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/SupplierArticlePrice">SupplierArticlePrice</a>| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/supplierarticles/{supplierArticleId}/prices/{supplierArticlePriceId} ### GET <a id="getSupplierArticlePrice">Returns a supplier article relation identified by its identifier.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>supplierArticleId</b></th> <td>path</td> <td>yes</td> <td>identifier of supplier article relation</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>supplierArticlePriceId</b></th> <td>path</td> <td>yes</td> <td>identifier of supplier article price relation</td> <td> - </td> <td>integer (int64)</td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/SupplierArticlePrice">SupplierArticlePrice</a>| ### PUT <a id="updatePrice">Returns the updated supplier article price relation.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>supplierArticleId</b></th> <td>path</td> <td>yes</td> <td>identifier of supplier article relation</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>supplierArticlePriceId</b></th> <td>path</td> <td>yes</td> <td>identifier of supplier article price relation</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>body</b></th> <td>body</td> <td>yes</td> <td>supplier article price relation to be modified</td> <td> - </td> <td> <a href="#/definitions/SupplierArticlePrice">SupplierArticlePrice</a> </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/SupplierArticlePrice">SupplierArticlePrice</a>| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/suppliers ### GET <a id="getSuppliers">Returns a list of suppliers.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>clearing</b></th> <td>query</td> <td>no</td> <td>flag if suppliers without thirdpartySystemNumber should be included</td> <td>false</td> <td>boolean </td> </tr> <tr> <td><b>shortName</b></th> <td>query</td> <td>no</td> <td>shortname of supplier</td> <td> - </td> <td>string </td> </tr> <tr> <td><b>externalSupplierNumber</b></th> <td>query</td> <td>no</td> <td>externalSupplierNumber of supplier</td> <td> - </td> <td>string </td> </tr> <tr> <td><b>logisticRelevant</b></th> <td>query</td> <td>no</td> <td>is supplier relevant for logistic processes</td> <td> - </td> <td>boolean </td> </tr> <tr> <td><b>purchOrderSince</b></th> <td>query</td> <td>no</td> <td>supplier has purchOrder since</td> <td> - </td> <td>string </td> </tr> <tr> <td><b>Range</b></th> <td>header</td> <td>no</td> <td>pagination</td> <td>items=0-1000</td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | Array[<a href="#/definitions/Supplier">Supplier</a>]| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/suppliers/{tsnSupplier} ### GET <a id="getSupplier">Returns the supplier identified by its thirdpartySystemNumber.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>tsnSupplier</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of supplier</td> <td> - </td> <td>integer (int64)</td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/Supplier">Supplier</a>| ### PUT <a id="updateSupplier">Returns the updated supplier</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>tsnSupplier</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of supplier</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>body</b></th> <td>body</td> <td>yes</td> <td>supplier article price relation to be modified</td> <td> - </td> <td> <a href="#/definitions/Supplier">Supplier</a> </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/Supplier">Supplier</a>| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/suppliers/{tsnSupplier}/termsofdelivery ### GET <a id="getTermsOfDeliverys">Returns a list of termsOfDelivery relations.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>tsnSupplier</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of supplier</td> <td> - </td> <td>integer (int64)</td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | Array[<a href="#/definitions/TermsOfDelivery">TermsOfDelivery</a>]| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/suppliers/{tsnSupplier}/termsofdelivery/{supplierTermsOfDeliveryId} ### GET <a id="getTermsOfDelivery">Returns supplier termsOfDelivery identified by its identifier.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>tsnSupplier</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of supplier</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>supplierTermsOfDeliveryId</b></th> <td>path</td> <td>yes</td> <td>identifier of the termsOfDelivery</td> <td> - </td> <td>integer (int64)</td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/TermsOfDelivery">TermsOfDelivery</a>| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/suppliers/{tsnSupplier}/termsofpayment ### GET <a id="getTermsOfPayments">Returns a list of termsOfPayment relations.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>tsnSupplier</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of supplier</td> <td> - </td> <td>integer (int64)</td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | Array[<a href="#/definitions/TermsOfPayment">TermsOfPayment</a>]| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/suppliers/{tsnSupplier}/termsofpayment/{supplierTermsOfPaymentId} ### GET <a id="getTermsOfPayment">Returns supplier termsOfPayment identified by its identifier.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>tsnSupplier</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of supplier</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>supplierTermsOfPaymentId</b></th> <td>path</td> <td>yes</td> <td>identifier of the termsOfPayment</td> <td> - </td> <td>integer (int64)</td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/TermsOfPayment">TermsOfPayment</a>| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/thresholdtypes ### GET <a id="getThresholds">Returns a list of thresholdtypes.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | Array[<a href="#/definitions/ThresholdType">ThresholdType</a>]| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/thresholdtypes/{identifier} ### GET <a id="getThresholdType">Returns the thresholdtype identified by its identifier.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>identifier</b></th> <td>path</td> <td>yes</td> <td>identifier of the thresholdtype</td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/ThresholdType">ThresholdType</a>| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/units ### GET <a id="getUnits">Returns a list of units.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | Array[<a href="#/definitions/Unit">Unit</a>]| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/units/{identifier} ### GET <a id="getUnit">Returns the unit identified by its identifier.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>identifier</b></th> <td>path</td> <td>yes</td> <td>identifier of the unit</td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/Unit">Unit</a>| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/vattypes ### GET <a id="getVATTypes">Returns al list of VAT types.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | Array[<a href="#/definitions/VATType">VATType</a>]| <hr/> ## /external/eprocurement/divisions/{tsnDivision}/vattypes/{identifier} ### GET <a id="getVATType">Returns the VAT type identified by its identifier.</a> #### Request **Content-Type: ** application/xml, application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <td><b>tsnDivision</b></th> <td>path</td> <td>yes</td> <td>thirdpartySystemNumber of logistic division</td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <td><b>identifier</b></th> <td>path</td> <td>yes</td> <td>identifier of the VAT type</td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/xml, application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/VATType">VATType</a>| <br/> # Definitions <br/> ## <a name="/definitions/Article">Article</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> integer (int64) </td> <td>required</td> <td>identifier of the article</td> </tr> <tr> <td>articleNumber</td> <td> string(20) </td> <td>required</td> <td>articleNumber of the article</td> </tr> <tr> <td>name</td> <td> string(150) </td> <td>required</td> <td>name of the article</td> </tr> <tr> <td>referenceArticleNumber</td> <td> string(20) </td> <td>optional</td> <td>external referenceNumber of the article</td> </tr> <tr> <td>unit</td> <td> <a href="#/definitions/UnitReference">UnitReference</a> </td> <td>required</td> <td>basic unit of the article</td> </tr> <tr> <td>materialGroup</td> <td> <a href="#/definitions/MaterialGroupReference">MaterialGroupReference</a> </td> <td>required</td> <td>material group of the article</td> </tr> <tr> <td>isCentralyMaintained</td> <td> boolean </td> <td>optional</td> <td>flag 'isCentralyMaintained' of the article</td> </tr> <tr> <td>vatType</td> <td> <a href="#/definitions/VATTypeReference">VATTypeReference</a> </td> <td>optional</td> <td>VAT type of the article</td> </tr> <tr> <td>packingUnits</td> <td> array[<a href="#/definitions/PackingUnit">PackingUnit</a>] </td> <td>optional</td> <td>packing units of the article</td> </tr> </table> ## <a name="/definitions/ArticleReference">ArticleReference</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> integer (int64) </td> <td>required</td> <td>identifier of the article</td> </tr> </table> ## <a name="/definitions/AuthenticationInformation">AuthenticationInformation</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>authMode</td> <td> enum (string) <br> <br> <option>Basic</option> <option>Bearer</option> <option>Hybrid</option> </td> <td>required</td> <td>authorization mode</td> </tr> <tr> <td>keycloak.json</td> <td> <a href="#/definitions/KeycloakJson">KeycloakJson</a> </td> <td>optional</td> <td>keycloak.json</td> </tr> </table> ## <a name="/definitions/CostCentre">CostCentre</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> integer (int64) </td> <td>required</td> <td>identifier of the costcentre</td> </tr> <tr> <td>costCentreNumber</td> <td> integer (int64) </td> <td>required</td> <td>number of the costcentre</td> </tr> <tr> <td>name</td> <td> string(100) </td> <td>required</td> <td>name of the costcentre</td> </tr> <tr> <td>customer</td> <td> <a href="#/definitions/Customer">Customer</a> </td> <td>optional</td> <td>customer of the costcentre</td> </tr> </table> ## <a name="/definitions/CostCentreReference">CostCentreReference</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> integer (int64) </td> <td>required</td> <td>identifier of the costCentre</td> </tr> </table> ## <a name="/definitions/Currency">Currency</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> string(4) </td> <td>required</td> <td>identifier of the currency</td> </tr> <tr> <td>shortName</td> <td> string(4) </td> <td>required</td> <td>shortname of the currency</td> </tr> <tr> <td>name</td> <td> string(50) </td> <td>required</td> <td>name of the currency</td> </tr> </table> ## <a name="/definitions/CurrencyReference">CurrencyReference</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> string(4) </td> <td>required</td> <td>identifier of the currency</td> </tr> </table> ## <a name="/definitions/Customer">Customer</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> integer (int64) </td> <td>required</td> <td>identifier of the customer</td> </tr> <tr> <td>shortName</td> <td> string(30) </td> <td>required</td> <td>shortname of the customer</td> </tr> <tr> <td>name</td> <td> string(120) </td> <td>required</td> <td>name of the customer</td> </tr> </table> ## <a name="/definitions/DeductionType">DeductionType</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> string(30) </td> <td>required</td> <td>identifier of the deduction type</td> </tr> <tr> <td>name</td> <td> string(400) </td> <td>required</td> <td>name of the deduction type</td> </tr> </table> ## <a name="/definitions/DeductionTypeReference">DeductionTypeReference</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> string(30) </td> <td>required</td> <td>identifier of the deduction type</td> </tr> </table> ## <a name="/definitions/DynamicCatalog">DynamicCatalog</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> integer (int64) </td> <td>required</td> <td>identifier of the dynamicCatalog</td> </tr> <tr> <td>shortName</td> <td> string(10) </td> <td>required</td> <td>shortname of the dynamicCatalog</td> </tr> <tr> <td>name</td> <td> string(100) </td> <td>required</td> <td>name of the dynamicCatalog</td> </tr> <tr> <td>isCentralyMaintained</td> <td> boolean </td> <td>optional</td> <td>flag if the dynamicCatalog is centraly maintained</td> </tr> <tr> <td>articlesOnlyOnLeaf</td> <td> boolean </td> <td>optional</td> <td>flag if articleRelations are only allowed on leaf</td> </tr> <tr> <td>uniqueArticleRelation</td> <td> boolean </td> <td>optional</td> <td>flag if articleRelations have to be unique</td> </tr> </table> ## <a name="/definitions/DynamicCatalogArticle">DynamicCatalogArticle</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> integer (int64) </td> <td>required</td> <td>identifier of the dynamicCatalogArticle</td> </tr> <tr> <td>article</td> <td> <a href="#/definitions/ArticleReference">ArticleReference</a> </td> <td>optional</td> <td>article of the dynamicCatalogArticle</td> </tr> <tr> <td>catalogEntry</td> <td> <a href="#/definitions/DynamicCatalogReference">DynamicCatalogReference</a> </td> <td>optional</td> <td>dynamicCatalog of the dynamicCatalogArticle</td> </tr> <tr> <td>catalog</td> <td> <a href="#/definitions/DynamicCatalogReference">DynamicCatalogReference</a> </td> <td>optional</td> <td>dynamicCatalog (root) of the dynamicCatalogArticle</td> </tr> <tr> <td>isCentralyMaintained</td> <td> boolean </td> <td>optional</td> <td>flag if the relation is centraly maintained</td> </tr> </table> ## <a name="/definitions/DynamicCatalogEntry">DynamicCatalogEntry</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> integer (int64) </td> <td>required</td> <td>identifier of the dynamicCatalogEntry</td> </tr> <tr> <td>shortName</td> <td> string(10) </td> <td>required</td> <td>shortname of the dynamicCatalogEntry</td> </tr> <tr> <td>name</td> <td> string(100) </td> <td>required</td> <td>name of the dynamicCatalogEntry</td> </tr> <tr> <td>parent</td> <td> <a href="#/definitions/DynamicCatalogReference">DynamicCatalogReference</a> </td> <td>optional</td> <td>parent dynamicCatalog of the dynamicCatalogEntry</td> </tr> <tr> <td>catalog</td> <td> <a href="#/definitions/DynamicCatalogReference">DynamicCatalogReference</a> </td> <td>optional</td> <td>dynamicCatalog (root) of the dynamicCatalogEntry</td> </tr> <tr> <td>isCentralyMaintained</td> <td> boolean </td> <td>optional</td> <td>flag if the relation is centraly maintained</td> </tr> </table> ## <a name="/definitions/DynamicCatalogReference">DynamicCatalogReference</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> integer (int64) </td> <td>required</td> <td>identifier of the dynamicCatalog</td> </tr> <tr> <td>shortName</td> <td> string(10) </td> <td>optional</td> <td>shortname of the dynamicCatalog</td> </tr> <tr> <td>name</td> <td> string(100) </td> <td>optional</td> <td>name of the dynamicCatalog</td> </tr> </table> ## <a name="/definitions/KeycloakJson">KeycloakJson</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>resource</td> <td> string </td> <td>optional</td> <td>resource</td> </tr> <tr> <td>ssl-required</td> <td> string </td> <td>optional</td> <td>sslRequired</td> </tr> <tr> <td>auth-server-url</td> <td> string </td> <td>optional</td> <td>authServerUrl</td> </tr> <tr> <td>realm</td> <td> string </td> <td>optional</td> <td>realm</td> </tr> <tr> <td>public-client</td> <td> boolean </td> <td>optional</td> <td>publicClient</td> </tr> </table> ## <a name="/definitions/LogisticDivision">LogisticDivision</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>facilityShortName</td> <td> string(30) </td> <td>required</td> <td>shortname of the facility</td> </tr> <tr> <td>facilityName</td> <td> string(120) </td> <td>required</td> <td>name of the facility</td> </tr> <tr> <td>name</td> <td> string(50) </td> <td>required</td> <td>name of the division</td> </tr> <tr> <td>thirdpartySystemNumber</td> <td> integer (int64) </td> <td>required</td> <td>tsn (thirdparty system number) of the division</td> </tr> <tr> <td>glnno</td> <td> integer (int64) </td> <td>optional</td> <td>-</td> </tr> <tr> <td>bgano</td> <td> integer (int64) </td> <td>optional</td> <td>-</td> </tr> </table> ## <a name="/definitions/MaterialGroup">MaterialGroup</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> integer (int64) </td> <td>required</td> <td>identifier of the material group</td> </tr> <tr> <td>shortName</td> <td> string(10) </td> <td>required</td> <td>shortname of the material group</td> </tr> <tr> <td>name</td> <td> string(100) </td> <td>required</td> <td>name of the material group</td> </tr> <tr> <td>parent</td> <td> <a href="#/definitions/MaterialGroupReference">MaterialGroupReference</a> </td> <td>optional</td> <td>parent material group of the material group</td> </tr> </table> ## <a name="/definitions/MaterialGroupReference">MaterialGroupReference</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> integer (int64) </td> <td>required</td> <td>identifier of the materialgroup</td> </tr> <tr> <td>shortName</td> <td> string(10) </td> <td>optional</td> <td>shortname of the materialgroup</td> </tr> <tr> <td>name</td> <td> string(100) </td> <td>optional</td> <td>name of the materialgroup</td> </tr> </table> ## <a name="/definitions/OrderReference">OrderReference</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>orderNumber</td> <td> integer (int64) </td> <td>required</td> <td>order number of the order</td> </tr> </table> ## <a name="/definitions/PackingUnit">PackingUnit</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> integer (int64) </td> <td>required</td> <td>identifier of the packing unit</td> </tr> <tr> <td>article</td> <td> <a href="#/definitions/ArticleReference">ArticleReference</a> </td> <td>required</td> <td>article of the packing unit</td> </tr> <tr> <td>basicUnit</td> <td> <a href="#/definitions/UnitReference">UnitReference</a> </td> <td>required</td> <td>basic unit of the article</td> </tr> <tr> <td>unit</td> <td> <a href="#/definitions/UnitReference">UnitReference</a> </td> <td>required</td> <td>unit of the packing unit</td> </tr> <tr> <td>factor</td> <td> number (double) </td> <td>required</td> <td>factor of the packing unit</td> </tr> <tr> <td>isReceipt</td> <td> boolean </td> <td>optional</td> <td>flag if the packing unit is valid for receipt process</td> </tr> <tr> <td>isReceiptDefault</td> <td> boolean </td> <td>optional</td> <td>flag if the packing unit is default for receipt process</td> </tr> <tr> <td>isOutgoing</td> <td> boolean </td> <td>optional</td> <td>flag if the packing unit is valid for outgoing process</td> </tr> <tr> <td>isOutgoingDefault</td> <td> boolean </td> <td>optional</td> <td>flag if the packing unit is default for outgoing process</td> </tr> <tr> <td>gtin</td> <td> string(100) </td> <td>optional</td> <td>gtin of the packing unit</td> </tr> <tr> <td>pzn</td> <td> string(100) </td> <td>optional</td> <td>pzn of the packing unit</td> </tr> <tr> <td>hibc</td> <td> string(254) </td> <td>optional</td> <td>hibc of the packing unit</td> </tr> <tr> <td>description</td> <td> string(100) </td> <td>optional</td> <td>description of the packing unit</td> </tr> </table> ## <a name="/definitions/PackingUnitReference">PackingUnitReference</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> integer (int64) </td> <td>required</td> <td>identifier of the packingunit</td> </tr> </table> ## <a name="/definitions/PurchOrder">PurchOrder</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>documentNumber</td> <td> string(20) </td> <td>optional</td> <td>documentNumber</td> </tr> <tr> <td>dateOfDocument</td> <td> string (ISO 8601 yyyy-MM-dd) </td> <td>required</td> <td>dateOfDocument</td> </tr> <tr> <td>supplier</td> <td> <a href="#/definitions/SupplierReference">SupplierReference</a> </td> <td>required</td> <td>supplier</td> </tr> <tr> <td>termsOfPayment</td> <td> <a href="#/definitions/TermsOfPaymentReference">TermsOfPaymentReference</a> </td> <td>optional</td> <td>termsOfPayment</td> </tr> <tr> <td>termsOfDelivery</td> <td> <a href="#/definitions/TermsOfDeliveryReference">TermsOfDeliveryReference</a> </td> <td>optional</td> <td>termsOfDelivery</td> </tr> <tr> <td>user</td> <td> <a href="#/definitions/UserReference">UserReference</a> </td> <td>optional</td> <td>user</td> </tr> <tr> <td>remark</td> <td> string(1800) </td> <td>optional</td> <td>remark</td> </tr> <tr> <td>currency</td> <td> <a href="#/definitions/CurrencyReference">CurrencyReference</a> </td> <td>optional</td> <td>currency</td> </tr> <tr> <td>purchOrderItems</td> <td> array[<a href="#/definitions/PurchOrderItem">PurchOrderItem</a>] </td> <td>optional</td> <td>purchOrderItems</td> </tr> </table> ## <a name="/definitions/PurchOrderItem">PurchOrderItem</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>order</td> <td> <a href="#/definitions/OrderReference">OrderReference</a> </td> <td>optional</td> <td>order</td> </tr> <tr> <td>article</td> <td> <a href="#/definitions/ArticleReference">ArticleReference</a> </td> <td>required</td> <td>article</td> </tr> <tr> <td>packingUnit</td> <td> <a href="#/definitions/PackingUnitReference">PackingUnitReference</a> </td> <td>required</td> <td>packing unit</td> </tr> <tr> <td>quantity</td> <td> number (double) </td> <td>required</td> <td>quantity in basic unit</td> </tr> <tr> <td>price</td> <td> number (double) </td> <td>required</td> <td>total price net for this purchOrderItem</td> </tr> <tr> <td>costCentre</td> <td> <a href="#/definitions/CostCentreReference">CostCentreReference</a> </td> <td>optional</td> <td>costCentre</td> </tr> <tr> <td>remark</td> <td> string(1800) </td> <td>optional</td> <td>remark</td> </tr> </table> ## <a name="/definitions/RebateInKind">RebateInKind</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> integer (int64) </td> <td>required</td> <td>identifier of the rebate in kind</td> </tr> <tr> <td>article</td> <td> <a href="#/definitions/ArticleReference">ArticleReference</a> </td> <td>required</td> <td>article of the rebate in kind</td> </tr> <tr> <td>quantity</td> <td> number (double) </td> <td>optional</td> <td>quantity</td> </tr> <tr> <td>percent</td> <td> number (double) </td> <td>optional</td> <td>percent</td> </tr> </table> ## <a name="/definitions/Supplier">Supplier</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>thirdpartySystemNumber</td> <td> integer (int64) </td> <td>required</td> <td>thirdpartySystemNumber of the supplier</td> </tr> <tr> <td>shortName</td> <td> string(30) </td> <td>required</td> <td>shortname of the supplier</td> </tr> <tr> <td>name</td> <td> string(120) </td> <td>required</td> <td>name of the supplier</td> </tr> <tr> <td>externalSupplierNumber</td> <td> string(30) </td> <td>optional</td> <td>external supplier identifier of the supplier</td> </tr> <tr> <td>identNumberVAT</td> <td> string(20) </td> <td>optional</td> <td>UST Ident of the supplier</td> </tr> <tr> <td>glnno</td> <td> integer (int64) </td> <td>optional</td> <td>glnno of the supplier</td> </tr> <tr> <td>bgano</td> <td> integer (int64) </td> <td>optional</td> <td>bgano of the supplier</td> </tr> <tr> <td>street</td> <td> string(46) </td> <td>optional</td> <td>street of the first address of the supplier</td> </tr> <tr> <td>houseNumber</td> <td> string(30) </td> <td>optional</td> <td>housenumber of the first address of the supplier</td> </tr> <tr> <td>postalCode</td> <td> string(10) </td> <td>optional</td> <td>postalcode of the first address of the supplier</td> </tr> <tr> <td>city</td> <td> string(50) </td> <td>optional</td> <td>city of the first address of the supplier</td> </tr> <tr> <td>currency</td> <td> <a href="#/definitions/CurrencyReference">CurrencyReference</a> </td> <td>required</td> <td>currency</td> </tr> <tr> <td>minOrderValue</td> <td> number (double) </td> <td>optional</td> <td>minimum order value</td> </tr> <tr> <td>isCentralyMaintained</td> <td> boolean </td> <td>optional</td> <td>flag 'isCentralyMaintained' of the supplier</td> </tr> </table> ## <a name="/definitions/SupplierArticle">SupplierArticle</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> integer (int64) </td> <td>required</td> <td>identifer of the supplier article relation</td> </tr> <tr> <td>supplier</td> <td> <a href="#/definitions/SupplierReference">SupplierReference</a> </td> <td>required</td> <td>reference to the supplier</td> </tr> <tr> <td>article</td> <td> <a href="#/definitions/ArticleReference">ArticleReference</a> </td> <td>required</td> <td>reference to the article</td> </tr> <tr> <td>packingUnit</td> <td> <a href="#/definitions/PackingUnitReference">PackingUnitReference</a> </td> <td>required</td> <td>reference to the packing unit</td> </tr> <tr> <td>articleNumberSupplier</td> <td> string(35) </td> <td>optional</td> <td>article number of supplier</td> </tr> <tr> <td>articleNameSupplier</td> <td> string(80) </td> <td>optional</td> <td>article name of supplier</td> </tr> <tr> <td>isMainSupplier</td> <td> boolean </td> <td>optional</td> <td>flag if supplier is main supplier</td> </tr> <tr> <td>isManufacturer</td> <td> boolean </td> <td>optional</td> <td>flag if supplier is manufacturer</td> </tr> <tr> <td>isCentralyMaintained</td> <td> boolean </td> <td>optional</td> <td>flag if supplier article relation is centraly maintained</td> </tr> </table> ## <a name="/definitions/SupplierArticlePrice">SupplierArticlePrice</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> integer (int64) </td> <td>required</td> <td>identifier of the relation</td> </tr> <tr> <td>supplierArticle</td> <td> <a href="#/definitions/SupplierArticleReference">SupplierArticleReference</a> </td> <td>required</td> <td>reference to the supplier article relation</td> </tr> <tr> <td>currency</td> <td> <a href="#/definitions/CurrencyReference">CurrencyReference</a> </td> <td>required</td> <td>currency of prices</td> </tr> <tr> <td>basicPrice</td> <td> number (double) </td> <td>required</td> <td>basic price (in basicUnit)</td> </tr> <tr> <td>validFrom</td> <td> string (ISO 8601 yyyy-MM-dd) </td> <td>required</td> <td>valid from</td> </tr> <tr> <td>validTo</td> <td> string (ISO 8601 yyyy-MM-dd) </td> <td>optional</td> <td>valid through</td> </tr> <tr> <td>isCentralyMaintained</td> <td> boolean </td> <td>optional</td> <td>flag if the relation is centraly maintained</td> </tr> <tr> <td>deductionType</td> <td> <a href="#/definitions/DeductionTypeReference">DeductionTypeReference</a> </td> <td>optional</td> <td>deduction type for priceScales</td> </tr> <tr> <td>thresholdType</td> <td> <a href="#/definitions/ThresholdTypeReference">ThresholdTypeReference</a> </td> <td>optional</td> <td>threshold type for priceScales</td> </tr> <tr> <td>supplierArticlePriceScales</td> <td> array[<a href="#/definitions/SupplierArticlePriceScale">SupplierArticlePriceScale</a>] </td> <td>optional</td> <td>price scales</td> </tr> </table> ## <a name="/definitions/SupplierArticlePriceScale">SupplierArticlePriceScale</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> integer (int64) </td> <td>required</td> <td>identifier of the price scale</td> </tr> <tr> <td>threshold</td> <td> number (double) </td> <td>required</td> <td>threshold</td> </tr> <tr> <td>deduction</td> <td> number (double) </td> <td>optional</td> <td>deduction</td> </tr> <tr> <td>rebateInKind</td> <td> <a href="#/definitions/RebateInKind">RebateInKind</a> </td> <td>optional</td> <td>rebate in kind</td> </tr> <tr> <td>isCentralyMaintained</td> <td> boolean </td> <td>optional</td> <td>flag if the price scale is centraly maintained</td> </tr> </table> ## <a name="/definitions/SupplierArticleReference">SupplierArticleReference</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> integer (int64) </td> <td>required</td> <td>identifier of the article</td> </tr> </table> ## <a name="/definitions/SupplierReference">SupplierReference</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>thirdpartySystemNumber</td> <td> integer (int64) </td> <td>required</td> <td>thirdparty system number of the supplier</td> </tr> </table> ## <a name="/definitions/TermsOfDelivery">TermsOfDelivery</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> integer (int64) </td> <td>required</td> <td>identifier of the terms</td> </tr> <tr> <td>shortName</td> <td> string(10) </td> <td>required</td> <td>shortname of the terms</td> </tr> <tr> <td>name</td> <td> string(50) </td> <td>required</td> <td>name of the terms</td> </tr> </table> ## <a name="/definitions/TermsOfDeliveryReference">TermsOfDeliveryReference</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> integer (int64) </td> <td>required</td> <td>identifier of the terms</td> </tr> </table> ## <a name="/definitions/TermsOfPayment">TermsOfPayment</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> integer (int64) </td> <td>required</td> <td>identifier of the termsOfPayment</td> </tr> <tr> <td>shortName</td> <td> string(20) </td> <td>required</td> <td>shortname of the termsOfPayment</td> </tr> <tr> <td>name</td> <td> string(100) </td> <td>required</td> <td>name of the termsOfPayment</td> </tr> <tr> <td>isDefault</td> <td> boolean </td> <td>optional</td> <td>default termsOfPayment for the supplier</td> </tr> </table> ## <a name="/definitions/TermsOfPaymentReference">TermsOfPaymentReference</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> integer (int64) </td> <td>required</td> <td>identifier of the terms</td> </tr> </table> ## <a name="/definitions/ThresholdType">ThresholdType</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> string(30) </td> <td>required</td> <td>identifier of the threshold type</td> </tr> <tr> <td>name</td> <td> string(400) </td> <td>required</td> <td>name of the threshold type</td> </tr> </table> ## <a name="/definitions/ThresholdTypeReference">ThresholdTypeReference</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> string(30) </td> <td>required</td> <td>identifier of the threshold type</td> </tr> </table> ## <a name="/definitions/Unit">Unit</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> string(30) </td> <td>required</td> <td>identifier of the unit</td> </tr> <tr> <td>shortName</td> <td> string(30) </td> <td>required</td> <td>shortname of the unit</td> </tr> <tr> <td>name</td> <td> string(400) </td> <td>required</td> <td>name of the unit</td> </tr> </table> ## <a name="/definitions/UnitReference">UnitReference</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> string(30) </td> <td>required</td> <td>identifier of the unit</td> </tr> <tr> <td>shortName</td> <td> string(30) </td> <td>required</td> <td>shortname of the unit</td> </tr> <tr> <td>name</td> <td> string(400) </td> <td>required</td> <td>name of the unit</td> </tr> </table> ## <a name="/definitions/UserReference">UserReference</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> string(60) </td> <td>required</td> <td>identifier of the user</td> </tr> </table> ## <a name="/definitions/VATType">VATType</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> string(30) </td> <td>required</td> <td>identifier of the VAT Type</td> </tr> <tr> <td>name</td> <td> string(400) </td> <td>required</td> <td>name of the VAT Type</td> </tr> <tr> <td>countryCode</td> <td> string(4) </td> <td>required</td> <td>country code of the VAT Type</td> </tr> <tr> <td>validFrom</td> <td> string (ISO 8601 yyyy-MM-dd) </td> <td>required</td> <td>valid from of the VAT Type</td> </tr> <tr> <td>validTo</td> <td> string (ISO 8601 yyyy-MM-dd) </td> <td>optional</td> <td>valid through of the VAT Type</td> </tr> </table> ## <a name="/definitions/VATTypeReference">VATTypeReference</a> <table border="1"> <tr></tr> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> </tr> <tr> <td>identifier</td> <td> string(30) </td> <td>required</td> <td>identifier of the VAT type</td> </tr> <tr> <td>name</td> <td> string(400) </td> <td>optional</td> <td>name of the VAT type</td> </tr> </table>