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

Get an Invoice PDF by Bill ID

get

/bcws/webresources/v1.0/bills/invoice/{id}

Gets the invoice PDF for the bill that matches the specified ID. The invoice is retrieved from the Business Intelligence (BI) Publisher web service. This endpoint automatically opens the invoice in PDF format.

Request

Path Parameters
Query Parameters

There's no request body for this operation.

Back to Top

Response

200 Response

The invoice PDF was returned successfully.

500 Response

An internal server error occurred.
Back to Top

Examples

This example shows how to get an an invoice PDF by bill ID 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/invoice/0.0.0.1+-bill+308426205730869579?number=B1-9'

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

If successful, the response code 200 is returned with the invoice document in PDF format.
Back to Top