Skip to main content
POST
/
v1
/
reporting-period-config
Create Reporting Period Configuration
curl --request POST \
  --url https://{tenant}.mindbridge.ai/api/v1/reporting-period-config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "monthlyReportingPeriods": [
    {
      "periodNumber": 123,
      "quarterNumber": 123,
      "yearLabel": "<string>",
      "startDate": "2023-12-25",
      "endDate": "2023-12-25"
    }
  ],
  "weeklyReportingPeriods": [
    {
      "weekNumber": 123,
      "yearLabel": "<string>",
      "startDate": "2023-12-25",
      "endDate": "2023-12-25"
    }
  ]
}
'
{
  "version": 123,
  "id": "<string>",
  "creationDate": "2023-11-07T05:31:56Z",
  "lastModifiedDate": "2023-11-07T05:31:56Z",
  "createdUserInfo": {
    "userId": "<string>",
    "userName": "<string>"
  },
  "lastModifiedUserInfo": {
    "userId": "<string>",
    "userName": "<string>"
  },
  "monthlyReportingPeriods": [
    {
      "periodNumber": 123,
      "quarterNumber": 123,
      "yearLabel": "<string>",
      "startDate": "2023-12-25",
      "endDate": "2023-12-25"
    }
  ],
  "weeklyReportingPeriods": [
    {
      "weekNumber": 123,
      "yearLabel": "<string>",
      "startDate": "2023-12-25",
      "endDate": "2023-12-25"
    }
  ],
  "status": "UPLOADED"
}

Authorizations

Authorization
string
header
required

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

Body

application/json
monthlyReportingPeriods
Monthly Reporting Period · object[]
required
weeklyReportingPeriods
Weekly Reporting Period · object[]
required

Response

201 - application/json

Created

version
integer<int64>
required
id
string
creationDate
string<date-time>
lastModifiedDate
string<date-time>
createdUserInfo
User Info · object
lastModifiedUserInfo
User Info · object
monthlyReportingPeriods
Monthly Reporting Period · object[]

List of monthly reporting periods.

weeklyReportingPeriods
Weekly Reporting Period · object[]

List of weekly reporting periods.

status
enum<string>
Available options:
UPLOADED,
VALIDATING,
FAILED,
COMPLETED