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


 
 Example:  87
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.


 
 Example:  87
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.


 
 Example:  87
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


Request samples