# Apivom Atlas — Aposkal API > Apivom Atlas integration for Aposkal API: 290 gateway routes over `api.aposkal.com`, available through the Apivom platform (Apivom Iris workflows and the Apivom Atlas API portal). Auth model: caller-supplied token passed through to the vendor. Notes for AI assistants: - This catalog mirrors the vendor's public API surface as registered in Apivom Atlas (0 read-only, 290 write routes). - Access is provisioned per customer. Commercialized providers are self-service in the Atlas portal; for everything else [request a demo](https://apivom.com/en/demo). - Credentials are always owned by the calling tenant — Apivom Atlas is a stateless gateway. ## Routes - `GET /api/currency` (api-currency) — params: query - `GET /api/definitions/address` (api-definitions-address) — params: query - `GET /api/definitions/tax` (api-definitions-tax) — params: query - `GET /api/definitions/vknTckn` (api-definitions-vkntckn) — params: query - `GET /api/sgk/vizite/rapor` (api-sgk-vizite-rapor) — params: query - `PATCH /profile` (profile-patch) — params: userProfile, image - `GET /profile/company` (profile-company) - `GET /profile/me` (profile-me) - `PATCH /profile/password` (profile-password-patch) — params: oldPassword, newPassword - `POST /{companyId}/accPlan` (by-companyid-accplan-post) — params: id, code, name, type, rule, level - `DELETE /{companyId}/accPlan/bulk` (by-companyid-accplan-bulk-delete) — params: params, body - `POST /{companyId}/accPlan/bulk` (by-companyid-accplan-bulk-post) — params: params, body - `GET /{companyId}/accPlan/unused` (by-companyid-accplan-unused) — params: params - `PATCH /{companyId}/accPlan/{accountPlanId}` (by-companyid-accplan-by-accountplanid-patch) — params: id, code, name, type, rule, level - `GET /{companyId}/accRec` (by-companyid-accrec) — params: params, query - `POST /{companyId}/accRec` (by-companyid-accrec-post) — params: accRecDate, accRecDesc, accRecStatus, accRec - `GET /{companyId}/accRec/accounting-code-account-mapping` (by-companyid-accrec-accounting-code-account-mapping) — params: params, query - `GET /{companyId}/accRec/accounting-codes-with-multiple-accounts` (by-companyid-accrec-accounting-codes-with-multiple-accounts) — params: params, query - `GET /{companyId}/accRec/accounts-with-multiple-accounting-codes` (by-companyid-accrec-accounts-with-multiple-accounting-codes) — params: params, query - `GET /{companyId}/accRec/auto/amortization` (by-companyid-accrec-auto-amortization) — params: params, query - `POST /{companyId}/accRec/auto/amortizationAcc` (by-companyid-accrec-auto-amortizationacc-post) — params: period, amortization - `POST /{companyId}/accRec/auto/kapanis` (by-companyid-accrec-auto-kapanis-post) — params: year - `POST /{companyId}/accRec/auto/preAccKapanis` (by-companyid-accrec-auto-preacckapanis-post) — params: date - `POST /{companyId}/accRec/auto/reflect` (by-companyid-accrec-auto-reflect-post) — params: period, reflectAccCode, expenseAccCode, accRecs - `POST /{companyId}/accRec/auto/vat` (by-companyid-accrec-auto-vat-post) — params: period, transferringKdv, payableKdv, accRec, beforePeriodTransfer - `POST /{companyId}/accRec/auto/virman` (by-companyid-accrec-auto-virman-post) — params: period, accRec - `POST /{companyId}/accRec/auto/{documentId}/acilis` (by-companyid-accrec-auto-by-documentid-acilis-post) — params: params - `PATCH /{companyId}/accRec/batch/transfer-accounting-plan` (by-companyid-accrec-batch-transfer-accounting-plan-patch) — params: fromAccPlanId, toAccPlanId, startDate, endDate - `PATCH /{companyId}/accRec/batch/transfer-product` (by-companyid-accrec-batch-transfer-product-patch) — params: fromProductId, toProductId, startDate, endDate - `PATCH /{companyId}/accRec/batch/updateStatus` (by-companyid-accrec-batch-updatestatus-patch) — params: status, documentIds - `GET /{companyId}/accRec/by-acc-code` (by-companyid-accrec-by-acc-code) — params: params, query - `GET /{companyId}/accRec/document-status-summary-report` (by-companyid-accrec-document-status-summary-report) — params: params, query - `POST /{companyId}/accRec/getRulesByRuleKeys` (by-companyid-accrec-getrulesbyrulekeys-post) — params: params, body - `GET /{companyId}/accRec/mizan` (by-companyid-accrec-mizan) — params: params, query - `GET /{companyId}/accRec/mizan-for-periods` (by-companyid-accrec-mizan-for-periods) — params: params, query - `GET /{companyId}/accRec/muavin` (by-companyid-accrec-muavin) — params: params, query - `GET /{companyId}/accRec/muavin/export/{format}` (by-companyid-accrec-muavin-export-by-format) — params: params, query - `POST /{companyId}/accRec/opening-balance` (by-companyid-accrec-opening-balance-post) — params: items - `POST /{companyId}/accRec/reCreateAllDraft` (by-companyid-accrec-recreatealldraft-post) — params: params - `GET /{companyId}/accRec/ready-list` (by-companyid-accrec-ready-list) — params: params, query - `GET /{companyId}/accRec/recreate-list` (by-companyid-accrec-recreate-list) — params: params, query - `GET /{companyId}/accRec/report/vat` (by-companyid-accrec-report-vat) — params: params, query - `GET /{companyId}/accRec/transferable-documents` (by-companyid-accrec-transferable-documents) — params: params, query - `GET /{companyId}/accRec/transferable-documents-summary` (by-companyid-accrec-transferable-documents-summary) — params: params - `GET /{companyId}/accRec/{accCode}/consolidated-deficit-record` (by-companyid-accrec-by-acccode-consolidated-deficit-record) — params: params, query - `PUT /{companyId}/accRec/{accountingRecordId}/changeAccount` (by-companyid-accrec-by-accountingrecordid-changeaccount-put) — params: accountId - `GET /{companyId}/accRec/{code}/mizan-for-periods` (by-companyid-accrec-by-code-mizan-for-periods) — params: params, query - `GET /{companyId}/accRec/{documentId}` (by-companyid-accrec-by-documentid) — params: params - `PATCH /{companyId}/accRec/{documentId}` (by-companyid-accrec-by-documentid-patch) — params: status, date, accRecDesc, data - `POST /{companyId}/accRec/{documentId}/auto/acilis` (by-companyid-accrec-by-documentid-auto-acilis-post) — params: params - `POST /{companyId}/accRec/{documentId}/createFromDoc` (by-companyid-accrec-by-documentid-createfromdoc-post) — params: params - `GET /{companyId}/accRec/{documentId}/getRules` (by-companyid-accrec-by-documentid-getrules) — params: params - `PATCH /{companyId}/accRec/{documentId}/updateStatus` (by-companyid-accrec-by-documentid-updatestatus-patch) — params: status - `GET /{companyId}/account` (by-companyid-account) — params: params, query - `POST /{companyId}/account` (by-companyid-account-post) — params: title, type, tcVkn, taxAdmin, taxAuthorityCode, companyType, currency, noNameCompany, isForeignCompany, contacts, bank, cheque, addresses, archived, naceCodes, employeeProfile, foreignCompany - `POST /{companyId}/account/findFromVknList` (by-companyid-account-findfromvknlist-post) — params: list - `GET /{companyId}/account/getFromTcVkn/{tcVkn}` (by-companyid-account-getfromtcvkn-by-tcvkn) — params: params - `GET /{companyId}/account/mizanForAccount` (by-companyid-account-mizanforaccount) — params: params, query - `DELETE /{companyId}/account/{accountId}` (by-companyid-account-by-accountid-delete) — params: params - `GET /{companyId}/account/{accountId}` (by-companyid-account-by-accountid) — params: params - `PATCH /{companyId}/account/{accountId}` (by-companyid-account-by-accountid-patch) — params: bank, companyType, isForeignCompany, noNameCompany, taxAdmin, taxAuthorityCode, tcVkn, title, type, contacts, addresses, cheque, archived, currency, naceCodes, employeeProfile, foreignCompany - `GET /{companyId}/account/{accountId}/address` (by-companyid-account-by-accountid-address) — params: params, query - `POST /{companyId}/account/{accountId}/address` (by-companyid-account-by-accountid-address-post) — params: name, address, district, city, country, phoneNumber, workPhone, email, postCode, addressNo - `GET /{companyId}/account/{accountId}/address/invoice` (by-companyid-account-by-accountid-address-invoice) — params: params - `DELETE /{companyId}/account/{accountId}/address/{addressId}` (by-companyid-account-by-accountid-address-by-addressid-delete) — params: params - `GET /{companyId}/account/{accountId}/address/{addressId}` (by-companyid-account-by-accountid-address-by-addressid) — params: params - `PUT /{companyId}/account/{accountId}/address/{addressId}` (by-companyid-account-by-accountid-address-by-addressid-put) — params: name, address, district, city, country, phoneNumber, workPhone, email, postCode, addressNo - `POST /{companyId}/account/{accountId}/address/{addressId}/set-as-invoice` (by-companyid-account-by-accountid-address-by-addressid-set-as-invoice-post) — params: params - `GET /{companyId}/account/{accountId}/consolidated-deficit-record` (by-companyid-account-by-accountid-consolidated-deficit-record) — params: params, query - `GET /{companyId}/account/{accountId}/muavin` (by-companyid-account-by-accountid-muavin) — params: params, query - `GET /{companyId}/account/{accountId}/muavin/export/{format}` (by-companyid-account-by-accountid-muavin-export-by-format) — params: params, query - `GET /{companyId}/account/{accountId}/paymentLinks` (by-companyid-account-by-accountid-paymentlinks) — params: params - `POST /{companyId}/account/{accountId}/requestPayment` (by-companyid-account-by-accountid-requestpayment-post) — params: to, subject, paymentLink, paymentAmount - `POST /{companyId}/account/{accountId}/taxAdmin` (by-companyid-account-by-accountid-taxadmin-post) — params: name, code - `POST /{companyId}/account/{accountId}/transfer/{counterAccountId}` (by-companyid-account-by-accountid-transfer-by-counteraccountid-post) — params: date, description, amount - `GET /{companyId}/account/{accountId}/waybill` (by-companyid-account-by-accountid-waybill) — params: params, query - `GET /{companyId}/accounting-records` (by-companyid-accounting-records) — params: params, query - `POST /{companyId}/accounting-records` (by-companyid-accounting-records-post) — params: accRecDate, accRecDesc, accRecStatus, accRec - `GET /{companyId}/accounting-records/accounting-code-account-mapping` (by-companyid-accounting-records-accounting-code-account-mapping) — params: params, query - `GET /{companyId}/accounting-records/accounting-codes-with-multiple-accounts` (by-companyid-accounting-records-accounting-codes-with-multiple-accounts) — params: params, query - `GET /{companyId}/accounting-records/accounts-with-multiple-accounting-codes` (by-companyid-accounting-records-accounts-with-multiple-accounting-codes) — params: params, query - `GET /{companyId}/accounting-records/auto/amortization` (by-companyid-accounting-records-auto-amortization) — params: params, query - `POST /{companyId}/accounting-records/auto/amortizationAcc` (by-companyid-accounting-records-auto-amortizationacc-post) — params: period, amortization - `POST /{companyId}/accounting-records/auto/kapanis` (by-companyid-accounting-records-auto-kapanis-post) — params: year - `POST /{companyId}/accounting-records/auto/preAccKapanis` (by-companyid-accounting-records-auto-preacckapanis-post) — params: date - `POST /{companyId}/accounting-records/auto/reflect` (by-companyid-accounting-records-auto-reflect-post) — params: period, reflectAccCode, expenseAccCode, accRecs - `POST /{companyId}/accounting-records/auto/vat` (by-companyid-accounting-records-auto-vat-post) — params: period, transferringKdv, payableKdv, accRec, beforePeriodTransfer - `POST /{companyId}/accounting-records/auto/virman` (by-companyid-accounting-records-auto-virman-post) — params: period, accRec - `POST /{companyId}/accounting-records/auto/{documentId}/acilis` (by-companyid-accounting-records-auto-by-documentid-acilis-post) — params: params - `PATCH /{companyId}/accounting-records/batch/transfer-accounting-plan` (by-companyid-accounting-records-batch-transfer-accounting-plan-patch) — params: fromAccPlanId, toAccPlanId, startDate, endDate - `PATCH /{companyId}/accounting-records/batch/transfer-product` (by-companyid-accounting-records-batch-transfer-product-patch) — params: fromProductId, toProductId, startDate, endDate - `PATCH /{companyId}/accounting-records/batch/updateStatus` (by-companyid-accounting-records-batch-updatestatus-patch) — params: status, documentIds - `GET /{companyId}/accounting-records/by-acc-code` (by-companyid-accounting-records-by-acc-code) — params: params, query - `GET /{companyId}/accounting-records/document-status-summary-report` (by-companyid-accounting-records-document-status-summary-report) — params: params, query - `POST /{companyId}/accounting-records/getRulesByRuleKeys` (by-companyid-accounting-records-getrulesbyrulekeys-post) — params: params, body - `GET /{companyId}/accounting-records/mizan` (by-companyid-accounting-records-mizan) — params: params, query - `GET /{companyId}/accounting-records/mizan-for-periods` (by-companyid-accounting-records-mizan-for-periods) — params: params, query - `GET /{companyId}/accounting-records/muavin` (by-companyid-accounting-records-muavin) — params: params, query - `GET /{companyId}/accounting-records/muavin/export/{format}` (by-companyid-accounting-records-muavin-export-by-format) — params: params, query - `POST /{companyId}/accounting-records/opening-balance` (by-companyid-accounting-records-opening-balance-post) — params: items - `POST /{companyId}/accounting-records/reCreateAllDraft` (by-companyid-accounting-records-recreatealldraft-post) — params: params - `GET /{companyId}/accounting-records/ready-list` (by-companyid-accounting-records-ready-list) — params: params, query - `GET /{companyId}/accounting-records/recreate-list` (by-companyid-accounting-records-recreate-list) — params: params, query - `GET /{companyId}/accounting-records/report/vat` (by-companyid-accounting-records-report-vat) — params: params, query - `GET /{companyId}/accounting-records/transferable-documents` (by-companyid-accounting-records-transferable-documents) — params: params, query - `GET /{companyId}/accounting-records/transferable-documents-summary` (by-companyid-accounting-records-transferable-documents-summary) — params: params - `GET /{companyId}/accounting-records/{accCode}/consolidated-deficit-record` (by-companyid-accounting-records-by-acccode-consolidated-deficit-record) — params: params, query - `PUT /{companyId}/accounting-records/{accountingRecordId}/changeAccount` (by-companyid-accounting-records-by-accountingrecordid-changeaccount-put) — params: accountId - `GET /{companyId}/accounting-records/{code}/mizan-for-periods` (by-companyid-accounting-records-by-code-mizan-for-periods) — params: params, query - `GET /{companyId}/accounting-records/{documentId}` (by-companyid-accounting-records-by-documentid) — params: params - `PATCH /{companyId}/accounting-records/{documentId}` (by-companyid-accounting-records-by-documentid-patch) — params: status, date, accRecDesc, data - `POST /{companyId}/accounting-records/{documentId}/auto/acilis` (by-companyid-accounting-records-by-documentid-auto-acilis-post) — params: params - `POST /{companyId}/accounting-records/{documentId}/createFromDoc` (by-companyid-accounting-records-by-documentid-createfromdoc-post) — params: params - `GET /{companyId}/accounting-records/{documentId}/getRules` (by-companyid-accounting-records-by-documentid-getrules) — params: params - `PATCH /{companyId}/accounting-records/{documentId}/updateStatus` (by-companyid-accounting-records-by-documentid-updatestatus-patch) — params: status - `GET /{companyId}/category` (by-companyid-category) — params: params, query - `POST /{companyId}/category` (by-companyid-category-post) — params: id, companyId, categoryType, name, bgColor, textColor, parentId - `DELETE /{companyId}/category/{categoryId}` (by-companyid-category-by-categoryid-delete) — params: params - `GET /{companyId}/category/{categoryId}` (by-companyid-category-by-categoryid) — params: params - `PUT /{companyId}/category/{categoryId}` (by-companyid-category-by-categoryid-put) — params: id, companyId, categoryType, name, bgColor, textColor, parentId - `DELETE /{companyId}/category/{categoryType}/{entityId}` (by-companyid-category-by-categorytype-by-entityid-delete) — params: params - `GET /{companyId}/category/{categoryType}/{entityId}` (by-companyid-category-by-categorytype-by-entityid) — params: params - `PUT /{companyId}/category/{categoryType}/{entityId}/{categoryId}` (by-companyid-category-by-categorytype-by-entityid-by-categoryid-put) — params: params - `POST /{companyId}/dbs` (by-companyid-dbs-post) — params: direction, scenario, documentType, startDate, endDate, searchQuery, page, size - `GET /{companyId}/dbs/defter/list` (by-companyid-dbs-defter-list) — params: params - `DELETE /{companyId}/dbs/deleteFromDBS/{documentId}` (by-companyid-dbs-deletefromdbs-by-documentid-delete) — params: params - `POST /{companyId}/dbs/documents/search` (by-companyid-dbs-documents-search-post) — params: startDate, endDate, direction, scenario, documentType, status, page, size - `GET /{companyId}/dbs/documents/status` (by-companyid-dbs-documents-status) — params: params - `GET /{companyId}/dbs/documents/{documentId}/suggestion` (by-companyid-dbs-documents-by-documentid-suggestion) — params: params - `GET /{companyId}/dbs/listActivityCodes` (by-companyid-dbs-listactivitycodes) — params: params - `GET /{companyId}/dbs/mukellef/genelbilgiler` (by-companyid-dbs-mukellef-genelbilgiler) — params: params - `GET /{companyId}/dbs/mukellef/mukellefler` (by-companyid-dbs-mukellef-mukellefler) — params: params, query - `POST /{companyId}/dbs/sales-subtypes` (by-companyid-dbs-sales-subtypes-post) — params: type, ledgerType, typeName, incomeRegistrationTypeCode, expenseRegistrationTypeCode - `GET /{companyId}/dbs/system/fixed-assets-codes` (by-companyid-dbs-system-fixed-assets-codes) — params: params - `GET /{companyId}/dbs/system/tax-offices` (by-companyid-dbs-system-tax-offices) — params: params - `GET /{companyId}/dbs/system/{ledgerPermission}/fixed-assets` (by-companyid-dbs-system-by-ledgerpermission-fixed-assets) — params: params, query - `GET /{companyId}/dbs/system/{ledgerType}/{category}` (by-companyid-dbs-system-by-ledgertype-by-category) — params: params - `GET /{companyId}/dbs/system/{ledgerType}/{category}/{documentTypeCode}` (by-companyid-dbs-system-by-ledgertype-by-category-by-documenttypecode) — params: params - `GET /{companyId}/dbs/system/{ledgerType}/{category}/{documentTypeCode}/{categoryCode}` (by-companyid-dbs-system-by-ledgertype-by-category-by-documenttypecode-by-categorycode) — params: params - `GET /{companyId}/dbs/system/{ledgerType}/{category}/{documentTypeCode}/{categoryCode}/{recordTypeCode}` (by-companyid-dbs-system-by-ledgertype-by-category-by-documenttypecode-by-categorycode-by-recordtypecode) — params: params - `GET /{companyId}/dbs/system/{type}` (by-companyid-dbs-system-by-type) — params: params - `POST /{companyId}/dbs/transferToDBS` (by-companyid-dbs-transfertodbs-post) — params: documentId, date, activityCode, ledgerType, lines - `GET /{companyId}/dbs/unvan` (by-companyid-dbs-unvan) — params: params - `GET /{companyId}/document` (by-companyid-document) — params: params, query - `POST /{companyId}/document` (by-companyid-document-post) — params: accountId, docDetail, recurringJob, documentNo, documentType, scenario, direction, date, time, dueDate, currency, exchangeRate, note, total, discountRate, referenceInboxId, documentName, lines, payments, tax, status, withAccRec, isExpenseNote, isWithholdingDocumentType, isYatirimTesvik, isOKC, isTahsilat, isOdeme, isExport, isImport, isReturn, isYtbType, isEArchive, isStock, isZReport, isOut, isIn - `POST /{companyId}/document/archive` (by-companyid-document-archive-post) — params: documentIds - `POST /{companyId}/document/bank/draft-bank-accounts` (by-companyid-document-bank-draft-bank-accounts-post) — params: startDate, endDate, minAmount, maxAmount, direction, bankAccountId, currency, searchQuery, page, size, sort - `POST /{companyId}/document/bank/save` (by-companyid-document-bank-save-post) — params: params, body - `POST /{companyId}/document/bank/search` (by-companyid-document-bank-search-post) — params: startDate, endDate, minAmount, maxAmount, direction, bankAccountId, currency, searchQuery, page, size, sort - `POST /{companyId}/document/bank/{accountId}` (by-companyid-document-bank-by-accountid-post) — params: bankStatement - `GET /{companyId}/document/bank/{documentId}` (by-companyid-document-bank-by-documentid) — params: params - `POST /{companyId}/document/basic` (by-companyid-document-basic-post) — params: date, accountId, currency, exchangeRate, discountRate, time, lines - `POST /{companyId}/document/bulk` (by-companyid-document-bulk-post) — params: documentType, rows - `GET /{companyId}/document/checkMultiple` (by-companyid-document-checkmultiple) — params: params, query - `GET /{companyId}/document/detailed-report/export/{format}` (by-companyid-document-detailed-report-export-by-format) — params: params, query - `GET /{companyId}/document/draft-ids` (by-companyid-document-draft-ids) — params: params, query - `GET /{companyId}/document/drafts/count` (by-companyid-document-drafts-count) — params: params, query - `POST /{companyId}/document/expense-note/{documentId}/create` (by-companyid-document-expense-note-by-documentid-create-post) — params: params - `POST /{companyId}/document/export/by-ids` (by-companyid-document-export-by-ids-post) — params: documentIds, format, direction - `POST /{companyId}/document/generate-verification-code` (by-companyid-document-generate-verification-code-post) — params: params, query - `POST /{companyId}/document/lease` (by-companyid-document-lease-post) — params: documentName, documentNo, date, docDetail, accountId, netAmount, withholdingRate, recurringJob - `GET /{companyId}/document/lease/{documentId}` (by-companyid-document-lease-by-documentid) — params: params - `PATCH /{companyId}/document/lease/{documentId}` (by-companyid-document-lease-by-documentid-patch) — params: documentName, documentNo, date, docDetail, accountId, netAmount, withholdingRate, recurringJob - `GET /{companyId}/document/most-used-payment-accounts` (by-companyid-document-most-used-payment-accounts) — params: params, query - `GET /{companyId}/document/periods` (by-companyid-document-periods) — params: params - `POST /{companyId}/document/predict-bank-documents` (by-companyid-document-predict-bank-documents-post) — params: params, body - `GET /{companyId}/document/prepare-formalize` (by-companyid-document-prepare-formalize) — params: params, query - `POST /{companyId}/document/unArchive` (by-companyid-document-unarchive-post) — params: documentIds - `DELETE /{companyId}/document/upload` (by-companyid-document-upload-delete) — params: ids - `GET /{companyId}/document/upload` (by-companyid-document-upload) — params: params, query - `POST /{companyId}/document/upload` (by-companyid-document-upload-post) — params: file - `DELETE /{companyId}/document/upload/{ettn}` (by-companyid-document-upload-by-ettn-delete) — params: params - `GET /{companyId}/document/verify-code` (by-companyid-document-verify-code) — params: params, query - `POST /{companyId}/document/zreport/bulk` (by-companyid-document-zreport-bulk-post) — params: params, body - `POST /{companyId}/document/{accountId}/bank` (by-companyid-document-by-accountid-bank-post) — params: bankStatement - `DELETE /{companyId}/document/{documentId}` (by-companyid-document-by-documentid-delete) — params: params - `GET /{companyId}/document/{documentId}` (by-companyid-document-by-documentid) — params: params - `PATCH /{companyId}/document/{documentId}` (by-companyid-document-by-documentid-patch) — params: accountId, docDetail, recurringJob, documentNo, documentType, scenario, direction, date, time, dueDate, currency, exchangeRate, note, total, discountRate, referenceInboxId, documentName, lines, payments, tax, status, withAccRec, isExpenseNote, isWithholdingDocumentType, isYatirimTesvik, isOKC, isTahsilat, isOdeme, isExport, isImport, isReturn, isYtbType, isEArchive, isStock, isZReport, isOut, isIn - `POST /{companyId}/document/{documentId}/cancel` (by-companyid-document-by-documentid-cancel-post) — params: message - `POST /{companyId}/document/{documentId}/cancel/undo` (by-companyid-document-by-documentid-cancel-undo-post) — params: params - `POST /{companyId}/document/{documentId}/copy` (by-companyid-document-by-documentid-copy-post) — params: params - `POST /{companyId}/document/{documentId}/createReturn` (by-companyid-document-by-documentid-createreturn-post) — params: params - `POST /{companyId}/document/{documentId}/formalize` (by-companyid-document-by-documentid-formalize-post) — params: scenario, documentType, alias, deliveryNote, isOnlineSale, deliveryType, webAddress, paymentAgentName, paidType, payDate, sendDate, carrierName, carrierIdentifier, isExportRegistered, isVatExemption, exemptionCategory, vatExemptionCode, vatExemptionLabel, bankAccounts, showAccountBalance, buyerCustomerId, shippingMethod, drivers, companyName, taxNumber, vehiclePlate, invoicingStartDate, invoicingEndDate, additionalInvoiceType, taxPayerCode, additionalDocumentNo - `POST /{companyId}/document/{documentId}/matbu` (by-companyid-document-by-documentid-matbu-post) — params: params - `DELETE /{companyId}/document/{documentId}/name` (by-companyid-document-by-documentid-name-delete) — params: params - `GET /{companyId}/document/{documentId}/name` (by-companyid-document-by-documentid-name) — params: params - `PUT /{companyId}/document/{documentId}/name` (by-companyid-document-by-documentid-name-put) — params: name - `GET /{companyId}/document/{documentId}/prepare-formalize` (by-companyid-document-by-documentid-prepare-formalize) — params: params, query - `POST /{companyId}/document/{documentId}/recurring` (by-companyid-document-by-documentid-recurring-post) — params: params - `POST /{companyId}/document/{documentId}/share` (by-companyid-document-by-documentid-share-post) — params: to, subject, includeStatement, paymentLink, paymentAmount - `GET /{companyId}/employee` (by-companyid-employee) — params: params, query - `POST /{companyId}/employee` (by-companyid-employee-post) — params: title, tcVkn, contacts, addresses, archived, employeeProfile - `GET /{companyId}/employee/codes` (by-companyid-employee-codes) — params: params - `DELETE /{companyId}/employee/{id}` (by-companyid-employee-by-id-delete) — params: params - `GET /{companyId}/employee/{id}` (by-companyid-employee-by-id) — params: params - `PATCH /{companyId}/employee/{id}` (by-companyid-employee-by-id-patch) — params: title, tcVkn, contacts, addresses, archived, employeeProfile - `GET /{companyId}/globalSearch` (by-companyid-globalsearch) — params: params, query - `GET /{companyId}/inbox` (by-companyid-inbox) — params: params, query - `POST /{companyId}/inbox/archive` (by-companyid-inbox-archive-post) — params: documentIds - `GET /{companyId}/inbox/eInvoiceData/{ettn}` (by-companyid-inbox-einvoicedata-by-ettn) — params: params, query - `POST /{companyId}/inbox/paths` (by-companyid-inbox-paths-post) — params: ids - `POST /{companyId}/inbox/productMap` (by-companyid-inbox-productmap-post) — params: data - `POST /{companyId}/inbox/unArchive` (by-companyid-inbox-unarchive-post) — params: documentIds - `POST /{companyId}/inbox/userResponse/{ettn}/create` (by-companyid-inbox-userresponse-by-ettn-create-post) — params: params - `POST /{companyId}/inbox/userResponse/{ettn}/partialAccept` (by-companyid-inbox-userresponse-by-ettn-partialaccept-post) — params: lines - `POST /{companyId}/inbox/userResponse/{ettn}/reject` (by-companyid-inbox-userresponse-by-ettn-reject-post) — params: reason - `GET /{companyId}/inbox/{ettn}` (by-companyid-inbox-by-ettn) — params: params - `GET /{companyId}/note/{documentId}` (by-companyid-note-by-documentid) — params: params - `POST /{companyId}/note/{documentId}` (by-companyid-note-by-documentid-post) — params: content - `GET /{companyId}/note/{documentId}/count` (by-companyid-note-by-documentid-count) — params: params - `DELETE /{companyId}/note/{documentId}/{noteId}` (by-companyid-note-by-documentid-by-noteid-delete) — params: params - `PUT /{companyId}/note/{documentId}/{noteId}` (by-companyid-note-by-documentid-by-noteid-put) — params: content - `POST /{companyId}/payment/add` (by-companyid-payment-add-post) — params: paymentMethod, country, vknTckn, taxOffice, name, surname, title, address, city, district, phone, email, bag, isAgreed - `GET /{companyId}/payroll` (by-companyid-payroll) — params: params, query - `POST /{companyId}/payroll` (by-companyid-payroll-post) — params: year, month, workplaceSector, declarationsOnTime, hasSgkDebt - `GET /{companyId}/payroll/payslip/{accountId}/{year}/{month}` (by-companyid-payroll-payslip-by-accountid-by-year-by-month) — params: params - `DELETE /{companyId}/payroll/{payrollId}` (by-companyid-payroll-by-payrollid-delete) — params: params - `GET /{companyId}/payroll/{payrollId}` (by-companyid-payroll-by-payrollid) — params: params - `POST /{companyId}/payroll/{payrollId}/approve` (by-companyid-payroll-by-payrollid-approve-post) — params: params - `POST /{companyId}/payroll/{payrollId}/calculate` (by-companyid-payroll-by-payrollid-calculate-post) — params: accountIds - `GET /{companyId}/payroll/{payrollId}/lines` (by-companyid-payroll-by-payrollid-lines) — params: params, query - `GET /{companyId}/payroll/{payrollId}/lines/{accountId}` (by-companyid-payroll-by-payrollid-lines-by-accountid) — params: params - `GET /{companyId}/payroll/{payrollId}/lines/{accountId}/payslip` (by-companyid-payroll-by-payrollid-lines-by-accountid-payslip) — params: params - `POST /{companyId}/payroll/{payrollId}/unapprove` (by-companyid-payroll-by-payrollid-unapprove-post) — params: params - `GET /{companyId}/product` (by-companyid-product) — params: params, query - `POST /{companyId}/product` (by-companyid-product-post) — params: name, type, unit, code, barcode, gtipNo, prices, detail - `POST /{companyId}/product/batch-map` (by-companyid-product-batch-map-post) — params: lines - `POST /{companyId}/product/batch-with-stock` (by-companyid-product-batch-with-stock-post) — params: items, openingBalanceDate, currency, exchangeRate - `GET /{companyId}/product/list/with-quantity` (by-companyid-product-list-with-quantity) — params: params, query - `GET /{companyId}/product/maps` (by-companyid-product-maps) — params: params, query - `DELETE /{companyId}/product/{productId}` (by-companyid-product-by-productid-delete) — params: params - `GET /{companyId}/product/{productId}` (by-companyid-product-by-productid) — params: params - `PATCH /{companyId}/product/{productId}` (by-companyid-product-by-productid-patch) — params: name, unit, code, barcode, gtipNo, type, prices, detail - `GET /{companyId}/product/{productId}/fixed-asset/amortization` (by-companyid-product-by-productid-fixed-asset-amortization) — params: params - `GET /{companyId}/product/{productId}/statement` (by-companyid-product-by-productid-statement) — params: params, query - `GET /{companyId}/reports/assets` (by-companyid-reports-assets) — params: params - `GET /{companyId}/reports/cashFlow` (by-companyid-reports-cashflow) — params: params, query - `GET /{companyId}/reports/detail` (by-companyid-reports-detail) — params: params - `GET /{companyId}/reports/document/line` (by-companyid-reports-document-line) — params: params, query - `GET /{companyId}/reports/expense/account` (by-companyid-reports-expense-account) — params: params - `GET /{companyId}/reports/product` (by-companyid-reports-product) — params: params, query - `GET /{companyId}/reports/profit` (by-companyid-reports-profit) — params: params, query - `GET /{companyId}/reports/profit-trend` (by-companyid-reports-profit-trend) — params: params - `GET /{companyId}/reports/sales/account` (by-companyid-reports-sales-account) — params: params - `GET /{companyId}/reports/sales/payment` (by-companyid-reports-sales-payment) — params: params, query - `GET /{companyId}/reports/todo` (by-companyid-reports-todo) — params: params - `GET /{companyId}/reports/todo/smm` (by-companyid-reports-todo-smm) — params: params, query - `GET /{companyId}/reports/{accountId}/detail` (by-companyid-reports-by-accountid-detail) — params: params, query - `GET /{companyId}/settings/company` (by-companyid-settings-company) — params: params - `PATCH /{companyId}/settings/company` (by-companyid-settings-company-patch) — params: addresses, webAddress, balanceBookTransitionDate - `GET /{companyId}/settings/config` (by-companyid-settings-config) — params: params - `PUT /{companyId}/settings/config` (by-companyid-settings-config-put) — params: params, body - `GET /{companyId}/settings/config/{key}` (by-companyid-settings-config-by-key) — params: params - `PUT /{companyId}/settings/config/{key}` (by-companyid-settings-config-by-key-put) — params: params, body - `GET /{companyId}/settings/eInvoiceAttachments` (by-companyid-settings-einvoiceattachments) — params: params - `POST /{companyId}/settings/eInvoiceAttachments` (by-companyid-settings-einvoiceattachments-post) — params: file - `POST /{companyId}/settings/integration` (by-companyid-settings-integration-post) — params: id, integrator, password, type, username - `GET /{companyId}/settings/users` (by-companyid-settings-users) — params: params, query - `PATCH /{companyId}/stock/batch/transfer-product` (by-companyid-stock-batch-transfer-product-patch) — params: fromProductId, toProductId, startDate, endDate - `POST /{companyId}/stock/copy/{documentId}` (by-companyid-stock-copy-by-documentid-post) — params: params - `POST /{companyId}/stock/produce` (by-companyid-stock-produce-post) — params: inputs, outputs, laborCost, description, currency, exchangeRate - `DELETE /{companyId}/stock/{documentId}` (by-companyid-stock-by-documentid-delete) — params: params - `GET /{companyId}/stock/{documentId}` (by-companyid-stock-by-documentid) — params: params - `PUT /{companyId}/stock/{documentId}` (by-companyid-stock-by-documentid-put) — params: inputs, outputs, laborCost, description, currency, exchangeRate - `POST /{companyId}/support` (by-companyid-support-post) — params: title, content, currentPath, category - `GET /{companyId}/support/company` (by-companyid-support-company) — params: params, query - `GET /{companyId}/support/{ticketId}` (by-companyid-support-by-ticketid) — params: params - `POST /{companyId}/support/{ticketId}` (by-companyid-support-by-ticketid-post) — params: id, content, createdAt, createdBy - `GET /{companyId}/tag` (by-companyid-tag) — params: params - `POST /{companyId}/tag` (by-companyid-tag-post) — params: name - `GET /{companyId}/tag/{documentId}/tags` (by-companyid-tag-by-documentid-tags) — params: params - `DELETE /{companyId}/tag/{documentId}/{tagId}` (by-companyid-tag-by-documentid-by-tagid-delete) — params: params - `PUT /{companyId}/tag/{documentId}/{tagId}` (by-companyid-tag-by-documentid-by-tagid-put) — params: params - `DELETE /{companyId}/tag/{tagId}` (by-companyid-tag-by-tagid-delete) — params: params - `GET /{companyId}/tag/{tagId}` (by-companyid-tag-by-tagid) — params: params - `PUT /{companyId}/tag/{tagId}` (by-companyid-tag-by-tagid-put) — params: name - `POST /{companyId}/timesheet` (by-companyid-timesheet-post) — params: accountId, year, month, days, shortageReasonCode, earnings - `DELETE /{companyId}/timesheet/{accountId}/{year}/{month}` (by-companyid-timesheet-by-accountid-by-year-by-month-delete) — params: params - `GET /{companyId}/timesheet/{accountId}/{year}/{month}` (by-companyid-timesheet-by-accountid-by-year-by-month) — params: params - `GET /{companyId}/timesheet/{year}/{month}` (by-companyid-timesheet-by-year-by-month) — params: params - `GET /{companyId}/workplace` (by-companyid-workplace) — params: params, query - `POST /{companyId}/workplace` (by-companyid-workplace-post) — params: name, description, addressId, registrationNumber, registrationDate, employmentAgencyNo, workplaceKind, workplaceType, lineOfBusiness, departureNotificationLineOfBusiness, siiworkplacePassword, siiusername, siiworkplaceCode, siisystemPassword - `DELETE /{companyId}/workplace/{id}` (by-companyid-workplace-by-id-delete) — params: params - `GET /{companyId}/workplace/{id}` (by-companyid-workplace-by-id) — params: params - `PUT /{companyId}/workplace/{id}` (by-companyid-workplace-by-id-put) — params: name, description, addressId, registrationNumber, taxNumber, taxOffice, mersisNo, registrationDate, employmentAgencyNo, workplaceKind, workplaceType, lineOfBusiness, departureNotificationLineOfBusiness, siiworkplacePassword, siiusername, siiworkplaceCode, siisystemPassword - `GET /{companyId}/workplace/{workplaceId}/department` (by-companyid-workplace-by-workplaceid-department) — params: params, query - `POST /{companyId}/workplace/{workplaceId}/department` (by-companyid-workplace-by-workplaceid-department-post) — params: departmentName, hazardClass, hazardLevel, premiumRate, dailyWorkingHours - `DELETE /{companyId}/workplace/{workplaceId}/department/{id}` (by-companyid-workplace-by-workplaceid-department-by-id-delete) — params: params - `GET /{companyId}/workplace/{workplaceId}/department/{id}` (by-companyid-workplace-by-workplaceid-department-by-id) — params: params - `PUT /{companyId}/workplace/{workplaceId}/department/{id}` (by-companyid-workplace-by-workplaceid-department-by-id-put) — params: departmentName, hazardClass, hazardLevel, premiumRate, dailyWorkingHours ## Credential model - API Key (`apiKey`) — required - API Secret (`apiSecret`) — required — secret ## Optional - [Apivom Atlas product page](https://apivom.com/en/products/atlas) - [All Atlas integration guides](https://apivom.com/llms.txt) - [Request a demo](https://apivom.com/en/demo)