POST api/{module}/OutgoingPreNFe

Request Information

URI Parameters

Name	Description	Type	Additional information
module		string	None.

Body Parameters

OutgoingPreNFeMain

Name	Type	Additional information
Document	integer	None.
Series	string	None.
Situation	EInvoiceNFeSituation	None.
SituationDesc	string	None.
PersonName	string	String length: inclusive between 0 and 120
EmissionDate	DBDateTime	None.
EmissionDateStr	string	None.
EmissionDateTimeStamp	string	None.
ExitDate	DBDateTime	None.
ExitDateStr	string	None.
ExitDateTimeStamp	string	None.
ExitHour	string	None.
SituationDate	DBDateTime	None.
SituationDateStr	string	None.
Step	string	None.
Items	Collection of Object	None.
Texts	Collection of Object	None.
Histories	Collection of Object	None.
Customer	CustomerExtent1	None.
Type	OutgoingNFeTypeMain	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.
InvoiceNetPrice	boolean	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.
ExpensesValue	decimal number	None.
CustomerDocument	string	None.
Purpose	enumFinalidadeNotaFiscal	None.
NFCommitment	string	None.
PurchaseOrder	string	None.
Contract	string	None.
ConsumerType	enumTipoConsumidor	None.
BuyerPresence	enumPresencaPessoa	None.
ApproximateValueTaxes	boolean	None.
TypeUse	ETypeUse	None.
CommissionPerc	decimal number	None.
LicensePlate	string	None.
VehicleRNTC	string	None.
VehicleUF	string	None.
Specie	string	None.
TotalVolumes	decimal number	None.
Brand	string	None.
Numeration	string	None.
GrossWeight	decimal number	None.
NetWeight	decimal number	None.
Cubage	decimal number	None.
TotalQuantity	decimal number	None.
TotalPrice	decimal number	None.
TotalPercentageDiscounts	decimal number	None.
TotalPercentageIncreases	decimal number	None.
TotalValueDiscounts	decimal number	None.
TotalValueIncreases	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.
MarginValue	decimal number	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.

Request Formats

application/json, text/json

Sample:

{
  "document": 1,
  "series": "sample string 2",
  "situation": 0,
  "situationDesc": "Bloqueada",
  "personName": "sample string 3",
  "emissionDate": {
    "BinaryData": -8584563841711355808
  },
  "emissionDateStr": "sample string 4",
  "emissionDateTimeStamp": "sample string 5",
  "exitDate": {
    "BinaryData": -8584563841711355808
  },
  "exitDateStr": "sample string 6",
  "exitDateTimeStamp": "sample string 7",
  "exitHour": "sample string 8",
  "situationDate": {
    "BinaryData": -8584563841711355808
  },
  "situationDateStr": "sample string 9",
  "step": "sample string 10",
  "items": [],
  "texts": [],
  "histories": [],
  "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,
    "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
    },
    "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
    },
    "billingDays": [],
    "contacts": [],
    "histories": [],
    "historiesHasDeletions": false,
    "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
  },
  "type": {
    "description": "sample string 1",
    "situationDesc": "Ativo",
    "id": "sample string 3",
    "userTableFields": null
  },
  "typeCode": 0,
  "personCode": "sample string 12",
  "costCenterCode": null,
  "paymentConditionCode": null,
  "fiscalNatureCode": null,
  "listPriceCode": 16,
  "carrierCode": null,
  "conveyorCode": null,
  "redispatchCode": null,
  "representativeCode": null,
  "notes": "sample string 21",
  "increasePerc": 22.1,
  "invoiceNetPrice": true,
  "discountPerc1": 24.1,
  "discountPerc2": 25.1,
  "discountPerc3": 26.1,
  "discountPerc4": 27.1,
  "discountPerc5": 28.1,
  "discountPerc6": 29.1,
  "discountPerc7": 30.1,
  "discountValue": 31.1,
  "increaseValue": 32.1,
  "freightType": 0,
  "freightValue": 33.1,
  "insuranceValue": 34.1,
  "expensesValue": 35.1,
  "customerDocument": "sample string 36",
  "purpose": 1,
  "nfCommitment": "sample string 37",
  "purchaseOrder": "sample string 38",
  "contract": "sample string 39",
  "consumerType": 0,
  "buyerPresence": 0,
  "approximateValueTaxes": true,
  "typeUse": 0,
  "commissionPerc": 41.1,
  "licensePlate": "sample string 42",
  "vehicleRNTC": "sample string 43",
  "vehicleUF": "sample string 44",
  "specie": "sample string 45",
  "totalVolumes": 46.1,
  "brand": "sample string 47",
  "numeration": "sample string 48",
  "grossWeight": 58.1,
  "netWeight": 59.1,
  "cubage": 51.1,
  "totalQuantity": 52.1,
  "totalPrice": 53.1,
  "totalPercentageDiscounts": 54.1,
  "totalPercentageIncreases": 55.1,
  "totalValueDiscounts": 56.1,
  "totalValueIncreases": 57.1,
  "totalGrossWeight": 58.1,
  "totalNetWeight": 59.1,
  "totalGrossProduct": 60.1,
  "totalNetProduct": 61.1,
  "totalTaxes": 62.1,
  "totalTaxesWithheld": 63.1,
  "totalFreight": 64.1,
  "totalExpenses": 65.1,
  "totalCommission": 66.1,
  "totalCost": 67.1,
  "totalPercentageTaxes": 68.1,
  "totalPercentageFreight": 69.1,
  "marginDesc": "sample string 70",
  "marginValue": 71.1,
  "attribute1": "sample string 72",
  "attribute2": "sample string 73",
  "attribute3": "sample string 74",
  "attribute4": "sample string 75",
  "attribute5": "sample string 76",
  "attribute6": "sample string 77",
  "attribute7": "sample string 78",
  "attribute8": "sample string 79",
  "id": "sample string 81",
  "userTableFields": null
}

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.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'OutgoingPreNFeMain'.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.