Sign in
< Back to Top

API-Related Info - D365 BC

This article contains the following information related to APIs.

  • Throttling Info
  • Handling Errors
  • Connector BP Task and Schema Reference

Throttling Information

To know more about the API limits for D365 BC endpoints please refer to https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/administration/operational-limits-online#Task

Handling Errors

In case the D365 BC Business Process (i.e. API call) is successful (returns status code between 200 & 300), the BP task will pass and return response payload (in Studio’s Admin Console perspective, in Auditor View the task is marked as completed) 

Or

In case the D365 BC Connector Business Process (API call) fails -any response status code not between 200 & 300  the BP task will fail without returning any response payload (in Studio’s Admin Console perspective, in Auditor View the task is marked as failed & error payload returned from D365 BC and stack trace are logged)

Or

In case D365 BC Connector BP (API call) execution fails (which can be an internal error such as payload parse issue) task will fail without returning any response payload (in Studio’s Admin Console perspective, in Auditor View the task is marked as failed & stack trace is logged)

Connector Business Process Task and Schema Reference

Note that the BP and Schema reflect the actual entities selected during the creation of the connector.

The entities listed below are from D365 BC 20.5 (Platform 20.0.45448.47469 + Application 20.5.45456.45681)

Several System Entities (but not all) that form the Order to Cash Flow are listed here: 

BP Schema D365 BC Entity Use Case
PostSalesOrder.bps
PostSalesOrderSubform.bps		 PostSalesOrderRequest.jsonSchema
PostSalesOrderResponse.jsonSchema
PostSalesOrderSubformRequest.jsonSchema
PostSalesOrderSubformResponse.jsonSchema		 SalesOrder
SalesOrderSubform(Sales Order Lines) 		 Creating a Sales Order and Sales Order Lines
  • Creating Sales Order Headers
  • Creating Sales Order Lines
PatchSalesOrder.bps
PatchSalesOrderSubform.bps		 PatchSalesOrderRequest.jsonSchema
PatchSalesOrderSubformRequest.jsonSchema		 SalesOrder
SalesOrderSubform(Sales Order Lines)		 Updating a Sales Order and Sales Order Lines
  • Updating Sales Order Headers
  • Updating Sales Order Lines
GetPostedSalesInvoice.bps
GetPostedSalesInvoices.bps
GetPostedSalesInvoiceSubform.bps
GetPostedSalesInvoicesSubform.bps		 GetPostedSalesInvoiceResponse.jsonSchema
GetPostedSalesInvoicesResponse.jsonSchema
GetPostedSalesInvoiceSubformResponse.jsonSchema
GetPostedSalesInvoicesSubformResponse.jsonSchema		 PostedSalesInvoice
PostedSalesInvoices
PostedSalesInvoiceSubform
PostedSalesInvoicesSubform

Retrieving the Sales Invoices and Sales Invoice lines

  • Retrieving the Sales order related invoices and its line item level details
GetPostedSalesShipment.bps
GetPostedSalesShipments.bps
GetPostedSalesShptSubform.bps		 GetPostedSalesShipmentResponse.jsonSchema
GetPostedSalesShipmentsResponse.jsonSchema
GetPostedSalesShptSubformResponse.jsonSchema		 PostedSalesShipment
PostedSalesShipments
PostedSalesShptSubform		 Retrieving Sales Shipment and Sales Shipment Lines
  • Retrieving the Sales Shipment and its line item level details
GetItemCard.bps GetItemCardResponse.jsonSchema ItemCard Retrieving Item
  • Retrieving the item details
PostItemCard.bps PostItemCardRequest.jsonSchema
PostItemCardResponse.jsonSchema		 ItemCard Creating an Item
  • Creating a new item
PatchItemCard.bps PatchtItemCardRequest.jsonSchema ItemCard Updating an Item
  • Updating item details
GetItemReferences.bps GetItemReferencesResponse.jsonSchema ItemReferences Retrieving Item Reference
  • Retrieving the item reference
PostItemReferences.bps PostItemReferencesRequest.jsonSchema
PostItemReferencesResponse.jsonSchema		 ItemReferences Creating an Item Reference
  • Creating a new item reference
PatchItemReferences.bps PatchtItemReferencesRequest.jsonSchema ItemReferences Updating an Item Reference
  • Updating item references
GetItemLedgerEntries.bps GetItemLedgerEntriesResponse.jsonSchema ItemLedgerEntries Retrieving Item Ledger Entries
  • Retrieving the item Ledger Entries

Related articles

Comments

0 comments

Please sign in to leave a comment.