POST api/saletypes/managepaymenttype

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SaleTypeId	integer	None.
SaleTypeDescription	string	None.
PaymentTypeId	integer	None.
PaymentTypeDescription	string	None.
CustomerType	CFTypes	None.
PropertyId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "SaleTypeId": 1,
  "SaleTypeDescription": "sample string 2",
  "PaymentTypeId": 3,
  "PaymentTypeDescription": "sample string 4",
  "CustomerType": 0,
  "PropertyId": 5
}

application/xml, text/xml

Sample:

<SaleTypePaymentType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Atlantis.Library.Web.Models">
  <CustomerType>Inhouse</CustomerType>
  <PaymentTypeDescription>sample string 4</PaymentTypeDescription>
  <PaymentTypeId>3</PaymentTypeId>
  <PropertyId>5</PropertyId>
  <SaleTypeDescription>sample string 2</SaleTypeDescription>
  <SaleTypeId>1</SaleTypeId>
</SaleTypePaymentType>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SaleType

Name	Type	Additional information
Id	integer	None.
Description	string	None.
DefaultDocId	integer	None.
DefaultDocDescription	string	None.
DefaultPricelistId	integer	None.
IsMaison	boolean	None.
IsDefault	boolean	None.
DefaultRetailDocId	integer	None.
DefaultRetailDocDescription	string	None.
IsHidden	boolean	None.
IsFromExternalSource	boolean	None.
ValidPaymentTypes	Collection of PaymentType	None.
ValidPriceLists	Collection of PriceList	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Description": "sample string 2",
  "DefaultDocId": 3,
  "DefaultDocDescription": "sample string 4",
  "DefaultPricelistId": 5,
  "IsMaison": true,
  "IsDefault": true,
  "DefaultRetailDocId": 8,
  "DefaultRetailDocDescription": "sample string 9",
  "IsHidden": true,
  "IsFromExternalSource": true,
  "ValidPaymentTypes": [
    {
      "Id": 1,
      "Description": "sample string 2",
      "Category": 3,
      "CreatesDebit": true,
      "DebitType": 64,
      "PMSDebitorId1": "sample string 6",
      "PMSDebitorId2": "sample string 7",
      "PMSDebitorType": "sample string 8",
      "IsMaison": true,
      "ExtReference": "sample string 10",
      "IsActive": true,
      "UseCrossPosting": true,
      "InvReportIdCopy1": 13,
      "InvReportIdCopy2": 14,
      "PMSValidateCustomer": true,
      "InvTypeId": 16,
      "ExtReference2": "sample string 17",
      "EFTPosTerminalId": 18,
      "CreatesReverseCredit": true,
      "ReverseCreditCuFlId": 20,
      "InvoicePaymentCategoryId": 21,
      "AskForTips": true,
      "ExtReference3": "sample string 23",
      "EFTPosTerminalCardTypeCode": "sample string 24",
      "EFTPosTerminalPaymentType": "sample string 25",
      "CustomerType": 0,
      "PropertyId": 26
    },
    {
      "Id": 1,
      "Description": "sample string 2",
      "Category": 3,
      "CreatesDebit": true,
      "DebitType": 64,
      "PMSDebitorId1": "sample string 6",
      "PMSDebitorId2": "sample string 7",
      "PMSDebitorType": "sample string 8",
      "IsMaison": true,
      "ExtReference": "sample string 10",
      "IsActive": true,
      "UseCrossPosting": true,
      "InvReportIdCopy1": 13,
      "InvReportIdCopy2": 14,
      "PMSValidateCustomer": true,
      "InvTypeId": 16,
      "ExtReference2": "sample string 17",
      "EFTPosTerminalId": 18,
      "CreatesReverseCredit": true,
      "ReverseCreditCuFlId": 20,
      "InvoicePaymentCategoryId": 21,
      "AskForTips": true,
      "ExtReference3": "sample string 23",
      "EFTPosTerminalCardTypeCode": "sample string 24",
      "EFTPosTerminalPaymentType": "sample string 25",
      "CustomerType": 0,
      "PropertyId": 26
    }
  ],
  "ValidPriceLists": [
    {
      "Id": 1,
      "Code": "sample string 2",
      "Description": "sample string 3",
      "AcceptsCustomValues": true,
      "IsDefault": true,
      "DefaultSaleTypeId": 6,
      "MaxDiscountPercent": 7,
      "IsCalculated": true,
      "CalculationFactor": 9.1,
      "ParentId": 10
    },
    {
      "Id": 1,
      "Code": "sample string 2",
      "Description": "sample string 3",
      "AcceptsCustomValues": true,
      "IsDefault": true,
      "DefaultSaleTypeId": 6,
      "MaxDiscountPercent": 7,
      "IsCalculated": true,
      "CalculationFactor": 9.1,
      "ParentId": 10
    }
  ]
}

application/xml, text/xml

Sample:

<SaleType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Atlantis.Library.Web.Models">
  <DefaultDocDescription>sample string 4</DefaultDocDescription>
  <DefaultDocId>3</DefaultDocId>
  <DefaultPricelistId>5</DefaultPricelistId>
  <DefaultRetailDocDescription>sample string 9</DefaultRetailDocDescription>
  <DefaultRetailDocId>8</DefaultRetailDocId>
  <Description>sample string 2</Description>
  <Id>1</Id>
  <IsDefault>true</IsDefault>
  <IsFromExternalSource>true</IsFromExternalSource>
  <IsHidden>true</IsHidden>
  <IsMaison>true</IsMaison>
  <ValidPaymentTypes>
    <PaymentType>
      <AskForTips>true</AskForTips>
      <Category>3</Category>
      <CreatesDebit>true</CreatesDebit>
      <CreatesReverseCredit>true</CreatesReverseCredit>
      <CustomerType>Inhouse</CustomerType>
      <DebitType>64</DebitType>
      <Description>sample string 2</Description>
      <EFTPosTerminalCardTypeCode>sample string 24</EFTPosTerminalCardTypeCode>
      <EFTPosTerminalId>18</EFTPosTerminalId>
      <EFTPosTerminalPaymentType>sample string 25</EFTPosTerminalPaymentType>
      <ExtReference>sample string 10</ExtReference>
      <ExtReference2>sample string 17</ExtReference2>
      <ExtReference3>sample string 23</ExtReference3>
      <Id>1</Id>
      <InvReportIdCopy1>13</InvReportIdCopy1>
      <InvReportIdCopy2>14</InvReportIdCopy2>
      <InvTypeId>16</InvTypeId>
      <InvoicePaymentCategoryId>21</InvoicePaymentCategoryId>
      <IsActive>true</IsActive>
      <IsMaison>true</IsMaison>
      <PMSDebitorId1>sample string 6</PMSDebitorId1>
      <PMSDebitorId2>sample string 7</PMSDebitorId2>
      <PMSDebitorType>sample string 8</PMSDebitorType>
      <PMSValidateCustomer>true</PMSValidateCustomer>
      <PropertyId>26</PropertyId>
      <ReverseCreditCuFlId>20</ReverseCreditCuFlId>
      <UseCrossPosting>true</UseCrossPosting>
    </PaymentType>
    <PaymentType>
      <AskForTips>true</AskForTips>
      <Category>3</Category>
      <CreatesDebit>true</CreatesDebit>
      <CreatesReverseCredit>true</CreatesReverseCredit>
      <CustomerType>Inhouse</CustomerType>
      <DebitType>64</DebitType>
      <Description>sample string 2</Description>
      <EFTPosTerminalCardTypeCode>sample string 24</EFTPosTerminalCardTypeCode>
      <EFTPosTerminalId>18</EFTPosTerminalId>
      <EFTPosTerminalPaymentType>sample string 25</EFTPosTerminalPaymentType>
      <ExtReference>sample string 10</ExtReference>
      <ExtReference2>sample string 17</ExtReference2>
      <ExtReference3>sample string 23</ExtReference3>
      <Id>1</Id>
      <InvReportIdCopy1>13</InvReportIdCopy1>
      <InvReportIdCopy2>14</InvReportIdCopy2>
      <InvTypeId>16</InvTypeId>
      <InvoicePaymentCategoryId>21</InvoicePaymentCategoryId>
      <IsActive>true</IsActive>
      <IsMaison>true</IsMaison>
      <PMSDebitorId1>sample string 6</PMSDebitorId1>
      <PMSDebitorId2>sample string 7</PMSDebitorId2>
      <PMSDebitorType>sample string 8</PMSDebitorType>
      <PMSValidateCustomer>true</PMSValidateCustomer>
      <PropertyId>26</PropertyId>
      <ReverseCreditCuFlId>20</ReverseCreditCuFlId>
      <UseCrossPosting>true</UseCrossPosting>
    </PaymentType>
  </ValidPaymentTypes>
  <ValidPriceLists>
    <PriceList>
      <AcceptsCustomValues>true</AcceptsCustomValues>
      <CalculationFactor>9.1</CalculationFactor>
      <Code>sample string 2</Code>
      <DefaultSaleTypeId>6</DefaultSaleTypeId>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <IsCalculated>true</IsCalculated>
      <IsDefault>true</IsDefault>
      <MaxDiscountPercent>7</MaxDiscountPercent>
      <ParentId>10</ParentId>
    </PriceList>
    <PriceList>
      <AcceptsCustomValues>true</AcceptsCustomValues>
      <CalculationFactor>9.1</CalculationFactor>
      <Code>sample string 2</Code>
      <DefaultSaleTypeId>6</DefaultSaleTypeId>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <IsCalculated>true</IsCalculated>
      <IsDefault>true</IsDefault>
      <MaxDiscountPercent>7</MaxDiscountPercent>
      <ParentId>10</ParentId>
    </PriceList>
  </ValidPriceLists>
</SaleType>