TRANXACT.AI Help

CRM · Forecasting & Quotas

Forecast Board

Quota, closed, commit, best case and pipeline for you and the people who report to you: attainment, weighted pipeline and coverage, your call for the period, and how past calls compared with what closed.

Type REST7 operationsBase path /api/crm/forecast-board

Download specification (OpenAPI 3.1) Screen: Forecast Board

Overview

PackageCRM
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold CRM › Forecast Board on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

7 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/crm/forecast-boardRead forecast board

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/crm/forecast-board" \
  -H "Authorization: Bearer $TOKEN"
GET/api/crm/forecast-board/dealsDeals

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/crm/forecast-board/deals" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/forecast-board/submitSubmit

Request body

The keys this action reads (* = required; "one of" lists the only values):

periodId*, forecastCommit, forecastBestCase, notes

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/forecast-board/submit" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"periodId":"value","forecastCommit":"value","forecastBestCase":"value","notes":"value"}'
POST/api/crm/forecast-board/roll-upRoll up

Request body

The keys this action reads (* = required; "one of" lists the only values):

periodId*, forecastCommit, forecastBestCase, notes

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/forecast-board/roll-up" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"periodId":"value","forecastCommit":"value","forecastBestCase":"value","notes":"value"}'
POST/api/crm/forecast-board/{id}/adjustAdjust

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

adjustedCommit, adjustedBestCase, note

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/forecast-board/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/adjust" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"adjustedCommit":"value","adjustedBestCase":"value","note":"value"}'
POST/api/crm/forecast-board/snapshotSnapshot

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/forecast-board/snapshot" \
  -H "Authorization: Bearer $TOKEN"
GET/api/crm/forecast-board/historyHistory

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/crm/forecast-board/history" \
  -H "Authorization: Bearer $TOKEN"

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold CRM › Forecast Board for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.