Create invoice profile ====================== Creates an invoice profile Prerequisites ^^^^^^^^^^^^^ - Credentials as described in :doc:`/getting-started/authentication` - An organization identifier - An invoice address identifier C# ^^ To create invoice profile, first instantiate **InvoiceProfile** and add the required properties with values. Next, get the instance of **CrayonApiClient** and get the token using the instance. Finally, call **InvoiceProfiles.Create()** method to create invoice profile by passing token and the instance of **InvoiceProfile**. .. code-block:: c# :emphasize-lines: 14 var invoiceProfile = new InvoiceProfile { Organization = new ObjectReference { Id = }, Name = "", InvoiceAddressId = , InvoiceReference = "" }; var client = new CrayonApiClient("https://api.crayon.com/"); var token = client.Tokens.GetUserToken(clientId, clientSecret, userName, password).GetData().AccessToken; var result = client.InvoiceProfiles.Create(token, invoiceProfile); Request ^^^^^^^ Request Syntax: +---------+-------------------------------------------------------------+ | Method | Request URI | +=========+=============================================================+ | POST | *https://api.crayon.com/api/v1/invoiceprofiles/* | +---------+-------------------------------------------------------------+ Request Body: +-----------------+----------------------------------+--------------------------------------+ | Name | Type | Description | +=================+==================================+======================================+ | invoice profile | :doc:`/resources/InvoiceProfile` | The invoice profile to create | +-----------------+----------------------------------+--------------------------------------+ Request Headers: The following HTTP request headers are supported +------------------+----------------+-----------------------------------------------------------------+ | Header | Type | Description | +==================+================+=================================================================+ | Authorization | string | Required. The authorization token in the form Bearer . | +------------------+----------------+----------------------------------------------+------------------+ | Accept | string | Specifies the request and response type, "application/json". | +------------------+----------------+----------------------------------------------+------------------+ | Content-Type | string | Specifies the media type of the resource, "application/json". | +------------------+----------------+----------------------------------------------+------------------+ Request Example: :: POST $"https://api.crayon.com/api/v1/invoiceprofiles/" Accept : application/json Content-Type: application/json Authorization : Bearer < Token > .. literalinclude:: /scenarios/_static/InvoiceProfileRequest.json :language: json Response ^^^^^^^^ If successful, this method returns the created invoice profile as 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. | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 400 Bad Request | The request could not be understood by the server due to malformed syntax, missing required properties, properties that couldn't be parsed according to their type (and length). It is a non-retryable error condition. The client should not repeat the request without modifications. | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+