Looking for the legacy API v1?v1

The previous version is deprecated but still available for existing integrations.

Complete reference for the Alladdin REST API. All endpoints use JSON and require Bearer token authentication.

🔒 Authentication Bearer <api-key> →

Sales

Invoices

Sales invoice management

18 endpoints

• POSTCreate an invoice/api/v2/invoices
• POSTCreate a payment for an invoice/api/v2/invoices/{invoiceId}/payments
• POSTApprove an invoice/api/v2/invoices/{invoiceId}/approve
• POSTAttach a file to an invoice/api/v2/invoices/{invoiceId}/attachments
• POSTSend an invoice by email/api/v2/invoices/{invoiceId}/send
• PUTUpdate an invoice/api/v2/invoices/{invoiceId}
• PUTSet invoice pipeline/api/v2/invoices/{invoiceId}/pipeline
• GETList invoice attachments/api/v2/invoices/{invoiceId}/attachments
• GETList invoices/api/v2/invoices
• GETGet an invoice/api/v2/invoices/{invoiceId}
• GETGet invoice attachment/api/v2/invoices/{invoiceId}/attachments/{attachmentId}
• GETGet invoice PDF/api/v2/invoices/{invoiceId}/pdf
• DELETEDelete an invoice/api/v2/invoices/{invoiceId}
• POSTBulk cancel invoices/api/v2/invoices/bulk/cancel
• POSTBulk approve invoices/api/v2/invoices/bulk/approve
• POSTCancel an invoice/api/v2/invoices/{invoiceId}/cancel
• GETFind invoices by document number/api/v2/invoices/find-by-number
• DELETEBulk delete invoices/api/v2/invoices

Recurring Invoices

Recurring invoice management

7 endpoints

• POSTCreate a recurring invoice/api/v2/recurring-invoices
• POSTSkip a recurring invoice occurrence/api/v2/recurring-invoices/{invoiceRecurringId}/skip
• PUTUpdate a recurring invoice/api/v2/recurring-invoices/{invoiceRecurringId}
• GETList recurring invoices/api/v2/recurring-invoices
• GETGet a recurring invoice/api/v2/recurring-invoices/{invoiceRecurringId}
• GETGet recurring invoice schedule/api/v2/recurring-invoices/{invoiceRecurringId}/schedule
• DELETEDelete a recurring invoice/api/v2/recurring-invoices/{invoiceRecurringId}

Sales Receipts

Sales receipt management

13 endpoints

• POSTCreate a sales receipt/api/v2/sales-receipts
• POSTCreate a payment for a sales receipt/api/v2/sales-receipts/{salesReceiptId}/payments
• POSTApprove a sales receipt/api/v2/sales-receipts/{salesReceiptId}/approve
• POSTAttach a file to a sales receipt/api/v2/sales-receipts/{salesReceiptId}/attachments
• POSTSend a sales receipt by email/api/v2/sales-receipts/{salesReceiptId}/send
• PUTUpdate a sales receipt/api/v2/sales-receipts/{salesReceiptId}
• PUTSet sales receipt pipeline/api/v2/sales-receipts/{salesReceiptId}/pipeline
• GETList sales receipt attachments/api/v2/sales-receipts/{salesReceiptId}/attachments
• GETList sales receipts/api/v2/sales-receipts
• GETGet a sales receipt/api/v2/sales-receipts/{salesReceiptId}
• GETGet sales receipt attachment/api/v2/sales-receipts/{salesReceiptId}/attachments/{attachmentId}
• GETGet sales receipt PDF/api/v2/sales-receipts/{salesReceiptId}/pdf
• DELETEDelete a sales receipt/api/v2/sales-receipts/{salesReceiptId}

Receipt Notes

Receipt note management

13 endpoints

• POSTApprove a receipt note/api/v2/receipt-notes/{receiptNoteId}/approve
• POSTAttach a file to a receipt note/api/v2/receipt-notes/{receiptNoteId}/attachments
• POSTCreate a receipt note/api/v2/receipt-notes
• POSTCreate a payment for a receipt note/api/v2/receipt-notes/{receiptNoteId}/payments
• POSTSend a receipt note by email/api/v2/receipt-notes/{receiptNoteId}/send
• PUTUpdate a receipt note/api/v2/receipt-notes/{receiptNoteId}
• PUTSet receipt note pipeline/api/v2/receipt-notes/{receiptNoteId}/pipeline
• GETList receipt note attachments/api/v2/receipt-notes/{receiptNoteId}/attachments
• GETList receipt notes/api/v2/receipt-notes
• GETGet a receipt note/api/v2/receipt-notes/{receiptNoteId}
• GETGet receipt note attachment/api/v2/receipt-notes/{receiptNoteId}/attachments/{attachmentId}
• GETGet receipt note PDF/api/v2/receipt-notes/{receiptNoteId}/pdf
• DELETEDelete a receipt note/api/v2/receipt-notes/{receiptNoteId}

Estimates

Estimate management

14 endpoints

• POSTCreate an estimate/api/v2/estimates
• POSTAccept an estimate/api/v2/estimates/{estimateId}/accept
• POSTAttach a file to an estimate/api/v2/estimates/{estimateId}/attachments
• POSTReject an estimate/api/v2/estimates/{estimateId}/reject
• POSTSend an estimate by email/api/v2/estimates/{estimateId}/send
• POSTApprove an estimate/api/v2/estimates/{estimateId}/approve
• PUTUpdate an estimate/api/v2/estimates/{estimateId}
• PUTSet estimate pipeline/api/v2/estimates/{estimateId}/pipeline
• GETList estimate attachments/api/v2/estimates/{estimateId}/attachments
• GETList estimates/api/v2/estimates
• GETGet an estimate/api/v2/estimates/{estimateId}
• GETGet estimate attachment/api/v2/estimates/{estimateId}/attachments/{attachmentId}
• GETGet estimate PDF/api/v2/estimates/{estimateId}/pdf
• DELETEDelete an estimate/api/v2/estimates/{estimateId}

Proformas

Proforma invoice management

12 endpoints

• POSTCreate a proforma/api/v2/proformas
• POSTApprove a proforma/api/v2/proformas/{proformaId}/approve
• POSTAttach a file to a proforma/api/v2/proformas/{proformaId}/attachments
• POSTSend a proforma by email/api/v2/proformas/{proformaId}/send
• PUTUpdate a proforma/api/v2/proformas/{proformaId}
• PUTSet proforma pipeline/api/v2/proformas/{proformaId}/pipeline
• GETList proforma attachments/api/v2/proformas/{proformaId}/attachments
• GETList proformas/api/v2/proformas
• GETGet a proforma/api/v2/proformas/{proformaId}
• GETGet proforma attachment/api/v2/proformas/{proformaId}/attachments/{attachmentId}
• GETGet proforma PDF/api/v2/proformas/{proformaId}/pdf
• DELETEDelete a proforma/api/v2/proformas/{proformaId}

Credit Notes

Credit note management

13 endpoints

• POSTCreate a credit note/api/v2/credit-notes
• POSTCreate a payment for a credit note/api/v2/credit-notes/{creditNoteId}/payments
• POSTApprove a credit note/api/v2/credit-notes/{creditNoteId}/approve
• POSTAttach a file to a credit note/api/v2/credit-notes/{creditNoteId}/attachments
• POSTSend a credit note by email/api/v2/credit-notes/{creditNoteId}/send
• PUTUpdate a credit note/api/v2/credit-notes/{creditNoteId}
• PUTSet credit note pipeline/api/v2/credit-notes/{creditNoteId}/pipeline
• GETList credit note attachments/api/v2/credit-notes/{creditNoteId}/attachments
• GETList credit notes/api/v2/credit-notes
• GETGet a credit note/api/v2/credit-notes/{creditNoteId}
• GETGet credit note attachment/api/v2/credit-notes/{creditNoteId}/attachments/{attachmentId}
• GETGet credit note PDF/api/v2/credit-notes/{creditNoteId}/pdf
• DELETEDelete a credit note/api/v2/credit-notes/{creditNoteId}

Services

Service catalog management

5 endpoints

• POSTCreate a service/api/v2/services
• PUTUpdate a service/api/v2/services/{serviceId}
• GETList services/api/v2/services
• GETGet a service/api/v2/services/{serviceId}
• DELETEDelete a service/api/v2/services/{serviceId}

Sales Channels

Sales channel management

5 endpoints

• POSTCreate a sales channel/api/v2/sales-channels
• PUTUpdate a sales channel/api/v2/sales-channels/{salesChannelId}
• GETList all sales channels/api/v2/sales-channels
• GETGet a sales channel by ID/api/v2/sales-channels/{salesChannelId}
• DELETEDelete a sales channel/api/v2/sales-channels/{salesChannelId}

Numbering Series

Document numbering series configuration

4 endpoints

• POSTCreate a numbering series/api/v2/numbering-series/{type}
• PUTUpdate a numbering series/api/v2/numbering-series/{type}/{numberingSeriesId}
• GETList numbering series by document type/api/v2/numbering-series/{type}
• DELETEDelete a numbering series/api/v2/numbering-series/{type}/{numberingSeriesId}

Contacts

Contact

Contact management (clients, suppliers, leads)

12 endpoints

• POSTCreate a contact/api/v2/contacts
• POSTAttach a file to a contact/api/v2/contacts/{contactId}/attachments
• PUTUpdate a contact/api/v2/contacts/{contactId}
• GETList contact attachments/api/v2/contacts/{contactId}/attachments
• GETList contacts/api/v2/contacts
• GETGet a contact by ID/api/v2/contacts/{contactId}
• GETGet a contact attachment/api/v2/contacts/{contactId}/attachments/{filename}
• GETGet client portal link for a contact/api/v2/contacts/{contactId}/portal-link
• DELETEDelete a contact/api/v2/contacts/{contactId}
• POSTBulk archive contacts/api/v2/contacts/bulk-archive
• POSTBulk delete contacts/api/v2/contacts/bulk-delete
• GETSearch contacts by name/api/v2/contacts/search

Contact Group

Contact group management

5 endpoints

• POSTCreate a contact group/api/v2/contact-groups
• PUTUpdate a contact group/api/v2/contact-groups/{contactGroupId}
• GETList contact groups/api/v2/contact-groups
• GETGet a contact group/api/v2/contact-groups/{contactGroupId}
• DELETEDelete a contact group/api/v2/contact-groups/{contactGroupId}

Tags

Tag management

3 endpoints

• POSTCreate a tag/api/v2/tags
• GETList all tags/api/v2/tags
• DELETEDelete a tag/api/v2/tags/{tag}

Accounting

Accounting

Chart of accounts and ledger entries

6 endpoints

• POSTCreate an accounting account/api/v2/accounting-accounts
• POSTCreate a ledger entry/api/v2/ledger-entries
• GETList chart of accounts/api/v2/accounting-accounts
• GETList ledger entries/api/v2/ledger-entries
• GETGet a ledger entry/api/v2/ledger-entries/{ledgerEntryId}
• DELETEDelete a ledger entry/api/v2/ledger-entries/{ledgerEntryId}

Expenses Accounts

Expense account management

5 endpoints

• POSTCreate an expenses account/api/v2/expenses-accounts
• PUTUpdate an expenses account/api/v2/expenses-accounts/{expensesAccountId}
• GETList all expenses accounts/api/v2/expenses-accounts
• GETGet an expenses account by ID/api/v2/expenses-accounts/{expensesAccountId}
• DELETEDelete an expenses account/api/v2/expenses-accounts/{expensesAccountId}

Payment

Payment management (create, update, delete, list)

5 endpoints

• POSTCreate a payment/api/v2/payments
• PUTUpdate a payment/api/v2/payments/{paymentId}
• GETList payments/api/v2/paymentsand collections
• GETGet a payment by ID/api/v2/payments/{paymentId}
• DELETEDelete a payment/api/v2/payments/{paymentId}

Purchases

Purchase invoice management

14 endpoints

• POSTCreate a purchase/api/v2/purchases
• POSTCreate a payment for a purchase/api/v2/purchases/{purchaseId}/payments
• POSTApprove a purchase/api/v2/purchases/{purchaseId}/approve
• POSTAttach a file to a purchase/api/v2/purchases/{purchaseId}/attachments
• POSTCreate a purchase refund/api/v2/purchases/refund
• PUTUpdate a purchase/api/v2/purchases/{purchaseId}
• PUTSet purchase pipeline/api/v2/purchases/{purchaseId}/pipeline
• GETList purchase attachments/api/v2/purchases/{purchaseId}/attachments
• GETList purchases/api/v2/purchases
• GETGet a purchase/api/v2/purchases/{purchaseId}
• GETGet purchase attachment/api/v2/purchases/{purchaseId}/attachments/{attachmentId}
• GETGet a purchase refund/api/v2/purchases/refund/{purchaseRefundId}
• GETList purchase refunds/api/v2/purchase-refunds
• DELETEDelete a purchase/api/v2/purchases/{purchaseId}

Tax

Tax configuration and compliance management

2 endpoints

• GETList all taxes/api/v2/taxes
• GETGet sorted tax keys by country and section/api/v2/taxes/keys-by-country

Treasury

Banking accounts

Banking account management within the Treasury product

10 endpoints

• POSTArchive a banking account/api/v2/treasury/accounts/{id}/archive
• POSTCreate one or multiple manual bank movements/api/v2/treasury/accounts/{bankingAccountId}/bank-movements
• GETList banking accounts/api/v2/treasury/accounts
• POSTCreate a banking account/api/v2/treasury/accounts
• GETGet a banking account by ID/api/v2/treasury/accounts/{id}
• PUTUpdate a banking account/api/v2/treasury/accounts/{id}
• DELETEDelete a banking account/api/v2/treasury/accounts/{id}
• GETList banking account movements/api/v2/treasury/accounts/{id}/bank-movements
• GETList banking account cash movements/api/v2/treasury/accounts/{id}/cash-movements
• POSTReconcile a bank movement/api/v2/treasury/accounts/{bankingAccountId}/bank-movements/{movementId}/reconcile

Payment Methods

Payment method configuration and management

5 endpoints

• POSTCreate a payment method/api/v2/payment-methods
• PUTUpdate a payment method/api/v2/payment-methods/{paymentMethodId}
• DELETEDelete a payment method/api/v2/payment-methods/{paymentMethodId}
• GETList payment methods/api/v2/payment-methods
• GETGet a payment method by ID/api/v2/payment-methods/{paymentMethodId}

Remittances

Remittance management within the Treasury product

2 endpoints

• GETList remittances/api/v2/treasury/remittances
• GETGet a remittance/api/v2/treasury/remittances/{remittanceId}

Invoicing Forecast

Invoicing forecast management for cashflow planning linked to estimates and purchase orders

5 endpoints

• POSTCreate an invoicing forecast/api/v2/treasury/cashflow/invoicing-forecasts
• PUTEdit an invoicing forecast/api/v2/treasury/cashflow/invoicing-forecasts/{forecastId}
• GETList invoicing forecasts/api/v2/treasury/cashflow/invoicing-forecasts
• GETGet an invoicing forecast/api/v2/treasury/cashflow/invoicing-forecasts/{forecastId}
• DELETEDelete an invoicing forecast/api/v2/treasury/cashflow/invoicing-forecasts/{forecastId}

Business Plan

Business Plan goals — targets vs. actuals by accounting account and month

2 endpoints

• GETList business plan goals vs actuals/api/v2/business-plan/goals
• GETList business plan scenarios/api/v2/business-plan/scenarios

CRM

Funnels

CRM funnel and pipeline stage management

5 endpoints

• POSTCreate a funnel/api/v2/funnels
• PUTUpdate a funnel/api/v2/funnels/{funnelId}
• GETList all funnels/api/v2/funnels
• GETGet a funnel/api/v2/funnels/{funnelId}
• DELETEDelete a funnel/api/v2/funnels/{funnelId}

Leads

CRM lead tracking and lifecycle management

12 endpoints

• POSTCreate a lead/api/v2/leads
• POSTCreate a lead note/api/v2/leads/{leadId}/notes
• POSTCreate a lead task/api/v2/leads/{leadId}/tasks
• PUTUpdate a lead note/api/v2/leads/{leadId}/notes
• PUTUpdate a lead task/api/v2/leads/{leadId}/tasks
• PUTUpdate a lead/api/v2/leads/{leadId}
• PUTUpdate lead dates/api/v2/leads/{leadId}/dates
• PUTUpdate a lead stage/api/v2/leads/{leadId}/stage
• GETList all leads/api/v2/leads
• GETGet a lead/api/v2/leads/{leadId}
• DELETEDelete a lead task/api/v2/leads/{leadId}/tasks
• DELETEDelete a lead/api/v2/leads/{leadId}

Projects

Projects

Project management

6 endpoints

• POSTCreate a project/api/v2/projects
• PUTUpdate a project/api/v2/projects/{projectId}
• GETGet a project/api/v2/projects/{projectId}
• GETGet a project summary/api/v2/projects/{projectId}/summary
• GETList projects/api/v2/projects
• DELETEDelete a project/api/v2/projects/{projectId}

Tasks

Task management within projects

5 endpoints

• POSTCreate a task/api/v2/tasks
• PUTUpdate a task/api/v2/tasks/{taskId}
• GETList all tasks/api/v2/tasks
• GETGet a task/api/v2/tasks/{taskId}
• DELETEDelete a task/api/v2/tasks/{taskId}

Project Time Tracking

Time tracking entries for projects

6 endpoints

• POSTCreate a time entry for a project/api/v2/projects/{projectId}/times
• PUTUpdate a project time entry/api/v2/projects/{projectId}/times/{timeId}
• GETList time entries for a project/api/v2/projects/{projectId}/times
• GETList all project time entries/api/v2/project-times
• GETGet a project time entry/api/v2/projects/{projectId}/times/{timeId}
• DELETEDelete a project time entry/api/v2/projects/{projectId}/times/{timeId}

Inventory

Products

Product management

12 endpoints

• POSTCreate a product/api/v2/products
• POSTUpload a product image/api/v2/products/{productId}/images
• PUTUpdate a product/api/v2/products/{productId}
• PUTUpdate stock for a product/api/v2/products/{productId}/stock
• GETList all products/api/v2/products
• GETList product images/api/v2/products/{productId}/images
• GETGet a product by ID/api/v2/products/{productId}
• GETGet a product image by ID/api/v2/products/{productId}/images/{imageId}
• GETGet the main product image/api/v2/products/{productId}/image
• GETGet stock availability for a product/api/v2/products/{productId}/stock
• GETGet stock in transit for a product/api/v2/products/{productId}/stock/transit
• DELETEDelete a product/api/v2/products/{productId}

Price Lists

Product price list management

5 endpoints

• POSTCreate a price list/api/v2/price-lists
• PATCHUpdate a price list/api/v2/price-lists/{priceListId}
• GETList price lists/api/v2/price-lists
• GETGet a price list by ID/api/v2/price-lists/{priceListId}
• DELETEDelete a price list/api/v2/price-lists/{priceListId}

Warehouses

Warehouse and stock management

6 endpoints

• POSTCreate a warehouse/api/v2/warehouses
• PATCHUpdate a warehouse/api/v2/warehouses/{warehouseId}
• GETList all warehouses/api/v2/warehouses
• GETGet a warehouse by ID/api/v2/warehouses/{warehouseId}
• GETGet stock levels for a warehouse/api/v2/warehouses/{warehouseId}/stock
• DELETEDelete a warehouse/api/v2/warehouses/{warehouseId}

Sales Orders

Sales order management

16 endpoints

• POSTCreate a sales order/api/v2/sales-orders
• POSTApprove a sales order/api/v2/sales-orders/{salesOrderId}/approve
• POSTAttach a file to a sales order/api/v2/sales-orders/{salesOrderId}/attachments
• POSTSend a sales order by email/api/v2/sales-orders/{salesOrderId}/send
• POSTShip all items in a sales order/api/v2/sales-orders/{salesOrderId}/ship
• POSTShip specific lines in a sales order/api/v2/sales-orders/{salesOrderId}/ship-by-lines
• PUTUpdate a sales order/api/v2/sales-orders/{salesOrderId}
• PUTSet sales order pipeline/api/v2/sales-orders/{salesOrderId}/pipeline
• PUTUpdate sales order tracking information/api/v2/sales-orders/{salesOrderId}/tracking
• GETList sales order attachments/api/v2/sales-orders/{salesOrderId}/attachments
• GETList sales orders/api/v2/sales-orders
• GETGet a sales order/api/v2/sales-orders/{salesOrderId}
• GETGet sales order attachment/api/v2/sales-orders/{salesOrderId}/attachments/{attachmentId}
• GETGet sales order PDF/api/v2/sales-orders/{salesOrderId}/pdf
• GETGet shipped items for a sales order/api/v2/sales-orders/{salesOrderId}/shipped-items
• DELETEDelete a sales order/api/v2/sales-orders/{salesOrderId}

Waybills

Waybill and shipment management

13 endpoints

• POSTCreate a waybill/api/v2/waybills
• POSTApprove a waybill/api/v2/waybills/{waybillId}/approve
• POSTAttach a file to a waybill/api/v2/waybills/{waybillId}/attachments
• POSTSend a waybill by email/api/v2/waybills/{waybillId}/send
• PUTUpdate a waybill/api/v2/waybills/{waybillId}
• PUTSet waybill pipeline/api/v2/waybills/{waybillId}/pipeline
• PUTUpdate waybill tracking information/api/v2/waybills/{waybillId}/tracking
• GETList waybill attachments/api/v2/waybills/{waybillId}/attachments
• GETList waybills/api/v2/waybills
• GETGet a waybill/api/v2/waybills/{waybillId}
• GETGet waybill attachment/api/v2/waybills/{waybillId}/attachments/{attachmentId}
• GETGet waybill PDF/api/v2/waybills/{waybillId}/pdf
• DELETEDelete a waybill/api/v2/waybills/{waybillId}

Purchase Orders

Purchase order management

14 endpoints

• POSTCreate a purchase order/api/v2/purchase-orders
• POSTApprove a purchase order/api/v2/purchase-orders/{purchaseOrderId}/approve
• POSTAttach a file to a purchase order/api/v2/purchase-orders/{purchaseOrderId}/attachments
• POSTReceive units of a purchase order/api/v2/purchase-orders/{purchaseOrderId}/receive
• POSTSend a purchase order by email/api/v2/purchase-orders/{purchaseOrderId}/send
• PUTUpdate a purchase order/api/v2/purchase-orders/{purchaseOrderId}
• PUTSet purchase order pipeline/api/v2/purchase-orders/{purchaseOrderId}/pipeline
• GETList purchase order attachments/api/v2/purchase-orders/{purchaseOrderId}/attachments
• GETList purchase orders/api/v2/purchase-orders
• GETGet a purchase order/api/v2/purchase-orders/{purchaseOrderId}
• GETGet purchase order attachment/api/v2/purchase-orders/{purchaseOrderId}/attachments/{attachmentId}
• GETGet purchase order PDF/api/v2/purchase-orders/{purchaseOrderId}/pdf
• GETGet received items for a purchase order/api/v2/purchase-orders/{purchaseOrderId}/received-items
• DELETEDelete a purchase order/api/v2/purchase-orders/{purchaseOrderId}

Purchase Shipments

Purchase shipment and receiving management

6 endpoints

• POSTCreate a purchase shipment/api/v2/purchase-shipments
• POSTApprove a purchase shipment/api/v2/purchase-shipments/{purchaseShipmentId}/approve
• PUTUpdate a purchase shipment/api/v2/purchase-shipments/{purchaseShipmentId}
• GETList purchase shipments/api/v2/purchase-shipments
• GETGet a purchase shipment/api/v2/purchase-shipments/{purchaseShipmentId}
• DELETEDelete a purchase shipment/api/v2/purchase-shipments/{purchaseShipmentId}

Documents

Cross-document operations (e.g. convert between document types)

1 endpoints

POST/api/v2/documents/convertConvert a document to another type →

Production Orders

Production order and manufacturing pipeline management

5 endpoints

• POSTCreate a production order/api/v2/production-orders
• PUTUpdate a production order/api/v2/production-orders/{productionOrderId}
• GETList production orders/api/v2/production-orders
• GETGet a production order/api/v2/production-orders/{productionOrderId}
• DELETEDelete a production order/api/v2/production-orders/{productionOrderId}

Team & HR

Employees

Employee CRUD management

7 endpoints

• POSTCreate an employee/api/v2/employees
• PUTUpdate an employee/api/v2/employees/{employeeId}
• PUTUpdate active contract/api/v2/employees/{employeeId}/contract
• GETList all employees/api/v2/employees
• GETGet an employee/api/v2/employees/{employeeId}
• GETGet active contract/api/v2/employees/{employeeId}/contract
• DELETEDelete an employee/api/v2/employees/{employeeId}

Employee Time Tracking

Employee time tracking, clock-in/out and pause management

10 endpoints

• POSTClock in an employee/api/v2/employees/{employeeId}/clock-in
• POSTClock out an employee/api/v2/employees/{employeeId}/clock-out
• POSTCreate a time entry for an employee/api/v2/employees/{employeeId}/times
• POSTPause an employee time session/api/v2/employees/{employeeId}/pause
• POSTResume an employee time session/api/v2/employees/{employeeId}/unpause
• PUTUpdate an employee time entry/api/v2/employee-times/{timeId}
• GETList time entries for an employee/api/v2/employees/{employeeId}/times
• GETList all employee time entries/api/v2/employee-times
• GETGet an employee time entry/api/v2/employee-times/{timeId}
• DELETEDelete an employee time entry/api/v2/employee-times/{timeId}

Salary records

Salary record management (non-payslip payroll documents)

7 endpoints

• POSTCreate a salary record/api/v2/salary-records
• PUTUpdate a salary record/api/v2/salary-records/{salaryRecordId}
• GETList salary records/api/v2/salary-records
• GETGet a salary record/api/v2/salary-records/{salaryRecordId}
• GETGet salary record form data/api/v2/salary-records/form-data
• GETDownload a salary record PDF/api/v2/salary-records/{salaryRecordId}/pdf
• DELETEDelete a salary record/api/v2/salary-records/{salaryRecordId}

Payslips

Payslip (nómina) management — calculated payroll documents, not salary records

8 endpoints

• POSTApprove a payslip/api/v2/payslips/{payslipId}/approve
• POSTCreate payslips in bulk/api/v2/payslips
• POSTCreate a payment for a payslip/api/v2/payslips/{payslipId}/payments
• GETList payslips/api/v2/payslips
• GETGet a payslip/api/v2/payslips/{payslipId}
• GETDownload a payslip PDF/api/v2/payslips/{payslipId}/pdf
• DELETEDelete a payslip/api/v2/payslips/{payslipId}
• DELETEDelete a payment from a payslip/api/v2/payslips/{payslipId}/payments/{paymentId}

Time off

Employee time off, absence, holiday, vacation and leave request management

5 endpoints

• POSTCreate a time off request (absence / holiday/api/v2/employees/{employeeId}/time-offs)
• PUTUpdate time off end date (absence / holiday)/api/v2/employees/{employeeId}/time-offs/{timeOffId}
• GETList time off requests for an employee (absences / holidays)/api/v2/employees/{employeeId}/time-offs
• GETGet a time off request (absence / holiday)/api/v2/employees/{employeeId}/time-offs/{timeOffId}
• GETList all time off requests (absences / holidays/api/v2/employees/time-offs)

Calendar

Events

Calendar events management

5 endpoints

• POSTCreate an event/api/v2/events
• PUTUpdate an event/api/v2/events/{eventId}
• GETList all events/api/v2/events
• GETGet an event by ID/api/v2/events/{eventId}
• DELETEDelete an event/api/v2/events/{eventId}

Bookings

Booking and reservation management

7 endpoints

• POSTCreate a booking/api/v2/bookings
• PUTUpdate a booking/api/v2/bookings/{bookingId}
• GETList all bookings/api/v2/bookings
• GETList all booking locations/api/v2/booking-locations
• GETGet a booking by ID/api/v2/bookings/{bookingId}
• GETGet available slots for a location/api/v2/booking-locations/{locationId}/slots
• DELETECancel a booking/api/v2/bookings/{bookingId}

Inbox

Inbox

Incoming document management (OCR, scan and verify)

9 endpoints

• POSTUpload a document/api/v2/inbox
• POSTAttach incoming document to a document/api/v2/inbox/{incomingDocumentId}/attach
• POSTConvert incoming document into a purchase document/api/v2/inbox/{incomingDocumentId}/export
• PUTUpdate an incoming document/api/v2/inbox/{incomingDocumentId}
• GETList inbox incoming documents/api/v2/inbox
• GETGet an incoming document by ID/api/v2/inbox/{incomingDocumentId}
• GETDownload a file from an inbox document/api/v2/inbox/{incomingDocumentId}/files/{filename}/download
• GETGet a processed thumbnail of a file from an inbox document/api/v2/inbox/{incomingDocumentId}/files/{filename}/preview
• DELETEDelete an incoming document/api/v2/inbox/{incomingDocumentId}

Developers

Developers

Developer tools — API usage monitoring and token management

2 endpoints

• GETGet API usage (automation token/api/v2/usage)
• GETGet API usage by type/api/v2/usage/{type}

Webhooks

Webhook subscription management

8 endpoints

• POSTCreate a webhook/api/v2/webhooks
• POSTDisable a webhook/api/v2/webhooks/{webhookId}/disable
• POSTEnable a webhook/api/v2/webhooks/{webhookId}/enable
• PUTUpdate a webhook/api/v2/webhooks/{webhookId}
• GETList webhooks/api/v2/webhooks
• GETGet a webhook/api/v2/webhooks/{webhookId}
• GETList supported webhook event types/api/v2/webhooks/events
• DELETEDelete a webhook/api/v2/webhooks/{webhookId}

Account

Account

Account information associated with the API token, and account user management — invite and list team members

6 endpoints

• POSTInvite a user to the account/api/v2/account/users
• PUTUpdate account user role/api/v2/account/users/{userId}
• GETGet account information/api/v2/account
• GETList account users/api/v2/account/users
• DELETEDelete account user/api/v2/account/users/{userId}
• DELETEDelete account user invitation/api/v2/account/users/invitations/{invitationId}