GET api/v1/reports/monthlystatement?Month={Month}&Year={Year}&SoftwareVersion={SoftwareVersion}

Retrieves a Monthly Statement Report showing a summary of the monthly and a daily breakdown

Request Information

URI Parameters

Name	Description	Type	Additional information
Month	Month	string	None.
Year	Year	string	None.

Body Parameters

None.

Response Information

Resource Description

TwoSms.CustomerPortalRole.API.Misc.ResponseOfTwoSms.CustomerPortalRole.API.Reports.MonthlyStatementReportResponse

Name	Description	Type	Additional information
Error		TwoSms.CustomerPortalRole.API.Misc.Error	None.
ResponseData		TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfTwoSms.CustomerPortalRole.API.Reports.MonthlyStatementReportResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": {
      "Date": "sample string 1",
      "AccountName": "sample string 2",
      "Summary": [
        {
          "ValueType": "sample string 1",
          "DayDate": "sample string 2",
          "Tier1Country": "sample string 3",
          "Tier2Country": "sample string 4",
          "Tier3Country": "sample string 5",
          "FailedWrongNumber": "sample string 6",
          "InvalidNumber": "sample string 7",
          "IntlFailedWrongNumber": "sample string 8",
          "Outbound": "sample string 9",
          "IntlOutbound": "sample string 10",
          "IntlFailedStop": "sample string 11",
          "IntlInvalidNumber": "sample string 12",
          "IntlTotalOutbound": "sample string 13",
          "USFailedInvalidNumber": "sample string 14",
          "FailedStop": "sample string 15",
          "TotalOutbound": "sample string 16",
          "Inbound": "sample string 17",
          "Reports": "sample string 18",
          "Emails": "sample string 19",
          "Receipts": "sample string 20",
          "WMRS": "sample string 21",
          "Meeting": "sample string 22",
          "Forwarding": "sample string 23",
          "Total": "sample string 24",
          "TotalCreditUsage": "sample string 25"
        },
        {
          "ValueType": "sample string 1",
          "DayDate": "sample string 2",
          "Tier1Country": "sample string 3",
          "Tier2Country": "sample string 4",
          "Tier3Country": "sample string 5",
          "FailedWrongNumber": "sample string 6",
          "InvalidNumber": "sample string 7",
          "IntlFailedWrongNumber": "sample string 8",
          "Outbound": "sample string 9",
          "IntlOutbound": "sample string 10",
          "IntlFailedStop": "sample string 11",
          "IntlInvalidNumber": "sample string 12",
          "IntlTotalOutbound": "sample string 13",
          "USFailedInvalidNumber": "sample string 14",
          "FailedStop": "sample string 15",
          "TotalOutbound": "sample string 16",
          "Inbound": "sample string 17",
          "Reports": "sample string 18",
          "Emails": "sample string 19",
          "Receipts": "sample string 20",
          "WMRS": "sample string 21",
          "Meeting": "sample string 22",
          "Forwarding": "sample string 23",
          "Total": "sample string 24",
          "TotalCreditUsage": "sample string 25"
        }
      ],
      "DailyBreakdown": [
        {
          "ValueType": "sample string 1",
          "DayDate": "sample string 2",
          "Tier1Country": "sample string 3",
          "Tier2Country": "sample string 4",
          "Tier3Country": "sample string 5",
          "FailedWrongNumber": "sample string 6",
          "InvalidNumber": "sample string 7",
          "IntlFailedWrongNumber": "sample string 8",
          "Outbound": "sample string 9",
          "IntlOutbound": "sample string 10",
          "IntlFailedStop": "sample string 11",
          "IntlInvalidNumber": "sample string 12",
          "IntlTotalOutbound": "sample string 13",
          "USFailedInvalidNumber": "sample string 14",
          "FailedStop": "sample string 15",
          "TotalOutbound": "sample string 16",
          "Inbound": "sample string 17",
          "Reports": "sample string 18",
          "Emails": "sample string 19",
          "Receipts": "sample string 20",
          "WMRS": "sample string 21",
          "Meeting": "sample string 22",
          "Forwarding": "sample string 23",
          "Total": "sample string 24",
          "TotalCreditUsage": "sample string 25"
        },
        {
          "ValueType": "sample string 1",
          "DayDate": "sample string 2",
          "Tier1Country": "sample string 3",
          "Tier2Country": "sample string 4",
          "Tier3Country": "sample string 5",
          "FailedWrongNumber": "sample string 6",
          "InvalidNumber": "sample string 7",
          "IntlFailedWrongNumber": "sample string 8",
          "Outbound": "sample string 9",
          "IntlOutbound": "sample string 10",
          "IntlFailedStop": "sample string 11",
          "IntlInvalidNumber": "sample string 12",
          "IntlTotalOutbound": "sample string 13",
          "USFailedInvalidNumber": "sample string 14",
          "FailedStop": "sample string 15",
          "TotalOutbound": "sample string 16",
          "Inbound": "sample string 17",
          "Reports": "sample string 18",
          "Emails": "sample string 19",
          "Receipts": "sample string 20",
          "WMRS": "sample string 21",
          "Meeting": "sample string 22",
          "Forwarding": "sample string 23",
          "Total": "sample string 24",
          "TotalCreditUsage": "sample string 25"
        }
      ]
    }
  }
}

application/xml, text/xml

Sample:

<ResponseOfMonthlyStatementReportResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail>
      <Date>sample string 1</Date>
      <AccountName>sample string 2</AccountName>
      <Summary>
        <MonthlyStatementData>
          <ValueType>sample string 1</ValueType>
          <DayDate>sample string 2</DayDate>
          <Tier1Country>sample string 3</Tier1Country>
          <Tier2Country>sample string 4</Tier2Country>
          <Tier3Country>sample string 5</Tier3Country>
          <FailedWrongNumber>sample string 6</FailedWrongNumber>
          <InvalidNumber>sample string 7</InvalidNumber>
          <IntlFailedWrongNumber>sample string 8</IntlFailedWrongNumber>
          <Outbound>sample string 9</Outbound>
          <IntlOutbound>sample string 10</IntlOutbound>
          <IntlFailedStop>sample string 11</IntlFailedStop>
          <IntlInvalidNumber>sample string 12</IntlInvalidNumber>
          <IntlTotalOutbound>sample string 13</IntlTotalOutbound>
          <USFailedInvalidNumber>sample string 14</USFailedInvalidNumber>
          <FailedStop>sample string 15</FailedStop>
          <TotalOutbound>sample string 16</TotalOutbound>
          <Inbound>sample string 17</Inbound>
          <Reports>sample string 18</Reports>
          <Emails>sample string 19</Emails>
          <Receipts>sample string 20</Receipts>
          <WMRS>sample string 21</WMRS>
          <Meeting>sample string 22</Meeting>
          <Forwarding>sample string 23</Forwarding>
          <Total>sample string 24</Total>
          <TotalCreditUsage>sample string 25</TotalCreditUsage>
        </MonthlyStatementData>
        <MonthlyStatementData>
          <ValueType>sample string 1</ValueType>
          <DayDate>sample string 2</DayDate>
          <Tier1Country>sample string 3</Tier1Country>
          <Tier2Country>sample string 4</Tier2Country>
          <Tier3Country>sample string 5</Tier3Country>
          <FailedWrongNumber>sample string 6</FailedWrongNumber>
          <InvalidNumber>sample string 7</InvalidNumber>
          <IntlFailedWrongNumber>sample string 8</IntlFailedWrongNumber>
          <Outbound>sample string 9</Outbound>
          <IntlOutbound>sample string 10</IntlOutbound>
          <IntlFailedStop>sample string 11</IntlFailedStop>
          <IntlInvalidNumber>sample string 12</IntlInvalidNumber>
          <IntlTotalOutbound>sample string 13</IntlTotalOutbound>
          <USFailedInvalidNumber>sample string 14</USFailedInvalidNumber>
          <FailedStop>sample string 15</FailedStop>
          <TotalOutbound>sample string 16</TotalOutbound>
          <Inbound>sample string 17</Inbound>
          <Reports>sample string 18</Reports>
          <Emails>sample string 19</Emails>
          <Receipts>sample string 20</Receipts>
          <WMRS>sample string 21</WMRS>
          <Meeting>sample string 22</Meeting>
          <Forwarding>sample string 23</Forwarding>
          <Total>sample string 24</Total>
          <TotalCreditUsage>sample string 25</TotalCreditUsage>
        </MonthlyStatementData>
      </Summary>
      <DailyBreakdown>
        <MonthlyStatementData>
          <ValueType>sample string 1</ValueType>
          <DayDate>sample string 2</DayDate>
          <Tier1Country>sample string 3</Tier1Country>
          <Tier2Country>sample string 4</Tier2Country>
          <Tier3Country>sample string 5</Tier3Country>
          <FailedWrongNumber>sample string 6</FailedWrongNumber>
          <InvalidNumber>sample string 7</InvalidNumber>
          <IntlFailedWrongNumber>sample string 8</IntlFailedWrongNumber>
          <Outbound>sample string 9</Outbound>
          <IntlOutbound>sample string 10</IntlOutbound>
          <IntlFailedStop>sample string 11</IntlFailedStop>
          <IntlInvalidNumber>sample string 12</IntlInvalidNumber>
          <IntlTotalOutbound>sample string 13</IntlTotalOutbound>
          <USFailedInvalidNumber>sample string 14</USFailedInvalidNumber>
          <FailedStop>sample string 15</FailedStop>
          <TotalOutbound>sample string 16</TotalOutbound>
          <Inbound>sample string 17</Inbound>
          <Reports>sample string 18</Reports>
          <Emails>sample string 19</Emails>
          <Receipts>sample string 20</Receipts>
          <WMRS>sample string 21</WMRS>
          <Meeting>sample string 22</Meeting>
          <Forwarding>sample string 23</Forwarding>
          <Total>sample string 24</Total>
          <TotalCreditUsage>sample string 25</TotalCreditUsage>
        </MonthlyStatementData>
        <MonthlyStatementData>
          <ValueType>sample string 1</ValueType>
          <DayDate>sample string 2</DayDate>
          <Tier1Country>sample string 3</Tier1Country>
          <Tier2Country>sample string 4</Tier2Country>
          <Tier3Country>sample string 5</Tier3Country>
          <FailedWrongNumber>sample string 6</FailedWrongNumber>
          <InvalidNumber>sample string 7</InvalidNumber>
          <IntlFailedWrongNumber>sample string 8</IntlFailedWrongNumber>
          <Outbound>sample string 9</Outbound>
          <IntlOutbound>sample string 10</IntlOutbound>
          <IntlFailedStop>sample string 11</IntlFailedStop>
          <IntlInvalidNumber>sample string 12</IntlInvalidNumber>
          <IntlTotalOutbound>sample string 13</IntlTotalOutbound>
          <USFailedInvalidNumber>sample string 14</USFailedInvalidNumber>
          <FailedStop>sample string 15</FailedStop>
          <TotalOutbound>sample string 16</TotalOutbound>
          <Inbound>sample string 17</Inbound>
          <Reports>sample string 18</Reports>
          <Emails>sample string 19</Emails>
          <Receipts>sample string 20</Receipts>
          <WMRS>sample string 21</WMRS>
          <Meeting>sample string 22</Meeting>
          <Forwarding>sample string 23</Forwarding>
          <Total>sample string 24</Total>
          <TotalCreditUsage>sample string 25</TotalCreditUsage>
        </MonthlyStatementData>
      </DailyBreakdown>
    </Detail>
  </ResponseData>
</ResponseOfMonthlyStatementReportResponse>