POST api/Reports/MonthlyBilling/Download

Download a CSV file of monthly billing data retrieved using the search criteria.

Request Information

URI Parameters

None.

Body Parameters

The monthly billing report search criteria.

ESignSystems.SmartSAFE.Models.Reports.MonthlyBillingReport.MonthlyBillingReportSearchCriteria

Name	Description	Type	Additional information
OrganizationId	Gets or sets property to search by organization identifier.	integer	None.
ClientId	Gets or sets property to search by client identifier.	integer	None.
StartDate	Gets or sets property to search for monthly billing report data created after the given date.	date	Required
EndDate	Gets or sets property to search for monthly billing report data created before the given date.	date	Required
PageSize	Gets or sets the number of rows in the page.	integer	Range: inclusive between 1 and 2147483647
PageOffset	Gets or sets the offset page to return.	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "OrganizationId": 1,
  "ClientId": 1,
  "StartDate": "2024-11-26T17:26:50.735914-05:00",
  "EndDate": "2024-11-26T17:26:50.735914-05:00",
  "PageSize": 1,
  "PageOffset": 1
}

application/xml, text/xml

Sample:

<MonthlyBillingReportSearchCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Reports.MonthlyBillingReport">
  <PageOffset xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">1</PageOffset>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">1</PageSize>
  <ClientId>1</ClientId>
  <EndDate>2024-11-26T17:26:50.735914-05:00</EndDate>
  <OrganizationId>1</OrganizationId>
  <StartDate>2024-11-26T17:26:50.735914-05:00</StartDate>
</MonthlyBillingReportSearchCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A CSV file of monthly billing data.

ESignSystems.SmartSAFE.Models.Shared.FileDownloadModel

Name	Description	Type	Additional information
File	Gets or sets the file to be downloaded.	Collection of byte	None.
FileName	Gets or sets the name of the file to be downloaded.	string	None.
MimeType	Gets or sets the mime type of the file to be downloaded.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "File": "QEA=",
  "FileName": "sample string 1",
  "MimeType": "sample string 2"
}

application/xml, text/xml

Sample:

<FileDownloadModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Shared">
  <File>QEA=</File>
  <FileName>sample string 1</FileName>
  <MimeType>sample string 2</MimeType>
</FileDownloadModel>