Get billing statement reconciliation file ========================================= Get billing statement csv file that describes the monthly billing. Prerequisites ^^^^^^^^^^^^^ - Credentials as described in :doc:`/getting-started/authentication` - An billings statement id as described in :doc:`/scenarios/billingstatements-get` Request ^^^^^^^ Request Syntax: +---------+------------------------------------------------------------------------------------------------------------------------+ | Method | Request URI | +=========+========================================================================================================================+ | GET | *https://api.crayon.com/api/v1/billingstatements/{id}/reconciliationfile/* | +---------+------------------------------------------------------------------------------------------------------------------------+ Request Parameters: +------------------+----------------+-------------------------------------------+----------------+ | Name | Type | Description | Required | +==================+================+===========================================+================+ | id | int | The billing statement id | YES | +------------------+----------------+-------------------------------------------+----------------+ 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 response type, "application/json" or "application/octet-stream" | +------------------+----------------+-------------------------------------------------------------------------------+ Request Example: :: GET $"https://api.crayon.com/api/v1/billingstatements/{id}/reconciliationfile/" Accept : application/json Authorization : Bearer < Token > Response ^^^^^^^^ If successful, this method returns a BillingStatementReconciliationFile object of :doc:`/resources/BillingStatementReconciliationFile` resource in the response body. The data property contains byte array with the csv file. If csv file is split into more then one file. Then a zip file is returned with multiple files. .. literalinclude:: /resources/_static/BillingStatementReconciliationFile.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. | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+