Перейти к основному содержимому
API docs by Redocly

SMART EDI API (1.0.0)

Download OpenAPI specification:Download

License: SMART business LLC

REST API for the SMART EDI extension for Microsoft Dynamics 365 Business Central. The API exposes electronic document services, templates, outgoing and internal DocFlow documents, attachments, signers, and document actions used to upload, send, archive, and refresh document statuses.

Authentication

This API supports two authentication methods:

Security Scheme: BearerAuth

How to use:

  1. Obtain an OAuth 2.0 access token from Azure AD (see BearerAuth in Security Schemes for instructions)
  2. Click the "Authorize" button at the top of this documentation
  3. Paste your access token in the "Value" field
  4. Click "Authorize" - all requests will now include the token automatically

Token Format: Azure AD JWT token obtained via OAuth 2.0 client credentials flow

Works for:

  • ✅ Business Central SaaS (Cloud)
  • ✅ Business Central On-Premises (with Azure AD authentication)

📖 See BearerAuth in Security Schemes below for detailed step-by-step instructions on obtaining the token.

API Conventions

  • All endpoints follow OData v4 protocol standards
  • Supports standard OData query options: $filter, $select, $expand, $orderby, $top, $skip, $count, and $search
  • Date fields use ISO 8601 format (YYYY-MM-DD)
  • All timestamps include timezone information
  • API responses include ETag headers for optimistic concurrency control

OData Query Options

Collection endpoints support standard OData query options.

  • $filter filters records by field values
  • $orderby sorts returned records
  • $select limits the fields returned in the response
  • $expand includes related entities in the same response
  • $top limits the number of returned records
  • $skip skips the first N records
  • $count includes @odata.count in collection responses
  • $search applies free-text search where supported

For OData syntax details, see the OData v4.01 protocol specification: https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html

Quick Start

Step 1: Get Access Token

# Replace {tenant-id}, {client-id}, {client-secret} with your Azure AD credentials
curl -X POST "https://login.microsoftonline.com/{tenant-id}/oauth2/v2.0/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id={client-id}" \
  -d "client_secret={client-secret}" \
  -d "scope=https://api.businesscentral.dynamics.com/.default"

Step 2: Use Token in API Calls

For SaaS:

curl -H "Authorization: Bearer {access_token}" \
  "https://api.businesscentral.dynamics.com/v2.0/{tenant}/Production/api/smart/docflow/v1.0/companies({companyid})/docFlowDocuments"

For On-Premises:

curl -H "Authorization: Bearer {access_token}" \
  "https://bc-server:7048/BC230/api/smart/docflow/v1.0/companies({companyid})/docFlowDocuments"

Step 3: Use Swagger UI

For testing in this documentation:

  1. Get your access token using the curl command above
  2. Click "Authorize" button at the top
  3. Paste the token value (without "Bearer" prefix)
  4. Try any endpoint using "Try it out" button

docFlowDocuments

Outgoing electronic documents exchanged with an external DocFlow provider.

List outgoing DocFlow documents

Returns external electronic documents managed by SMART EDI, including provider status, counterparty details, and related entities when expanded.

Authorizations:
BearerAuth
query Parameters
$top
integer >= 0
Example: $top=50

Limits the number of returned items.

$skip
integer >= 0

Skips the first N returned items.

$search
string

Applies a free-text search expression.

$filter
string

Filters records by field values.

$count
boolean

Includes @odata.count in the response.

$orderby
Array of strings unique
Items Enum: "id" "id desc" "entryNumber" "entryNumber desc" "serviceCode" "serviceCode desc" "documentId" "documentId desc" "templateCode" "templateCode desc" "templateDescription" "templateDescription desc" "documentNumber" "documentNumber desc" "documentDate" "documentDate desc" "name" "name desc" "isSigned" "isSigned desc" "isViewed" "isViewed desc" "statusId" "statusId desc" "status" "status desc" "integrationState" "integrationState desc" "endingDate" "endingDate desc" "counterpartyCode" "counterpartyCode desc" "counterpartyName" "counterpartyName desc" "counterpartyGln" "counterpartyGln desc" "counterpartyEmail" "counterpartyEmail desc" "documentUrl" "documentUrl desc" "amount" "amount desc" "responsibilityCenter" "responsibilityCenter desc" "archived" "archived desc" "lastModifiedDateTime" "lastModifiedDateTime desc"

Sorts the returned records.

$select
Array of strings unique
Items Enum: "id" "entryNumber" "serviceCode" "documentId" "templateCode" "templateDescription" "documentNumber" "documentDate" "name" "isSigned" "isViewed" "statusId" "status" "integrationState" "endingDate" "counterpartyCode" "counterpartyName" "counterpartyGln" "counterpartyEmail" "documentUrl" "amount" "responsibilityCenter" "archived" "lastModifiedDateTime"

Limits the response to the selected properties.

$expand
Array of strings unique
Items Enum: "*" "docFlowService" "docFlowTemplate" "docFlowAttachments" "docFlowDocumentSigners"

Includes related entities in the same response.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 0,
  • "value": [
    ]
}

Get an outgoing DocFlow document

Returns a single outgoing electronic document identified by its Business Central SystemId.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the outgoing DocFlow document.

query Parameters
$select
Array of strings unique
Items Enum: "id" "entryNumber" "serviceCode" "documentId" "templateCode" "templateDescription" "documentNumber" "documentDate" "name" "isSigned" "isViewed" "statusId" "status" "integrationState" "endingDate" "counterpartyCode" "counterpartyName" "counterpartyGln" "counterpartyEmail" "documentUrl" "amount" "responsibilityCenter" "archived" "lastModifiedDateTime"

Limits the response to the selected properties.

$expand
Array of strings unique
Items Enum: "*" "docFlowService" "docFlowTemplate" "docFlowAttachments" "docFlowDocumentSigners"

Includes related entities in the same response.

Responses

Response samples

Content type
application/json
{
  • "id": "01234567-89ab-cdef-0123-456789abcdef",
  • "entryNumber": 0,
  • "serviceCode": "string",
  • "documentId": "string",
  • "templateCode": "string",
  • "templateDescription": "string",
  • "documentNumber": "string",
  • "documentDate": "2017-04-13",
  • "name": "string",
  • "isSigned": true,
  • "isViewed": true,
  • "statusId": 0,
  • "status": "string",
  • "integrationState": "Created",
  • "endingDate": "2017-04-13",
  • "counterpartyCode": "string",
  • "counterpartyName": "string",
  • "counterpartyGln": "string",
  • "counterpartyEmail": "string",
  • "documentUrl": "string",
  • "amount": 0,
  • "responsibilityCenter": "string",
  • "archived": true,
  • "lastModifiedDateTime": "2017-04-13T15:51:04Z",
  • "docFlowService": {
    },
  • "docFlowTemplate": {
    },
  • "docFlowAttachments": [
    ],
  • "docFlowAttachments@odata.count": 0,
  • "docFlowDocumentSigners": [
    ],
  • "docFlowDocumentSigners@odata.count": 0
}

Update an outgoing DocFlow document

Updates editable business fields of an outgoing DocFlow document during its processing lifecycle.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the outgoing DocFlow document.

Request Body schema: application/json
required

New property values

documentNumber
string or null <= 20 characters

Business document number shown to users and counterparties.

documentDate
string or null <date>
name
string or null <= 100 characters

Display name or title of the electronic document.

statusId
integer or null <int32>

Numeric provider status code stored on the document.

endingDate
string or null <date>
counterpartyCode
string or null <= 20 characters

Counterparty identifier, typically the EDRPOU code.

counterpartyName
string or null <= 100 characters
counterpartyGln
string or null <= 13 characters
counterpartyEmail
string or null <= 80 characters

Counterparty email address associated with the document flow.

number or string <decimal>

Monetary amount associated with the business document.

responsibilityCenter
string or null <= 10 characters

Responsibility center assigned to the document.

Responses

Request samples

Content type
application/json
{
  • "documentNumber": "string",
  • "documentDate": "2017-04-13",
  • "name": "string",
  • "statusId": 0,
  • "endingDate": "2017-04-13",
  • "counterpartyCode": "string",
  • "counterpartyName": "string",
  • "counterpartyGln": "string",
  • "counterpartyEmail": "string",
  • "amount": 0,
  • "responsibilityCenter": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete an outgoing DocFlow document

Deletes an outgoing DocFlow document record from SMART EDI.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the outgoing DocFlow document.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Mark an outgoing DocFlow document as accepted

Marks the specified outgoing electronic document as accepted in SMART EDI.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the outgoing DocFlow document.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Archive an outgoing DocFlow document

Archives the specified outgoing electronic document using the configured provider status mapping and archive rules.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the outgoing DocFlow document.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Send an outgoing DocFlow document

Sends the specified outgoing electronic document through the configured DocFlow provider.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the outgoing DocFlow document.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Refresh the status of an outgoing DocFlow document

Requests the latest provider status for the specified outgoing electronic document and updates local status fields.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the outgoing DocFlow document.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Upload an outgoing DocFlow document

Uploads the specified outgoing electronic document and its prepared payload to the configured DocFlow provider.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the outgoing DocFlow document.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

List attachments of an outgoing DocFlow document

Returns files attached to the specified outgoing electronic document, including printable forms, XML payloads, signatures, and archives.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the parent outgoing DocFlow document.

query Parameters
$top
integer >= 0
Example: $top=50

Limits the number of returned items.

$skip
integer >= 0

Skips the first N returned items.

$search
string

Applies a free-text search expression.

$filter
string

Filters records by field values.

$count
boolean

Includes @odata.count in the response.

$orderby
Array of strings unique
Items Enum: "id" "id desc" "docFlowNumber" "docFlowNumber desc" "docFlowId" "docFlowId desc" "lineNumber" "lineNumber desc" "name" "name desc" "fileExtension" "fileExtension desc" "type" "type desc" "mainAttachment" "mainAttachment desc" "defaultAttachment" "defaultAttachment desc" "attachmentId" "attachmentId desc" "base64FileContent" "base64FileContent desc" "lastModifiedDateTime" "lastModifiedDateTime desc"

Sorts the returned records.

$select
Array of strings unique
Items Enum: "id" "docFlowNumber" "docFlowId" "lineNumber" "name" "fileExtension" "type" "mainAttachment" "defaultAttachment" "attachmentId" "base64FileContent" "lastModifiedDateTime"

Limits the response to the selected properties.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 0,
  • "value": [
    ]
}

Create an attachment for an outgoing DocFlow document

Adds a new attachment to the specified outgoing electronic document using file metadata and base64-encoded content.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the parent outgoing DocFlow document.

Request Body schema: application/json
required

New entity

id
required
string <uuid>
docFlowNumber
integer or null <int32>
docFlowId
string or null <uuid>

Business Central SystemId of the parent DocFlow document.

lineNumber
integer or null <int32>
name
string or null <= 250 characters

File name of the attachment.

fileExtension
string or null <= 30 characters

File extension of the attachment content.

type
string or null (smaDocFlowAttachmentType)
Enum: "_x0020_" "PDF" "Word" "Excel" "XML" "Signature" "Stamp" "Archive" "Other"

Business meaning of the attachment, such as PDF, XML, signature, or archive.

mainAttachment
boolean or null
defaultAttachment
boolean or null
attachmentId
string or null <= 36 characters
base64FileContent
string or null

Base64-encoded content of the attachment.

lastModifiedDateTime
string or null <date-time>

Responses

Request samples

Content type
application/json
{
  • "id": "01234567-89ab-cdef-0123-456789abcdef",
  • "docFlowNumber": 0,
  • "docFlowId": "01234567-89ab-cdef-0123-456789abcdef",
  • "lineNumber": 0,
  • "name": "string",
  • "fileExtension": "string",
  • "type": "_x0020_",
  • "mainAttachment": true,
  • "defaultAttachment": true,
  • "attachmentId": "string",
  • "base64FileContent": "string",
  • "lastModifiedDateTime": "2017-04-13T15:51:04Z"
}

Response samples

Content type
application/json
{
  • "id": "01234567-89ab-cdef-0123-456789abcdef",
  • "docFlowNumber": 0,
  • "docFlowId": "01234567-89ab-cdef-0123-456789abcdef",
  • "lineNumber": 0,
  • "name": "string",
  • "fileExtension": "string",
  • "type": "_x0020_",
  • "mainAttachment": true,
  • "defaultAttachment": true,
  • "attachmentId": "string",
  • "base64FileContent": "string",
  • "lastModifiedDateTime": "2017-04-13T15:51:04Z"
}

Get an attachment of an outgoing DocFlow document

Returns metadata and file content for a single attachment that belongs to the specified outgoing electronic document.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the parent outgoing DocFlow document.

attachmentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the attachment that belongs to the outgoing DocFlow document.

query Parameters
$select
Array of strings unique
Items Enum: "id" "docFlowNumber" "docFlowId" "lineNumber" "name" "fileExtension" "type" "mainAttachment" "defaultAttachment" "attachmentId" "base64FileContent" "lastModifiedDateTime"

Limits the response to the selected properties.

Responses

Response samples

Content type
application/json
{
  • "id": "01234567-89ab-cdef-0123-456789abcdef",
  • "docFlowNumber": 0,
  • "docFlowId": "01234567-89ab-cdef-0123-456789abcdef",
  • "lineNumber": 0,
  • "name": "string",
  • "fileExtension": "string",
  • "type": "_x0020_",
  • "mainAttachment": true,
  • "defaultAttachment": true,
  • "attachmentId": "string",
  • "base64FileContent": "string",
  • "lastModifiedDateTime": "2017-04-13T15:51:04Z"
}

Update an attachment of an outgoing DocFlow document

Updates metadata or file content of an attachment linked to the specified outgoing electronic document.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the parent outgoing DocFlow document.

attachmentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the attachment that belongs to the outgoing DocFlow document.

Request Body schema: application/json
required

New property values

docFlowNumber
integer or null <int32>
docFlowId
string or null <uuid>

Business Central SystemId of the parent DocFlow document.

lineNumber
integer or null <int32>
name
string or null <= 250 characters

File name of the attachment.

fileExtension
string or null <= 30 characters
type
string or null (smaDocFlowAttachmentType)
Enum: "_x0020_" "PDF" "Word" "Excel" "XML" "Signature" "Stamp" "Archive" "Other"

Business meaning of the attachment, such as PDF, XML, signature, or archive.

mainAttachment
boolean or null
defaultAttachment
boolean or null
attachmentId
string or null <= 36 characters
base64FileContent
string or null

Base64-encoded attachment content used to replace the existing file.

lastModifiedDateTime
string or null <date-time>

Responses

Request samples

Content type
application/json
{
  • "docFlowNumber": 0,
  • "docFlowId": "01234567-89ab-cdef-0123-456789abcdef",
  • "lineNumber": 0,
  • "name": "string",
  • "fileExtension": "string",
  • "type": "_x0020_",
  • "mainAttachment": true,
  • "defaultAttachment": true,
  • "attachmentId": "string",
  • "base64FileContent": "string",
  • "lastModifiedDateTime": "2017-04-13T15:51:04Z"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete an attachment of an outgoing DocFlow document

Removes an attachment from the specified outgoing electronic document.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the parent outgoing DocFlow document.

attachmentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the attachment that belongs to the outgoing DocFlow document.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

List signers of an outgoing DocFlow document

Returns the signer workflow entries assigned to the specified outgoing electronic document.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the parent outgoing DocFlow document.

query Parameters
$top
integer >= 0
Example: $top=50

Limits the number of returned items.

$skip
integer >= 0

Skips the first N returned items.

$search
string

Applies a free-text search expression.

$filter
string

Filters records by field values.

$count
boolean

Includes @odata.count in the response.

$orderby
Array of strings unique
Items Enum: "id" "id desc" "docFlowNumber" "docFlowNumber desc" "documentId" "documentId desc" "lineNumber" "lineNumber desc" "signerType" "signerType desc" "signerNumber" "signerNumber desc" "fullName" "fullName desc" "jobTitle" "jobTitle desc" "email" "email desc" "signed" "signed desc" "lastModifiedDateTime" "lastModifiedDateTime desc"

Sorts the returned records.

$select
Array of strings unique
Items Enum: "id" "docFlowNumber" "documentId" "lineNumber" "signerType" "signerNumber" "fullName" "jobTitle" "email" "signed" "lastModifiedDateTime"

Limits the response to the selected properties.

$expand
Array of strings unique
Items Enum: "*" "docFlowDocument"

Includes related entities in the same response.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 0,
  • "value": [
    ]
}

Create a signer for an outgoing DocFlow document

Adds a signer entry to the signing flow of the specified outgoing electronic document.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the parent outgoing DocFlow document.

Request Body schema: application/json
required

New entity

id
required
string <uuid>
docFlowNumber
integer or null <int32>
documentId
string or null <uuid>

Business Central SystemId of the parent DocFlow document.

lineNumber
integer or null <int32>
signerType
string or null (smaDocFlowEmployeeSignerType)
Enum: "_x0020_" "Director" "Accountant" "Cashier" "Responsible" "ReleasedBy" "ReceivedBy" "PassedBy" "RequestedBy" "Chairman" "Member1" "Member2" "Member3" "StoredBy" "Head_x0020_of_x0020_Department" "Confirm" "Member4" "SMA_x0020_Signer_x0020_1" "SMA_x0020_Signer_x0020_2" "SMA_x0020_Signer_x0020_3" "SMA_x0020_Signer_x0020_4" "SMA_x0020_Signer_x0020_5" "SMA_x0020_Signer_x0020_6" "SMA_x0020_Signer_x0020_7" "SMA_x0020_Signer_x0020_8" "SMA_x0020_Signer_x0020_9" "SMA_x0020_Signer_x0020_10"

Business role of the signer in the workflow.

signerNumber
string or null <= 20 characters

Employee or signer code linked to the signer entry.

fullName
string or null <= 100 characters

Full name of the signer.

jobTitle
string or null <= 250 characters
email
string or null <= 80 characters

Email address used for the signer workflow.

signed
boolean or null
lastModifiedDateTime
string or null <date-time>
object or null (docFlowDocument (for create))

Expanded parent document included in create payloads when needed.

Responses

Request samples

Content type
application/json
{
  • "id": "01234567-89ab-cdef-0123-456789abcdef",
  • "docFlowNumber": 0,
  • "documentId": "01234567-89ab-cdef-0123-456789abcdef",
  • "lineNumber": 0,
  • "signerType": "_x0020_",
  • "signerNumber": "string",
  • "fullName": "string",
  • "jobTitle": "string",
  • "email": "string",
  • "signed": true,
  • "lastModifiedDateTime": "2017-04-13T15:51:04Z",
  • "docFlowDocument": {
    }
}

Response samples

Content type
application/json
{
  • "id": "01234567-89ab-cdef-0123-456789abcdef",
  • "docFlowNumber": 0,
  • "documentId": "01234567-89ab-cdef-0123-456789abcdef",
  • "lineNumber": 0,
  • "signerType": "_x0020_",
  • "signerNumber": "string",
  • "fullName": "string",
  • "jobTitle": "string",
  • "email": "string",
  • "signed": true,
  • "lastModifiedDateTime": "2017-04-13T15:51:04Z",
  • "docFlowDocument": {
    }
}

Get a signer of an outgoing DocFlow document

Returns one signer workflow entry for the specified outgoing electronic document.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the parent outgoing DocFlow document.

signerId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the signer entry that belongs to the outgoing DocFlow document.

query Parameters
$select
Array of strings unique
Items Enum: "id" "docFlowNumber" "documentId" "lineNumber" "signerType" "signerNumber" "fullName" "jobTitle" "email" "signed" "lastModifiedDateTime"

Limits the response to the selected properties.

$expand
Array of strings unique
Items Enum: "*" "docFlowDocument"

Includes related entities in the same response.

Responses

Response samples

Content type
application/json
{
  • "id": "01234567-89ab-cdef-0123-456789abcdef",
  • "docFlowNumber": 0,
  • "documentId": "01234567-89ab-cdef-0123-456789abcdef",
  • "lineNumber": 0,
  • "signerType": "_x0020_",
  • "signerNumber": "string",
  • "fullName": "string",
  • "jobTitle": "string",
  • "email": "string",
  • "signed": true,
  • "lastModifiedDateTime": "2017-04-13T15:51:04Z",
  • "docFlowDocument": {
    }
}

Update a signer of an outgoing DocFlow document

Updates signer details or signing state for the specified outgoing electronic document.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the parent outgoing DocFlow document.

signerId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the signer entry that belongs to the outgoing DocFlow document.

Request Body schema: application/json
required

New property values

docFlowNumber
integer or null <int32>
documentId
string or null <uuid>

Business Central SystemId of the parent DocFlow document.

lineNumber
integer or null <int32>
signerType
string or null (smaDocFlowEmployeeSignerType)
Enum: "_x0020_" "Director" "Accountant" "Cashier" "Responsible" "ReleasedBy" "ReceivedBy" "PassedBy" "RequestedBy" "Chairman" "Member1" "Member2" "Member3" "StoredBy" "Head_x0020_of_x0020_Department" "Confirm" "Member4" "SMA_x0020_Signer_x0020_1" "SMA_x0020_Signer_x0020_2" "SMA_x0020_Signer_x0020_3" "SMA_x0020_Signer_x0020_4" "SMA_x0020_Signer_x0020_5" "SMA_x0020_Signer_x0020_6" "SMA_x0020_Signer_x0020_7" "SMA_x0020_Signer_x0020_8" "SMA_x0020_Signer_x0020_9" "SMA_x0020_Signer_x0020_10"

Business role of the signer in the workflow.

signerNumber
string or null <= 20 characters
fullName
string or null <= 100 characters

Full name of the signer.

jobTitle
string or null <= 250 characters
email
string or null <= 80 characters
signed
boolean or null

Set to true when the signer has completed the signature step.

lastModifiedDateTime
string or null <date-time>

Responses

Request samples

Content type
application/json
{
  • "docFlowNumber": 0,
  • "documentId": "01234567-89ab-cdef-0123-456789abcdef",
  • "lineNumber": 0,
  • "signerType": "_x0020_",
  • "signerNumber": "string",
  • "fullName": "string",
  • "jobTitle": "string",
  • "email": "string",
  • "signed": true,
  • "lastModifiedDateTime": "2017-04-13T15:51:04Z"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete a signer of an outgoing DocFlow document

Removes a signer entry from the signing workflow of the specified outgoing electronic document.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the parent outgoing DocFlow document.

signerId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the signer entry that belongs to the outgoing DocFlow document.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

internalDocFlowDocuments

Internal electronic documents that stay within the organization's signing and approval flow.

List internal DocFlow documents

Returns internal electronic documents that are processed within SMART EDI without external delivery to a counterparty provider.

Authorizations:
BearerAuth
query Parameters
$top
integer >= 0
Example: $top=50

Limits the number of returned items.

$skip
integer >= 0

Skips the first N returned items.

$search
string

Applies a free-text search expression.

$filter
string

Filters records by field values.

$count
boolean

Includes @odata.count in the response.

$orderby
Array of strings unique
Items Enum: "id" "id desc" "entryNumber" "entryNumber desc" "serviceCode" "serviceCode desc" "documentId" "documentId desc" "templateCode" "templateCode desc" "templateDescription" "templateDescription desc" "documentNumber" "documentNumber desc" "documentDate" "documentDate desc" "name" "name desc" "uploadedDateTime" "uploadedDateTime desc" "isSigned" "isSigned desc" "isViewed" "isViewed desc" "statusId" "statusId desc" "status" "status desc" "statusText" "statusText desc" "integrationState" "integrationState desc" "endingDate" "endingDate desc" "documentUrl" "documentUrl desc" "amount" "amount desc" "responsibilityCenter" "responsibilityCenter desc" "lastErrorText" "lastErrorText desc" "signerEmail" "signerEmail desc" "archived" "archived desc" "lastModifiedDateTime" "lastModifiedDateTime desc"

Sorts the returned records.

$select
Array of strings unique
Items Enum: "id" "entryNumber" "serviceCode" "documentId" "templateCode" "templateDescription" "documentNumber" "documentDate" "name" "uploadedDateTime" "isSigned" "isViewed" "statusId" "status" "statusText" "integrationState" "endingDate" "documentUrl" "amount" "responsibilityCenter" "lastErrorText" "signerEmail" "archived" "lastModifiedDateTime"

Limits the response to the selected properties.

$expand
Array of strings unique
Items Enum: "*" "docFlowService" "docFlowTemplate" "docFlowAttachments" "docFlowDocumentSigners"

Includes related entities in the same response.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 0,
  • "value": [
    ]
}

Get an internal DocFlow document

Returns a single internal electronic document identified by its Business Central SystemId.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the internal DocFlow document.

query Parameters
$select
Array of strings unique
Items Enum: "id" "entryNumber" "serviceCode" "documentId" "templateCode" "templateDescription" "documentNumber" "documentDate" "name" "uploadedDateTime" "isSigned" "isViewed" "statusId" "status" "statusText" "integrationState" "endingDate" "documentUrl" "amount" "responsibilityCenter" "lastErrorText" "signerEmail" "archived" "lastModifiedDateTime"

Limits the response to the selected properties.

$expand
Array of strings unique
Items Enum: "*" "docFlowService" "docFlowTemplate" "docFlowAttachments" "docFlowDocumentSigners"

Includes related entities in the same response.

Responses

Response samples

Content type
application/json
{
  • "id": "01234567-89ab-cdef-0123-456789abcdef",
  • "entryNumber": 0,
  • "serviceCode": "string",
  • "documentId": "string",
  • "templateCode": "string",
  • "templateDescription": "string",
  • "documentNumber": "string",
  • "documentDate": "2017-04-13",
  • "name": "string",
  • "uploadedDateTime": "2017-04-13T15:51:04Z",
  • "isSigned": true,
  • "isViewed": true,
  • "statusId": 0,
  • "status": "string",
  • "statusText": "string",
  • "integrationState": "Created",
  • "endingDate": "2017-04-13",
  • "documentUrl": "string",
  • "amount": 0,
  • "responsibilityCenter": "string",
  • "lastErrorText": "string",
  • "signerEmail": "string",
  • "archived": true,
  • "lastModifiedDateTime": "2017-04-13T15:51:04Z",
  • "docFlowService": {
    },
  • "docFlowTemplate": {
    },
  • "docFlowAttachments": [
    ],
  • "docFlowAttachments@odata.count": 0,
  • "docFlowDocumentSigners": [
    ],
  • "docFlowDocumentSigners@odata.count": 0
}

Update an internal DocFlow document

Updates editable fields of an internal DocFlow document, such as naming, dates, or responsibility information.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the internal DocFlow document.

Request Body schema: application/json
required

New property values

documentNumber
string or null <= 20 characters
documentDate
string or null <date>
name
string or null <= 100 characters
endingDate
string or null <date>
number or string <decimal>

Monetary amount associated with the internal business document.

responsibilityCenter
string or null <= 10 characters

Responses

Request samples

Content type
application/json
{
  • "documentNumber": "string",
  • "documentDate": "2017-04-13",
  • "name": "string",
  • "endingDate": "2017-04-13",
  • "amount": 0,
  • "responsibilityCenter": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Archive an internal DocFlow document

Archives the specified internal electronic document according to its configured archive status mapping.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the internal DocFlow document.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Refresh the status of an internal DocFlow document

Refreshes local status information for the specified internal electronic document.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the internal DocFlow document.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Upload an internal DocFlow document

Uploads the specified internal electronic document and its prepared payload to the configured provider.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the internal DocFlow document.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

List attachments of an internal DocFlow document

Returns files attached to the specified internal electronic document.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the parent internal DocFlow document.

query Parameters
$top
integer >= 0
Example: $top=50

Limits the number of returned items.

$skip
integer >= 0

Skips the first N returned items.

$search
string

Applies a free-text search expression.

$filter
string

Filters records by field values.

$count
boolean

Includes @odata.count in the response.

$orderby
Array of strings unique
Items Enum: "id" "id desc" "docFlowNumber" "docFlowNumber desc" "docFlowId" "docFlowId desc" "lineNumber" "lineNumber desc" "name" "name desc" "fileExtension" "fileExtension desc" "type" "type desc" "mainAttachment" "mainAttachment desc" "defaultAttachment" "defaultAttachment desc" "attachmentId" "attachmentId desc" "base64FileContent" "base64FileContent desc" "lastModifiedDateTime" "lastModifiedDateTime desc"

Sorts the returned records.

$select
Array of strings unique
Items Enum: "id" "docFlowNumber" "docFlowId" "lineNumber" "name" "fileExtension" "type" "mainAttachment" "defaultAttachment" "attachmentId" "base64FileContent" "lastModifiedDateTime"

Limits the response to the selected properties.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 0,
  • "value": [
    ]
}

Create an attachment for an internal DocFlow document

Adds a new attachment to the specified internal electronic document using base64-encoded file content.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the parent internal DocFlow document.

Request Body schema: application/json
required

New entity

id
required
string <uuid>
docFlowNumber
integer or null <int32>
docFlowId
string or null <uuid>

Business Central SystemId of the parent DocFlow document.

lineNumber
integer or null <int32>
name
string or null <= 250 characters

File name of the attachment.

fileExtension
string or null <= 30 characters

File extension of the attachment content.

type
string or null (smaDocFlowAttachmentType)
Enum: "_x0020_" "PDF" "Word" "Excel" "XML" "Signature" "Stamp" "Archive" "Other"

Business meaning of the attachment, such as PDF, XML, signature, or archive.

mainAttachment
boolean or null
defaultAttachment
boolean or null
attachmentId
string or null <= 36 characters
base64FileContent
string or null

Base64-encoded content of the attachment.

lastModifiedDateTime
string or null <date-time>

Responses

Request samples

Content type
application/json
{
  • "id": "01234567-89ab-cdef-0123-456789abcdef",
  • "docFlowNumber": 0,
  • "docFlowId": "01234567-89ab-cdef-0123-456789abcdef",
  • "lineNumber": 0,
  • "name": "string",
  • "fileExtension": "string",
  • "type": "_x0020_",
  • "mainAttachment": true,
  • "defaultAttachment": true,
  • "attachmentId": "string",
  • "base64FileContent": "string",
  • "lastModifiedDateTime": "2017-04-13T15:51:04Z"
}

Response samples

Content type
application/json
{
  • "id": "01234567-89ab-cdef-0123-456789abcdef",
  • "docFlowNumber": 0,
  • "docFlowId": "01234567-89ab-cdef-0123-456789abcdef",
  • "lineNumber": 0,
  • "name": "string",
  • "fileExtension": "string",
  • "type": "_x0020_",
  • "mainAttachment": true,
  • "defaultAttachment": true,
  • "attachmentId": "string",
  • "base64FileContent": "string",
  • "lastModifiedDateTime": "2017-04-13T15:51:04Z"
}

Get an attachment of an internal DocFlow document

Returns one attachment linked to the specified internal electronic document.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the parent internal DocFlow document.

attachmentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the attachment that belongs to the internal DocFlow document.

query Parameters
$select
Array of strings unique
Items Enum: "id" "docFlowNumber" "docFlowId" "lineNumber" "name" "fileExtension" "type" "mainAttachment" "defaultAttachment" "attachmentId" "base64FileContent" "lastModifiedDateTime"

Limits the response to the selected properties.

Responses

Response samples

Content type
application/json
{
  • "id": "01234567-89ab-cdef-0123-456789abcdef",
  • "docFlowNumber": 0,
  • "docFlowId": "01234567-89ab-cdef-0123-456789abcdef",
  • "lineNumber": 0,
  • "name": "string",
  • "fileExtension": "string",
  • "type": "_x0020_",
  • "mainAttachment": true,
  • "defaultAttachment": true,
  • "attachmentId": "string",
  • "base64FileContent": "string",
  • "lastModifiedDateTime": "2017-04-13T15:51:04Z"
}

Update an attachment of an internal DocFlow document

Updates metadata or file content of an attachment linked to the specified internal electronic document.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the parent internal DocFlow document.

attachmentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the attachment that belongs to the internal DocFlow document.

Request Body schema: application/json
required

New property values

docFlowNumber
integer or null <int32>
docFlowId
string or null <uuid>

Business Central SystemId of the parent DocFlow document.

lineNumber
integer or null <int32>
name
string or null <= 250 characters

File name of the attachment.

fileExtension
string or null <= 30 characters
type
string or null (smaDocFlowAttachmentType)
Enum: "_x0020_" "PDF" "Word" "Excel" "XML" "Signature" "Stamp" "Archive" "Other"

Business meaning of the attachment, such as PDF, XML, signature, or archive.

mainAttachment
boolean or null
defaultAttachment
boolean or null
attachmentId
string or null <= 36 characters
base64FileContent
string or null

Base64-encoded attachment content used to replace the existing file.

lastModifiedDateTime
string or null <date-time>

Responses

Request samples

Content type
application/json
{
  • "docFlowNumber": 0,
  • "docFlowId": "01234567-89ab-cdef-0123-456789abcdef",
  • "lineNumber": 0,
  • "name": "string",
  • "fileExtension": "string",
  • "type": "_x0020_",
  • "mainAttachment": true,
  • "defaultAttachment": true,
  • "attachmentId": "string",
  • "base64FileContent": "string",
  • "lastModifiedDateTime": "2017-04-13T15:51:04Z"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete an attachment of an internal DocFlow document

Removes an attachment from the specified internal electronic document.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the parent internal DocFlow document.

attachmentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the attachment that belongs to the internal DocFlow document.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

List signers of an internal DocFlow document

Returns signer workflow entries assigned to the specified internal electronic document.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the parent internal DocFlow document.

query Parameters
$top
integer >= 0
Example: $top=50

Limits the number of returned items.

$skip
integer >= 0

Skips the first N returned items.

$search
string

Applies a free-text search expression.

$filter
string

Filters records by field values.

$count
boolean

Includes @odata.count in the response.

$orderby
Array of strings unique
Items Enum: "id" "id desc" "docFlowNumber" "docFlowNumber desc" "documentId" "documentId desc" "lineNumber" "lineNumber desc" "signerType" "signerType desc" "signerNumber" "signerNumber desc" "fullName" "fullName desc" "jobTitle" "jobTitle desc" "email" "email desc" "signed" "signed desc" "lastModifiedDateTime" "lastModifiedDateTime desc"

Sorts the returned records.

$select
Array of strings unique
Items Enum: "id" "docFlowNumber" "documentId" "lineNumber" "signerType" "signerNumber" "fullName" "jobTitle" "email" "signed" "lastModifiedDateTime"

Limits the response to the selected properties.

$expand
Array of strings unique
Items Enum: "*" "docFlowDocument"

Includes related entities in the same response.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 0,
  • "value": [
    ]
}

Create a signer for an internal DocFlow document

Adds a signer entry to the signing flow of the specified internal electronic document.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the parent internal DocFlow document.

Request Body schema: application/json
required

New entity

id
required
string <uuid>
docFlowNumber
integer or null <int32>
documentId
string or null <uuid>

Business Central SystemId of the parent DocFlow document.

lineNumber
integer or null <int32>
signerType
string or null (smaDocFlowEmployeeSignerType)
Enum: "_x0020_" "Director" "Accountant" "Cashier" "Responsible" "ReleasedBy" "ReceivedBy" "PassedBy" "RequestedBy" "Chairman" "Member1" "Member2" "Member3" "StoredBy" "Head_x0020_of_x0020_Department" "Confirm" "Member4" "SMA_x0020_Signer_x0020_1" "SMA_x0020_Signer_x0020_2" "SMA_x0020_Signer_x0020_3" "SMA_x0020_Signer_x0020_4" "SMA_x0020_Signer_x0020_5" "SMA_x0020_Signer_x0020_6" "SMA_x0020_Signer_x0020_7" "SMA_x0020_Signer_x0020_8" "SMA_x0020_Signer_x0020_9" "SMA_x0020_Signer_x0020_10"

Business role of the signer in the workflow.

signerNumber
string or null <= 20 characters

Employee or signer code linked to the signer entry.

fullName
string or null <= 100 characters

Full name of the signer.

jobTitle
string or null <= 250 characters
email
string or null <= 80 characters

Email address used for the signer workflow.

signed
boolean or null
lastModifiedDateTime
string or null <date-time>
object or null (docFlowDocument (for create))

Expanded parent document included in create payloads when needed.

Responses

Request samples

Content type
application/json
{
  • "id": "01234567-89ab-cdef-0123-456789abcdef",
  • "docFlowNumber": 0,
  • "documentId": "01234567-89ab-cdef-0123-456789abcdef",
  • "lineNumber": 0,
  • "signerType": "_x0020_",
  • "signerNumber": "string",
  • "fullName": "string",
  • "jobTitle": "string",
  • "email": "string",
  • "signed": true,
  • "lastModifiedDateTime": "2017-04-13T15:51:04Z",
  • "docFlowDocument": {
    }
}

Response samples

Content type
application/json
{
  • "id": "01234567-89ab-cdef-0123-456789abcdef",
  • "docFlowNumber": 0,
  • "documentId": "01234567-89ab-cdef-0123-456789abcdef",
  • "lineNumber": 0,
  • "signerType": "_x0020_",
  • "signerNumber": "string",
  • "fullName": "string",
  • "jobTitle": "string",
  • "email": "string",
  • "signed": true,
  • "lastModifiedDateTime": "2017-04-13T15:51:04Z",
  • "docFlowDocument": {
    }
}

Get a signer of an internal DocFlow document

Returns one signer workflow entry for the specified internal electronic document.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the parent internal DocFlow document.

signerId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the signer entry that belongs to the internal DocFlow document.

query Parameters
$select
Array of strings unique
Items Enum: "id" "docFlowNumber" "documentId" "lineNumber" "signerType" "signerNumber" "fullName" "jobTitle" "email" "signed" "lastModifiedDateTime"

Limits the response to the selected properties.

$expand
Array of strings unique
Items Enum: "*" "docFlowDocument"

Includes related entities in the same response.

Responses

Response samples

Content type
application/json
{
  • "id": "01234567-89ab-cdef-0123-456789abcdef",
  • "docFlowNumber": 0,
  • "documentId": "01234567-89ab-cdef-0123-456789abcdef",
  • "lineNumber": 0,
  • "signerType": "_x0020_",
  • "signerNumber": "string",
  • "fullName": "string",
  • "jobTitle": "string",
  • "email": "string",
  • "signed": true,
  • "lastModifiedDateTime": "2017-04-13T15:51:04Z",
  • "docFlowDocument": {
    }
}

Update a signer of an internal DocFlow document

Updates signer details or signing state for the specified internal electronic document.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the parent internal DocFlow document.

signerId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the signer entry that belongs to the internal DocFlow document.

Request Body schema: application/json
required

New property values

docFlowNumber
integer or null <int32>
documentId
string or null <uuid>

Business Central SystemId of the parent DocFlow document.

lineNumber
integer or null <int32>
signerType
string or null (smaDocFlowEmployeeSignerType)
Enum: "_x0020_" "Director" "Accountant" "Cashier" "Responsible" "ReleasedBy" "ReceivedBy" "PassedBy" "RequestedBy" "Chairman" "Member1" "Member2" "Member3" "StoredBy" "Head_x0020_of_x0020_Department" "Confirm" "Member4" "SMA_x0020_Signer_x0020_1" "SMA_x0020_Signer_x0020_2" "SMA_x0020_Signer_x0020_3" "SMA_x0020_Signer_x0020_4" "SMA_x0020_Signer_x0020_5" "SMA_x0020_Signer_x0020_6" "SMA_x0020_Signer_x0020_7" "SMA_x0020_Signer_x0020_8" "SMA_x0020_Signer_x0020_9" "SMA_x0020_Signer_x0020_10"

Business role of the signer in the workflow.

signerNumber
string or null <= 20 characters
fullName
string or null <= 100 characters

Full name of the signer.

jobTitle
string or null <= 250 characters
email
string or null <= 80 characters
signed
boolean or null

Set to true when the signer has completed the signature step.

lastModifiedDateTime
string or null <date-time>

Responses

Request samples

Content type
application/json
{
  • "docFlowNumber": 0,
  • "documentId": "01234567-89ab-cdef-0123-456789abcdef",
  • "lineNumber": 0,
  • "signerType": "_x0020_",
  • "signerNumber": "string",
  • "fullName": "string",
  • "jobTitle": "string",
  • "email": "string",
  • "signed": true,
  • "lastModifiedDateTime": "2017-04-13T15:51:04Z"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete a signer of an internal DocFlow document

Removes a signer entry from the signing workflow of the specified internal electronic document.

Authorizations:
BearerAuth
path Parameters
documentId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the parent internal DocFlow document.

signerId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the signer entry that belongs to the internal DocFlow document.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

docFlowTemplates

Document templates that define how files are generated, titled, routed, and signed.

List DocFlow templates

Returns document templates that define how DocFlow documents are generated, titled, routed, and signed.

Authorizations:
BearerAuth
query Parameters
$top
integer >= 0
Example: $top=50

Limits the number of returned items.

$skip
integer >= 0

Skips the first N returned items.

$search
string

Applies a free-text search expression.

$filter
string

Filters records by field values.

$count
boolean

Includes @odata.count in the response.

$orderby
Array of strings unique
Items Enum: "id" "id desc" "serviceCode" "serviceCode desc" "serviceId" "serviceId desc" "code" "code desc" "description" "description desc" "type" "type desc" "customDocumentType" "customDocumentType desc" "sourceTableId" "sourceTableId desc" "sourceTableName" "sourceTableName desc" "reportId" "reportId desc" "reportName" "reportName desc" "firstSignBy" "firstSignBy desc" "documentTitle" "documentTitle desc" "expectedOwnerSigner" "expectedOwnerSigner desc" "expectedRecipientSignatures" "expectedRecipientSignatures desc" "ownerSignatureMandatory" "ownerSignatureMandatory desc" "ownerStampMandatory" "ownerStampMandatory desc" "filenamePattern" "filenamePattern desc" "createDocumentOnPost" "createDocumentOnPost desc" "internalDocument" "internalDocument desc" "parallelSigning" "parallelSigning desc" "blockOutboundDelivery" "blockOutboundDelivery desc" "ownerSignatureNotRequired" "ownerSignatureNotRequired desc" "lastModifiedDateTime" "lastModifiedDateTime desc"

Sorts the returned records.

$select
Array of strings unique
Items Enum: "id" "serviceCode" "serviceId" "code" "description" "type" "customDocumentType" "sourceTableId" "sourceTableName" "reportId" "reportName" "firstSignBy" "documentTitle" "expectedOwnerSigner" "expectedRecipientSignatures" "ownerSignatureMandatory" "ownerStampMandatory" "filenamePattern" "createDocumentOnPost" "internalDocument" "parallelSigning" "blockOutboundDelivery" "ownerSignatureNotRequired" "lastModifiedDateTime"

Limits the response to the selected properties.

$expand
Array of strings unique
Items Enum: "*" "docFlowService"

Includes related entities in the same response.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 0,
  • "value": [
    ]
}

Get a DocFlow template

Returns one document template including generation, signing, and automation settings.

Authorizations:
BearerAuth
path Parameters
templateId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the DocFlow template.

query Parameters
$select
Array of strings unique
Items Enum: "id" "serviceCode" "serviceId" "code" "description" "type" "customDocumentType" "sourceTableId" "sourceTableName" "reportId" "reportName" "firstSignBy" "documentTitle" "expectedOwnerSigner" "expectedRecipientSignatures" "ownerSignatureMandatory" "ownerStampMandatory" "filenamePattern" "createDocumentOnPost" "internalDocument" "parallelSigning" "blockOutboundDelivery" "ownerSignatureNotRequired" "lastModifiedDateTime"

Limits the response to the selected properties.

$expand
Array of strings unique
Items Enum: "*" "docFlowService"

Includes related entities in the same response.

Responses

Response samples

Content type
application/json
{
  • "id": "01234567-89ab-cdef-0123-456789abcdef",
  • "serviceCode": "string",
  • "serviceId": "01234567-89ab-cdef-0123-456789abcdef",
  • "code": "string",
  • "description": "string",
  • "type": "_x0020_",
  • "customDocumentType": "_x0020_",
  • "sourceTableId": 0,
  • "sourceTableName": "string",
  • "reportId": 0,
  • "reportName": "string",
  • "firstSignBy": "Owner",
  • "documentTitle": "string",
  • "expectedOwnerSigner": "_x0020_",
  • "expectedRecipientSignatures": 0,
  • "ownerSignatureMandatory": true,
  • "ownerStampMandatory": true,
  • "filenamePattern": "string",
  • "createDocumentOnPost": true,
  • "internalDocument": true,
  • "parallelSigning": true,
  • "blockOutboundDelivery": true,
  • "ownerSignatureNotRequired": true,
  • "lastModifiedDateTime": "2017-04-13T15:51:04Z",
  • "docFlowService": {
    }
}

newDocFlowDocuments

Write-only endpoint for creating a new DocFlow document with an uploaded file payload.

Create a new DocFlow document from uploaded content

Creates a new DocFlow document using the selected service and template, then stores the supplied base64-encoded file as its initial attachment.

Authorizations:
BearerAuth
Request Body schema: application/json
required

New entity

id
required
string <uuid>

Business Central SystemId placeholder generated for the API payload.

entryNumber
integer or null <int32>
serviceCode
string or null

Code of the DocFlow service to use when creating the document. Provide this field or serviceId.

serviceId
string or null <uuid>

Business Central SystemId of the DocFlow service. Can be used instead of serviceCode. One of serviceCode or serviceId is required.

templateCode
string or null

Code of the template used to initialize the document. Provide this field or templateId.

templateId
string or null <uuid>

Business Central SystemId of the template. Can be used instead of templateCode. One of templateCode or templateId is required.

documentNo
string or null

Business document number to store on the created DocFlow document.

documentDate
string or null <date>
name
string or null

Display name of the created document.

counterpartyCode
string or null
counterpartyName
string or null
counterpartyEmail
string or null
number or string <decimal>

Monetary amount associated with the created document.

internal
boolean or null

Set to true to create the document as an internal DocFlow document.

base64FileContent
required
string or null

Required base64-encoded content of the initial attachment.

fileName
required
string or null

Required file name of the uploaded attachment.

integrationState
string or null (smaDocFlowDocumentState)
Enum: "Created" "Uploaded" "Deleted" "Signed" "Wait_x0020_for_x0020_signature" "Wait_x0020_for_x0020_stamp" "Pending_x0020_Approval" "Rejected"

Initial integration state returned by the API after document creation.

Responses

Request samples

Content type
application/json
{
  • "id": "01234567-89ab-cdef-0123-456789abcdef",
  • "entryNumber": 0,
  • "serviceCode": "string",
  • "serviceId": "01234567-89ab-cdef-0123-456789abcdef",
  • "templateCode": "string",
  • "templateId": "01234567-89ab-cdef-0123-456789abcdef",
  • "documentNo": "string",
  • "documentDate": "2017-04-13",
  • "name": "string",
  • "counterpartyCode": "string",
  • "counterpartyName": "string",
  • "counterpartyEmail": "string",
  • "amount": 0,
  • "internal": true,
  • "base64FileContent": "string",
  • "fileName": "string",
  • "integrationState": "Created"
}

Response samples

Content type
application/json
{
  • "id": "01234567-89ab-cdef-0123-456789abcdef",
  • "entryNumber": 0,
  • "serviceCode": "string",
  • "serviceId": "01234567-89ab-cdef-0123-456789abcdef",
  • "templateCode": "string",
  • "templateId": "01234567-89ab-cdef-0123-456789abcdef",
  • "documentNo": "string",
  • "documentDate": "2017-04-13",
  • "name": "string",
  • "counterpartyCode": "string",
  • "counterpartyName": "string",
  • "counterpartyEmail": "string",
  • "amount": 0,
  • "internal": true,
  • "base64FileContent": "string",
  • "fileName": "string",
  • "integrationState": "Created"
}

docFlowServices

Provider configurations that control document exchange, monitoring, archiving, and EDI processing.

List DocFlow services

Returns configured DocFlow providers and their processing capabilities for document exchange, monitoring, archiving, and EDI operations.

Authorizations:
BearerAuth
query Parameters
$top
integer >= 0
Example: $top=50

Limits the number of returned items.

$skip
integer >= 0

Skips the first N returned items.

$search
string

Applies a free-text search expression.

$filter
string

Filters records by field values.

$count
boolean

Includes @odata.count in the response.

$orderby
Array of strings unique
Items Enum: "id" "id desc" "serviceCode" "serviceCode desc" "name" "name desc" "serviceVendor" "serviceVendor desc" "companyId" "companyId desc" "enabled" "enabled desc" "signingMethod" "signingMethod desc" "exportDocFlowDocuments" "exportDocFlowDocuments desc" "importIncomingDocuments" "importIncomingDocuments desc" "archiveDocFlowDocuments" "archiveDocFlowDocuments desc" "archiveIncomingDocuments" "archiveIncomingDocuments desc" "checkDocFlowDocuments" "checkDocFlowDocuments desc" "checkIncomingDocuments" "checkIncomingDocuments desc" "syncDeleteRequests" "syncDeleteRequests desc" "salesEDIProcess" "salesEDIProcess desc" "purchaseEDIProcess" "purchaseEDIProcess desc" "logLevel" "logLevel desc" "defaultResponsibilityCenter" "defaultResponsibilityCenter desc" "lastModifiedDateTime" "lastModifiedDateTime desc"

Sorts the returned records.

$select
Array of strings unique
Items Enum: "id" "serviceCode" "name" "serviceVendor" "companyId" "enabled" "signingMethod" "exportDocFlowDocuments" "importIncomingDocuments" "archiveDocFlowDocuments" "archiveIncomingDocuments" "checkDocFlowDocuments" "checkIncomingDocuments" "syncDeleteRequests" "salesEDIProcess" "purchaseEDIProcess" "logLevel" "defaultResponsibilityCenter" "lastModifiedDateTime"

Limits the response to the selected properties.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 0,
  • "value": [
    ]
}

Get a DocFlow service

Returns one configured DocFlow provider with its enabled capabilities and default processing settings.

Authorizations:
BearerAuth
path Parameters
serviceId
required
string <uuid>
Example: 01234567-89ab-cdef-0123-456789abcdef

The SystemId of the DocFlow service.

query Parameters
$select
Array of strings unique
Items Enum: "id" "serviceCode" "name" "serviceVendor" "companyId" "enabled" "signingMethod" "exportDocFlowDocuments" "importIncomingDocuments" "archiveDocFlowDocuments" "archiveIncomingDocuments" "checkDocFlowDocuments" "checkIncomingDocuments" "syncDeleteRequests" "salesEDIProcess" "purchaseEDIProcess" "logLevel" "defaultResponsibilityCenter" "lastModifiedDateTime"

Limits the response to the selected properties.

Responses

Response samples

Content type
application/json
{
  • "id": "01234567-89ab-cdef-0123-456789abcdef",
  • "serviceCode": "string",
  • "name": "string",
  • "serviceVendor": "None",
  • "companyId": "string",
  • "enabled": true,
  • "signingMethod": "None",
  • "exportDocFlowDocuments": true,
  • "importIncomingDocuments": true,
  • "archiveDocFlowDocuments": true,
  • "archiveIncomingDocuments": true,
  • "checkDocFlowDocuments": true,
  • "checkIncomingDocuments": true,
  • "syncDeleteRequests": true,
  • "salesEDIProcess": true,
  • "purchaseEDIProcess": true,
  • "logLevel": "Disabled",
  • "defaultResponsibilityCenter": "string",
  • "lastModifiedDateTime": "2017-04-13T15:51:04Z"
}
https://bc.smart-it.com/
© 2008 - 2026 SMART business