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

Project Accounting Records

The Project Accounting Records object allows you to view, create, and delete financial records related to revenue recognition, forecasting, and earned value.

Fetching a list of Project Accounting Records

Returns all project accounting records (Baseline, Earned Value, Earned Value Forecasting, Forecasting, and Recognition), unless filter parameters have been applied.

This endpoint returns structured Project Accounting Records 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 project_accounting_records top-level JSON key. Please see our Response Format section for more information.

Request
query Parameters
created_at
string <date-time>

Filters for records created on or after the specified date (e.g. GET /api/v1/project_accounting_records.json?created_at=2014-02-25). The datetime must be in ISO 8601 format.

end_date
string <date>

Filters for records with accounting periods that end on specified dates.

You can filter for records with an accounting period that ends...

  • within a date range, with a pair of semicolon-separated dates (e.g. 2019-09-14;2019-09-15),
  • on or after a date, with only the date before the semicolon (e.g. 2019-09-14;),
  • on or before a date, with only the date after the semicolon (e.g. ;2019-09-14). The date must be in ISO 8601 format.
external_reference_external_message
string

Filter the objects based on the external message of their associated external references. This is an exact match.

external_reference_external_status
string

Filter by the status of the external object in the external system.

external_reference_service_model
string

Filter by the type of the external object this external reference belongs to.

external_reference_service_model_ref
integer <int32>

Filter by the id of the external object this external reference belongs to.

external_reference_service_model_refs
string

Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs.

external_reference_service_name
string

Filter by the name of the provider for integration.

external_reference_status
string

Filter by the status of the integration, this can be successful or fail.

has_external_references
boolean

Filter by whether or not the object has external references.

ids
Array of integers <int32>

Filters for records with the specified IDs. Give multiple record IDs in a comma-separated list (e.g. GET /api/v1/project_accounting_records.json?ids=55,16,73).

include
string

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • role (Role) - Includes the ID of the role associated with the record.
  • story (Story) - Includes the ID of the task related to the record.
  • user (User) - Includes the ID(s) of user(s) associated with the record (e.g. who created the record, who the record was created for, etc.).
  • workspace (Workspace) - Includes the ID of the project the record belongs to.
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
show_deleted
boolean

If true, returns only deleted project accounting records. Set to false by default.

start_date
string <date>

Filters for records with accounting periods that begin on specified dates.

You can filter for records with an accounting period that begins...

  • within a date range, with a pair of semicolon-separated dates (e.g. 2019-09-14;2019-09-15),
  • on or after a date, with only the date before the semicolon (e.g. 2019-09-14;),
  • on or before a date, with only the date after the semicolon (e.g. ;2019-09-14). The date must be in ISO 8601 format.
status
Array of strings

Filters for records with the specified status.

Valid values: Draft, Pending Approval, Approved, Cancelled.

Note: Records without a status cannot be returned with this filter.

type
string

Only includes Project Accounting Records of the specified type. Valid values: Baseline, Earned Value, Earned Value Forecasting, Forecasting, Recognition.

user_id
integer <int32>

Only includes Project Accounting Records for the specified user_id.

without_external_reference_service_name
string

Exclude by the existence of an external reference with the specified service name.

workspace_ids
Array of integers <int32>

Filters for records from projects with the specified IDs. Give multiple project IDs in a comma-separated list (e.g. GET /api/v1/project_accounting_records.json?workspace_ids=25344,76545).

Responses
200

A list of Project Accounting Records have been retrieved.

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

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/project_accounting_records
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "project_accounting_records": {
    },
  • "external_references": {
    },
  • "workspaces": {
    },
  • "stories": {
    },
  • "roles": {
    },
  • "users": {
    }
}
Creating a new Project Accounting Records
Creates a single or multiple project accounting records.


This endpoint returns structured Project Accounting Records 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 project_accounting_records top-level JSON key.
Please see our Response Format section for more information.


Request 
query Parameters
include
string
Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.


    

  • external_references (ExternalReference) - Includes references to external integrations for this object.
    • 

  • role (Role) - Includes the ID of the role associated with the record.
    • 

  • story (Story) - Includes the ID of the task related to the record.
    • 

  • user (User) - Includes the ID(s) of user(s) associated with the record
              (e.g. who created the record, who the record was created for, etc.).
    • 

  • workspace (Workspace) - Includes the ID of the project the record belongs to.
    • 



 
Request Body schema: application/json
required
object
A single project accounting record and its attributes.


 
Array of objects
Multiple project accounting records and their attributes in an array.


 
Responses 
200
Project Accounting Records has been created.


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


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


post/project_accounting_records
Request samples 
application/json
{
  • "project_accounting_record": {
    },
  • "project_accounting_records": [
    ]
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "project_accounting_records": {
    },
  • "external_references": {
    },
  • "workspaces": {
    },
  • "stories": {
    },
  • "roles": {
    },
  • "users": {
    }
}
Soft Deleting a Project Accounting Record
Soft deletes a specified project accounting record. View deleted records by
Fetching a list of Project Accounting Records with the show_deleted filter set to true.


This endpoint returns structured Project Accounting Records 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 project_accounting_records top-level JSON key.
Please see our Response Format section for more information.


Request 
query Parameters
csv_file
string
The ID(s) of record(s) to delete, in a
            .csv file
            with rows/lines of ID numbers under a header of ID.


 
ids
Array of strings
The ID(s) of record(s) to delete, in an array.


 
include
string
Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.


    

  • external_references (ExternalReference) - Includes references to external integrations for this object.
    • 

  • role (Role) - Includes the ID of the role associated with the record.
    • 

  • story (Story) - Includes the ID of the task related to the record.
    • 

  • user (User) - Includes the ID(s) of user(s) associated with the record
              (e.g. who created the record, who the record was created for, etc.).
    • 

  • workspace (Workspace) - Includes the ID of the project the record belongs to.
    • 



 
Responses 
200
Project Accounting Records has been updated.


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


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


put/project_accounting_records/delete
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "project_accounting_records": {
    },
  • "external_references": {
    },
  • "workspaces": {
    },
  • "stories": {
    },
  • "roles": {
    },
  • "users": {
    }
}
Exporting Project Account Records in a CSV
Downloads a .csv file of all project accounting records.


This endpoint returns structured Project Accounting Records 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 project_accounting_records top-level JSON key.
Please see our Response Format section for more information.


Request 
query Parameters
include
string
Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.


    

  • external_references (ExternalReference) - Includes references to external integrations for this object.
    • 

  • role (Role) - Includes the ID of the role associated with the record.
    • 

  • story (Story) - Includes the ID of the task related to the record.
    • 

  • user (User) - Includes the ID(s) of user(s) associated with the record
              (e.g. who created the record, who the record was created for, etc.).
    • 

  • workspace (Workspace) - Includes the ID of the project the record belongs to.
    • 



 
Responses 
200
A list of Project Accounting Records have been retrieved.


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


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


get/project_accounting_records/export_to_csv
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "project_accounting_records": {
    },
  • "external_references": {
    },
  • "workspaces": {
    },
  • "stories": {
    },
  • "roles": {
    },
  • "users": {
    }
}
Importing Project Account Records in a CSV
Imports up to 5000 project accounting records with a
csv file
with a .txt or .csv extension.


Each row/line is a record, and each record has attributes. Headers
indicate which attributes are being specified for imported records.
Headers can include:


    

  • Project ID (required)
    • 

  • Story ID
    • 

  • Role ID
    • 

  • User ID
    • 

  • Type (recommended)
    • 

  • Period Start Date (required)
    • 

  • Period End Date (required)
    • 

  • Contract Date
    • 

  • Currency (required)
    • 

  • Amount
    • 

  • Amount To Date
    • 

  • Budget
    • 

  • Cost
    • 

  • Cost EAC
    • 

  • Fees
    • 

  • Labor Type
    • 

  • Hours
    • 

  • Hours EAC
    • 

  • Hours ETC
    • 

  • Total Estimated Hours
    • 

  • Total Hours to Date
    • 

  • Percent Complete
    • 

  • Status
    • 

  • Service Type
    • 

  • Description
    • 

  • Notes
    • 



Only Project ID, Period Start Date, Period End Date,
and Currency are required for a csv import. But when it is not specified,
Type defaults to Recognition. Other valid values for Type are
Baseline, Earned Value, Earned Value Forecasting, and Forecasting.


This endpoint returns structured Project Accounting Records 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 project_accounting_records top-level JSON key.
Please see our Response Format section for more information.


Request 
query Parameters
include
string
Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.


    

  • external_references (ExternalReference) - Includes references to external integrations for this object.
    • 

  • role (Role) - Includes the ID of the role associated with the record.
    • 

  • story (Story) - Includes the ID of the task related to the record.
    • 

  • user (User) - Includes the ID(s) of user(s) associated with the record
              (e.g. who created the record, who the record was created for, etc.).
    • 

  • workspace (Workspace) - Includes the ID of the project the record belongs to.
    • 



 
Responses 
200
Project Accounting Records has been created.


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


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


post/project_accounting_records/import_csv
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "project_accounting_records": {
    },
  • "external_references": {
    },
  • "workspaces": {
    },
  • "stories": {
    },
  • "roles": {
    },
  • "users": {
    }
}
Fetching a single Project Accounting Records
Returns a specified project accounting record.


This endpoint returns structured Project Accounting Records 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 project_accounting_records top-level JSON key.
Please see our Response Format section for more information.


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


 
query Parameters
include
string
Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.


    

  • external_references (ExternalReference) - Includes references to external integrations for this object.
    • 

  • role (Role) - Includes the ID of the role associated with the record.
    • 

  • story (Story) - Includes the ID of the task related to the record.
    • 

  • user (User) - Includes the ID(s) of user(s) associated with the record
              (e.g. who created the record, who the record was created for, etc.).
    • 

  • workspace (Workspace) - Includes the ID of the project the record belongs to.
    • 



 
Responses 
200
The Project Accounting Records has been retrieved.


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


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


get/project_accounting_records/{id}
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "project_accounting_records": {
    },
  • "external_references": {
    },
  • "workspaces": {
    },
  • "stories": {
    },
  • "roles": {
    },
  • "users": {
    }
}
➔ Next to Status Reports