İrsaliye Listeleme
RahatSistem Demo
https://apidemo.rahatsistem.com.tr
RahatSistem Demo
https://apidemo.rahatsistem.com.tr
POST
/v2/documents/despatch.list
Açıklama#
TIP
sortBy bilgisi issue_date olarak gönderilirse, belirtilen başlangıç ve bitiş tarihleri, irsaliye tarihi üzerinden filtrelenerek yanıt dönülür. Eğer received_at olarak gönderilse, irsaliyeler zarf tarihlerine göre filtrelenerek yanıt dönülür.Request
Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************Body Params application/json
Example
{
"query": {
"direction": "in",
"startDate": "string",
"endDate": "string",
"sortBy": "issue_date",
"sortDefs": [
{
"field": "issue_date",
"direction": "asc"
}
],
"search": "string",
"pageSize": 10,
"page": 1,
"statusCodes": [
2012
],
"replyStatusCodes": [
2004
],
"includeErp": true,
"printed": true,
"readMarked": true
}
}Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://apidemo.rahatsistem.com.tr/v2/documents/despatch.list' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
"query": {
"direction": "in",
"startDate": "string",
"endDate": "string",
"sortBy": "issue_date",
"sortDefs": [
{
"field": "issue_date",
"direction": "asc"
}
],
"search": "string",
"pageSize": 10,
"page": 1,
"statusCodes": [
2012
],
"replyStatusCodes": [
2004
],
"includeErp": true,
"printed": true,
"readMarked": true
}
}'Responses
🟢200OK
application/json
Body
Example
{
"data": {
"pagination": {
"count": 0,
"count_unfiltered": 0,
"page_size": 0,
"page_index": 0
},
"items": [
{
"integrator": "string",
"uuid": "string",
"id": "string",
"profile_id": "string",
"type_code": "string",
"issue_date": "string",
"issue_time": "string",
"currency": "string",
"note": "string",
"notes": [
"string"
],
"sender": {
"name": "string",
"vkn_tckn": "string",
"city": "string",
"city_subdivision": "string",
"tax_office": "string",
"email": "string"
},
"receiver": {
"name": "string",
"vkn_tckn": "string",
"city": "string",
"city_subdivision": "string",
"email": "string"
},
"received_at": "string",
"is_archived": true,
"is_printed": true,
"status": {
"summary": "string",
"status_code": 0,
"status": "string",
"gib_status_code": 0,
"message": "string",
"progress": {
"step": 0,
"step_count": 0,
"percentage": 0
}
},
"short_id": "string",
"app_name": null,
"lines": [
{
"id": "string",
"name": "string",
"quantity": 0,
"quantity_unit": "string",
"price": 0,
"price_currency": "string",
"extension_amount": 0,
"extension_amount_currency": "string"
}
]
}
]
}
}🟠400Bad Request
Modified at 2024-05-03 14:14:52