GET api/BillingReport?userid={userid}&token={token}&beginDocumentDate={beginDocumentDate}&endDocumentDate={endDocumentDate}&includeNonViewingRoles={includeNonViewingRoles}

Request Information

URI Parameters

Name	Type	Additional information
userid	string	Default value is
token	string	Default value is
beginDocumentDate	date	None.
endDocumentDate	date	None.
includeNonViewingRoles	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

BillingReportGetResponse

Name	Description	Type	Additional information
Data		BillingReport	None.
Response		BaseResponseItems	None.

Response Formats

application/json, text/json

Sample:

{
  "Data": {
    "Items": [
      {
        "SubjectId": "sample string 1",
        "DocumentDescription": "sample string 2",
        "Type": "sample string 3",
        "ExtraInformation": "sample string 4",
        "AdditionalColumns": "sample string 5",
        "Action": "sample string 6",
        "RealName": "sample string 7",
        "ViewingSeconds": 8,
        "DateSigned": "2025-08-20T15:29:30.9940102+00:00",
        "DocumentDate": "2025-08-20T15:29:30.9940102+00:00"
      },
      {
        "SubjectId": "sample string 1",
        "DocumentDescription": "sample string 2",
        "Type": "sample string 3",
        "ExtraInformation": "sample string 4",
        "AdditionalColumns": "sample string 5",
        "Action": "sample string 6",
        "RealName": "sample string 7",
        "ViewingSeconds": 8,
        "DateSigned": "2025-08-20T15:29:30.9940102+00:00",
        "DocumentDate": "2025-08-20T15:29:30.9940102+00:00"
      }
    ]
  },
  "Response": {
    "Processed": "sample string 1",
    "Error": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<BillingReportGetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignAPI.Models.Responses">
  <Response>
    <Error>sample string 2</Error>
    <Processed>sample string 1</Processed>
  </Response>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/ESignAPI.Models.DTOs">
    <d2p1:Items>
      <d2p1:BillingReportItem>
        <d2p1:Action>sample string 6</d2p1:Action>
        <d2p1:AdditionalColumns>sample string 5</d2p1:AdditionalColumns>
        <d2p1:DateSigned>2025-08-20T15:29:30.9940102+00:00</d2p1:DateSigned>
        <d2p1:DocumentDate>2025-08-20T15:29:30.9940102+00:00</d2p1:DocumentDate>
        <d2p1:DocumentDescription>sample string 2</d2p1:DocumentDescription>
        <d2p1:ExtraInformation>sample string 4</d2p1:ExtraInformation>
        <d2p1:RealName>sample string 7</d2p1:RealName>
        <d2p1:SubjectId>sample string 1</d2p1:SubjectId>
        <d2p1:Type>sample string 3</d2p1:Type>
        <d2p1:ViewingSeconds>8</d2p1:ViewingSeconds>
      </d2p1:BillingReportItem>
      <d2p1:BillingReportItem>
        <d2p1:Action>sample string 6</d2p1:Action>
        <d2p1:AdditionalColumns>sample string 5</d2p1:AdditionalColumns>
        <d2p1:DateSigned>2025-08-20T15:29:30.9940102+00:00</d2p1:DateSigned>
        <d2p1:DocumentDate>2025-08-20T15:29:30.9940102+00:00</d2p1:DocumentDate>
        <d2p1:DocumentDescription>sample string 2</d2p1:DocumentDescription>
        <d2p1:ExtraInformation>sample string 4</d2p1:ExtraInformation>
        <d2p1:RealName>sample string 7</d2p1:RealName>
        <d2p1:SubjectId>sample string 1</d2p1:SubjectId>
        <d2p1:Type>sample string 3</d2p1:Type>
        <d2p1:ViewingSeconds>8</d2p1:ViewingSeconds>
      </d2p1:BillingReportItem>
    </d2p1:Items>
  </Data>
</BillingReportGetResponse>