PUT api/{module}/OutgoingPreNFe/{id}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | string |
Required |
|
| module | string |
None. |
Body Parameters
OutgoingPreNFeMain| Name | Description | 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. |
|
| StepCode | integer |
None. |
|
| StepDesc | string |
None. |
|
| Items | Collection of Object |
None. |
|
| Texts | Collection of Object |
None. |
|
| Histories | Collection of Object |
None. |
|
| HasDestinationDocument | boolean |
None. |
|
| DestinationDocuments | Collection of OriginDocument |
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. |
|
| ConveyorName | string |
None. |
|
| RedispatchCode | string |
None. |
|
| RepresentativeCode | string |
None. |
|
| MoedaCodigo | string |
None. |
|
| MoedaDescricao | string |
None. |
|
| ContaFinanceiraNumero | integer |
None. |
|
| ContaFinanceiraDescricao | string |
None. |
|
| ContaContabilNumero | integer |
None. |
|
| ContaContabilDescricao | 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. |
|
| CreationUser | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"document": 1,
"series": "sample string 2",
"situation": 0,
"situationDesc": "Bloqueada",
"personName": "sample string 3",
"emissionDate": {
"BinaryData": -8584343616207455808
},
"emissionDateStr": "sample string 4",
"emissionDateTimeStamp": "sample string 5",
"exitDate": {
"BinaryData": -8584343616207455808
},
"exitDateStr": "sample string 6",
"exitDateTimeStamp": "sample string 7",
"exitHour": "sample string 8",
"situationDate": {
"BinaryData": -8584343616207455808
},
"situationDateStr": "sample string 9",
"stepCode": 10,
"stepDesc": "sample string 11",
"items": [],
"texts": [],
"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,
"grupoPessoaCodigo": null,
"grupoPessoaDescricao": null,
"categoryCode": null,
"commercialClassificCode": null,
"relationshipClassificationCode": 0,
"relationshipClassificationDesc": null,
"representativeCode": null,
"conveyorCode": null,
"paymentConditionCode": null,
"moedaCodigo": null,
"moedaDescricao": null,
"contaContabilNumero": 0,
"contaContabilDescricao": 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"
},
"typeCode": 0,
"personCode": "sample string 13",
"costCenterCode": null,
"paymentConditionCode": null,
"fiscalNatureCode": null,
"listPriceCode": 17,
"carrierCode": null,
"conveyorCode": null,
"conveyorName": "sample string 20",
"redispatchCode": null,
"representativeCode": null,
"moedaCodigo": null,
"moedaDescricao": null,
"contaFinanceiraNumero": 0,
"contaFinanceiraDescricao": null,
"contaContabilNumero": 0,
"contaContabilDescricao": null,
"notes": "sample string 26",
"increasePerc": 27.1,
"invoiceNetPrice": true,
"discountPerc1": 29.1,
"discountPerc2": 30.1,
"discountPerc3": 31.1,
"discountPerc4": 32.1,
"discountPerc5": 33.1,
"discountPerc6": 34.1,
"discountPerc7": 35.1,
"discountValue": 36.1,
"increaseValue": 37.1,
"freightType": 0,
"freightValue": 38.1,
"insuranceValue": 39.1,
"expensesValue": 40.1,
"customerDocument": "sample string 41",
"purpose": 1,
"nfCommitment": "sample string 42",
"purchaseOrder": "sample string 43",
"contract": "sample string 44",
"consumerType": 0,
"buyerPresence": 0,
"approximateValueTaxes": true,
"typeUse": 0,
"commissionPerc": 46.1,
"licensePlate": "sample string 47",
"vehicleRNTC": "sample string 48",
"vehicleUF": "sample string 49",
"specie": "sample string 50",
"totalVolumes": 51.1,
"brand": "sample string 52",
"numeration": "sample string 53",
"grossWeight": 63.1,
"netWeight": 64.1,
"cubage": 56.1,
"totalQuantity": 57.1,
"totalPrice": 58.1,
"totalPercentageDiscounts": 59.1,
"totalPercentageIncreases": 60.1,
"totalValueDiscounts": 61.1,
"totalValueIncreases": 62.1,
"totalGrossWeight": 63.1,
"totalNetWeight": 64.1,
"totalGrossProduct": 65.1,
"totalNetProduct": 66.1,
"totalTaxes": 67.1,
"totalTaxesWithheld": 68.1,
"totalFreight": 69.1,
"totalExpenses": 70.1,
"totalCommission": 71.1,
"totalCost": 72.1,
"totalPercentageTaxes": 73.1,
"totalPercentageFreight": 74.1,
"marginDesc": "sample string 75",
"marginValue": 76.1,
"attribute1": "sample string 77",
"attribute2": "sample string 78",
"attribute3": "sample string 79",
"attribute4": "sample string 80",
"attribute5": "sample string 81",
"attribute6": "sample string 82",
"attribute7": "sample string 83",
"attribute8": "sample string 84",
"id": "sample string 86",
"userTableFields": null,
"creationUser": "sample string 87"
}
application/xml
Sample:
text/xml
Sample:
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
HttpResponseMessage| Name | Description | 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. |