Entries

post

Authorizations

ApiBearerAuth

AuthorizationstringRequired

Enter access token

Path parameters

customerIdstring · objectidRequired

customer's id

userIdstring · objectidRequired

user's id

entryIdstring · objectidRequired

Responses

200Success

No content

post

/api/v1/public/customers/{customerId}/users/{userId}/entries/{entryId}/unrelease

HTTPcURLJavaScriptPython

POST /api/v1/public/customers/{customerId}/users/{userId}/entries/{entryId}/unrelease HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

No content

patch

Authorizations

ApiBearerAuth

AuthorizationstringRequired

Enter access token

Path parameters

customerIdstring · objectidRequired

customer's id

userIdstring · objectidRequired

user's id

entryIdstring · objectidRequired

Body

application/json

summarystringOptional

if set, will update entry's summary

unitIncrementCountAdjustmentsnumber · doubleOptional

sum of total unit increments from this entry's sources and adjustments

initiativeIdstring · objectidOptional

if set, will update entry's initiativeId

codeIdsstring · objectid[]Optional

if set, will update entry's codes

workDatestring · iso-dateOptional

the date this entry is released to

Example: 2022-08-12

Responses

200Success

application/json

entryIdstring · objectidRequired

entry's id

externalIdstringOptional

entry's external id

customerIdstring · objectidRequired

id of customer who the owner belongs to

userIdstring · objectidRequired

user who owns the entry

creationMethodstring · enumRequired

the creation method of the entry

Possible values:

releasedBystring · objectidOptional

the identifier of the user who released the entry

createdBystring · objectidOptional

the identifier of the user who created the entry

workDatestring · iso-dateOptional

the date this entry is released to

Example: 2022-08-12

createdAtstring · iso-date-timeRequired

date and time this entry was created

Example: 2022-08-12T20:44:48Z

updatedAtstring · iso-date-timeRequired

date and time this entry was updated last

Example: 2022-08-12T20:44:48Z

initiativeExternalIdstringRequired

entry's initiative external Id

clientExternalIdstringRequired

initiative's client external Id

summarystringRequired

entry's summary

unitIncrementCountnumber · int64Required

sum of unit increments from this entry's sources and adjustments

incrementDurationInSecondsnumber · int64Required

entry duration in seconds

lastReleasePendingAtstring · iso-date-timeOptional

last date and time this entry was release pended

Example: 2022-08-12T20:44:48Z

lastReleaseFailedAtstring · iso-date-timeOptional

last date and time this entry was release failed

Example: 2022-08-12T20:44:48Z

releaseSuccessAtstring · iso-date-timeOptional

date and time this entry was released successfully

Example: 2022-08-12T20:44:48Z

isDeletedbooleanOptional

is entry soft deleted

notesstringOptional

entry's notes

releaseCountnumber · int64Optional

lastSyncedAtstring · iso-date-timeOptional

date and time when the entry was last synced with the PMS

Example: 2022-08-12T20:44:48Z

patch

/api/v1/public/customers/{customerId}/users/{userId}/entries/{entryId}/override

HTTPcURLJavaScriptPython

PATCH /api/v1/public/customers/{customerId}/users/{userId}/entries/{entryId}/override HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "summary": "text",
  "unitIncrementCountAdjustments": 1,
  "initiativeId": "text",
  "codeIds": [
    "text"
  ],
  "workDate": "2022-08-12"
}

200Success

{
  "entryId": "text",
  "externalId": "text",
  "customerId": "text",
  "userId": "text",
  "creationMethod": "async",
  "releasedBy": "text",
  "createdBy": "text",
  "workDate": "2022-08-12",
  "createdAt": "2022-08-12T20:44:48Z",
  "updatedAt": "2022-08-12T20:44:48Z",
  "initiativeExternalId": "text",
  "clientExternalId": "text",
  "summary": "text",
  "unitIncrementCount": 1,
  "incrementDurationInSeconds": 1,
  "lastReleasePendingAt": "2022-08-12T20:44:48Z",
  "lastReleaseFailedAt": "2022-08-12T20:44:48Z",
  "releaseSuccessAt": "2022-08-12T20:44:48Z",
  "isDeleted": true,
  "notes": "text",
  "releaseCount": 1,
  "lastSyncedAt": "2022-08-12T20:44:48Z",
  "codes": [
    {
      "codeExternalId": "text",
      "codeTypeExternalId": "text"
    }
  ]
}

delete

Authorizations

ApiBearerAuth

AuthorizationstringRequired

Enter access token

Path parameters

customerIdstring · objectidRequired

customer's id

userIdstring · objectidRequired

user's id

entryIdstring · objectidRequired

Responses

200Success

application/json

_idstring · objectidRequired

entry's id

customerIdstring · objectidRequired

id of customer who the owner belongs to

userIdstring · objectidRequired

if of user who owns the entry

enrichmentCorrelationIdstringOptional

entry's enrichmentCorrelationId to be used by enrichment service

statusInfoone ofRequired

entry's status info

or

or

or

or

or

creationMethodstring · enumRequired

the creation method of the entry

Possible values:

createdAsTimerbooleanOptional

if true, this entry was created by a user for use as a timer

workDatestring · iso-dateOptional

the date this entry is released to

Example: 2022-08-12

isLockedbooleanRequired

if true, this entry is locked and cannot be updated

summarystringRequired

entry's summary

unitIncrementCountFromSourcesnumber · doubleRequired

sum of unit increments from this entry's sources

unitIncrementCountAdjustmentsnumber · doubleRequired

user modified overrides to entry unit increment total

incrementDurationInSecondsnumber · doubleRequired

entry duration in seconds

initiativePropsone ofRequired

is entry's initiative

or

externalIdstringOptional

entry's external id

createdAtstring · iso-date-timeRequired

date and time this entry was created

Example: 2022-08-12T20:44:48Z

updatedAtstring · iso-date-timeRequired

date and time this entry was updated last

Example: 2022-08-12T20:44:48Z

hasOverlapbooleanOptional

entry's overlap state

overlapTimeInSecondsnumber · int64Optional

entry's duration in seconds with overlap

isDeletedbooleanOptional

is entry soft deleted

notesstringOptional

entry's notes

releaseCountnumber · int64Optional

entry's release count

lastSyncedAtstring · iso-date-timeOptional

date and time when the entry was last synced with the PMS

Example: 2022-08-12T20:44:48Z

timerDurationAdjustmentInSecondsnumber · int64Optional

adjustment in seconds to be applied to timer duration

delete

/api/v1/public/customers/{customerId}/users/{userId}/entries/{entryId}

HTTPcURLJavaScriptPython

DELETE /api/v1/public/customers/{customerId}/users/{userId}/entries/{entryId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "_id": "text",
  "customerId": "text",
  "userId": "text",
  "enrichmentCorrelationId": "text",
  "statusInfo": {
    "status": "release-failed",
    "releaseFailedErrors": [
      {
        "originalMessage": "text",
        "title": "text",
        "description": "text"
      }
    ]
  },
  "creationMethod": "async",
  "createdAsTimer": true,
  "workDate": "2022-08-12",
  "isLocked": true,
  "summary": "text",
  "unitIncrementCountFromSources": 1,
  "unitIncrementCountAdjustments": 1,
  "incrementDurationInSeconds": 1,
  "initiativeProps": {
    "type": "pms",
    "colorHex": "fec828",
    "tags": [
      "pinned"
    ],
    "nickname": "text",
    "initiative": {
      "type": "pms",
      "_id": "text",
      "billingType": "billable",
      "callSign": "text",
      "unitIncrements": 1,
      "externalId": "text",
      "name": "text",
      "description": "text",
      "client": {
        "_id": "text",
        "externalId": "text",
        "name": "text",
        "description": "text",
        "callSign": "text"
      }
    }
  },
  "workCodes": [
    {
      "assignedBy": "user",
      "code": {
        "_id": "text",
        "externalId": "text",
        "name": "text",
        "description": "text",
        "type": {
          "_id": "text",
          "externalId": "text",
          "name": "text",
          "semanticType": "action"
        }
      }
    }
  ],
  "sources": [
    [
      {
        "_id": "text",
        "type": "activity",
        "creationMethod": "timer",
        "category": "call",
        "technology": "zoom",
        "title": "text",
        "detail": "text",
        "startedAt": "2022-08-12T20:44:48Z",
        "stoppedAt": "2022-08-12T20:44:48Z",
        "clusterId": "text",
        "hasOverlap": true,
        "overlapTimeInSeconds": 1,
        "threadId": "text"
      }
    ]
  ],
  "externalId": "text",
  "createdAt": "2022-08-12T20:44:48Z",
  "updatedAt": "2022-08-12T20:44:48Z",
  "hasOverlap": true,
  "overlapTimeInSeconds": 1,
  "isDeleted": true,
  "notes": "text",
  "releaseCount": 1,
  "lastSyncedAt": "2022-08-12T20:44:48Z",
  "timerDurationAdjustmentInSeconds": 1,
  "complianceRules": [
    {
      "ruleKey": "text",
      "description": "text",
      "enforcementLevel": "block"
    }
  ]
}

Deprecated

get

Authorizations

ApiBearerAuth

AuthorizationstringRequired

Enter access token

Path parameters

customerIdstring · objectidRequired

customer id

Query parameters

updatedAfterstring · iso-date-timeRequired

the date after which the Entry was updated

Example: 2022-08-12T20:44:48Z

updatedOnOrBeforestring · iso-date-timeRequired

the date on or before which the Entry was updated

Example: 2022-08-12T20:44:48Z

Responses

200Success

application/json

entryIdstring · objectidRequired

entry's id

externalIdstringOptional

entry's external id

customerIdstring · objectidRequired

id of customer who the owner belongs to

userIdstring · objectidRequired

user who owns the entry

creationMethodstring · enumRequired

the creation method of the entry

Possible values:

releasedBystring · objectidOptional

the identifier of the user who released the entry

createdBystring · objectidOptional

the identifier of the user who created the entry

workDatestring · iso-dateOptional

the date this entry is released to

Example: 2022-08-12

createdAtstring · iso-date-timeRequired

date and time this entry was created

Example: 2022-08-12T20:44:48Z

updatedAtstring · iso-date-timeRequired

date and time this entry was updated last

Example: 2022-08-12T20:44:48Z

initiativeExternalIdstringRequired

entry's initiative external Id

clientExternalIdstringRequired

initiative's client external Id

summarystringRequired

entry's summary

unitIncrementCountnumber · int64Required

sum of unit increments from this entry's sources and adjustments

incrementDurationInSecondsnumber · int64Required

entry duration in seconds

lastReleasePendingAtstring · iso-date-timeOptional

last date and time this entry was release pended

Example: 2022-08-12T20:44:48Z

lastReleaseFailedAtstring · iso-date-timeOptional

last date and time this entry was release failed

Example: 2022-08-12T20:44:48Z

releaseSuccessAtstring · iso-date-timeOptional

date and time this entry was released successfully

Example: 2022-08-12T20:44:48Z

isDeletedbooleanOptional

is entry soft deleted

notesstringOptional

entry's notes

releaseCountnumber · int64Optional

lastSyncedAtstring · iso-date-timeOptional

date and time when the entry was last synced with the PMS

Example: 2022-08-12T20:44:48Z

get

/api/v1/customers/{customerId}/entries

HTTPcURLJavaScriptPython

GET /api/v1/customers/{customerId}/entries?updatedAfter=2022-08-12T20%3A44%3A48Z&updatedOnOrBefore=2022-08-12T20%3A44%3A48Z HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

[
  {
    "entryId": "text",
    "externalId": "text",
    "customerId": "text",
    "userId": "text",
    "creationMethod": "async",
    "releasedBy": "text",
    "createdBy": "text",
    "workDate": "2022-08-12",
    "createdAt": "2022-08-12T20:44:48Z",
    "updatedAt": "2022-08-12T20:44:48Z",
    "initiativeExternalId": "text",
    "clientExternalId": "text",
    "summary": "text",
    "unitIncrementCount": 1,
    "incrementDurationInSeconds": 1,
    "lastReleasePendingAt": "2022-08-12T20:44:48Z",
    "lastReleaseFailedAt": "2022-08-12T20:44:48Z",
    "releaseSuccessAt": "2022-08-12T20:44:48Z",
    "isDeleted": true,
    "notes": "text",
    "releaseCount": 1,
    "lastSyncedAt": "2022-08-12T20:44:48Z",
    "codes": [
      {
        "codeExternalId": "text",
        "codeTypeExternalId": "text"
      }
    ]
  }
]

get

Authorizations

ApiBearerAuth

AuthorizationstringRequired

Enter access token

Path parameters

customerIdstring · objectidRequired

customer id

Query parameters

updatedAfterstring · iso-date-timeRequired

the date after which the Entry was updated

Example: 2022-08-12T20:44:48Z

updatedOnOrBeforestring · iso-date-timeRequired

the date on or before which the Entry was updated

Example: 2022-08-12T20:44:48Z

pageSizenumber · int64 · min: 1 · max: 100Optional

max number of item in each page

cursorstring · objectidOptional

cursor to start from

Responses

200Success

application/json

nextCursorstringOptional

get

/api/v2/customers/{customerId}/entries

HTTPcURLJavaScriptPython

GET /api/v2/customers/{customerId}/entries?updatedAfter=2022-08-12T20%3A44%3A48Z&updatedOnOrBefore=2022-08-12T20%3A44%3A48Z HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "items": [
    {
      "entryId": "text",
      "externalId": "text",
      "customerId": "text",
      "userId": "text",
      "creationMethod": "async",
      "releasedBy": "text",
      "createdBy": "text",
      "workDate": "2022-08-12",
      "createdAt": "2022-08-12T20:44:48Z",
      "updatedAt": "2022-08-12T20:44:48Z",
      "initiativeExternalId": "text",
      "clientExternalId": "text",
      "summary": "text",
      "unitIncrementCount": 1,
      "incrementDurationInSeconds": 1,
      "lastReleasePendingAt": "2022-08-12T20:44:48Z",
      "lastReleaseFailedAt": "2022-08-12T20:44:48Z",
      "releaseSuccessAt": "2022-08-12T20:44:48Z",
      "isDeleted": true,
      "notes": "text",
      "releaseCount": 1,
      "lastSyncedAt": "2022-08-12T20:44:48Z",
      "codes": [
        {
          "codeExternalId": "text",
          "codeTypeExternalId": "text"
        }
      ]
    }
  ],
  "nextCursor": "text"
}

get

Authorizations

ApiBearerAuth

AuthorizationstringRequired

Enter access token

Path parameters

customerIdstring · objectidRequired

customer id

Query parameters

releasedAfterstring · iso-date-timeRequired

the date after which the Entry was released

Example: 2022-08-12T20:44:48Z

releasedOnOrBeforestring · iso-date-timeRequired

the date on or before which the Entry was released

Example: 2022-08-12T20:44:48Z

Responses

200Success

application/json

_idstring · objectidRequired

entry's id

customerIdstring · objectidRequired

id of customer who the owner belongs to

userIdstring · objectidRequired

if of user who owns the entry

workDatestring · iso-dateRequired

the date this entry is released to

Example: 2022-08-12

summarystringRequired

entry's summary

unitIncrementCountnumber · doubleRequired

sum of unit increments from this entry's sources and adjustments

incrementDurationInSecondsnumber · doubleRequired

entry duration in seconds

initiativePropsone ofRequired

is entry's initiative

or

externalIdstringOptional

entry's external id

notesstringOptional

entry's notes

releaseCountnumber · int64Optional

entry's release count

lastSyncedAtstring · iso-dateOptional

date and time when the entry was last synced with the PMS

Example: 2022-08-12

get

/api/v1/customers/{customerId}/entries/export

HTTPcURLJavaScriptPython

GET /api/v1/customers/{customerId}/entries/export?releasedAfter=2022-08-12T20%3A44%3A48Z&releasedOnOrBefore=2022-08-12T20%3A44%3A48Z HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

[
  {
    "_id": "text",
    "customerId": "text",
    "userId": "text",
    "workDate": "2022-08-12",
    "summary": "text",
    "unitIncrementCount": 1,
    "incrementDurationInSeconds": 1,
    "initiativeProps": {
      "type": "pms",
      "colorHex": "fec828",
      "tags": [
        "pinned"
      ],
      "nickname": "text",
      "initiative": {
        "type": "pms",
        "_id": "text",
        "billingType": "billable",
        "callSign": "text",
        "unitIncrements": 1,
        "externalId": "text",
        "name": "text",
        "description": "text",
        "client": {
          "_id": "text",
          "externalId": "text",
          "name": "text",
          "description": "text",
          "callSign": "text"
        }
      }
    },
    "externalId": "text",
    "notes": "text",
    "releaseCount": 1,
    "lastSyncedAt": "2022-08-12",
    "codes": [
      {
        "_id": "text",
        "externalId": "text",
        "name": "text",
        "description": "text",
        "type": {
          "_id": "text",
          "externalId": "text",
          "name": "text",
          "semanticType": "action"
        }
      }
    ]
  }
]

get

Authorizations

ApiBearerAuth

AuthorizationstringRequired

Enter access token

Path parameters

customerIdstring · objectidRequired

customer id

Query parameters

releasedAfterstring · iso-date-timeRequired

the date after which the Entry was released

Example: 2022-08-12T20:44:48Z

releasedOnOrBeforestring · iso-date-timeRequired

the date on or before which the Entry was released

Example: 2022-08-12T20:44:48Z

Responses

200Success

No content

get

/api/v2/customers/{customerId}/entries/export

HTTPcURLJavaScriptPython

GET /api/v2/customers/{customerId}/entries/export?releasedAfter=2022-08-12T20%3A44%3A48Z&releasedOnOrBefore=2022-08-12T20%3A44%3A48Z HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

No content

post

Authorizations

ApiBearerAuth

AuthorizationstringRequired

Enter access token

Path parameters

customerIdstring · objectidRequired

customer id

Body

application/json

Responses

207Success

application/json

post

/api/v1/customers/{customerId}/entries/release-succeeded/batch

HTTPcURLJavaScriptPython

POST /api/v1/customers/{customerId}/entries/release-succeeded/batch HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 103

{
  "request": [
    {
      "entryId": "text",
      "userId": "text",
      "externalId": "text",
      "reReleaseFailedMessages": [
        "text"
      ]
    }
  ]
}

207Success

{
  "response": [
    {
      "entryId": "text",
      "status": "CONTINUE",
      "errorMessage": "text",
      "errorCode": 1
    }
  ]
}

post

Authorizations

ApiBearerAuth

AuthorizationstringRequired

Enter access token

Path parameters

customerIdstring · objectidRequired

customer's id

userIdstring · objectidRequired

user's id

entryIdstring · objectidRequired

individual entry id

Body

application/json

externalIdstringOptional

entry's external id from billing system

reReleaseFailedMessagesstring[]Optional

list of errors from re-release attempt

Responses

200Success

No content

post

/api/v1/customers/{customerId}/users/{userId}/entries/{entryId}/release-succeeded

HTTPcURLJavaScriptPython

POST /api/v1/customers/{customerId}/users/{userId}/entries/{entryId}/release-succeeded HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "externalId": "text",
  "reReleaseFailedMessages": [
    "text"
  ]
}

200Success

No content

post

Authorizations

ApiBearerAuth

AuthorizationstringRequired

Enter access token

Path parameters

customerIdstring · objectidRequired

customer's id

userIdstring · objectidRequired

user's id

entryIdstring · objectidRequired

individual entry id

Body

application/json

errorsstring[]Required

list of errors

Responses

200Success

No content

post

/api/v1/customers/{customerId}/users/{userId}/entries/{entryId}/release-failed

HTTPcURLJavaScriptPython

POST /api/v1/customers/{customerId}/users/{userId}/entries/{entryId}/release-failed HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "errors": [
    "text"
  ]
}

200Success

No content