Configuration
List Financial Alerts
Returns a paginated list of financial alerts (low margin or loss alerts on sales order lines). Uses Spatie QueryBuilder for filtering and sorting.
Create Financial Alert
Creates a new financial alert record. Typically, alerts are auto-generated by the process endpoint, but this allows manual creation.
Update Financial Alert
Updates a financial alert's classification and/or note.
Delete Financial Alert
Deletes a financial alert record.
Archive Alert
Archives (resolves) a single financial alert, recording the archiving user and timestamp.
Unarchive Alert
Unarchives (re-opens) a previously archived financial alert.
Bulk Archive Alerts
Archives multiple financial alerts at once.
Bulk Unarchive Alerts
Unarchives multiple financial alerts at once.
Bulk Update Alerts
Bulk updates the classification and/or note for multiple financial alerts.
Preview Import
Previews an import file for financial alerts before committing. Returns a summary of what will be imported and any errors.
Import Alerts
Imports financial alerts from a CSV/Excel file.
Get Dashboard Data
Returns a summary of archived (resolved) financial alerts grouped by alert type. Used for the financial alerts dashboard overview.
Get Report Data
Returns reporting data for financial alerts including classification breakdown and resolution breakdown. Used for the reports page.
Process Alerts
Triggers the financial alert processing job, which scans all sales order lines for low margin or loss conditions and creates/deletes alerts accordingly.
List Classifications
Returns all financial alert classification categories. Classifications are used to tag alerts with a reason or resolution type (e.g., Pricing Error, Supplier Issue).
Create Classification
Creates a new financial alert classification category.
Get Classification
Returns a single financial alert classification by ID.
Update Classification
Updates a financial alert classification name.
Delete Classification
Deletes a financial alert classification.
List Financial Line Types
Returns all financial line types for the organization.
Create Financial Line Type
Creates a new financial line type.
Bulk Delete Financial Line Types
Bulk deletes multiple financial line types by their IDs.
Show Financial Line Type
Returns a single financial line type by ID.
Update Financial Line Type
Updates an existing financial line type. All fields are optional on update.
Delete Financial Line Type
Deletes a financial line type. Returns 400 if the type has associated financial lines.
List Nominal Codes (DataTable)
List nominal codes using the DataTable system. Supports full-text search across name, code, and type fields.
Create Nominal Code
Create a new nominal code.
Bulk Delete Nominal Codes
Bulk delete multiple nominal codes by ID.
List Nominal Codes (Dropdown)
Returns a lightweight list of all nominal codes (id, name, code only), ordered by code. Intended for dropdown/combo-box lookups.
Show Nominal Code
Show a single nominal code.
Update Nominal Code
Update an existing nominal code.
Delete Nominal Code
Delete a nominal code. Fails if the code is used in mapping settings or linked to sales order lines.
Get Create Form Data
Returns form metadata needed to create a new nominal code (e.g. available types, validation rules).
Get Edit Form Data
Returns form data for editing a specific nominal code.
Archive Nominal Code
Archive a single nominal code.
Unarchive Nominal Code
Unarchive a single nominal code.
Bulk Archive Nominal Codes
Bulk archive multiple nominal codes by ID.
Bulk Unarchive Nominal Codes
Bulk unarchive multiple nominal codes by ID.
Check Deletable
Check which nominal codes can be deleted. A code cannot be deleted if it is linked to sales order lines or used in nominal code mapping settings.
Check Archivable
Check which nominal codes can be archived. A code cannot be archived if it is currently used in the nominal code mapping settings.
Preview Import
Previews an import file for financial alerts before committing. Returns a summary of what will be imported and any errors.
Import Nominal Codes
Import nominal codes from a CSV or Excel file.
List Payment Types
List all payment types. Returns a flat collection (not paginated).
Create Payment Type
Create a new payment type.
Bulk Delete Payment Types
Bulk delete multiple payment types by ID.
Get Payment Type
Retrieve a single payment type by ID.
Update Payment Type
Update an existing payment type.
Delete Payment Type
Delete a payment type. Amazon and Shopify payment types cannot be deleted (system-managed).
Check Deletable
Check which nominal codes can be deleted. A code cannot be deleted if it is linked to sales order lines or used in nominal code mapping settings.
Update Accounting Mapping
Bulk update accounting integration mappings for payment types. Maps each payment type to an external accounting system account.
Archive Payment Type
Archive a single payment type.
Unarchive Payment Type
Unarchive a single payment type.
Bulk Archive Payment Types
Bulk archive multiple payment types.
Bulk Unarchive Payment Types
Bulk unarchive multiple payment types.
List Payment Terms
Returns a paginated list of payment terms.
Create Payment Term
Creates a new payment term.
Bulk Delete Payment Terms
Bulk deletes multiple payment terms by IDs.
Show Payment Term
Returns a single payment term by ID. Includes due_date_type_options in the response for form use.
Update Payment Term
Updates an existing payment term by ID.
Delete Payment Term
Deletes a payment term by ID. Returns an error if the term is linked to purchase orders or suppliers.
Archive Payment Term
Archives a payment term. Returns a warning if already archived.
Unarchive Payment Term
Unarchives a payment term. Returns a warning if not currently archived.
Bulk Archive Payment Terms
Bulk archives multiple payment terms by IDs.
Bulk Unarchive Payment Terms
Bulk unarchives multiple payment terms by IDs.
Check Deletable
Check which nominal codes can be deleted. A code cannot be deleted if it is linked to sales order lines or used in nominal code mapping settings.
List Incoterms
Returns a paginated list of incoterms (International Commercial Terms). Supports search, pagination, and archive filtering.
Create Incoterm
Creates a new incoterm.
Bulk Delete Incoterms
Deletes multiple incoterms in a single request.
Get Incoterm
Returns the details of a single incoterm.
Update Incoterm
Updates the specified incoterm.
Delete Incoterm
Deletes the specified incoterm. Will fail if the incoterm is linked to existing purchase orders or other records.
Archive Incoterm
Archives the specified incoterm by setting its archived_at timestamp.
Unarchive Incoterm
Restores (unarchives) the specified incoterm by clearing its archived_at timestamp.
Get Create Form Data
Returns form metadata needed to create a new nominal code (e.g. available types, validation rules).
Get Edit Form Data
Returns form data for editing a specific nominal code.
Check Deletable
Check which nominal codes can be deleted. A code cannot be deleted if it is linked to sales order lines or used in nominal code mapping settings.
Bulk Archive Incoterms
Archives multiple incoterms.
Bulk Unarchive Incoterms
Restores (unarchives) multiple incoterms.