GET GetBillingSetup

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

BillingSetupRepository
NameDescriptionTypeAdditional information
successful

boolean

None.
message

string

None.
data

BillingSetupInfo

None.
FutureChargesdata

FutureChargesInfo

None.
sumMonthlyCharges

decimal number

None.
sumFutureCharges

decimal number

None.

Response Formats

application/json, text/json

Sample: 
{
  "successful": true,
  "message": "sample string 2",
  "data": {
    "transactions": [
      {
        "description": "sample string 1",
        "billingAmount": 2.0,
        "startDate": 3,
        "endDate": 4,
        "startDate_DF": "2026-02-03T21:05:47.8199126-06:00",
        "endDate_DF": "2026-02-03T21:05:47.8199126-06:00",
        "taxAmount": 5.1,
        "displayOrder": 6
      },
      {
        "description": "sample string 1",
        "billingAmount": 2.0,
        "startDate": 3,
        "endDate": 4,
        "startDate_DF": "2026-02-03T21:05:47.8199126-06:00",
        "endDate_DF": "2026-02-03T21:05:47.8199126-06:00",
        "taxAmount": 5.1,
        "displayOrder": 6
      }
    ]
  },
  "FutureChargesdata": {
    "FutureChargestransactions": [
      {
        "description": "sample string 1",
        "amount": 2.0,
        "scheduledDate": "2026-02-03T21:05:47.8199126-06:00",
        "scheduledTDate": 3
      },
      {
        "description": "sample string 1",
        "amount": 2.0,
        "scheduledDate": "2026-02-03T21:05:47.8199126-06:00",
        "scheduledTDate": 3
      }
    ]
  },
  "sumMonthlyCharges": 3.1,
  "sumFutureCharges": 4.1
}

application/xml, text/xml

Sample: 
<BillingSetupRepository xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.YottaResident.WebAPIs.Services">
  <FutureChargesdata>
    <FutureChargestransactions>
      <Future_Charges>
        <amount>2</amount>
        <description>sample string 1</description>
        <scheduledDate>2026-02-03T21:05:47.8199126-06:00</scheduledDate>
        <scheduledTDate>3</scheduledTDate>
      </Future_Charges>
      <Future_Charges>
        <amount>2</amount>
        <description>sample string 1</description>
        <scheduledDate>2026-02-03T21:05:47.8199126-06:00</scheduledDate>
        <scheduledTDate>3</scheduledTDate>
      </Future_Charges>
    </FutureChargestransactions>
  </FutureChargesdata>
  <data>
    <transactions>
      <BillingSetupTransactions>
        <billingAmount>2</billingAmount>
        <description>sample string 1</description>
        <displayOrder>6</displayOrder>
        <endDate>4</endDate>
        <endDate_DF>2026-02-03T21:05:47.8199126-06:00</endDate_DF>
        <startDate>3</startDate>
        <startDate_DF>2026-02-03T21:05:47.8199126-06:00</startDate_DF>
        <taxAmount>5.1</taxAmount>
      </BillingSetupTransactions>
      <BillingSetupTransactions>
        <billingAmount>2</billingAmount>
        <description>sample string 1</description>
        <displayOrder>6</displayOrder>
        <endDate>4</endDate>
        <endDate_DF>2026-02-03T21:05:47.8199126-06:00</endDate_DF>
        <startDate>3</startDate>
        <startDate_DF>2026-02-03T21:05:47.8199126-06:00</startDate_DF>
        <taxAmount>5.1</taxAmount>
      </BillingSetupTransactions>
    </transactions>
  </data>
  <message>sample string 2</message>
  <successful>true</successful>
  <sumFutureCharges>4.1</sumFutureCharges>
  <sumMonthlyCharges>3.1</sumMonthlyCharges>
</BillingSetupRepository>