İçeriğe geç
Store API

CurrentAccount

Serverhttps://magaza-adiniz.myideasoft.com

CurrentAccount LIST

GET
https://magaza-adiniz.myideasoft.com
/api/current_accounts
Bearer

Bu endpoint, mevcut (current) hesap kayıtlarını listelemek veya belirli kriterlere göre filtrelemek için kullanılır. Listeleme işlemi, sayfalama (limit, page), sıralama (sort), ID bazlı filtreleme (id, ids, sinceId) ve arama (q, s) parametreleriyle özelleştirilebilir.

CurrentAccount LIST › query Parameters

sort
​string

Sıralama parametresi. - Artan sıralama için: sort=id - Azalan sıralama için: sort=-id Birden fazla alanla sıralama yapmak için virgülle ayırabilirsiniz. Örnek: sort=-createdAt,name

limit
​integer · min: 1 · max: 100

Sayfa başına döndürülecek maksimum Current Account sayısı. Varsayılan: 20 Örnek: limit=50

Default: 20
page
​integer · min: 1

Listelenecek sayfa numarası. Varsayılan: 1 Örnek: page=2

Default: 1
sinceId
​integer · min: 1

Belirtilen ID değerinden sonraki kayıtları getirir. Özellikle sonsuz kaydırma (infinite scroll) gibi senaryolarda kullanılır. Örnek: sinceId=100

ids
​string

Birden fazla Current Account kaydını aynı anda listelemek için virgülle ayrılmış ID değerleri. Örnek: ids=1,2,3,4

code
​string

CurrentAccount Code.

title
​string

CurrentAccount Title.

startDate
​string · date-time · pattern: yyyy-mm-dd hh:mm:ss

Start of the time frame

endDate
​string · date-time · pattern: yyyy-mm-dd hh:mm:ss

End of the time frame

startUpdatedAt
​string · date-time · pattern: yyyy-mm-dd hh:mm:ss

Start of the time frame

endUpdatedAt
​string · date-time · pattern: yyyy-mm-dd hh:mm:ss

End of the time frame

member
​integer · min: 1

İlgili member (üye) kimliğine göre filtreleme yapar. Örnek: member=25

CurrentAccount LIST › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

title
​string · maxLength: 255 · required

Cari hesap başlığı.

Example: Cari Hesap Başlığı
​MemberSummary · required

Üye hesap bilgilerini içeren obje

id
​integer

Cari hesap nesnesi kimlik değeri.

Example: 123
code
​string · maxLength: 255

Cari hesap için düzenlenebilir kod değeri.

Example: cari-hesap-kod-ornegi
balance
​number · float

Cari hesap bakiyesi.

Example: 155.5
riskLimit
​number · float · min: 0

Cari hesap için risk limiti.

Example: 155.5
createdAt
​string · date-time

Cari hesap nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Cari hesap nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300

CurrentAccount POST

POST
https://magaza-adiniz.myideasoft.com
/api/current_accounts
Bearer

CurrentAccount POST › Request Body

title
​string · maxLength: 255 · required

Cari hesap başlığı.

Example: Cari Hesap Başlığı
​MemberSummary · required

Üye hesap bilgilerini içeren obje

id
​integer

Cari hesap nesnesi kimlik değeri.

Example: 123
code
​string · maxLength: 255

Cari hesap için düzenlenebilir kod değeri.

Example: cari-hesap-kod-ornegi
balance
​number · float

Cari hesap bakiyesi.

Example: 155.5
riskLimit
​number · float · min: 0

Cari hesap için risk limiti.

Example: 155.5
createdAt
​string · date-time

Cari hesap nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Cari hesap nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300

CurrentAccount POST › Responses

Oluşturma işlemi (POST) başarı ile sonuçlandı.

title
​string · maxLength: 255 · required

Cari hesap başlığı.

Example: Cari Hesap Başlığı
​MemberSummary · required

Üye hesap bilgilerini içeren obje

id
​integer

Cari hesap nesnesi kimlik değeri.

Example: 123
code
​string · maxLength: 255

Cari hesap için düzenlenebilir kod değeri.

Example: cari-hesap-kod-ornegi
balance
​number · float

Cari hesap bakiyesi.

Example: 155.5
riskLimit
​number · float · min: 0

Cari hesap için risk limiti.

Example: 155.5
createdAt
​string · date-time

Cari hesap nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Cari hesap nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300

CurrentAccount GET

GET
https://magaza-adiniz.myideasoft.com
/api/current_accounts/{id}
Bearer

CurrentAccount GET › path Parameters

id
​string · pattern: \d+ · required

CurrentAccount GET › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

title
​string · maxLength: 255 · required

Cari hesap başlığı.

Example: Cari Hesap Başlığı
​MemberSummary · required

Üye hesap bilgilerini içeren obje

id
​integer

Cari hesap nesnesi kimlik değeri.

Example: 123
code
​string · maxLength: 255

Cari hesap için düzenlenebilir kod değeri.

Example: cari-hesap-kod-ornegi
balance
​number · float

Cari hesap bakiyesi.

Example: 155.5
riskLimit
​number · float · min: 0

Cari hesap için risk limiti.

Example: 155.5
createdAt
​string · date-time

Cari hesap nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Cari hesap nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300

CurrentAccount PUT

PUT
https://magaza-adiniz.myideasoft.com
/api/current_accounts/{id}
Bearer

CurrentAccount PUT › path Parameters

id
​string · pattern: \d+ · required

CurrentAccount PUT › Request Body

title
​string · maxLength: 255 · required

Cari hesap başlığı.

Example: Cari Hesap Başlığı
​MemberSummary · required

Üye hesap bilgilerini içeren obje

id
​integer

Cari hesap nesnesi kimlik değeri.

Example: 123
code
​string · maxLength: 255

Cari hesap için düzenlenebilir kod değeri.

Example: cari-hesap-kod-ornegi
balance
​number · float

Cari hesap bakiyesi.

Example: 155.5
riskLimit
​number · float · min: 0

Cari hesap için risk limiti.

Example: 155.5
createdAt
​string · date-time

Cari hesap nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Cari hesap nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300

CurrentAccount PUT › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

title
​string · maxLength: 255 · required

Cari hesap başlığı.

Example: Cari Hesap Başlığı
​MemberSummary · required

Üye hesap bilgilerini içeren obje

id
​integer

Cari hesap nesnesi kimlik değeri.

Example: 123
code
​string · maxLength: 255

Cari hesap için düzenlenebilir kod değeri.

Example: cari-hesap-kod-ornegi
balance
​number · float

Cari hesap bakiyesi.

Example: 155.5
riskLimit
​number · float · min: 0

Cari hesap için risk limiti.

Example: 155.5
createdAt
​string · date-time

Cari hesap nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Cari hesap nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300

CurrentAccount DELETE

DELETE
https://magaza-adiniz.myideasoft.com
/api/current_accounts/{id}
Bearer

CurrentAccount DELETE › path Parameters

id
​string · pattern: \d+ · required

CurrentAccount DELETE › Responses

Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)

No data returned