Samples — SmartAPI

Altera dados de um cliente.

Endpoint: PATCH Customer

{
"OrganizationName": "Mundo infinito, Lda.",
"AddressLine1": "Rua da Estrela, 23",
"AddressLine2": "",
"PostalCode": "1200-123 Lisboa",
"CountryID": "PRT",
"ProvinceID": "11",
"LocalityID": 7,
"FederalTaxId": "",
"BirthDate": "1989-08-03T00:00:00",
"WebAddress": "",
"Telephone1": "215556644",
"Telephone2": "",
"Telephone3": "",
"Telephone4": "",
"MobileTelephone1": "967548015",
"MobileTelephone2": "967548015",
"Fax": "",
"Email": "etorre@smartdigit.pt",
"CustomerPicturePath": "",
"SalesmanId": 1,
"ZoneID": 1,
"ZoneName": "Viana do Castelo ",
"CurrencyID": "EUR",
"PaymentID": 2,
"PaymentName": "30 Dias",
"CarrierID": 1,
"CarrierName": "CTT - IVA Isento",
"CashDiscountTermID": "1",
"CashDiscountTermName": null,
"TenderID": 1,
"PriceLineID": 0,
"CustomerLevel": 1,
"CustomerGroupDescription": "",
"EntityFiscalStatusID": 1

Altera dados de um artigo.

Endpoint: PATCH Item

{
"ItemID":"151201",
"Description":"Caviar, Sturgeon, Black, Jar, Lemberg (box*6) 50g",
"ShortDescription":"Caviar, Sturgeon, Black",
"BarCode":"4260051071985",
"SupplierID":"1",
"SalePrice":[
{
"PriceLineID":0,
"UnitPrice":0,
"CreateDate":"2023-12-08T16:45:20Z",
"TaxIncludedPrice":0,
"FixedProfitRate":0
},
{
"PriceLineID":1,
"UnitPrice":0,
"CreateDate":"2023-12-08T16:45:20Z",
"TaxIncludedPrice":0,
"FixedProfitRate":0
}
]
}

Cria um artigo.

Endpoint: POST Item

{
"ItemID":"151201",
"ItemType":0,
"Description":"Caviar, Sturgeon, Black, Jar, Lemberg (box*6) 50g",
"ShortDescription":"Caviar, Sturgeon, Black",
"BarCode":"4260051071985",
"BarCodeType":0,
"WeightUnitOfMeasure":"GM",
"WeightMeasure":50,
"TaxableGroupID":4,
"ItemTax":1,
"ItemTax2":0,
"ItemTax3":0,
"AverageCostPrice":0,
"SupplierID":"1",
"Family":{
"FamilyID":"1"
},
"UnitOfSaleID":"UNI",
"AlternativeUnitOfStock":"UNI",
"UnitConversion":1,
"DefaultSellingUnit":"UNI",
"DefaultBuyUnit":"UNI",
"DefaultStockUnit":"UNI",
"Locked":0,
"ExtraFieldList":[

],
"SalePrice":[
{
"PriceLineID":0,
"UnitPrice":0,
"CreateDate":"2023-12-08T16:45:20Z",
"TaxIncludedPrice":0,
"FixedProfitRate":0
},
{
"PriceLineID":1,
"UnitPrice":0,
"CreateDate":"2023-12-08T16:45:20Z",
"TaxIncludedPrice":0,
"FixedProfitRate":0
}
],
"Comments":"",
"StockManagement":true,
"Discontinued":false
}

Cria um artigo com campos extra.

Endpoint: POST Item

{
"ItemID":"0001",
"ItemType":0,
"Description":"Product Name ",
"ShortDescription":"Product Name",
"BarCode":"4260051071985",
"TaxableGroupID":4,
"SupplierID":"1",
"Family":{
"FamilyID":"1"
},
"UnitOfSaleID":"UNI",
"Locked":0,
"ExtraFieldList":[
{
"ExtraFieldID":"1",
"TextAnswer":"Auto Tires"
},
{
"ExtraFieldID":"2",
"TextAnswer":"4x4 road tires"
},
{
"ExtraFieldID":"3",
"TextAnswer":"Bridgestone"
},
{
"ExtraFieldID":"4",
"TextAnswer":"Alenza 001"
},
{
"ExtraFieldID":"5",
"TextAnswer":"245"
},
{
"ExtraFieldID":"6",
"TextAnswer":"55"
},
{
"ExtraFieldID":"7",
"TextAnswer":"16"
},
{
"ExtraFieldID":"8",
"TextAnswer":"R"
},
{
"ExtraFieldID":"9",
"TextAnswer":"W"
},
{
"ExtraFieldID":"10",
"TextAnswer":"105"
},
{
"ExtraFieldID":"11",
"TextAnswer":"XL"
},
{
"ExtraFieldID":"12",
"TextAnswer":"A"
},
{
"ExtraFieldID":"13",
"TextAnswer":"B"
},
{
"ExtraFieldID":"14",
"TextAnswer":"B (71db)"
}
],
"SalePrice":[
{
"PriceLineID":0,
"UnitPrice":0,
"CreateDate":"2023-12-08T16:45:20Z",
"TaxIncludedPrice":0,
"FixedProfitRate":0
},
{
"PriceLineID":1,
"UnitPrice":10,
"CreateDate":"2023-12-08T16:45:20Z",
"TaxIncludedPrice":0,
"FixedProfitRate":0
}
],
"Comments":""
}

Cria um cliente.

Endpoint: POST Customer

{
"OrganizationName":"Hrach Barseghyan",
"SalesmanId":1,
"ZoneID":"1",
"CarrierID":1,
"PaymentID":1,
"TenderID":"1",
"AddressLine1":"90 Aram srt.",
"AddressLine2":"",
"PostalCode":"1234-123",
"CountryID":"ARM",
"MobileTelephone1":"00 374 99 747747",
"Telephone1":"",
"EntityFiscalStatusID":"6",
"CustomerLevel":1,
"Email":"hrachb2002@gmail.com",
"IssuingOutput":0,
"LimitType":1,
"CurrencyID":"EUR",
"ActiveParty":true,
"PriceLineID":"1",
"IntranetEMailDaily":true,
"IntranetEMailWeekly":true,
"TaxablePersonType":1,
"GDPRConsent":true,
"FrequentShopperPoints":0,
"FederalTaxID":"123456789",
"KeyFederalTaxID":"0"
}

Cria um documento de venda ou compra.

Endpoint: POST ItemTransaction

{
"TransSerial":"1",
"TransDocument":"FR",
"PartyID":"2",
"Comments":"Document Comments",
"TransactionTaxIncluded":"True", "Details":[
{
"ItemID":"arroz001",
"Quantity":10,
"UnitPrice":1.22,
"WarehouseID":1,
"Color":{
"ColorID":0
},
"Size":{
"SizeID":0
},
"DiscountPercent":0
},
{
"ItemID":"arroz002",
"Quantity":6,
"UnitPrice":1.15,
"WarehouseID":1,
"Color":{
"ColorID":0
},
"Size":{
"SizeID":0
},
"DiscountPercent":0
}
], "Salesman":{
"SalesmanID":1
},
"Payment":{
"PaymentID":1
},
"ContractReferenceNumber":"Document Reference",
"UnloadPlace":{
"LoadUnloadPlaceID":2
},
"UnloadPlaceAddress":{
"AddressLine1":"Vale da Grama - Alto do Assilho Intermarche Albergaria-a-Velha",
"AddressLine2":"",
"PostalCode":"3850-226 Albergaria-a-Vel"
}
}