Action Reference for iDocuments Connector

Actions are used by a workflow to to download, upload or inspect data from a system.

Refer to the table below for action details.

Action Name Description Version
Add or Update Expense Add or update an expense. 1.1+
Add or Update Goods Issue Add or update a goods issue document. 1.0+
Add or Update Goods Receipt Note Add or update a goods receipt note. 1.0+
Add or Update Goods Return Note Add or update a goods return note. 1.0+
Add or Update Purchase Invoice Add or update a purchase invoice. 1.0+
Add or Update Purchase Order Add or update a purchase order. 1.0+
Add or Update Purchase Quotation Add or update a purchase quotation. 1.0+
Add or Update Purchase Requisition Add or update a purchase requisition. 1.0+
Add or Update Sales Delivery Add or update a sales delivery. 1.2+
Add or Update Sales Invoice Add or update a sales invoice. 1.2+
Add or Update Sales Order Add or update a sales order. 1.1+
Add or Update Sales Quotation Add or update a sales quotation. 1.1+
Add or Update Sales Return Add or update a sales return. 1.1+
Flag a Purchase Order as Updated Change a specific Purchase Order’s iDocuments status to updated using the route GetChangedSaltBoxUpdate. This should be done after the PO has been processed using other actions. 1.8+
Get a Goods Receipt Note Fetch a goods receipt note with the specified ID. 1.6+
Get a Goods Return Note Fetch a goods return note with the specified ID. 1.6+
Get a Purchase Order Fetch a purchase order with the specified ID. 1.7+
Get a Purchase Requisition Fetch a purchase requisition with the specified ID. 1.6+
Get Attachment Contents Get contents of an attachment. Save action output to a message to allow another message import the attachment contents as a base 64 data string. 1.3+
Get Attachment Metadata Get details about an attachment, such as file format and name. 1.0+
Get Company Settings Get company settings. 1.2+
Get Down Payment Purchase Invoices Fetch a list of down payment purchase invoices, as filtered. 1.4+
Get System Settings Get system settings. 1.3+
Patch Expense Patch the specified expense. 1.1+
Patch Goods Issue Patch a goods issue document. 1.0+
Patch Goods Receipt Note Patch the specified goods receipt note. 1.0+
Patch Goods Return Note Patch the specified goods return note. 1.0+
Patch Purchase Invoice Patch the specified purchase invoice. 1.0+
Patch Purchase Order Patch the specified purchase order. 1.0+
Patch Purchase Quotation Patch the specified purchase quotation. 1.1+
Patch Purchase Requisition Patch the specified purchase requisition. 1.0+
Patch Sales Delivery Patch the specified sales delivery. 1.2+
Patch Sales Invoice Patch the specified sales invoice. 1.2+
Patch Sales Order Patch the specified sales order. 1.1+
Patch Sales Quotation Patch the specified sales quotation. 1.1+
Patch Sales Return Patch the specified sales return. 1.1+

Action Names

Add or Update Expense

Action Name Description Version
Add or Update Expense Add or update an expense. 1.1+

Add or Update Goods Issue

Action Name Description Version
Add or Update Goods Issue Add or update a goods issue document. 1.0+

Add or Update Goods Receipt Note

Action Name Description Version
Add or Update Goods Receipt Note Add or update a goods receipt note. 1.0+

Add or Update Goods Return Note

Action Name Description Version
Add or Update Goods Return Note Add or update a goods return note. 1.0+

Add or Update Purchase Invoice

Action Name Description Version
Add or Update Purchase Invoice Add or update a purchase invoice. 1.0+

Add or Update Purchase Order

Action Name Description Version
Add or Update Purchase Order Add or update a purchase order. 1.0+

Add or Update Purchase Quotation

Action Name Description Version
Add or Update Purchase Quotation Add or update a purchase quotation. 1.0+

Add or Update Purchase Requisition

Action Name Description Version
Add or Update Purchase Requisition Add or update a purchase requisition. 1.0+

Add or Update Sales Delivery

Action Name Description Version
Add or Update Sales Delivery Add or update a sales delivery. 1.2+

Add or Update Sales Invoice

Action Name Description Version
Add or Update Sales Invoice Add or update a sales invoice. 1.2+

Add or Update Sales Order

Action Name Description Version
Add or Update Sales Order Add or update a sales order. 1.1+

Add or Update Sales Quotation

Action Name Description Version
Add or Update Sales Quotation Add or update a sales quotation. 1.1+

Add or Update Sales Return

Action Name Description Version
Add or Update Sales Return Add or update a sales return. 1.1+

Flag a Purchase Order as Updated

Action Name Description Version
Flag a Purchase Order as Updated Change a specific Purchase Order’s iDocuments status to updated using the route GetChangedSaltBoxUpdate. This should be done after the PO has been processed using other actions. 1.8+

Get a Goods Receipt Note

Action Name Description Version
Get a Goods Receipt Note Fetch a goods receipt note with the specified ID. 1.6+

Get a Goods Return Note

Action Name Description Version
Get a Goods Return Note Fetch a goods return note with the specified ID. 1.6+

Get a Purchase Order

Action Name Description Version
Get a Purchase Order Fetch a purchase order with the specified ID. 1.7+

Get a Purchase Requisition

Action Name Description Version
Get a Purchase Requisition Fetch a purchase requisition with the specified ID. 1.6+

Get Attachment Contents

Action Name Description Version
Get Attachment Contents Get contents of an attachment. Save action output to a message to allow another message import the attachment contents as a base 64 data string. 1.3+

Get Attachment Metadata

Action Name Description Version
Get Attachment Metadata Get details about an attachment, such as file format and name. 1.0+

Get Company Settings

Action Name Description Version
Get Company Settings Get company settings. 1.2+

Get Down Payment Purchase Invoices

Action Name Description Version
Get Down Payment Purchase Invoices Fetch a list of down payment purchase invoices, as filtered. 1.4+

Get System Settings

Action Name Description Version
Get System Settings Get system settings. 1.3+

Patch Expense

Action Name Description Version
Patch Expense Patch the specified expense. 1.1+

Patch Goods Issue

Action Name Description Version
Patch Goods Issue Patch a goods issue document. 1.0+

Patch Goods Receipt Note

Action Name Description Version
Patch Goods Receipt Note Patch the specified goods receipt note. 1.0+

Patch Goods Return Note

Action Name Description Version
Patch Goods Return Note Patch the specified goods return note. 1.0+

Patch Purchase Invoice

Action Name Description Version
Patch Purchase Invoice Patch the specified purchase invoice. 1.0+

Patch Purchase Order

Action Name Description Version
Patch Purchase Order Patch the specified purchase order. 1.0+

Patch Purchase Quotation

Action Name Description Version
Patch Purchase Quotation Patch the specified purchase quotation. 1.1+

Patch Purchase Requisition

Action Name Description Version
Patch Purchase Requisition Patch the specified purchase requisition. 1.0+

Patch Sales Delivery

Action Name Description Version
Patch Sales Delivery Patch the specified sales delivery. 1.2+

Patch Sales Invoice

Action Name Description Version
Patch Sales Invoice Patch the specified sales invoice. 1.2+

Patch Sales Order

Action Name Description Version
Patch Sales Order Patch the specified sales order. 1.1+

Patch Sales Quotation

Action Name Description Version
Patch Sales Quotation Patch the specified sales quotation. 1.1+

Patch Sales Return

Action Name Description Version
Patch Sales Return Patch the specified sales return. 1.1+