Edit

Share via

Create vendors

  • Article

Create a vendor object in Business Central.

HTTP request

Replace the URL prefix for Business Central depending on environment following the guideline.

POST businesscentralPrefix/companies({id})/vendors

Request headers

Header Value
Authorization Bearer {token}. Required.
Content-Type application/json

Request body

In the request body, supply a JSON representation of a vendors object.

Response

If successful, this method returns 201 Created response code and a vendors object in the response body.

Example

Request

Here is an example of a request.

POST https://{businesscentralPrefix}/api/v2.0/companies({id})/vendors
Content-type: application/json

{
    "id": "f7a5738a-44e3-ea11-bb43-000d3a2feca1",
    "number": "10000",
    "displayName": "Fabrikam, Inc.",
    "addressLine1": "10 North Lake Avenue",
    "addressLine2": "",
    "city": "Atlanta",
    "state": "GA",
    "country": "US",
    "postalCode": "31772",
    "phoneNumber": "4255550101",
    "email": "krystal.york@contoso.com",
    "website": "www.royalmail.co.uk",
    "taxRegistrationNumber": "",
    "currencyId": "00000000-0000-0000-0000-000000000000",
    "currencyCode": "USD",
    "irs1099Code": "",
    "paymentTermsId": "0aa5738a-44e3-ea11-bb43-000d3a2feca1",
    "paymentMethodId": "3b196a90-44e3-ea11-bb43-000d3a2feca1",
    "taxLiable": true,
    "blocked": " "
}

Response

Here is an example of the response.

Note

The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 201 Created
Content-type: application/json

{
  "id": "f7a5738a-44e3-ea11-bb43-000d3a2feca1",
  "number": "10000",
  "displayName": "Fabrikam, Inc.",
  "addressLine1": "10 North Lake Avenue",
  "addressLine2": "",
  "city": "Atlanta",
  "state": "GA",
  "country": "US",
  "postalCode": "31772",
  "phoneNumber": "4255550101",
  "email": "krystal.york@contoso.com",
  "website": "www.royalmail.co.uk",
  "taxRegistrationNumber": "",
  "currencyId": "543131ab-508c-ed11-aada-000d3a298ab3",
  "currencyCode": "USD",
  "irs1099Code": "",
  "paymentTermsId": "0aa5738a-44e3-ea11-bb43-000d3a2feca1",
  "paymentMethodId": "3b196a90-44e3-ea11-bb43-000d3a2feca1",
  "taxLiable": true,
  "blocked": " ",
  "balance": 0,
  "lastModifiedDateTime": "2015-11-09T02:14:32Z"
}

Tips for working with the APIs
vendor
Get vendor
Delete vendor
Update vendor