Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
version: 1.0.0
title: Kantata OX API Documentation Project Accounting Records API
description: Kantata OX's API provides access to the majority of Kantata OX's data model.
termsOfService: https://www.kantata.com/terms-of-use
contact:
name: Kantata OX Support
url: https://knowledge.kantata.com/hc/en-us
license:
name: COPYRIGHT © 2026 Kantata, Inc.
url: https://www.kantata.com/terms-of-use
x-logo:
url: https://theme.zdassets.com/theme_assets/56104/04e93064d309f75d054b8cee885d1ea51e9be8f7.png
backgroundColor: '#FFFFFF'
altText: Kantata OX API Documentation
href: https://developer.kantata.com
servers:
- url: https://api.mavenlink.com/api/v1
tags:
- name: Project Accounting Records
description: 'The Project Accounting
Records object allows you to view, create, and delete financial records
related to revenue recognition, forecasting, and earned value.'
paths:
/project_accounting_records:
get:
summary: Fetching a list of Project Accounting Records
description: '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.'
operationId: Get Project Accounting Records
tags:
- Project Accounting Records
parameters:
- in: query
name: created_at
required: false
description: 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](https://www.w3.org/TR/NOTE-datetime) format.
schema:
type: string
format: date-time
- in: query
name: end_date
required: false
description: '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](https://www.w3.org/TR/NOTE-datetime) format.'
schema:
type: string
format: date
- in: query
name: external_reference_external_message
description: Filter the objects based on the external message of their associated external references. This is an exact match.
schema:
type: string
- in: query
name: external_reference_external_status
description: Filter by the status of the external object in the external system.
schema:
type: string
- in: query
name: external_reference_service_model
description: Filter by the type of the external object this external reference belongs to.
schema:
type: string
- in: query
name: external_reference_service_model_ref
description: Filter by the id of the external object this external reference belongs to.
schema:
type: integer
format: int32
- in: query
name: external_reference_service_model_refs
description: Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs.
schema:
type: string
- in: query
name: external_reference_service_name
description: Filter by the name of the provider for integration.
schema:
type: string
- in: query
name: external_reference_status
description: Filter by the status of the integration, this can be successful or fail.
schema:
type: string
- in: query
name: has_external_references
description: Filter by whether or not the object has external references.
schema:
type: boolean
- in: query
name: ids
required: false
description: "Filters for records with the specified IDs. Give multiple record IDs\n in a comma-separated list (e.g. `GET /api/v1/project_accounting_records.json?ids=55,16,73`)."
schema:
type: array
items:
type: integer
format: int32
- in: query
name: include
description: "Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `role` (Role) - Includes the ID of the role associated with the record.\n- `story` (Story) - Includes the ID of the task related to the record.\n- `user` (User) - Includes the ID(s) of user(s) associated with the record\n (e.g. who created the record, who the record was created for, etc.).\n- `workspace` (Workspace) - Includes the ID of the project the record belongs to."
schema:
type: string
- in: query
name: only
description: '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`.'
schema:
type: string
- in: query
name: page
schema:
type: integer
format: int32
default: 1
- in: query
name: per_page
schema:
type: integer
format: int32
default: 20
maximum: 200
- in: query
name: show_deleted
required: false
description: If `true`, returns only deleted project accounting records. Set to `false` by default.
schema:
type: boolean
- in: query
name: start_date
required: false
description: '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](https://www.w3.org/TR/NOTE-datetime) format.'
schema:
type: string
format: date
- in: query
name: status
required: false
description: '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.'
schema:
type: array
items:
type: string
- in: query
name: type
description: "Only includes Project Accounting Records of the specified type.\n Valid values: `Baseline`, `Earned Value`, `Earned Value Forecasting`, `Forecasting`, `Recognition`."
schema:
type: string
- in: query
name: user_id
description: Only includes Project Accounting Records for the specified user_id.
schema:
type: integer
format: int32
- in: query
name: without_external_reference_service_name
description: Exclude by the existence of an external reference with the specified service name.
schema:
type: string
- in: query
name: workspace_ids
required: false
description: "Filters for records from projects with the specified IDs. Give multiple project IDs\n in a comma-separated list (e.g. `GET /api/v1/project_accounting_records.json?workspace_ids=25344,76545`)."
schema:
type: array
items:
type: integer
format: int32
responses:
'200':
description: A list of Project Accounting Records have been retrieved.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
format: int32
meta:
type: object
properties:
count:
type: integer
format: int32
page_count:
type: integer
format: int32
page_number:
type: integer
format: int32
page_size:
type: integer
format: int32
results:
type: array
items:
type: object
properties:
key:
type: string
id:
type: string
project_accounting_records:
type: object
additionalProperties:
$ref: '#/components/schemas/ProjectAccounting__Models__ProjectAccountingRecord'
external_references:
type: object
additionalProperties:
$ref: '#/components/schemas/ExternalReference'
workspaces:
type: object
additionalProperties:
$ref: '#/components/schemas/Workspace'
stories:
type: object
additionalProperties:
$ref: '#/components/schemas/Story'
roles:
type: object
additionalProperties:
$ref: '#/components/schemas/Role'
users:
type: object
additionalProperties:
$ref: '#/components/schemas/User'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'401':
description: Unauthorized request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'403':
description: Forbidden request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'404':
description: Page Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'422':
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'503':
description: Service is unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
post:
summary: Creating a new Project Accounting Records
description: '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.'
operationId: Create Project Accounting Record
tags:
- Project Accounting Records
parameters:
- in: query
name: include
description: "Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `role` (Role) - Includes the ID of the role associated with the record.\n- `story` (Story) - Includes the ID of the task related to the record.\n- `user` (User) - Includes the ID(s) of user(s) associated with the record\n (e.g. who created the record, who the record was created for, etc.).\n- `workspace` (Workspace) - Includes the ID of the project the record belongs to."
schema:
type: string
responses:
'200':
description: Project Accounting Records has been created.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
format: int32
meta:
type: object
properties:
count:
type: integer
format: int32
page_count:
type: integer
format: int32
page_number:
type: integer
format: int32
page_size:
type: integer
format: int32
results:
type: array
items:
type: object
properties:
key:
type: string
id:
type: string
project_accounting_records:
type: object
additionalProperties:
$ref: '#/components/schemas/ProjectAccounting__Models__ProjectAccountingRecord'
external_references:
type: object
additionalProperties:
$ref: '#/components/schemas/ExternalReference'
workspaces:
type: object
additionalProperties:
$ref: '#/components/schemas/Workspace'
stories:
type: object
additionalProperties:
$ref: '#/components/schemas/Story'
roles:
type: object
additionalProperties:
$ref: '#/components/schemas/Role'
users:
type: object
additionalProperties:
$ref: '#/components/schemas/User'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'401':
description: Unauthorized request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'403':
description: Forbidden request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'404':
description: Page Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'422':
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'503':
description: Service is unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
requestBody:
content:
application/json:
schema:
type: object
properties:
project_accounting_record:
type: object
description: A single project accounting record and its attributes.
properties:
workspace_id:
type: integer
format: int32
description: The ID of the project the record belongs to.
start_date:
type: string
format: date
description: "The date the accounting period begins,\n in ISO8601 format (e.g. `2014-06-25`). The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."
end_date:
type: string
format: date
description: "The date the accounting period ends,\n in ISO8601 format (e.g. `2014-02-25`). The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."
currency:
type: string
description: "The currency of the record. Valid values are\n [ISO codes of currencies supported by Kantata OX](https://mavenlink.zendesk.com/hc/en-us/articles/360041576473)."
type:
type: string
description: 'The type of project accounting record:
* `Baseline`
* `Earned Value`
* `Earned Value Forecasting`
* `Forecasting`
* `Recognition` (Default)
If not specified, a `Recognition` record is created by default.
**Note:** Make sure to include the spaces in `Earned Value` and `Earned Value Forecasting`
when making a request.'
amount:
type: number
format: float
description: "The amount being calculated for baseline, forecasting,\n earned value, earned value forecasting, or revenue recognition within the specified accounting period,\n up to 2 decimal places (e.g. 575.75).\n Values can also be negative (e.g. -96.75)."
amount_to_date:
type: number
format: float
description: "The total amount spent to date\n (for all accounting periods), up to 2 decimal places (e.g. 1252.33).\n Values can also be negative (e.g. -83.33)."
budget:
type: number
format: float
description: "The budget of the project or task,\n up to 2 decimal places (e.g. 2457.52). Values can also be negative (e.g. -350.52)."
contract_date:
type: string
format: date
description: "This can be a contract's start or end date in ISO8601 format,\n or any other date a user prefers. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."
cost:
type: number
format: float
description: "The cost of the project or task within the specified accounting period,\n up to 2 decimal places (e.g. 3003.56). Values can also be negative (e.g. -350.72)."
cost_eac:
type: number
format: float
description: "The\n [estimated cost](https://mavenlink.zendesk.com/hc/en-us/articles/360004619334-Project-Completion-Estimates)\n of the project or task when it is completed, up to 2 decimal places (e.g. 8326.55).\n Values can also be negative (e.g. -426.55).\n This updates during the course of a project or task, as costs are logged."
description:
type: string
description: "This can be a brief description of the record,\n or anything a user prefers."
fees:
type: number
format: float
description: "The fees from the specified accounting period,\n up to 2 decimal places (e.g. 324.53). Values can also be negative (e.g. -41.53)."
hours:
type: number
format: float
description: "The [hours](https://mavenlink.zendesk.com/hc/en-us/articles/360059325413)\n spent within the specified accounting period, up to 2 decimal places (e.g. 23.25).\n Values can also be negative (e.g. -7.25)."
hours_eac:
type: number
format: float
description: "The\n [estimated hours](https://mavenlink.zendesk.com/hc/en-us/articles/360004619334-Project-Completion-Estimates)\n for the project or task when it is completed, up to 2 decimal places (e.g. 82.25).\n Values can also be negative (e.g. -22.25).\n This updates during the course of a project or task, as hours are logged."
hours_etc:
type: number
format: float
description: "The\n [estimated hours](https://mavenlink.zendesk.com/hc/en-us/articles/360004619334-Project-Completion-Estimates)\n until completion (`hours_eac` - `hours`) of the project or task, up to two decimal places (e.g. 53.25).\n Values can also be negative (e.g. -10.25)."
total_estimated_hours:
type: number
format: float
description: "The hours initially estimated for the project or task,\n up to 2 decimal places (e.g. 83.50). Values can also be negative (e.g. -12.25).\n This value does not change over the course of a project."
total_hours_to_date:
type: number
format: float
description: "The total hours logged to date for the project or task,\n up to 2 decimal places (e.g. 32.25). Values can also be negative (e.g. -5.75)."
labor_type:
type: string
description: "The type of cost associated with the record.\n Valid values are `Labor` or `Non-Labor`."
notes:
type: string
description: This can be any extra information to note about the record.
percent_complete:
type: number
format: float
description: "How much of the project or task is complete\n in decimal format, up to 2 places (e.g. 0.75). Values can also be negative (e.g. -.25)."
role_id:
type: integer
format: int32
description: The ID of the role associated with the record.
service_type:
type: string
description: "This can be an organization-specific category of services\n that is related to the record (e.g. Branding, Campaigns, Photography, etc.)."
status:
type: string
description: "The status of the record.\n Valid values: `Draft`, `Pending Approval`, `Approved`, `Cancelled`."
story_id:
type: integer
format: int32
description: The ID of the task related to the record.
user_id:
type: integer
format: int32
description: "The ID of the user associated with the record\n (e.g. who created the record, who the record was created for, etc.)."
external_reference:
type: object
description: 'Typically populated programmatically by a third party system via an integration, this is an optional
object that holds data from an external system. It connects objects in an external system with objects in
Kantata OX (for example, to connect a Jira issue to a Kantata OX Project).'
properties:
service_name:
type: string
description: The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique.
service_model:
type: string
description: The object type of the external object this external reference belongs to.
service_model_ref:
type: string
description: The object ID of the external object this external reference belongs to.
status:
type: string
description: The status of the integration. Options are `successful`, `pending`, or `failed`.
external_message:
type: string
description: The message on the external object.
external_link:
type: string
description: The link to the external object.
external_status:
type: string
description: The status of the external object in the external system.
locked:
type: boolean
description: Whether the subject is locked.
required:
- service_name
- service_model
- service_model_ref
required:
- workspace_id
- start_date
- end_date
- currency
project_accounting_records:
type: array
description: Multiple project accounting records and their attributes in an array.
items:
type: object
properties:
workspace_id:
type: integer
format: int32
description: The ID of the project the record belongs to.
start_date:
type: string
format: date
description: "The date the accounting period begins,\n in ISO8601 format (e.g. `2014-06-25`). The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."
end_date:
type: string
format: date
description: "The date the accounting period ends,\n in ISO8601 format (e.g. `2014-02-25`). The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."
currency:
type: string
description: "The currency of the record. Valid values are\n [ISO codes of currencies supported by Kantata OX](https://mavenlink.zendesk.com/hc/en-us/articles/360041576473)."
type:
type: string
description: 'The type of project accounting record:
* `Baseline`
* `Earned Value`
* `Earned Value Forecasting`
* `Forecasting`
* `Recognition` (Default)
If not specified, a `Recognition` record is created by default.
**Note:** Make sure to include the spaces in `Earned Value` and `Earned Value Forecasting`
when making a request.'
amount:
type: number
format: float
description: "The amount being calculated for baseline, forecasting,\n earned value, earned value forecasting, or revenue recognition within the specified accounting period,\n up to 2 decimal places (e.g. 575.75).\n Values can also be negative (e.g. -96.75)."
amount_to_date:
type: number
format: float
description: "The total amount spent to date\n (for all accounting periods), up to 2 decimal places (e.g. 1252.33).\n Values can also be negative (e.g. -83.33)."
budget:
type: number
format: float
description: "The budget of the project or task,\n up to 2 decimal places (e.g. 2457.52). Values can also be negative (e.g. -350.52)."
contract_date:
type: string
format: date
description: "This can be a contract's start or end date in ISO8601 format,\n or any other date a user prefers. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."
cost:
type: number
format: float
description: "The cost of the project or task within the specified accounting period,\n up to 2 decimal places (e.g. 3003.56). Values can also be negative (e.g. -350.72)."
cost_eac:
type: number
format: float
description: "The\n [estimated cost](https://mavenlink.zendesk.com/hc/en-us/articles/360004619334-Project-Completion-Estimates)\n of the project or task when it is completed, up to 2 decimal places (e.g. 8326.55).\n Values can also be negative (e.g. -426.55).\n This updates during the course of a project or task, as costs are logged."
description:
type: string
description: "This can be a brief description of the record,\n or anything a user prefers."
fees:
type: number
format: float
description: "The fees from the specified accounting period,\n up to 2 decimal places (e.g. 324.53). Values can also be negative (e.g. -41.53)."
hours:
type: number
format: float
description: "The [hours](https://mavenlink.zendesk.com/hc/en-us/articles/360059325413)\n spent within the specified accounting period, up to 2 decimal places (e.g. 23.25).\n Values can also be negative (e.g. -7.25)."
hours_eac:
type: number
format: float
description: "The\n [estimated hours](https://mavenlink.zendesk.com/hc/en-us/articles/360004619334-Project-Completion-Estimates)\n for the project or task when it is completed, up to 2 decimal places (e.g. 82.25).\n Values can also be negative (e.g. -22.25).\n This updates during the course of a project or task, as hours are logged."
hours_etc:
type: number
format: float
description: "The\n [estimated hours](https://mavenlink.zendesk.com/hc/en-us/articles/360004619334-Project-Completion-Estimates)\n until completion (`hours_eac` - `hours`) of the project or task, up to two decimal places (e.g. 53.25).\n Values can also be negative (e.g. -10.25)."
total_estimated_hours:
type: number
# --- truncated at 32 KB (118 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mavenlink/refs/heads/main/openapi/mavenlink-project-accounting-records-api-openapi.yml