POST LoadControlScreen

No documentation available.

Request Information

Parameters

Name	Description	Additional information
request	No documentation available.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "user": "sample string 1",
  "token": "sample string 2",
  "function": 0
}

application/x-www-form-urlencoded

Sample:

Sample not available.

application/xml, text/xml

Sample:

<LoadControlScreenRequest>
  <token>sample string 2</token>
  <function>AddCleanBag</function>
  <user>sample string 1</user>
</LoadControlScreenRequest>

Response Information

No documentation available.

Response body formats

application/json, text/json

Sample:

{
  "data": {
    "systemOptions": {
      "creditCardDataPurged": true,
      "name": "sample string 2",
      "ccProcessing": 3,
      "ccTransKey": "sample string 4",
      "achProcessing": 5,
      "arCheckInfoImport": 6,
      "sessionDesc": true,
      "writeoffCodes": "sample string 8",
      "ccPayAllCredits": 9,
      "achPayAllCredits": 10,
      "perCnt": 11,
      "allPmt": 12,
      "curDef": "sample string 13",
      "prepay": 14,
      "arUpdback": 15,
      "lupdate": "sample string 16",
      "lcreate": "sample string 17"
    },
    "branchList": [
      {
        "branch": 1
      },
      {
        "branch": 1
      },
      {
        "branch": 1
      }
    ],
    "currentPeriod": {
      "beginDate": "sample string 1",
      "endDate": "sample string 2"
    },
    "sessionDescrList": [
      {
        "code": "sample string 1",
        "description": "sample string 2"
      },
      {
        "code": "sample string 1",
        "description": "sample string 2"
      },
      {
        "code": "sample string 1",
        "description": "sample string 2"
      }
    ],
    "session": {
      "user": "sample string 1",
      "payment": 2.0,
      "credit": 3.0,
      "cash": 4.0,
      "discnt": 5.0,
      "nonAr": 6.0,
      "writeof": 7.0,
      "latechg": 8.0,
      "retchk": 9.0,
      "stmtmin": 10.0,
      "eft": 11.0,
      "arStat": "sample string 12",
      "session": 13,
      "sdCode": "sample string 14"
    },
    "sessionTotals": {
      "user": "sample string 1",
      "payment": 2.0,
      "credit": 3.0,
      "cash": 4.0,
      "discnt": 5.0,
      "nonAr": 6.0,
      "writeof": 7.0,
      "latechg": 8.0,
      "retchk": 9.0,
      "stmtmin": 10.0,
      "eft": 11.0,
      "arStat": "sample string 12",
      "session": 13,
      "sdCode": "sample string 14"
    },
    "sequence": {
      "sequence": 1,
      "checkAmount": 2.0,
      "checkName": "sample string 3",
      "checkNum": "sample string 4",
      "credit": 5.0,
      "paymentDate": "sample string 6",
      "applyAmount": 7.0,
      "transactionID": "sample string 8"
    },
    "firstCustomer": {
      "cuid": 1,
      "accountNumber": 2,
      "branch": 3,
      "departmentNumber": "sample string 4",
      "customerName": "sample string 5",
      "route": 6,
      "stopDate": "2025-12-05T23:00:13.2588264-05:00",
      "address1": "sample string 8",
      "address2": "sample string 9",
      "city": "sample string 10",
      "state": "sample string 11",
      "zip": "sample string 12",
      "phone": "sample string 13",
      "acid": 14,
      "arid": 15,
      "active": 16,
      "group": 17,
      "healthcare": 18,
      "paymentType": "sample string 19",
      "accountType": "sample string 20",
      "creditLimit": 21.0,
      "cashOnly": 22,
      "billingOptions": [
        {
          "type": "sample string 1",
          "prmIni": "sample string 2",
          "name": "sample string 3",
          "gmark": "sample string 4",
          "addr1": "sample string 5",
          "city": "sample string 6",
          "zip": "sample string 7",
          "phone": "sample string 8",
          "prepay": 9,
          "potAmt": 10.0,
          "cuPaytype": "sample string 11",
          "grpAcct": 12,
          "fname": "sample string 13",
          "lname": "sample string 14",
          "PayType": "sample string 15",
          "stopdt": "sample string 16",
          "description": "sample string 17"
        },
        {
          "type": "sample string 1",
          "prmIni": "sample string 2",
          "name": "sample string 3",
          "gmark": "sample string 4",
          "addr1": "sample string 5",
          "city": "sample string 6",
          "zip": "sample string 7",
          "phone": "sample string 8",
          "prepay": 9,
          "potAmt": 10.0,
          "cuPaytype": "sample string 11",
          "grpAcct": 12,
          "fname": "sample string 13",
          "lname": "sample string 14",
          "PayType": "sample string 15",
          "stopdt": "sample string 16",
          "description": "sample string 17"
        },
        {
          "type": "sample string 1",
          "prmIni": "sample string 2",
          "name": "sample string 3",
          "gmark": "sample string 4",
          "addr1": "sample string 5",
          "city": "sample string 6",
          "zip": "sample string 7",
          "phone": "sample string 8",
          "prepay": 9,
          "potAmt": 10.0,
          "cuPaytype": "sample string 11",
          "grpAcct": 12,
          "fname": "sample string 13",
          "lname": "sample string 14",
          "PayType": "sample string 15",
          "stopdt": "sample string 16",
          "description": "sample string 17"
        }
      ]
    },
    "billingOptions": [
      {
        "type": "sample string 1",
        "prmIni": "sample string 2",
        "name": "sample string 3",
        "gmark": "sample string 4",
        "addr1": "sample string 5",
        "city": "sample string 6",
        "zip": "sample string 7",
        "phone": "sample string 8",
        "prepay": 9,
        "potAmt": 10.0,
        "cuPaytype": "sample string 11",
        "grpAcct": 12,
        "fname": "sample string 13",
        "lname": "sample string 14",
        "PayType": "sample string 15",
        "stopdt": "sample string 16",
        "description": "sample string 17"
      },
      {
        "type": "sample string 1",
        "prmIni": "sample string 2",
        "name": "sample string 3",
        "gmark": "sample string 4",
        "addr1": "sample string 5",
        "city": "sample string 6",
        "zip": "sample string 7",
        "phone": "sample string 8",
        "prepay": 9,
        "potAmt": 10.0,
        "cuPaytype": "sample string 11",
        "grpAcct": 12,
        "fname": "sample string 13",
        "lname": "sample string 14",
        "PayType": "sample string 15",
        "stopdt": "sample string 16",
        "description": "sample string 17"
      },
      {
        "type": "sample string 1",
        "prmIni": "sample string 2",
        "name": "sample string 3",
        "gmark": "sample string 4",
        "addr1": "sample string 5",
        "city": "sample string 6",
        "zip": "sample string 7",
        "phone": "sample string 8",
        "prepay": 9,
        "potAmt": 10.0,
        "cuPaytype": "sample string 11",
        "grpAcct": 12,
        "fname": "sample string 13",
        "lname": "sample string 14",
        "PayType": "sample string 15",
        "stopdt": "sample string 16",
        "description": "sample string 17"
      }
    ]
  },
  "valid": true,
  "message": "sample string 2"
}

application/xml, text/xml

Sample:

<LoadControlScreenResponse>
  <valid>true</valid>
  <message>sample string 2</message>
  <data>
    <systemOptions>
      <creditCardDataPurged>true</creditCardDataPurged>
      <name>sample string 2</name>
      <ccProcessing>3</ccProcessing>
      <ccTransKey>sample string 4</ccTransKey>
      <achProcessing>5</achProcessing>
      <arCheckInfoImport>6</arCheckInfoImport>
      <sessionDesc>true</sessionDesc>
      <writeoffCodes>sample string 8</writeoffCodes>
      <ccPayAllCredits>9</ccPayAllCredits>
      <achPayAllCredits>10</achPayAllCredits>
      <perCnt>11</perCnt>
      <allPmt>12</allPmt>
      <curDef>sample string 13</curDef>
      <prepay>14</prepay>
      <arUpdback>15</arUpdback>
      <lupdate>sample string 16</lupdate>
      <lcreate>sample string 17</lcreate>
    </systemOptions>
    <branchList>
      <Branch>
        <branch>1</branch>
      </Branch>
      <Branch>
        <branch>1</branch>
      </Branch>
      <Branch>
        <branch>1</branch>
      </Branch>
    </branchList>
    <currentPeriod>
      <beginDate>sample string 1</beginDate>
      <endDate>sample string 2</endDate>
    </currentPeriod>
    <sessionDescrList>
      <DescriptionList>
        <code>sample string 1</code>
        <description>sample string 2</description>
      </DescriptionList>
      <DescriptionList>
        <code>sample string 1</code>
        <description>sample string 2</description>
      </DescriptionList>
      <DescriptionList>
        <code>sample string 1</code>
        <description>sample string 2</description>
      </DescriptionList>
    </sessionDescrList>
    <session>
      <user>sample string 1</user>
      <payment>2</payment>
      <credit>3</credit>
      <cash>4</cash>
      <discnt>5</discnt>
      <nonAr>6</nonAr>
      <writeof>7</writeof>
      <latechg>8</latechg>
      <retchk>9</retchk>
      <stmtmin>10</stmtmin>
      <eft>11</eft>
      <arStat>sample string 12</arStat>
      <session>13</session>
      <sdCode>sample string 14</sdCode>
    </session>
    <sessionTotals>
      <user>sample string 1</user>
      <payment>2</payment>
      <credit>3</credit>
      <cash>4</cash>
      <discnt>5</discnt>
      <nonAr>6</nonAr>
      <writeof>7</writeof>
      <latechg>8</latechg>
      <retchk>9</retchk>
      <stmtmin>10</stmtmin>
      <eft>11</eft>
      <arStat>sample string 12</arStat>
      <session>13</session>
      <sdCode>sample string 14</sdCode>
    </sessionTotals>
    <sequence>
      <sequence>1</sequence>
      <checkAmount>2</checkAmount>
      <checkName>sample string 3</checkName>
      <checkNum>sample string 4</checkNum>
      <credit>5</credit>
      <paymentDate>sample string 6</paymentDate>
      <applyAmount>7</applyAmount>
      <transactionID>sample string 8</transactionID>
    </sequence>
    <firstCustomer>
      <cuid>1</cuid>
      <accountNumber>2</accountNumber>
      <branch>3</branch>
      <departmentNumber>sample string 4</departmentNumber>
      <customerName>sample string 5</customerName>
      <route>6</route>
      <stopDate>2025-12-05T23:00:13.2588264-05:00</stopDate>
      <address1>sample string 8</address1>
      <address2>sample string 9</address2>
      <city>sample string 10</city>
      <state>sample string 11</state>
      <zip>sample string 12</zip>
      <phone>sample string 13</phone>
      <acid>14</acid>
      <arid>15</arid>
      <active>16</active>
      <group>17</group>
      <healthcare>18</healthcare>
      <paymentType>sample string 19</paymentType>
      <accountType>sample string 20</accountType>
      <creditLimit>21</creditLimit>
      <cashOnly>22</cashOnly>
      <billingOptions>
        <AccountBillingOption>
          <type>sample string 1</type>
          <prmIni>sample string 2</prmIni>
          <name>sample string 3</name>
          <gmark>sample string 4</gmark>
          <addr1>sample string 5</addr1>
          <city>sample string 6</city>
          <zip>sample string 7</zip>
          <phone>sample string 8</phone>
          <prepay>9</prepay>
          <potAmt>10</potAmt>
          <cuPaytype>sample string 11</cuPaytype>
          <grpAcct>12</grpAcct>
          <fname>sample string 13</fname>
          <lname>sample string 14</lname>
          <PayType>sample string 15</PayType>
          <stopdt>sample string 16</stopdt>
          <description>sample string 17</description>
        </AccountBillingOption>
        <AccountBillingOption>
          <type>sample string 1</type>
          <prmIni>sample string 2</prmIni>
          <name>sample string 3</name>
          <gmark>sample string 4</gmark>
          <addr1>sample string 5</addr1>
          <city>sample string 6</city>
          <zip>sample string 7</zip>
          <phone>sample string 8</phone>
          <prepay>9</prepay>
          <potAmt>10</potAmt>
          <cuPaytype>sample string 11</cuPaytype>
          <grpAcct>12</grpAcct>
          <fname>sample string 13</fname>
          <lname>sample string 14</lname>
          <PayType>sample string 15</PayType>
          <stopdt>sample string 16</stopdt>
          <description>sample string 17</description>
        </AccountBillingOption>
        <AccountBillingOption>
          <type>sample string 1</type>
          <prmIni>sample string 2</prmIni>
          <name>sample string 3</name>
          <gmark>sample string 4</gmark>
          <addr1>sample string 5</addr1>
          <city>sample string 6</city>
          <zip>sample string 7</zip>
          <phone>sample string 8</phone>
          <prepay>9</prepay>
          <potAmt>10</potAmt>
          <cuPaytype>sample string 11</cuPaytype>
          <grpAcct>12</grpAcct>
          <fname>sample string 13</fname>
          <lname>sample string 14</lname>
          <PayType>sample string 15</PayType>
          <stopdt>sample string 16</stopdt>
          <description>sample string 17</description>
        </AccountBillingOption>
      </billingOptions>
    </firstCustomer>
    <billingOptions>
      <AccountBillingOption>
        <type>sample string 1</type>
        <prmIni>sample string 2</prmIni>
        <name>sample string 3</name>
        <gmark>sample string 4</gmark>
        <addr1>sample string 5</addr1>
        <city>sample string 6</city>
        <zip>sample string 7</zip>
        <phone>sample string 8</phone>
        <prepay>9</prepay>
        <potAmt>10</potAmt>
        <cuPaytype>sample string 11</cuPaytype>
        <grpAcct>12</grpAcct>
        <fname>sample string 13</fname>
        <lname>sample string 14</lname>
        <PayType>sample string 15</PayType>
        <stopdt>sample string 16</stopdt>
        <description>sample string 17</description>
      </AccountBillingOption>
      <AccountBillingOption>
        <type>sample string 1</type>
        <prmIni>sample string 2</prmIni>
        <name>sample string 3</name>
        <gmark>sample string 4</gmark>
        <addr1>sample string 5</addr1>
        <city>sample string 6</city>
        <zip>sample string 7</zip>
        <phone>sample string 8</phone>
        <prepay>9</prepay>
        <potAmt>10</potAmt>
        <cuPaytype>sample string 11</cuPaytype>
        <grpAcct>12</grpAcct>
        <fname>sample string 13</fname>
        <lname>sample string 14</lname>
        <PayType>sample string 15</PayType>
        <stopdt>sample string 16</stopdt>
        <description>sample string 17</description>
      </AccountBillingOption>
      <AccountBillingOption>
        <type>sample string 1</type>
        <prmIni>sample string 2</prmIni>
        <name>sample string 3</name>
        <gmark>sample string 4</gmark>
        <addr1>sample string 5</addr1>
        <city>sample string 6</city>
        <zip>sample string 7</zip>
        <phone>sample string 8</phone>
        <prepay>9</prepay>
        <potAmt>10</potAmt>
        <cuPaytype>sample string 11</cuPaytype>
        <grpAcct>12</grpAcct>
        <fname>sample string 13</fname>
        <lname>sample string 14</lname>
        <PayType>sample string 15</PayType>
        <stopdt>sample string 16</stopdt>
        <description>sample string 17</description>
      </AccountBillingOption>
    </billingOptions>
  </data>
</LoadControlScreenResponse>