Get billing statement reconciliation file

Get billing statement csv file that describes the monthly billing.

Prerequisites

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 <token>.
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 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.

{
  "FileName": "customer-reconciliation.csv",
  "Data": "IJQRJwzoQUcB2ZpLajtrTdiJqTAbIiHPCJnQgoYA7O0FIQt7XK8bcRMKEG1K75eFICZUALGwCytBGFf28FMCEG1NW6YCSHgODBLC0FtX71Jzqq98DWLTpuxrsD6AhtazA62YX+5ec6qbWzDjIZ3MBOLAsbALL0oCJvFDmZCBap96nprMoaciTWBwaKcrVWgUWsKEeAdZuRMiABjyFlaBMLuryNnQgN4AxnMhAYwBmZpDQibuw5mYkHA+8NgJjSAMTBLa0DYu3UwExrA279gJjSAMTBLa0Bto7hRPxMawLu7YCY0gDEwS2tAbR+4ETOhAbx5C2ZCAxgDs7QG1LZ5GzETGsB7s2AmNIAxMEtrQG0Xtwkz3mbttBnrCqwvsKHF7HgWtkWb3wG8iwpmQgMYAzOxFDBYxGy9FGiUM6EBvHGKnImVAGPIWXolEPZMHTkTGsDbrmAmNIAxMEtrQNhxdTATGsCbtmAmNIAxMEtrQG17t1FrCg3gHV8wExrAGJilNWBvvSnUiJnQgFBEtA5gDHeA2BMyWHQHrA8LGzETGrAntoQYAzOxJWSwiNn6LLARM6EBe2JHiDEwEztCBouYrY/6GjETGlA8t8UeW6CfCQ1gDP0srQHFsypWuy5NmIXwaD+IsW6bsb7AhhazOSseiOJhJraDQhHRHcAYmAkNMFjEzKcB+0IDGEPOhAYwhpylNWDftw4I4XFr0ngPZkIDGAOztAbsrzeDGvUzoQGhiLg1hQZwHJilNaBw73v6mdCAUETMTGgAx4FZWgP2fRoQwuPWFOcCHIc7QGiAwaI7wKcB+0IDGEM/E+sAxpCz9Dpg36cBITzOmdAAjkPOhAYYLMqZTwP2hQYwhpwJDWAMOUtrwIFPA0J4lDPGum3G+gIbWszm7MCnASE8ZibWARwHZkIDDBYx82nAgdAAxpAzoQGMIWdpDTjwaUAIj3MmNIDjkDOKA7O0BhTP6nOMtCE8ZkbjPXImNIAxMEtrwIFPA0J4zIzGezATGsAYmKU14MCnASE8ZiY0gOPQmkIDDBbdAT4NOBAawBhyJjSAMeQsrQEHPg0I4XHOhAZwHHImNMBgUc58GnAgNIAx5ExoAGPIWVoDDn0aEMKjnDHWbTPWF9jQYjZnhz4NCOExM6EBHAdmQgMMFjHzacCh0ADGkDOhAYwhZ2kNOPRpQAiPcyY0gOOQM6EBBoty5tMAPA87WvXimRhCAxgDM4pDztIacOjTgBAe50xoAMeBGcWBWVoDDn0aEMJjZkIDOA7MhAYYLGpNnwYcCg1gDHeA0ADGkLO0Bhz6NCCExzkTGsBxyJnQAINFOfNpwKHQAMaQM6EBjCFnSQ3ACws887My3OZMYF2B9QU2tJjJWbbt0oAyPGbGGiDiwIw1wGIRM5cGZNusAQJDzlgDBIacJTUg23ZpQBke54w1QMQhZ6wBFoty5tKAbJs1QGDIGa8DBIacJTUg23ZpQBke54w1QMQhZ6wBFoty5tKAbJvPAwSGnPGZsMCQs+SZcLbt0oAyPM4ZnweIOOSMzwMsFuXMpQHZNp8HCAw5ozgwYw2wWMTMpQHZNmuAwMCMNUBgaM20BtSebtlgnzarnvtY+/aNwLoC6wtsaDGbs/B4xsaniNnqaY7m+WOMgRl/L0hgYJb8XlAWnsLoYCY0YPUgx/rXfctizZ2CnNG1YJbWgOIlE813XLIQHt2bjCFnfB4gMDBL7gVlhZXGw0xoQCjCsAUzoQGMgVlaA8IjJh2tyecBmXlKZfk9R4GhNYUGpJ9wmdUecdno3hQaYJ4vWTETGsBxyFlaA8JjHR0543VAZp4MWTHjdYCIA7PkOiALD2x0MBMaYJ75WDETGsBxYFaPi8YznwbwoyA7GWO4A4QGMAZmaQ2oPfyxST9TT3pkrJsx1hfY0GI2Z+GhiM1bUz21kTEwExrAGJilNSA8utDBTGgAPxARzMQ6gDEwS2tAeMCggxmN7Z2Mn2QIZkIDGAOztAaExwA6mAkN4OcNgpnQAMbALK0B4WF9DmZCA/ipgGDG5wECA7PkXlAWHrznYCY0gJ/dB2ZCAxgDs7QGhMfjOZgJDeAn7IGZ0ADGwCytAeFRdw5mQgP4aXlgJjSAMTBLa0B4kp2DmVgHVA/Dq32jPGMMIy1dC2ZpDahZk5toQOVMrq8DGOtmjPUFNrSY1YCaa7gRM/5eUMZmYDATGiBMwzYuYubbC2LfbydjDMyEBgjPsI2LmPnWAWz7BTOxF8QYWlPsBaUtw1nNMtyoNYUGsBMYORMaIBzDNi7KmW8viE2/yJnYCxKGYRGHOyCtAcGw23zUYM8vmPF5gMDQmnweYLEoZ769ILb8gpnYCxJ2YRGHnKU1oGYXbtTPhAYIt3Am3MICA7O0BtTcwo2YCQ0QZuFMmIUFBmZpDaiZhZswE17hTHiFBdYX2NBitp/VvMKNmAkNEFbhTFiFBQZm6XVAsOo2vzfZ7dvJhFNYYMiZ2AtKO4WzmlO4Uc7EOkAYhctio10qYRS2cVFr+vaC2OuLnNF43xUYckZxaM30OsDnE86ET1hgYCbWAcInbOOinPnOA9jri5wJDWAMORMakPYJZz6fcBke7TkKn7CIAzNxHpD2CWc+n3AZHjPjM2ERB2biPCDtE858PuEyPGZGuoB+JvaChE/Yxtl+5vMJZ8InLLCuwPoCG1osYuY7ExY+4YwxMBPrAOETtnERM986gL2+eGMBje1gJtYBwids4yJmvnUAe33BTKwDhE9YxKE103tBPp9wxl5fMBMaIHzCIg7M0hrg8wln7PUFM7EOED5hEQdm6XWAzyecsdcXzIQGCJ+wiAOz9F6QzyeMN5XTt7wEhjtA7AUJn7CNi+4A35kwe32RM6EBwics4pCz9DrA5xPO2OsLZkIDhE9YxIFZeh3g8wlnwicssK7A+gIbWsy2ps8nnAmfsMDATGiA8AnbuIiZTw"
}

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.