Headers

• WEAL-TOKEN Required

  API token (can be retrieved from account settings)

• TARGET-ORGANIZATION-ID

  ID of organization, for which the operation must be performed

Query parameters

• pageNumber integer

  Page Number

  Default value is 1.

• sortingField string

  Field to sort by

• direction string

  Sorting direction

  Values are ASC or DESC. Default value is ASC.

• sizePerPage integer

  Size per page

  Default value is 60.

• id string

  Budget ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• fiscalYear integer(int32)

  Fiscal year filter

• name string

  Budget name filter

• reportType string

  Report type filter

  Values are PL or CASH_FLOW.

• status string

  Budget status filter

  Values are ACTIVE or INACTIVE.

• parent string

  Parent budget ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• articleId string

  Article ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• contactId string

  Contact ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• orderId string

  Order ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• departmentId string

  Department ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • id integer(int64)
  • organizationId integer(int64)
  • fiscalYear integer(int32)
  • name string
  • reportType string

    Values are PL or CASH_FLOW.

  • status string

    Values are ACTIVE or INACTIVE.

  • parent integer(int64)
  • articleId integer(int64)
  • contactId integer(int64)
  • orderId integer(int64)
  • departmentId integer(int64)
• 400

  400 Bad Request

• 401

  401 Unauthorized

• 403

  403 Access Denied

• 404

  404 Not Found

• 500

  500 Internal Server Error