post/project-statementsWrite operation

Create a project statement

Use this operation to create a project statement. The server validates the complete payload and derives workspace ownership from the authenticated credential. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request. Use a stable Idempotency-Key when retrying so a transport timeout cannot create duplicate work. Finance-protected fields are omitted or rejected unless the credential also has the documented finance scope.

Required scopes

project-statements:write

Request example

curl --request POST \
  --url 'https://api.de.teamgrid.app/v1/project-statements' \
  --header 'Authorization: Bearer $TEAMGRID_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "amount": null,
    "comment": null,
    "count": null,
    "date": "2026-07-29T09:00:00.000Z",
    "description": null,
    "isCharge": false,
    "productNumber": null,
    "purchasePrice": null,
    "title": "string",
    "projectId": "string",
    "productId": null,
    "type": "manual"
  }'

const response = await fetch('https://api.de.teamgrid.app/v1/project-statements', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "amount": null,
  "comment": null,
  "count": null,
  "date": "2026-07-29T09:00:00.000Z",
  "description": null,
  "isCharge": false,
  "productNumber": null,
  "purchasePrice": null,
  "title": "string",
  "projectId": "string",
  "productId": null,
  "type": "manual"
}),
})

const result = await response.json()

type ApiResponse = unknown

const response = await fetch('https://api.de.teamgrid.app/v1/project-statements', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "amount": null,
  "comment": null,
  "count": null,
  "date": "2026-07-29T09:00:00.000Z",
  "description": null,
  "isCharge": false,
  "productNumber": null,
  "purchasePrice": null,
  "title": "string",
  "projectId": "string",
  "productId": null,
  "type": "manual"
}),
})

const result: ApiResponse = await response.json()

teamgrid project-statements create \
  --data @payload.json \
  --idempotency-key REQUEST_KEY

Example response 2xx

{
  "data": {
    "attributes": {
      "amount": null,
      "archived": false,
      "comment": "string",
      "count": null,
      "createdAt": "2026-07-29T09:00:00.000Z",
      "date": "2026-07-29T09:00:00.000Z",
      "description": "string",
      "isCharge": false,
      "productId": null,
      "productNumber": null,
      "projectId": null,
      "purchasePrice": null
    },
    "id": "string",
    "type": "string"
  },
  "meta": {
    "requestId": "string"
  }
}

EndpointGerman region

Interactive request builder

Prepare this request

Build locally · nothing is sent

Region

Credential variable

Idempotency-Keyheader · required

JSON request bodyValid JSON

Generated cURL

The builder does not execute requests or persist credentials. Replace the environment-variable placeholder only in your terminal or secret-aware runtime.

Headers

Idempotency-Keyrequired

string

Unique request key retained for seven days. Within that window, reuse with different data is rejected.

Request body

application/json

amount

numbernullable

The amount associated with this project statement.

comment

stringnullable

The comment associated with this project statement.

count

integernullable

The count associated with this project statement.

daterequired

stringdate-time

ISO 8601 timestamp for date.

description

stringnullable

Human-readable description of the resource.

isChargerequired

boolean

Whether is charge applies to this project statement.

productNumber

stringnullable

The product number associated with this project statement.

purchasePrice

numbernullable

Requires project-statements:finance:write when supplied.

titlerequired

string

Human-readable title of the resource.

projectIdrequired

string

Identifier of the related project.

productId

stringnullable

The product id associated with this project statement.

typerequired

string

Canonical type discriminator for this resource.

manualproduct

Responses

200An idempotent replay of an existing resource.application/json

Response schemaapplication/json

required

ProjectStatement

Budget statements and purchasePrice are finance-gated. Internal workflow, order, cart, and budget-rollup fields are never part of this public DTO.

required

ResponseMeta

Public API representation of meta.

201The request to create a project statement created the resource. The response contains its canonical public representation and request metadata.application/json

Response schemaapplication/json

required

ProjectStatement

Budget statements and purchasePrice are finance-gated. Internal workflow, order, cart, and budget-rollup fields are never part of this public DTO.

required

ResponseMeta

Public API representation of meta.

400The request is invalid.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

401The bearer credential is missing, invalid, expired, or revoked.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

403The credential has insufficient scope.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

409The request conflicts with the current resource state.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

429The credential or source exceeded its rate limit.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

502The cell-local application returned an invalid response.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

503A required cell-local dependency is unavailable.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

Operation IDcreateProjectStatementOpenAPI JSON ↗

Documentation feedbackWas this page useful?