GetSupplierDeposits
Endpoint
Overview
The "GetSupplierDeposits" endpoint is a GET request. It is used to get the deposit records of a certain vendor or supplier. Detailed functionality of how to use this endpoint is explained in the Multiple Suppliers section.
The endpoint on Swagger is Supplier_GetSupplierDeposits.
Now, we are going to declare the endpoint and its models along with each accepted parameter and possible value.
Request Header
Add "Authorization": "Bearer {Token}" to request header. Token of demo configuration can be found here.
Request Model
The request is a GET request with the following parameters:
Input Parameter | Type | Description |
---|---|---|
SupplierCode | integer | |
search | string, optional | |
start | integer, optional | |
length | integer, optional | |
sortColumn | string, optional | |
sortDirection | string, optional |
Response Model
Response Field | Type | Description |
---|---|---|
Records | ||
Data |
Sample Message
/v2/GetSupplierDeposits?SupplierCode=69
{
"Records": 1,
"Data": [
{
"Iban": "AL35202111090000000001234567",
"DepositId": 183,
"VendorId": 123,
"DepositReference": "2022000183",
"BankName": "NBK",
"TotalValue": 542.575,
"DepositDate": "16/10/02022"
}
]
}
Updated about 2 months ago