Actions

[https://www.approvalmax.com/scopes/public\_api/read](https://www.approvalmax.com/scopes/public_api/read) [https://www.approvalmax.com/scopes/public\_api/write](https://www.approvalmax.com/scopes/public_api/write)

64 actions

Action

Description

Required scopes

Get Request Attachment

Download an attachment file from an ApprovalMax approval request

Upload Request Attachment

Upload a file attachment to an ApprovalMax approval request

Delete Request Attachment

Permanently delete an attachment from an ApprovalMax approval request (irreversible)

Get Request Comment Attachment

Download an attachment file from a comment on an ApprovalMax approval request

List Companies

Retrieve all ApprovalMax companies (organisations) accessible to the authenticated user

List NetSuite Vendor Bills

Retrieve NetSuite vendor bills with optional filtering by reference, status, and date ranges. Supports pagination.

Get NetSuite Vendor Bill

Retrieve a single NetSuite vendor bill by its request ID, including line items, attachments, and comments

List NetSuite Purchase Orders

Retrieve NetSuite purchase orders with optional filtering by reference, status, and date ranges. Supports pagination.

Get NetSuite Purchase Order

Retrieve a single NetSuite purchase order by its request ID, including line items, attachments, and comments

List NetSuite Expense Reports

Retrieve NetSuite expense reports with optional filtering by reference, status, and date ranges. Supports pagination.

Get NetSuite Expense Report

Retrieve a single NetSuite expense report by its request ID, including line items, attachments, and comments

List NetSuite Sales Orders

Retrieve NetSuite sales orders with optional filtering by reference, status, and date ranges. Supports pagination.

Get NetSuite Sales Order

Retrieve a single NetSuite sales order by its request ID, including line items, attachments, and comments

List NetSuite Invoices

Retrieve NetSuite invoices with optional filtering by reference, status, and date ranges. Supports pagination.

Get NetSuite Invoice

Retrieve a single NetSuite invoice by its request ID, including line items, attachments, and comments

List NetSuite Bill Payments

Retrieve NetSuite bill payments with optional filtering by reference, status, and date ranges. Supports pagination.

Get NetSuite Bill Payment

Retrieve a single NetSuite bill payment by its request ID, including full payment details and comments

List NetSuite Journal Entries

Retrieve NetSuite journal entries with optional filtering by reference, status, and date ranges. Supports pagination.

Get NetSuite Journal Entry

Retrieve a single NetSuite journal entry by its request ID, including debit/credit lines and comments

List NetSuite Item Receipts

Retrieve NetSuite item receipts with optional filtering by reference, status, and date ranges. Supports pagination.

Get NetSuite Item Receipt

Retrieve a single NetSuite item receipt by its request ID, including line items, attachments, and comments

List QuickBooks Bills

Retrieve QuickBooks Online bills with optional filtering by reference, status, and date ranges. Supports pagination.

Get QuickBooks Bill

Retrieve a single QuickBooks Online bill by its request ID, including line items, attachments, and comments

List QuickBooks Purchase Orders

Retrieve QuickBooks Online purchase orders with optional filtering by reference, status, and date ranges. Supports pagin...

Get QuickBooks Purchase Order

Retrieve a single QuickBooks Online purchase order by its request ID, including line items, attachments, and comments

List QuickBooks Expenses

Retrieve QuickBooks Online expenses with optional filtering by reference, status, and date ranges. Supports pagination.

Get QuickBooks Expense

Retrieve a single QuickBooks Online expense by its request ID, including line items, attachments, and comments

List Standalone Documents

Retrieve standalone documents with optional filtering by reference, status, and date ranges. Supports pagination.

Get Standalone Document

Retrieve a single standalone document by its request ID, including details, attachments, and comments

Create Standalone Document

Create a draft standalone document in ApprovalMax that can then be submitted for approval

Edit Standalone Document

Edit an existing standalone document in ApprovalMax (requires currentVersion for concurrency control)

List Standalone Currencies

Retrieve the supported currency codes for standalone documents in an ApprovalMax company

List Standalone Workflows

Retrieve the approval workflows available for standalone documents in an ApprovalMax company

Submit Standalone Document

Submit a draft standalone document to trigger the configured approval workflow

Mark Xero Purchase Order As Billed

Mark an approved Xero purchase order as billed to close it for matching

List User Profiles

Retrieve all user profiles (members and participants) for an ApprovalMax company

Get User Profile

Retrieve a single user profile by user ID within an ApprovalMax company

List Xero Bills

Retrieve Xero bills with optional filtering by reference, status, and date ranges. Supports pagination.

Get Xero Bill

Retrieve a single Xero bill by its request ID, including line items, attachments, and comments

List Xero Purchase Orders

Retrieve Xero purchase orders with optional filtering by reference, status, and date ranges. Supports pagination.

Get Xero Purchase Order

Retrieve a single Xero purchase order by its request ID, including line items, attachments, and comments

List Xero Batch Payments

Retrieve Xero batch payments with optional filtering by reference, status, and date ranges. Supports pagination.

Get Xero Batch Payment

Retrieve a single Xero batch payment by its request ID, including full payment details and comments

List Xero Credit Notes

Retrieve Xero credit notes with optional filtering by reference, status, and date ranges. Supports pagination.

Get Xero Credit Note

Retrieve a single Xero credit note by its request ID, including line items, attachments, and comments

List Xero Sales Invoices

Retrieve Xero sales invoices with optional filtering by reference, status, and date ranges. Supports pagination.

Get Xero Sales Invoice

Retrieve a single Xero sales invoice by its request ID, including line items, attachments, and comments

List Xero Quotes

Retrieve Xero quotes with optional filtering by reference, status, and date ranges. Supports pagination.

Get Xero Quote

Retrieve a single Xero quote by its request ID, including line items, attachments, and comments

Create Xero Quote

Create a draft Xero quote in ApprovalMax

Edit Xero Quote

Edit an existing Xero quote in ApprovalMax (requires currentVersion for concurrency control)

List Xero Accounts

Retrieve the Xero chart of accounts for use as accountId values in document line items

List Xero Branding Themes

Retrieve Xero branding themes for use as brandingThemeId values in documents

List Xero Contacts

Retrieve Xero contacts (suppliers and customers) for use as contactId values in documents. Supports pagination and filte...

List Xero Currencies

Retrieve Xero currencies configured for the company, for use as currency values in documents

List Xero Items

Retrieve Xero items (products and services) for use as itemId values in document line items. Supports pagination and fil...

List Xero Taxes

Retrieve Xero tax rates for use as taxCode values in document line items

List Xero Tracking Categories

Retrieve Xero tracking categories and their options for line item tracking assignments

Create Xero Bill

Create a draft Xero bill in ApprovalMax

Edit Xero Bill

Edit an existing Xero bill in ApprovalMax (requires currentVersion for concurrency control)

Create Xero Purchase Order

Create a draft Xero purchase order in ApprovalMax that can then be submitted for approval

Edit Xero Purchase Order

Edit an existing Xero purchase order in ApprovalMax (requires currentVersion for concurrency control)

Create Xero Sales Invoice

Create a draft Xero sales invoice in ApprovalMax

Edit Xero Sales Invoice

Edit an existing Xero sales invoice in ApprovalMax (requires currentVersion for concurrency control)