WebAPI - Creating a customer

WebAPI - Creating a customer

This method allows to create a customer in a simplified manner. 
The method to be used when creating a customer:
POST url/api/mytenant/myorganization/businesscore/customerparties
Json example for creating a customer:
  1. {
        "settlementDiscountPercent": 12.000000,
        "partyKey": "001",
        "name": "Kinet",
        "keyword": "Kinet",
        "companyTaxID": null,
        "electronicMail": null,
        "telephone": null,
        "mobile": null,
        "websiteUrl": null,
        "notes": null,
        "picture": null,
        "pictureThumbnail": null,
        "streetName": null,
        "buildingNumber": null,
        "postalZone": null,
        "cityName": null,
        "contactName": "Kinet",
        "username": null,
        "customerGroup": "CF",
        "currency": "EUR",
        "country": "PT",
        "partyAddresses": [
            {
                "streetName": "rua maria",
                "buildingNumber": "456",
                "postalZone": "3456-453",
                "cityName": "António",
                "contactName": "098098098",
                "contactTitle": "Tec",
                "country": "PT"
            }
        ],
        "partyContacts": [
            {
                "contactTitle": "técnico",
                "contactName": "Joao",
                "electronicMail": null,
                "mobile": "676767678",
                "telephone": "234234234",
                "contactType": "01"
            }
        ],
        "culture": "PT-PT"
    }

This method allows to create a customer according to the parameters filled in:

  1. settlementDiscountpercent: Customer discount percentage. 
  2. partyKey: The customer's key. This field is mandatory.
  3. name: Short description of the customer. This field is mandatory.
  4. keyword: Short description of the customer.
  5. companyTaxID: Tax ID number.
  6. electronicMail: Customer email.
  7. telephone: Telephone number.
  8. mobile: Mobile phone number.
  9. websiteUrl: Website.
  10. notes: Remarks.
  11. picture: the image. 
  12. streetName: Street.
  13. buildingNumber: Building number.
  14. postalZone: Postal code.
  15. cityName: City.
  16. contactName: Short description of the customer.
  17. username: User name.
  18. customerGroup: The key of the group of customers. This field is mandatory.
  19. currency: The currency's key.
  20. country: Key of the country, this field is mandatory.
  21. partyAddresses: Additional addresses.
  22. partyContacts: Additional contacts.
  23. culture: The culture's key. This field is mandatory.

When this method is executed successfully, it returns HttpStatusCode.OK.

 


    • Related Articles

    • WebAPI - Creating a warehouse

      This method allows to create a warehouse in a simplified manner. The method to be used when creating a warehouse: POST url/api/mytenant/myorganization/inventorycore/warehouses Json example for creating a warehouse: 1. { "warehouseKey": "W2", ...

    • WebAPI - Creating a request

      This method allows to create a request in a simplified manner. The method to be used when creating a request: POST url/api/mytenant/myorganization/Requests/requests Json example for creating a request: { "requestKey": "00001", "description": "Vidro ...

    • WebAPI - Creating a tool

      This method allows to create a tool in a simplified manner. The method to be used when creating a tool is: POST url/api/mytenant/myorganization/assetmanagementcore/equipmentItems Json example for creating a tool: 1.     {     "equipmentKey": "PCR", ...

    • WebAPI - Creating an equipment

      This method allows to create an equipment in a simplified manner. The method to be used when creating an equipment: POST url/api/mytenant/myorganization/assetmanagementcore/equipmentItems Json example for creating an equipment: 1.       { ...

    • WebAPI – How do I create work orders?

      This method offers a simple way of creating a Work Order for a specific Asset, Location, Tool or Route. The method to be used to create a work order is: POST /api/mytenant/myorganization/maintenance/workorders/newWorkOrderInfo Json example to create ...