1. REST API Reference for Billing Care
  2. Tasks
  3. Collections

Create a Promise-to-Pay Agreement for a Bill Unit

put

/bcws/webresources/v1.0/collections/promisetopay/invoke/{id}

Creates a promise-to-pay agreement for the specified bill unit.

Request

Path Parameters
Supported Media Types
Request Body - application/xml ()
Details about the promise to pay agreement. The minimum required parameter is: effectiveDate.
Root Schema : schema
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : milestones
Type: array
Show Source
Nested Schema : Notes
Type: object
Show Source
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : Milestones
Type: object
Show Source
Nested Schema : comments
Type: array
The list of comments associated with the note.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Comments
Type: object
The list of comments associated with the note.
Show Source
Request Body - application/json ()
Details about the promise to pay agreement. The minimum required parameter is: effectiveDate.
Root Schema : schema
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : milestones
Type: array
Show Source
Nested Schema : Notes
Type: object
Show Source
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : Milestones
Type: object
Show Source
Nested Schema : comments
Type: array
The list of comments associated with the note.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Comments
Type: object
The list of comments associated with the note.
Show Source
Back to Top

Response

Supported Media Types

200 Response

The promise-to-pay agreement was created successfully.
Body ()
Root Schema : resource
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : ResourceRef
Type: object
Show Source

500 Response

An internal server error occurred.
Back to Top

Examples

This example shows how create a promise-to-pay agreement for a bill unit by submitting a PUT request on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Command

curl -X PUT 'http://hostname:port/bcws/webresources/version/collections/promisetopay/invoke/0.0.0.1+-billinfo+128084' -H 'content-type: application/json' -d @createPromiseToPay.json

where:

  • hostname is the URL for the Billing Care REST server.
  • port is the port for the Billing Care REST server.
  • version is the version of the API you're using, such as v1.0.
  • createPromiseToPay.json is the JSON file that specifies the promise-to-pay details.

Example of Request Body

This example shows the contents of the createPromiseToPay.json file sent as the request body. Because a note ID is specified, the comment is added to an existing note. 

{
	"promiseToPayAmount": "7404",
	"effectiveDate": "2021-02-12",
	"numberOfMilestones": "10",
	"daysBetweenMilestones": "6",
	"notes": {
		"billUnitId": "0.0.0.1+-billinfo+128084",
		"accountId": "0.0.0.1+-account+130964",
		"domainId": 10,
		"type": 900,
		"subType": 901,
		"status": 101,
		"effectiveDate": "2021-02-08",
		"id": "0.0.0.1+-note+278620",
		"reasonId": "0"
		"comments": [
			{
				"comment": "Customer promised to pay by specified date."
			}
		]
	}
}

Example of Response Body

This example shows the contents of the response body in JSON format.

{
	"extension": null,
	"reference": {
		"id": "0.0.0.1+-event-activity-collections-promise_to_pay+328375744705343185",
		"uri": "http://hostname:port/bc/webresources/v1.0/collections/0.0.0.1+-event-activity-collections-promise_to_pay+328375744705343185"
	}
}
Back to Top