Skip to main content
POST
/
v1
/
engagements
Create Engagement
curl --request POST \
  --url https://localtest.mindbridge.ai/api/v1/engagements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "organizationId": {},
  "name": "<string>",
  "libraryId": {},
  "accountingPeriod": {
    "fiscalStartMonth": 123,
    "fiscalStartDay": 123,
    "frequency": "ANNUAL"
  },
  "auditPeriodEndDate": "2023-12-25",
  "accountingPackage": "<string>",
  "industry": "<string>",
  "engagementLeadId": {},
  "billingCode": "<string>",
  "settingsBasedOnEngagementId": {},
  "auditorIds": [
    {}
  ]
}
'
{
  "version": 123,
  "organizationId": {},
  "name": "<string>",
  "libraryId": {},
  "accountingPeriod": {
    "fiscalStartMonth": 123,
    "fiscalStartDay": 123,
    "frequency": "ANNUAL"
  },
  "auditPeriodEndDate": "2023-12-25",
  "accountingPackage": "<string>",
  "industry": "<string>",
  "engagementLeadId": {},
  "id": {},
  "creationDate": "2023-11-07T05:31:56Z",
  "lastModifiedDate": "2023-11-07T05:31:56Z",
  "createdUserInfo": {
    "userId": {},
    "userName": "<string>"
  },
  "lastModifiedUserInfo": {
    "userId": {},
    "userName": "<string>"
  },
  "billingCode": "<string>",
  "auditorIds": [
    {}
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
organizationId
object
required

Identifies the organization.

name
string
required

The name of the engagement.

Required string length: 1 - 80
Pattern: \s*\S+.*
libraryId
object
required

Identifies the library.

accountingPeriod
Accounting Period · object
required

Details about the accounting period.

auditPeriodEndDate
string<date>
required

The last day of the occurring audit.

accountingPackage
string
required

The ERP or financial management system that your client is using.

Minimum string length: 1
Pattern: \s*\S+.*
industry
string
required

The type of industry that your client operates within.

Minimum string length: 1
Pattern: \s*\S+.*
engagementLeadId
object
required

Identifies the user who will lead the engagement.

billingCode
string

A unique code that associates engagements and analyses with clients to ensure those clients are billed appropriately for MindBridge usage.

settingsBasedOnEngagementId
object

Identifies the engagement that the settings are based on.

auditorIds
object[]

Identifies the users who will act as auditors in the engagement.

Response

Created

version
integer<int64>
required

Indicates the data integrity version to ensure data consistency.

organizationId
object
required

Identifies the organization.

name
string
required

The name of the engagement.

Required string length: 1 - 80
Pattern: \s*\S+.*
libraryId
object
required

Identifies the library.

accountingPeriod
Accounting Period · object
required

Details about the accounting period.

auditPeriodEndDate
string<date>
required

The last day of the occurring audit.

accountingPackage
string
required

The ERP or financial management system that your client is using.

Minimum string length: 1
Pattern: \s*\S+.*
industry
string
required

The type of industry that your client operates within.

Minimum string length: 1
Pattern: \s*\S+.*
engagementLeadId
object
required

Identifies the user who will lead the engagement.

id
object

The unique object identifier.

creationDate
string<date-time>

The date that the object was originally created.

lastModifiedDate
string<date-time>

The date that the object was last updated or modified.

createdUserInfo
User Info · object

Details about the user who created the object.

lastModifiedUserInfo
User Info · object

Details about the user who last modified or updated the object.

billingCode
string

A unique code that associates engagements and analyses with clients to ensure those clients are billed appropriately for MindBridge usage.

auditorIds
object[]

Identifies the users who will act as auditors in the engagement.