Skip to main content
ms-business-central icon

Microsoft Dynamics 365 Business Central Connector

SourceAPI DocsAPI ChangelogConnector Changelog

Description​

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

This component manages Sales Orders, Customers, Invoices, Vendors, and Shipments in Microsoft Dynamics 365 Business Central.

API Documentation​

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

Connections​

OAuth 2.0 Client Credentials​

key: businessCentralClientCredentials

The OAuth 2.0 Client Credentials flow allows applications to send requests to Business Central without user interaction. This requires creating an Application User in Business Central. For more information, refer to the Microsoft Business Central OAuth Documentation.

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

Prerequisites​

  • A Microsoft Azure account with administrator access
  • Access to the Power Platform admin center

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

Configure API Permissions​

  1. Under API permissions click + Add a permission
  2. Select Business Central
  3. Check the following permissions:
    • user_impersonation
    • offline_access
    • Financials.ReadWrite.All
  4. Click Add permissions
  5. Click Grant admin consent for (organization name)

Create a Client Secret​

  1. Under Certificates & secrets click + New client secret
  2. Provide a description and expiration date
  3. Take note of the Value (not the Secret ID) of the client secret

Retrieve the Client ID and Token Endpoint​

  1. Return to the Overview page and take note of the Application (client) ID
  2. Click Endpoints and take note of the OAuth 2.0 token endpoint (v2)

Add the App as an Application User in Business Central​

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

Configure the Connection​

Create a connection of type OAuth 2.0 Client Credentials and enter:

  • Web API URL: The Business Central API URL in the format https://api.businesscentral.dynamics.com/v2.0/<TENANT_DOMAIN>/<ENVIRONMENT>
  • Token URL: The OAuth 2.0 token endpoint (v2) from Azure
  • Scopes: Use https://api.businesscentral.dynamics.com/.default
  • Client ID: The Application (client) ID from the Azure app registration
  • Client Secret: The secret value created above
InputNotesExample
Client ID

The Client ID generated when you register an app in Azure Portal. Found in App registrations > Overview.

12345678-1234-1234-1234-123456789abc
Client Secret Value

The Client Secret value from Azure Portal. Found in App registrations > Certificates & secrets.

Scopes

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

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

The OAuth 2.0 Token URL. Found in Azure Portal > App registrations > 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 Authorization Code​

key: businessCentralOauth2

The OAuth 2.0 Authorization Code flow allows users to grant permission for integrations to interact with Business Central on their behalf. For more information, refer to the Microsoft Business Central OAuth Documentation.

Prerequisites​

  • A Microsoft Azure account with administrator access
  • Access to the Azure Portal

Register an Application in Azure​

  1. Log in to Azure Portal
  2. Select App registrations
  3. Click + New registration
    • Supported account types should be Multi-tenant for customers authenticating with their own Business Central instance, or Single-tenant for authenticating with a specific Business Central instance
    • Under Redirect URI enter https://oauth2.prismatic.io/callback
    • Click Register

Configure API Permissions​

  1. Under API permissions click + Add a permission
  2. Select Business Central
  3. Check the following permissions:
    • user_impersonation
    • offline_access
    • Financials.ReadWrite.All
  4. Click Add permissions

Create a Client Secret​

  1. Under Certificates & secrets click + New client secret
  2. Provide a description and expiration date
  3. Take note of the Value (not the Secret ID) of the client secret

Retrieve the Client ID​

  1. Return to the Overview page
  2. Take note of the Application (client) ID

Configure the Connection​

Create a connection of type OAuth 2.0 Authorization Code and enter:

  • Web API URL: The Business Central API URL in the format https://api.businesscentral.dynamics.com/v2.0/<TENANT_DOMAIN>/<ENVIRONMENT>
  • Scopes: Use https://api.businesscentral.dynamics.com/.default offline_access
  • Client ID: The Application (client) ID from the Azure app registration
  • Client Secret: The secret value created 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

The Client ID from your Azure AD application registration. Found in Azure Portal > App registrations > Overview.

12345678-1234-1234-1234-123456789abc
Client Secret

The Client Secret from your Azure AD application registration. Found in Azure Portal > App registrations > Certificates & secrets.

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​

Managed Subscription Events​

Automatically registers and manages webhook subscriptions for resource changes in Business Central. | key: webhook

InputNotesExample
Connection

The Microsoft Business Central connection to use.

Resource

Resource to subscribe to.

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

The Microsoft Dynamics 365 Business Central Webhook trigger receives notifications when resources change in Business Central. Subscriptions are automatically created when the instance is deployed and removed when the instance is disabled.

How It Works​

This trigger uses Microsoft Business Central's webhook subscription API to receive real-time notifications when specified resources are created, updated, or deleted.

Automatic Lifecycle Management​

  • On Instance Deploy: A webhook subscription is automatically created in Business Central pointing to the instance's endpoint
  • On Instance Deletion: The webhook subscription is automatically removed from Business Central
Subscription Expiration

Business Central webhook subscriptions expire after approximately 3 days. The trigger automatically handles subscription renewal to ensure continuous operation.

URL Validation​

Business Central validates webhook endpoints by sending a validation request with a validationToken query parameter. The trigger automatically handles this validation by returning the token in the response.

Branching​

This trigger uses branching to separate validation requests from actual notifications:

  • URL Validation: Handles initial webhook validation requests from Business Central
  • Notification: Processes actual change notifications for the subscribed resource

Event Types​

The following resources can be monitored for changes:

Supported Resources
ResourcePathEvents
Customers/api/v1.0/companies({companyId})/customersCreated, Updated, Deleted
Sales Orders/api/v1.0/companies({companyId})/salesOrdersCreated, Updated, Deleted
Items/api/v1.0/companies({companyId})/itemsCreated, Updated, Deleted
Vendors/api/v1.0/companies({companyId})/vendorsCreated, Updated, Deleted
Purchase Orders/api/v1.0/companies({companyId})/purchaseOrdersCreated, Updated, Deleted
Sales Invoices/api/v1.0/companies({companyId})/salesInvoicesCreated, Updated, Deleted

Replace {companyId} with the actual company GUID.

Configuration​

Specify the Business Central resource to subscribe to in the Resource input. The resource path should include the API version, company ID, and entity type.

Returned Data​

Example Payload

When a resource changes, Business Central sends a notification with the following structure:

{
"value": [
{
"subscriptionId": "ba1cba0177854a6091865452e017742b",
"clientState": "",
"changeType": "updated",
"resource": "/api/v1.0/companies(5d115c9c-44e3-ea11-bb43-000d3a2feca1)/customers(7d577253-3ef0-4a0a-bb7f-8335c2596e70)",
"lastModifiedDateTime": "2024-01-15T10:30:00Z"
}
]
}
  • Create Event Subscription - Manually create a webhook subscription
  • Delete All Instance Subscriptions - Remove all subscriptions for this instance

Manual Webhook​

Receive and validate webhook requests from Business Central for manually configured webhooks. | key: webhookReceiver


New and Updated Records​

Checks for new and updated records of a Microsoft Dynamics 365 Business Central entity on a configured schedule. | key: pollChangesTrigger

InputNotesExample
Additional Filter

Optional OData filter to combine (AND) with the modification-time filter applied by the trigger.

type eq 'Inventory'
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Resource Type

The Business Central entity to poll for changes.

Show Updated Records

When enabled, records modified after the last poll are included in the trigger output.

true
Example Payload for New and Updated Records⤓
Loading…

Data Sources​

Select Account​

A picklist of accounts in your Business Central organization. | key: selectAccount | type: picklist

InputNotesExample
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Example Payload for Select Account⤓
Loading…

Select Companies​

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

InputNotesExample
Connection

The Microsoft Business Central connection to use.

Example Payload for Select Companies⤓
Loading…

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Example Payload for Select Customers⤓
Loading…

Select General Ledger Entry​

A picklist of general ledger entries in your Business Central organization. | key: selectGeneralLedgerEntry | type: picklist

InputNotesExample
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Example Payload for Select General Ledger Entry⤓
Loading…

Select Item Ledger Entry​

A picklist of item ledger entries in your Business Central organization. | key: selectItemLedgerEntry | type: picklist

InputNotesExample
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Example Payload for Select Item Ledger Entry⤓
Loading…

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Example Payload for Select Items⤓
Loading…

Select Purchase Invoice​

A picklist of purchase invoices in your Business Central organization. | key: selectPurchaseInvoice | type: picklist

InputNotesExample
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Example Payload for Select Purchase Invoice⤓
Loading…

Select Purchase Order​

A picklist of purchase orders in your Business Central organization. | key: selectPurchaseOrder | type: picklist

InputNotesExample
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Example Payload for Select Purchase Order⤓
Loading…

Select Purchase Order Line​

A picklist of purchase order lines for the selected purchase order. | key: selectPurchaseOrderLine | type: picklist

InputNotesExample
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Purchase Order ID

The unique ID of the purchase order.

00000000-0000-0000-0000-000000000000
Example Payload for Select Purchase Order Line⤓
Loading…

Select Purchase Receipt​

A picklist of purchase receipts in your Business Central organization. | key: selectPurchaseReceipt | type: picklist

InputNotesExample
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Example Payload for Select Purchase Receipt⤓
Loading…

Select Purchase Receipt Line​

A picklist of purchase receipt lines in your Business Central organization. | key: selectPurchaseReceiptLine | type: picklist

InputNotesExample
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Example Payload for Select Purchase Receipt Line⤓
Loading…

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Example Payload for Select Sales Invoices⤓
Loading…

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Example Payload for Select Sales Orders⤓
Loading…

Select Sales Shipment Line​

A picklist of sales shipment line items in your Business Central organization. | key: selectSalesShipmentLine | type: picklist

InputNotesExample
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Example Payload for Select Sales Shipment Line⤓
Loading…

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Example Payload for Select Sales Shipments⤓
Loading…

Select Subscription​

A picklist of subscriptions in your Business Central organization. | key: selectSubscription | type: picklist

InputNotesExample
Connection

The Microsoft Business Central connection to use.

Example Payload for Select Subscription⤓
Loading…

Select Vendor​

A picklist of vendors in your Business Central organization. | key: selectVendor | type: picklist

InputNotesExample
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Example Payload for Select Vendor⤓
Loading…

Actions​

Create Attachment​

Create a new attachment | key: createAttachment

InputNotesExample
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

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
Example Payload for Create Attachment⤓
Loading…

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.

Suite 200
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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
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

When true, the customer is liable for sales tax.

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.example.com
Example Payload for Create Customer⤓
Loading…

Create Event Subscription​

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

InputNotesExample
Allow Duplicates

When true, allows more than one webhook per endpoint.

false
Connection

The Microsoft Business Central connection to use.

Notification URL

URL to send events of this Subscription to.

https://hooks.example.com/trigger/abc123
Resource

Resource to subscribe to.

/api/v1.0/companies(f64eba74-dacd-4854-a584-1834f68cfc3a)/customers
Example Payload for Create Event Subscription⤓
Loading…

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Display Name

The display name of the item.

ATHENS Desk
Number

The number of the item.

1896-S
Example Payload for Create Item⤓
Loading…

Create Purchase Invoice​

Creates a purchase invoice object in Microsoft Business Central. | key: createPurchaseInvoice

InputNotesExample
Buy From Address

Buy-from street, city, state, postal code, and country.

Company ID

The ID of the company you want to create the purchase invoice in.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Currency Code

The currency code.

USD
Currency ID

The unique identifier of the currency.

00000000-0000-0000-0000-000000000000
Discount Amount

The discount amount for the invoice.

0
Due Date

The due date of the invoice.

2024-02-15
Invoice Date

The date of the invoice.

2024-01-15
Pay To Vendor ID

The unique identifier of the vendor to pay to.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Pay To Vendor Number

Specifies the number of the vendor to pay to.

20000
Posting Date

The posting date of the invoice.

2024-01-15
Prices Include Tax

Specifies if prices include tax.

false
Ship To Contact

The contact name for the ship-to address.

John Doe
Ship To Name

The name for the ship-to address.

My Company
Vendor ID

The unique identifier of the vendor for this invoice.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Vendor Invoice Number

The vendor's invoice number.

INV-001
Vendor Number

Specifies the vendor's number.

20000
Example Payload for Create Purchase Invoice⤓
Loading…

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.

{
  "buyFromAddressLine1": "100 Day Drive",
  "buyFromAddressLine2": "",
  "buyFromCity": "Chicago",
  "buyFromCountry": "US",
  "buyFromState": "IL",
  "buyFromPostCode": "61236"
}
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Currency Code

The currency code for the sales order.

USD
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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
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
Example Payload for Create Purchase Order⤓
Loading…

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
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.

{
  "itemVariantId": "00000000-0000-0000-0000-000000000000",
  "locationId": "00000000-0000-0000-0000-000000000000"
}
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Item ID

The ID of the item in the purchase order line.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
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
Example Payload for Create Purchase Order Line⤓
Loading…

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.

{
  "invoiceDate": "2024-03-02",
  "postingDate": "2024-03-02",
  "salesperson": "PS",
  "phoneNumber": "555-555-5555"
}
Bill To Customer ID

The customer ID for the invoice to the customer.

7e57e220-e60b-ef11-9f8e-6045bdc8c192
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

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
Customer Email Address

The email address for the sales invoice.

robert.townes@contoso.com
Sell To Address Line 1

The first line of the sell to address.

192 Market Square
Ship To Address Line 1

The first line of the ship to address.

192 Market Square
Ship To Name

The name of the ship to customer.

Adatum Corporation
Example Payload for Create Sales Invoice⤓
Loading…

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.

{
  "orderDate": "2024-03-02",
  "postingDate": "2024-03-02",
  "pricesIncludeTax": false
}
Bill To Customer ID

The customer ID for the bill to customer.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

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
Customer Email Address

The email address for the sales order.

robert.jr@example.com
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
Example Payload for Create Sales Order⤓
Loading…

Create Shipment Method​

Create a new shipment method | key: createShipmentMethod

InputNotesExample
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Shipment Code

The unique code for the shipment method.

UPS-GND
Shipment Method Name

The display name for the shipment method.

UPS Ground
Example Payload for Create Shipment Method⤓
Loading…

Create Vendor​

Creates a vendor object in Microsoft Business Central. | key: createVendor

InputNotesExample
Address

Street, city, state, postal code, and country.

Blocked

Specifies which transactions with the vendor cannot be posted. It can be empty, 'Payment', or 'All'.

Payment
Company ID

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

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Contact Information

Email, phone, and other contact channel details.

Currency Code

Specifies the currency code used by the vendor.

USD
Currency ID

Specifies the currency used by the vendor.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Display Name

Specifies the vendor's name.

First Up Consultants
IRS 1099 Code

Specifies the IRS 1099 code for the vendor.

Payment Method ID

Specifies the payment method used by the vendor.

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

Specifies the payment terms used by the vendor.

04a5738a-44e3-ea11-bb43-000d3a2feca1
Tax Liable

When true, the vendor is liable for sales tax.

false
Tax Registration Number

Specifies the vendor's tax registration number.

Example Payload for Create Vendor⤓
Loading…

Delete All Instance Subscriptions​

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

InputNotesExample
Connection

The Microsoft Business Central connection to use.

Example Payload for Delete All Instance Subscriptions⤓
Loading…

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Example Payload for Delete Attachment⤓
Loading…

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Customer ID

The unique identifier of the customer.

8ba01a7a-5734-ef11-8409-7c1e5213ec0e
Example Payload for Delete Customer⤓
Loading…

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Item Id

The id of the item.

e21a6a90-44e3-ea11-bb43-000d3a2feca1
Example Payload for Delete Item⤓
Loading…

Delete Purchase Invoice​

Deletes a purchase invoice object in your Business Central organization. | key: deletePurchaseInvoice

InputNotesExample
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Purchase Invoice ID

The unique identifier of the purchase invoice.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Example Payload for Delete Purchase Invoice⤓
Loading…

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Purchase Order ID

The unique ID of the purchase order to delete.

00000000-0000-0000-0000-000000000000
Example Payload for Delete Purchase Order⤓
Loading…

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Purchase Order Line ID

The unique ID of the purchase order line to delete.

00000000-0000-0000-0000-000000000000
Example Payload for Delete Purchase Order Line⤓
Loading…

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Sales Invoice ID

The unique identifier of the sales invoice object.

0ba5738a-44e3-ea11-bb43-000d3a2feca1
Example Payload for Delete Sales Invoice⤓
Loading…

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Sales Order ID

The unique identifier of the sales order.

f1678e37-e50b-ef11-9f8e-6045bdc8c192
Example Payload for Delete Sales Order⤓
Loading…

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Shipment Method Id

Specifies the shipment method used by the customer.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Example Payload for Delete Shipment Method⤓
Loading…

Delete Subscription​

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

InputNotesExample
Connection

The Microsoft Business Central connection to use.

Etag

Etag value for the subscription to delete.

W/"JzEtNjM3NjQwMzUwMDAwMDAwMCc="
Subscription ID

Subscription ID to manage.

7d577253-3ef0-4a0a-bb7f-8335c2596e70
Example Payload for Delete Subscription⤓
Loading…

Delete Vendor​

Deletes a vendor object in your Business Central organization. | key: deleteVendor

InputNotesExample
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Vendor ID

The unique identifier of the vendor.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Example Payload for Delete Vendor⤓
Loading…

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Example Payload for Get Account⤓
Loading…

Get Attachment​

Gets an attachment object | key: getAttachment

InputNotesExample
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

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
Example Payload for Get Attachment⤓
Loading…

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Example Payload for Get Company Information⤓
Loading…

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Customer ID

The unique identifier of the customer.

8ba01a7a-5734-ef11-8409-7c1e5213ec0e
Example Payload for Get Customer⤓
Loading…

Get General Ledger Entry​

Retrieve the properties and relationships of a general ledger entry object in your Business Central organization. | key: getGeneralLedgerEntry

InputNotesExample
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

General Ledger Entry ID

The unique identifier of the general ledger entry.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Example Payload for Get General Ledger Entry⤓
Loading…

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Item Id

The id of the item.

e21a6a90-44e3-ea11-bb43-000d3a2feca1
Example Payload for Get Item⤓
Loading…

Get Item Ledger Entry​

Retrieve the properties and relationships of an item ledger entry object in your Business Central organization. | key: getItemLedgerEntry

InputNotesExample
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Item Ledger Entry ID

The unique identifier of the item ledger entry.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Example Payload for Get Item Ledger Entry⤓
Loading…

Get Purchase Invoice​

Retrieve the properties and relationships of a purchase invoice object in your Business Central organization. | key: getPurchaseInvoice

InputNotesExample
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Purchase Invoice ID

The unique identifier of the purchase invoice.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Example Payload for Get Purchase Invoice⤓
Loading…

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Purchase Order ID

The unique ID of the purchase order to retrieve.

00000000-0000-0000-0000-000000000000
Example Payload for Get Purchase Order⤓
Loading…

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Purchase Order Line ID

The unique ID of the purchase order line to retrieve.

00000000-0000-0000-0000-000000000000
Example Payload for Get Purchase Order Line⤓
Loading…

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Purchase Receipt ID

The unique identifier of the purchase receipt.

00000000-0000-0000-0000-000000000000
Example Payload for Get Purchase Receipt⤓
Loading…

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Purchase Receipt Line ID

The unique identifier of the purchase receipt line.

00000000-0000-0000-0000-000000000000
Example Payload for Get Purchase Receipt Line⤓
Loading…

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Sales Invoice ID

The unique identifier of the sales invoice object.

0ba5738a-44e3-ea11-bb43-000d3a2feca1
Example Payload for Get Sales Invoice⤓
Loading…

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Sales Order ID

The unique identifier of the sales order.

f1678e37-e50b-ef11-9f8e-6045bdc8c192
Example Payload for Get Sales Order⤓
Loading…

Get Sales Shipment​

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

InputNotesExample
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Sale Shipment ID

The ID of the sale shipment you want to retrieve.

00000000-0000-0000-0000-000000000000
Example Payload for Get Sales Shipment⤓
Loading…

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Sales Shipment Line ID

The ID of the sales shipment line object.

be90f4f2-1735-ef11-8409-6045bdfedf9a
Example Payload for Get Sales Shipment Line Item⤓
Loading…

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Shipment Method Id

Specifies the shipment method used by the customer.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Example Payload for Get Shipment Method⤓
Loading…

Get Vendor​

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

InputNotesExample
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Vendor ID

The unique identifier of the vendor.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Example Payload for Get Vendor⤓
Loading…

List Accounts​

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

InputNotesExample
Count

When true, 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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Example Payload for List Accounts⤓
Loading…

List Companies​

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

InputNotesExample
Count

When true, 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

The Microsoft Business Central connection to use.

Fetch All

When enabled, automatically fetches all pages of results by following @odata.nextLink. Page Size, Skip, and Skip Token inputs are ignored when this is enabled.

false
Example Payload for List Companies⤓
Loading…

List Customers​

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

InputNotesExample
Count

When true, 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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Fetch All

When enabled, automatically fetches all pages of results by following @odata.nextLink. Page Size, Skip, and Skip Token inputs are ignored when this is enabled.

false
Example Payload for List Customers⤓
Loading…

List General Ledger Entries​

Retrieve all general ledger entries in your Business Central organization. | key: listGeneralLedgerEntries

InputNotesExample
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Fetch All

When enabled, automatically fetches all pages of results by following @odata.nextLink. Page Size, Skip, and Skip Token inputs are ignored when this is enabled.

false
OData Query Parameters

OData system query options for filtering, sorting, selecting, and expanding results.

Example Payload for List General Ledger Entries⤓
Loading…

List Item Ledger Entries​

Retrieve all item ledger entries in your Business Central organization. | key: listItemLedgerEntries

InputNotesExample
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Fetch All

When enabled, automatically fetches all pages of results by following @odata.nextLink. Page Size, Skip, and Skip Token inputs are ignored when this is enabled.

false
OData Query Parameters

OData system query options for filtering, sorting, selecting, and expanding results.

Example Payload for List Item Ledger Entries⤓
Loading…

List Items​

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

InputNotesExample
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Fetch All

When enabled, automatically fetches all pages of results by following @odata.nextLink. Page Size, Skip, and Skip Token inputs are ignored when this is enabled.

false
OData Query Parameters

OData system query options for filtering, sorting, selecting, and expanding results.


List Purchase Invoices​

Retrieve all purchase invoices in your Business Central organization. | key: listPurchaseInvoices

InputNotesExample
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Fetch All

When enabled, automatically fetches all pages of results by following @odata.nextLink. Page Size, Skip, and Skip Token inputs are ignored when this is enabled.

false
OData Query Parameters

OData system query options for filtering, sorting, selecting, and expanding results.

Example Payload for List Purchase Invoices⤓
Loading…

List Purchase Order Lines​

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

InputNotesExample
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Fetch All

When enabled, automatically fetches all pages of results by following @odata.nextLink. Page Size, Skip, and Skip Token inputs are ignored when this is enabled.

false
OData Query Parameters

OData system query options for filtering, sorting, selecting, and expanding results.

Purchase Order ID

The unique ID of the purchase order.

00000000-0000-0000-0000-000000000000
Example Payload for List Purchase Order Lines⤓
Loading…

List Purchase Orders​

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

InputNotesExample
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Fetch All

When enabled, automatically fetches all pages of results by following @odata.nextLink. Page Size, Skip, and Skip Token inputs are ignored when this is enabled.

false
OData Query Parameters

OData system query options for filtering, sorting, selecting, and expanding results.

Example Payload for List Purchase Orders⤓
Loading…

List Purchase Receipt Lines​

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

InputNotesExample
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Fetch All

When enabled, automatically fetches all pages of results by following @odata.nextLink. Page Size, Skip, and Skip Token inputs are ignored when this is enabled.

false
OData Query Parameters

OData system query options for filtering, sorting, selecting, and expanding results.

Example Payload for List Purchase Receipt Lines⤓
Loading…

List Purchase Receipts​

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

InputNotesExample
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Fetch All

When enabled, automatically fetches all pages of results by following @odata.nextLink. Page Size, Skip, and Skip Token inputs are ignored when this is enabled.

false
OData Query Parameters

OData system query options for filtering, sorting, selecting, and expanding results.

Example Payload for List Purchase Receipts⤓
Loading…

List Sales Invoices​

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

InputNotesExample
Count

When true, 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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Fetch All

When enabled, automatically fetches all pages of results by following @odata.nextLink. Page Size, Skip, and Skip Token inputs are ignored when this is enabled.

false
Example Payload for List Sales Invoices⤓
Loading…

List Sales Orders​

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

InputNotesExample
Count

When true, 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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Fetch All

When enabled, automatically fetches all pages of results by following @odata.nextLink. Page Size, Skip, and Skip Token inputs are ignored when this is enabled.

false
Example Payload for List Sales Orders⤓
Loading…

List Sales Shipment Line Items​

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

InputNotesExample
Count

When true, 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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Fetch All

When enabled, automatically fetches all pages of results by following @odata.nextLink. Page Size, Skip, and Skip Token inputs are ignored when this is enabled.

false
Example Payload for List Sales Shipment Line Items⤓
Loading…

List Sales Shipments​

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

InputNotesExample
Count

When true, 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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Fetch All

When enabled, automatically fetches all pages of results by following @odata.nextLink. Page Size, Skip, and Skip Token inputs are ignored when this is enabled.

false
Example Payload for List Sales Shipments⤓
Loading…

List Subscriptions​

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

InputNotesExample
Connection

The Microsoft Business Central connection to use.

Show Instance Webhooks

When true, shows only subscriptions for this Instance's webhooks.

false
Example Payload for List Subscriptions⤓
Loading…

List Vendors​

Retrieve all vendors in your Business Central organization. | key: listVendors

InputNotesExample
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Fetch All

When enabled, automatically fetches all pages of results by following @odata.nextLink. Page Size, Skip, and Skip Token inputs are ignored when this is enabled.

false
OData Query Parameters

OData system query options for filtering, sorting, selecting, and expanding results.

Example Payload for List Vendors⤓
Loading…

Post Purchase Invoice​

Posts a purchase invoice in your Business Central organization. This will finalize the invoice and create ledger entries. | key: postPurchaseInvoice

InputNotesExample
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Purchase Invoice ID

The unique identifier of the purchase invoice.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Example Payload for Post Purchase Invoice⤓
Loading…

Raw Request​

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

InputNotesExample
Connection

The Microsoft Business Central connection to use.

Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Example Payload for Update Attachment⤓
Loading…

Update Company Information​

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

InputNotesExample
Address

Street, city, state, postal code, and country.

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.
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
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
Tax Registration Number

The company's tax registration number.

f80b7995-6869-4958-ac60-25e4fcdeeada
Connection

The Microsoft Business Central connection to use.

Contact Information

Email, phone, and other contact channel details.

Example Payload for Update Company Information⤓
Loading…

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.

Suite 200
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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Customer ID

The unique identifier of the customer.

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

Specifies the type of customer.

Company
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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
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

When true, the customer is liable for sales tax.

Tax Registration Number

Specifies the customer's tax registration number.

Website

Specifies the customer's website.

www.example.com
Example Payload for Update Customer⤓
Loading…

Update Event Subscription​

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

InputNotesExample
Connection

The Microsoft Business Central connection to use.

Etag

Etag value for the subscription to delete.

W/"JzEtNjM3NjQwMzUwMDAwMDAwMCc="
Notification URL

URL to send events of this Subscription to.

https://hooks.example.com/trigger/abc123
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
Example Payload for Update Event Subscription⤓
Loading…

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

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
Example Payload for Update Item⤓
Loading…

Update Purchase Invoice​

Update a purchase invoice object in your Business Central organization. | key: updatePurchaseInvoice

InputNotesExample
Buy From Address

Buy-from street, city, state, postal code, and country.

Company ID

The ID of the company to which the purchase invoice belongs.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Currency Code

The currency code.

USD
Currency ID

The unique identifier of the currency.

00000000-0000-0000-0000-000000000000
Discount Amount

The discount amount for the invoice.

0
Due Date

The due date of the invoice.

2024-02-15
Invoice Date

The date of the invoice.

2024-01-15
Pay To Vendor ID

The unique identifier of the vendor to pay to.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Pay To Vendor Number

Specifies the number of the vendor to pay to.

20000
Posting Date

The posting date of the invoice.

2024-01-15
Prices Include Tax

Specifies if prices include tax.

Purchase Invoice ID

The unique identifier of the purchase invoice.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Ship To Contact

The contact name for the ship-to address.

John Doe
Ship To Name

The name for the ship-to address.

My Company
Vendor ID

The unique identifier of the vendor for this invoice.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Vendor Invoice Number

The vendor's invoice number.

INV-001
Vendor Number

Specifies the vendor's number.

20000
Example Payload for Update Purchase Invoice⤓
Loading…

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.

{
  "buyFromAddressLine1": "100 Day Drive",
  "buyFromAddressLine2": "",
  "buyFromCity": "Chicago",
  "buyFromCountry": "US",
  "buyFromState": "IL",
  "buyFromPostCode": "61236"
}
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Currency Code

The currency code for the sales order.

USD
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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
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
Example Payload for Update Purchase Order⤓
Loading…

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
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.

{
  "itemVariantId": "00000000-0000-0000-0000-000000000000",
  "locationId": "00000000-0000-0000-0000-000000000000"
}
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Item ID

The ID of the item in the purchase order line.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
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
Example Payload for Update Purchase Order Line⤓
Loading…

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.

{"invoiceDate":"2024-03-02","postingDate":"2024-03-02","salesperson":"PS","phoneNumber":"555-555-5555"}
Bill To Customer ID

The customer ID for the invoice to the customer.

7e57e220-e60b-ef11-9f8e-6045bdc8c192
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

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
Customer Email Address

The email address for the sales invoice.

robert.townes@contoso.com
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.

192 Market Square
Ship To Address Line 1

The first line of the ship to address.

192 Market Square
Ship To Name

The name of the ship to customer.

Adatum Corporation
Example Payload for Update Sales Invoice⤓
Loading…

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.

{"orderDate":"2024-03-02","postingDate":"2024-03-02","pricesIncludeTax":false}
Bill To Customer ID

The customer ID for the bill to customer.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Company ID

The ID of the company you want to interact with.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

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
Customer Email Address

The email address for the sales order.

robert.jr@example.com
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
Example Payload for Update Sales Order⤓
Loading…

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.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Shipment Code

The unique code for the shipment method.

UPS-GND
Shipment Method Id

Specifies the shipment method used by the customer.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Shipment Method Name

The display name for the shipment method.

UPS Ground
Example Payload for Update Shipment Method⤓
Loading…

Update Vendor​

Update a vendor object in your Business Central organization. | key: updateVendor

InputNotesExample
Address

Street, city, state, postal code, and country.

Blocked

Specifies which transactions with the vendor cannot be posted. It can be empty, 'Payment', or 'All'.

Payment
Company ID

The ID of the company to which the vendor belongs.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Connection

The Microsoft Business Central connection to use.

Contact Information

Email, phone, and other contact channel details.

Currency Code

Specifies the currency code used by the vendor.

USD
Currency ID

Specifies the currency used by the vendor.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Display Name

Specifies the vendor's name.

First Up Consultants
IRS 1099 Code

Specifies the IRS 1099 code for the vendor.

Payment Method ID

Specifies the payment method used by the vendor.

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

Specifies the payment terms used by the vendor.

04a5738a-44e3-ea11-bb43-000d3a2feca1
Tax Liable

When true, the vendor is liable for sales tax.

Tax Registration Number

Specifies the vendor's tax registration number.

Vendor ID

The unique identifier of the vendor.

5d115c9c-44e3-ea11-bb43-000d3a2feca1
Example Payload for Update Vendor⤓
Loading…

Changelog​

2026-09-02​

Updated action inputs to group related fields into structured objects:

  • Updated the list actions (List Items, List Vendors, List Purchase Orders, List Purchase Order Lines, List Purchase Invoices, List Purchase Receipts, List Purchase Receipt Lines, List General Ledger Entries, and List Item Ledger Entries) to group their OData query options into an OData Query Parameters object; Fetch All remains a top-level toggle
  • Updated Create Purchase Invoice and Update Purchase Invoice to group their buy-from address fields into a Buy From Address object
  • Updated Create Vendor, Update Vendor, and Update Company Information to group their address and contact fields into Address and Contact Information objects

2026-07-27​

Updated the Fetch All option on list actions so results are returned in the same { value: [ ... ] } shape as a single-page call; previously enabling Fetch All returned a bare array, so integrations that read the value property received no items

2026-06-11​

Added Fetch All toggle to all list actions (List Companies, List Customers, List Vendors, List Items, List Sales Orders, List Sales Invoices, List Sales Shipments, List Sales Shipment Line Items, List Purchase Orders, List Purchase Order Lines, List Purchase Invoices, List Purchase Receipts, List Purchase Receipt Lines, List General Ledger Entries, List Item Ledger Entries) that automatically follows @odata.nextLink pagination to retrieve all pages of results in a single call; when disabled, existing single-page behavior with Top, Skip, and Skip Token inputs is preserved

2026-05-28​

Added New and Updated Records polling trigger that checks for changes to a curated set of Business Central entities (Items, Customers, Vendors, Sales Orders, Sales Invoices, Sales Shipments, Purchase Orders, Purchase Invoices, Purchase Receipts, Accounts) via the lastModifiedDateTime OData filter; because Business Central does not expose a creation timestamp on list responses, all changed records are emitted in the updated bucket while the created bucket is preserved in the payload shape but always empty

2026-04-30​

Updated spectral version

2026-02-26​

Added inline data sources for vendors, accounts, purchase orders, purchase invoices, purchase order lines, purchase receipts, sales shipments, general ledger entries, item ledger entries, and subscriptions to enable dynamic dropdown selection

2026-02-04​

Added new actions for vendor and financial management:

  • Vendor actions: Create, Get, List, Update, and Delete vendors
  • Purchase Invoice actions: Create, Get, List, Update, Delete, and Post purchase invoices
  • General Ledger Entries actions: Get and List general ledger entries
  • Item Ledger Entries actions: Get and List item ledger entries

2025-10-17​

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