Modify enabled widgets

POST /api-v1/widget/batch

Headers

Body Required

widgets

  • contactId integer
  • filters string
  • height integer(int32)
  • id integer
  • isRemoved boolean
  • organizationId integer
  • templateNumber integer(int32)
  • type string

    Values are TREASURY, PL_STATEMENT, CASH_FLOW_STATEMENT, GROSS_MARGIN, NET_MARGIN, AVERAGE_RECEIVABLES, AVERAGE_PAYABLES, AVERAGE_WEIGHTED_RECEIVABLES, AVERAGE_WEIGHTED_PAYABLES, LIQUIDITY_RATIO, PAYABLES, VAT, INVOICES_FOR_REVIEW, CASH_FLOW_CHART, OUTSTANDING_RECEIVABLES, FUTURE_PAYABLES, INCOME_BREAKDOWN, EXPENSE_BREAKDOWN, MONTHLY_INCOME_EXPENSE, PURCHASE_INVOICE_SCANS_UPLOAD, INVOICE_SCANS, ANNUAL_EMPLOYEE_COUNT, NOTIFICATIONS, WORKING_CAPITAL_REQUIREMENT, DOCUMENT_SCANS, ALERTS_ON_REGISTRY_OF_COMMERCE, LINES_TO_BE_RECONCILED, or ACTIVE_USERS.

  • width integer(int32)
  • x integer(int32)
  • y integer(int32)

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • contactId integer
    • filters string
    • height integer(int32)
    • id integer
    • isRemoved boolean
    • organizationId integer
    • templateNumber integer(int32)
    • type string

      Values are TREASURY, PL_STATEMENT, CASH_FLOW_STATEMENT, GROSS_MARGIN, NET_MARGIN, AVERAGE_RECEIVABLES, AVERAGE_PAYABLES, AVERAGE_WEIGHTED_RECEIVABLES, AVERAGE_WEIGHTED_PAYABLES, LIQUIDITY_RATIO, PAYABLES, VAT, INVOICES_FOR_REVIEW, CASH_FLOW_CHART, OUTSTANDING_RECEIVABLES, FUTURE_PAYABLES, INCOME_BREAKDOWN, EXPENSE_BREAKDOWN, MONTHLY_INCOME_EXPENSE, PURCHASE_INVOICE_SCANS_UPLOAD, INVOICE_SCANS, ANNUAL_EMPLOYEE_COUNT, NOTIFICATIONS, WORKING_CAPITAL_REQUIREMENT, DOCUMENT_SCANS, ALERTS_ON_REGISTRY_OF_COMMERCE, LINES_TO_BE_RECONCILED, or ACTIVE_USERS.

    • width integer(int32)
    • x integer(int32)
    • y integer(int32)
  • 400

    400 Bad Request

  • 401

    401 Unauthorized

  • 403

    403 Access Denied

  • 404

    404 Not Found

  • 500

    500 Internal Server Error

POST /api-v1/widget/batch 
curl \
 -X POST http://10.10.10.132/api-v1/widget/batch \
 -H "TARGET-ORGANIZATION-ID: 42" \
 -H "WEAL-TOKEN: string" \
 -d '[{"contactId":42,"filters":"string","height":42,"id":42,"isRemoved":true,"organizationId":42,"templateNumber":42,"type":"TREASURY","width":42,"x":42,"y":42}]'
Request examples 
# Headers
TARGET-ORGANIZATION-ID: 42
WEAL-TOKEN: string

# Payload
[
  {
    "contactId": 42,
    "filters": "string",
    "height": 42,
    "id": 42,
    "isRemoved": true,
    "organizationId": 42,
    "templateNumber": 42,
    "type": "TREASURY",
    "width": 42,
    "x": 42,
    "y": 42
  }
]
Response examples (200) 
[
  {
    "contactId": 42,
    "filters": "string",
    "height": 42,
    "id": 42,
    "isRemoved": true,
    "organizationId": 42,
    "templateNumber": 42,
    "type": "TREASURY",
    "width": 42,
    "x": 42,
    "y": 42
  }
]