POST api/v1/Hp/Actions

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Action	string	None.
Id	integer	None.
Values	string	None.
Username	string	None.
request	PAYMENTREQUEST	None.
Edits	Collection of Editables	None.

Request Formats

application/json, text/json

Sample:

{
  "Action": "sample string 1",
  "Id": 2,
  "Values": "sample string 3",
  "Username": "sample string 4",
  "request": {
    "ID_PaymentRequest": 1,
    "ID_Account": 2,
    "ID_Status": 3,
    "ID_ExternalReference": 1,
    "Entity": "sample string 4",
    "Account": "sample string 5",
    "CategoryID": "sample string 6",
    "CurrencyCode": "sample string 7",
    "ItemRef1": "sample string 8",
    "Comments2": "sample string 9",
    "ShipperReference1": "sample string 10",
    "ShipperName": "sample string 11",
    "ShipmentReference1": "sample string 12",
    "CustomerEmail": "sample string 13",
    "Amount": 1.0,
    "Comments1": "sample string 14",
    "ItemReference1": "sample string 15",
    "ItemReference2": "sample string 16",
    "ItemReference3": "sample string 17",
    "AWBOrigin": "sample string 18",
    "AWBProductGroup": "sample string 19",
    "Excise": 1.0,
    "IsPaid": true,
    "Password": "sample string 20",
    "PasswordExpiry": "2025-09-05T07:33:42.9136229+00:00",
    "LinkGuid": "sample string 21",
    "AWB": "sample string 22",
    "AWBDestination": "sample string 23",
    "ProductType": "sample string 24",
    "Service": "sample string 25",
    "Rules": 1,
    "CustomerName": "sample string 26",
    "CustomerPhone": "sample string 27",
    "OriginCity": "sample string 28",
    "OriginCountry": "sample string 29",
    "OriginPostcode": "sample string 30",
    "VAT": 1.0,
    "Duties": 1.0,
    "OriginAddress": "sample string 31",
    "ImportDate": "2025-09-05T07:33:42.9136229+00:00",
    "ToSend": true,
    "IsEmailSent": true,
    "EmailCount": 34,
    "ActionTime": "2025-09-05T07:33:42.9136229+00:00",
    "paidByCustomer": true,
    "Deleted": true,
    "Updates": 1,
    "OneTimeStatus": 1,
    "FirstSendTo": true,
    "PaymentReference": "sample string 36",
    "PaymentType": "sample string 37",
    "ActionTaken": "sample string 38",
    "CustomerNumber": "sample string 39",
    "PayLink": "sample string 40",
    "SMSCounter": 1,
    "TrackingURL": "sample string 41",
    "AdminFees": "sample string 42",
    "SMSStatus": 1,
    "ShipperReference": "sample string 43",
    "CustomerPaymentReference": "sample string 44",
    "RegenerateDate": "2025-09-05T07:33:42.9136229+00:00",
    "document": "sample string 45",
    "Comment1": "sample string 46",
    "Comment2": "sample string 47",
    "Comment3": "sample string 48",
    "Comment4": "sample string 49",
    "Comment5": "sample string 50",
    "Ref1": "sample string 51",
    "Ref2": "sample string 52",
    "Ref3": "sample string 53",
    "Ref4": "sample string 54",
    "Ref5": "sample string 55",
    "Freight": 1.0,
    "Goods": 1.0,
    "FreightConverted1": 1.0,
    "FreightConv1CC": "sample string 56",
    "GoodsConverted1": 1.0,
    "GoodsConvCC": "sample string 57",
    "VATConverted1": 1.0,
    "VATConv1CC": "sample string 58",
    "Toll": 1.0,
    "Products": [
      {
        "Tax_Code": "sample string 1",
        "Tax_Description": "sample string 2",
        "Tax_CountryOfOrigin": "sample string 3",
        "Tax_UnitPrice": 1.0,
        "Tax_CurrencyCode": "sample string 4",
        "Tax_Quantity": 1,
        "Tax_VolumeM3": 1.0,
        "Tax_WeightKg": 1.0,
        "Tax_Ref1": 1.0,
        "Tax_Ref2": 1.0,
        "Tax_Ref3": 1.0,
        "SKU": "sample string 5"
      },
      {
        "Tax_Code": "sample string 1",
        "Tax_Description": "sample string 2",
        "Tax_CountryOfOrigin": "sample string 3",
        "Tax_UnitPrice": 1.0,
        "Tax_CurrencyCode": "sample string 4",
        "Tax_Quantity": 1,
        "Tax_VolumeM3": 1.0,
        "Tax_WeightKg": 1.0,
        "Tax_Ref1": 1.0,
        "Tax_Ref2": 1.0,
        "Tax_Ref3": 1.0,
        "SKU": "sample string 5"
      }
    ],
    "ProductsJSON": "sample string 59",
    "Shipping": 1.0,
    "Insurance": 1.0,
    "Weight": 1.0,
    "BlobGuid": "sample string 60",
    "OriginatingDocument": "sample string 61"
  },
  "Edits": [
    {
      "Column": "sample string 1",
      "Editable": true,
      "Type": "sample string 2"
    },
    {
      "Column": "sample string 1",
      "Editable": true,
      "Type": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<PRS.ActionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortalEntities.Models">
  <Action>sample string 1</Action>
  <Edits>
    <PRS.Editables>
      <Column>sample string 1</Column>
      <Editable>true</Editable>
      <Type>sample string 2</Type>
    </PRS.Editables>
    <PRS.Editables>
      <Column>sample string 1</Column>
      <Editable>true</Editable>
      <Type>sample string 2</Type>
    </PRS.Editables>
  </Edits>
  <Id>2</Id>
  <Username>sample string 4</Username>
  <Values>sample string 3</Values>
  <request>
    <AWB>sample string 22</AWB>
    <AWBDestination>sample string 23</AWBDestination>
    <AWBOrigin>sample string 18</AWBOrigin>
    <AWBProductGroup>sample string 19</AWBProductGroup>
    <Account>sample string 5</Account>
    <ActionTaken>sample string 38</ActionTaken>
    <ActionTime>2025-09-05T07:33:42.9136229+00:00</ActionTime>
    <AdminFees>sample string 42</AdminFees>
    <Amount>1</Amount>
    <BlobGuid>sample string 60</BlobGuid>
    <CategoryID>sample string 6</CategoryID>
    <Comment1>sample string 46</Comment1>
    <Comment2>sample string 47</Comment2>
    <Comment3>sample string 48</Comment3>
    <Comment4>sample string 49</Comment4>
    <Comment5>sample string 50</Comment5>
    <Comments1>sample string 14</Comments1>
    <Comments2>sample string 9</Comments2>
    <CurrencyCode>sample string 7</CurrencyCode>
    <CustomerEmail>sample string 13</CustomerEmail>
    <CustomerName>sample string 26</CustomerName>
    <CustomerNumber>sample string 39</CustomerNumber>
    <CustomerPaymentReference>sample string 44</CustomerPaymentReference>
    <CustomerPhone>sample string 27</CustomerPhone>
    <Deleted>true</Deleted>
    <Duties>1</Duties>
    <EmailCount>34</EmailCount>
    <Entity>sample string 4</Entity>
    <Excise>1</Excise>
    <FirstSendTo>true</FirstSendTo>
    <Freight>1</Freight>
    <FreightConv1CC>sample string 56</FreightConv1CC>
    <FreightConverted1>1</FreightConverted1>
    <Goods>1</Goods>
    <GoodsConvCC>sample string 57</GoodsConvCC>
    <GoodsConverted1>1</GoodsConverted1>
    <ID_Account>2</ID_Account>
    <ID_ExternalReference>1</ID_ExternalReference>
    <ID_PaymentRequest>1</ID_PaymentRequest>
    <ID_Status>3</ID_Status>
    <ImportDate>2025-09-05T07:33:42.9136229+00:00</ImportDate>
    <Insurance>1</Insurance>
    <IsEmailSent>true</IsEmailSent>
    <IsPaid>true</IsPaid>
    <ItemRef1>sample string 8</ItemRef1>
    <ItemReference1>sample string 15</ItemReference1>
    <ItemReference2>sample string 16</ItemReference2>
    <ItemReference3>sample string 17</ItemReference3>
    <LinkGuid>sample string 21</LinkGuid>
    <OneTimeStatus>1</OneTimeStatus>
    <OriginAddress>sample string 31</OriginAddress>
    <OriginCity>sample string 28</OriginCity>
    <OriginCountry>sample string 29</OriginCountry>
    <OriginPostcode>sample string 30</OriginPostcode>
    <OriginatingDocument>sample string 61</OriginatingDocument>
    <Password>sample string 20</Password>
    <PasswordExpiry>2025-09-05T07:33:42.9136229+00:00</PasswordExpiry>
    <PayLink>sample string 40</PayLink>
    <PaymentReference>sample string 36</PaymentReference>
    <PaymentType>sample string 37</PaymentType>
    <ProductType>sample string 24</ProductType>
    <Products>
      <PRS.PaymentRequestTaxInformation>
        <SKU>sample string 5</SKU>
        <Tax_Code>sample string 1</Tax_Code>
        <Tax_CountryOfOrigin>sample string 3</Tax_CountryOfOrigin>
        <Tax_CurrencyCode>sample string 4</Tax_CurrencyCode>
        <Tax_Description>sample string 2</Tax_Description>
        <Tax_Quantity>1</Tax_Quantity>
        <Tax_Ref1>1</Tax_Ref1>
        <Tax_Ref2>1</Tax_Ref2>
        <Tax_Ref3>1</Tax_Ref3>
        <Tax_UnitPrice>1</Tax_UnitPrice>
        <Tax_VolumeM3>1</Tax_VolumeM3>
        <Tax_WeightKg>1</Tax_WeightKg>
      </PRS.PaymentRequestTaxInformation>
      <PRS.PaymentRequestTaxInformation>
        <SKU>sample string 5</SKU>
        <Tax_Code>sample string 1</Tax_Code>
        <Tax_CountryOfOrigin>sample string 3</Tax_CountryOfOrigin>
        <Tax_CurrencyCode>sample string 4</Tax_CurrencyCode>
        <Tax_Description>sample string 2</Tax_Description>
        <Tax_Quantity>1</Tax_Quantity>
        <Tax_Ref1>1</Tax_Ref1>
        <Tax_Ref2>1</Tax_Ref2>
        <Tax_Ref3>1</Tax_Ref3>
        <Tax_UnitPrice>1</Tax_UnitPrice>
        <Tax_VolumeM3>1</Tax_VolumeM3>
        <Tax_WeightKg>1</Tax_WeightKg>
      </PRS.PaymentRequestTaxInformation>
    </Products>
    <ProductsJSON>sample string 59</ProductsJSON>
    <Ref1>sample string 51</Ref1>
    <Ref2>sample string 52</Ref2>
    <Ref3>sample string 53</Ref3>
    <Ref4>sample string 54</Ref4>
    <Ref5>sample string 55</Ref5>
    <RegenerateDate>2025-09-05T07:33:42.9136229+00:00</RegenerateDate>
    <Rules>1</Rules>
    <SMSCounter>1</SMSCounter>
    <SMSStatus>1</SMSStatus>
    <Service>sample string 25</Service>
    <ShipmentReference1>sample string 12</ShipmentReference1>
    <ShipperName>sample string 11</ShipperName>
    <ShipperReference>sample string 43</ShipperReference>
    <ShipperReference1>sample string 10</ShipperReference1>
    <Shipping>1</Shipping>
    <ToSend>true</ToSend>
    <Toll>1</Toll>
    <TrackingURL>sample string 41</TrackingURL>
    <Updates>1</Updates>
    <VAT>1</VAT>
    <VATConv1CC>sample string 58</VATConv1CC>
    <VATConverted1>1</VATConverted1>
    <Weight>1</Weight>
    <document>sample string 45</document>
    <paidByCustomer>true</paidByCustomer>
  </request>
</PRS.ActionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>