Budgets

Create Budget

Creates a budget.

POST

/budgets

Create Budget

curl --request POST \
  --url https://api.operating.app/v1/budgets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": {
    "amount": 123,
    "currency": "default"
  },
  "description": "<string>",
  "from": "<string>",
  "name": "<string>",
  "projectId": "<string>",
  "through": "<string>"
}
'

{
  "data": {
    "amount": {
      "amount": 123,
      "currency": "default"
    },
    "createdAt": "<string>",
    "description": "<string>",
    "externallyInvoiced": true,
    "from": "<string>",
    "id": "<string>",
    "name": "<string>",
    "projectId": "<string>",
    "through": "<string>",
    "updatedAt": "<string>"
  },
  "meta": {}
}

Authorizations

Authorizationstringheaderrequired

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

Body

amountobjectrequired

The amount of the budget.

Show child attributes

descriptionstring | null

The description of the budget.

Maximum string length: 5000

fromstringrequired

The start date of the budget.

namestringrequired

The name of the budget.

projectIdstringrequired

The project this budget is for.

throughstringrequired

The end date of the budget.

Response

Successful response

dataobjectrequired

Show child attributes

metaobjectrequired

Still need help? Ask the team