Workspace Invoice Preferences

Workspace Invoice Preferences specify the default values that are applied to new invoices created for the specified project. It is only used for projects that have financials enabled.

These preferences can only be created and updated by users who can manage invoice preferences on the project. This can be found by querying can_manage_invoice_preferences on Workspace.

Operations

Creating a new Workspace Invoice Preference

Request

This endpoint returns structured Workspace Invoice Preference objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the workspace_invoice_preferences top-level JSON key. Please see our Response Format section for more information.

Bodyapplication/jsonrequired

workspace_invoice_preferenceobject

POST

/workspace_invoice_preferences

{
  "workspace_invoice_preference": {
    "workspace_id": 0,
    "purchase_order": "string",
    "project_code": "string",
    "client_invoice_name": "string",
    "client_invoice_address": "string",
    "consultant_invoice_name": "string",
    "consultant_invoice_address": "string"
  }
}

Responses

Workspace Invoice Preference has been created.

Bodyapplication/json

countinteger, (int32)

metaobject

resultsArray of objects

workspace_invoice_preferencesobject

Response

{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "workspace_invoice_preferences": {
    "property1": {
      "client_invoice_address": "string",
      "client_invoice_name": "string",
      "consultant_invoice_address": "string",
      "consultant_invoice_name": "string",
      "project_code": "string",
      "purchase_order": "string",
      "workspace_id": 0
    },
    "property2": {
      "client_invoice_address": "string",
      "client_invoice_name": "string",
      "consultant_invoice_address": "string",
      "consultant_invoice_name": "string",
      "project_code": "string",
      "purchase_order": "string",
      "workspace_id": 0
    }
  }
}