Kantata Kantata OX Knowledge Base
Release Notes
Kantata OX Release Notes API Breaking Changes
Status Page
Kantata OX API Documentation

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.

Creating a new Workspace Invoice Preference

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.

Request
Request Body schema: application/json
required
object
workspace_id
required
integer <int32>

The ID of the project for which the invoice preferences will apply.

purchase_order
string

The invoice purchase order (defined by the user).

project_code
string

The invoice project code (defined by the user).

client_invoice_name
string

The name of the client being invoiced.

client_invoice_address
string

The address of the client being invoiced.

consultant_invoice_name
string

The name of the provider who is sending the invoice.

consultant_invoice_address
string

The address of the provider who is sending the invoice.

Responses
200

Workspace Invoice Preference has been created.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

post/workspace_invoice_preferences
Request samples
application/json
{
  • "workspace_invoice_preference": {
    }
}
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "workspace_invoice_preferences": {
    }
}

Fetching a single Workspace Invoice Preference

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.

Request
path Parameters
id
required
integer

The ID of the Model.

Responses
200

The Workspace Invoice Preference has been retrieved.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/workspace_invoice_preferences/{id}
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "workspace_invoice_preferences": {
    }
}
Updating an existing Workspace Invoice Preference
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.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
Request Body schema: application/json
required
object
 
purchase_order
string
The invoice purchase order (defined by the user).


 
project_code
string
The invoice project code (defined by the user).


 
client_invoice_name
string
The name of the client being invoiced.


 
client_invoice_address
string
The address of the client being invoiced.


 
consultant_invoice_name
string
The name of the provider who is sending the invoice.


 
consultant_invoice_address
string
The address of the provider who is sending the invoice.


 
Responses 
200
Workspace Invoice Preference has been updated.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


put/workspace_invoice_preferences/{id}
Request samples 
application/json
{
  • "workspace_invoice_preference": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "workspace_invoice_preferences": {
    }
}
➔ Next to Users