eRep API

RetrieveSchema

Get the table schema required to prepare import JSON.

Request

URI Parameters

None.

Body Parameters

None.

Sample API Request

GET api/OrderHeader/RetrieveSchema

api/OrderHeader/RetrieveSchema

Response

Resource Description

Returns the success/error status along with requested table schema.

ResponseMessage

Name	Description	Type	Additional information
Status	The status of the request, namely Success or Error.	MessageStatus	None.
Message	The response message containing either message or requested data.	string	None.

Sample API Response

GET api/OrderHeader/RetrieveSchema

[{ "Status":1, "Message": "[ {"QuoteHeaderID":"Int Optional"}, {"CreatorId":"Int Mandatory"}, {"BrandID":"Int Mandatory"}, {"assignedToID":"Int Optional"}, {"TransactionTypeID":"Int Mandatory"}, {"TermID":"Int Mandatory"}, {"CurrencyID":"Int Mandatory"}, {"OrderStatusID":"Int Mandatory"}, {"ShipMethodID":"Int Mandatory"}, {"ShipToID":"Int Optional"}, {"ModifiedByID":"Int Optional"}, {"ProjectID":"Int Optional"}, {"VendorID":"Int Optional"}, {"OrderTypeID":"Int Mandatory"}, {"PaymentMethodID":"Int Optional"}, {"Shipped":"Bool Optional"}, {"ShipDate":"DateTime Optional"}, {"TrackingNumber":"String(50) Optional"}, {"Billed":"Bool Optional"}, {"BilledDate":"DateTime Optional"}, {"Invoiced":"Bool Optional"}, {"InvoiceNumber":"String(20) Optional"}, {"InvoiceDate":"DateTime Optional"}, {"TrailerNumber":"String(36) Optional"}, {"TrailerPrefix":"String(36) Optional"}, {"AmountPaid":"Decimal(19,4) Optional"}, {"BalanceDue":"Decimal(19,4) Optional"}, {"DateCreated":"DateTime Mandatory"}, {"RequestedShipDate":"DateTime Optional"}, {"DateCanceled":"DateTime Optional"}, {"Memorize":"Bool Optional"}, {"PurchaseOrderNumber":"String(36) Optional"}, {"TaxExemptID":"String(20) Mandatory"}, {"TaxGroup":"String(36) Mandatory"}, {"CurrencyExchangeRate":"Double(53,0) Optional"}, {"Subtotal":"Decimal(19,4) Optional"}, {"DiscountPers":"Double(53,0) Optional"}, {"DiscountAmount":"Decimal(19,4) Optional"}, {"TaxPercent":"Double(53,0) Optional"}, {"TaxAmount":"Decimal(19,4) Optional"}, {"TaxableSubTotal":"Decimal(19,4) Optional"}, {"Freight":"Decimal(19,4) Optional"}, {"TaxFreight":"Bool Optional"}, {"Handling":"Decimal(19,4) Optional"}, {"Total":"Decimal(19,4) Optional"}, {"Commission":"Decimal(19,4) Optional"}, {"CommissionableSales":"Decimal(19,4) Optional"}, {"ComissionalbleCost":"Decimal(19,4) Optional"}, {"CustomerDropShipment":"Bool Optional"}, {"ShippingName":"String(50) Optional"}, {"ShippingAddress1":"String(50) Optional"}, {"ShippingAddress2":"String(50) Optional"}, {"ShippingAddress3":"String(50) Optional"}, {"ShippingCity":"String(50) Optional"}, {"ShippingState":"String(50) Optional"}, {"ShippingZip":"String(10) Optional"}, {"ShippingCounty":"String(50) Optional"}, {"ShippingCountry":"String(50) Optional"}, {"ShippingContactPhone":"String(50) Optional"}, {"ShippingContactName":"String(80) Optional"}, {"ShippingAttention":"String(50) Optional"}, {"ScheduledStartDate":"DateTime Optional"}, {"ScheduledEndDate":"DateTime Optional"}, {"Backordered":"Bool Optional"}, {"Picked":"Bool Optional"}, {"PickedDate":"DateTime Optional"}, {"Printed":"Bool Optional"}, {"PrintedDate":"DateTime Optional"}, {"Posted":"Bool Optional"}, {"PostedDate":"DateTime Optional"}, {"AllowanceDiscountPerc":"Double(53,0) Optional"}, {"Approved":"Bool Optional"}, {"ApprovedBy":"String(36) Optional"}, {"ApprovedDate":"DateTime Optional"}, {"EnteredBy":"String(36) Optional"}, {"Signature":"String(36) Optional"}, {"SignaturePassword":"String(36) Optional"}, {"CommissionStatus":"String(20) Optional"}, {"ExternalOrderNumber":"String(36) Optional"}, {"RepCompany":"String(50) Optional"}, {"RepName":"String(50) Optional"}, {"RepAccount":"String(50) Optional"}, {"SplitShip":"Bool Optional"}, {"CustAccountNo":"String(50) Optional"}, {"CompanyName":"String(50) Optional"}, {"CustomerName":"String(50) Optional"}, {"CustomerAddress1":"String(100) Optional"}, {"CustomerAddress2":"String(100) Optional"}, {"CustomerAddress3":"String(100) Optional"}, {"CustomerState":"String(50) Optional"}, {"CustomerCity":"String(50) Optional"}, {"CustomerZip":"String(50) Optional"}, {"CustomerCounty":"String(50) Optional"}, {"CustomerCountry":"String(50) Optional"}, {"CustomerPhone":"String(50) Optional"}, {"CustomerFax":"String(50) Optional"}, {"CustomerEmail":"String(80) Optional"}, {"ModifiedDate":"DateTime Optional"}, {"Name":"String(255) Optional"}, {"RepCompanyName":"String(50) Optional"}, {"RepCompanyPhone":"String(50) Optional"}, {"RepCompanyFax":"String(50) Optional"}, {"RepCompanyContact":"String(50) Optional"}, {"PendingMultiplierRequest":"Bool Mandatory"}, {"SpecialReview":"Bool Mandatory"}, {"CreditReview":"Bool Mandatory"}, {"MultiplierRequestedReason":"String(255) Optional"}, {"MultiplierRequestedBasis":"String(50) Optional"}, {"totalListPrice":"Decimal(19,4) Optional"}, {"TotalEquipment":"Decimal(19,4) Optional"}, {"CommissionPercent":"Double(53,0) Optional"}, {"MarginPerc":"Decimal(8,0) Optional"}, {"RegionalSalesManager":"String(50) Optional"}, {"FreightQuoteNumber":"String(36) Optional"}, {"FreightQuoted":"Bool Mandatory"}, {"TaxExempt":"Bool Mandatory"}, {"ShipToContactName":"String(250) Optional"}, {"ShipToContactPhone":"String(250) Optional"}, {"JobName":"String(50) Optional"}, {"RepEmail":"String(80) Optional"}, {"fulfillmentReview":"Bool Optional"}, {"Finalized":"Bool Optional"}, {"WeightedMultiplier":"Double(53,0) Optional"}, {"shippingEmail":"String(80) Optional"}, {"instructions":"String(255) Mandatory"}, {"FactoryOrderNumber":"String(36) Optional"}, {"SentToERP":"Bool Optional"}, {"ShippingCompanyName":"String(50) Optional"}, {"WeightedMargin":"Float(24,0) Optional"}, {"ExpectedOrderDate":"DateTime Mandatory"}, {"ShippingCost":"Decimal(19,4) Optional"}, {"TerritoryID":"Int Optional"}, {"CustomerFreightAccountNumber":"String(50) Optional"}, {"EndUserCompanyName":"String(50) Optional"}, {"EndUserName":"String(50) Optional"}, {"EndUserAddress1":"String(100) Optional"}, {"EndUserAddress2":"String(100) Optional"}, {"EndUserAddress3":"String(100) Optional"}, {"EndUserState":"String(50) Optional"}, {"EndUserCity":"String(50) Optional"}, {"EndUserZip":"String(50) Optional"}, {"EndUserCounty":"String(50) Optional"}, {"EndUserCountry":"String(50) Optional"}, {"EndUserPhone":"String(50) Optional"}, {"EndUserFax":"String(50) Optional"}, {"EndUserEmail":"String(80) Optional"}, {"TotalWriteIn":"Decimal(19,4) Optional"}, {"TaxTypeID":"Int Optional"}, {"EstimateNumOfReleases":"Int Optional"}, {"PaymentAmount":"Decimal(19,4) Optional"}, {"PaymentTransactionID":"String(50) Optional"}, {"PaymentCardType":"String(30) Optional"}, {"PaymentNameOnCard":"String(80) Optional"}, {"PaymentDate":"DateTime Optional"}, {"OrderCategoryID":"Int Optional"}, {"VendorOrderId":"String(100) Optional"}, {"NetProfitMargin":"Decimal(19,4) Optional"}, {"OptReferenceOrderID":"String(10) Optional"}, {"OptReferenceType":"String(10) Optional"} ]" }]

<- Back to Help Page Home