Employee Budgets

Endpoints for Employee Budgets addon

Employee Budgets addon

List budget period types

post

Authorizations

ApiKey

sw-context-tokenstringRequired

Responses

200Success

No content

post

/budget-period-types

HTTPcURLJavaScriptPython

POST /budget-period-types HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*

200Success

No content

List employee budgets

get

Responses

200Success

No content

get

/b2b/employee-budget

HTTPcURLJavaScriptPython

GET /b2b/employee-budget HTTP/1.1
Accept: */*

200Success

No content

List employees

get

Authorizations

ApiKey

sw-context-tokenstringRequired

Responses

200Success

No content

get

/budget-approval-employees

HTTPcURLJavaScriptPython

GET /budget-approval-employees HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*

200Success

No content

Save a Budget

post

This route is used to create a new Budget

Body

application/json

anyOptional

Responses

200

Returns a success response indicating a successful update

application/json

anyOptional

post

/budget

HTTPcURLJavaScriptPython

POST /budget HTTP/1.1
Content-Type: application/json
Accept: */*

200

Returns a success response indicating a successful update

No content

Fetch a Budget

get

Path parameters

BudgetIdstringRequired

ID of a Budget

Responses

200Success

No content

get

/budget/{id}

HTTPcURLJavaScriptPython

GET /budget/{id} HTTP/1.1
Accept: */*

200Success

No content

Update a Budget

put

Path parameters

BudgetIdstringRequired

ID of Budget

Body

application/json

anyOptional

Responses

200

Returns a success response indicating a successful update

application/json

anyOptional

put

/budget/{id}

HTTPcURLJavaScriptPython

PUT /budget/{id} HTTP/1.1
Content-Type: application/json
Accept: */*

200

Returns a success response indicating a successful update

No content

Delete a Budget

delete

Path parameters

BudgetIdstringRequired

ID of Budget

Responses

200

Returns a success response indicating a successful update

application/json

anyOptional

delete

/budget/{id}

HTTPcURLJavaScriptPython

DELETE /budget/{id} HTTP/1.1
Accept: */*

200

Returns a success response indicating a successful update

No content

Update a Budget

patch

Path parameters

BudgetIdstringRequired

ID of Budget

Body

application/json

anyOptional

Responses

200

Returns a success response indicating a successful update

application/json

anyOptional

patch

/budget/{id}

HTTPcURLJavaScriptPython

PATCH /budget/{id} HTTP/1.1
Content-Type: application/json
Accept: */*

200

Returns a success response indicating a successful update

No content

List Budgets

post

Authorizations

ApiKey

sw-context-tokenstringRequired

Body

application/json

anyOptional

Responses

200Success

No content

post

/budget/list

HTTPcURLJavaScriptPython

POST /budget/list HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200Success

No content

List Budget Orders

get

Get all orders that use the specified budget

Authorizations

ApiKey

sw-context-tokenstringRequired

Path parameters

budgetIdstringRequired

ID of the Budget

Responses

200

Returns a list of orders that use the specified budget

application/json

totalintegerRequired

Total number of orders

get

/budget/{budgetId}/orders

HTTPcURLJavaScriptPython

GET /budget/{budgetId}/orders HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*

200

Returns a list of orders that use the specified budget

{
  "orders": [
    {
      "id": "text",
      "orderNumber": "text",
      "orderDate": "2026-03-17T01:03:20.087Z",
      "stateMachineState": null,
      "currency": null,
      "totalPrice": 1,
      "netPrice": 1,
      "taxAmount": 1,
      "billingAddress": null,
      "orderCustomer": null,
      "deliveries": [],
      "transactions": [],
      "lineItems": [],
      "documents": [],
      "budgetData": {
        "budgetId": "text",
        "budgetLineItems": [],
        "budgetProductCount": 1,
        "totalProductCount": 1,
        "budgetValue": 1,
        "totalOrderValue": 1,
        "budgetUsagePercentage": 1,
        "budgetProductRatio": "text"
      }
    }
  ],
  "total": 1
}

List Budget Orders with Criteria

post

Get all orders that use the specified budget with search criteria

Authorizations

ApiKey

sw-context-tokenstringRequired

Path parameters

budgetIdstringRequired

ID of the Budget

Body

application/json

anyOptional

Responses

200

Returns a list of orders that use the specified budget

application/json

totalintegerRequired

Total number of orders

post

/budget/{budgetId}/orders

HTTPcURLJavaScriptPython

POST /budget/{budgetId}/orders HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

Returns a list of orders that use the specified budget

{
  "orders": [
    {
      "id": "text",
      "orderNumber": "text",
      "orderDate": "2026-03-17T01:03:20.087Z",
      "stateMachineState": null,
      "currency": null,
      "totalPrice": 1,
      "netPrice": 1,
      "taxAmount": 1,
      "billingAddress": null,
      "orderCustomer": null,
      "deliveries": [],
      "transactions": [],
      "lineItems": [],
      "documents": [],
      "budgetData": {
        "budgetId": "text",
        "budgetLineItems": [],
        "budgetProductCount": 1,
        "totalProductCount": 1,
        "budgetValue": 1,
        "totalOrderValue": 1,
        "budgetUsagePercentage": 1,
        "budgetProductRatio": "text"
      }
    }
  ],
  "total": 1
}