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

Client Invoice Defaults

Represents the default configuration for presenting invoices to clients.

Fetching a list of Client Invoice Defaults

This endpoint returns structured Client Invoice Defaults 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 client_invoice_defaults top-level JSON key. Please see our Response Format section for more information.

Request
query Parameters
client_user_id
integer <int32>

The user ID of the client.

only
string

Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like GET /api/v1/workspaces.json?only=5,6,7.

page
integer <int32>
Default: 1
per_page
integer <int32> <= 200
Default: 20
workspace_id
integer <int32>

The ID of the project for which you are creating the invoice.

Responses
200

A list of Client Invoice Defaults have 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/client_invoice_defaults
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "client_invoice_defaults": {
    }
}
Creating Client Invoice Defaults
This endpoint returns structured Client Invoice Defaults 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 client_invoice_defaults top-level JSON key.
Please see our Response Format section for more information.


Request 
Request Body schema: application/json
required
object
 
client_account_id
integer <int32> 
The user ID of the client being invoiced.


 
time_rollup_type
integer <int32> 
Options for how time is formatted on an invoice. These options include 'Detailed', 'Grouped by task',
and 'Grouped by person, then task'. They are represented by the numbers 0, 1, and 2, respectively.


 
expense_rollup_type
integer <int32> 
Options for how expenses are formatted on an invoice. These options include 'Detailed' and 'Grouped'.
They are represented by the numbers 0 and 1, respectively.


 
rich_text
string
The default rich text shown as additional details on the invoice.


 
show_project_names
integer <int32> 
Whether project names should be shown on the invoice.


 
show_task_names
boolean
Whether task names should be shown for invoice items.


 
show_subtotals
boolean
Whether subtotals should be shown for time entries on the invoice.


 
show_creators
boolean
Whether the name of the person who created the entry should be shown.


 
show_dates
boolean
Whether dates for items on the invoice should be shown.


 
show_notes
boolean
Whether notes for items on the invoice should be shown.


 
show_hours
boolean
Whether hours logged on a time entry on the invoice should be shown.


 
show_rates
boolean
Whether the rate for the item should be shown.


 
show_tax
boolean
Whether the item's taxable amount should be shown.


 
show_roles
boolean
Whether the role of the person who created the item should be shown.


 
Responses 
200
Client Invoice Defaults 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/client_invoice_defaults
Request samples 
application/json
{
  • "client_invoice_default": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "client_invoice_defaults": {
    }
}
Fetching Client Invoice Defaults by ID
This endpoint returns structured Client Invoice Defaults 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 client_invoice_defaults 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 Client Invoice Defaults 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/client_invoice_defaults/{id}
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "client_invoice_defaults": {
    }
}
Updating Client Invoice Defaults by ID
This endpoint returns structured Client Invoice Defaults 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 client_invoice_defaults 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
 
time_rollup_type
integer <int32> 
Options for how time is formatted on an invoice. These options include 'Detailed', 'Grouped by task', and 'Grouped by person, then task'. They are represented by the numbers 0, 1, and 2, respectively.


 
expense_rollup_type
integer <int32> 
Options for how expenses are formatted on an invoice. These options include 'Detailed' and 'Grouped', and are represented by the numbers 0 and 1, respectively.


 
rich_text
string
The default rich text shown as additional details on the invoice.


 
show_project_names
integer <int32> 
Whether project names should be shown on the invoice.


 
show_task_names
boolean
Whether task names should be shown for invoice items.


 
show_subtotals
boolean
Whether subtotals should be shown for time entries on the invoice.


 
show_creators
boolean
Whether the name of the person who created the entry should be shown.


 
show_dates
boolean
Whether dates for items on the invoice should be shown.


 
show_notes
boolean
Whether notes for items on the invoice should be shown.


 
show_hours
boolean
Whether hours logged on a time entry on the invoice should be shown.


 
show_rates
boolean
Whether the rate for the item should be shown.


 
show_tax
boolean
Whether the item's taxable amount should be shown.


 
show_roles
boolean
Whether the role of the person who created the item should be shown.


 
Responses 
200
Client Invoice Defaults 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/client_invoice_defaults/{id}
Request samples 
application/json
{
  • "client_invoice_default": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "client_invoice_defaults": {
    }
}
Deleting Client Invoice Defaults by ID
The response will contain no content and an HTTP 204 status code if the request was
successful, or a standard Kantata OX error message explaining why the object could not be deleted.


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


 
Responses 
204
Client Invoice Defaults has been deleted.


400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


delete/client_invoice_defaults/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to External Payments