Get billing statements
======================

Get billing statements.

Prerequisites
^^^^^^^^^^^^^

- Credentials as described in :doc:`/getting-started/authentication`
- An organization identifier

C#
^^

To get billing statement, first prepare an instance of the BillingStatementFilter with the required filter values.

Next, create an instance of **CrayonApiClient** and get the token using **CrayonApiClient** instance.

Then call **BillingStatements.Get()** method to get the billing statement by passing token and the filter.

.. code-block:: c#
	:emphasize-lines: 12

	var filter = new BillingStatementFilter {
		OrganizationId = <Organization Id>,
		InvoiceProfileId = <Invoice Profile Id>,
		ProvisionType = <None / Seat / Usage / OneTime / Crayon / AzureMarketplace>,
		From = <from date>,
		To = <to date>,
		Page = <page number>,
		PageSize = <page size>
	};
	var client = new CrayonApiClient("https://api.crayon.com/");
	var token = client.Tokens.GetUserToken(clientId, clientSecret, userName, password).GetData().AccessToken;	
	var result = client.BillingStatements.Get(token, filter);


Request
^^^^^^^

Request Syntax:

+---------+------------------------------------------------------------------------------------------------------------------------+
| Method  | Request URI                                                                                                            |
+=========+========================================================================================================================+
| GET     | *https://api.crayon.com/api/v1/billingstatements/?organizationId={organizationId}&page={page}&pageSize={pageSize}*     |
+---------+------------------------------------------------------------------------------------------------------------------------+

Request Parameters:

+------------------+----------------+------------------------------------------------------------------------------+----------------+
| Name             | Type           | Description                                                                  |     Required   |
+==================+================+==============================================================================+================+
| organizationId   | int            | organization id                                                              |     YES        |
+------------------+----------------+------------------------------------------------------------------------------+----------------+
| invoiceProfileId | int            | Invoice Profile id                                                           |     NO         |
+------------------+----------------+------------------------------------------------------------------------------+----------------+
| provisionType    | Enum           | None = 0, Seat = 1, Usage = 2, OneTime = 3, Crayon = 4, AzureMarketplace = 5 |     NO         |
+------------------+----------------+------------------------------------------------------------------------------+----------------+
| from             | DateTimeOffset | from date                                                                    |     NO         |
+------------------+----------------+------------------------------------------------------------------------------+----------------+
| to               | DateTimeOffset | to date                                                                      |     NO         |
+------------------+----------------+------------------------------------------------------------------------------+----------------+
| page             | int            | Pagination, starts at page 1                                                 |     NO         |
+------------------+----------------+------------------------------------------------------------------------------+----------------+
| pageSize         | int            | Pagination, Number of objects to return                                      |     NO         |
+------------------+----------------+------------------------------------------------------------------------------+----------------+

Request Headers:

The following HTTP request headers are supported

+------------------+----------------+-----------------------------------------------------------------+
| Header           | Type           | Description                                                     |
+==================+================+=================================================================+
| Authorization    | string         | Required. The authorization token in the form Bearer <token>.   |
+------------------+----------------+----------------------------------------------+------------------+
| Accept           | string         | Specifies the request and response type, "application/json".    |
+------------------+----------------+----------------------------------------------+------------------+
| Content-Type     | string         | Specifies the media type of the resource, "application/json".   |
+------------------+----------------+----------------------------------------------+------------------+

Request Example:

::

	GET $"https://api.crayon.com/api/v1/billingstatements/?organizationId={organizationId}&page={page}&pageSize={pageSize}"
	Accept : application/json
	Content-Type: application/json
	Authorization : Bearer < Token >
	
Response
^^^^^^^^ 

If successful, this method returns a collection of :doc:`/resources/BillingStatement` resource in the response body.


.. literalinclude:: /resources/_static/BillingStatement.json
        :language: json
	
Response success and error codes:

Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use a network trace tool to read this code, error type, and additional parameters.

+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Error Codes                    | Description                                                                                                                                                                                                                                                                               |
+================================+===========================================================================================================================================================================================================================================================================================+
| 200 Ok                         | The request has succeeded.                                                                                                                                                                                                                                                                |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 401 Unauthorized               | The request requires user authentication. If the request already included Authorization credentials, then the 401 (Unauthorized) status code means that authorization has been refused for those credentials. It is a non-retryable error condition.                                      |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+