Skip to main content

Microsoft Dynamics 365 Business Central Component

Microsoft Dynamics 365 Business Central is a comprehensive enterprise resource planning (ERP) with capabilities including finance, manufacturing, customer relationship management (CRM), supply chains, analytics, and e-commerce.

Component key: ms-business-central

Changelog ↓

Description​

Microsoft Dynamics 365 Business Central is a comprehensive enterprise resource planning (ERP) with capabilities including finance, manufacturing, customer relationship management (CRM), supply chains, analytics, and e-commerce.

Use the Microsoft Dynamics 365 Business Central component to manage Sales Orders, Customers, Invoices, and Shipments.

API Documentation:

This component was built using the Microsoft Dynamics v2.0 REST API

Connections​

OAuth 2.0 Client Credentials​

The OAuth 2.0 client credentials flow allows your user to create an Application User to send requests to Business Central on their behalf. Refer to the following Documentation for more information. Setting up a client credentials connection is a two-step process:

  1. Create an "App" in Azure
  2. Create an "Application User" in Business Central

Create an app in Microsoft Azure

  1. Log in to Azure Portal
  2. Select App registrations
  3. Click + New registration
  • Supported account types can be Single tenant
  • No Redirect URI is necessary
  • Click Register
  1. Under API permissions click +Add a permission
  • Select Business Central
  • Check the following permissions
  • user_impersonation
  • offline_access
  • Financials.ReadWrite.All
  • Click Add permissions
  1. Under API permissions click Grant admin concent for (your org)
  2. Under Certificates & secrets click + New client secret
  • Give your certificate a description and expiration date
  • Take note of the value (not the Secret ID) of the client secret.
  1. Returning to the Overview page, take note of Application (client) ID
  2. From the Overview page, click Endpoints and take note of the OAuth 2.0 token endpoint (v2)

You will use the Secret Value, Client ID and Token Endpoint in a moment.

Add the app as an App User to Business Central

  1. Log in to Power Platform admin center
  2. Select Environments and choose your Business Central Environments
  3. Select S2S Apps
  4. Click +New app user
  • Click +Add an app
  • Choose the app you created in Azure portal (above). You can search for your app by entering the client ID you noted.
  • Select your Business Central tenant as your Business unit
  • Under Security Roles select System Administrator
  • Click Create

Configure the connection

Create a connection of type MS Business Central OAuth 2.0 Client Credentials.

  • Enter the Token Endpoint you noted as your Token URL.
  • Enter the Client ID and Secret Value you noted above.
InputNotesExample
Client ID

Generated when you register an app in Azure portal

Client secret value

Generated when you register an app in Azure portal

Scopes

This should be your Business Central URL with '/.default' appened to it

https://api.businesscentral.dynamics.com/.default
Token URL

This can be found by visiting your app in Azure portal and selecting 'Endpoints'

https://login.microsoftonline.com/00000000-0000-0000-0000-000000000000/oauth2/v2.0/token
Web API URL

Your organization's Microsoft Business Central Web API URL.

https://api.businesscentral.dynamics.com/v2.0/<TENANT_DOMAIN>/<ENVIRONMENT>

OAuth 2.0 Auth Code​

The OAuth 2.0 auth code flow allows your user grant permission to your integration to interact with Business Central on their behalf. Please refer to the following Documentation for more information

  1. Log in to Azure Portal

  2. Select App registrations

  3. Click + New registration

    • Supported account types should be Multi-tenant if you intend for customers to authenticate with their own Business Central instance, or Single-tenant if you intend to authenticate with your own Business Central instance.
    • Under Redirect URI enter https://oauth2.prismatic.io/callback
    • Click Register

  4. Under API permissions click +Add a permission

    • Select Business Central
    • Check the following permissions
      • user_impersonation
      • offline_access
      • Financials.ReadWrite.All
    • Click Add permissions

  5. Under Certificates & secrets click + New client secret

    • Give your certificate a description and expiration date
    • Take note of the value (not the Secret ID) of the client secret.

  6. Returning to the Overview page, take note of Application (client) ID

Create a connection of type OAuth 2.0 Auth Code.

  • Enter the Client ID and Secret Value you noted above.
InputNotesExample
Authorize URL

The OAuth 2.0 Authorization URL for Microsoft Business Central

https://login.microsoftonline.com/organizations/oauth2/v2.0/authorize
Client ID
Client Secret
Scopes

A space-delimited set of one or more scopes to get the user's permission to access.

https://api.businesscentral.dynamics.com/.default offline_access
Token URL

The OAuth 2.0 Token URL for Microsoft Business central

https://login.microsoftonline.com/organizations/oauth2/v2.0/token
Web API URL

Your organization's Microsoft Business Central Web API URL.

https://api.businesscentral.dynamics.com/v2.0/<TENANT_DOMAIN>/<ENVIRONMENT>

Triggers​

Microsoft Dynamics 365 Business Central Webhook​

Receive and validate webhook requests from Microsoft Dynamics 365 Business Central for webhooks you configure. | key: webhook

InputNotesExample
Connection
Resource

Resource to subscribe to.

/api/v1.0/companies(f64eba74-dacd-4854-a584-1834f68cfc3a)/customers

Webhook Receiver​

Receive a webhook payload from an external service. | key: webhookReceiver

Data Sources​

Select Companies​

A picklist of company objects in your Business Central organization. | key: listCompanies | type: picklist

InputNotesExample
Connection

Select Customers​

A picklist of customer objects in your Business Central organization. | key: listCustomers | type: picklist

InputNotesExample
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection

Select Items​

A picklist of item objects in your Business Central organization. | key: listItems | type: picklist

InputNotesExample
Filter

Filters results (rows).

startswith(givenName,'J')
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection

Select Sales Invoices​

A picklist of sales invoices objects in your Business Central organization. | key: listSalesInvoices | type: picklist

InputNotesExample
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection

Select Sales Orders​

A picklist of sales orders objects in your Business Central organization. | key: listSalesOrders | type: picklist

InputNotesExample
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection

Select Sales Shipments​

A picklist of sales shipment objects in your Business Central organization. | key: listSalesShipment | type: picklist

InputNotesExample
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection

Actions​

Create Attachment​

Create a new attachment | key: createAttachment

InputNotesExample
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false
File Name

The name of the file

example.pdf
Parent ID

The ID of the parent object that the attachment is associated with

0a077d18-45e3-ea11-bb43-000d3a2feca1
Parent Type

The type of the parent object

contact

{
  "data": {
    "@odata.context": "https://api.businesscentral.dynamics.com/v2.0/29dd78b9-6d0d-47ab-9427-2a49d9a1deb1/Production/api/v2.0/$metadata#companies(f1678e37-e50b-ef11-9f8e-6045bdc8c192)/attachments/$entity",
    "@odata.etag": "W/\"JzE5OzMyMTg5ODE2ODE1NzUzODQ2NDcxOzAwOyc=\"",
    "id": "25b8238e-f034-ef11-840b-002248241214",
    "parentId": "a84eb92b-e60b-ef11-9f8e-6045bdc8c192",
    "fileName": "test.pdf",
    "byteSize": 0,
    "lastModifiedDateTime": "2024-06-28T01:48:51Z",
    "parentType": "Sales_x0020_Invoice",
    "attachmentContent@odata.mediaEditLink": "https://api.businesscentral.dynamics.com/v2.0/29dd78b9-6d0d-47ab-9427-2a49d9a1deb1/Production/api/v2.0/companies(f1678e37-e50b-ef11-9f8e-6045bdc8c192)/attachments(25b8238e-f034-ef11-840b-002248241214)/attachmentContent",
    "attachmentContent@odata.mediaReadLink": "https://api.businesscentral.dynamics.com/v2.0/29dd78b9-6d0d-47ab-9427-2a49d9a1deb1/Production/api/v2.0/companies(f1678e37-e50b-ef11-9f8e-6045bdc8c192)/attachments(25b8238e-f034-ef11-840b-002248241214)/attachmentContent"
  }
}

Create Customer​

Creates a customer object in Microsoft Business Central. | key: createCustomer

InputNotesExample
Address Line 1

Specifies the first line of the customer's address.

192 Market Square
Address Line 2

Specifies the second line of the customer's address.

192 Market Square
Actions Blocked

Specifies which transactions with the customer cannot be posted.It can be empty, 'Ship', 'Invoice' or 'All'

Ship
City

Specifies the city of the customer's address.

Atlanta
Company ID

The ID of the company you want to create the customer in.

00000000-0000-0000-0000-000000000000
Connection
Country

Specifies the country of the customer's address.

US
Currency Code

Specifies the currency code used by the customer.

USD
Currency Id

Specifies the currency used by the customer.

00000000-0000-0000-0000-000000000000
Debug Request

Enabling this flag will log out the current request.

false
Display Name

Specifies the customer's name.

Adatum Corporation
Email

Specifies the customer's email address.

robert.townes@contoso.com
Payment Method Id

Specifies the payment method used by the customer.

3b196a90-44e3-ea11-bb43-000d3a2feca1
Payment Terms Id

Specifies the payment terms used by the customer.

04a5738a-44e3-ea11-bb43-000d3a2feca1
Phone Number

Specifies the customer's phone number.

+1 555-555-5555
Postal Code

Specifies the postal code of the customer's address.

31772
Shipment Method Id

Specifies the shipment method used by the customer.

00000000-0000-0000-0000-000000000000
State

Specifies the state of the customer's address.

GA
Tax Area Id

Specifies which tax area the customer belongs to.

90196a90-44e3-ea11-bb43-000d3a2feca1
Tax Liable

specifies if the customer or vendor is liable for sales tax. Set to true if the customer is tax liable.

false
Tax Registration Number

Specifies the customer's tax registration number.

Customer Type

Specifies the type of customer.

Company
Website

Specifies the customer's website.

www.sample.com

{
  "data": {
    "id": "8ba01a7a-5734-ef11-8409-7c1e5213ec0e",
    "number": "C00020",
    "displayName": "Customer Test 1",
    "type": "Person",
    "addressLine1": "192 Market square",
    "addressLine2": "",
    "city": "Atlanta",
    "state": "GA",
    "country": "US",
    "postalCode": "31772",
    "phoneNumber": "",
    "email": "robert.townes@gmailfake.com",
    "website": "www.sample.com",
    "salespersonCode": "",
    "balanceDue": 0,
    "creditLimit": 0,
    "taxLiable": false,
    "taxAreaId": "0241ba25-e60b-ef11-9f8e-6045bdc8c192",
    "taxAreaDisplayName": "ATLANTA, GA",
    "taxRegistrationNumber": "",
    "currencyId": "8955e220-e60b-ef11-9f8e-6045bdc8c192",
    "currencyCode": "EUR",
    "paymentTermsId": "7d55e220-e60b-ef11-9f8e-6045bdc8c192",
    "shipmentMethodId": "0756e220-e60b-ef11-9f8e-6045bdc8c192",
    "paymentMethodId": "a840ba25-e60b-ef11-9f8e-6045bdc8c192",
    "blocked": "_x0020_",
    "lastModifiedDateTime": "2024-06-27T07:33:02.2Z"
  }
}

Create Event Subscription​

Create an Event subscription for Microsoft Business Central. | key: createEventSubscription

InputNotesExample
Allow Duplicates

Enable to allow more than one webhook per endpoint.

false
Connection
Debug Request

Enabling this flag will log out the current request.

false
Notification URL

URL to send events of this Subscription to.

https://example.com/webhook
Resource

Resource to subscribe to.

/api/v1.0/companies(f64eba74-dacd-4854-a584-1834f68cfc3a)/customers

{
  "data": {
    "@odata.context": "https://api.test.dynamics.com/v2.0/29dd78b9-6d0d-47ab-9427-ss23/Production/api/v2.0/$metadata#subscriptions/$entity",
    "etag": "W/\"JzE5OzM3MzQyNTU5MTk5MTQwNDIzMTkxOzAxzw=\"",
    "subscriptionId": "ba1cba0177854a6091865452e017742b",
    "notificationUrl": "https://hooks.example.com/trigger/example",
    "resource": "api/v2.0/companies(66d8-1a4e-ef11-bfe7-sd548)/customers",
    "timestamp": 193385,
    "userId": "ds58w-ee2b-429f-aa8c-sd4899",
    "lastModifiedDateTime": "2025-01-15T21:48:39Z",
    "clientState": "",
    "expirationDateTime": "2025-01-18T21:48:39Z",
    "systemCreatedAt": "2025-01-15T21:48:40.577Z",
    "systemCreatedBy": "ds58w-ee2b-429f-aa8c-sd4899",
    "systemModifiedAt": "2025-01-15T21:48:40.577Z",
    "systemModifiedBy": "ds58w-ee2b-429f-aa8c-sd4899"
  }
}

Create Item​

Creates a new item object in your Business Central Organization. | key: createItem

InputNotesExample
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false
Display Name

The display name of the item.

ATHENS Desk
Number

The number of the item.

1896-S

{
  "data": {
    "id": "5247fc6c-2f35-ef11-840b-002248241214",
    "number": "TESTO-001",
    "displayName": "TEST",
    "displayName2": "",
    "type": "Inventory",
    "itemCategoryId": "00000000-0000-0000-0000-000000000000",
    "itemCategoryCode": "",
    "blocked": false,
    "gtin": "",
    "inventory": 0,
    "unitPrice": 0,
    "priceIncludesTax": false,
    "unitCost": 0,
    "taxGroupId": "00000000-0000-0000-0000-000000000000",
    "taxGroupCode": "",
    "baseUnitOfMeasureId": "f957e220-e60b-ef11-9f8e-6045bdc8c192",
    "baseUnitOfMeasureCode": "PCS",
    "generalProductPostingGroupId": "9240ba25-e60b-ef11-9f8e-6045bdc8c192",
    "generalProductPostingGroupCode": "RETAIL",
    "inventoryPostingGroupId": "e557e220-e60b-ef11-9f8e-6045bdc8c192",
    "inventoryPostingGroupCode": "RESALE",
    "lastModifiedDateTime": "2024-06-28T09:18:58.05Z"
  }
}

Create Purchase Order​

Creates a purchase order object in your Business Central organization. | key: createPurchaseOrder

InputNotesExample
Additional Properties

Additional properties to include in the request body. In case of supplying a property that is already defined as an input, the input value will be used.

Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Currency Code

The currency code for the sales order.

USD
Debug Request

Enabling this flag will log out the current request.

false
Discount Amount

The discount amount.

0.10
Order Date

The order date.

2022-01-01
Pay To Vendor ID

The unique ID of the vendor to pay to.

00000000-0000-0000-0000-000000000000
Pay To Vendor Number

Specifies the number of the vendor to pay to.

10000
Purchaser

The purchaser in the purchase order.

John Doe
Ship To Address Line 1

The first line of the ship to address.

123 Main St
Ship To Name

The name of the ship to customer.

John Doe
Vendor Number

Specifies vendor's number.

10000

{
  "data": {
    "id": "5d115c9c-44e3-ea11-bb43-000d3a2feca1",
    "number": "108001",
    "orderDate": "2021-01-01T00:00:00.000Z",
    "postingDate": "2021-01-01T00:00:00.000Z",
    "dueDate": "2021-01-01T00:00:00.000Z",
    "vendorId": "",
    "vendorNumber": "20000",
    "vendorName": "First Up Consultants",
    "payToName": "First Up Consultants",
    "payToVendorId": "Evan McIntosh",
    "payToVendorNumber": "20000",
    "shipToName": "First Up Consultants",
    "shipToContact": "Evan McIntosh",
    "buyFromAddressLine1": "100 Day Drive",
    "buyFromAddressLine2": "",
    "buyFromCity": "Chicago",
    "buyFromCountry": "US",
    "buyFromState": "IL",
    "buyFromPostCode": "61236",
    "shipToAddressLine1": "100 Day Drive",
    "shipToAddressLine2": "",
    "shipToCity": "Chicago",
    "shipToCountry": "US",
    "shipToState": "IL",
    "shipToPostCode": "61236",
    "payToAddressLine1": "100 Day Drive",
    "payToAddressLine2": "",
    "payToCity": "Chicago",
    "payToCountry": "US",
    "payToState": "IL",
    "payToPostCode": "61236",
    "currencyId": "00000000-0000-0000-0000-000000000000",
    "currencyCode": "USD",
    "pricesIncludeTax": false,
    "paymentTermsId": "04a5738a-44e3-ea11-bb43-000d3a2feca1",
    "shipmentMethodId": "93f5638a-55e3-jk22-aa32-211d3a2fdce5",
    "purchaser": "First Up Consultants",
    "requestedReceiptDate": "2021-01-01T00:00:00.000Z",
    "discountAmount": 0,
    "discountAppliedBeforeTax": false,
    "totalAmountExcludingTax": 0,
    "totalTaxAmount": 0,
    "totalAmountIncludingTax": 0,
    "fullyReceived": false,
    "status": "Draft",
    "lastModifiedDateTime": "2021-01-01T00:26:53.793Z",
    "shortcutDimension1Code": "",
    "shortcutDimension2Code": ""
  }
}

Create Purchase Order Line​

Creates a purchase order line object in your Business Central organization. | key: createPurchaseOrderLine

InputNotesExample
Account ID

The id of the account that the purchase order line is related to.

00000000-0000-0000-0000-000000000000
Additional Properties

Additional properties to include in the request body. In case of supplying a property that is already defined as an input, the input value will be used.

Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false
Description

Specifies the description of the purchase order line.

ATLANTA Whiteboard, base
Direct Unit Cost

The direct cost per unit.

1397.3
Document ID

The ID of the parent purchase order line.

00000000-0000-0000-0000-000000000000
Item ID

The ID of the item in the purchase order line.

00000000-0000-0000-0000-000000000000
Line Object Number

The number of the object (account or item) of the purchase order line.

1996-S
Line Type

The type of the purchase order line.

Item
Quantity

The quantity of the item in the purchase order line.

12

{
  "data": {
    "id": "1e8cb9c0-44e3-ea11-bb43-000d3a2feca1",
    "documentId": "960f5c9c-44e3-ea11-bb43-000d3a2feca1",
    "sequence": 10000,
    "itemId": "0ea6738a-44e3-ea11-bb43-000d3a2feca1",
    "accountId": "93f5638a-55e3-jk22-aa32-211d3a2fdce5",
    "lineType": "Item",
    "lineObjectNumber": "1996-S",
    "description": "ATLANTA Whiteboard, base",
    "unitOfMeasureId": "5ca6738a-44e3-ea11-bb43-000d3a2feca1",
    "unitOfMeasureCode": "PCS",
    "quantity": 12,
    "directUnitCost": 1397.3,
    "discountAmount": 0,
    "discountPercent": 0,
    "discountAppliedBeforeTax": false,
    "amountExcludingTax": 16767.6,
    "taxCode": "FURNITURE",
    "taxPercent": 6.00002,
    "totalTaxAmount": 1006.06,
    "amountIncludingTax": 17773.66,
    "invoiceDiscountAllocation": 0,
    "netAmount": 16767.6,
    "netTaxAmount": 1006.06,
    "netAmountIncludingTax": 17773.66,
    "expectedReceiptDate": "2020-04-02T00:00:00.000Z",
    "receivedQuantity": 0,
    "invoicedQuantity": 0,
    "invoiceQuantity": 12,
    "receiveQuantity": 12,
    "itemVariantId": "00000000-0000-0000-0000-000000000000",
    "locationId": "00000000-0000-0000-0000-000000000000"
  }
}

Create Sales Invoice​

Creates a sales invoice object in your Business Central organization. | key: createSalesInvoice

InputNotesExample
Additional Properties

Additional properties to include in the request body. In case of supplying a property that is already defined as an input, the input value will be used.

Bill To Customer ID

The customer ID for the invoice to the customer

12345
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Currency Code

The currency code for the sales invoice

USD
Customer ID

The unique identifier of the customer.

8ba01a7a-5734-ef11-8409-7c1e5213ec0e
Customer Number

The customer number for the sales invoice

10000
Debug Request

Enabling this flag will log out the current request.

false
Customer Email Address

The email address for the sales invoice

robert.jr@sample.cm
Sell To Address Line 1

The first line of the sell to address

123 Main St
Ship To Address Line 1

The first line of the ship to address

123 Main St
Ship To Name

The name of the ship to customer

John Doe

{
  "data": {
    "id": "b353895e-5635-ef11-8409-6045bdfedf9a",
    "number": "PS-INV103001",
    "externalDocumentNumber": "",
    "invoiceDate": "2019-01-15",
    "postingDate": "2019-01-15",
    "dueDate": "2019-01-15",
    "customerPurchaseOrderReference": "",
    "customerId": "f3a5738a-44e3-ea11-bb43-000d3a2feca1",
    "customerNumber": "20000",
    "customerName": "Trey Research",
    "billToCustomerId": "f3a5738a-44e3-ea11-bb43-000d3a2feca1",
    "billToCustomerNumber": "20000",
    "shipToName": "Trey Research",
    "shipToContact": "Helen Ray",
    "sellToAddressLine1": "153 Thomas Drive",
    "sellToAddressLine2": "",
    "sellToCity": "Chicago",
    "sellToCountry": "US",
    "sellToState": "IL",
    "sellToPostCode": "61236",
    "shipToAddressLine1": "153 Thomas Drive",
    "shipToAddressLine2": "",
    "shipToCity": "Chicago",
    "shipToCountry": "US",
    "shipToState": "IL",
    "shipToPostCode": "61236",
    "currencyId": "00000000-0000-0000-0000-000000000000",
    "currencyCode": "USD",
    "paymentTermsId": "0ba5738a-44e3-ea11-bb43-000d3a2feca1",
    "shipmentMethodId": "00000000-0000-0000-0000-000000000000",
    "salesperson": "PS",
    "discountAmount": 0,
    "phoneNumber": "",
    "email": "helen.ray@contoso.com"
  }
}

Create Sales Order​

Creates a sales order object in your Business Central organization. | key: createSalesOrder

InputNotesExample
Additional Properties

Additional properties to include in the request body. In case of supplying a property that is already defined as an input, the input value will be used.

Bill To Customer ID

The customer ID for the bill to customer.

12345
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Currency Code

The currency code for the sales order.

USD
Customer ID

The unique identifier of the customer.

8ba01a7a-5734-ef11-8409-7c1e5213ec0e
Customer Number

The customer number for the sales order.

10000
Debug Request

Enabling this flag will log out the current request.

false
Customer Email Address

The email address for the sales order.

robert.jr@sample.cm
Sell To Address Line 1

The first line of the sell to address.

123 Main St
Ship To Address Line 1

The first line of the ship to address.

123 Main St
Ship To Name

The name of the ship to customer.

John Doe

{
  "data": {
    "id": "54a53ee8-3835-ef11-840b-00224820d4a6",
    "number": "S-ORD101010",
    "externalDocumentNumber": "",
    "orderDate": "2023-09-01",
    "postingDate": "2023-09-02",
    "customerId": "7e57e220-e60b-ef11-9f8e-6045bdc8c192",
    "customerNumber": "10000",
    "customerName": "Adatum Corporation",
    "billToName": "Adatum Corporation",
    "billToCustomerId": "7e57e220-e60b-ef11-9f8e-6045bdc8c192",
    "billToCustomerNumber": "10000",
    "shipToName": "Adatum Corporation",
    "shipToContact": "Robert Townes",
    "sellToAddressLine1": "Station Road, 21",
    "sellToAddressLine2": "",
    "sellToCity": "Georgia",
    "sellToCountry": "US",
    "sellToState": "GA",
    "sellToPostCode": "31772",
    "billToAddressLine1": "Station Road, 21",
    "billToAddressLine2": "",
    "billToCity": "Georgia",
    "billToCountry": "US",
    "billToState": "GA",
    "billToPostCode": "31772",
    "shipToAddressLine1": "Station Road, 21",
    "shipToAddressLine2": "",
    "shipToCity": "Georgia",
    "shipToCountry": "US",
    "shipToState": "GA",
    "shipToPostCode": "31772",
    "shortcutDimension1Code": "",
    "shortcutDimension2Code": "MEDIUM",
    "currencyId": "00000000-0000-0000-0000-000000000000",
    "currencyCode": "USD",
    "pricesIncludeTax": false,
    "paymentTermsId": "7e55e220-e60b-ef11-9f8e-6045bdc8c192",
    "shipmentMethodId": "0756e220-e60b-ef11-9f8e-6045bdc8c192",
    "salesperson": "JO",
    "partialShipping": true,
    "requestedDeliveryDate": "0001-01-01",
    "discountAmount": 0,
    "discountAppliedBeforeTax": false,
    "totalAmountExcludingTax": 0,
    "totalTaxAmount": 0,
    "totalAmountIncludingTax": 0,
    "fullyShipped": false,
    "status": "Draft",
    "lastModifiedDateTime": "2024-06-28T10:26:43.957Z",
    "phoneNumber": "",
    "email": "robert.townes@contoso.com"
  }
}

Create Shipment Method​

Create a new shipment method | key: createShipmentMethod

InputNotesExample
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false
Shipment CodeUPS
Shipment Method NameFedex

{
  "data": {
    "id": "be90f4f2-1735-ef11-8409-6045bdfedf9a",
    "code": "TEST",
    "displayName": "test",
    "lastModifiedDateTime": "2024-06-28T06:30:46.263Z"
  }
}

Delete All Instance Subscriptions​

Delete all subscriptions pointed at this instance. | key: deleteAllInstanceSubscriptions

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false

{
  "data": {
    "subscriptionsRemoved": [
      {
        "subscriptionId": "26ebd1e9-c54a-4bbe-9583-fc05974952a4",
        "etag": "W/\"b9b27172-ee2e-4248-86df-fc98cb71d914\""
      },
      {
        "subscriptionId": "b9b27172-ee2e-4248-86df-fc98cb71d914",
        "etag": "W/\"b9b27172-ee2e-4248-86df-fc98cb71d914\""
      }
    ]
  }
}

Delete Attachment​

Delete an attachment object in Business Central. | key: deleteAttachment

InputNotesExample
Attachment ID

The ID of the attachment to update.

25b8238e-f034-ef11-840b-002248241214
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false

{
  "data": {
    "message": "Success"
  }
}

Delete Customer​

Deletes a customer object in your Business Central organization. | key: deleteCustomer

InputNotesExample
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Customer ID

The unique identifier of the customer.

8ba01a7a-5734-ef11-8409-7c1e5213ec0e
Debug Request

Enabling this flag will log out the current request.

false

{
  "data": {
    "message": "Success"
  }
}

Delete Item​

Deletes an item object in your Business Central Organization. | key: deleteItem

InputNotesExample
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false
Item Id

The id of the item.

e21a6a90-44e3-ea11-bb43-000d3a2feca1

{
  "data": {
    "message": "Success"
  }
}

Delete Purchase Order​

Deletes a purchase order object in your Business Central Organization. | key: deletePurchaseOrder

InputNotesExample
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false
Purchase Order ID

The unique ID of the purchase order to delete.

00000000-0000-0000-0000-000000000000

{
  "data": {
    "message": "Success"
  }
}

Delete Purchase Order Line​

Deletes a purchase order line object in your Business Central Organization. | key: deletePurchaseOrderLine

InputNotesExample
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false
Purchase Order Line ID

The unique ID of the purchase order line to delete.

00000000-0000-0000-0000-000000000000

{
  "data": {
    "message": "Success"
  }
}

Delete Sales Invoice​

Deletes a sales invoice object in your Business Central Organization. | key: deleteSalesInvoice

InputNotesExample
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false
Sales Invoice ID

The unique identifier of the sales invoice object.

0ba5738a-44e3-ea11-bb43-000d3a2feca1

{
  "data": {
    "message": "Success"
  }
}

Delete Sales Order​

Deletes a sales order object in your Business Central Organization. | key: deleteSalesOrder

InputNotesExample
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false
Sales Order ID

The unique identifier of the sales order.

f1678e37-e50b-ef11-9f8e-6045bdc8c192

{
  "data": {
    "message": "Success"
  }
}

Delete Shipment Method​

Deletes a shipment method object in your Business Central organization. | key: deleteShipmentMethod

InputNotesExample
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false
Shipment Method Id

Specifies the shipment method used by the customer.

00000000-0000-0000-0000-000000000000

{
  "data": {
    "message": "Success"
  }
}

Delete Subscription​

Delete existing subscription for Microsoft Business Central. | key: deleteSubscription

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Etag

Etag value for the subscription to delete.

W/"JzEtNjM3NjQwMzUwMDAwMDAwMCc="
Subscription ID

Subscription ID to manage.

7d577253-3ef0-4a0a-bb7f-8335c2596e70

{
  "data": "ACTION SUCCEEDED"
}

Get Account​

Retrieve the properties and relationships of an account object in Microsoft Business Central. | key: getAccount

InputNotesExample
Account ID

The ID of the account you want to retrieve data from.

someAccountId
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false

{
  "data": {
    "id": "2256e220-e60b-ef11-9f8e-6045bdc8c192",
    "number": "10000",
    "displayName": "Balance Sheet",
    "category": "Assets",
    "subCategory": "Assets",
    "blocked": false,
    "accountType": "Heading",
    "directPosting": false,
    "netChange": 0,
    "consolidationTranslationMethod": "Average Rate (Manual)",
    "consolidationDebitAccount": "",
    "consolidationCreditAccount": "",
    "excludeFromConsolidation": false,
    "lastModifiedDateTime": "2024-05-06T20:21:22.54Z"
  }
}

Get Attachment​

Gets an attachment object | key: getAttachment

InputNotesExample
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false
Parent ID

The ID of the parent object that the attachment is associated with

0a077d18-45e3-ea11-bb43-000d3a2feca1
Parent Type

The type of the parent object

contact

{
  "data": {
    "@odata.context": "https://api.businesscentral.dynamics.com/v2.0/29dd78b9-6d0d-47ab-9427-2a49d9a1deb1/Production/api/v2.0/$metadata#companies(f1678e37-e50b-ef11-9f8e-6045bdc8c192)/attachments",
    "value": [
      {
        "id": "25b8238e-f034-ef11-840b-002248241214",
        "parentId": "a84eb92b-e60b-ef11-9f8e-6045bdc8c192",
        "fileName": "test.pdf",
        "byteSize": 0,
        "lastModifiedDateTime": "2024-06-28T01:48:51Z",
        "parentType": "Sales_x0020_Invoice"
      }
    ]
  }
}

Get Company Information​

Get information about a company in your Business Central organization. | key: getCompanyInformation

InputNotesExample
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false

{
  "data": {
    "displayName": "CRONUS USA, Inc.",
    "addressLine1": "7122 South Ashford Street",
    "addressLine2": "Westminster",
    "city": "Atlanta",
    "state": "GA",
    "country": "US",
    "postalCode": "31772",
    "phoneNumber": "+1 425 555 0100",
    "faxNumber": "+1 425 555 0101",
    "email": "",
    "website": "",
    "taxRegistrationNumber": "",
    "currencyCode": "USD",
    "currentFiscalYearStartDate": "2021-01-01"
  }
}

Get Customer​

Retrieve the properties and relationships of a customer object in your Business Central organization. | key: getCustomer

InputNotesExample
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Customer ID

The unique identifier of the customer.

8ba01a7a-5734-ef11-8409-7c1e5213ec0e
Debug Request

Enabling this flag will log out the current request.

false

{
  "data": {
    "id": "8ba01a7a-5734-ef11-8409-7c1e5213ec0e",
    "number": "C00020",
    "displayName": "Customer Test 1",
    "type": "Person",
    "addressLine1": "192 Market square",
    "addressLine2": "",
    "city": "Atlanta",
    "state": "GA",
    "country": "US",
    "postalCode": "31772",
    "phoneNumber": "",
    "email": "robert.townes@gmailfake.com",
    "website": "www.sample.com",
    "salespersonCode": "",
    "balanceDue": 0,
    "creditLimit": 0,
    "taxLiable": false,
    "taxAreaId": "0241ba25-e60b-ef11-9f8e-6045bdc8c192",
    "taxAreaDisplayName": "ATLANTA, GA",
    "taxRegistrationNumber": "",
    "currencyId": "8955e220-e60b-ef11-9f8e-6045bdc8c192",
    "currencyCode": "EUR",
    "paymentTermsId": "7d55e220-e60b-ef11-9f8e-6045bdc8c192",
    "shipmentMethodId": "0756e220-e60b-ef11-9f8e-6045bdc8c192",
    "paymentMethodId": "a840ba25-e60b-ef11-9f8e-6045bdc8c192",
    "blocked": "_x0020_",
    "lastModifiedDateTime": "2024-06-27T07:33:02.2Z"
  }
}

Get Item​

Retrieves an item object from your Business Central Organization. | key: getItem

InputNotesExample
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false
Item Id

The id of the item.

e21a6a90-44e3-ea11-bb43-000d3a2feca1

{
  "data": {
    "id": "5247fc6c-2f35-ef11-840b-002248241214",
    "number": "TESTO-001",
    "displayName": "TEST",
    "displayName2": "",
    "type": "Inventory",
    "itemCategoryId": "00000000-0000-0000-0000-000000000000",
    "itemCategoryCode": "",
    "blocked": false,
    "gtin": "",
    "inventory": 0,
    "unitPrice": 0,
    "priceIncludesTax": false,
    "unitCost": 0,
    "taxGroupId": "00000000-0000-0000-0000-000000000000",
    "taxGroupCode": "",
    "baseUnitOfMeasureId": "f957e220-e60b-ef11-9f8e-6045bdc8c192",
    "baseUnitOfMeasureCode": "PCS",
    "generalProductPostingGroupId": "9240ba25-e60b-ef11-9f8e-6045bdc8c192",
    "generalProductPostingGroupCode": "RETAIL",
    "inventoryPostingGroupId": "e557e220-e60b-ef11-9f8e-6045bdc8c192",
    "inventoryPostingGroupCode": "RESALE",
    "lastModifiedDateTime": "2024-06-28T09:18:58.05Z"
  }
}

Get Purchase Order​

Retrieves a purchase order object in your Business Central Organization. | key: getPurchaseOrder

InputNotesExample
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false
Purchase Order ID

The unique ID of the purchase order to retrieve.

00000000-0000-0000-0000-000000000000

{
  "data": {
    "id": "5d115c9c-44e3-ea11-bb43-000d3a2feca1",
    "number": "108001",
    "orderDate": "2021-01-01T00:00:00.000Z",
    "postingDate": "2021-01-01T00:00:00.000Z",
    "dueDate": "2021-01-01T00:00:00.000Z",
    "vendorId": "",
    "vendorNumber": "20000",
    "vendorName": "First Up Consultants",
    "payToName": "First Up Consultants",
    "payToVendorId": "Evan McIntosh",
    "payToVendorNumber": "20000",
    "shipToName": "First Up Consultants",
    "shipToContact": "Evan McIntosh",
    "buyFromAddressLine1": "100 Day Drive",
    "buyFromAddressLine2": "",
    "buyFromCity": "Chicago",
    "buyFromCountry": "US",
    "buyFromState": "IL",
    "buyFromPostCode": "61236",
    "shipToAddressLine1": "100 Day Drive",
    "shipToAddressLine2": "",
    "shipToCity": "Chicago",
    "shipToCountry": "US",
    "shipToState": "IL",
    "shipToPostCode": "61236",
    "payToAddressLine1": "100 Day Drive",
    "payToAddressLine2": "",
    "payToCity": "Chicago",
    "payToCountry": "US",
    "payToState": "IL",
    "payToPostCode": "61236",
    "currencyId": "00000000-0000-0000-0000-000000000000",
    "currencyCode": "USD",
    "pricesIncludeTax": false,
    "paymentTermsId": "04a5738a-44e3-ea11-bb43-000d3a2feca1",
    "shipmentMethodId": "93f5638a-55e3-jk22-aa32-211d3a2fdce5",
    "purchaser": "First Up Consultants",
    "requestedReceiptDate": "2021-01-01T00:00:00.000Z",
    "discountAmount": 0,
    "discountAppliedBeforeTax": false,
    "totalAmountExcludingTax": 0,
    "totalTaxAmount": 0,
    "totalAmountIncludingTax": 0,
    "fullyReceived": false,
    "status": "Draft",
    "lastModifiedDateTime": "2021-01-01T00:26:53.793Z",
    "shortcutDimension1Code": "",
    "shortcutDimension2Code": ""
  }
}

Get Purchase Order Line​

Retrieves a purchase order line object in your Business Central Organization. | key: getPurchaseOrderLine

InputNotesExample
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false
Purchase Order Line ID

The unique ID of the purchase order line to retrieve.

00000000-0000-0000-0000-000000000000

{
  "data": {
    "id": "1e8cb9c0-44e3-ea11-bb43-000d3a2feca1",
    "documentId": "960f5c9c-44e3-ea11-bb43-000d3a2feca1",
    "sequence": 10000,
    "itemId": "0ea6738a-44e3-ea11-bb43-000d3a2feca1",
    "accountId": "93f5638a-55e3-jk22-aa32-211d3a2fdce5",
    "lineType": "Item",
    "lineObjectNumber": "1996-S",
    "description": "ATLANTA Whiteboard, base",
    "unitOfMeasureId": "5ca6738a-44e3-ea11-bb43-000d3a2feca1",
    "unitOfMeasureCode": "PCS",
    "quantity": 12,
    "directUnitCost": 1397.3,
    "discountAmount": 0,
    "discountPercent": 0,
    "discountAppliedBeforeTax": false,
    "amountExcludingTax": 16767.6,
    "taxCode": "FURNITURE",
    "taxPercent": 6.00002,
    "totalTaxAmount": 1006.06,
    "amountIncludingTax": 17773.66,
    "invoiceDiscountAllocation": 0,
    "netAmount": 16767.6,
    "netTaxAmount": 1006.06,
    "netAmountIncludingTax": 17773.66,
    "expectedReceiptDate": "2020-04-02T00:00:00.000Z",
    "receivedQuantity": 0,
    "invoicedQuantity": 0,
    "invoiceQuantity": 12,
    "receiveQuantity": 12,
    "itemVariantId": "00000000-0000-0000-0000-000000000000",
    "locationId": "00000000-0000-0000-0000-000000000000"
  }
}

Get Purchase Receipt​

Retrieves a purchase receipt object in your Business Central Organization. | key: getPurchaseReceipt

InputNotesExample
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false
Purchase Receipt ID

The unique identifier of the purchase receipt.

00000000-0000-0000-0000-000000000000

{
  "data": {
    "id": "5d115c9c-44e3-ea11-bb43-000d3a2feca1",
    "number": "108001",
    "invoiceDate": "2019-01-01T00:00:00.000Z",
    "postingDate": "2019-01-01T00:00:00.000Z",
    "dueDate": "2019-01-01T00:00:00.000Z",
    "vendorNumber": "20000",
    "vendorName": "First Up Consultants",
    "payToName": "First Up Consultants",
    "payToContact": "Evan McIntosh",
    "payToVendorNumber": "20000",
    "shipToName": "First Up Consultants",
    "shipToContact": "Evan McIntosh",
    "buyFromAddressLine1": "100 Day Drive",
    "buyFromAddressLine2": "",
    "buyFromCity": "Chicago",
    "buyFromCountry": "US",
    "buyFromState": "IL",
    "buyFromPostCode": "61236",
    "shipToAddressLine1": "100 Day Drive",
    "shipToAddressLine2": "",
    "shipToCity": "Chicago",
    "shipToCountry": "US",
    "shipToState": "IL",
    "shipToPostCode": "61236",
    "payToAddressLine1": "100 Day Drive",
    "payToAddressLine2": "",
    "payToCity": "Chicago",
    "payToCountry": "US",
    "payToState": "IL",
    "payToPostCode": "61236",
    "currencyCode": "USD",
    "lastModifiedDateTime": "2019-01-01T00:00:00.000Z"
  }
}

Get Purchase Receipt Line​

Retrieves a purchase receipt line object in your Business Central Organization. | key: getPurchaseReceiptLine

InputNotesExample
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false
Purchase Receipt Line ID

The unique identifier of the purchase receipt line.

00000000-0000-0000-0000-000000000000

{
  "data": {
    "id": "dd8db9c0-44e3-ea11-bb43-000d3a2feca1",
    "documentId": "5d115c9c-44e3-ea11-bb43-000d3a2feca1",
    "sequence": 10000,
    "lineType": "Item",
    "lineObjectNumber": "1896-S",
    "description": "ATHENS Desk",
    "unitOfMeasureCode": "PCS",
    "unitCost": 780.7,
    "quantity": 4,
    "discountPercent": 5,
    "taxPercent": 10,
    "expectedReceiptDate": "2021-01-01T00:00:00.000Z"
  }
}

Get Sale Shipment​

Retrieves a sale shipment object from your Business Central organization. | key: getSaleShipment

InputNotesExample
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false
Sale Shipment ID

The ID of the sale shipment you want to retrieve.

00000000-0000-0000-0000-000000000000

{
  "data": {
    "id": "647a3456-e60b-ef11-9f8e-6045bdc8c192",
    "number": "S-SHPT102002",
    "externalDocumentNumber": "",
    "invoiceDate": "2023-01-18",
    "postingDate": "2023-01-18",
    "dueDate": "2023-01-18",
    "customerPurchaseOrderReference": "",
    "customerId": "7e57e220-e60b-ef11-9f8e-6045bdc8c192",
    "customerNumber": "10000",
    "customerName": "Adatum Corporation",
    "billToCustomerId": "7e57e220-e60b-ef11-9f8e-6045bdc8c192",
    "billToName": "Adatum Corporation",
    "billToCustomerNumber": "10000",
    "shipToName": "Adatum Corporation",
    "shipToContact": "Robert Townes",
    "sellToAddressLine1": "192 Market Square",
    "sellToAddressLine2": "",
    "sellToCity": "Atlanta",
    "sellToCountry": "US",
    "sellToState": "GA",
    "sellToPostCode": "31772",
    "billToAddressLine1": "192 Market Square",
    "billToAddressLine2": "",
    "billToCity": "Atlanta",
    "billToCountry": "US",
    "billToState": "GA",
    "billToPostCode": "31772",
    "shipToAddressLine1": "192 Market Square",
    "shipToAddressLine2": "",
    "shipToCity": "Atlanta",
    "shipToCountry": "US",
    "shipToState": "GA",
    "shipToPostCode": "31772",
    "currencyCode": "USD",
    "orderNumber": "",
    "paymentTermsCode": "COD",
    "shipmentMethodCode": "",
    "salesperson": "JO",
    "pricesIncludeTax": false,
    "lastModifiedDateTime": "2024-05-06T20:22:23.263Z",
    "phoneNumber": "",
    "email": "robert.townes@contoso.com"
  }
}

Get Sales Invoice​

Retrieves a sales invoice object in your Business Central Organization. | key: getSalesInvoice

InputNotesExample
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false
Sales Invoice ID

The unique identifier of the sales invoice object.

0ba5738a-44e3-ea11-bb43-000d3a2feca1

{
  "data": {
    "id": "b353895e-5635-ef11-8409-6045bdfedf9a",
    "number": "PS-INV103001",
    "externalDocumentNumber": "",
    "invoiceDate": "2019-01-15",
    "postingDate": "2019-01-15",
    "dueDate": "2019-01-15",
    "customerPurchaseOrderReference": "",
    "customerId": "f3a5738a-44e3-ea11-bb43-000d3a2feca1",
    "customerNumber": "20000",
    "customerName": "Trey Research",
    "billToCustomerId": "f3a5738a-44e3-ea11-bb43-000d3a2feca1",
    "billToCustomerNumber": "20000",
    "shipToName": "Trey Research",
    "shipToContact": "Helen Ray",
    "sellToAddressLine1": "153 Thomas Drive",
    "sellToAddressLine2": "",
    "sellToCity": "Chicago",
    "sellToCountry": "US",
    "sellToState": "IL",
    "sellToPostCode": "61236",
    "shipToAddressLine1": "153 Thomas Drive",
    "shipToAddressLine2": "",
    "shipToCity": "Chicago",
    "shipToCountry": "US",
    "shipToState": "IL",
    "shipToPostCode": "61236",
    "currencyId": "00000000-0000-0000-0000-000000000000",
    "currencyCode": "USD",
    "paymentTermsId": "0ba5738a-44e3-ea11-bb43-000d3a2feca1",
    "shipmentMethodId": "00000000-0000-0000-0000-000000000000",
    "salesperson": "PS",
    "discountAmount": 0,
    "phoneNumber": "",
    "email": "helen.ray@contoso.com"
  }
}

Get Sales Order​

Retrieves a sales order object in your Business Central Organization. | key: getSalesOrder

InputNotesExample
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false
Sales Order ID

The unique identifier of the sales order.

f1678e37-e50b-ef11-9f8e-6045bdc8c192

{
  "data": {
    "id": "54a53ee8-3835-ef11-840b-00224820d4a6",
    "number": "S-ORD101010",
    "externalDocumentNumber": "",
    "orderDate": "2023-09-01",
    "postingDate": "2023-09-02",
    "customerId": "7e57e220-e60b-ef11-9f8e-6045bdc8c192",
    "customerNumber": "10000",
    "customerName": "Adatum Corporation",
    "billToName": "Adatum Corporation",
    "billToCustomerId": "7e57e220-e60b-ef11-9f8e-6045bdc8c192",
    "billToCustomerNumber": "10000",
    "shipToName": "Adatum Corporation",
    "shipToContact": "Robert Townes",
    "sellToAddressLine1": "Station Road, 21",
    "sellToAddressLine2": "",
    "sellToCity": "Georgia",
    "sellToCountry": "US",
    "sellToState": "GA",
    "sellToPostCode": "31772",
    "billToAddressLine1": "Station Road, 21",
    "billToAddressLine2": "",
    "billToCity": "Georgia",
    "billToCountry": "US",
    "billToState": "GA",
    "billToPostCode": "31772",
    "shipToAddressLine1": "Station Road, 21",
    "shipToAddressLine2": "",
    "shipToCity": "Georgia",
    "shipToCountry": "US",
    "shipToState": "GA",
    "shipToPostCode": "31772",
    "shortcutDimension1Code": "",
    "shortcutDimension2Code": "MEDIUM",
    "currencyId": "00000000-0000-0000-0000-000000000000",
    "currencyCode": "USD",
    "pricesIncludeTax": false,
    "paymentTermsId": "7e55e220-e60b-ef11-9f8e-6045bdc8c192",
    "shipmentMethodId": "0756e220-e60b-ef11-9f8e-6045bdc8c192",
    "salesperson": "JO",
    "partialShipping": true,
    "requestedDeliveryDate": "0001-01-01",
    "discountAmount": 0,
    "discountAppliedBeforeTax": false,
    "totalAmountExcludingTax": 0,
    "totalTaxAmount": 0,
    "totalAmountIncludingTax": 0,
    "fullyShipped": false,
    "status": "Draft",
    "lastModifiedDateTime": "2024-06-28T10:26:43.957Z",
    "phoneNumber": "",
    "email": "robert.townes@contoso.com"
  }
}

Get Sales Shipment Line Item​

Gets a sales shipment line object | key: getSalesShipmentLines

InputNotesExample
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false
Sales Shipment Line ID

The ID of the sales shipment line object.

be90f4f2-1735-ef11-8409-6045bdfedf9a

{
  "data": {
    "@odata.context": "https://api.businesscentral.dynamics.com/v2.0/29dd78b9-6d0d-47ab-9427-2a49d9a1deb1/Production/api/v2.0/$metadata#companies(f1678e37-e50b-ef11-9f8e-6045bdc8c192)/salesShipmentLines/$entity",
    "@odata.etag": "W/\"JzE4Ozg0ODEwNzQxNDUwODk0NjY5MzE7MDA7Jw==\"",
    "id": "4f7a3456-e60b-ef11-9f8e-6045bdc8c192",
    "documentId": "437a3456-e60b-ef11-9f8e-6045bdc8c192",
    "documentNo": "S-SHPT102001",
    "sequence": 10000,
    "lineType": "Item",
    "lineObjectNumber": "1928-S",
    "description": "AMSTERDAM Lamp",
    "description2": "",
    "unitOfMeasureCode": "PCS",
    "unitPrice": 54.9,
    "quantity": 3,
    "discountPercent": 0,
    "taxPercent": 5,
    "shipmentDate": "2024-05-06"
  }
}

Get Shipment Method​

Retrieves a shipment method object in your Business Central organization. | key: getShipmentMethod

InputNotesExample
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false
Shipment Method Id

Specifies the shipment method used by the customer.

00000000-0000-0000-0000-000000000000

{
  "data": {
    "id": "be90f4f2-1735-ef11-8409-6045bdfedf9a",
    "code": "TEST",
    "displayName": "test",
    "lastModifiedDateTime": "2024-06-28T06:30:46.263Z"
  }
}

List Accounts​

Retrieve the properties and relationships of all account objects in your Business Central organization. | key: listAccounts

InputNotesExample
Count

Retrieves the total count of matching resources.

false
Expand

Retrieves related resources.

members
Filter

Filters results (rows).

startswith(givenName,'J')
Format

Returns the results in the specified media format.

json
Order By

Orders results.

displayName desc
Search

Returns results based on search criteria.

pizza
Select

Filters properties (columns).

givenName,surname
Skip

Indexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results.

10
Skip Token

Retrieves the next page of results from result sets that span multiple pages.

X%274453707402000100000017...
Top

Sets the page size of results.

10
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false

{
  "data": {
    "@odata.context": "https://api.businesscentral.dynamics.com/v2.0/29dd78b9-6d0d-47ab-9427-2a49d9a1deb1/Production/api/v2.0/$metadata#companies(f1678e37-e50b-ef11-9f8e-6045bdc8c192)/accounts",
    "value": [
      {
        "id": "2256e220-e60b-ef11-9f8e-6045bdc8c192",
        "number": "10000",
        "displayName": "Balance Sheet",
        "category": "Assets",
        "subCategory": "Assets",
        "blocked": false,
        "accountType": "Heading",
        "directPosting": false,
        "netChange": 0,
        "consolidationTranslationMethod": "Average Rate (Manual)",
        "consolidationDebitAccount": "",
        "consolidationCreditAccount": "",
        "excludeFromConsolidation": false,
        "lastModifiedDateTime": "2024-05-06T20:21:22.54Z"
      }
    ]
  }
}

List Companies​

Retrieve the properties and relationships of companies in your Business Central organization. | key: listCompanies

InputNotesExample
Count

Retrieves the total count of matching resources.

false
Expand

Retrieves related resources.

members
Filter

Filters results (rows).

startswith(givenName,'J')
Format

Returns the results in the specified media format.

json
Order By

Orders results.

displayName desc
Search

Returns results based on search criteria.

pizza
Select

Filters properties (columns).

givenName,surname
Skip

Indexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results.

10
Skip Token

Retrieves the next page of results from result sets that span multiple pages.

X%274453707402000100000017...
Top

Sets the page size of results.

10
Connection
Debug Request

Enabling this flag will log out the current request.

false

{
  "data": {
    "@odata.context": "https://api.businesscentral.dynamics.com/v2.0/production/api/data/$metadata#companies",
    "value": [
      {
        "id": "f1678e37-e50b-ef11-9f8e-6045bdc8c192",
        "systemVersion": "24.1.18927.19282",
        "timestamp": 4070,
        "name": "CRONUS USA, Inc.",
        "displayName": "",
        "businessProfileId": "",
        "systemCreatedAt": "2024-05-06T20:14:23.247Z",
        "systemCreatedBy": "00000000-0000-0000-0000-000000000001",
        "systemModifiedAt": "2024-05-06T20:14:23.247Z",
        "systemModifiedBy": "00000000-0000-0000-0000-000000000001"
      }
    ]
  }
}

List Customers​

Retrieve the properties and relationships of all customer objects in your Business Central organization. | key: listCustomers

InputNotesExample
Count

Retrieves the total count of matching resources.

false
Expand

Retrieves related resources.

members
Filter

Filters results (rows).

startswith(givenName,'J')
Format

Returns the results in the specified media format.

json
Order By

Orders results.

displayName desc
Search

Returns results based on search criteria.

pizza
Select

Filters properties (columns).

givenName,surname
Skip

Indexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results.

10
Skip Token

Retrieves the next page of results from result sets that span multiple pages.

X%274453707402000100000017...
Top

Sets the page size of results.

10
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false

{
  "data": {
    "value": [
      {
        "id": "7e57e220-e60b-ef11-9f8e-6045bdc8c192",
        "number": "10000",
        "displayName": "Adatum Corporation",
        "type": "Company",
        "addressLine1": "192 Market Square",
        "addressLine2": "",
        "city": "Atlanta",
        "state": "GA",
        "country": "US",
        "postalCode": "31772",
        "phoneNumber": "",
        "email": "robert.townes@contoso.com",
        "website": "",
        "salespersonCode": "JO",
        "balanceDue": 0,
        "creditLimit": 0,
        "taxLiable": true,
        "taxAreaId": "0241ba25-e60b-ef11-9f8e-6045bdc8c192",
        "taxAreaDisplayName": "ATLANTA, GA",
        "taxRegistrationNumber": "",
        "currencyId": "00000000-0000-0000-0000-000000000000",
        "currencyCode": "USD",
        "paymentTermsId": "8055e220-e60b-ef11-9f8e-6045bdc8c192",
        "shipmentMethodId": "00000000-0000-0000-0000-000000000000",
        "paymentMethodId": "00000000-0000-0000-0000-000000000000",
        "blocked": "_x0020_",
        "lastModifiedDateTime": "2024-05-06T20:21:41.53Z"
      },
      {
        "id": "7f57e220-e60b-ef11-9f8e-6045bdc8c192",
        "number": "20000",
        "displayName": "Trey Research",
        "type": "Company",
        "addressLine1": "153 Thomas Drive",
        "addressLine2": "",
        "city": "Chicago",
        "state": "IL",
        "country": "US",
        "postalCode": "61236",
        "phoneNumber": "",
        "email": "helen.ray@contoso.com",
        "website": "",
        "salespersonCode": "JO",
        "balanceDue": 3036.6,
        "creditLimit": 0,
        "taxLiable": true,
        "taxAreaId": "0341ba25-e60b-ef11-9f8e-6045bdc8c192",
        "taxAreaDisplayName": "CHICAGO, IL",
        "taxRegistrationNumber": "",
        "currencyId": "00000000-0000-0000-0000-000000000000",
        "currencyCode": "USD",
        "paymentTermsId": "7e55e220-e60b-ef11-9f8e-6045bdc8c192",
        "shipmentMethodId": "00000000-0000-0000-0000-000000000000",
        "paymentMethodId": "00000000-0000-0000-0000-000000000000",
        "blocked": "_x0020_",
        "lastModifiedDateTime": "2024-05-06T20:21:41.543Z"
      },
      {
        "id": "8057e220-e60b-ef11-9f8e-6045bdc8c192",
        "number": "30000",
        "displayName": "School of Fine Art",
        "type": "Company",
        "addressLine1": "10 High Tower Green",
        "addressLine2": "",
        "city": "Miami",
        "state": "FL",
        "country": "US",
        "postalCode": "37125",
        "phoneNumber": "",
        "email": "meagan.bond@contoso.com",
        "website": "",
        "salespersonCode": "JO",
        "balanceDue": 53833.52,
        "creditLimit": 0,
        "taxLiable": true,
        "taxAreaId": "0441ba25-e60b-ef11-9f8e-6045bdc8c192",
        "taxAreaDisplayName": "MIAMI, FL",
        "taxRegistrationNumber": "",
        "currencyId": "00000000-0000-0000-0000-000000000000",
        "currencyCode": "USD",
        "paymentTermsId": "8655e220-e60b-ef11-9f8e-6045bdc8c192",
        "shipmentMethodId": "00000000-0000-0000-0000-000000000000",
        "paymentMethodId": "00000000-0000-0000-0000-000000000000",
        "blocked": "_x0020_",
        "lastModifiedDateTime": "2024-05-06T20:21:41.607Z"
      },
      {
        "id": "8157e220-e60b-ef11-9f8e-6045bdc8c192",
        "number": "40000",
        "displayName": "Alpine Ski House",
        "type": "Company",
        "addressLine1": "10 Deerfield Road",
        "addressLine2": "",
        "city": "Atlanta",
        "state": "GA",
        "country": "US",
        "postalCode": "31772",
        "phoneNumber": "",
        "email": "ian.deberry@contoso.com",
        "website": "",
        "salespersonCode": "JO",
        "balanceDue": 4316.92,
        "creditLimit": 0,
        "taxLiable": true,
        "taxAreaId": "0541ba25-e60b-ef11-9f8e-6045bdc8c192",
        "taxAreaDisplayName": "Atlanta, GA - North",
        "taxRegistrationNumber": "",
        "currencyId": "00000000-0000-0000-0000-000000000000",
        "currencyCode": "USD",
        "paymentTermsId": "8055e220-e60b-ef11-9f8e-6045bdc8c192",
        "shipmentMethodId": "00000000-0000-0000-0000-000000000000",
        "paymentMethodId": "00000000-0000-0000-0000-000000000000",
        "blocked": "_x0020_",
        "lastModifiedDateTime": "2024-05-06T20:21:41.62Z"
      },
      {
        "id": "8257e220-e60b-ef11-9f8e-6045bdc8c192",
        "number": "50000",
        "displayName": "Relecloud",
        "type": "Company",
        "addressLine1": "25 Water Way",
        "addressLine2": "",
        "city": "Atlanta",
        "state": "GA",
        "country": "US",
        "postalCode": "31772",
        "phoneNumber": "",
        "email": "jesse.homer@contoso.com",
        "website": "",
        "salespersonCode": "JO",
        "balanceDue": 8836.8,
        "creditLimit": 0,
        "taxLiable": true,
        "taxAreaId": "0241ba25-e60b-ef11-9f8e-6045bdc8c192",
        "taxAreaDisplayName": "ATLANTA, GA",
        "taxRegistrationNumber": "",
        "currencyId": "00000000-0000-0000-0000-000000000000",
        "currencyCode": "USD",
        "paymentTermsId": "7e55e220-e60b-ef11-9f8e-6045bdc8c192",
        "shipmentMethodId": "00000000-0000-0000-0000-000000000000",
        "paymentMethodId": "00000000-0000-0000-0000-000000000000",
        "blocked": "_x0020_",
        "lastModifiedDateTime": "2024-05-06T20:21:41.637Z"
      },
      {
        "id": "83800c53-4227-ef11-9f88-002248241214",
        "number": "C00010",
        "displayName": "Acme",
        "type": "Company",
        "addressLine1": "",
        "addressLine2": "",
        "city": "",
        "state": "",
        "country": "US",
        "postalCode": "",
        "phoneNumber": "",
        "email": "",
        "website": "",
        "salespersonCode": "",
        "balanceDue": 0,
        "creditLimit": 0,
        "taxLiable": false,
        "taxAreaId": "0341ba25-e60b-ef11-9f8e-6045bdc8c192",
        "taxAreaDisplayName": "CHICAGO, IL",
        "taxRegistrationNumber": "",
        "currencyId": "00000000-0000-0000-0000-000000000000",
        "currencyCode": "USD",
        "paymentTermsId": "8055e220-e60b-ef11-9f8e-6045bdc8c192",
        "shipmentMethodId": "00000000-0000-0000-0000-000000000000",
        "paymentMethodId": "a940ba25-e60b-ef11-9f8e-6045bdc8c192",
        "blocked": "_x0020_",
        "lastModifiedDateTime": "2024-06-10T15:59:01.273Z"
      },
      {
        "id": "8ba01a7a-5734-ef11-8409-7c1e5213ec0e",
        "number": "C00020",
        "displayName": "Customer Test 1",
        "type": "Person",
        "addressLine1": "192 Market square",
        "addressLine2": "",
        "city": "Atlanta",
        "state": "GA",
        "country": "US",
        "postalCode": "31772",
        "phoneNumber": "",
        "email": "robert.townes@gmailfake.com",
        "website": "www.sample.com",
        "salespersonCode": "",
        "balanceDue": 0,
        "creditLimit": 0,
        "taxLiable": false,
        "taxAreaId": "0241ba25-e60b-ef11-9f8e-6045bdc8c192",
        "taxAreaDisplayName": "ATLANTA, GA",
        "taxRegistrationNumber": "",
        "currencyId": "8955e220-e60b-ef11-9f8e-6045bdc8c192",
        "currencyCode": "EUR",
        "paymentTermsId": "7d55e220-e60b-ef11-9f8e-6045bdc8c192",
        "shipmentMethodId": "0756e220-e60b-ef11-9f8e-6045bdc8c192",
        "paymentMethodId": "a840ba25-e60b-ef11-9f8e-6045bdc8c192",
        "blocked": "_x0020_",
        "lastModifiedDateTime": "2024-06-27T07:33:02.2Z"
      }
    ]
  }
}

List Items​

List all item objects from your Business Central Organization. | key: listItems

InputNotesExample
Count

Retrieves the total count of matching resources.

false
Expand

Retrieves related resources.

members
Filter

Filters results (rows).

startswith(givenName,'J')
Format

Returns the results in the specified media format.

json
Order By

Orders results.

displayName desc
Search

Returns results based on search criteria.

pizza
Select

Filters properties (columns).

givenName,surname
Skip

Indexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results.

10
Skip Token

Retrieves the next page of results from result sets that span multiple pages.

X%274453707402000100000017...
Top

Sets the page size of results.

10
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false

List Purchase Order Lines​

List all purchase order line objects in your Business Central Organization. | key: listPurchaseOrderLines

InputNotesExample
Count

Retrieves the total count of matching resources.

false
Expand

Retrieves related resources.

members
Filter

Filters results (rows).

startswith(givenName,'J')
Format

Returns the results in the specified media format.

json
Order By

Orders results.

displayName desc
Search

Returns results based on search criteria.

pizza
Select

Filters properties (columns).

givenName,surname
Skip

Indexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results.

10
Skip Token

Retrieves the next page of results from result sets that span multiple pages.

X%274453707402000100000017...
Top

Sets the page size of results.

10
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false
Purchase Order ID

The unique ID of the purchase order.

00000000-0000-0000-0000-000000000000

{
  "data": {
    "value": [
      {
        "id": "1e8cb9c0-44e3-ea11-bb43-000d3a2feca1",
        "documentId": "960f5c9c-44e3-ea11-bb43-000d3a2feca1",
        "sequence": 10000,
        "itemId": "0ea6738a-44e3-ea11-bb43-000d3a2feca1",
        "accountId": "93f5638a-55e3-jk22-aa32-211d3a2fdce5",
        "lineType": "Item",
        "lineObjectNumber": "1996-S",
        "description": "ATLANTA Whiteboard, base",
        "unitOfMeasureId": "5ca6738a-44e3-ea11-bb43-000d3a2feca1",
        "unitOfMeasureCode": "PCS",
        "quantity": 12,
        "directUnitCost": 1397.3,
        "discountAmount": 0,
        "discountPercent": 0,
        "discountAppliedBeforeTax": false,
        "amountExcludingTax": 16767.6,
        "taxCode": "FURNITURE",
        "taxPercent": 6.00002,
        "totalTaxAmount": 1006.06,
        "amountIncludingTax": 17773.66,
        "invoiceDiscountAllocation": 0,
        "netAmount": 16767.6,
        "netTaxAmount": 1006.06,
        "netAmountIncludingTax": 17773.66,
        "expectedReceiptDate": "2020-04-02T00:00:00.000Z",
        "receivedQuantity": 0,
        "invoicedQuantity": 0,
        "invoiceQuantity": 12,
        "receiveQuantity": 12,
        "itemVariantId": "00000000-0000-0000-0000-000000000000",
        "locationId": "00000000-0000-0000-0000-000000000000"
      }
    ]
  }
}

List Purchase Orders​

List all purchase order objects in your Business Central Organization. | key: listPurchaseOrders

InputNotesExample
Count

Retrieves the total count of matching resources.

false
Expand

Retrieves related resources.

members
Filter

Filters results (rows).

startswith(givenName,'J')
Format

Returns the results in the specified media format.

json
Order By

Orders results.

displayName desc
Search

Returns results based on search criteria.

pizza
Select

Filters properties (columns).

givenName,surname
Skip

Indexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results.

10
Skip Token

Retrieves the next page of results from result sets that span multiple pages.

X%274453707402000100000017...
Top

Sets the page size of results.

10
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false

{
  "data": {
    "value": [
      {
        "id": "5d115c9c-44e3-ea11-bb43-000d3a2feca1",
        "number": "108001",
        "orderDate": "2021-01-01T00:00:00.000Z",
        "postingDate": "2021-01-01T00:00:00.000Z",
        "dueDate": "2021-01-01T00:00:00.000Z",
        "vendorId": "",
        "vendorNumber": "20000",
        "vendorName": "First Up Consultants",
        "payToName": "First Up Consultants",
        "payToVendorId": "Evan McIntosh",
        "payToVendorNumber": "20000",
        "shipToName": "First Up Consultants",
        "shipToContact": "Evan McIntosh",
        "buyFromAddressLine1": "100 Day Drive",
        "buyFromAddressLine2": "",
        "buyFromCity": "Chicago",
        "buyFromCountry": "US",
        "buyFromState": "IL",
        "buyFromPostCode": "61236",
        "shipToAddressLine1": "100 Day Drive",
        "shipToAddressLine2": "",
        "shipToCity": "Chicago",
        "shipToCountry": "US",
        "shipToState": "IL",
        "shipToPostCode": "61236",
        "payToAddressLine1": "100 Day Drive",
        "payToAddressLine2": "",
        "payToCity": "Chicago",
        "payToCountry": "US",
        "payToState": "IL",
        "payToPostCode": "61236",
        "currencyId": "00000000-0000-0000-0000-000000000000",
        "currencyCode": "USD",
        "pricesIncludeTax": false,
        "paymentTermsId": "04a5738a-44e3-ea11-bb43-000d3a2feca1",
        "shipmentMethodId": "93f5638a-55e3-jk22-aa32-211d3a2fdce5",
        "purchaser": "First Up Consultants",
        "requestedReceiptDate": "2021-01-01T00:00:00.000Z",
        "discountAmount": 0,
        "discountAppliedBeforeTax": false,
        "totalAmountExcludingTax": 0,
        "totalTaxAmount": 0,
        "totalAmountIncludingTax": 0,
        "fullyReceived": false,
        "status": "Draft",
        "lastModifiedDateTime": "2021-01-01T00:26:53.793Z",
        "shortcutDimension1Code": "",
        "shortcutDimension2Code": ""
      }
    ]
  }
}

List Purchase Receipt Lines​

List all purchase receipt line objects in your Business Central Organization. | key: listPurchaseReceiptLines

InputNotesExample
Count

Retrieves the total count of matching resources.

false
Expand

Retrieves related resources.

members
Filter

Filters results (rows).

startswith(givenName,'J')
Format

Returns the results in the specified media format.

json
Order By

Orders results.

displayName desc
Search

Returns results based on search criteria.

pizza
Select

Filters properties (columns).

givenName,surname
Skip

Indexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results.

10
Skip Token

Retrieves the next page of results from result sets that span multiple pages.

X%274453707402000100000017...
Top

Sets the page size of results.

10
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false

{
  "data": {
    "value": [
      {
        "id": "dd8db9c0-44e3-ea11-bb43-000d3a2feca1",
        "documentId": "5d115c9c-44e3-ea11-bb43-000d3a2feca1",
        "sequence": 10000,
        "lineType": "Item",
        "lineObjectNumber": "1896-S",
        "description": "ATHENS Desk",
        "unitOfMeasureCode": "PCS",
        "unitCost": 780.7,
        "quantity": 4,
        "discountPercent": 5,
        "taxPercent": 10,
        "expectedReceiptDate": "2021-01-01T00:00:00.000Z"
      }
    ]
  }
}

List Purchase Receipts​

List all purchase receipt objects in your Business Central Organization. | key: listPurchaseReceipts

InputNotesExample
Count

Retrieves the total count of matching resources.

false
Expand

Retrieves related resources.

members
Filter

Filters results (rows).

startswith(givenName,'J')
Format

Returns the results in the specified media format.

json
Order By

Orders results.

displayName desc
Search

Returns results based on search criteria.

pizza
Select

Filters properties (columns).

givenName,surname
Skip

Indexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results.

10
Skip Token

Retrieves the next page of results from result sets that span multiple pages.

X%274453707402000100000017...
Top

Sets the page size of results.

10
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false

{
  "data": {
    "value": [
      {
        "id": "5d115c9c-44e3-ea11-bb43-000d3a2feca1",
        "number": "108001",
        "invoiceDate": "2019-01-01T00:00:00.000Z",
        "postingDate": "2019-01-01T00:00:00.000Z",
        "dueDate": "2019-01-01T00:00:00.000Z",
        "vendorNumber": "20000",
        "vendorName": "First Up Consultants",
        "payToName": "First Up Consultants",
        "payToContact": "Evan McIntosh",
        "payToVendorNumber": "20000",
        "shipToName": "First Up Consultants",
        "shipToContact": "Evan McIntosh",
        "buyFromAddressLine1": "100 Day Drive",
        "buyFromAddressLine2": "",
        "buyFromCity": "Chicago",
        "buyFromCountry": "US",
        "buyFromState": "IL",
        "buyFromPostCode": "61236",
        "shipToAddressLine1": "100 Day Drive",
        "shipToAddressLine2": "",
        "shipToCity": "Chicago",
        "shipToCountry": "US",
        "shipToState": "IL",
        "shipToPostCode": "61236",
        "payToAddressLine1": "100 Day Drive",
        "payToAddressLine2": "",
        "payToCity": "Chicago",
        "payToCountry": "US",
        "payToState": "IL",
        "payToPostCode": "61236",
        "currencyCode": "USD",
        "lastModifiedDateTime": "2019-01-01T00:00:00.000Z"
      }
    ]
  }
}

List Sales Invoices​

List all sales invoices objects in your Business Central Organization. | key: listSalesInvoices

InputNotesExample
Count

Retrieves the total count of matching resources.

false
Expand

Retrieves related resources.

members
Filter

Filters results (rows).

startswith(givenName,'J')
Format

Returns the results in the specified media format.

json
Order By

Orders results.

displayName desc
Search

Returns results based on search criteria.

pizza
Select

Filters properties (columns).

givenName,surname
Skip

Indexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results.

10
Skip Token

Retrieves the next page of results from result sets that span multiple pages.

X%274453707402000100000017...
Top

Sets the page size of results.

10
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false

{
  "data": {
    "value": [
      {
        "id": "a84eb92b-e60b-ef11-9f8e-6045bdc8c192",
        "number": "PS-INV103001",
        "externalDocumentNumber": "",
        "invoiceDate": "2023-01-17",
        "postingDate": "2023-01-17",
        "dueDate": "2023-01-17",
        "promisedPayDate": "0001-01-01",
        "customerPurchaseOrderReference": "",
        "customerId": "7f57e220-e60b-ef11-9f8e-6045bdc8c192",
        "customerNumber": "20000",
        "customerName": "Trey Research",
        "billToName": "Trey Research",
        "billToCustomerId": "7f57e220-e60b-ef11-9f8e-6045bdc8c192",
        "billToCustomerNumber": "20000",
        "shipToName": "Trey Research",
        "shipToContact": "Helen Ray",
        "sellToAddressLine1": "153 Thomas Drive",
        "sellToAddressLine2": "",
        "sellToCity": "Chicago",
        "sellToCountry": "US",
        "sellToState": "IL",
        "sellToPostCode": "61236",
        "billToAddressLine1": "153 Thomas Drive",
        "billToAddressLine2": "",
        "billToCity": "Chicago",
        "billToCountry": "US",
        "billToState": "IL",
        "billToPostCode": "61236",
        "shipToAddressLine1": "153 Thomas Drive",
        "shipToAddressLine2": "",
        "shipToCity": "Chicago",
        "shipToCountry": "US",
        "shipToState": "IL",
        "shipToPostCode": "61236",
        "currencyId": "00000000-0000-0000-0000-000000000000",
        "shortcutDimension1Code": "SALES",
        "shortcutDimension2Code": "MEDIUM",
        "currencyCode": "USD",
        "orderId": "00000000-0000-0000-0000-000000000000",
        "orderNumber": "",
        "paymentTermsId": "8755e220-e60b-ef11-9f8e-6045bdc8c192",
        "shipmentMethodId": "00000000-0000-0000-0000-000000000000",
        "salesperson": "JO",
        "disputeStatusId": "00000000-0000-0000-0000-000000000000",
        "disputeStatus": "",
        "pricesIncludeTax": false,
        "remainingAmount": 0,
        "discountAmount": 0,
        "discountAppliedBeforeTax": true,
        "totalAmountExcludingTax": 164.7,
        "totalTaxAmount": 8.24,
        "totalAmountIncludingTax": 172.94,
        "status": "Paid",
        "lastModifiedDateTime": "2024-05-06T20:22:22.897Z",
        "phoneNumber": "",
        "email": "helen.ray@contoso.com"
      }
    ]
  }
}

List Sales Orders​

List all sales orders objects in your Business Central Organization. | key: listSalesOrders

InputNotesExample
Count

Retrieves the total count of matching resources.

false
Expand

Retrieves related resources.

members
Filter

Filters results (rows).

startswith(givenName,'J')
Format

Returns the results in the specified media format.

json
Order By

Orders results.

displayName desc
Search

Returns results based on search criteria.

pizza
Select

Filters properties (columns).

givenName,surname
Skip

Indexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results.

10
Skip Token

Retrieves the next page of results from result sets that span multiple pages.

X%274453707402000100000017...
Top

Sets the page size of results.

10
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false

{
  "data": {
    "value": [
      {
        "id": "a04eb92b-e60b-ef11-9f8e-6045bdc8c192",
        "number": "S-ORD101001",
        "externalDocumentNumber": "",
        "orderDate": "2024-04-02",
        "postingDate": "2024-04-02",
        "customerId": "7e57e220-e60b-ef11-9f8e-6045bdc8c192",
        "customerNumber": "10000",
        "customerName": "Adatum Corporation",
        "billToName": "Adatum Corporation",
        "billToCustomerId": "7e57e220-e60b-ef11-9f8e-6045bdc8c192",
        "billToCustomerNumber": "10000",
        "shipToName": "Adatum Corporation",
        "shipToContact": "Robert Townes",
        "sellToAddressLine1": "192 Market Square",
        "sellToAddressLine2": "",
        "sellToCity": "Atlanta",
        "sellToCountry": "US",
        "sellToState": "GA",
        "sellToPostCode": "31772",
        "billToAddressLine1": "192 Market Square",
        "billToAddressLine2": "",
        "billToCity": "Atlanta",
        "billToCountry": "US",
        "billToState": "GA",
        "billToPostCode": "31772",
        "shipToAddressLine1": "192 Market Square",
        "shipToAddressLine2": "",
        "shipToCity": "Atlanta",
        "shipToCountry": "US",
        "shipToState": "GA",
        "shipToPostCode": "31772",
        "shortcutDimension1Code": "SALES",
        "shortcutDimension2Code": "SMALL",
        "currencyId": "00000000-0000-0000-0000-000000000000",
        "currencyCode": "USD",
        "pricesIncludeTax": false,
        "paymentTermsId": "8055e220-e60b-ef11-9f8e-6045bdc8c192",
        "shipmentMethodId": "00000000-0000-0000-0000-000000000000",
        "salesperson": "JO",
        "partialShipping": true,
        "requestedDeliveryDate": "2024-04-03",
        "discountAmount": 0,
        "discountAppliedBeforeTax": true,
        "totalAmountExcludingTax": 16767.6,
        "totalTaxAmount": 1006.06,
        "totalAmountIncludingTax": 17773.66,
        "fullyShipped": true,
        "status": "Draft",
        "lastModifiedDateTime": "2024-06-28T12:31:52.077Z",
        "phoneNumber": "",
        "email": "robert.townes@contoso.com"
      }
    ]
  }
}

List Sales Shipment Line Items​

Lists all sales shipment line objects in your Business Central organization. | key: listSalesShipmentLines

InputNotesExample
Count

Retrieves the total count of matching resources.

false
Expand

Retrieves related resources.

members
Filter

Filters results (rows).

startswith(givenName,'J')
Format

Returns the results in the specified media format.

json
Order By

Orders results.

displayName desc
Search

Returns results based on search criteria.

pizza
Select

Filters properties (columns).

givenName,surname
Skip

Indexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results.

10
Skip Token

Retrieves the next page of results from result sets that span multiple pages.

X%274453707402000100000017...
Top

Sets the page size of results.

10
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false

{
  "data": {
    "value": [
      {
        "id": "4f7a3456-e60b-ef11-9f8e-6045bdc8c192",
        "documentId": "437a3456-e60b-ef11-9f8e-6045bdc8c192",
        "documentNo": "S-SHPT102001",
        "sequence": 10000,
        "lineType": "Item",
        "lineObjectNumber": "1928-S",
        "description": "AMSTERDAM Lamp",
        "description2": "",
        "unitOfMeasureCode": "PCS",
        "unitPrice": 54.9,
        "quantity": 3,
        "discountPercent": 0,
        "taxPercent": 5,
        "shipmentDate": "2024-05-06"
      }
    ]
  }
}

List Sales Shipments​

List all sales shipments objects from your Business Central organization. | key: listSaleShipments

InputNotesExample
Count

Retrieves the total count of matching resources.

false
Expand

Retrieves related resources.

members
Filter

Filters results (rows).

startswith(givenName,'J')
Format

Returns the results in the specified media format.

json
Order By

Orders results.

displayName desc
Search

Returns results based on search criteria.

pizza
Select

Filters properties (columns).

givenName,surname
Skip

Indexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results.

10
Skip Token

Retrieves the next page of results from result sets that span multiple pages.

X%274453707402000100000017...
Top

Sets the page size of results.

10
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false

{
  "data": {
    "@odata.context": "https://api.businesscentral.dynamics.com/v2.0/29dd78b9-6d0d-47ab-9427-2a49d9a1deb1/Production/api/v2.0/$metadata#companies(f1678e37-e50b-ef11-9f8e-6045bdc8c192)/salesShipments",
    "value": [
      {
        "id": "437a3456-e60b-ef11-9f8e-6045bdc8c192",
        "number": "S-SHPT102001",
        "externalDocumentNumber": "",
        "invoiceDate": "2023-01-17",
        "postingDate": "2023-01-17",
        "dueDate": "2023-01-17",
        "customerPurchaseOrderReference": "",
        "customerId": "7f57e220-e60b-ef11-9f8e-6045bdc8c192",
        "customerNumber": "20000",
        "customerName": "Trey Research",
        "billToCustomerId": "7f57e220-e60b-ef11-9f8e-6045bdc8c192",
        "billToName": "Trey Research",
        "billToCustomerNumber": "20000",
        "shipToName": "Trey Research",
        "shipToContact": "Helen Ray",
        "sellToAddressLine1": "153 Thomas Drive",
        "sellToAddressLine2": "",
        "sellToCity": "Chicago",
        "sellToCountry": "US",
        "sellToState": "IL",
        "sellToPostCode": "61236",
        "billToAddressLine1": "153 Thomas Drive",
        "billToAddressLine2": "",
        "billToCity": "Chicago",
        "billToCountry": "US",
        "billToState": "IL",
        "billToPostCode": "61236",
        "shipToAddressLine1": "153 Thomas Drive",
        "shipToAddressLine2": "",
        "shipToCity": "Chicago",
        "shipToCountry": "US",
        "shipToState": "IL",
        "shipToPostCode": "61236",
        "currencyCode": "USD",
        "orderNumber": "",
        "paymentTermsCode": "COD",
        "shipmentMethodCode": "",
        "salesperson": "JO",
        "pricesIncludeTax": false,
        "lastModifiedDateTime": "2024-05-06T20:22:21.69Z",
        "phoneNumber": "",
        "email": "helen.ray@contoso.com"
      }
    ]
  }
}

List Subscriptions​

List all subscriptions for Microsoft Business Central. | key: listSubscriptions

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Show Instance Webhooks

Show only subscriptions for this Instance's webhooks.

false

{
  "data": {
    "@odata.context": "https://api.test.dynamics.com/v2.0/d68w-6d0d-47ab-9427-d4r8/Production/api/v2.0/$metadata#subscriptions",
    "value": [
      {
        "@odata.context": "https://api.test.dynamics.com/v2.0/29dd78b9-6d0d-47ab-9427-ss23/Production/api/v2.0/$metadata#subscriptions/$entity",
        "etag": "W/\"JzE5OzM3MzQyNTU5MTk5MTQwNDIzMTkxOzAxzw=\"",
        "subscriptionId": "ba1cba0177854a6091865452e017742b",
        "notificationUrl": "https://hooks.example.com/trigger/example",
        "resource": "api/v2.0/companies(66d8-1a4e-ef11-bfe7-sd548)/customers",
        "timestamp": 193385,
        "userId": "ds58w-ee2b-429f-aa8c-sd4899",
        "lastModifiedDateTime": "2025-01-15T21:48:39Z",
        "clientState": "",
        "expirationDateTime": "2025-01-18T21:48:39Z",
        "systemCreatedAt": "2025-01-15T21:48:40.577Z",
        "systemCreatedBy": "ds58w-ee2b-429f-aa8c-sd4899",
        "systemModifiedAt": "2025-01-15T21:48:40.577Z",
        "systemModifiedBy": "ds58w-ee2b-429f-aa8c-sd4899"
      }
    ]
  }
}

Raw Request​

Send a raw HTTP request to Microsoft's Business Central API | key: rawRequest

InputNotesExample
Connection
Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
Debug Request

Enable this to log the request and response

false
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

Query Parameter

A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.

false
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

Input the path only (/companies(companyId), the base URL along with the version is already included

/sobjects/Account
Use Exponential Backoff

Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

false

Update Attachment​

Update the attachment content in Business Central. | key: updateAttachment

InputNotesExample
Attachment Content

The content of the attachment.

<binary data>
Attachment ID

The ID of the attachment to update.

25b8238e-f034-ef11-840b-002248241214
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false

{
  "data": {
    "message": "Success"
  }
}

Update Company Information​

Update the properties of a company information object in your Business Central organization. | key: updateCompanyInformation

InputNotesExample
Address Line 1

The first line of the company's address.

7122 South Ashford Street
Address Line 2

The second line of the company's address.

Westminster
City

The city where the company is located.

Atlanta
Country

The country where the company is located.

US
Currency Code

The currency code used by the company.

USD
Current Fiscal Year Start Date

The start date of the company's current fiscal year.

2021-01-01
Display Name

The name of the company as it should be displayed to users.

CRONUS USA, Inc.
Email

The company's email address.

example@gmail.com
Fax Number

The company's fax number.

+1 425 555 0101
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Industry

The industry in which the company operates.

yourIndustryHere
Company Information ID

The unique identifier of the company information object.

f80b7995-6869-4958-ac60-25e4fcdeeada
Phone Number

The company's phone number.

+1 425 555 0100
Postal Code

The postal code of the company's address.

31772
State

The state where the company is located.

GA
Tax Registration Number

The company's tax registration number.

f80b7995-6869-4958-ac60-25e4fcdeeada
Website

The company's website URL.

www.sample.com
Connection
Debug Request

Enabling this flag will log out the current request.

false

{
  "data": {
    "displayName": "CRONUS USA, Inc.",
    "addressLine1": "7122 South Ashford Street",
    "addressLine2": "Westminster",
    "city": "Atlanta",
    "state": "GA",
    "country": "US",
    "postalCode": "31772",
    "phoneNumber": "+1 425 555 0100",
    "faxNumber": "+1 425 555 0101",
    "email": "",
    "website": "",
    "taxRegistrationNumber": "",
    "currencyCode": "USD",
    "currentFiscalYearStartDate": "2021-01-01",
    "industry": ""
  }
}

Update Customer​

Update a customer object in your Business Central organization. | key: updateCustomer

InputNotesExample
Address Line 1

Specifies the first line of the customer's address.

192 Market Square
Address Line 2

Specifies the second line of the customer's address.

192 Market Square
Actions Blocked

Specifies which transactions with the customer cannot be posted.It can be empty, 'Ship', 'Invoice' or 'All'

Ship
City

Specifies the city of the customer's address.

Atlanta
Company ID

The ID of the company to which the customer belongs.

00000000-0000-0000-0000-000000000000
Connection
Country

Specifies the country of the customer's address.

US
Currency Code

Specifies the currency code used by the customer.

USD
Currency Id

Specifies the currency used by the customer.

00000000-0000-0000-0000-000000000000
Customer ID

The unique identifier of the customer.

8ba01a7a-5734-ef11-8409-7c1e5213ec0e
Customer Type

Specifies the type of customer.

Company
Debug Request

Enabling this flag will log out the current request.

false
Display Name

Specifies the customer's name.

Adatum Corporation
Email

Specifies the customer's email address.

robert.townes@contoso.com
Payment Method Id

Specifies the payment method used by the customer.

3b196a90-44e3-ea11-bb43-000d3a2feca1
Payment Terms Id

Specifies the payment terms used by the customer.

04a5738a-44e3-ea11-bb43-000d3a2feca1
Phone Number

Specifies the customer's phone number.

+1 555-555-5555
Postal Code

Specifies the postal code of the customer's address.

31772
Shipment Method Id

Specifies the shipment method used by the customer.

00000000-0000-0000-0000-000000000000
State

Specifies the state of the customer's address.

GA
Tax Area Id

Specifies which tax area the customer belongs to.

90196a90-44e3-ea11-bb43-000d3a2feca1
Tax Liable

specifies if the customer or vendor is liable for sales tax. Set to true if the customer is tax liable.

Tax Registration Number

Specifies the customer's tax registration number.

Website

Specifies the customer's website.

www.sample.com

{
  "data": {
    "id": "8ba01a7a-5734-ef11-8409-7c1e5213ec0e",
    "number": "C00020",
    "displayName": "Customer Test 1",
    "type": "Person",
    "addressLine1": "192 Market square",
    "addressLine2": "",
    "city": "Atlanta",
    "state": "GA",
    "country": "US",
    "postalCode": "31772",
    "phoneNumber": "",
    "email": "robert.townes@gmailfake.com",
    "website": "www.sample.com",
    "salespersonCode": "",
    "balanceDue": 0,
    "creditLimit": 0,
    "taxLiable": false,
    "taxAreaId": "0241ba25-e60b-ef11-9f8e-6045bdc8c192",
    "taxAreaDisplayName": "ATLANTA, GA",
    "taxRegistrationNumber": "",
    "currencyId": "8955e220-e60b-ef11-9f8e-6045bdc8c192",
    "currencyCode": "EUR",
    "paymentTermsId": "7d55e220-e60b-ef11-9f8e-6045bdc8c192",
    "shipmentMethodId": "0756e220-e60b-ef11-9f8e-6045bdc8c192",
    "paymentMethodId": "a840ba25-e60b-ef11-9f8e-6045bdc8c192",
    "blocked": "_x0020_",
    "lastModifiedDateTime": "2024-06-27T07:33:02.2Z"
  }
}

Update Event Subscription​

Update existing Event subscription for Microsoft Business Central. | key: updateEventSubscription

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Etag

Etag value for the subscription to delete.

W/"JzEtNjM3NjQwMzUwMDAwMDAwMCc="
Notification URL

URL to send events of this Subscription to.

https://example.com/webhook
Resource

Resource to subscribe to.

/api/v1.0/companies(f64eba74-dacd-4854-a584-1834f68cfc3a)/customers
Subscription ID

Subscription ID to manage.

7d577253-3ef0-4a0a-bb7f-8335c2596e70

{
  "data": {
    "@odata.context": "https://api.test.dynamics.com/v2.0/29dd78b9-6d0d-47ab-9427-ss23/Production/api/v2.0/$metadata#subscriptions/$entity",
    "etag": "W/\"JzE5OzM3MzQyNTU5MTk5MTQwNDIzMTkxOzAxzw=\"",
    "subscriptionId": "ba1cba0177854a6091865452e017742b",
    "notificationUrl": "https://hooks.example.com/trigger/example",
    "resource": "api/v2.0/companies(66d8-1a4e-ef11-bfe7-sd548)/customers",
    "timestamp": 193385,
    "userId": "ds58w-ee2b-429f-aa8c-sd4899",
    "lastModifiedDateTime": "2025-01-15T21:48:39Z",
    "clientState": "",
    "expirationDateTime": "2025-01-18T21:48:39Z",
    "systemCreatedAt": "2025-01-15T21:48:40.577Z",
    "systemCreatedBy": "ds58w-ee2b-429f-aa8c-sd4899",
    "systemModifiedAt": "2025-01-15T21:48:40.577Z",
    "systemModifiedBy": "ds58w-ee2b-429f-aa8c-sd4899"
  }
}

Update Item​

Updates an item object from your Business Central Organization. | key: updateItem

InputNotesExample
Base Unit Of Measure Code

The item's base unit of measure code.

PCS
Base Unit Of Measure Id

Specifies the ID of the unit of measure.

5ca6738a-44e3-ea11-bb43-000d3a2feca1
Blocked

Specifies that entries cannot be posted to the item. True indicates account is blocked and posting is not allowed.

false
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false
Display Name

The display name of the item.

ATHENS Desk
Global Trade Item Number

The Global Trade Item Number (GTIN) of the item.

1234567890123
Item Category Code

The code of the item category in the item.

TABLE
Item Category Id

The id of the item category in the item.

e21a6a90-44e3-ea11-bb43-000d3a2feca1
Item Id

The id of the item.

e21a6a90-44e3-ea11-bb43-000d3a2feca1
Price Includes Tax

Specifies whether the price includes tax.

false
Tax Group Code

The code of the tax group in the item.

FURNITURE
Tax Group Id

The id of the tax group in the item.

9f196a90-44e3-ea11-bb43-000d3a2feca1
Type

The type of the item.

Inventory
Unit Cost

The unit cost of the item.

780.7
Unit Price

The unit price of the item.

1000.8

{
  "data": {
    "id": "5247fc6c-2f35-ef11-840b-002248241214",
    "number": "TESTO-001",
    "displayName": "TEST",
    "displayName2": "",
    "type": "Inventory",
    "itemCategoryId": "00000000-0000-0000-0000-000000000000",
    "itemCategoryCode": "",
    "blocked": false,
    "gtin": "",
    "inventory": 0,
    "unitPrice": 0,
    "priceIncludesTax": false,
    "unitCost": 0,
    "taxGroupId": "00000000-0000-0000-0000-000000000000",
    "taxGroupCode": "",
    "baseUnitOfMeasureId": "f957e220-e60b-ef11-9f8e-6045bdc8c192",
    "baseUnitOfMeasureCode": "PCS",
    "generalProductPostingGroupId": "9240ba25-e60b-ef11-9f8e-6045bdc8c192",
    "generalProductPostingGroupCode": "RETAIL",
    "inventoryPostingGroupId": "e557e220-e60b-ef11-9f8e-6045bdc8c192",
    "inventoryPostingGroupCode": "RESALE",
    "lastModifiedDateTime": "2024-06-28T09:18:58.05Z"
  }
}

Update Purchase Order​

Updates a purchase order object in your Business Central organization. | key: updatePurchaseOrder

InputNotesExample
Additional Properties

Additional properties to include in the request body. In case of supplying a property that is already defined as an input, the input value will be used.

Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Currency Code

The currency code for the sales order.

USD
Debug Request

Enabling this flag will log out the current request.

false
Discount Amount

The discount amount.

0.10
Order Date

The order date.

2022-01-01
Pay To Vendor ID

The unique ID of the vendor to pay to.

00000000-0000-0000-0000-000000000000
Pay To Vendor Number

Specifies the number of the vendor to pay to.

10000
Purchase Order ID

The ID of the purchase order to update.

00000000-0000-0000-0000-000000000000
Purchaser

The purchaser in the purchase order.

John Doe
Ship To Address Line 1

The first line of the ship to address.

123 Main St
Ship To Name

The name of the ship to customer.

John Doe
Vendor Number

Specifies vendor's number.

10000

{
  "data": {
    "id": "5d115c9c-44e3-ea11-bb43-000d3a2feca1",
    "number": "108001",
    "orderDate": "2021-01-01T00:00:00.000Z",
    "postingDate": "2021-01-01T00:00:00.000Z",
    "dueDate": "2021-01-01T00:00:00.000Z",
    "vendorId": "",
    "vendorNumber": "20000",
    "vendorName": "First Up Consultants",
    "payToName": "First Up Consultants",
    "payToVendorId": "Evan McIntosh",
    "payToVendorNumber": "20000",
    "shipToName": "First Up Consultants",
    "shipToContact": "Evan McIntosh",
    "buyFromAddressLine1": "100 Day Drive",
    "buyFromAddressLine2": "",
    "buyFromCity": "Chicago",
    "buyFromCountry": "US",
    "buyFromState": "IL",
    "buyFromPostCode": "61236",
    "shipToAddressLine1": "100 Day Drive",
    "shipToAddressLine2": "",
    "shipToCity": "Chicago",
    "shipToCountry": "US",
    "shipToState": "IL",
    "shipToPostCode": "61236",
    "payToAddressLine1": "100 Day Drive",
    "payToAddressLine2": "",
    "payToCity": "Chicago",
    "payToCountry": "US",
    "payToState": "IL",
    "payToPostCode": "61236",
    "currencyId": "00000000-0000-0000-0000-000000000000",
    "currencyCode": "USD",
    "pricesIncludeTax": false,
    "paymentTermsId": "04a5738a-44e3-ea11-bb43-000d3a2feca1",
    "shipmentMethodId": "93f5638a-55e3-jk22-aa32-211d3a2fdce5",
    "purchaser": "First Up Consultants",
    "requestedReceiptDate": "2021-01-01T00:00:00.000Z",
    "discountAmount": 0,
    "discountAppliedBeforeTax": false,
    "totalAmountExcludingTax": 0,
    "totalTaxAmount": 0,
    "totalAmountIncludingTax": 0,
    "fullyReceived": false,
    "status": "Draft",
    "lastModifiedDateTime": "2021-01-01T00:26:53.793Z",
    "shortcutDimension1Code": "",
    "shortcutDimension2Code": ""
  }
}

Update Purchase Order Line​

Updates a purchase order line object in your Business Central organization. | key: updatePurchaseOrderLine

InputNotesExample
Account ID

The id of the account that the purchase order line is related to.

00000000-0000-0000-0000-000000000000
Additional Properties

Additional properties to include in the request body. In case of supplying a property that is already defined as an input, the input value will be used.

Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false
Description

Specifies the description of the purchase order line.

ATLANTA Whiteboard, base
Direct Unit Cost

The direct cost per unit.

1397.3
Document ID

The ID of the parent purchase order line.

00000000-0000-0000-0000-000000000000
Item ID

The ID of the item in the purchase order line.

00000000-0000-0000-0000-000000000000
Line Object Number

The number of the object (account or item) of the purchase order line.

1996-S
Line Type

The type of the purchase order line.

Item
Purchase Order Line ID

The ID of the purchase order line to update.

00000000-0000-0000-0000-000000000000
Quantity

The quantity of the item in the purchase order line.

12

{
  "data": {
    "id": "1e8cb9c0-44e3-ea11-bb43-000d3a2feca1",
    "documentId": "960f5c9c-44e3-ea11-bb43-000d3a2feca1",
    "sequence": 10000,
    "itemId": "0ea6738a-44e3-ea11-bb43-000d3a2feca1",
    "accountId": "93f5638a-55e3-jk22-aa32-211d3a2fdce5",
    "lineType": "Item",
    "lineObjectNumber": "1996-S",
    "description": "ATLANTA Whiteboard, base",
    "unitOfMeasureId": "5ca6738a-44e3-ea11-bb43-000d3a2feca1",
    "unitOfMeasureCode": "PCS",
    "quantity": 12,
    "directUnitCost": 1397.3,
    "discountAmount": 0,
    "discountPercent": 0,
    "discountAppliedBeforeTax": false,
    "amountExcludingTax": 16767.6,
    "taxCode": "FURNITURE",
    "taxPercent": 6.00002,
    "totalTaxAmount": 1006.06,
    "amountIncludingTax": 17773.66,
    "invoiceDiscountAllocation": 0,
    "netAmount": 16767.6,
    "netTaxAmount": 1006.06,
    "netAmountIncludingTax": 17773.66,
    "expectedReceiptDate": "2020-04-02T00:00:00.000Z",
    "receivedQuantity": 0,
    "invoicedQuantity": 0,
    "invoiceQuantity": 12,
    "receiveQuantity": 12,
    "itemVariantId": "00000000-0000-0000-0000-000000000000",
    "locationId": "00000000-0000-0000-0000-000000000000"
  }
}

Update Sales Invoice​

Updates a sales invoice object in your Business Central organization. | key: updateSalesInvoice

InputNotesExample
Additional Properties

Additional properties to include in the request body. In case of supplying a property that is already defined as an input, the input value will be used.

Bill To Customer ID

The customer ID for the invoice to the customer

12345
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Currency Code

The currency code for the sales invoice

USD
Customer ID

The unique identifier of the customer.

8ba01a7a-5734-ef11-8409-7c1e5213ec0e
Customer Number

The customer number for the sales invoice

10000
Debug Request

Enabling this flag will log out the current request.

false
Customer Email Address

The email address for the sales invoice

robert.jr@sample.cm
Sales Invoice ID

The unique identifier of the sales invoice object.

0ba5738a-44e3-ea11-bb43-000d3a2feca1
Sell To Address Line 1

The first line of the sell to address

123 Main St
Ship To Address Line 1

The first line of the ship to address

123 Main St
Ship To Name

The name of the ship to customer

John Doe

{
  "data": {
    "id": "b353895e-5635-ef11-8409-6045bdfedf9a",
    "number": "PS-INV103001",
    "externalDocumentNumber": "",
    "invoiceDate": "2019-01-15",
    "postingDate": "2019-01-15",
    "dueDate": "2019-01-15",
    "customerPurchaseOrderReference": "",
    "customerId": "f3a5738a-44e3-ea11-bb43-000d3a2feca1",
    "customerNumber": "20000",
    "customerName": "Trey Research",
    "billToCustomerId": "f3a5738a-44e3-ea11-bb43-000d3a2feca1",
    "billToCustomerNumber": "20000",
    "shipToName": "Trey Research",
    "shipToContact": "Helen Ray",
    "sellToAddressLine1": "153 Thomas Drive",
    "sellToAddressLine2": "",
    "sellToCity": "Chicago",
    "sellToCountry": "US",
    "sellToState": "IL",
    "sellToPostCode": "61236",
    "shipToAddressLine1": "153 Thomas Drive",
    "shipToAddressLine2": "",
    "shipToCity": "Chicago",
    "shipToCountry": "US",
    "shipToState": "IL",
    "shipToPostCode": "61236",
    "currencyId": "00000000-0000-0000-0000-000000000000",
    "currencyCode": "USD",
    "paymentTermsId": "0ba5738a-44e3-ea11-bb43-000d3a2feca1",
    "shipmentMethodId": "00000000-0000-0000-0000-000000000000",
    "salesperson": "PS",
    "discountAmount": 0,
    "phoneNumber": "",
    "email": "helen.ray@contoso.com"
  }
}

Update Sales Order​

Updates a sales order object in your Business Central organization. | key: updateSalesOrder

InputNotesExample
Additional Properties

Additional properties to include in the request body. In case of supplying a property that is already defined as an input, the input value will be used.

Bill To Customer ID

The customer ID for the bill to customer.

12345
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Currency Code

The currency code for the sales order.

USD
Customer ID

The unique identifier of the customer.

8ba01a7a-5734-ef11-8409-7c1e5213ec0e
Customer Number

The customer number for the sales order.

10000
Debug Request

Enabling this flag will log out the current request.

false
Customer Email Address

The email address for the sales order.

robert.jr@sample.cm
Sales Order ID

The unique identifier of the sales order.

f1678e37-e50b-ef11-9f8e-6045bdc8c192
Sell To Address Line 1

The first line of the sell to address.

123 Main St
Ship To Address Line 1

The first line of the ship to address.

123 Main St
Ship To Name

The name of the ship to customer.

John Doe

{
  "data": {
    "id": "54a53ee8-3835-ef11-840b-00224820d4a6",
    "number": "S-ORD101010",
    "externalDocumentNumber": "",
    "orderDate": "2023-09-01",
    "postingDate": "2023-09-02",
    "customerId": "7e57e220-e60b-ef11-9f8e-6045bdc8c192",
    "customerNumber": "10000",
    "customerName": "Adatum Corporation",
    "billToName": "Adatum Corporation",
    "billToCustomerId": "7e57e220-e60b-ef11-9f8e-6045bdc8c192",
    "billToCustomerNumber": "10000",
    "shipToName": "Adatum Corporation",
    "shipToContact": "Robert Townes",
    "sellToAddressLine1": "Station Road, 21",
    "sellToAddressLine2": "",
    "sellToCity": "Georgia",
    "sellToCountry": "US",
    "sellToState": "GA",
    "sellToPostCode": "31772",
    "billToAddressLine1": "Station Road, 21",
    "billToAddressLine2": "",
    "billToCity": "Georgia",
    "billToCountry": "US",
    "billToState": "GA",
    "billToPostCode": "31772",
    "shipToAddressLine1": "Station Road, 21",
    "shipToAddressLine2": "",
    "shipToCity": "Georgia",
    "shipToCountry": "US",
    "shipToState": "GA",
    "shipToPostCode": "31772",
    "shortcutDimension1Code": "",
    "shortcutDimension2Code": "MEDIUM",
    "currencyId": "00000000-0000-0000-0000-000000000000",
    "currencyCode": "USD",
    "pricesIncludeTax": false,
    "paymentTermsId": "7e55e220-e60b-ef11-9f8e-6045bdc8c192",
    "shipmentMethodId": "0756e220-e60b-ef11-9f8e-6045bdc8c192",
    "salesperson": "JO",
    "partialShipping": true,
    "requestedDeliveryDate": "0001-01-01",
    "discountAmount": 0,
    "discountAppliedBeforeTax": false,
    "totalAmountExcludingTax": 0,
    "totalTaxAmount": 0,
    "totalAmountIncludingTax": 0,
    "fullyShipped": false,
    "status": "Draft",
    "lastModifiedDateTime": "2024-06-28T10:26:43.957Z",
    "phoneNumber": "",
    "email": "robert.townes@contoso.com"
  }
}

Update Shipment Method​

Update a shipment method object in your Business Central organization. | key: updateShipmentMethod

InputNotesExample
Company ID

The ID of the company you want to interact with.

00000000-0000-0000-0000-000000000000
Connection
Debug Request

Enabling this flag will log out the current request.

false
Shipment CodeUPS
Shipment Method Id

Specifies the shipment method used by the customer.

00000000-0000-0000-0000-000000000000
Shipment Method NameFedex

{
  "data": {
    "id": "be90f4f2-1735-ef11-8409-6045bdfedf9a",
    "code": "TEST",
    "displayName": "test",
    "lastModifiedDateTime": "2024-06-28T06:30:46.263Z"
  }
}

Changelog​

2025-10-17​

Enhanced webhook lifecycle management with improved trigger subscription handling and automated cleanup.