Project billing templates

Optimize project billing with our easy-to-use project billing template.

Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.

List billing templates

get/objects/projects/project-billing-template

Returns a collection with a key, ID, and link for each billing template.

SecurityOAuth2

Responses

200

400

Bad Request

Request samples

curl
JavaScript
Node.js
PHP
C#

Response samples

application/json

{"ia::result": [{"key": "12",
"id": "12",
"href": "/objects/projects/project-billing-template/12"
},
{"key": "13",
"id": "13",
"href": "/objects/projects/project-billing-template/13"
},
{"key": "14",
"id": "14",
"href": "/objects/projects/project-billing-template/14"
}
],
"ia::meta": {"totalCount": 3,
"start": 1,
"pageSize": 100,
"next": 101,
"previous": null
}
}

Create a project billing template

post/objects/projects/project-billing-template

Creates a new project billing template.

SecurityOAuth2

Request

Request Body schema: application/json

Create a project billing template

name

required

string

Unique name of the billing template.

Example: "Project Estimated Hours"

description

required

string

Project billing template description.

Example: "Template for billing by estimated project hours"

billingMethod

string

Default: "percentCompleted"

Billing method.

Enum: "milestone" "percentCompleted"

Example: "percentCompleted"

calculateOn

string

Default: "project"

Calculate on.

Enum: "project" "task"

Example: "project"

basedOn

string

Default: "estimatedHours"

Based on.

Enum: "budgetedHours" "estimatedHours" "observedPercentCompleted" "plannedHours"

Example: "plannedHours"

status

string

Default: "active"

Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.

Enum: "active" "inactive"

Example: "active"

Array of objects

Line items of the billing template.

Array

percentCompleted	string Percent completed value when invoicing should occur Example: ".5"
description	string or null Milestone description Example: "Invoice at 50%"

Responses

201

Created

400

Bad Request

Request samples

application/json

{"name": "Project Estimated Hours",
"description": "Template for billing by estimated project hours",
"billingMethod": "percentCompleted",
"calculateOn": "project",
"basedOn": "plannedHours",
"status": "active",
"milestones": [{"percentCompleted": "0.1",
"description": "Project Estimated Hours"
}
]
}

Response samples

application/json

{"ia::result": {"key": "15",
"id": "15",
"href": "/objects/projects/project-billing-template/15"
},
"ia::meta": {"totalCount": 1,
"totalSuccess": 1,
"totalError": 0
}
}

Get a billing template

get/objects/projects/project-billing-template/{key}

Returns detailed information for a particular billing template.

SecurityOAuth2

Request

path Parameters

key

required

string

system-assigned unique key for the billing template.

Responses

200

400

Bad Request

Request samples

curl
JavaScript
Node.js
PHP
C#

Response samples

application/json

{"ia::result": {"key": "15",
"id": "15",
"href": "/objects/projects/project-billing-template/15",
"name": "Project Estimated Hours",
"description": "Template for billing by estimated project hours",
"billingMethod": "percentCompleted",
"calculateOn": "project",
"basedOn": "plannedHours",
"status": "active",
"milestones": [{"key": "23",
"id": "23",
"percentCompleted": "0.5",
"percentToInvoice": "0.5",
"description": "Bill at 50% completion",
"href": "/objects/projects/project-billing-template-milestone/23",
"projectBillingTemplate": {"key": "15",
"id": "15",
"href": "/objects/projects/project-billing-template/15"
}
},
{"key": "24",
"id": "24",
"percentCompleted": "1",
"percentInvoiced": "0.5",
"description": "Bill at 100% completion",
"href": "/objects/projects/project-billing-template-milestone/23",
"projectBillingTemplate": {"key": "15",
"id": "15",
"href": "/objects/projects/project-billing-template/15"
}
}
]
},
"ia::meta": {"totalCount": 1,
"totalSuccess": 1,
"totalError": 0
}
}

Update a billing template

patch/objects/projects/project-billing-template/{key}

Updates an existing billing template by setting field values. Any fields not provided remain unchanged.

SecurityOAuth2

Request

path Parameters

key

required

string

system-assigned unique key for the billing template.

Request Body schema: application/json

description

string

Project billing template description.

Example: "Template for billing by estimated project hours"

billingMethod

string

Default: "percentCompleted"

Billing method.

Enum: "milestone" "percentCompleted"

Example: "percentCompleted"

calculateOn

string

Default: "project"

Calculate on.

Enum: "project" "task"

Example: "project"

basedOn

string

Default: "estimatedHours"

Based on.

Enum: "budgetedHours" "estimatedHours" "observedPercentCompleted" "plannedHours"

Example: "plannedHours"

status

string

Default: "active"

Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.

Enum: "active" "inactive"

Example: "active"

Array of objects

Line items of the billing template.

Array

percentCompleted	string Percent completed value when invoicing should occur Example: ".5"
description	string or null Milestone description Example: "Invoice at 50%"

Responses

200

400

Bad Request

Request samples

application/json

{"description": "Bill by actual project hours"
}

Response samples

application/json

{"ia::result": {"key": "12",
"id": "12",
"href": "/objects/projects/project-billing-template/12"
},
"ia::meta": {"totalCount": 1,
"totalSuccess": 1,
"totalError": 0
}
}

Delete a billing template

delete/objects/projects/project-billing-template/{key}

Deletes a billing template.

SecurityOAuth2

Request

path Parameters

key

required

string

system-assigned unique key for the billing template.

Responses

204

No Content

400

Bad Request

Request samples

curl
JavaScript
Node.js
PHP
C#

Response samples

application/json

{"ia::result": {"ia::error": {"code": "invalidRequest",
"message": "Payload contains errors",
"supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
"errorId": "REST-1064",
"additionalInfo": {"messageId": "IA.PAYLOAD_CONTAINS_ERRORS",
"placeholders": { },
"propertySet": { }
},
"details": [{"code": "invalidRequest",
"message": "/testDate is not a valid field",
"errorId": "REST-1043",
"target": "/testDate",
"additionalInfo": {"messageId": "IA.NOT_A_VALID_FIELD",
"placeholders": {"FIELD": "/testDate"
},
"propertySet": { }
}
}
]
},
"ia::meta": {"totalCount": 3,
"totalSuccess": 2,
"totalError": 1
}
},
"ia::error": {"code": "invalidRequest",
"message": "Malformed URL",
"supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
"details": [{"code": "invalidRequest",
"message": "The content type is not valid",
"correction": "TODO"
}
]
}
}

Query project billing templates

post/services/core/query

Queries an object for filtered data.

SecurityOAuth2

Request

Request Body schema: application/json

object

string

Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.

Example: "projects/project-billing-template"

fields

Array of strings

List of fields to include in the response. Can be any combination of these:

The name of a field in the object that you are querying, such as id.
The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
- count
- avg
- sum
- min
- max
The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.

Example: ["key","id","max:vendor.creditLimit"]

Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)

Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".

Example: [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]

Array

Any of:

Field value must be equal to this specified value.

For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:

today
currentWeek
currentMonth
currentQuarter
currentYear

yesterday
lastWeek
priorMonth
priorQuarter
priorYear

These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.

For example, {"eq":{"postingDate":"priorYear"}}.

object

The field name and value to be compared with object values.

Example: {"status":"active"}

filterExpression

string

Default: "and"

Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.

Shortcuts:

and by itself means that all conditions must be true.
or by itself means that at least one condition must be true.

Example: "(1 and 2) or 3"

object

Pre-defined filter options.

asOfDate	string <date> The "as of" date to use with any relative date comparisons in `filters`. For example, if `asOfDate` is set to "2022-04-01" then `priorMonth` will be "03". The current date is used if `asOfDate` is not set. Example: "2022-04-01"
includeHierarchyFields	boolean Default: false Set to `true` to include hierarchical structure information with each object in the response. Example: false
caseSensitiveComparison	boolean Default: true Queries are case-sensitive by default. Set to `false` to ignore case in a query. Example: true
includePrivate	boolean Default: false By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities. Example: false

Array of objects

Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.

Example: [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]

Array

property name*

additional property

string

Enum: "asc" "desc"

start

integer

First record of the result set to include in the response.

Example: 1

size

integer

Number of records to include in the response.

Example: 100

Responses

200

400

Bad Request

Request samples

application/json

{"object": "accounts-payable/vendor",
"fields": ["id",
"name",
"status",
"href"
],
"filters": [{"$eq": {"status": "active"
}
},
{"$eq": {"billingType": "openItem"
}
}
],
"filterExpression": "1 and 2",
"orderBy": [{"id": "asc"
}
]
}

Response samples

application/json

{"ia::result": [{"id": "Vend-00002",
"name": "Test vendor",
"status": "active",
"href": "/objects/accounts-payable/vendor/85"
},
{"id": "VEND-00010",
"name": "Design Works",
"status": "active",
"href": "/objects/accounts-payable/vendor/111"
}
],
"ia::meta": {"totalCount": 2,
"start": 1,
"pageSize": 100,
"next": null,
"previous": null
}
}