Lensing Public API v1 Reference

Reference for the Lensing Public API v1: 542 endpoints across Accounting, Banking, Base, CRM, Inventory, People Management, and PSA.

v1 is published, and its contract is frozen: an endpoint in this version will not change incompatibly. An incompatible change ships in a successor version instead, and v1 stays reachable alongside it, so an integration moves only when it changes its Api-Version header.

Every request carries Api-Version: v1 and an Authorization: Bearer <access token> header.

llms.txt: an index of the reference for AI agents
OpenAPI document: the complete contract
Full reference: every endpoint and event in one Markdown file

Accounting › Accounting Period Status

Accounting Period Statuses GET /accounting/period-status
Get Accounting Period Status GET /accounting/period-status/{id}
Execute Accounting Period Task POST /accounting/period-status/{id}/execute-task

Accounting › Accounting Periods

Accounting Periods GET /accounting/accounting-periods
Get Accounting Period GET /accounting/accounting-periods/{id}

Accounting › Accounts

Accounts GET /accounting/accounts
Returns the account with the given identifier. GET /accounting/accounts/{id}
Search Account POST /accounting/accounts/search

Accounting › Amortization Schedule Lines

Amortization Schedule Lines GET /accounting/amortization-schedule-lines

Accounting › Books

Returns a list of accounting books. GET /accounting/books
List Book Entity Assignments GET /accounting/books/{bookId}/entity-assignments
Returns the accounting book with the given identifier. GET /accounting/books/{id}

Accounting › Charts of Accounts

Charts Of Accounts GET /accounting/chart-of-accounts
Returns the chart of accounts with the given identifier. GET /accounting/chart-of-accounts/{id}
Search Chart Of Accounts POST /accounting/chart-of-accounts/search

Accounting › Credit Memos

Credit Memos GET /accounting/credit-memos
Create Credit Memo POST /accounting/credit-memos
Get Credit Memo GET /accounting/credit-memos/{id}
Update Credit Memo PATCH /accounting/credit-memos/{id}
Applies a credit memo to one or more invoices. POST /accounting/credit-memos/{id}/apply
Reverses a credit memo's allocation against one or more invoices. POST /accounting/credit-memos/{id}/unapply
Returns the credit memos that match the given filters. POST /accounting/credit-memos/search

Accounting › Customers

Customers GET /accounting/customers
Create a customer POST /accounting/customers
Get Customer GET /accounting/customers/{id}
Partially update a customer PATCH /accounting/customers/{id}
Search Customer POST /accounting/customers/search

Accounting › Debit Memos

Debit Memos GET /accounting/debit-memos
Create Debit Memo POST /accounting/debit-memos
Get Debit Memo GET /accounting/debit-memos/{id}
Update Debit Memo PATCH /accounting/debit-memos/{id}
Search Debit Memo POST /accounting/debit-memos/search

Accounting › Expense Categories

Returns a list of expense categories. GET /accounting/expense-categories
Creates an expense category. The name must be unique across the tenant. POST /accounting/expense-categories
Returns the expense category with the given identifier. GET /accounting/expense-categories/{id}
Update Expense Category PATCH /accounting/expense-categories/{id}
Deletes the expense category with the given identifier. DELETE /accounting/expense-categories/{id}
Returns the expense categories that match the given filters. POST /accounting/expense-categories/search

Accounting › Expense Reports

Expense Reports GET /accounting/expense-reports
Creates an expense report. POST /accounting/expense-reports
Returns the expense report with the given identifier. GET /accounting/expense-reports/{id}
Update Expense Report PATCH /accounting/expense-reports/{id}
Deletes an expense report. DELETE /accounting/expense-reports/{id}
Approves the expense report. POST /accounting/expense-reports/{id}/approve
Cancels an expense report's submission. POST /accounting/expense-reports/{id}/cancel-submission
Rejects the expense report. POST /accounting/expense-reports/{id}/reject
Search Expense Report POST /accounting/expense-reports/search

Accounting › Fiscal Calendars

Fiscal Calendars GET /accounting/fiscal-calendars
Get Fiscal Calendar GET /accounting/fiscal-calendars/{id}

Accounting › Invoice Frequency Templates

Invoice Frequency Templates GET /accounting/invoice-frequency-templates

Accounting › Invoice Runs

Invoice Runs GET /accounting/invoice-runs
Starts an invoice run for a sales order, customer or legal entity. POST /accounting/invoice-runs
Returns one invoice run and its outcome. GET /accounting/invoice-runs/{id}
Retries the failed lines of an invoice run. POST /accounting/invoice-runs/{id}/rerun

Accounting › Invoices

Invoices GET /accounting/invoices
Get Invoice GET /accounting/invoices/{id}
Update Invoice PATCH /accounting/invoices/{id}
Records a payment against an invoice and applies it immediately. POST /accounting/invoices/{id}/pay
Records invoices billed by an external system. POST /accounting/invoices/import
Returns the invoices that match the given filters. POST /accounting/invoices/search
Accounting/invoices/created event accounting/invoices/created
Accounting/invoices/updated event accounting/invoices/updated

Accounting › Journal Entries

Journal Entries GET /accounting/journal-entries
Create Journal Entry POST /accounting/journal-entries
Get Journal Entry GET /accounting/journal-entries/{id}
Update Journal Entry PATCH /accounting/journal-entries/{id}
Reverse Journal Entry POST /accounting/journal-entries/{id}/reverse
Void Journal Entry POST /accounting/journal-entries/{id}/void
Search Journal Entries POST /accounting/journal-entries/search

Accounting › Outbound Payments

Outbound Payments GET /accounting/outbound-payments
Creates an outbound payment. POST /accounting/outbound-payments
Returns the outbound payment with the given identifier. GET /accounting/outbound-payments/{id}
Update Outbound Payment PATCH /accounting/outbound-payments/{id}
Deletes an outbound payment. DELETE /accounting/outbound-payments/{id}
Voids an outbound payment. POST /accounting/outbound-payments/{id}/void
Search Outbound Payment POST /accounting/outbound-payments/search

Accounting › Payment Terms

Payment Terms GET /accounting/payment-terms

Accounting › Payments

Payments GET /accounting/payments
Creates a payment for a customer. POST /accounting/payments
Get Payment GET /accounting/payments/{id}
Update Payment PATCH /accounting/payments/{id}
Applies a payment to one or more invoices. POST /accounting/payments/{id}/apply
Reverses a payment's application to one or more invoices. POST /accounting/payments/{id}/unapply
Returns the payments that match the given filters. POST /accounting/payments/search

Accounting › Payroll Details

Payroll Details GET /accounting/payroll-details
Creates a payroll detail. POST /accounting/payroll-details
Returns the payroll run with the given identifier. GET /accounting/payroll-details/{id}
Update Payroll Detail PATCH /accounting/payroll-details/{id}
Deletes a payroll detail. DELETE /accounting/payroll-details/{id}
Search Payroll Detail POST /accounting/payroll-details/search

Accounting › Payroll Payments

Payroll Payments GET /accounting/payroll-payments
Records a payroll payment. POST /accounting/payroll-payments
Returns the payroll payment with the given identifier. GET /accounting/payroll-payments/{id}
Update Payroll Payment PATCH /accounting/payroll-payments/{id}
Deletes a payroll payment. DELETE /accounting/payroll-payments/{id}
Search Payroll Payment POST /accounting/payroll-payments/search

Accounting › Payroll Templates

Payroll Templates GET /accounting/payroll-templates
Create Payroll Template POST /accounting/payroll-templates
Get Payroll Template GET /accounting/payroll-templates/{id}
Update Payroll Template PATCH /accounting/payroll-templates/{id}
Deletes the payroll template with the given identifier. DELETE /accounting/payroll-templates/{id}
Search Payroll Template POST /accounting/payroll-templates/search

Accounting › Performance Obligations

Performance Obligations GET /accounting/performance-obligations
Get Performance Obligation GET /accounting/performance-obligations/{id}
List Performance Obligation Products GET /accounting/performance-obligations/{id}/products
Search Performance Obligation POST /accounting/performance-obligations/search

Accounting › Price Books

Price Books GET /accounting/price-books
Creates a price book. POST /accounting/price-books
Get Price Book GET /accounting/price-books/{id}
Update Price Book PATCH /accounting/price-books/{id}
Returns the price books that match the given filters. POST /accounting/price-books/search

Accounting › Products

Products GET /accounting/products
Creates a product. POST /accounting/products
Returns the product with the given identifier. GET /accounting/products/{id}
Update Accounting Product PATCH /accounting/products/{id}
Returns the products that match the given free-text term and filters. POST /accounting/products/search

Accounting › Products › Product Lines

Pricing GET /accounting/pricing
Get Accounting Pricing GET /accounting/pricing/{id}
Search Accounting Pricing POST /accounting/pricing/search
Product Lines GET /accounting/product-lines
Get Accounting Product Line GET /accounting/product-lines/{id}
Search Accounting Product Lines POST /accounting/product-lines/search
Add product lines to a product POST /accounting/products/{id}/product-lines
Partially update a product line PATCH /accounting/products/{id}/product-lines/{productLineId}
Delete a product line DELETE /accounting/products/{id}/product-lines/{productLineId}
Add pricing headers to a product line POST /accounting/products/{id}/product-lines/{productLineId}/pricing
Partially update a pricing header and its entries PATCH /accounting/products/{id}/product-lines/{productLineId}/pricing/{pricingId}
Delete a pricing header DELETE /accounting/products/{id}/product-lines/{productLineId}/pricing/{pricingId}

Accounting › Purchase Orders

Purchase Orders GET /accounting/purchase-orders
Creates a purchase order. POST /accounting/purchase-orders
Returns the purchase order with the given identifier. GET /accounting/purchase-orders/{id}
Update Purchase Order PATCH /accounting/purchase-orders/{id}
Deletes a purchase order. DELETE /accounting/purchase-orders/{id}
Approves the purchase order. POST /accounting/purchase-orders/{id}/approve
Rejects the purchase order. POST /accounting/purchase-orders/{id}/reject
Returns the purchase orders that match the given filters. POST /accounting/purchase-orders/search

Accounting › Purchase Requests

Purchase Requests GET /accounting/purchase-requests
Creates a purchase request. POST /accounting/purchase-requests
Returns the purchase request with the given identifier. GET /accounting/purchase-requests/{id}
Update Purchase Request PATCH /accounting/purchase-requests/{id}
Approves the purchase request. POST /accounting/purchase-requests/{id}/approve
Rejects the purchase request. POST /accounting/purchase-requests/{id}/reject
Search Purchase Request POST /accounting/purchase-requests/search

Accounting › Refunds

List Refunds GET /accounting/refunds
Creates a refund against a source payment. POST /accounting/refunds
Get Refund GET /accounting/refunds/{id}
Update Refund PATCH /accounting/refunds/{id}
Search Refunds POST /accounting/refunds/search

Accounting › Reports › Financial Statement

Run Financial Statement POST /accounting/reports/financial-statement

Accounting › Reports › General Ledger

Read General Ledger POST /accounting/reports/general-ledger

Accounting › Reports › Trial Balances

Returns the trial balance for one entity, accounting book and window. POST /accounting/reports/trial-balance/search

Accounting › Revenue Contracts

Revenue Contracts GET /accounting/revenue-contracts
Get Revenue Contract GET /accounting/revenue-contracts/{id}
Search Revenue Contract POST /accounting/revenue-contracts/search

Accounting › Revenue Scheduling Templates

Revenue Scheduling Templates GET /accounting/revenue-scheduling-templates
Get Revenue Scheduling Template GET /accounting/revenue-scheduling-templates/{id}
Returns the revenue scheduling templates that match the given filters. POST /accounting/revenue-scheduling-templates/search

Accounting › Sales Order Shipments

List Sales Order Shipments GET /accounting/sales-order-shipments
Create Sales Order Shipment POST /accounting/sales-order-shipments
Get Sales Order Shipment GET /accounting/sales-order-shipments/{id}
Update Sales Order Shipment PATCH /accounting/sales-order-shipments/{id}
Delete Sales Order Shipment DELETE /accounting/sales-order-shipments/{id}
Returns the sales order shipments that match the given filters. POST /accounting/sales-order-shipments/search

Accounting › Sales Orders

Sales Orders GET /accounting/sales-orders
Create a sales order POST /accounting/sales-orders
Get Sales Order GET /accounting/sales-orders/{id}
Partially update a sales order PATCH /accounting/sales-orders/{id}
Delete Sales Order DELETE /accounting/sales-orders/{id}
Search Sales Order POST /accounting/sales-orders/search

Accounting › Sales Returns

List Accounting Sales Returns GET /accounting/sales-returns
Creates a sales return against a sales order. POST /accounting/sales-returns
Get Accounting Sales Return GET /accounting/sales-returns/{id}
Update Accounting Sales Return PATCH /accounting/sales-returns/{id}
Cancels the sales return with the given identifier. POST /accounting/sales-returns/{id}/cancel
Search Accounting Sales Return POST /accounting/sales-returns/search

Accounting › Subscriptions

Subscriptions GET /accounting/subscriptions
Get Subscription GET /accounting/subscriptions/{id}
Search Subscription POST /accounting/subscriptions/search

Accounting › Tax Configurations

Tax Configurations GET /accounting/tax-configurations
Creates a tax configuration for a legal entity. POST /accounting/tax-configurations
Returns the tax configuration with the given identifier. GET /accounting/tax-configurations/{id}
Update Tax Configuration PATCH /accounting/tax-configurations/{id}
Search Tax Configuration POST /accounting/tax-configurations/search

Accounting › Usage

List Usage GET /accounting/usages
Returns the usage record with the given identifier. GET /accounting/usages/{id}
Ingest Usage POST /accounting/usages/ingest
Get Ingestion Status GET /accounting/usages/ingestions
Returns the usage records that match the given filters. POST /accounting/usages/search

Accounting › Vendor Bills

Vendor Bills GET /accounting/vendor-bills
Creates a vendor bill. POST /accounting/vendor-bills
Returns the vendor bill with the given identifier. GET /accounting/vendor-bills/{id}
Update Vendor Bill PATCH /accounting/vendor-bills/{id}
Deletes a vendor bill. DELETE /accounting/vendor-bills/{id}
Approves the vendor bill. POST /accounting/vendor-bills/{id}/approve
Rejects the vendor bill. POST /accounting/vendor-bills/{id}/reject
Reverses the vendor bill. POST /accounting/vendor-bills/{id}/reverse
Voids the vendor bill. POST /accounting/vendor-bills/{id}/void
Search Vendor Bill POST /accounting/vendor-bills/search

Accounting › Vendor Credits

Vendor Credits GET /accounting/vendor-credits
Creates a vendor credit. POST /accounting/vendor-credits
Returns the vendor credit with the given identifier. GET /accounting/vendor-credits/{id}
Update Vendor Credit PATCH /accounting/vendor-credits/{id}
Deletes a vendor credit. DELETE /accounting/vendor-credits/{id}
Applies the vendor credit to the given vendor bills. POST /accounting/vendor-credits/{id}/apply
Detaches the vendor credit from the given vendor bills. POST /accounting/vendor-credits/{id}/unapply
Search Vendor Credit POST /accounting/vendor-credits/search

Accounting › Vendors

Vendors GET /accounting/vendors
Creates a vendor. POST /accounting/vendors
Returns the vendor with the given identifier. GET /accounting/vendors/{id}
Update Vendor PATCH /accounting/vendors/{id}
Deletes the vendor with the given identifier. DELETE /accounting/vendors/{id}
Returns the vendors that match the given filters. POST /accounting/vendors/search

Banking › Bank Accounts

Bank Accounts GET /banking/bank-accounts
Creates a bank account. POST /banking/bank-accounts
Returns the bank account with the given identifier. GET /banking/bank-accounts/{id}
Update Bank Account PATCH /banking/bank-accounts/{id}
Deletes a bank account, keeping it recoverable. DELETE /banking/bank-accounts/{id}
Returns the bank accounts that match the given filters. POST /banking/bank-accounts/search

Banking › Bank Entries

Bank Entries GET /banking/bank-entries
Creates a bank entry with its lines. POST /banking/bank-entries
Get Bank Entry GET /banking/bank-entries/{id}
Update Bank Entry PATCH /banking/bank-entries/{id}
Void Bank Entry POST /banking/bank-entries/{id}/void
Returns the bank entries that match the given filters. POST /banking/bank-entries/search

Banking › Bank Rules

Bank Rules GET /banking/bank-rules
Create Bank Rule POST /banking/bank-rules
Get Bank Rule GET /banking/bank-rules/{id}
Update Bank Rule PATCH /banking/bank-rules/{id}
Delete Bank Rule DELETE /banking/bank-rules/{id}
Run Bank Rules POST /banking/bank-rules/run
Search Bank Rule POST /banking/bank-rules/search

Banking › Bank Transactions

Bank Transactions GET /banking/bank-transactions
Creates a bank transaction. POST /banking/bank-transactions
Get Bank Transaction GET /banking/bank-transactions/{id}
Update Bank Transaction PATCH /banking/bank-transactions/{id}
Delete Bank Transaction DELETE /banking/bank-transactions/{id}
Unmatch Bank Transaction POST /banking/bank-transactions/{id}/unmatch
Match Bank Transactions POST /banking/bank-transactions/match
Returns the bank transactions that match the given filters. POST /banking/bank-transactions/search

Banking › Credit Card Entries

Credit Card Entries GET /banking/credit-card-entries
Creates a credit card entry with its lines. POST /banking/credit-card-entries
Get Credit Card Entry GET /banking/credit-card-entries/{id}
Update Credit Card Entry PATCH /banking/credit-card-entries/{id}
Void Credit Card Entry POST /banking/credit-card-entries/{id}/void
Returns the credit card entries that match the given filters. POST /banking/credit-card-entries/search

Banking › Fund Transfers

Fund Transfers GET /banking/fund-transfers
Creates a fund transfer. POST /banking/fund-transfers
Get Fund Transfer GET /banking/fund-transfers/{id}
Update Fund Transfer PATCH /banking/fund-transfers/{id}
Voids a fund transfer. POST /banking/fund-transfers/{id}/void
Returns the fund transfers that match the given filters. POST /banking/fund-transfers/search

Base › Approval Policies

Approval Policies GET /base/approval-policies
Create Approval Policy POST /base/approval-policies
Get Approval Policy GET /base/approval-policies/{id}
Update Approval Policy PATCH /base/approval-policies/{id}
Delete Approval Policy DELETE /base/approval-policies/{id}
Search Approval Policies POST /base/approval-policies/search

Base › Entities

Entities GET /base/entities

Base › Reporting Tags

List Custom Dimensions GET /base/custom-dimensions
List Custom Dimension Values GET /base/custom-dimensions/{customDimensionUuid}/values
Resolve Reporting Tags POST /base/reporting-tags/resolve

CRM › Opportunities

List Opportunities GET /crm/opportunities
Get Opportunity GET /crm/opportunities/{id}
Returns the opportunities that match the given criteria. POST /crm/opportunities/search

CRM › Prospects

List Prospects GET /crm/prospects
Get Prospect GET /crm/prospects/{id}
Returns the prospects that match the given criteria. POST /crm/prospects/search

CRM › Quotes

List Quotes GET /crm/quotes
Get Quote GET /crm/quotes/{id}
Returns the quotes that match the given criteria. POST /crm/quotes/search

Inventory › Account Determination Rules

Account Determination Rules GET /inventory/account-determination-rules
Create Account Determination Rule POST /inventory/account-determination-rules
Get Account Determination Rule GET /inventory/account-determination-rules/{id}
Update Account Determination Rule PATCH /inventory/account-determination-rules/{id}
Deletes the account determination rule with the given identifier. DELETE /inventory/account-determination-rules/{id}
Creates several account determination rules in one call. POST /inventory/account-determination-rules/bulk
Deletes several account determination rules in one call. POST /inventory/account-determination-rules/bulk-delete
Returns the account determination rules that match the given filters. POST /inventory/account-determination-rules/search

Inventory › Batch Numbers

Returns a list of batches. GET /inventory/batch-numbers
Returns the batch with the given identifier. GET /inventory/batch-numbers/{id}
Update Batch Number PATCH /inventory/batch-numbers/{id}
Returns the batches that match the given filters. POST /inventory/batch-numbers/search

Inventory › Batch Transactions

Returns a list of batch transactions. GET /inventory/batch-transactions
Get Batch Transaction GET /inventory/batch-transactions/{id}
Returns the batch transactions that match the given filters. POST /inventory/batch-transactions/search

Inventory › Bins

Bins GET /inventory/bins
Creates a bin. POST /inventory/bins
Returns the bin with the given identifier, with its live utilization. GET /inventory/bins/{id}
Update Bin PATCH /inventory/bins/{id}
Removes the bin with the given identifier. DELETE /inventory/bins/{id}
Creates several bins in one call. POST /inventory/bins/bulk
Removes several bins in one call. POST /inventory/bins/bulk-delete
Returns the bins that match the given filters. POST /inventory/bins/search

Inventory › Inventory Decreases

Inventory Decreases GET /inventory/inventory-decreases
Create Inventory Decrease POST /inventory/inventory-decreases
Get Inventory Decrease GET /inventory/inventory-decreases/{id}
Update Inventory Decrease PATCH /inventory/inventory-decreases/{id}
Delete Inventory Decrease DELETE /inventory/inventory-decreases/{id}
Commit Inventory Decrease POST /inventory/inventory-decreases/{id}/commit
Creates several inventory decreases in one call, each as a draft. POST /inventory/inventory-decreases/bulk
Bulk Delete Inventory Decreases POST /inventory/inventory-decreases/bulk-delete
Search Inventory Decreases POST /inventory/inventory-decreases/search

Inventory › Inventory Increases

Inventory Increases GET /inventory/inventory-increases
Creates an inventory increase as a draft. POST /inventory/inventory-increases
Returns the inventory increase with the given identifier. GET /inventory/inventory-increases/{id}
Update Inventory Increase PATCH /inventory/inventory-increases/{id}
Deletes the inventory increase. DELETE /inventory/inventory-increases/{id}
Commits the inventory increase, posting the stock and the journal entry. POST /inventory/inventory-increases/{id}/commit
Creates several inventory increases in one call, each as a draft. POST /inventory/inventory-increases/bulk
Deletes several inventory increases in one call. POST /inventory/inventory-increases/bulk-delete
Returns the inventory increases that match the given criteria. POST /inventory/inventory-increases/search

Inventory › Inventory Levels

Inventory Levels GET /inventory/inventory-levels
Returns the inventory level with the given identifier. GET /inventory/inventory-levels/{id}
Returns the inventory levels that match the given filters. POST /inventory/inventory-levels/search

Inventory › Inventory Revaluations

Inventory Revaluations GET /inventory/inventory-revaluations
Creates an inventory revaluation as a draft. POST /inventory/inventory-revaluations
Returns the inventory revaluation with the given identifier. GET /inventory/inventory-revaluations/{id}
Update Inventory Revaluation PATCH /inventory/inventory-revaluations/{id}
Deletes a draft inventory revaluation. DELETE /inventory/inventory-revaluations/{id}
Commit Inventory Revaluation POST /inventory/inventory-revaluations/{id}/commit
Creates several inventory revaluations in one call, each as a draft. POST /inventory/inventory-revaluations/bulk
Deletes several draft inventory revaluations in one call. POST /inventory/inventory-revaluations/bulk-delete
Search Inventory Revaluations POST /inventory/inventory-revaluations/search

Inventory › Inventory Transactions

Returns a list of inventory transactions. GET /inventory/inventory-transactions
Returns the inventory transaction with the given identifier. GET /inventory/inventory-transactions/{id}
Returns the inventory transactions that match the given filters. POST /inventory/inventory-transactions/search

Inventory › Item Categories

Returns a list of item categories. GET /inventory/item-categories
Creates an item category. POST /inventory/item-categories
Returns the item category with the given identifier. GET /inventory/item-categories/{id}
Update Item Category PATCH /inventory/item-categories/{id}
Deletes an item category. DELETE /inventory/item-categories/{id}
Creates many item categories in one call. POST /inventory/item-categories/bulk
Deletes many item categories in one call. POST /inventory/item-categories/bulk-delete
Returns the item categories that match the given criteria. POST /inventory/item-categories/search
Returns every item category with its position in the category tree. GET /inventory/item-categories/tree

Inventory › Item Types

Returns a list of item types. GET /inventory/item-types
Returns the item type with the given identifier. GET /inventory/item-types/{id}
Returns the item types that match the given filters. POST /inventory/item-types/search

Inventory › Items

Returns a list of items. GET /inventory/items
Creates an item. POST /inventory/items
Returns the item with the given identifier. GET /inventory/items/{id}
Update Item PATCH /inventory/items/{id}
Deletes the item with the given identifier. DELETE /inventory/items/{id}
Creates several items in one call. All or nothing. POST /inventory/items/bulk
Deletes several items in one call. All or nothing. POST /inventory/items/bulk-delete
Returns the items that match the given filters. POST /inventory/items/search

Inventory › Landed Cost Items

Returns a list of landed cost items. GET /inventory/landed-cost-items
Create Landed Cost Item POST /inventory/landed-cost-items
Returns the landed cost item with the given identifier. GET /inventory/landed-cost-items/{id}
Update Landed Cost Item PATCH /inventory/landed-cost-items/{id}
Deletes the landed cost item with the given identifier. DELETE /inventory/landed-cost-items/{id}
Creates several landed cost items in one call. POST /inventory/landed-cost-items/bulk
Deletes several landed cost items in one call. POST /inventory/landed-cost-items/bulk-delete
Returns the landed cost items that match the given filters. POST /inventory/landed-cost-items/search

Inventory › Landed Costs

Landed Costs GET /inventory/landed-costs
Create Landed Cost POST /inventory/landed-costs
Returns the landed cost with the given identifier. GET /inventory/landed-costs/{id}
Update Landed Cost PATCH /inventory/landed-costs/{id}
Delete Landed Cost DELETE /inventory/landed-costs/{id}
Commit Landed Cost POST /inventory/landed-costs/{id}/commit
Creates several landed costs in one call, each as a draft. POST /inventory/landed-costs/bulk
Deletes several landed costs in one call. POST /inventory/landed-costs/bulk-delete
Returns the landed costs that match the given criteria. POST /inventory/landed-costs/search
Get Available Charges GET /inventory/landed-costs/vendor-bill-lines

Inventory › Reason Codes

Reason Codes GET /inventory/reason-codes
Creates a reason code. POST /inventory/reason-codes
Returns the reason code with the given identifier. GET /inventory/reason-codes/{id}
Update Reason Code PATCH /inventory/reason-codes/{id}
Deletes the reason code with the given identifier. DELETE /inventory/reason-codes/{id}
Creates several reason codes in one call. POST /inventory/reason-codes/bulk
Deletes several reason codes in one call. POST /inventory/reason-codes/bulk-delete
Returns the reason codes that match the given filters. POST /inventory/reason-codes/search

Inventory › Receipts

Receipts GET /inventory/receipts
Creates a receipt in draft status. POST /inventory/receipts
Returns the receipt with the given identifier. GET /inventory/receipts/{id}
Update Receipt PATCH /inventory/receipts/{id}
Deletes the receipt with the given identifier. DELETE /inventory/receipts/{id}
Commit Receipt POST /inventory/receipts/{id}/commit
Creates several receipts in one call. POST /inventory/receipts/bulk
Deletes several receipts in one call. POST /inventory/receipts/bulk-delete
Returns the receipts that match the given filters. POST /inventory/receipts/search

Inventory › Sales Returns

Sales Returns GET /inventory/sales-returns
Creates a sales return. POST /inventory/sales-returns
Returns the sales return with the given identifier. GET /inventory/sales-returns/{id}
Update Sales Return PATCH /inventory/sales-returns/{id}
Deletes a sales return. DELETE /inventory/sales-returns/{id}
Commits a sales return. POST /inventory/sales-returns/{id}/commit
Creates several sales returns in one call. POST /inventory/sales-returns/bulk
Deletes several sales returns in one call. POST /inventory/sales-returns/bulk-delete
Returns the sales returns that match the given criteria. POST /inventory/sales-returns/search

Inventory › Serial Numbers

Returns a list of serial numbers. GET /inventory/serial-numbers
Returns the serial number with the given identifier. GET /inventory/serial-numbers/{id}
Update Serial Number PATCH /inventory/serial-numbers/{id}
Returns the serial numbers that match the given filters. POST /inventory/serial-numbers/search

Inventory › Serial Transactions

Returns a list of serial transactions. GET /inventory/serial-transactions
Returns the serial transaction line with the given identifier. GET /inventory/serial-transactions/{id}
Returns the serial transactions that match the given filters. POST /inventory/serial-transactions/search

Inventory › Shipment Carriers

Returns a list of shipment carriers. GET /inventory/shipment-carriers
Creates a shipment carrier. POST /inventory/shipment-carriers
Returns the shipment carrier with the given identifier. GET /inventory/shipment-carriers/{id}
Update Shipment Carrier PATCH /inventory/shipment-carriers/{id}
Deletes the shipment carrier with the given identifier. DELETE /inventory/shipment-carriers/{id}
Creates many shipment carriers in one call. POST /inventory/shipment-carriers/bulk
Deletes many shipment carriers in one call. POST /inventory/shipment-carriers/bulk-delete
Returns the shipment carriers that match the given filters. POST /inventory/shipment-carriers/search

Inventory › Shipments

Returns a list of shipments. GET /inventory/shipments
Create Shipment POST /inventory/shipments
Returns the shipment with the given identifier, with all of its lines. GET /inventory/shipments/{id}
Update Shipment PATCH /inventory/shipments/{id}
Deletes the shipment with the given identifier. DELETE /inventory/shipments/{id}
Ships and delivers the shipment in one call. POST /inventory/shipments/{id}/commit
Creates several shipments in one call, each as a draft. POST /inventory/shipments/bulk
Deletes several shipments in one call. POST /inventory/shipments/bulk-delete
Returns the shipments that match the given filters, each with its lines. POST /inventory/shipments/search

Inventory › Unit of Measure Groups

Returns a list of unit of measure groups. GET /inventory/unit-of-measure-groups
Creates a unit of measure group. POST /inventory/unit-of-measure-groups
Returns the unit of measure group with the given identifier. GET /inventory/unit-of-measure-groups/{id}
Update Unit Of Measure Group PATCH /inventory/unit-of-measure-groups/{id}
Deletes the unit of measure group with the given identifier. DELETE /inventory/unit-of-measure-groups/{id}
Creates several unit of measure groups in one call. POST /inventory/unit-of-measure-groups/bulk
Deletes several unit of measure groups in one call. POST /inventory/unit-of-measure-groups/bulk-delete
Returns the unit of measure groups that match the given filters. POST /inventory/unit-of-measure-groups/search

Inventory › Units of Measure

Returns a list of units of measure. GET /inventory/unit-of-measures
Creates a unit of measure. POST /inventory/unit-of-measures
Returns the unit of measure with the given identifier. GET /inventory/unit-of-measures/{id}
Update Unit Of Measure PATCH /inventory/unit-of-measures/{id}
Deletes the unit of measure with the given identifier. DELETE /inventory/unit-of-measures/{id}
Creates several units of measure in one call. POST /inventory/unit-of-measures/bulk
Deletes several units of measure in one call. POST /inventory/unit-of-measures/bulk-delete
Returns the units of measure that match the given filters. POST /inventory/unit-of-measures/search

Inventory › Warehouse Transfer Orders

Warehouse Transfer Orders GET /inventory/warehouse-transfer-orders
Create Transfer Order POST /inventory/warehouse-transfer-orders
Get Transfer Order GET /inventory/warehouse-transfer-orders/{id}
Update Transfer Order PATCH /inventory/warehouse-transfer-orders/{id}
Delete Transfer Order DELETE /inventory/warehouse-transfer-orders/{id}
Commit Transfer Order POST /inventory/warehouse-transfer-orders/{id}/commit
Creates several warehouse transfer orders in one call. POST /inventory/warehouse-transfer-orders/bulk
Deletes several draft warehouse transfer orders in one call. POST /inventory/warehouse-transfer-orders/bulk-delete
Returns the warehouse transfer orders that match the given filters. POST /inventory/warehouse-transfer-orders/search

Inventory › Warehouse Transfers

Warehouse Transfers GET /inventory/warehouse-transfers
Create Warehouse Transfer POST /inventory/warehouse-transfers
Get Warehouse Transfer GET /inventory/warehouse-transfers/{id}
Update Warehouse Transfer PATCH /inventory/warehouse-transfers/{id}
Deletes a draft warehouse transfer. DELETE /inventory/warehouse-transfers/{id}
Creates the intercompany bill for a committed intercompany transfer. POST /inventory/warehouse-transfers/{id}/bill
Commit Warehouse Transfer POST /inventory/warehouse-transfers/{id}/commit
Creates several warehouse transfers in one call. POST /inventory/warehouse-transfers/bulk
Deletes several draft warehouse transfers in one call. POST /inventory/warehouse-transfers/bulk-delete
Returns the warehouse transfers that match the given filters. POST /inventory/warehouse-transfers/search

Inventory › Warehouses

Warehouses GET /inventory/warehouses
Creates a warehouse. POST /inventory/warehouses
Returns the warehouse with the given identifier. GET /inventory/warehouses/{id}
Update Warehouse PATCH /inventory/warehouses/{id}
Deletes the warehouse with the given identifier. DELETE /inventory/warehouses/{id}
Creates several warehouses in one call. POST /inventory/warehouses/bulk
Deletes several warehouses in one call. POST /inventory/warehouses/bulk-delete
Returns the warehouses that match the given filters. POST /inventory/warehouses/search

People Management › Absence Types

Absence Types GET /people/absence-types
Returns the absence type with the given identifier. GET /people/absence-types/{id}

People Management › Absences

Absences GET /people/absences
Create Absence POST /people/absences
Returns the absence with the given identifier. GET /people/absences/{id}
Update Absence PATCH /people/absences/{id}
Delete Absence DELETE /people/absences/{id}
Approve Absences POST /people/absences/approve
Reject Absences POST /people/absences/reject
Returns the absences that match the given filters. POST /people/absences/search

People Management › Applicants

Create Applicant POST /applicants

People Management › Applications

Applications GET /applications
Create Application POST /applications

People Management › Departments

Departments GET /departments
Create Department POST /departments
Get Department GET /departments/{id}
Update Department PATCH /departments/{id}

People Management › Document Categories

Returns a list of document categories. GET /people/document-categories

People Management › Documents

Documents GET /people/documents
Upload Document POST /people/documents
Delete Document DELETE /people/documents/{id}
Download Document GET /people/documents/{id}/download

People Management › People

People GET /people
Create Person POST /people
Get Person GET /people/{id}
Update Person PATCH /people/{id}
Returns the people that match the given filters. POST /people/search
Hr/people/created event hr/people/created
A person changed. Carries the id only; re-read for their new state. event hr/people/updated

People Management › Positions

Positions GET /positions
Create Position POST /positions
Get Position GET /positions/{id}
Update Position PATCH /positions/{id}

People Management › Recruitments

Returns a list of recruitments. GET /people/recruitments
Create Recruitment POST /people/recruitments
Get Recruitment GET /people/recruitments/{id}
Update Recruitment PATCH /people/recruitments/{id}

People Management › Teams

Teams GET /people/teams
Create Team POST /people/teams
Get Team GET /people/teams/{id}
Update Team PATCH /people/teams/{id}
Delete Team DELETE /people/teams/{id}

PSA › Activities

Returns a list of activities. GET /psa/activities
Returns the activity with the given identifier. GET /psa/activities/{id}

PSA › Allocations

Returns a list of allocations. GET /psa/allocations
Creates allocations. POST /psa/allocations
Updates allocations. Only the fields in the request body change. PATCH /psa/allocations
Returns the allocation with the given identifier. GET /psa/allocations/{id}
Deletes allocations. POST /psa/allocations/bulk-delete

PSA › Expenses

Returns the expense budgets defined for a PSA project. GET /psa/expenses/budgets
Returns a PSA project's expenses with their budget assignments. GET /psa/expenses/summary

PSA › Fixed Fees

Returns a list of fixed fees. GET /psa/fixed-fees
Returns the fixed fee with the given identifier. GET /psa/fixed-fees/{id}

PSA › Milestones

Returns a list of milestones. GET /psa/milestones
Returns the milestone with the given identifier. GET /psa/milestones/{id}

PSA › Placeholders

Returns a list of placeholders. GET /psa/placeholders
Creates one or more placeholders. Either all are created, or none are. POST /psa/placeholders
Returns the placeholder with the given identifier. GET /psa/placeholders/{id}
Update Placeholder PATCH /psa/placeholders/{id}
Permanently deletes the placeholder with the given identifier. DELETE /psa/placeholders/{id}

PSA › Positions

Returns a list of positions. GET /psa/positions
Returns the position with the given identifier. GET /psa/positions/{id}

PSA › Project Types

Returns a list of project types. GET /psa/project-types
Creates a project type. POST /psa/project-types
Returns the project type with the given identifier. GET /psa/project-types/{id}
Update Project Type PATCH /psa/project-types/{id}
Deletes the project type with the given identifier. DELETE /psa/project-types/{id}
Creates many project types in one call. POST /psa/project-types/bulk

PSA › Projects

Returns a list of PSA projects. GET /psa/projects
Creates a PSA project. POST /psa/projects
Returns the PSA project with the given identifier. GET /psa/projects/{id}
Update Psa Project PATCH /psa/projects/{id}
Deletes the PSA project with the given identifier, archiving it. DELETE /psa/projects/{id}
Deletes PSA projects in bulk, archiving them by default. POST /psa/projects/bulk-delete
Restores archived PSA projects in bulk. POST /psa/projects/bulk-restore

PSA › Team Members

Returns a list of position assignments on PSA project teams. GET /psa/team-member-positions
Returns the position assignment with the given identifier. GET /psa/team-member-positions/{id}
Returns a list of the people on PSA project teams. GET /psa/team-members
Returns the team member with the given identifier. GET /psa/team-members/{id}
Assign Employees To Placeholders POST /psa/team-members/assign-placeholder
Create Team Members POST /psa/team-members/bulk

PSA › Time Entries

Returns a list of time entries. GET /psa/time-entries
Create Time Entries POST /psa/time-entries
Updates the hours or notes of time entries. PATCH /psa/time-entries
Returns the time entry with the given identifier. GET /psa/time-entries/{id}
Approves submitted time entries. POST /psa/time-entries/approve
Deletes the time entries with the given identifiers. POST /psa/time-entries/delete
Rejects submitted time entries. POST /psa/time-entries/reject
Submits draft time entries for approval. POST /psa/time-entries/submit