POST api/Sale

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Module	ModuleInfo	None.
TransactionReference	string	None.
TransactionDate	string	None.
Buyer	BuyerInfo	None.
Payment	PaymentInfo	None.
Items	Collection of ProductServiceItem	None.
UsersReference	string	None.
UsersMemo	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Module": {
    "reference": "sample string 1",
    "name": "sample string 2"
  },
  "TransactionReference": "sample string 1",
  "TransactionDate": "sample string 2",
  "Buyer": {
    "CompanyInfo": {
      "reference": "sample string 1",
      "name": "sample string 2"
    },
    "UserInfo": {
      "reference": "sample string 1",
      "name": "sample string 2"
    }
  },
  "Payment": {
    "Account": {
      "reference": "sample string 1",
      "name": "sample string 2"
    },
    "Method": 0,
    "PaymentProvider": {
      "ProvidersReference": "sample string 1",
      "ProvidersBatch": "sample string 2",
      "reference": "sample string 3",
      "name": "sample string 4"
    }
  },
  "Items": [
    {
      "SaleType": 0,
      "TransactionDetailReference": "sample string 1",
      "ItemReference": "sample string 2",
      "Seller": {
        "reference": "sample string 1",
        "name": "sample string 2"
      },
      "Product": {
        "reference": "sample string 1",
        "name": "sample string 2"
      },
      "ProductProgram": {
        "reference": "sample string 1",
        "name": "sample string 2"
      },
      "ProductCategory": {
        "reference": "sample string 1",
        "name": "sample string 2"
      },
      "ItemAmount": 3.0,
      "Correlation_Id": "da5ef27c-91a6-4ad2-ba58-35e875ff6fb6",
      "ExternalCollection_Ind": true,
      "ChildItems": [
        {
          "TransactionDetailReference": "sample string 1",
          "ItemReference": "sample string 2",
          "Seller": {
            "reference": "sample string 1",
            "name": "sample string 2"
          },
          "Product": {
            "reference": "sample string 1",
            "name": "sample string 2"
          },
          "ProductCategory": {
            "reference": "sample string 1",
            "name": "sample string 2"
          },
          "ItemAmount": 3.0,
          "Correlation_Id": "d3085f3c-07f9-4bc6-a280-b4b18eae6c27"
        },
        {
          "TransactionDetailReference": "sample string 1",
          "ItemReference": "sample string 2",
          "Seller": {
            "reference": "sample string 1",
            "name": "sample string 2"
          },
          "Product": {
            "reference": "sample string 1",
            "name": "sample string 2"
          },
          "ProductCategory": {
            "reference": "sample string 1",
            "name": "sample string 2"
          },
          "ItemAmount": 3.0,
          "Correlation_Id": "d3085f3c-07f9-4bc6-a280-b4b18eae6c27"
        }
      ]
    },
    {
      "SaleType": 0,
      "TransactionDetailReference": "sample string 1",
      "ItemReference": "sample string 2",
      "Seller": {
        "reference": "sample string 1",
        "name": "sample string 2"
      },
      "Product": {
        "reference": "sample string 1",
        "name": "sample string 2"
      },
      "ProductProgram": {
        "reference": "sample string 1",
        "name": "sample string 2"
      },
      "ProductCategory": {
        "reference": "sample string 1",
        "name": "sample string 2"
      },
      "ItemAmount": 3.0,
      "Correlation_Id": "da5ef27c-91a6-4ad2-ba58-35e875ff6fb6",
      "ExternalCollection_Ind": true,
      "ChildItems": [
        {
          "TransactionDetailReference": "sample string 1",
          "ItemReference": "sample string 2",
          "Seller": {
            "reference": "sample string 1",
            "name": "sample string 2"
          },
          "Product": {
            "reference": "sample string 1",
            "name": "sample string 2"
          },
          "ProductCategory": {
            "reference": "sample string 1",
            "name": "sample string 2"
          },
          "ItemAmount": 3.0,
          "Correlation_Id": "d3085f3c-07f9-4bc6-a280-b4b18eae6c27"
        },
        {
          "TransactionDetailReference": "sample string 1",
          "ItemReference": "sample string 2",
          "Seller": {
            "reference": "sample string 1",
            "name": "sample string 2"
          },
          "Product": {
            "reference": "sample string 1",
            "name": "sample string 2"
          },
          "ProductCategory": {
            "reference": "sample string 1",
            "name": "sample string 2"
          },
          "ItemAmount": 3.0,
          "Correlation_Id": "d3085f3c-07f9-4bc6-a280-b4b18eae6c27"
        }
      ]
    }
  ],
  "UsersReference": "sample string 3",
  "UsersMemo": "sample string 4"
}

application/xml, text/xml

Sample:

<SaleInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QBTypes">
  <Buyer>
    <CompanyInfo>
      <name>sample string 2</name>
      <reference>sample string 1</reference>
    </CompanyInfo>
    <UserInfo>
      <name>sample string 2</name>
      <reference>sample string 1</reference>
    </UserInfo>
  </Buyer>
  <Items>
    <ProductServiceItem>
      <ChildItems>
        <ProductServiceChildItem>
          <Correlation_Id>d3085f3c-07f9-4bc6-a280-b4b18eae6c27</Correlation_Id>
          <ItemAmount>3</ItemAmount>
          <ItemReference>sample string 2</ItemReference>
          <Product>
            <name>sample string 2</name>
            <reference>sample string 1</reference>
          </Product>
          <ProductCategory>
            <name>sample string 2</name>
            <reference>sample string 1</reference>
          </ProductCategory>
          <Seller>
            <name>sample string 2</name>
            <reference>sample string 1</reference>
          </Seller>
          <TransactionDetailReference>sample string 1</TransactionDetailReference>
        </ProductServiceChildItem>
        <ProductServiceChildItem>
          <Correlation_Id>d3085f3c-07f9-4bc6-a280-b4b18eae6c27</Correlation_Id>
          <ItemAmount>3</ItemAmount>
          <ItemReference>sample string 2</ItemReference>
          <Product>
            <name>sample string 2</name>
            <reference>sample string 1</reference>
          </Product>
          <ProductCategory>
            <name>sample string 2</name>
            <reference>sample string 1</reference>
          </ProductCategory>
          <Seller>
            <name>sample string 2</name>
            <reference>sample string 1</reference>
          </Seller>
          <TransactionDetailReference>sample string 1</TransactionDetailReference>
        </ProductServiceChildItem>
      </ChildItems>
      <Correlation_Id>da5ef27c-91a6-4ad2-ba58-35e875ff6fb6</Correlation_Id>
      <ExternalCollection_Ind>true</ExternalCollection_Ind>
      <ItemAmount>3</ItemAmount>
      <ItemReference>sample string 2</ItemReference>
      <Product>
        <name>sample string 2</name>
        <reference>sample string 1</reference>
      </Product>
      <ProductCategory>
        <name>sample string 2</name>
        <reference>sample string 1</reference>
      </ProductCategory>
      <ProductProgram>
        <name>sample string 2</name>
        <reference>sample string 1</reference>
      </ProductProgram>
      <SaleType>SVC</SaleType>
      <Seller>
        <name>sample string 2</name>
        <reference>sample string 1</reference>
      </Seller>
      <TransactionDetailReference>sample string 1</TransactionDetailReference>
    </ProductServiceItem>
    <ProductServiceItem>
      <ChildItems>
        <ProductServiceChildItem>
          <Correlation_Id>d3085f3c-07f9-4bc6-a280-b4b18eae6c27</Correlation_Id>
          <ItemAmount>3</ItemAmount>
          <ItemReference>sample string 2</ItemReference>
          <Product>
            <name>sample string 2</name>
            <reference>sample string 1</reference>
          </Product>
          <ProductCategory>
            <name>sample string 2</name>
            <reference>sample string 1</reference>
          </ProductCategory>
          <Seller>
            <name>sample string 2</name>
            <reference>sample string 1</reference>
          </Seller>
          <TransactionDetailReference>sample string 1</TransactionDetailReference>
        </ProductServiceChildItem>
        <ProductServiceChildItem>
          <Correlation_Id>d3085f3c-07f9-4bc6-a280-b4b18eae6c27</Correlation_Id>
          <ItemAmount>3</ItemAmount>
          <ItemReference>sample string 2</ItemReference>
          <Product>
            <name>sample string 2</name>
            <reference>sample string 1</reference>
          </Product>
          <ProductCategory>
            <name>sample string 2</name>
            <reference>sample string 1</reference>
          </ProductCategory>
          <Seller>
            <name>sample string 2</name>
            <reference>sample string 1</reference>
          </Seller>
          <TransactionDetailReference>sample string 1</TransactionDetailReference>
        </ProductServiceChildItem>
      </ChildItems>
      <Correlation_Id>da5ef27c-91a6-4ad2-ba58-35e875ff6fb6</Correlation_Id>
      <ExternalCollection_Ind>true</ExternalCollection_Ind>
      <ItemAmount>3</ItemAmount>
      <ItemReference>sample string 2</ItemReference>
      <Product>
        <name>sample string 2</name>
        <reference>sample string 1</reference>
      </Product>
      <ProductCategory>
        <name>sample string 2</name>
        <reference>sample string 1</reference>
      </ProductCategory>
      <ProductProgram>
        <name>sample string 2</name>
        <reference>sample string 1</reference>
      </ProductProgram>
      <SaleType>SVC</SaleType>
      <Seller>
        <name>sample string 2</name>
        <reference>sample string 1</reference>
      </Seller>
      <TransactionDetailReference>sample string 1</TransactionDetailReference>
    </ProductServiceItem>
  </Items>
  <Module>
    <name>sample string 2</name>
    <reference>sample string 1</reference>
  </Module>
  <Payment>
    <Account>
      <name>sample string 2</name>
      <reference>sample string 1</reference>
    </Account>
    <Method>CARD</Method>
    <PaymentProvider>
      <name>sample string 4</name>
      <reference>sample string 3</reference>
      <ProvidersBatch>sample string 2</ProvidersBatch>
      <ProvidersReference>sample string 1</ProvidersReference>
    </PaymentProvider>
  </Payment>
  <TransactionDate>sample string 2</TransactionDate>
  <TransactionReference>sample string 1</TransactionReference>
  <UsersMemo>sample string 4</UsersMemo>
  <UsersReference>sample string 3</UsersReference>
</SaleInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.