Billing templates

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

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 find 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
required
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


    

  • predefinedPercentages - Billing is scheduled based on a table of entries that map the period to bill with the percentage of the flat/fixed amount to be billed for that period.
    • 

  • projectPercentComplete - Billing for a fixed-fee project is scheduled proportionate to either approved hours divided by source hours or by a percentage determined by user input.
    • 

  • TaskPercentComplete - Billing for a task related to a fixed-fee project is scheduled proportionate to either approved hours divided by source hours or by a percentage determined by user input. For example, you could use Task percent complete templates for milestone billing.
    • 



 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.


    

  • estimatedHours - Divide the total estimated hours for the project or task by the number of approved hours (actual hours).
    • 

  • observedPercentCompleted - Use the appropriate percent complete value entered by the user on the project or task.
    • 

  • budgetedHours - Divide the total budgeted hours for the project by the number of approved hours (actual hours). This source is only applicable to Projects.
    • 

  • plannedHours - Divide the total planned hours for the project or task by the number of approved hours (actual hours).
    • 



 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
The number of months in the future from the billing template start date the corresponding percentage will be billed. Use 0 to bill the corresponding percentage in the month the billing template starts. This is only applicable when method= predefinedPercentages.


 
 Example:  "2"
percentToBill
string <decimal-precision-8> 
The percentage of the flat/fixed amount that will be billed at the corresponding number of months from the billing template start date.


 
 Example:  "11"
stepPercent
string or null <decimal-precision-8> 
The percentage of completeness at which you want to invoice. This value is cumulative.


 
 Example:  "10"
object
Billing template that this line 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",
      • "percentToBill": "5",
      • "stepPercent": null
      },
    • {
      • "periodOffset": "6",
      • "percentToBill": "25",
      • "stepPercent": null
      },
    • {
      • "periodOffset": "9",
      • "percentToBill": "45",
      • "stepPercent": null
      },
    • {
      • "periodOffset": "12",
      • "percentToBill": "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.


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "10",
    • "id": "50_6PRD_12PRD",
    • "description": "Billing twice for the contract",
    • "status": "inactive",
    • "method": "predefinedPercentages",
    • "source": "estimatedHours",
    • "isStepBilling": false,
    • "audit": {
      • "modifiedDateTime": "2019-01-16T23:12:22Z",
      • "createdDateTime": "2016-05-13T18:22:36Z",
      • "createdByUser": {
        },
      • "createdBy": "1",
      • "modifiedByUser": {
        },
      • "modifiedBy": "109"
      },
    • "lines": [
      • {
        },
      • {
        }
      ],
    • "href": "/objects/contracts/billing-template/10"
    },
  • "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.


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


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


    

  • predefinedPercentages - Billing is scheduled based on a table of entries that map the period to bill with the percentage of the flat/fixed amount to be billed for that period.
    • 

  • projectPercentComplete - Billing for a fixed-fee project is scheduled proportionate to either approved hours divided by source hours or by a percentage determined by user input.
    • 

  • TaskPercentComplete - Billing for a task related to a fixed-fee project is scheduled proportionate to either approved hours divided by source hours or by a percentage determined by user input. For example, you could use Task percent complete templates for milestone billing.
    • 



 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.


    

  • estimatedHours - Divide the total estimated hours for the project or task by the number of approved hours (actual hours).
    • 

  • observedPercentCompleted - Use the appropriate percent complete value entered by the user on the project or task.
    • 

  • budgetedHours - Divide the total budgeted hours for the project by the number of approved hours (actual hours). This source is only applicable to Projects.
    • 

  • plannedHours - Divide the total planned hours for the project or task by the number of approved hours (actual hours).
    • 



 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
The number of months in the future from the billing template start date the corresponding percentage will be billed. Use 0 to bill the corresponding percentage in the month the billing template starts. This is only applicable when method= predefinedPercentages.


 
 Example:  "2"
percentToBill
string <decimal-precision-8> 
The percentage of the flat/fixed amount that will be billed at the corresponding number of months from the billing template start date.


 
 Example:  "11"
stepPercent
string or null <decimal-precision-8> 
The percentage of completeness at which you want to invoice. This value is cumulative.


 
 Example:  "10"
object
Billing template that this line 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",
      • "percentToBill": "5",
      • "stepPercent": null
      },
    • {
      • "key": "136",
      • "periodOffset": "6",
      • "percentToBill": "5",
      • "stepPercent": null
      },
    • {
      • "key": "137",
      • "periodOffset": "9",
      • "percentToBill": "12",
      • "stepPercent": null
      },
    • {
      • "key": "138",
      • "periodOffset": "12",
      • "percentToBill": "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.


 
 Example:  99
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
Use the query service to find billing templates that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


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
    }
}