Billing templates

A billing template defines the rules to use to invoice the flat or fixed amount of a contract line item.

Please be aware that this object is currently "Uncertified", 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/contracts/billing-template

Returns a collection with a key, ID, and link for each billing template. This operation is mostly for use in testing. Use query to fnd objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "7",
      • "id": "BILLINGBEGPERCUST2",
      • "href": "/objects/contracts/billing-template/7"
      },
    • {
      • "key": "19",
      • "id": "18M_Straitline_Beg",
      • "href": "/objects/contracts/billing-template/19"
      },
    • {
      • "key": "14",
      • "id": "4P_25PER_MBEGIN",
      • "href": "/objects/contracts/billing-template/14"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a billing template
post/objects/contracts/billing-template
Creates a new billing template.


SecurityOAuth2 
Request 
Request Body schema: application/json
id
required
string
Name or other unique identifier for the billing template.


 
 Example:  "12P_BeginningPeriod"
description
string
Description of the billing template.


 
 Example:  "12P Beginning Period"
method
string
 Default:  "predefinedPercentages"
Template type


 Enum: "predefinedPercentages" "projectPercentComplete" "taskPercentComplete"  
 Example:  "predefinedPercentages"
source
string or null
 Default:  null
Specifies the data source to use to determine the percentage of completeness for the project or task.


 Enum: "budgetedHours" "estimatedHours" null "observedPercentCompleted" "plannedHours"  
 Example:  "estimatedHours"
isStepBilling
boolean
 Default:  false
Indicates whether to define billing thresholds to determine the percentage of the flat/fixed amount to invoice.


 
 Example:  false
Array of objects
Contract billing template details.


 
 Array 
periodOffset
string
Number of months offset


 
 Example:  "2"
percentToBill
string <decimal-precision-8> 
Percent to bill


 
 Example:  "10.12312000"
stepPercent
string <decimal-precision-8> 
Percentage completed threshold


 
 Example:  "90.12312000"
object
Billing template that this entry belongs to.


 
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"
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"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "BILLINGBEGPERCUST3",
  • "description": "Custom percent billing beginning of 3,6,9,12 periods",
  • "status": "active",
  • "method": "predefinedPercentages",
  • "source": "estimatedHours",
  • "isStepBilling": false,
  • "lines": [
    • {
      • "periodOffset": "3",
      • "percentBilled": "5",
      • "stepPercent": null
      },
    • {
      • "periodOffset": "6",
      • "percentBilled": "25",
      • "stepPercent": null
      },
    • {
      • "periodOffset": "9",
      • "percentBilled": "45",
      • "stepPercent": null
      },
    • {
      • "periodOffset": "12",
      • "percentBilled": "25",
      • "stepPercent": null
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "22",
    • "id": "BILLINGBEGPERCUST3",
    • "href": "/objects/contracts/billing-template/22"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a billing template
get/objects/contracts/billing-template/{key}
Returns detailed information for a specified billing template.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the billing template.


 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "7",
    • "id": "BILLINGBEGPERCUST2",
    • "description": "Custom percent billing beginning of 3,6,9,12 periods",
    • "status": "active",
    • "method": "predefinedPercentages",
    • "source": "",
    • "isStepBilling": false,
    • "audit": {
      • "modifiedDateTime": "2016-05-13T18:22:29Z",
      • "createdDateTime": "2016-05-13T18:22:29Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "lines": [
      • {
        },
      • {
        },
      • {
        },
      • {
        }
      ],
    • "href": "/objects/contracts/billing-template/7"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a billing template
patch/objects/contracts/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 key for the billing template.


 
Request Body schema: application/json
description
string
Description of the billing template.


 
 Example:  "12P Beginning Period"
method
string
 Default:  "predefinedPercentages"
Template type


 Enum: "predefinedPercentages" "projectPercentComplete" "taskPercentComplete"  
 Example:  "predefinedPercentages"
source
string or null
 Default:  null
Specifies the data source to use to determine the percentage of completeness for the project or task.


 Enum: "budgetedHours" "estimatedHours" null "observedPercentCompleted" "plannedHours"  
 Example:  "estimatedHours"
isStepBilling
boolean
 Default:  false
Indicates whether to define billing thresholds to determine the percentage of the flat/fixed amount to invoice.


 
 Example:  false
Array of objects
Contract billing template details.


 
 Array 
periodOffset
string
Number of months offset


 
 Example:  "2"
percentToBill
string <decimal-precision-8> 
Percent to bill


 
 Example:  "10.12312000"
stepPercent
string <decimal-precision-8> 
Percentage completed threshold


 
 Example:  "90.12312000"
object
Billing template that this entry belongs to.


 
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"
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"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "description": "Custom percent billing beginning of 3,6,9,12 periods",
  • "status": "active",
  • "method": "predefinedPercentages",
  • "source": "estimatedHours",
  • "isStepBilling": false,
  • "lines": [
    • {
      • "key": "135",
      • "periodOffset": "3",
      • "percentBilled": "5",
      • "stepPercent": null
      },
    • {
      • "key": "136",
      • "periodOffset": "6",
      • "percentBilled": "25",
      • "stepPercent": null
      },
    • {
      • "key": "137",
      • "periodOffset": "9",
      • "percentBilled": "45",
      • "stepPercent": null
      },
    • {
      • "key": "138",
      • "periodOffset": "12",
      • "percentBilled": "25",
      • "stepPercent": null
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "22",
    • "id": "BILLINGBEGPERCUST3",
    • "href": "/objects/contracts/billing-template/22"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a billing template
delete/objects/contracts/billing-template/{key}
Deletes a billing template.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the billing template.


 
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}
Query 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:  "contracts/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
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "accounts-payable/vendor",
  • "fields": [
    • "id",
    • "name",
    • "status",
    • "href"
    ],
  • "filters": [
    • {
      • "$eq": {
        }
      },
    • {
      • "$eq": {
        }
      }
    ],
  • "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
    }
}