Subject APIs
In this category, you will find APIs that enable you to get all subjects with all data, insert subject into the database or update an existing ident in the database.
Table of contents
- POST/api/Subject/retrieve
- POST/api/Subject
- PUT/api/Subject
|
1. Short descripiton of Subject API`s
|
POST/api/Subject/retrieve
|
Get all subject with all data. |
|
POST/api/Subject
|
Inserts a subject into the database. |
|
PUT/api/Subject
|
Updates an existing ident in the database. |
2. POST/api/Subject/retrieve
This API enables you to to get ident data as a result of a query defined THE_SetSubj as masterTable with ability to join tables in the parameters tableFKs with custom conditions in the parameters customConditions.
Additionally, you can sort your data with param sortColumn and sortOrder.
The parameter withSubSelect can be used to structure the result set as a .json file. If the parameter withSubSelect is 0, then the result set will be shown in a flat structure.
If the parameter withSubSelect is 1, then the result set will be shown in a nested structure.
{
"start": 0,
"length": 0,
"fieldsToReturn": "string",
"tableFKs": [
{
"table": "string",
"alias": "string",
"join": "string",
"parentAlias": "string",
"fieldsToReturn": "string"
}
],
"customConditions": {
"condition": "string",
"params": [
"string"
]
},
"sortColumn": "string",
"sortOrder": "string",
"withSubSelects": 0
}
3. POST/API/Subject
This API enables you to insert individual data IN the main table tHE_SetSubj from the specified structure.
{
"subject": "string",
"buyer": "string",
"supplier": "string",
"bank": "string",
"municipality": "string",
"locComm": "string",
"warehouse": "string",
"worker": "string",
"user": "string",
"dept": "string",
"school": "string",
"institution": "string",
"name2": "string",
"address": "string",
"name3": "string",
"post": "string",
"country": "string",
"km": 0,
"vatcodePrefix": "string",
"code": "string",
"region": "string",
"suprCommune": "string",
"phone": "string",
"fax": "string",
"subUnit": "string",
"priceRate": "string",
"daysForPayment": 0,
"yearStatement": "string",
"dateState": "2022-04-21T07:57:46.928Z",
"statement": "string",
"limit": 0,
"dateLimit": "2022-04-21T07:57:46.928Z",
"maxDaysPayDelay": 0,
"subjTypeSupp": "string",
"subjTypeBuyer": "string",
"stockManage": "string",
"stockValue": "string",
"stockInMinus": "string",
"dateInvent": "2022-04-21T07:57:46.928Z",
"clerk": 0,
"rebate": 0,
"wayOfSale": "string",
"currency": "string",
"priceCalcMethod": "string",
"payMethod": "string",
"delivery": "string",
"regNo": "string",
"acPayer": "string",
"activityCode": "string",
"separSaleCalc": "string",
"suppPriceCalcMet": "string",
"suppDiscount": 0,
"suppSaleMet": "string",
"suppYearStatement": "string",
"suppDateSta": "2022-04-21T07:57:46.928Z",
"suppPayDays": 0,
"suppPayMet": "string",
"suppStatement": "string",
"suppLimit": 0,
"suppDateLim": "2022-04-21T07:57:46.928Z",
"suppDelivery": "string",
"suppCurr": "string",
"suppClerk": 0,
"payOrdPriorty": "string",
"swiftcode": "string",
"atwarehouse": "string",
"municipCode": "string",
"dispDoc": "string",
"setOfInterestRates": "string",
"stockRetailValue": "string",
"parity": "string",
"parityPost": "string",
"suppParity": "string",
"suppParityPost": "string",
"fieldSa": "string",
"fieldSb": "string",
"fieldSc": "string",
"fieldSd": "string",
"fieldSe": "string",
"fieldSf": "string",
"fieldSg": "string",
"fieldSh": "string",
"fieldSi": "string",
"fieldSj": "string",
"fieldNa": 0,
"fieldNb": 0,
"fieldNc": 0,
"fieldNd": 0,
"fieldNe": 0,
"fieldNf": 0,
"fieldNg": 0,
"fieldNh": 0,
"fieldNi": 0,
"fieldNj": 0,
"fieldDa": "2022-04-21T07:57:46.928Z",
"fieldDb": "2022-04-21T07:57:46.928Z",
"fieldDc": "2022-04-21T07:57:46.928Z",
"fieldDd": "2022-04-21T07:57:46.928Z",
"skis": "string",
"xmldocType": "string",
"xmldocCript": "string",
"xmldocSign": "string",
"createPayOrd": "string",
"xmlglnno": "string",
"intrstsBuyer": "string",
"intrstsSupplier": "string",
"rsbainDistrikt": "string",
"httppath": "string",
"ibanprefix": "string",
"suprDept": "string",
"subjVar1": 0,
"subjVar2": 0,
"subjVar3": 0,
"subjVar4": 0,
"subjVar5": 0,
"subjVar6": 0,
"subjVar7": 0,
"subjVar8": 0,
"subjVar9": 0,
"subjVar10": 0,
"latitude": 0,
"longitude": 0,
"maxRebate": 0,
"perInv": "string",
"suppPerInv": "string",
"active": "string",
"activeContacts": "string",
"deptRegNo": "string",
"payLoc": "string",
"buyerLimitCtrl": "string",
"timeIns": "2022-04-21T07:57:46.928Z",
"userIns": 0,
"timeChg": "2022-04-21T07:57:46.928Z",
"userChg": 0,
"subUnitCode": "string",
"jibcode": "string",
"note": "string",
"pin": "string",
"deptMuni": "string",
"contactPrsnB": 0,
"contactPrsnS": 0,
"subUnitRegNo": "string",
"subUnitTaxCode": "string",
"workingHours": 0,
"workingDaysInWeek": 0,
"budgetUser": "string",
"exciseNumber": "string",
"instalmentNo": 0,
"suppInstalmentNo": 0,
"branch": "string",
"branchForm": "string",
"orgColor": 0,
"loyaltyPrefix": "string",
"dontSendReminders": "string",
"gln": "string",
"municipCreditor": "string",
"bankCode": "string",
"qid": 0,
"retail": "string",
"fiscalNo": "string",
"payerS": "string",
"acctClaim": "string",
"acctOblig": "string",
"eSlogVer": "string",
"pincodePrefix": "string",
"acctGlopen": "string",
"noExciseCalc": "string",
"rsbainDistriktBuyer": "string",
"vatpayRealSupp": "string",
"warehouseCapacity": 0,
"warehouseCapacityUm": "string",
"acctExpense": "string",
"acctIncome": "string",
"permitLumpCompen": "string",
"remindersSendType": "string",
"pac": "string",
"eslogContractCt": "string",
"skis2": "string",
"allowedInvShort": 0,
"acctRebateExtra": "string",
"veterinarian": "string",
"anafcheckDate": "2022-04-21T07:57:46.928Z",
"parityType": "string",
"suppParityType": "string",
"naturalPerson": "string",
"minMargin": 0,
"ncc": "string",
"buyerCalcInvoOutFallDue": "string",
"assortment": "string",
"orgUnit": "string",
"accountingPeriod": "string",
"orderValidBuyer": 0,
"orderValidSupplier": 0,
"lei": "string",
"freeStockReport": "string",
"webShopSubject": "string",
"deliveryPriority": 0,
"deliveryDays": 0,
"priceRatePos": true
}
4. PUT/API/Subject/
This API enables you to update single subject data in the THE_SetISubj master table in the specified structure.
{
"subject": "string",
"buyer": "string",
"supplier": "string",
"bank": "string",
"municipality": "string",
"locComm": "string",
"warehouse": "string",
"worker": "string",
"user": "string",
"dept": "string",
"school": "string",
"institution": "string",
"name2": "string",
"address": "string",
"name3": "string",
"post": "string",
"country": "string",
"km": 0,
"vatcodePrefix": "string",
"code": "string",
"region": "string",
"suprCommune": "string",
"phone": "string",
"fax": "string",
"subUnit": "string",
"priceRate": "string",
"daysForPayment": 0,
"yearStatement": "string",
"dateState": "2022-04-21T07:58:17.838Z",
"statement": "string",
"limit": 0,
"dateLimit": "2022-04-21T07:58:17.838Z",
"maxDaysPayDelay": 0,
"subjTypeSupp": "string",
"subjTypeBuyer": "string",
"stockManage": "string",
"stockValue": "string",
"stockInMinus": "string",
"dateInvent": "2022-04-21T07:58:17.838Z",
"clerk": 0,
"rebate": 0,
"wayOfSale": "string",
"currency": "string",
"priceCalcMethod": "string",
"payMethod": "string",
"delivery": "string",
"regNo": "string",
"acPayer": "string",
"activityCode": "string",
"separSaleCalc": "string",
"suppPriceCalcMet": "string",
"suppDiscount": 0,
"suppSaleMet": "string",
"suppYearStatement": "string",
"suppDateSta": "2022-04-21T07:58:17.838Z",
"suppPayDays": 0,
"suppPayMet": "string",
"suppStatement": "string",
"suppLimit": 0,
"suppDateLim": "2022-04-21T07:58:17.838Z",
"suppDelivery": "string",
"suppCurr": "string",
"suppClerk": 0,
"payOrdPriorty": "string",
"swiftcode": "string",
"atwarehouse": "string",
"municipCode": "string",
"dispDoc": "string",
"setOfInterestRates": "string",
"stockRetailValue": "string",
"parity": "string",
"parityPost": "string",
"suppParity": "string",
"suppParityPost": "string",
"fieldSa": "string",
"fieldSb": "string",
"fieldSc": "string",
"fieldSd": "string",
"fieldSe": "string",
"fieldSf": "string",
"fieldSg": "string",
"fieldSh": "string",
"fieldSi": "string",
"fieldSj": "string",
"fieldNa": 0,
"fieldNb": 0,
"fieldNc": 0,
"fieldNd": 0,
"fieldNe": 0,
"fieldNf": 0,
"fieldNg": 0,
"fieldNh": 0,
"fieldNi": 0,
"fieldNj": 0,
"fieldDa": "2022-04-21T07:58:17.838Z",
"fieldDb": "2022-04-21T07:58:17.838Z",
"fieldDc": "2022-04-21T07:58:17.838Z",
"fieldDd": "2022-04-21T07:58:17.838Z",
"skis": "string",
"xmldocType": "string",
"xmldocCript": "string",
"xmldocSign": "string",
"createPayOrd": "string",
"xmlglnno": "string",
"intrstsBuyer": "string",
"intrstsSupplier": "string",
"rsbainDistrikt": "string",
"httppath": "string",
"ibanprefix": "string",
"suprDept": "string",
"subjVar1": 0,
"subjVar2": 0,
"subjVar3": 0,
"subjVar4": 0,
"subjVar5": 0,
"subjVar6": 0,
"subjVar7": 0,
"subjVar8": 0,
"subjVar9": 0,
"subjVar10": 0,
"latitude": 0,
"longitude": 0,
"maxRebate": 0,
"perInv": "string",
"suppPerInv": "string",
"active": "string",
"activeContacts": "string",
"deptRegNo": "string",
"payLoc": "string",
"buyerLimitCtrl": "string",
"timeIns": "2022-04-21T07:58:17.838Z",
"userIns": 0,
"timeChg": "2022-04-21T07:58:17.838Z",
"userChg": 0,
"subUnitCode": "string",
"jibcode": "string",
"note": "string",
"pin": "string",
"deptMuni": "string",
"contactPrsnB": 0,
"contactPrsnS": 0,
"subUnitRegNo": "string",
"subUnitTaxCode": "string",
"workingHours": 0,
"workingDaysInWeek": 0,
"budgetUser": "string",
"exciseNumber": "string",
"instalmentNo": 0,
"suppInstalmentNo": 0,
"branch": "string",
"branchForm": "string",
"orgColor": 0,
"loyaltyPrefix": "string",
"dontSendReminders": "string",
"gln": "string",
"municipCreditor": "string",
"bankCode": "string",
"qid": 0,
"retail": "string",
"fiscalNo": "string",
"payerS": "string",
"acctClaim": "string",
"acctOblig": "string",
"eSlogVer": "string",
"pincodePrefix": "string",
"acctGlopen": "string",
"noExciseCalc": "string",
"rsbainDistriktBuyer": "string",
"vatpayRealSupp": "string",
"warehouseCapacity": 0,
"warehouseCapacityUm": "string",
"acctExpense": "string",
"acctIncome": "string",
"permitLumpCompen": "string",
"remindersSendType": "string",
"pac": "string",
"eslogContractCt": "string",
"skis2": "string",
"allowedInvShort": 0,
"acctRebateExtra": "string",
"veterinarian": "string",
"anafcheckDate": "2022-04-21T07:58:17.838Z",
"parityType": "string",
"suppParityType": "string",
"naturalPerson": "string",
"minMargin": 0,
"ncc": "string",
"buyerCalcInvoOutFallDue": "string",
"assortment": "string",
"orgUnit": "string",
"accountingPeriod": "string",
"orderValidBuyer": 0,
"orderValidSupplier": 0,
"lei": "string",
"freeStockReport": "string",
"webShopSubject": "string",
"deliveryPriority": 0,
"deliveryDays": 0,
"priceRatePos": true
}