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

SalesOrderFull

Name	Type	Additional information
SalesOrderItems	Collection of Object	None.
SalesOrderTexts	Collection of Object	None.
Histories	Collection of Object	None.
HasDestinationDocument	boolean	None.
DestinationDocuments	Collection of OriginDocument	None.
Customer	CustomerExtent1	None.
Type	SalesOrderTypeMain	None.
OriginDocument	string	None.
DestinationDocument	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.
ConveyorName	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.
DiscountPerc3	decimal number	None.
DiscountPerc4	decimal number	None.
DiscountPerc5	decimal number	None.
DiscountPerc6	decimal number	None.
DiscountPerc7	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.
NFCommitment	string	None.
PurchaseOrder	string	None.
Contract	string	None.
TypeUse	ETypeUse	None.
CommissionPerc	decimal number	None.
TotalPercentageDiscounts	decimal number	None.
TotalPercentageIncreases	decimal number	None.
TotalValueDiscounts	decimal number	None.
TotalValueIncreases	decimal number	None.
TotalVolumes	decimal number	None.
TotalGrossWeight	decimal number	None.
TotalNetWeight	decimal number	None.
TotalGrossProduct	decimal number	None.
TotalNetProduct	decimal number	None.
TotalTaxes	decimal number	None.
TotalTaxesWithheld	decimal number	None.
TotalFreight	decimal number	None.
TotalExpenses	decimal number	None.
TotalCommission	decimal number	None.
TotalCost	decimal number	None.
TotalPercentageTaxes	decimal number	None.
TotalPercentageFreight	decimal number	None.
MarginDesc	string	None.
TotalQuantity	decimal number	None.
TotalPrice	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.
DeliveryForecast	string	None.
StepCode	integer	None.
StepDesc	string	None.
StepDate	DBDateTime	None.
StepDateStr	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.
UserTableFields	Collection of Object	None.
CreationUser	string	None.

Response Formats

application/json, text/json

Sample:

{
  "salesOrderItems": [],
  "salesOrderTexts": [],
  "histories": [],
  "hasDestinationDocument": false,
  "destinationDocuments": null,
  "customer": {
    "conveyorCodeAttribute1": null,
    "redispatchCode": null,
    "listPriceCode": 0,
    "costCenterCode": null,
    "customerAllowsPartialBilling": true,
    "customerAllowsEarlyBilling": true,
    "stateId": null,
    "fantasyName": null,
    "site": null,
    "telephone": null,
    "telephoneExtension": null,
    "businessPhone": null,
    "businessExtension": null,
    "fax": null,
    "cellphone": null,
    "email": null,
    "notes": null,
    "bornDate": null,
    "bornDateTS": null,
    "languageCode": 0,
    "branchActivityCode": null,
    "branchActivityDesc": null,
    "groupCode": null,
    "categoryCode": null,
    "commercialClassificCode": null,
    "relationshipClassificationCode": 0,
    "relationshipClassificationDesc": null,
    "representativeCode": null,
    "conveyorCode": null,
    "paymentConditionCode": null,
    "carrierCode": null,
    "fiscalNatureCode": "",
    "freightType": 0,
    "situationDesc": "Ativo",
    "nonContributor": false,
    "cnae": null,
    "taxRegime": 0,
    "suframa": null,
    "fiscalText": null,
    "locationAddress": {
      "zipCode": null,
      "streetName": null,
      "streetNumber": null,
      "complement": null,
      "district": null,
      "referencePoint": null,
      "country": null,
      "state": null,
      "city": null,
      "id": null,
      "userTableFields": null,
      "creationUser": null
    },
    "financial": {
      "partialBilling": true,
      "earlyBilling": true,
      "fractionalDelivery": true,
      "earlyDelivery": true,
      "vendor": false,
      "accountingAccount": 0,
      "graceDays": 0,
      "billingCustomer": null,
      "usedCredit": null,
      "fullCredit": 0.0,
      "availableCredit": 0.0,
      "lastPurchase": null,
      "biggestPurchase": null,
      "averageTerm": null,
      "overdueBonds": null,
      "id": null,
      "userTableFields": null,
      "creationUser": null
    },
    "billingDays": [],
    "contacts": [],
    "histories": [],
    "historiesHasDeletions": false,
    "addresses": [],
    "attribute1": null,
    "attribute2": null,
    "attribute3": null,
    "attribute4": null,
    "attribute5": null,
    "attribute6": null,
    "attribute7": null,
    "attribute8": null,
    "attribute_I_1": null,
    "attribute_I_2": null,
    "type": 0,
    "typeDescription": "Jurídica",
    "legalId": "",
    "name": null,
    "id": null,
    "userTableFields": null,
    "creationUser": null
  },
  "type": {
    "description": "sample string 1",
    "situationDesc": "Ativo",
    "id": "sample string 3",
    "userTableFields": null,
    "creationUser": "sample string 4"
  },
  "originDocument": null,
  "destinationDocument": null,
  "typeCode": 0,
  "personCode": "sample string 2",
  "costCenterCode": null,
  "paymentConditionCode": null,
  "fiscalNatureCode": null,
  "listPriceCode": 6,
  "carrierCode": null,
  "conveyorCode": null,
  "conveyorName": "sample string 9",
  "redispatchCode": null,
  "representativeCode": null,
  "notes": "sample string 12",
  "increasePerc": 13.1,
  "discountPerc1": 14.1,
  "discountPerc2": 15.1,
  "discountPerc3": 16.1,
  "discountPerc4": 17.1,
  "discountPerc5": 18.1,
  "discountPerc6": 19.1,
  "discountPerc7": 20.1,
  "discountValue": 21.1,
  "increaseValue": 22.1,
  "freightType": 0,
  "freightValue": 23.1,
  "insuranceValue": 24.1,
  "allowsPartialBilling": true,
  "allowsEarlyBilling": true,
  "expensesValue": 27.1,
  "customerDocument": "sample string 28",
  "nfCommitment": "sample string 29",
  "purchaseOrder": "sample string 30",
  "contract": "sample string 31",
  "typeUse": 0,
  "commissionPerc": 32.1,
  "totalPercentageDiscounts": 33.1,
  "totalPercentageIncreases": 34.1,
  "totalValueDiscounts": 35.1,
  "totalValueIncreases": 36.1,
  "totalVolumes": 37.1,
  "totalGrossWeight": 38.1,
  "totalNetWeight": 39.1,
  "totalGrossProduct": 40.1,
  "totalNetProduct": 41.1,
  "totalTaxes": 42.1,
  "totalTaxesWithheld": 43.1,
  "totalFreight": 44.1,
  "totalExpenses": 45.1,
  "totalCommission": 46.1,
  "totalCost": 47.1,
  "totalPercentageTaxes": 48.1,
  "totalPercentageFreight": 49.1,
  "marginDesc": "sample string 50",
  "totalQuantity": 51.1,
  "totalPrice": 52.1,
  "document": 53,
  "series": "sample string 54",
  "situation": 0,
  "situationDesc": "Bloqueado",
  "personName": "sample string 55",
  "emissionDate": {
    "BinaryData": -8584564668467625808
  },
  "emissionDateStr": "sample string 56",
  "forecastDate": {
    "BinaryData": -8584564668467625808
  },
  "forecastDateStr": "sample string 57",
  "forecastDateTimeStamp": "sample string 58",
  "situationDate": {
    "BinaryData": -8584564668467625808
  },
  "situationDateStr": "sample string 59",
  "deliveryForecast": "sample string 60",
  "stepCode": 61,
  "stepDesc": "sample string 62",
  "stepDate": {
    "BinaryData": -8584564668467625808
  },
  "stepDateStr": "sample string 63",
  "attribute1": "sample string 64",
  "attribute2": "sample string 65",
  "attribute3": "sample string 66",
  "attribute4": "sample string 67",
  "attribute5": "sample string 68",
  "attribute6": "sample string 69",
  "attribute7": "sample string 70",
  "attribute8": "sample string 71",
  "id": "sample string 73",
  "userTableFields": null,
  "creationUser": "sample string 74"
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Enum value '0' is invalid for type 'Avant.Plenus.WebApi.Enums.Admin.Enums+ETaxRegime' and cannot be serialized. Ensure that the necessary enum values are present and are marked with EnumMemberAttribute attribute if the type has DataContractAttribute attribute.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Enum value '0' is invalid for type 'Avant.Plenus.WebApi.Enums.Admin.Enums+ETaxRegime' and cannot be serialized. Ensure that the necessary enum values are present and are marked with EnumMemberAttribute attribute if the type has DataContractAttribute attribute.