Партнер 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 update single subject data in the THE_SetSubj 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: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",