{"id":36238,"date":"2024-08-21T13:59:09","date_gmt":"2024-08-21T12:59:09","guid":{"rendered":"https:\/\/developers.ila.cegid.com\/valuekeep\/\/"},"modified":"2024-12-26T15:18:45","modified_gmt":"2024-12-26T14:18:45","slug":"webapi-creating-a-customer","status":"publish","type":"valuekeep","link":"https:\/\/developers.ila.cegid.com\/en\/valuekeep\/development-en\/workshops-and-employees\/article\/webapi-creating-a-customer","title":{"rendered":"How to create a customer?"},"content":{"rendered":"
This method allows to create a customer in a simplified manner. <\/span><\/div>\n
The method to be used when creating a customer: <\/span>POST url\/api\/mytenant\/myorganization\/businesscore\/customerparties<\/span><\/div>\n
Json example for creating a customer: <\/span><\/div>\n
\n
{\r\n\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"settlementDiscountPercent\":\u00a012.000000,\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"partyKey\":\u00a0\"001\",\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"name\":\u00a0\"Kinet\",\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"keyword\":\u00a0\"Kinet\",\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"companyTaxID\":\u00a0null,\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"electronicMail\":\u00a0null,\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"telephone\":\u00a0null,\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"mobile\":\u00a0null,\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"websiteUrl\":\u00a0null,\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"notes\":\u00a0null,\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"picture\":\u00a0null,\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"pictureThumbnail\":\u00a0null,\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"streetName\":\u00a0null,\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"buildingNumber\":\u00a0null,\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"postalZone\":\u00a0null,\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"cityName\":\u00a0null,\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"contactName\":\u00a0\"Kinet\",\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"username\":\u00a0null,\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"customerGroup\":\u00a0\"CF\",\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"currency\":\u00a0\"EUR\",\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"country\":\u00a0\"PT\",\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"partyAddresses\":\u00a0[\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0{\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"streetName\":\u00a0\"rua\u00a0maria\",\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"buildingNumber\":\u00a0\"456\",\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"postalZone\":\u00a0\"3456-453\",\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"cityName\":\u00a0\"Ant\u00f3nio\",\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"contactName\":\u00a0\"098098098\",\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"contactTitle\":\u00a0\"Tec\",\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"country\":\u00a0\"PT\"\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0}\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0],\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"partyContacts\":\u00a0[\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0{\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"contactTitle\":\u00a0\"t\u00e9cnico\",\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"contactName\":\u00a0\"Joao\",\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"electronicMail\":\u00a0null,\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"mobile\":\u00a0\"676767678\",\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"telephone\":\u00a0\"234234234\",\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"contactType\":\u00a0\"01\"\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0}\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0],\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"culture\":\u00a0\"PT-PT\"\r\n\r\n\r\n}<\/pre>\n<\/div>\n
\n
This method allows to create a customer according to the parameters filled in:<\/span><\/p>\n
    \n
  • settlementDiscountpercent: Customer discount percentage.\u00a0<\/span><\/li>\n
  • partyKey: The customer’s key. This field is mandatory.<\/span><\/li>\n
  • name: Short description of the customer. This field is mandatory.<\/span><\/li>\n
  • keyword: Short description of the customer.<\/span><\/li>\n
  • companyTaxID:\u00a0Tax ID number.<\/span><\/li>\n
  • electronicMail: Customer email.<\/span><\/li>\n
  • telephone: Telephone number.<\/span><\/li>\n
  • mobile: Mobile phone number.<\/span><\/li>\n
  • websiteUrl: Website.<\/span><\/li>\n
  • notes:\u00a0Remarks.<\/span><\/li>\n
  • picture:\u00a0the image.\u00a0<\/span><\/li>\n
  • streetName:\u00a0Street.<\/span><\/li>\n
  • buildingNumber: Building number.<\/span><\/li>\n
  • postalZone:\u00a0Postal code.<\/span><\/li>\n
  • cityName:\u00a0City.<\/span><\/li>\n
  • contactName: Short description of the customer.<\/span><\/li>\n
  • username: User name.<\/span><\/li>\n
  • customerGroup: The key of the <\/span>group of customers. This field is mandatory.<\/span><\/li>\n
  • currency: The currency’s key.<\/span><\/li>\n
  • country: Key of the country, this field is mandatory.<\/span><\/li>\n
  • partyAddresses: Additional addresses.<\/span><\/li>\n
  • partyContacts: Additional contacts.<\/span><\/li>\n
  • culture: The culture’s key. This field is mandatory.<\/span><\/li>\n<\/ul>\n
    When this method is executed successfully, it returns HttpStatusCode.OK.<\/span><\/p>\n
    \u00a0<\/span><\/p>\n<\/div>\n<\/div><\/section>\n","protected":false},"excerpt":{"rendered":"","protected":false},"featured_media":0,"menu_order":0,"comment_status":"open","ping_status":"open","template":"","format":"standard","tags":[901],"videos_tax":[],"post-type":[],"categoria-valuekeep":[945],"class_list":["post-36238","valuekeep","type-valuekeep","status-publish","format-standard","hentry","tag-clients","categoria-valuekeep-workshops-and-employees"],"_links":{"self":[{"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/valuekeep\/36238","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/valuekeep"}],"about":[{"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/types\/valuekeep"}],"replies":[{"embeddable":true,"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/comments?post=36238"}],"version-history":[{"count":0,"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/valuekeep\/36238\/revisions"}],"wp:attachment":[{"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/media?parent=36238"}],"wp:term":[{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/tags?post=36238"},{"taxonomy":"videos_tax","embeddable":true,"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/videos_tax?post=36238"},{"taxonomy":"post-type","embeddable":true,"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/post-type?post=36238"},{"taxonomy":"categoria-valuekeep","embeddable":true,"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/categoria-valuekeep?post=36238"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}