Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/CodexaCP/DG_BACK/llms.txt

Use this file to discover all available pages before exploring further.

The Business Central Native Execution API (/api/integration/businesscentral-native or /api/v1/integration/businesscentral-native) provides read access to data fetched live from a connected Microsoft Dynamics 365 Business Central instance. All endpoints are available exclusively to tenants with IntegrationMode = BusinessCentralNative and authenticate via X-Api-Key. The response envelope wraps the remote BC payload with Dragon Guard metadata including correlation ID and provider name.
All endpoints on this page require X-Api-Key authentication and the tenant must have IntegrationMode = BusinessCentralNative. Requests from other tenant types receive 409 Conflict.

GET /api/v1/integration/businesscentral-native/items

Fetches the current item catalog from the connected Business Central instance. Any query parameters supplied are forwarded to the BC OData/API adapter without modification (e.g., $filter, $top, $skip). Authentication: X-Api-Key: <api-key> (required).
success
boolean
Whether the BC call succeeded.
companyCode
string
Dragon Guard tenant company code.
providerName
string
Always BusinessCentralNative.
correlationId
string
Request correlation ID for tracing.
data
object
Business Central resource collection response.
Error codes
StatusCodeMeaning
409ConflictTenant is not configured for BusinessCentralNative.
501Not ImplementedBC adapter endpoint not configured for this resource.
502Bad GatewayBusiness Central returned an error or was unreachable. Response includes remoteHttpStatusCode and retryable flag.
curl -X GET "https://api.example.com/api/v1/integration/businesscentral-native/items" \
  -H "X-Api-Key: your-api-key-here"

GET /api/v1/integration/businesscentral-native/receipts

Fetches purchase receipt documents from the connected Business Central instance. Returns open or posted purchase receipts depending on BC configuration. Query parameters are forwarded to BC without modification. Authentication: X-Api-Key: <api-key> (required).
success
boolean
Whether the call succeeded.
companyCode
string
Tenant company code.
providerName
string
Always BusinessCentralNative.
correlationId
string
Correlation ID.
data
object
BC receipts collection (same envelope as /items).
Error codes
StatusMeaning
502BC gateway error. Response includes remoteHttpStatusCode and retryable flag.
curl -X GET "https://api.example.com/api/v1/integration/businesscentral-native/receipts" \
  -H "X-Api-Key: your-api-key-here"

GET /api/v1/integration/businesscentral-native/shipments

Fetches sales shipment documents from Business Central. Query parameters forwarded to BC. Response follows the same envelope as /items. Authentication: X-Api-Key: <api-key> (required).
success
boolean
Whether the call succeeded.
companyCode
string
Tenant company code.
providerName
string
Always BusinessCentralNative.
correlationId
string
Correlation ID.
data
object
BC shipments collection.
Error codes
StatusMeaning
502BC returned an error. Inspect remoteHttpStatusCode and retryable in the error body.
curl -X GET "https://api.example.com/api/v1/integration/businesscentral-native/shipments" \
  -H "X-Api-Key: your-api-key-here"

GET /api/v1/integration/businesscentral-native/movements

Fetches inventory movement / journal records from Business Central. Query parameters forwarded to BC. Response follows the same envelope as /items. Authentication: X-Api-Key: <api-key> (required).
success
boolean
Whether the call succeeded.
companyCode
string
Tenant company code.
providerName
string
Always BusinessCentralNative.
correlationId
string
Correlation ID.
data
object
BC movements collection.
Error codes
StatusMeaning
501BC adapter does not support this resource for the tenant’s BC configuration.
502BC gateway error.
curl -X GET "https://api.example.com/api/v1/integration/businesscentral-native/movements" \
  -H "X-Api-Key: your-api-key-here"

Build docs developers (and LLMs) love