GET api/Contracts
Retrieve Contracts
Request Information
URI Parameters
None.
Body Parameters
ContractsReqName | Description | Type | Additional information |
---|---|---|---|
Company |
The company name |
string |
Required String length: inclusive between 0 and 6 |
LastSyncDate |
Retrieve contracts that were modified since LastSyncDate |
date |
Required |
ItemCode |
The item code. Optional: return all items if not given |
string |
String length: inclusive between 0 and 30 |
SupplierCode |
The supplier code. Optional: return all suppliers if not given |
string |
String length: inclusive between 0 and 15 |
Request Formats
application/json, text/json
Sample:
{ "Company": "DEMO", "LastSyncDate": "2025-01-06T22:32:15.2189577+02:00", "ItemCode": "100", "SupplierCode": "001" }
Response Information
Resource Description
ContractsResName | Description | Type | Additional information |
---|---|---|---|
MsgControl |
Contains information about the response |
MsgControl |
None. |
Contracts |
List of contract |
Collection of Contract |
None. |
Response Formats
application/json, text/json
Sample:
{ "MsgControl": { "result": 0, "Message": "Corresponding success and error message", "MethodName": "api/Contracts GET", "AppName": "EsoftWebApi", "EsoftUser": "ESOFT", "User": "Username", "Password": "Password", "SystemDate": "2025-01-06T22:32:15.2189577+02:00", "GenList": [], "GenMsg1": "", "GenMsg2": "", "GenMsg3": "" }, "Contracts": [ { "Code": 1, "SupplierCode": "110015", "SupplierName": "DEP", "ItemCode": "1001015", "ItemDesc": null, "Type": "1", "PackContract": { "Packing": 1, "PackPrice": 1.0, "PackDiscount": 0.0, "PackFreeEvery": 10, "PackFreeQty": 1, "PackUnitCost": 0.909091, "PackNotes": "pack sample" }, "PriceContract": null, "QuantityContract": null, "DateFrom": "2020-12-31", "DateTo": "2021-01-01" }, { "Code": 2, "SupplierCode": "320111", "SupplierName": "Petros", "ItemCode": "1001124", "ItemDesc": null, "Type": "2", "PackContract": null, "PriceContract": { "PriceCode": "1", "PriceAmount": 100.0, "PriceDiscount": 17.0 }, "QuantityContract": null, "DateFrom": "2020-12-01", "DateTo": "2020-12-25" }, { "Code": 34, "SupplierCode": "320120", "SupplierName": "VASSO", "ItemCode": "1001122", "ItemDesc": "pencil", "Type": "3", "PackContract": null, "PriceContract": null, "QuantityContract": { "Quantity1": 1, "QuantityPrice1": 11.5, "Quantity2": 0, "QuantityPrice2": 0.0, "Quantity3": 0, "QuantityPrice3": 0.0, "Quantity4": 0, "QuantityPrice4": 0.0, "Quantity5": 0, "QuantityPrice5": 0.0, "QuantityDiscount": 0.0 }, "DateFrom": null, "DateTo": null } ] }