Get Unallocated Payments for an Account

get

/bcws/webresources/v1.0/payments/account/{id}

Gets the list of unallocated payments for an account.

Both the id parameter and the type query parameter are required.

Request

Path Parameters
  • The ID of the account you are retrieving payments for, such as 0.0.0.1+-account+123123.
Query Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The unallocated payments were returned successfully.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : paymentList
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 to get an account's unallocated payments 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/payments/account/0.0.0.1+-account+57615?type=unallocated'

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.

Example of Response Body

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

[
    {
        "extension": null,
        "paymentAmount": -8.5,
        "paymentDate": 1590641967000,
        "paymentId": "P1-56",
        "paymentMethod": 10011,
        "unAllocatedAmount": -1.55,
        "originalPaymentAmount": null,
        "paymentAction": null,
        "billingStatus": null,
        "paymentRef": {
            "id": "0.0.0.1+-item-payment+122952",
            "uri": null
        }
    },
    {
        "extension": null,
        "paymentAmount": -3,
        "paymentDate": 1594928886000,
        "paymentId": "P1-216",
        "paymentMethod": 10011,
        "unAllocatedAmount": -3,
        "originalPaymentAmount": null,
        "paymentAction": null,
        "billingStatus": null,
        "paymentRef": {
            "id": "0.0.0.1+-item-payment+122389",
            "uri": null
        }
    },
    {
        "extension": null,
        "paymentAmount": -1,
        "paymentDate": 1600689352000,
        "paymentId": "P1-281",
        "paymentMethod": 10011,
        "unAllocatedAmount": -1,
        "originalPaymentAmount": null,
        "paymentAction": null,
        "billingStatus": null,
        "paymentRef": {
            "id": "0.0.0.1+-item-payment+156894",
            "uri": null
        }
    },
    {
        "extension": null,
        "paymentAmount": -1,
        "paymentDate": 1600689439000,
        "paymentId": "P1-282",
        "paymentMethod": 10011,
        "unAllocatedAmount": -2,
        "originalPaymentAmount": null,
        "paymentAction": null,
        "billingStatus": null,
        "paymentRef": {
            "id": "0.0.0.1+-item-payment+157440",
            "uri": null
        }
    },
    {
        "extension": null,
        "paymentAmount": -1,
        "paymentDate": 1608705956000,
        "paymentId": "P1-390",
        "paymentMethod": 10011,
        "unAllocatedAmount": -1,
        "originalPaymentAmount": null,
        "paymentAction": null,
        "billingStatus": null,
        "paymentRef": {
            "id": "0.0.0.1+-item-payment+216361",
            "uri": null
        }
    },
    {
        "extension": null,
        "paymentAmount": -1,
        "paymentDate": 1608706413000,
        "paymentId": "P1-391",
        "paymentMethod": 10011,
        "unAllocatedAmount": -1,
        "originalPaymentAmount": null,
        "paymentAction": null,
        "billingStatus": null,
        "paymentRef": {
            "id": "0.0.0.1+-item-payment+210777",
            "uri": null
        }
    },
    {
        "extension": null,
        "paymentAmount": -1,
        "paymentDate": 1608719228000,
        "paymentId": "P1-402",
        "paymentMethod": 10011,
        "unAllocatedAmount": -1,
        "originalPaymentAmount": null,
        "paymentAction": null,
        "billingStatus": null,
        "paymentRef": {
            "id": "0.0.0.1+-item-payment+216776",
            "uri": null
        }
    }
]
Back to Top