GET api/{module}/SalesOrder/{id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		string	Required
module		string	None.

Body Parameters

None.

Response Information

Resource Description

SalesOrderDetailsPrimary

Name	Type	Additional information
OriginDocument	string	None.
TypeCode	integer	None.
PersonCode	string	None.
CostCenterCode	string	None.
PaymentConditionCode	string	None.
FiscalNatureCode	string	None.
ListPriceCode	integer	None.
CarrierCode	string	None.
ConveyorCode	string	None.
RedispatchCode	string	None.
RepresentativeCode	string	None.
Notes	string	String length: inclusive between 0 and 512
IncreasePerc	decimal number	None.
DiscountPerc1	decimal number	None.
DiscountPerc2	decimal number	None.
DiscountValue	decimal number	None.
IncreaseValue	decimal number	None.
FreightType	EFreightType	None.
FreightValue	decimal number	None.
InsuranceValue	decimal number	None.
AllowsPartialBilling	boolean	None.
AllowsEarlyBilling	boolean	None.
ExpensesValue	decimal number	None.
CustomerDocument	string	None.
TypeUse	ETypeUse	None.
CommissionPerc	decimal number	None.
Document	integer	None.
Series	string	None.
Situation	ESalesOrderSituation	None.
SituationDesc	string	None.
PersonName	string	String length: inclusive between 0 and 120
EmissionDate	DBDateTime	None.
EmissionDateStr	string	None.
ForecastDate	DBDateTime	None.
ForecastDateStr	string	None.
ForecastDateTimeStamp	string	None.
SituationDate	DBDateTime	None.
SituationDateStr	string	None.
Step	string	None.
Attribute1	string	None.
Attribute2	string	None.
Attribute3	string	None.
Attribute4	string	None.
Attribute5	string	None.
Attribute6	string	None.
Attribute7	string	None.
Attribute8	string	None.
Id	string	None.

Response Formats

application/json, text/json

Sample:

{
  "originDocument": null,
  "typeCode": 0,
  "personCode": "sample string 2",
  "costCenterCode": null,
  "paymentConditionCode": null,
  "fiscalNatureCode": null,
  "listPriceCode": 0,
  "carrierCode": null,
  "conveyorCode": null,
  "redispatchCode": null,
  "representativeCode": null,
  "notes": "sample string 11",
  "increasePerc": 12.1,
  "discountPerc1": 13.1,
  "discountPerc2": 14.1,
  "discountValue": 15.1,
  "increaseValue": 16.1,
  "freightType": 0,
  "freightValue": 17.1,
  "insuranceValue": 18.1,
  "allowsPartialBilling": true,
  "allowsEarlyBilling": true,
  "expensesValue": 21.1,
  "customerDocument": "sample string 22",
  "typeUse": 0,
  "commissionPerc": 23.1,
  "document": 24,
  "series": "sample string 25",
  "situation": 0,
  "situationDesc": "Bloqueado",
  "personName": "sample string 26",
  "emissionDate": {
    "BinaryData": -8584400034657565808
  },
  "emissionDateStr": "sample string 27",
  "forecastDate": {
    "BinaryData": -8584400034657565808
  },
  "forecastDateStr": "sample string 28",
  "forecastDateTimeStamp": "sample string 29",
  "situationDate": {
    "BinaryData": -8584400034657565808
  },
  "situationDateStr": "sample string 30",
  "step": "sample string 31",
  "attribute1": "sample string 32",
  "attribute2": "sample string 33",
  "attribute3": "sample string 34",
  "attribute4": "sample string 35",
  "attribute5": "sample string 36",
  "attribute6": "sample string 37",
  "attribute7": "sample string 38",
  "attribute8": "sample string 39",
  "id": "sample string 40"
}

application/xml, text/xml

Sample:

<SalesOrderDetailsPrimary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Avant.Plenus.WebApi.Models.Business.Sales">
  <Id xmlns="http://schemas.datacontract.org/2004/07/Avant.Plenus.WebApi.Models.Business.Common">sample string 40</Id>
  <Attribute1>sample string 32</Attribute1>
  <Attribute2>sample string 33</Attribute2>
  <Attribute3>sample string 34</Attribute3>
  <Attribute4>sample string 35</Attribute4>
  <Attribute5>sample string 36</Attribute5>
  <Attribute6>sample string 37</Attribute6>
  <Attribute7>sample string 38</Attribute7>
  <Attribute8>sample string 39</Attribute8>
  <Document>24</Document>
  <EmissionDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/Avant.DataTypes">
    <BinaryData xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:long" xmlns="">-8584400034657565808</BinaryData>
  </EmissionDate>
  <EmissionDateStr>sample string 27</EmissionDateStr>
  <ForecastDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/Avant.DataTypes">
    <BinaryData xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:long" xmlns="">-8584400034657565808</BinaryData>
  </ForecastDate>
  <ForecastDateStr>sample string 28</ForecastDateStr>
  <ForecastDateTimeStamp>sample string 29</ForecastDateTimeStamp>
  <PersonName>sample string 26</PersonName>
  <Series>sample string 25</Series>
  <Situation>Blocked</Situation>
  <SituationDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/Avant.DataTypes">
    <BinaryData xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:long" xmlns="">-8584400034657565808</BinaryData>
  </SituationDate>
  <SituationDateStr>sample string 30</SituationDateStr>
  <Step>sample string 31</Step>
  <AllowsEarlyBilling>true</AllowsEarlyBilling>
  <AllowsPartialBilling>true</AllowsPartialBilling>
  <CarrierCode i:nil="true" />
  <CommissionPerc>23.1</CommissionPerc>
  <ConveyorCode i:nil="true" />
  <CostCenterCode i:nil="true" />
  <CustomerDocument>sample string 22</CustomerDocument>
  <DiscountPerc1>13.1</DiscountPerc1>
  <DiscountPerc2>14.1</DiscountPerc2>
  <DiscountValue>15.1</DiscountValue>
  <ExpensesValue>21.1</ExpensesValue>
  <FiscalNatureCode i:nil="true" />
  <FreightType>Cif</FreightType>
  <FreightValue>17.1</FreightValue>
  <IncreasePerc>12.1</IncreasePerc>
  <IncreaseValue>16.1</IncreaseValue>
  <InsuranceValue>18.1</InsuranceValue>
  <ListPriceCode>0</ListPriceCode>
  <Notes>sample string 11</Notes>
  <PaymentConditionCode i:nil="true" />
  <PersonCode>sample string 2</PersonCode>
  <RedispatchCode i:nil="true" />
  <RepresentativeCode i:nil="true" />
  <TypeCode>0</TypeCode>
  <TypeUse>ByItemOperation</TypeUse>
</SalesOrderDetailsPrimary>