budgets

Embed

<a href="https://hermetica.15.204.158.166.sslip.io/docs/ref-budgets"><img src="https://hermetica.15.204.158.166.sslip.io/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/8c464ba4-c2c8-4b18-a915-cdaa015d8560/social-card.svg?v=3e7ae33eec8b" alt="budgets" width="600" height="315"></a>

GEThttps://hermetica.15.204.158.166.sslip.io/v1/budgets

Parameters

campaignRefstringquery

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/budgets" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "campaignRef": "string",
      "currency": "string",
      "amountMinor": 0,
      "startsOn": "string",
      "endsOn": "string",
      "notes": "string",
      "spentMinor": 0,
      "remainingMinor": 0,
      "overBudget": true,
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

namestringrequired

campaignRefstringrequired

currencystringrequired

amountMinorintegerrequired

startsOnstringrequired

endsOnstringrequired

notesstringrequired

spentMinorintegerrequired

remainingMinorintegerrequired

overBudgetbooleanrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · GET /v1/budgets

POSThttps://hermetica.15.204.158.166.sslip.io/v1/budgets

Request body

application/json

namestringrequired

campaignRefstring

currencystring

= USD

amountMinorintegerrequired

startsOnstring

endsOnstring

notesstring

{
  "name": "string",
  "campaignRef": "string",
  "currency": "USD",
  "amountMinor": 0,
  "startsOn": "string",
  "endsOn": "string",
  "notes": "string"
}

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/budgets" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","campaignRef":"string","currency":"USD","amountMinor":0,"startsOn":"string","endsOn":"string","notes":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "name": "string",
  "campaignRef": "string",
  "currency": "string",
  "amountMinor": 0,
  "startsOn": "string",
  "endsOn": "string",
  "notes": "string",
  "spentMinor": 0,
  "remainingMinor": 0,
  "overBudget": true,
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

namestringrequired

campaignRefstringrequired

currencystringrequired

amountMinorintegerrequired

startsOnstringrequired

endsOnstringrequired

notesstringrequired

spentMinorintegerrequired

remainingMinorintegerrequired

overBudgetbooleanrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/budgets

5XX Default Response

Same as 4XX · GET /v1/budgets

GEThttps://hermetica.15.204.158.166.sslip.io/v1/budgets/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/budgets/{id}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/budgets

4XX Default Response

Same as 4XX · GET /v1/budgets

5XX Default Response

Same as 4XX · GET /v1/budgets

DELETEhttps://hermetica.15.204.158.166.sslip.io/v1/budgets/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermetica.15.204.158.166.sslip.io/v1/budgets/{id}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · GET /v1/budgets

5XX Default Response

Same as 4XX · GET /v1/budgets

PATCHhttps://hermetica.15.204.158.166.sslip.io/v1/budgets/{id}

Parameters

idstringpathrequired

Request body

application/json

namestring

campaignRefstring

currencystring

amountMinorinteger

startsOnstring

endsOnstring

notesstring

{
  "name": "string",
  "campaignRef": "string",
  "currency": "string",
  "amountMinor": 0,
  "startsOn": "string",
  "endsOn": "string",
  "notes": "string"
}

Code samples

cURL

curl -X PATCH "https://hermetica.15.204.158.166.sslip.io/v1/budgets/{id}" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","campaignRef":"string","currency":"string","amountMinor":0,"startsOn":"string","endsOn":"string","notes":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/budgets

4XX Default Response

Same as 4XX · GET /v1/budgets

5XX Default Response

Same as 4XX · GET /v1/budgets

GEThttps://hermetica.15.204.158.166.sslip.io/v1/budgets/{id}/spend

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/budgets/{id}/spend" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "budgetId": "string",
      "amountMinor": 0,
      "spentOn": "string",
      "description": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

budgetIdstringrequired

amountMinorintegerrequired

spentOnstringrequired

descriptionstringrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/budgets

5XX Default Response

Same as 4XX · GET /v1/budgets

POSThttps://hermetica.15.204.158.166.sslip.io/v1/budgets/{id}/spend

Record a cost against a budget; repeating the same idempotencyKey returns the original line

Parameters

idstringpathrequired

Request body

application/json

amountMinorintegerrequired

spentOnstringrequired

descriptionstring

idempotencyKeystringrequired

{
  "amountMinor": 0,
  "spentOn": "string",
  "description": "string",
  "idempotencyKey": "string"
}

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/budgets/{id}/spend" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"amountMinor":0,"spentOn":"string","description":"string","idempotencyKey":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "budgetId": "string",
  "amountMinor": 0,
  "spentOn": "string",
  "description": "string",
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

budgetIdstringrequired

amountMinorintegerrequired

spentOnstringrequired

descriptionstringrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/budgets

5XX Default Response

Same as 4XX · GET /v1/budgets

GEThttps://hermetica.15.204.158.166.sslip.io/v1/budgets/{id}/spend/{spendId}

Parameters

idstringpathrequired

spendIdstringpathrequired

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/budgets/{id}/spend/{spendId}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/budgets/{id}/spend

4XX Default Response

Same as 4XX · GET /v1/budgets

5XX Default Response

Same as 4XX · GET /v1/budgets

DELETEhttps://hermetica.15.204.158.166.sslip.io/v1/budgets/{id}/spend/{spendId}

Parameters

idstringpathrequired

spendIdstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermetica.15.204.158.166.sslip.io/v1/budgets/{id}/spend/{spendId}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/budgets/{id}

4XX Default Response

Same as 4XX · GET /v1/budgets

5XX Default Response

Same as 4XX · GET /v1/budgets

PATCHhttps://hermetica.15.204.158.166.sslip.io/v1/budgets/{id}/spend/{spendId}

Correct a cost line in place

Parameters

idstringpathrequired

spendIdstringpathrequired

Request body

application/json

amountMinorinteger

spentOnstring

descriptionstring

{
  "amountMinor": 0,
  "spentOn": "string",
  "description": "string"
}

Code samples

cURL

curl -X PATCH "https://hermetica.15.204.158.166.sslip.io/v1/budgets/{id}/spend/{spendId}" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"amountMinor":0,"spentOn":"string","description":"string"}'

TypeScript

Python

PHP

Ruby

Java