Wyzio API documentation

Modify batch of budgets

PUT /api-v1/budget/batch

Headers

TARGET-ORGANIZATION-ID integer(int32)

ID of organization, for which the operation must be performed
WEAL-TOKEN string Required

API token (can be retrieved from account settings)

Body Required

budgets

article integer
contact integer
department integer
entries array[object]
Hide entries attributes Show entries attributes object
- chart integer
- date string(date-time)
- hasChildBudget boolean
- id integer
- newValue string
- reportLine integer
- total number
- value string
id integer
name string
orderId integer
parent integer
period object
Hide period attributes Show period attributes
- endDate string(date-time)
- fiscalYear integer(int32)
- id integer
- startDate string(date-time)
reportType string

Values are BALANCE_SHEET, PL, CASH_FLOW, or RATIOS.
status string

Values are ACTIVE or INACTIVE.
warnings string

Responses

• 200

OK
Hide response attribute Show response attribute object
- items array[object]
  
  Hide items attributes Show items attributes object
  
  error boolean
  
  errorCode object
  
  Hide errorCode attributes Show errorCode attributes
  
  errorCode string
  
  Values are NO_ERROR, NOT_IMPLEMENTED_YET, CONTACT_NOT_FOUND, FIELD_REQUIRED, VALIDATION_ERROR, DUPLICATION_ERROR, UNIQUE_CONSTRAINT_VIOLATION, WRONG_PASSWORD_FORMAT, WRONG_PASSWORD, ACTION_DENIED, NOT_FOUND, EXPECTED_ONE_FILE, UNIQUE_VIOLATION, CONTENT_EMPTY, INVALID_TYPE, CONVERSION_ERROR, FILE_PARSE_EXCEPTION, or IN_USE.
  
  errorDetailValues array[object]
  
  Hide errorDetailValues attributes Show errorDetailValues attributes object
  
  data string
  
  errorCode string
  
  fieldName string
  
  isSevere boolean
  
  freshData object
  
  freshRow object
  
  possibleWorkflows array[object]
  
  Hide possibleWorkflows attributes Show possibleWorkflows attributes object
  
  id integer
  
  name string
  
  severeError boolean
• 400

400 Bad Request
• 401

401 Unauthorized
• 403

403 Access Denied
• 404

404 Not Found
• 500

500 Internal Server Error

PUT /api-v1/budget/batch

curl \
 -X PUT http://wyzio.app/api-v1/budget/batch \
 -H "TARGET-ORGANIZATION-ID: 42" \
 -H "WEAL-TOKEN: string" \
 -d '[{"article":42,"contact":42,"department":42,"entries":[{"chart":42,"date":"2024-05-04T09:42:00+00:00","hasChildBudget":true,"id":42,"newValue":"string","reportLine":42,"total":42.0,"value":"string"}],"id":42,"name":"string","orderId":42,"parent":42,"period":{"endDate":"2024-05-04T09:42:00+00:00","fiscalYear":42,"id":42,"startDate":"2024-05-04T09:42:00+00:00"},"reportType":"BALANCE_SHEET","status":"ACTIVE","warnings":"string"}]'

Request example

# Headers
TARGET-ORGANIZATION-ID: 42
WEAL-TOKEN: string

# Payload
[
  {
    "article": 42,
    "contact": 42,
    "department": 42,
    "entries": [
      {
        "chart": 42,
        "date": "2024-05-04T09:42:00+00:00",
        "hasChildBudget": true,
        "id": 42,
        "newValue": "string",
        "reportLine": 42,
        "total": 42.0,
        "value": "string"
      }
    ],
    "id": 42,
    "name": "string",
    "orderId": 42,
    "parent": 42,
    "period": {
      "endDate": "2024-05-04T09:42:00+00:00",
      "fiscalYear": 42,
      "id": 42,
      "startDate": "2024-05-04T09:42:00+00:00"
    },
    "reportType": "BALANCE_SHEET",
    "status": "ACTIVE",
    "warnings": "string"
  }
]

Response examples (200)

{
  "items": [
    {
      "error": true,
      "errorCode": {
        "errorCode": "NO_ERROR",
        "errorDetailValues": [
          {
            "data": "string",
            "errorCode": "string",
            "fieldName": "string",
            "isSevere": true
          }
        ]
      },
      "freshData": {},
      "freshRow": {},
      "possibleWorkflows": [
        {
          "id": 42,
          "name": "string"
        }
      ],
      "severeError": true
    }
  ]
}