2024 December Release

Material Master DataPermanent link for this heading

The material master data web service allows creating and updating materials and price conditions.

Note:

  • Retrieve the WSDL to get an overview of the general options. The JSON requests correspond to the SOAP XML requests as you can see in the examples below.
  • The shelves are identified either by the Import ID or Fabasoft Cloud ID.
  • The materials are identified by the Material Number or Fabasoft Cloud ID.
  • The price conditions are identified by the Price Condition ID or Fabasoft Cloud ID.
  • The sales organizations are identified by the Company Code (the field has to be enabled in the contact management configuration) or Fabasoft Cloud ID.
  • If a property (short reference) is defined in FSCMATERIALMASTERDATA_1_1001_overridekeys, empty values are taken over and lists are overwritten.
  • The decimal places of a floating point number are separated by a dot.
  • lscode supports ISO codes like en, de or de-at of available languages.
  • currsymbol supports all currencies (e.g. EUR or USD) that you can see when defining a currency in the user interface.
  • pcdcalculationrule supports following integer values;
    • 1: Percentage
    • 2: Fixed Amount
    • 3: Quantity
    • 4: Gross Weight
    • 5: Net Weight
    • 6: Volume
    • 7: Formula
    • 8: Percentage (In Hundred)
    • 9: Percentage (Travel Expenses)
    • 10: Quantity - Monthly Price
    • 11: Quantity - Yearly Price
    • 12: Quantity - Daily Price
    • 13: Quantity - Weekly Price
    • 14: Commodity Price
  • pcdpricescaletype supports following integer values;
    • 1: No Scale
    • 2: Quantity Scale
  • psdkind supports following integer values;
    • 1: From Scale
    • 2: To Scale

SOAP and WSDLPermanent link for this heading

The WSDL can be retrieved via following URL:

https://<host>/<vdir>/fscdav/wsdl?WEBSVC=FSCMATERIALMASTERDATA_1_1001_MasterialMasterDataWebService

Example:

https://at.cloud.fabasoft.com/folio/fscdav/wsdl?WEBSVC=FSCMATERIALMASTERDATA_1_1001_MasterialMasterDataWebService: new window

JSONPermanent link for this heading

You can call the operations the following way:

https://<host>/<vdir>/wsjson/ FSCMATERIALMASTERDATA_1_1001_MasterialMasterDataWebService/<operation>

Example:

https://at.cloud.fabasoft.com/folio/wsjson/FSCMATERIALMASTERDATA_1_1001_MasterialMasterDataWebService/UpdateMaterial: new window

Available OperationsPermanent link for this heading

The material master data web service provides following operations:

  • GetMaterial
    Retrieves a material.
    Note: If several materials with the same material number are found, a list of materials is returned.
  • UpdateMaterial
    Creates a new material or updates an existing one.
  • GetPriceCondition
    Retrieves a price condition.
    Note: If several price conditions with the same price condition ID are found, a list of price conditions is returned.
  • UpdatePriceCondition
    Creates a new price condition or updates an existing one.

ExamplesPermanent link for this heading

The following chapters provide several contact management web service examples.

GetMaterialPermanent link for this heading

In the following example the material Mat-16-A (Material Number) is retrieved from the material shelf with Import ID MR1 that is assigned to the material master data configuration with Import ID MC1.

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:fsc="http://schemas.fabasoft.com/websvc/
  FSCMATERIALMASTERDATA_1_1001_MasterialMasterDataWebService/">
   <soapenv:Header/>
   <soapenv:Body>
      <fsc:GetMaterial>
         <fsc:materialnumber>Mat-16-A</fsc:materialnumber>
         <fsc:materialroomid>MR1</fsc:materialroomid>
         <fsc:materialconfigid>MC1</fsc:materialconfigid>
      </fsc:GetMaterial>
   </soapenv:Body>
</soapenv:Envelope>

JSON Request

{
  "materialnumber": "Mat-16-A",
  "materialroomid": "MR1",
  "materialconfigid": "MC1"
}

UpdateMaterialPermanent link for this heading

In the following example the material Mat-16-A (Material Number) is imported with a German and English name and two sales organizations are assigned. In addition, a quantity unit and an alternative quantity unit with a conversion factor are defined. Note that the properties mdmaterialname and mdownersalesorganization are defined as override keys. This way the empty value for mdownersalesorganization  will be considered and the mdmaterialname list is overwritten (instead of adding new entries to existing ones).

Example

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:fsc="http://schemas.fabasoft.com/websvc/
  FSCMATERIALMASTERDATA_1_1001_MasterialMasterDataWebService/">
  <soapenv:Header/>
   <soapenv:Body>
      <fsc:UpdateMaterial>
         <fsc:data>
            <fsc:FSCMATERIALMASTERDATA_1_1001_mdmaterialroomid>MR1
             </fsc:FSCMATERIALMASTERDATA_1_1001_mdmaterialroomid>
            <fsc:FSCMATERIALMASTERDATA_1_1001_mdmaterialnumber>Mat-16-A
              </fsc:FSCMATERIALMASTERDATA_1_1001_mdmaterialnumber>
            <fsc:FSCMATERIALMASTERDATA_1_1001_mdmaterialname>
               <fsc:FSCOWSSTDSERVICES_1_1001_LangStr>
                  <fsc:FSCOWSSTDSERVICES_1_1001_lscode>de
                    </fsc:FSCOWSSTDSERVICES_1_1001_lscode>
                  <fsc:FSCOWSSTDSERVICES_1_1001_lsstr>Schraube 16-A
                    </fsc:FSCOWSSTDSERVICES_1_1001_lsstr>
               </fsc:FSCOWSSTDSERVICES_1_1001_LangStr>
               <fsc:FSCOWSSTDSERVICES_1_1001_LangStr>
                  <fsc:FSCOWSSTDSERVICES_1_1001_lscode>en
                    </fsc:FSCOWSSTDSERVICES_1_1001_lscode>
                  <fsc:FSCOWSSTDSERVICES_1_1001_lsstr>Screw 16-A
                    </fsc:FSCOWSSTDSERVICES_1_1001_lsstr>
               </fsc:FSCOWSSTDSERVICES_1_1001_LangStr>
            </fsc:FSCMATERIALMASTERDATA_1_1001_mdmaterialname>
            <fsc:FSCMATERIALMASTERDATA_1_1001_mdownersalesorganization>
              </fsc:FSCMATERIALMASTERDATA_1_1001_mdownersalesorganization>
            <fsc:FSCMATERIALMASTERDATA_1_1001_mdsalesorganizations>
               <fsc:string>C1242</fsc:string>
               <fsc:string>C3421</fsc:string>
            </fsc:FSCMATERIALMASTERDATA_1_1001_mdsalesorganizations>
            <fsc:FSCMATERIALMASTERDATA_1_1001_mdprimaryunitid>ME1
              </fsc:FSCMATERIALMASTERDATA_1_1001_mdprimaryunitid>
            <fsc:FSCMATERIALMASTERDATA_1_1001_mdalternativeunits>
               <fsc:FSCMATERIALMASTERDATA_1_1001_AlternateQuantityUnitData>
                  <fsc:FSCMATERIALMASTERDATA_1_1001_aquunitkey>ME2
                    </fsc:FSCMATERIALMASTERDATA_1_1001_aquunitkey>
                  <fsc:FSCMATERIALMASTERDATA_1_1001_aquconversionfactor>0.1
                    </fsc:FSCMATERIALMASTERDATA_1_1001_aquconversionfactor>
               </fsc:FSCMATERIALMASTERDATA_1_1001_AlternateQuantityUnitData>
            </fsc:FSCMATERIALMASTERDATA_1_1001_mdalternativeunits>
            <fsc:FSCMATERIALMASTERDATA_1_1001_overridekeys>
               <fsc:string>mdmaterialname</fsc:string>
               <fsc:string>mdownersalesorganization</fsc:string>
            </fsc:FSCMATERIALMASTERDATA_1_1001_overridekeys>
         </fsc:data>
      </fsc:UpdateMaterial>
   </soapenv:Body>
</soapenv:Envelope>

JSON Request

{
  "data": {
    "mdmaterialroomid": "MR1",
    "mdmaterialnumber": "Mat-16-A",
    "mdmaterialname": [
      {
        "lscode": "de",
        "lsstr": "Schraube 16-A"
      },
      {
        "lscode": "en",
        "lsstr": "Screw 16-A"
      }
    ],
    "mdownersalesorganization": null,
    "mdsalesorganizations": [
      "C1242",
      "C3421"
    ],
    "mdprimaryunitid": "ME1",
    "mdalternativeunits": {
    "AlternateQuantityUnitData": {
      "aquunitkey": "ME2",
      "aquconversionfactor": "0.1"
    }
    "overridekeys": [
      "mdmaterialname",
      "mdownersalesorganization"
    ]
  }
}

GetPriceConditionPermanent link for this heading

In the following example the price condition PR-22 (Price Condition ID) is retrieved from the price list with Import ID PL1 that is assigned to the material master data configuration with Import ID MC1.

Example

SOAP Request

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
  xmlns:fsc="http://schemas.fabasoft.com/websvc/
  FSCMATERIALMASTERDATA_1_1001_MasterialMasterDataWebService/">
   <soap:Header/>
   <soap:Body>
      <fsc:GetPriceCondition>
         <fsc:priceconditionid>PR-22</fsc:priceconditionid>
         <fsc:priceconditionroomid>PL1</fsc:priceconditionroomid>
         <fsc:materialconfigid>MC1</fsc:materialconfigid>
      </fsc:GetPriceCondition>
   </soap:Body>
</soap:Envelope>

JSON Request

{
  "priceconditionid": "PR-22",
  "priceconditionroomid": "PL1",
  "materialconfigid": "MC1"
}

UpdatePriceConditionPermanent link for this heading

In the following example the price condition PR-23 (Price Condition ID) is imported. The material Mat-16-A (Material Number) and the sales organization C1242 (Company Code) is assigned. Several prices and the valid period are defined. objvalidfrom is defined as override key, so that an empty value will be considered.

Example

SOAP Request

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
  xmlns:fsc="http://schemas.fabasoft.com/websvc/
  FSCMATERIALMASTERDATA_1_1001_MasterialMasterDataWebService/">
   <soap:Header/>
   <soap:Body>
      <fsc:UpdatePriceCondition>
         <fsc:data>
            <fsc:FSCMATERIALMASTERDATA_1_1001_pcdpriceconditionroomid>PR1
             </fsc:FSCMATERIALMASTERDATA_1_1001_pcdpriceconditionroomid>
            <fsc:FSCMATERIALMASTERDATA_1_1001_pcdidentification>PR-23
              </fsc:FSCMATERIALMASTERDATA_1_1001_pcdidentification>
            <fsc:FSCMATERIALMASTERDATA_1_1001_pcdmaterialnumber>Mat-16-A
              </fsc:FSCMATERIALMASTERDATA_1_1001_pcdmaterialnumber>
            <fsc:FSCMATERIALMASTERDATA_1_1001_pcdsalesorganization>C1242
              </fsc:FSCMATERIALMASTERDATA_1_1001_pcdsalesorganization>
            <fsc:FSCMATERIALMASTERDATA_1_1001_pcvalidfrom>2024-06-23
              </fsc:FSCMATERIALMASTERDATA_1_1001_pcvalidfrom>
            <fsc:FSCMATERIALMASTERDATA_1_1001_pcvalidto>2025-06-23
              </fsc:FSCMATERIALMASTERDATA_1_1001_pcvalidto>
            <fsc:FSCMATERIALMASTERDATA_1_1001_pcdpriceunitid>ME1
              </fsc:FSCMATERIALMASTERDATA_1_1001_pcdpriceunitid>
            <fsc:FSCMATERIALMASTERDATA_1_1001_pcdcurrencyamount>
               <fsc:FSCMATERIALMASTERDATA_1_1001_currsymbol>EUR
                 </fsc:FSCMATERIALMASTERDATA_1_1001_currsymbol>
               <fsc:COOSYSTEM_1_1_currvalue>170.5
                 </fsc:COOSYSTEM_1_1_currvalue>
            </fsc:FSCMATERIALMASTERDATA_1_1001_pcdcurrencyamount>
            <fsc:FSCMATERIALMASTERDATA_1_1001_pcdcurrencylowerlimit>
               <fsc:FSCMATERIALMASTERDATA_1_1001_currsymbol>USD
                 </fsc:FSCMATERIALMASTERDATA_1_1001_currsymbol>
               <fsc:COOSYSTEM_1_1_currvalue>10
                 </fsc:COOSYSTEM_1_1_currvalue>
            </fsc:FSCMATERIALMASTERDATA_1_1001_pcdcurrencylowerlimit>
            <fsc:FSCMATERIALMASTERDATA_1_1001_pcdcurrencyupperlimit>
               <fsc:FSCMATERIALMASTERDATA_1_1001_currsymbol>USD
                 </fsc:FSCMATERIALMASTERDATA_1_1001_currsymbol>
               <fsc:COOSYSTEM_1_1_currvalue>200
                 </fsc:COOSYSTEM_1_1_currvalue>
            </fsc:FSCMATERIALMASTERDATA_1_1001_pcdcurrencyupperlimit>
            <fsc:FSCMATERIALMASTERDATA_1_1001_pcdcalculationrule>5
              </fsc:FSCMATERIALMASTERDATA_1_1001_pcdcalculationrule>
            <fsc:FSCMATERIALMASTERDATA_1_1001_pcdpricescaletype>2
              </fsc:FSCMATERIALMASTERDATA_1_1001_pcdpricescaletype>
            <fsc:FSCMATERIALMASTERDATA_1_1001_pcdpricescale>
               <fsc:FSCMATERIALMASTERDATA_1_1001_psdkind>2
                 </fsc:FSCMATERIALMASTERDATA_1_1001_psdkind>
               <fsc:FSCMATERIALMASTERDATA_1_1001_psdentries>
                  <fsc:FSCMATERIALMASTERDATA_1_1001_PriceScaleEntryData>
                     <fsc:FSCMATERIALMASTERDATA_1_1001_psedquantity>100
                       </fsc:FSCMATERIALMASTERDATA_1_1001_psedquantity>
                     <fsc:FSCMATERIALMASTERDATA_1_1001_psedconditionamount>
                        <fsc:FSCMATERIALMASTERDATA_1_1001_currsymbol>EUR
                          </fsc:FSCMATERIALMASTERDATA_1_1001_currsymbol>
                        <fsc:COOSYSTEM_1_1_currvalue>160
                          </fsc:COOSYSTEM_1_1_currvalue>
                     </fsc:FSCMATERIALMASTERDATA_1_1001_psedconditionamount>
                   </fsc:FSCMATERIALMASTERDATA_1_1001_PriceScaleEntryData>
                   <fsc:FSCMATERIALMASTERDATA_1_1001_PriceScaleEntryData>  
                     <fsc:FSCMATERIALMASTERDATA_1_1001_psedquantity>200
                       </fsc:FSCMATERIALMASTERDATA_1_1001_psedquantity>
                     <fsc:FSCMATERIALMASTERDATA_1_1001_psedconditionamount>
                        <fsc:FSCMATERIALMASTERDATA_1_1001_currsymbol>EUR
                          </fsc:FSCMATERIALMASTERDATA_1_1001_currsymbol>
                        <fsc:COOSYSTEM_1_1_currvalue>140
                          </fsc:COOSYSTEM_1_1_currvalue>
                     </fsc:FSCMATERIALMASTERDATA_1_1001_psedconditionamount>
                  </fsc:FSCMATERIALMASTERDATA_1_1001_PriceScaleEntryData>
               </fsc:FSCMATERIALMASTERDATA_1_1001_psdentries>
            </fsc:FSCMATERIALMASTERDATA_1_1001_pcdpricescale>
            <fsc:FSCMATERIALMASTERDATA_1_1001_overridekeys>
               <fsc:string>objvalidfrom</fsc:string>
            </fsc:FSCMATERIALMASTERDATA_1_1001_overridekeys>
         </fsc:data>
      </fsc:UpdatePriceCondition>
   </soap:Body>
</soap:Envelope>

JSON Request

{
  "data": {
    "pcdpriceconditionroomid": "PR1",
    "pcdidentification": "PR-23",
    "pcdmaterialnumber": "Mat-16-A",
    "pcdsalesorganization": "C1242",
    "pcvalidfrom": "2024-06-23",
    "pcvalidto": "2025-06-23",
    "pcdpriceunitid": "ME1",
    "pcdcurrencyamount": {
      "currsymbol": "EUR",
      "currvalue": "170.5"
    },
    "pcdcurrencylowerlimit": {
      "currsymbol": "USD",
      "currvalue": "10"
    },
    "pcdcurrencyupperlimit": {
      "currsymbol": "USD",
      "currvalue": "200"
    },
    "pcdcalculationrule": "5",
    "pcdpricescaletype": "2",
    "pcdpricescale": {
      "psdkind": "2",
      "psdentries": [
        {
          "psedquantity": "100",
          "psedconditionamount": {
            "currsymbol": "EUR",
            "currvalue": "160"
          }
        },
        {
          "psedquantity": "200",
          "psedconditionamount": {
            "currsymbol": "EUR",
            "currvalue": "140"
          }
        }
      ]
    },
    "overridekeys": [
      "objvalidfrom"
    ]
  }
}

Download PDF

Download PDF