Budgets

Update Budget

Updates the budget with the given id.

PATCH

/budgets/{id}

Update Budget

curl --request PATCH \
  --url https://api.operating.app/v1/budgets/{id} \
  --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.

Path Parameters

idstringrequired

Body

amountobject

The amount of the budget.

Show child attributes

descriptionstring | null

The description of the budget.

Maximum string length: 5000

fromstring

The start date of the budget.

namestring

The name of the budget.

projectIdstring

The project this budget is for.

throughstring

The end date of the budget.

Response

Successful response

dataobjectrequired

Show child attributes

metaobjectrequired

Still need help? Ask the team