- [Kurulum](#kurulum) - [Giriş](#giriş) - [Özellikler](#özellikler) - [Kullanım Örnekleri](#kullanım-örnekleri) - [Dokümantasyon](#dokümantasyon) - [Kimlik Doğrulama](#kimlik-doğrulama) - [Modüller](#modüller) - [Accounts](#accounts) - [Bank F
npm install parasut-api-v4- Kurulum
- Giriş
- Özellikler
- Kullanım Örnekleri
- Dokümantasyon
- Kimlik Doğrulama
- Modüller
- Accounts
- Bank Fees
- Categories
- Contacts
- E-Archives
- E-Invoice
- E-Invoice In Boxes
- E-SMMS
- Employees
- Inventory Levels
- Products
- Purchase Bills
- Salaries
- Sales Invoices
- Sales Offers
- Shipment Documents
- Stock Movements
- Stock Updates
- Tags
- Taxes
- Trackable Jobs
- Transactions
- Warehouses
- Webhooks
- Hatalar ve İstekler
- Destek Olmak İsteyenler
```
npm i parasut-api-v4
Bu npm modülün amacı https://apidocs.parasut.com/ da belirtilen api için bir sdk görevi görmektir. Resmi bir yayın değildir.
1. Obje şeması üzerinden istekleri gönderebilme ör: parasutApiV4.accounts.index({ queryParams, data, pagination })refreshToken
2. Request ve Response tiplerinin tanımlanması (kısmen mevcut)
3. Authorization yönetimi otomatik yapılıyor. Token süresi dolduğunda isteği yapılmakta ve istek kaldığı yerden devam etmektedir.
`ts
import ParasutApiV4 from 'parasut-api-v4'
const run = async () => {
const parasutApiV4 = new ParasutApiV4({
firmaNo: '101010',
email: 'örnek_email@gmail.com',
password: '11111111111',
clientId: '11111111111',
clientSecret: '11111111111',
})
const meResult = await parasutApiV4.me()
console.log(meResult.data)
}
run()
`
`ts
import ParasutApiV4 from 'parasut-api-v4'
const run = async () => {
const parasutApiV4 = new ParasutApiV4({
firmaNo: '101010',
email: 'örnek_email@gmail.com',
password: '11111111111',
clientId: '11111111111',
clientSecret: '11111111111',
})
const queryParams = { // obje şeklinde tanımlanır
sort: '-balance',
}
const pagination = { // obje şeklinde tanımlanır
limit: 1,
size: 15,
}
const accountIndexResult = await parasutApiV4.accounts.index({ queryParams, pagination })
console.log(accountIndexResult.data)
}
run()
`
Paket, OAuth2 tabanlı kimlik doğrulama kullanır. Token süresi dolduğunda otomatik olarak refreshToken isteği yapılır ve istek kaldığı yerden devam eder.
#### Accounts
Hesap yönetimi için kullanılan modül.
Metodlar:
- index({ queryParams, pagination }) - Hesap listesini getirircreate({ data, queryParams })
- - Yeni hesap oluştururshow(id, { queryParams })
- - Belirli bir hesabı getiriredit(id, { data, queryParams })
- - Hesabı güncellerdelete(id, { queryParams })
- - Hesabı silertransactions(id, { queryParams })
- - Hesabın işlemlerini getirirdebitTransactions(id, { data, queryParams })
- - Hesaba borç işlemi eklercreditTransactions(id, { data, queryParams })
- - Hesaba alacak işlemi ekler
#### Bank Fees
Banka masrafları yönetimi için kullanılan modül.
Metodlar:
- create({ data, queryParams }) - Yeni banka masrafı oluştururshow(id, { queryParams })
- - Belirli bir banka masrafını getiriredit(id, { data, queryParams })
- - Banka masrafını güncellerdelete(id, { queryParams })
- - Banka masrafını silerarchive(id, { queryParams })
- - Banka masrafını arşivlerunarchive(id, { queryParams })
- - Banka masrafını arşivden çıkarırpay(id, { queryParams })
- - Banka masrafını öder
#### Categories
Kategori yönetimi için kullanılan modül.
Metodlar:
- index({ queryParams, pagination }) - Kategori listesini getirircreate({ data, queryParams })
- - Yeni kategori oluştururshow(id, { queryParams })
- - Belirli bir kategoriyi getiriredit(id, { data, queryParams })
- - Kategoriyi güncellerdelete(id, { queryParams })
- - Kategoriyi siler
#### Contacts
Kişi/şirket yönetimi için kullanılan modül.
Metodlar:
- index({ queryParams, pagination }) - Kişi/şirket listesini getirircreate({ data, queryParams })
- - Yeni kişi/şirket oluştururshow(id, { queryParams })
- - Belirli bir kişi/şirketi getiriredit(id, { data, queryParams })
- - Kişi/şirketi güncellerdelete(id, { queryParams })
- - Kişi/şirketi silercontactDebitTransactions(id, { data, queryParams })
- - Kişi/şirkete borç işlemi eklercontactCreditTransactions(id, { data, queryParams })
- - Kişi/şirkete alacak işlemi ekler
#### E-Archives
E-Arşiv yönetimi için kullanılan modül.
Metodlar:
- create({ data, queryParams }) - Yeni e-arşiv oluştururshow(id, { queryParams })
- - Belirli bir e-arşivi getirirshowPdf(id, { queryParams })
- - E-arşivin PDF'ini getirir
#### E-Invoice
E-Fatura yönetimi için kullanılan modül.
Metodlar:
- create({ data, queryParams }) - Yeni e-fatura oluştururshow(id, { queryParams })
- - Belirli bir e-faturayı getirirshowPdf(id, { queryParams })
- - E-faturanın PDF'ini getirir
#### E-Invoice In Boxes
E-Fatura gelen kutusu yönetimi için kullanılan modül.
Metodlar:
- index({ queryParams, pagination }) - E-fatura gelen kutusu listesini getirir
#### E-SMMS
E-SMM yönetimi için kullanılan modül.
Metodlar:
- create({ data, queryParams }) - Yeni e-SMM oluştururshow(id, { queryParams })
- - Belirli bir e-SMM'i getirirshowPdf(id, { queryParams })
- - E-SMM'in PDF'ini getirir
#### Employees
Çalışan yönetimi için kullanılan modül.
Metodlar:
- index({ queryParams, pagination }) - Çalışan listesini getirircreate({ data, queryParams })
- - Yeni çalışan oluştururshow(id, { queryParams })
- - Belirli bir çalışanı getiriredit(id, { data, queryParams })
- - Çalışanı güncellerdelete(id, { queryParams })
- - Çalışanı silerarchive(id, { queryParams })
- - Çalışanı arşivlerunarchive(id, { queryParams })
- - Çalışanı arşivden çıkarır
#### Inventory Levels
Stok seviyeleri yönetimi için kullanılan modül.
Metodlar:
- index({ queryParams, pagination }) - Stok seviyeleri listesini getirir
#### Products
Ürün yönetimi için kullanılan modül.
Metodlar:
- index({ queryParams, pagination }) - Ürün listesini getirircreate({ data, queryParams })
- - Yeni ürün oluştururshow(id, { queryParams })
- - Belirli bir ürünü getiriredit(id, { data, queryParams })
- - Ürünü güncellerdelete(id, { queryParams })
- - Ürünü siler
#### Purchase Bills
Alış faturası yönetimi için kullanılan modül.
Metodlar:
- index({ queryParams, pagination }) - Alış faturası listesini getirircreateBasicPurchaseBill({ data, queryParams })
- - Basit alış faturası oluştururcreateDetailedPurchaseBill({ data, queryParams })
- - Detaylı alış faturası oluştururshow(id, { queryParams })
- - Belirli bir alış faturasını getirirdelete(id, { queryParams })
- - Alış faturasını silereditBasicPurchaseBill(id, { data, queryParams })
- - Basit alış faturasını güncellereditDetailedPurchaseBill(id, { data, queryParams })
- - Detaylı alış faturasını güncellerpay(id, { data, queryParams })
- - Alış faturasını ödercancel(id, { queryParams })
- - Alış faturasını iptal ederrecover(id, { queryParams })
- - Alış faturasını geri getirirarchive(id, { queryParams })
- - Alış faturasını arşivlerunarchive(id, { queryParams })
- - Alış faturasını arşivden çıkarır
#### Salaries
Maaş yönetimi için kullanılan modül.
Metodlar:
- index({ queryParams, pagination }) - Maaş listesini getirircreate({ data, queryParams })
- - Yeni maaş kaydı oluştururshow(id, { queryParams })
- - Belirli bir maaş kaydını getiriredit(id, { data, queryParams })
- - Maaş kaydını güncellerdelete(id, { queryParams })
- - Maaş kaydını silerarchive(id, { queryParams })
- - Maaş kaydını arşivlerunarchive(id, { queryParams })
- - Maaş kaydını arşivden çıkarırpay(id, { queryParams })
- - Maaşı öder
#### Sales Invoices
Satış faturası yönetimi için kullanılan modül.
Metodlar:
- index({ queryParams, pagination }) - Satış faturası listesini getirircreate({ data, queryParams })
- - Yeni satış faturası oluştururshow(id, { queryParams })
- - Belirli bir satış faturasını getiriredit(id, { data, queryParams })
- - Satış faturasını güncellerdelete(id, { queryParams })
- - Satış faturasını silerpay(id, { data, queryParams })
- - Satış faturasını ödercancel(id, { queryParams })
- - Satış faturasını iptal ederrecover(id, { queryParams })
- - Satış faturasını geri getirirarchive(id, { queryParams })
- - Satış faturasını arşivlerunarchive(id, { queryParams })
- - Satış faturasını arşivden çıkarırconvertToInvoice(id, { queryParams })
- - Satış faturasını faturalaştırırshowPdf(id, { queryParams })
- - Satış faturasının PDF'ini getirir
#### Sales Offers
Satış teklifi yönetimi için kullanılan modül.
Metodlar:
- index({ queryParams, pagination }) - Satış teklifi listesini getirircreate({ data, queryParams })
- - Yeni satış teklifi oluştururshow(id, { queryParams })
- - Belirli bir satış teklifini getiriredit(id, { data, queryParams })
- - Satış teklifini güncellerdelete(id, { queryParams })
- - Satış teklifini silershowPdf(id, { queryParams })
- - Satış teklifinin PDF'ini getirirarchive(id, { queryParams })
- - Satış teklifini arşivlerunarchive(id, { queryParams })
- - Satış teklifini arşivden çıkarırdetails(id, { queryParams })
- - Satış teklifinin detaylarını getirirupdateStatus(id, { data, queryParams })
- - Satış teklifinin durumunu güncellersendEmail(id, { data, queryParams })
- - Satış teklifini e-posta ile gönderir
#### Shipment Documents
Sevk irsaliyesi yönetimi için kullanılan modül.
Metodlar:
- index({ queryParams, pagination }) - Sevk irsaliyesi listesini getirircreate({ data, queryParams })
- - Yeni sevk irsaliyesi oluştururshow(id, { queryParams })
- - Belirli bir sevk irsaliyesini getiriredit(id, { data, queryParams })
- - Sevk irsaliyesini güncellerdelete(id, { queryParams })
- - Sevk irsaliyesini siler
#### Stock Movements
Stok hareketleri yönetimi için kullanılan modül.
Metodlar:
- index({ queryParams, pagination }) - Stok hareketleri listesini getirir
#### Stock Updates
Stok güncellemeleri yönetimi için kullanılan modül.
Metodlar:
- create({ data, queryParams }) - Yeni stok güncellemesi oluşturur
#### Tags
Etiket yönetimi için kullanılan modül.
Metodlar:
- index({ queryParams, pagination }) - Etiket listesini getirircreate({ data, queryParams })
- - Yeni etiket oluştururshow(id, { queryParams })
- - Belirli bir etiketi getiriredit(id, { data, queryParams })
- - Etiketi güncellerdelete(id, { queryParams })
- - Etiketi siler
#### Taxes
Vergi yönetimi için kullanılan modül.
Metodlar:
- index({ queryParams, pagination }) - Vergi listesini getirircreate({ data, queryParams })
- - Yeni vergi oluştururshow(id, { queryParams })
- - Belirli bir vergiyi getiriredit(id, { data, queryParams })
- - Vergiyi güncellerdelete(id, { queryParams })
- - Vergiyi silerarchive(id, { queryParams })
- - Vergiyi arşivlerunarchive(id, { queryParams })
- - Vergiyi arşivden çıkarırpay(id, { queryParams })
- - Vergiyi öder
#### Trackable Jobs
Takip edilebilir işler yönetimi için kullanılan modül.
Metodlar:
- show(id, { queryParams }) - Belirli bir takip edilebilir işi getirir
#### Transactions
İşlem yönetimi için kullanılan modül.
Metodlar:
- show(id, { queryParams }) - Belirli bir işlemi getirirdelete(id, { queryParams })
- - İşlemi siler
#### Warehouses
Depo yönetimi için kullanılan modül.
Metodlar:
- index({ queryParams, pagination }) - Depo listesini getirircreate({ data, queryParams })
- - Yeni depo oluştururshow(id, { queryParams })
- - Belirli bir depoyu getiriredit(id, { data, queryParams })
- - Depoyu güncellerdelete(id, { queryParams })
- - Depoyu siler
#### Webhooks
Webhook yönetimi için kullanılan modül.
Metodlar:
- index({ queryParams, pagination }) - Webhook listesini getirircreate({ data, queryParams })
- - Yeni webhook oluştururshow(id, { queryParams })
- - Belirli bir webhook'u getiriredit(id, { data, queryParams })
- - Webhook'u güncellerdelete(id, { queryParams })` - Webhook'u siler
-
Kullanım sırasında yaşadığınız sorunları veya isteklerinizi https://github.com/Sergeant61/parasut-api-v4/issues iş kaydı açabilir veya https://recepozen.com 'dan bildirebilirsiniz.
Mevcut kod yapısına uygun her türlü pr tarafımca kabul edilecektir.