POST v1/billingstatementSummary/generate

Documentation for 'Generate'.

Request Information

Parameters

NameDescriptionAdditional information
entity 
Documentation for 'entity'.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
Click to beautify! 
{
  "customerId": 1,
  "startDate": "2024-05-03T08:30:26.6159227+00:00",
  "endDate": "2024-05-03T08:30:26.6159227+00:00",
  "trackedItemDisplay": {
    "trackedItemDisplayFormat": "sample string 1",
    "showTrackedItemName": {},
    "showTrackedItemReference": {},
    "showTrackedItemDescription": {},
    "showTrackedItemCreatedDate": {}
  },
  "statementActivityType": "sample string 4",
  "showWordStatement": true
}

application/xml, text/xml

Sample:
Click to beautify! 
<BillingStatementGenerate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Dto.Post">
  <EndDate>2024-05-03T08:30:26.6159227+00:00</EndDate>
  <StartDate>2024-05-03T08:30:26.6159227+00:00</StartDate>
</BillingStatementGenerate>

application/x-www-form-urlencoded

Sample:
Click to beautify!

Sample not available.

Response Information

Response body formats

application/json, text/json

Sample:
Click to beautify! 
{
  "transactionSummary": [
    {
      "transactionType": "sample string 1",
      "arDebit": 2.0,
      "arCredit": 3.0,
      "runningTotal": 4.0
    },
    {
      "transactionType": "sample string 1",
      "arDebit": 2.0,
      "arCredit": 3.0,
      "runningTotal": 4.0
    },
    {
      "transactionType": "sample string 1",
      "arDebit": 2.0,
      "arCredit": 3.0,
      "runningTotal": 4.0
    }
  ],
  "header": {
    "signature": "sample string 1",
    "customer": {
      "fullName": "sample string 1",
      "companyName": "sample string 2",
      "billingAddress": {
        "customerAddressPreferenceId": 1,
        "companyName": "sample string 2",
        "line1": "sample string 3",
        "line2": "sample string 4",
        "countryId": 1,
        "country": "sample string 5",
        "stateId": 1,
        "state": "sample string 6",
        "city": "sample string 7",
        "postalZip": "sample string 8",
        "addressType": "sample string 9",
        "valid": true,
        "id": 11,
        "uri": "sample string 12"
      }
    },
    "customerReferenceValue": "sample string 2",
    "showWordStatement": true
  },
  "startDate": "2024-05-03T08:30:26.6315581+00:00",
  "endDate": "2024-05-03T08:30:26.6315581+00:00",
  "openingBalance": 3.0,
  "closingBalance": 4.0,
  "currency": "sample string 5",
  "accountBillingStatementPreference": {
    "option": "sample string 1",
    "type": "sample string 2",
    "interval": "sample string 3",
    "day": 1,
    "month": 1,
    "trackedItemDisplayFormat": "sample string 4",
    "showTrackedItemName": true,
    "showTrackedItemReference": true,
    "showTrackedItemDescription": true,
    "showTrackedItemCreatedDate": true,
    "trackedItemNameFieldOverride": "sample string 9",
    "trackedItemReferenceFieldOverride": "sample string 10",
    "trackedItemDescriptionFieldOverride": "sample string 11",
    "trackedItemCreatedDateFieldOverride": "sample string 12",
    "trackedItemPageLabelOverride": "sample string 13",
    "trackedItemMainInvoiceMessage": "sample string 14",
    "statementActivityType": "sample string 15",
    "showServiceDates": true,
    "showWordStatement": true,
    "id": 18,
    "uri": "sample string 19"
  },
  "id": 6,
  "uri": "sample string 7"
}

application/xml, text/xml

Sample:
Click to beautify! 
<BillingStatementSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Dto.Get">
  <Id>6</Id>
  <Uri>sample string 7</Uri>
  <AccountBillingStatementPreference>
    <Id>18</Id>
    <Uri>sample string 19</Uri>
    <Day>1</Day>
    <Interval>sample string 3</Interval>
    <Month>1</Month>
    <Option>sample string 1</Option>
    <ShowServiceDates>true</ShowServiceDates>
    <ShowTrackedItemCreatedDate>true</ShowTrackedItemCreatedDate>
    <ShowTrackedItemDescription>true</ShowTrackedItemDescription>
    <ShowTrackedItemName>true</ShowTrackedItemName>
    <ShowTrackedItemReference>true</ShowTrackedItemReference>
    <ShowWordStatement>true</ShowWordStatement>
    <StatementActivityType>sample string 15</StatementActivityType>
    <TrackedItemCreatedDateFieldOverride>sample string 12</TrackedItemCreatedDateFieldOverride>
    <TrackedItemDescriptionFieldOverride>sample string 11</TrackedItemDescriptionFieldOverride>
    <TrackedItemDisplayFormat>sample string 4</TrackedItemDisplayFormat>
    <TrackedItemMainInvoiceMessage>sample string 14</TrackedItemMainInvoiceMessage>
    <TrackedItemNameFieldOverride>sample string 9</TrackedItemNameFieldOverride>
    <TrackedItemPageLabelOverride>sample string 13</TrackedItemPageLabelOverride>
    <TrackedItemReferenceFieldOverride>sample string 10</TrackedItemReferenceFieldOverride>
    <Type>sample string 2</Type>
  </AccountBillingStatementPreference>
  <ClosingBalance>4</ClosingBalance>
  <Currency>sample string 5</Currency>
  <EndDate>2024-05-03T08:30:26.6315581+00:00</EndDate>
  <Header>
    <Customer>
      <BillingAddress>
        <Id>11</Id>
        <Uri>sample string 12</Uri>
        <AddressType>sample string 9</AddressType>
        <City>sample string 7</City>
        <CompanyName>sample string 2</CompanyName>
        <Country>sample string 5</Country>
        <CountryId>1</CountryId>
        <CustomerAddressPreferenceId>1</CustomerAddressPreferenceId>
        <Line1>sample string 3</Line1>
        <Line2>sample string 4</Line2>
        <PostalZip>sample string 8</PostalZip>
        <State>sample string 6</State>
        <StateId>1</StateId>
        <Valid>true</Valid>
      </BillingAddress>
      <CompanyName>sample string 2</CompanyName>
      <FullName>sample string 1</FullName>
    </Customer>
    <CustomerReferenceValue>sample string 2</CustomerReferenceValue>
    <ShowWordStatement>true</ShowWordStatement>
    <Signature>sample string 1</Signature>
  </Header>
  <OpeningBalance>3</OpeningBalance>
  <StartDate>2024-05-03T08:30:26.6315581+00:00</StartDate>
  <TransactionSummary>
    <TransactionSummary>
      <ArCredit>3</ArCredit>
      <ArDebit>2</ArDebit>
      <RunningTotal>4</RunningTotal>
      <TransactionType>sample string 1</TransactionType>
    </TransactionSummary>
    <TransactionSummary>
      <ArCredit>3</ArCredit>
      <ArDebit>2</ArDebit>
      <RunningTotal>4</RunningTotal>
      <TransactionType>sample string 1</TransactionType>
    </TransactionSummary>
    <TransactionSummary>
      <ArCredit>3</ArCredit>
      <ArDebit>2</ArDebit>
      <RunningTotal>4</RunningTotal>
      <TransactionType>sample string 1</TransactionType>
    </TransactionSummary>
  </TransactionSummary>
</BillingStatementSummary>