POST api/UploadOrderPayment

Request Information

URI Parameters

None.

Body Parameters

UploadRequest
NameDescriptionTypeAdditional information
AppVersion

string

None.

FileName

string

None.

OrderHeaders

Collection of OrderHeader

None.

OrderDetails

Collection of OrderDetail

None.

PaymentHeaders

Collection of PaymentHeader

None.

PaymentDetails

Collection of PaymentDetail

None.

TransactionImages

Collection of ImageFile

None.

Request Formats

application/json, text/json

Sample:
{
  "AppVersion": "sample string 1",
  "FileName": "sample string 2",
  "OrderHeaders": [
    {
      "ID": 1,
      "COMPID": "sample string 2",
      "CUSTNM": "sample string 3",
      "CUSTNO": "sample string 4",
      "LOCTID": "sample string 5",
      "PAYTRM": "sample string 6",
      "RECEIPTNO": "sample string 7",
      "SALESDATE": "sample string 8",
      "SHIPREFNO": "sample string 9",
      "SHIPTO": "sample string 10",
      "SPADD1": "sample string 11",
      "SPADD2": "sample string 12",
      "SPCIPC": "sample string 13",
      "SPCITY": "sample string 14",
      "TAX1AMT": "sample string 15",
      "TAX2AMT": "sample string 16",
      "TICKETNO": "sample string 17",
      "TOTAMOUNT": "sample string 18",
      "USERID": "sample string 19",
      "COMMENTS": "sample string 20",
      "INVSIGNATURE": "sample string 21",
      "TAXLOC": "sample string 22",
      "STATE": "sample string 23",
      "TRUCKID": "sample string 24",
      "PHONE": "sample string 25",
      "INVRECEIPT": "sample string 26",
      "LATITUDE": "sample string 27",
      "LONGITUDE": "sample string 28",
      "ANULL": "sample string 29",
      "ANULLCOMMENT": "sample string 30",
      "BOBTAILNO": "sample string 31"
    },
    {
      "ID": 1,
      "COMPID": "sample string 2",
      "CUSTNM": "sample string 3",
      "CUSTNO": "sample string 4",
      "LOCTID": "sample string 5",
      "PAYTRM": "sample string 6",
      "RECEIPTNO": "sample string 7",
      "SALESDATE": "sample string 8",
      "SHIPREFNO": "sample string 9",
      "SHIPTO": "sample string 10",
      "SPADD1": "sample string 11",
      "SPADD2": "sample string 12",
      "SPCIPC": "sample string 13",
      "SPCITY": "sample string 14",
      "TAX1AMT": "sample string 15",
      "TAX2AMT": "sample string 16",
      "TICKETNO": "sample string 17",
      "TOTAMOUNT": "sample string 18",
      "USERID": "sample string 19",
      "COMMENTS": "sample string 20",
      "INVSIGNATURE": "sample string 21",
      "TAXLOC": "sample string 22",
      "STATE": "sample string 23",
      "TRUCKID": "sample string 24",
      "PHONE": "sample string 25",
      "INVRECEIPT": "sample string 26",
      "LATITUDE": "sample string 27",
      "LONGITUDE": "sample string 28",
      "ANULL": "sample string 29",
      "ANULLCOMMENT": "sample string 30",
      "BOBTAILNO": "sample string 31"
    }
  ],
  "OrderDetails": [
    {
      "ID": 1,
      "COMPID": "sample string 2",
      "CUSTNO": "sample string 3",
      "ITEMNO": "sample string 4",
      "LOCTID": "sample string 5",
      "ORDER_HEADERID": 6,
      "QTYSOLD": "sample string 7",
      "SERIALPICK": "sample string 8",
      "SERIALSELL": "sample string 9",
      "TAX1USED": "sample string 10",
      "TAX2USED": "sample string 11",
      "TICKETNO": "sample string 12",
      "UNITPRICE": "sample string 13",
      "ORIGINALPRICE": "sample string 14"
    },
    {
      "ID": 1,
      "COMPID": "sample string 2",
      "CUSTNO": "sample string 3",
      "ITEMNO": "sample string 4",
      "LOCTID": "sample string 5",
      "ORDER_HEADERID": 6,
      "QTYSOLD": "sample string 7",
      "SERIALPICK": "sample string 8",
      "SERIALSELL": "sample string 9",
      "TAX1USED": "sample string 10",
      "TAX2USED": "sample string 11",
      "TICKETNO": "sample string 12",
      "UNITPRICE": "sample string 13",
      "ORIGINALPRICE": "sample string 14"
    }
  ],
  "PaymentHeaders": [
    {
      "ID": 1,
      "AMOUNT": "sample string 2",
      "COMPID": "sample string 3",
      "CUSTNO": "sample string 4",
      "LOCTID": "sample string 5",
      "PAYDATE": "sample string 6",
      "PAYREF": "sample string 7",
      "PAYTYPE": "sample string 8",
      "RECEIPTNO": "sample string 9",
      "TICKETNO": "sample string 10",
      "INVSIGNATURE": "sample string 11",
      "COMMENTS": "sample string 12",
      "USERID": "sample string 13",
      "TRUCKID": "sample string 14",
      "INVRECEIPT": "sample string 15",
      "ANULL": "sample string 16",
      "ANULLCOMMENT": "sample string 17"
    },
    {
      "ID": 1,
      "AMOUNT": "sample string 2",
      "COMPID": "sample string 3",
      "CUSTNO": "sample string 4",
      "LOCTID": "sample string 5",
      "PAYDATE": "sample string 6",
      "PAYREF": "sample string 7",
      "PAYTYPE": "sample string 8",
      "RECEIPTNO": "sample string 9",
      "TICKETNO": "sample string 10",
      "INVSIGNATURE": "sample string 11",
      "COMMENTS": "sample string 12",
      "USERID": "sample string 13",
      "TRUCKID": "sample string 14",
      "INVRECEIPT": "sample string 15",
      "ANULL": "sample string 16",
      "ANULLCOMMENT": "sample string 17"
    }
  ],
  "PaymentDetails": [
    {
      "ID": 1,
      "AMOUNTPAID": "sample string 2",
      "COMPID": "sample string 3",
      "CUSTNO": "sample string 4",
      "DISCOUNT": "sample string 5",
      "DOCTYP": "sample string 6",
      "INVCNO": "sample string 7",
      "LOCTID": "sample string 8",
      "PAYMENT_HEADERID": 9,
      "RECEIPTNO": "sample string 10"
    },
    {
      "ID": 1,
      "AMOUNTPAID": "sample string 2",
      "COMPID": "sample string 3",
      "CUSTNO": "sample string 4",
      "DISCOUNT": "sample string 5",
      "DOCTYP": "sample string 6",
      "INVCNO": "sample string 7",
      "LOCTID": "sample string 8",
      "PAYMENT_HEADERID": 9,
      "RECEIPTNO": "sample string 10"
    }
  ],
  "TransactionImages": [
    {
      "Filename": "sample string 1",
      "ImageData": "QEA="
    },
    {
      "Filename": "sample string 1",
      "ImageData": "QEA="
    }
  ]
}

application/xml, text/xml

Sample:
<UploadRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EGas.WebAPI.Controllers">
  <AppVersion>sample string 1</AppVersion>
  <FileName>sample string 2</FileName>
  <OrderDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/EGas.WebAPI.Models">
    <d2p1:OrderDetail>
      <d2p1:COMPID>sample string 2</d2p1:COMPID>
      <d2p1:CUSTNO>sample string 3</d2p1:CUSTNO>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:ITEMNO>sample string 4</d2p1:ITEMNO>
      <d2p1:LOCTID>sample string 5</d2p1:LOCTID>
      <d2p1:ORDER_HEADERID>6</d2p1:ORDER_HEADERID>
      <d2p1:ORIGINALPRICE>sample string 14</d2p1:ORIGINALPRICE>
      <d2p1:QTYSOLD>sample string 7</d2p1:QTYSOLD>
      <d2p1:SERIALPICK>sample string 8</d2p1:SERIALPICK>
      <d2p1:SERIALSELL>sample string 9</d2p1:SERIALSELL>
      <d2p1:TAX1USED>sample string 10</d2p1:TAX1USED>
      <d2p1:TAX2USED>sample string 11</d2p1:TAX2USED>
      <d2p1:TICKETNO>sample string 12</d2p1:TICKETNO>
      <d2p1:UNITPRICE>sample string 13</d2p1:UNITPRICE>
    </d2p1:OrderDetail>
    <d2p1:OrderDetail>
      <d2p1:COMPID>sample string 2</d2p1:COMPID>
      <d2p1:CUSTNO>sample string 3</d2p1:CUSTNO>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:ITEMNO>sample string 4</d2p1:ITEMNO>
      <d2p1:LOCTID>sample string 5</d2p1:LOCTID>
      <d2p1:ORDER_HEADERID>6</d2p1:ORDER_HEADERID>
      <d2p1:ORIGINALPRICE>sample string 14</d2p1:ORIGINALPRICE>
      <d2p1:QTYSOLD>sample string 7</d2p1:QTYSOLD>
      <d2p1:SERIALPICK>sample string 8</d2p1:SERIALPICK>
      <d2p1:SERIALSELL>sample string 9</d2p1:SERIALSELL>
      <d2p1:TAX1USED>sample string 10</d2p1:TAX1USED>
      <d2p1:TAX2USED>sample string 11</d2p1:TAX2USED>
      <d2p1:TICKETNO>sample string 12</d2p1:TICKETNO>
      <d2p1:UNITPRICE>sample string 13</d2p1:UNITPRICE>
    </d2p1:OrderDetail>
  </OrderDetails>
  <OrderHeaders xmlns:d2p1="http://schemas.datacontract.org/2004/07/EGas.WebAPI.Models">
    <d2p1:OrderHeader>
      <d2p1:ANULL>sample string 29</d2p1:ANULL>
      <d2p1:ANULLCOMMENT>sample string 30</d2p1:ANULLCOMMENT>
      <d2p1:BOBTAILNO>sample string 31</d2p1:BOBTAILNO>
      <d2p1:COMMENTS>sample string 20</d2p1:COMMENTS>
      <d2p1:COMPID>sample string 2</d2p1:COMPID>
      <d2p1:CUSTNM>sample string 3</d2p1:CUSTNM>
      <d2p1:CUSTNO>sample string 4</d2p1:CUSTNO>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:INVRECEIPT>sample string 26</d2p1:INVRECEIPT>
      <d2p1:INVSIGNATURE>sample string 21</d2p1:INVSIGNATURE>
      <d2p1:LATITUDE>sample string 27</d2p1:LATITUDE>
      <d2p1:LOCTID>sample string 5</d2p1:LOCTID>
      <d2p1:LONGITUDE>sample string 28</d2p1:LONGITUDE>
      <d2p1:PAYTRM>sample string 6</d2p1:PAYTRM>
      <d2p1:PHONE>sample string 25</d2p1:PHONE>
      <d2p1:RECEIPTNO>sample string 7</d2p1:RECEIPTNO>
      <d2p1:SALESDATE>sample string 8</d2p1:SALESDATE>
      <d2p1:SHIPREFNO>sample string 9</d2p1:SHIPREFNO>
      <d2p1:SHIPTO>sample string 10</d2p1:SHIPTO>
      <d2p1:SPADD1>sample string 11</d2p1:SPADD1>
      <d2p1:SPADD2>sample string 12</d2p1:SPADD2>
      <d2p1:SPCIPC>sample string 13</d2p1:SPCIPC>
      <d2p1:SPCITY>sample string 14</d2p1:SPCITY>
      <d2p1:STATE>sample string 23</d2p1:STATE>
      <d2p1:TAX1AMT>sample string 15</d2p1:TAX1AMT>
      <d2p1:TAX2AMT>sample string 16</d2p1:TAX2AMT>
      <d2p1:TAXLOC>sample string 22</d2p1:TAXLOC>
      <d2p1:TICKETNO>sample string 17</d2p1:TICKETNO>
      <d2p1:TOTAMOUNT>sample string 18</d2p1:TOTAMOUNT>
      <d2p1:TRUCKID>sample string 24</d2p1:TRUCKID>
      <d2p1:USERID>sample string 19</d2p1:USERID>
    </d2p1:OrderHeader>
    <d2p1:OrderHeader>
      <d2p1:ANULL>sample string 29</d2p1:ANULL>
      <d2p1:ANULLCOMMENT>sample string 30</d2p1:ANULLCOMMENT>
      <d2p1:BOBTAILNO>sample string 31</d2p1:BOBTAILNO>
      <d2p1:COMMENTS>sample string 20</d2p1:COMMENTS>
      <d2p1:COMPID>sample string 2</d2p1:COMPID>
      <d2p1:CUSTNM>sample string 3</d2p1:CUSTNM>
      <d2p1:CUSTNO>sample string 4</d2p1:CUSTNO>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:INVRECEIPT>sample string 26</d2p1:INVRECEIPT>
      <d2p1:INVSIGNATURE>sample string 21</d2p1:INVSIGNATURE>
      <d2p1:LATITUDE>sample string 27</d2p1:LATITUDE>
      <d2p1:LOCTID>sample string 5</d2p1:LOCTID>
      <d2p1:LONGITUDE>sample string 28</d2p1:LONGITUDE>
      <d2p1:PAYTRM>sample string 6</d2p1:PAYTRM>
      <d2p1:PHONE>sample string 25</d2p1:PHONE>
      <d2p1:RECEIPTNO>sample string 7</d2p1:RECEIPTNO>
      <d2p1:SALESDATE>sample string 8</d2p1:SALESDATE>
      <d2p1:SHIPREFNO>sample string 9</d2p1:SHIPREFNO>
      <d2p1:SHIPTO>sample string 10</d2p1:SHIPTO>
      <d2p1:SPADD1>sample string 11</d2p1:SPADD1>
      <d2p1:SPADD2>sample string 12</d2p1:SPADD2>
      <d2p1:SPCIPC>sample string 13</d2p1:SPCIPC>
      <d2p1:SPCITY>sample string 14</d2p1:SPCITY>
      <d2p1:STATE>sample string 23</d2p1:STATE>
      <d2p1:TAX1AMT>sample string 15</d2p1:TAX1AMT>
      <d2p1:TAX2AMT>sample string 16</d2p1:TAX2AMT>
      <d2p1:TAXLOC>sample string 22</d2p1:TAXLOC>
      <d2p1:TICKETNO>sample string 17</d2p1:TICKETNO>
      <d2p1:TOTAMOUNT>sample string 18</d2p1:TOTAMOUNT>
      <d2p1:TRUCKID>sample string 24</d2p1:TRUCKID>
      <d2p1:USERID>sample string 19</d2p1:USERID>
    </d2p1:OrderHeader>
  </OrderHeaders>
  <PaymentDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/EGas.WebAPI.Models">
    <d2p1:PaymentDetail>
      <d2p1:AMOUNTPAID>sample string 2</d2p1:AMOUNTPAID>
      <d2p1:COMPID>sample string 3</d2p1:COMPID>
      <d2p1:CUSTNO>sample string 4</d2p1:CUSTNO>
      <d2p1:DISCOUNT>sample string 5</d2p1:DISCOUNT>
      <d2p1:DOCTYP>sample string 6</d2p1:DOCTYP>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:INVCNO>sample string 7</d2p1:INVCNO>
      <d2p1:LOCTID>sample string 8</d2p1:LOCTID>
      <d2p1:PAYMENT_HEADERID>9</d2p1:PAYMENT_HEADERID>
      <d2p1:RECEIPTNO>sample string 10</d2p1:RECEIPTNO>
    </d2p1:PaymentDetail>
    <d2p1:PaymentDetail>
      <d2p1:AMOUNTPAID>sample string 2</d2p1:AMOUNTPAID>
      <d2p1:COMPID>sample string 3</d2p1:COMPID>
      <d2p1:CUSTNO>sample string 4</d2p1:CUSTNO>
      <d2p1:DISCOUNT>sample string 5</d2p1:DISCOUNT>
      <d2p1:DOCTYP>sample string 6</d2p1:DOCTYP>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:INVCNO>sample string 7</d2p1:INVCNO>
      <d2p1:LOCTID>sample string 8</d2p1:LOCTID>
      <d2p1:PAYMENT_HEADERID>9</d2p1:PAYMENT_HEADERID>
      <d2p1:RECEIPTNO>sample string 10</d2p1:RECEIPTNO>
    </d2p1:PaymentDetail>
  </PaymentDetails>
  <PaymentHeaders xmlns:d2p1="http://schemas.datacontract.org/2004/07/EGas.WebAPI.Models">
    <d2p1:PaymentHeader>
      <d2p1:AMOUNT>sample string 2</d2p1:AMOUNT>
      <d2p1:ANULL>sample string 16</d2p1:ANULL>
      <d2p1:ANULLCOMMENT>sample string 17</d2p1:ANULLCOMMENT>
      <d2p1:COMMENTS>sample string 12</d2p1:COMMENTS>
      <d2p1:COMPID>sample string 3</d2p1:COMPID>
      <d2p1:CUSTNO>sample string 4</d2p1:CUSTNO>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:INVRECEIPT>sample string 15</d2p1:INVRECEIPT>
      <d2p1:INVSIGNATURE>sample string 11</d2p1:INVSIGNATURE>
      <d2p1:LOCTID>sample string 5</d2p1:LOCTID>
      <d2p1:PAYDATE>sample string 6</d2p1:PAYDATE>
      <d2p1:PAYREF>sample string 7</d2p1:PAYREF>
      <d2p1:PAYTYPE>sample string 8</d2p1:PAYTYPE>
      <d2p1:RECEIPTNO>sample string 9</d2p1:RECEIPTNO>
      <d2p1:TICKETNO>sample string 10</d2p1:TICKETNO>
      <d2p1:TRUCKID>sample string 14</d2p1:TRUCKID>
      <d2p1:USERID>sample string 13</d2p1:USERID>
    </d2p1:PaymentHeader>
    <d2p1:PaymentHeader>
      <d2p1:AMOUNT>sample string 2</d2p1:AMOUNT>
      <d2p1:ANULL>sample string 16</d2p1:ANULL>
      <d2p1:ANULLCOMMENT>sample string 17</d2p1:ANULLCOMMENT>
      <d2p1:COMMENTS>sample string 12</d2p1:COMMENTS>
      <d2p1:COMPID>sample string 3</d2p1:COMPID>
      <d2p1:CUSTNO>sample string 4</d2p1:CUSTNO>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:INVRECEIPT>sample string 15</d2p1:INVRECEIPT>
      <d2p1:INVSIGNATURE>sample string 11</d2p1:INVSIGNATURE>
      <d2p1:LOCTID>sample string 5</d2p1:LOCTID>
      <d2p1:PAYDATE>sample string 6</d2p1:PAYDATE>
      <d2p1:PAYREF>sample string 7</d2p1:PAYREF>
      <d2p1:PAYTYPE>sample string 8</d2p1:PAYTYPE>
      <d2p1:RECEIPTNO>sample string 9</d2p1:RECEIPTNO>
      <d2p1:TICKETNO>sample string 10</d2p1:TICKETNO>
      <d2p1:TRUCKID>sample string 14</d2p1:TRUCKID>
      <d2p1:USERID>sample string 13</d2p1:USERID>
    </d2p1:PaymentHeader>
  </PaymentHeaders>
  <TransactionImages>
    <ImageFile>
      <Filename>sample string 1</Filename>
      <ImageData>QEA=</ImageData>
    </ImageFile>
    <ImageFile>
      <Filename>sample string 1</Filename>
      <ImageData>QEA=</ImageData>
    </ImageFile>
  </TransactionImages>
</UploadRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

UploadResponse
NameDescriptionTypeAdditional information
ErrorCode

integer

None.

ErrorMessages

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "ErrorCode": 1,
  "ErrorMessages": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<UploadResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EGas.WebAPI.Controllers">
  <ErrorCode>1</ErrorCode>
  <ErrorMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorMessages>
</UploadResponse>