Get invoice profile
===================

Get invoice profile by id

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

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

C#
^^

To get invoice profile, first create an instance of **CrayonApiClient** and get the token using **CrayonApiClient** instance.

Then call **InvoiceProfiles.GetById()** method to get an invoice profile by passing token and invoice profile id.

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

	var id = <invoice profile identifier>;
	var client = new CrayonApiClient("https://api.crayon.com/");
	var token = client.Tokens.GetUserToken(clientId, clientSecret, userName, password).GetData().AccessToken;
	
	var result = client.InvoiceProfiles.GetById(token, id);

Request
^^^^^^^

Request Syntax:

+---------+-------------------------------------------------------------+
| Method  | Request URI                                                 |
+=========+=============================================================+
| GET     | *https://api.crayon.com/api/v1/invoiceprofiles/{id}/*        |
+---------+-------------------------------------------------------------+
	
Request Parameters:

+-------+-----------+----------------------------------------------------------------------+
| Name  | Type      | Description                                                          |
+=======+===========+======================================================================+
| id	| int       | Identifier for invoice profile                                       |
+-------+-----------+----------------------------------------------------------------------+

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/invoiceprofiles/{id}/"
	Accept : application/json
	Content-Type: application/json 
	Authorization : Bearer < Token >


Response
^^^^^^^^

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

.. literalinclude:: /resources/_static/InvoiceProfile.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.                                      |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+