Get A/R Actions for a Bill
get
/bcws/webresources/v1.0/bills/{id}/ar-actions
Gets the A/R actions for the specified bill ID.
Request
Path Parameters
-
id(required): string
The ID for the bill.
Query Parameters
-
number: string
The bill number, such as B1728.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
The A/R actions were returned successfully.
Nested Schema : arActionsList
Type:
Show Source
object
-
accountNumber: string
The account number.
-
arActionAmount(required): number
The amount associated with the A/R action.
-
arActionId: string
The ID of the A/R action.
-
arActionRef: object
ResourceRef
-
arActionType: integer
(int32)
The type of A/R action: item adjustment (0), event adjustment (1), bill adjustment (2), account adjustment (3), refund (4), open item dispute (6), settled item dispute (7), item payment (8), open event dispute (9), settled event dispute (10), open bill dispute (11), settled bill dispute (12), account writeoff (13), bill writeoff (14), or item writeoff (15).
-
arUnallocatedAmount: number
The amount that is still unallocated.
-
billID: string
The ID of the bill.
-
billingStatus: integer
(int32)
The billing status: billed (1) or unbilled (2).
-
billUnitName: string
The name of the bill unit.
-
createdDate: string
(date-time)
The date and time the A/R action was created.
-
effectiveDate: string
(date-time)
The date and time the A/R action takes effect.
-
extension: object
extension
The extended attributes.
-
firstName: string
The customer's first name.
-
itemName: string
The item name.
-
lastName: string
The customer's last name.
Nested Schema : ResourceRef
Type:
Show Source
object
-
id(required): string
The ID.
-
uri: string
The Uniform Resource Identifier (URI) associated with the resource.
Nested Schema : extension
Type:
object
The extended attributes.
500 Response
An internal server error occurred
Examples
This example shows how to get the A/R actions for a specified bill by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Use cURL".
cURL Command
curl -X GET 'http://hostname:port/bcws/webresources/version/bills/0.0.0.1+-bill+200506/ar-actions'
- 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.
Example of Response Body
This example shows the contents of the response body in JSON format.
[
{
"extension": null,
"accountNumber": "0.0.0.1-81329",
"firstName": "Nancy",
"lastName": "Miller",
"effectiveDate": 1605173177000,
"createdDate": 1605173177000,
"arActionType": 3,
"arActionAmount": -1,
"arUnallocatedAmount": null,
"arActionId": "A1-156",
"arActionRef": {
"id": "0.0.0.1+-item-adjustment+208776",
"uri": null
},
"billUnitName": null,
"billID": null,
"itemName": null,
"billingStatus": null
},
{
"extension": null,
"accountNumber": "0.0.0.1-81329",
"firstName": "Nancy",
"lastName": "Miller",
"effectiveDate": 1611836594000,
"createdDate": 1611836594000,
"arActionType": 3,
"arActionAmount": -2.5,
"arUnallocatedAmount": null,
"arActionId": "A1-165",
"arActionRef": {
"id": "0.0.0.1+-item-adjustment+262194",
"uri": null
},
"billUnitName": null,
"billID": null,
"itemName": null,
"billingStatus": null
}
]