POST api/Reports/MonthlyBilling

Allows a SAFEAdmin to get the monthly billing reports for all organization in a specified time period. Allows an organization admin to get the monthly billing report for its organization. Allows a client admin to get the monthly billing reports for its client.

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:18:02.4063277-05:00",
  "EndDate": "2024-11-26T17:18:02.4063277-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:18:02.4063277-05:00</EndDate>
  <OrganizationId>1</OrganizationId>
  <StartDate>2024-11-26T17:18:02.4063277-05:00</StartDate>
</MonthlyBillingReportSearchCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The list of monthly billing reports resulting from the search.

Collection of ESignSystems.SmartSAFE.Models.Reports.MonthlyBillingReport.MonthlyBillingReportModel

Name	Description	Type	Additional information
OrganizationName	Gets or sets the name of the organization for which the monthly billing report is being conducted.	string	None.
ClientCount	Gets or sets the number of clients that conducted any SigningRoom activity in the specified time frame.	integer	None.
SigningRoomCount	Gets or sets the number of SigningRooms that were created in the specified time frame.	integer	None.
ParticipantCount	Gets or sets the number of participants that were created in the specified time frame.	integer	None.
DocumentCount	Gets or sets the number of documents that were created in the specified time frame.	integer	None.
SigningRoomWithSignedDocumentCount	Gets or sets the number of SigningRooms with at least one document signed in the specified time frame.	integer	None.
SignedENotesCount	Gets or sets the number of Smart Documents that were signed in the specified time frame.	integer	None.
MERSRegistrationCount	Gets or sets the number of documents that were registered with MERS in the specified time frame.	integer	None.
SuccessfulIncomingMERSEDeliveryCount	Gets or sets the number of successful incoming MERS EDeliveries in the specified time frame.	integer	None.
SuccessfulIncomingMERSTransferCount	Gets or sets the number of successful incoming MERS Transfers in the specified time frame.	integer	None.
TransferableRecordCount	Gets or sets the transferable record count.	integer	None.
SuccessfulIncomingTOLECTransfers	Gets the count of successful incoming transfers.	integer	None.
UpdatedBy	Gets or sets the name of the user that updated the model.	string	None.
UpdatedDate	Gets or sets the date an time that the model was updated.	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "OrganizationName": "sample string 1",
    "ClientCount": 2,
    "SigningRoomCount": 3,
    "ParticipantCount": 4,
    "DocumentCount": 5,
    "SigningRoomWithSignedDocumentCount": 6,
    "SignedENotesCount": 7,
    "MERSRegistrationCount": 8,
    "SuccessfulIncomingMERSEDeliveryCount": 9,
    "SuccessfulIncomingMERSTransferCount": 10,
    "TransferableRecordCount": 11,
    "SuccessfulIncomingTOLECTransfers": 12,
    "UpdatedBy": "sample string 13",
    "UpdatedDate": "2024-11-26T17:18:02.4063277-05:00"
  },
  {
    "OrganizationName": "sample string 1",
    "ClientCount": 2,
    "SigningRoomCount": 3,
    "ParticipantCount": 4,
    "DocumentCount": 5,
    "SigningRoomWithSignedDocumentCount": 6,
    "SignedENotesCount": 7,
    "MERSRegistrationCount": 8,
    "SuccessfulIncomingMERSEDeliveryCount": 9,
    "SuccessfulIncomingMERSTransferCount": 10,
    "TransferableRecordCount": 11,
    "SuccessfulIncomingTOLECTransfers": 12,
    "UpdatedBy": "sample string 13",
    "UpdatedDate": "2024-11-26T17:18:02.4063277-05:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfMonthlyBillingReportModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Reports.MonthlyBillingReport">
  <MonthlyBillingReportModel>
    <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 13</UpdatedBy>
    <UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2024-11-26T17:18:02.4063277-05:00</UpdatedDate>
    <ClientCount>2</ClientCount>
    <DocumentCount>5</DocumentCount>
    <MERSRegistrationCount>8</MERSRegistrationCount>
    <OrganizationName>sample string 1</OrganizationName>
    <ParticipantCount>4</ParticipantCount>
    <SignedENotesCount>7</SignedENotesCount>
    <SigningRoomCount>3</SigningRoomCount>
    <SigningRoomWithSignedDocumentCount>6</SigningRoomWithSignedDocumentCount>
    <SuccessfulIncomingMERSEDeliveryCount>9</SuccessfulIncomingMERSEDeliveryCount>
    <SuccessfulIncomingMERSTransferCount>10</SuccessfulIncomingMERSTransferCount>
    <SuccessfulIncomingTOLECTransfers>12</SuccessfulIncomingTOLECTransfers>
    <TransferableRecordCount>11</TransferableRecordCount>
  </MonthlyBillingReportModel>
  <MonthlyBillingReportModel>
    <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 13</UpdatedBy>
    <UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2024-11-26T17:18:02.4063277-05:00</UpdatedDate>
    <ClientCount>2</ClientCount>
    <DocumentCount>5</DocumentCount>
    <MERSRegistrationCount>8</MERSRegistrationCount>
    <OrganizationName>sample string 1</OrganizationName>
    <ParticipantCount>4</ParticipantCount>
    <SignedENotesCount>7</SignedENotesCount>
    <SigningRoomCount>3</SigningRoomCount>
    <SigningRoomWithSignedDocumentCount>6</SigningRoomWithSignedDocumentCount>
    <SuccessfulIncomingMERSEDeliveryCount>9</SuccessfulIncomingMERSEDeliveryCount>
    <SuccessfulIncomingMERSTransferCount>10</SuccessfulIncomingMERSTransferCount>
    <SuccessfulIncomingTOLECTransfers>12</SuccessfulIncomingTOLECTransfers>
    <TransferableRecordCount>11</TransferableRecordCount>
  </MonthlyBillingReportModel>
</ArrayOfMonthlyBillingReportModel>