We’re currently experiencing a high volume of support requests, which may result in longer response times — thank you for your patience and understanding.
cancel
Showing results for 
Show  only  | Search instead for 
Did you mean: 

This documentation is for the new preview UI. It’s still being refined and is subject to change. For documentation for the old UI, see Knowledge Base.

Article link copied to clipboard
Updated
Published
18 min read
Note on third‑party tools

We aim to provide accurate and helpful details about third‑party tools, but we can’t guarantee that this information is always complete or up to date. If you notice any discrepancies, feel free to share them in the feedback section below. For the most reliable information, please always refer to the third‑party tool’s official documentation.

Use the Sage Intacct component to manage Invoices, Payments, Vendors, and more.

Connections

Sage Intacct Connection

Web Service Authentication

Web Service Authentication

  1. Web Services credentials consist of a sender ID and password. These are provisioned by Sage Intacct for customers/partners with an active Web Services developer license.
  2. Company credentials consist of either:
    1. A company ID, user ID, and password - this is called login authentication.
    2. A temporary session ID - this is called session authentication.
  3. To Authenticate through Sage Intacct you must establish an API session that provides you with a session ID. The session timeout is calculated based on the session duration specified for the user or company plus the current time.
Input Comments Default
Sender ID Sender ID for Web Services Authentication
Sender Password Sender Password for Web Services Authentication
Company ID Company ID for Web Services Authentication
User ID User ID for Web Services Authentication
User Password User Password for Web Services Authentication
Entity ID Entity ID for Web Services Authentication

Actions

Create AR Advance

Creates a new AR Advance.

Input Comments Default
Connection
Payment Date Date the advance payment was made, in the mm/dd/yyyy format.
Receipt Date Receipt date in the mm/dd/yyyy format. If automatic summaries are enabled, this is the date on which the advance will be posted to the General Ledger.
Payment Method Payment method used for the advance.
AR Advance Items Advance lines, must have at least 1. Check Documentation for additional tags.
Customer ID Unique ID. Required if company does not use document sequencing, or you can provide a value to use instead of the document sequence value.
Financial Entity ID of the checking or savings account to deposit the funds to. A create request must contain FINANCIALENTITY or UNDEPOSITEDACCOUNTNO when automatic summaries are enabled.
Undeposited Account No Undeposited funds account number. A create request must contain FINANCIALENTITY or UNDEPOSITEDACCOUNTNO when automatic summaries are enabled.
Additional XML Tags Additional XML tags that might not be covered by the standard inputs.

Create Bill

Create a new bill.

Input Comments Default
Connection
Bill Transaction Date Transaction date
Bill GL Posting Date General ledger posting date
Vendor ID The vendor ID.
Bill Number A Bill Number identifier
Reference Number A reference number for the bill
Description Description of the bill
Term Name Payment term, this should be a previously created term
Recommended to pay on Payment date
Attachments ID Id of an attachment group of one or more supporting files
Due Date Due date
Payment Priority
On Hold Place this bill on hold
Currency Transaction currency code
Base Currency Base currency code
AP Bill Items AP bill items, must have at least 1. Each item must be wrapped in tags.
10000
<TRX_AMOUNT>100.12</TRX_AMOUNT>
Line 1 of my bill
Alder
12345


10000
<TRX_AMOUNT>100.12</TRX_AMOUNT>
Line 2 of my bill
Alder
12345

Create Contact

Creates a new contact.

Input Comments Default
Connection
Contact Name Contact name to create
Print Name As Determine the format the name should be printed.
Active Status Flag indicating if the status is active
Address Line 1 First line's address
Address Line 2 Second line's address
Cellular Phone Number Cellular phone number
City City name.
Company Name Name of the company
Contact Tax Group Name Name of the tax group
Country Country name.
Fax Number Fax number
First Name First name
Last Name Last name
Middle Name Middle name
Pager Number Pager number
Prefix Prefix for the name
Primary Email Address Primary email address
Primary Phone Number Primary phone number
Primary URL Primary URL
Secondary Email Address Secondary email address
Secondary Phone Number Secondary phone number
Secondary URL Secondary URL
State/Province State or province
Tax ID Tax identification number
Taxable Flag indicating if taxable
ZIP/Postal Code ZIP or postal code.

Create Customer

Creates a customer and specifies a display contact and a contact list (provided via customer contacts).

Input Comments Default
Connection
Customer ID Unique ID. Required if company does not use document sequencing, or you can provide a value to use instead of the document sequence value.
Customer Name Name
One Time One time. Use false for No, true for Yes. If you want to simplify your customer list page by displaying only your regularly-used customers, we recommend you select this option for customers that you use only once or just occasionally. These customers will not appear in the customer list page unless you click Include one-time use at the top of the list page, in which case, you'll see all your customers regardless of frequency of use.
Active Status Flag indicating if the status is active
Last Name Last name
First Name First name
Middle Name Middle name
Prefix Prefix for the name
Company Name Name of the company
Print Name As Determine the format the name should be printed.
Primary Phone Number Primary phone number
Secondary Phone Number Secondary phone number
Cellular Phone Number Cellular phone number
Pager Number Pager number
Fax Number Fax number
Primary Email Address Primary email address
Secondary Email Address Secondary email address
Primary URL Primary URL
Secondary URL Secondary URL
Address Line 1 First line's address
Address Line 2 Second line's address
City City name.
State/Province State or province
ZIP/Postal Code ZIP or postal code.
Country Country name.
ISO Country Code ISO country code. When ISO country codes are enabled in a company, both COUNTRY and ISOCOUNTRYCODE must be provided.
Excluded From Contact List Flag indicating if excluded from contact lists
Customer Type ID Identifier for the type of customer
Sales Rep Employee ID Employee ID of the sales representative
Parent Customer ID Identifier of the parent customer
GL Group Name Name of the GL group
Territory ID Identifier for the territory
Attachments ID Id of an attachment group of one or more supporting files
Payment Term A previously created payment term
Offset AR GL Account No Offset AR GL account number
Default Revenue GL Account No Default AR GL account number
Shipping Method Shipping method
Resale Number Resale number
Taxable Flag indicating if taxable
Contact Tax Group Name Name of the tax group
Tax ID Tax identification number
Credit Limit Credit limit
On Hold Flag indicating if on hold
Delivery Method Delivery method. Use either Print, E-Mail, or Print#~#E-Mail for both. If using E-Mail, the customer contact must have a valid e-mail address.
Default Invoice Message Default message for invoices
Comments Additional comments
Default Currency Default currency code
Print Option AR Invoice Template Name Template name for AR invoices
Print Option OE Quote Template Name Template name for OE quotes
Print Option OE Order Template Name Template name for OE orders
Print Option OE List Template Name Template name for OE lists
Print Option OE Invoice Template Name Template name for OE invoices
Print Option OE Adjustment Template Name Template name for OE adjustments
Print Option OE Other Template Name Template name for other OE documents
Primary Contact Name Primary contact. If blank system will use DISPLAYCONTACT.
Bill To Contact Name Bill to contact. If blank system will use DISPLAYCONTACT.
Ship To Contact Name Ship to contact. If blank system will use DISPLAYCONTACT.
Restriction Type Type of restriction
Restricted Location Restricted location ID. Use if OBJECTRESTRICTION is Restricted
Restricted Department Restricted department IDs. Use if OBJECTRESTRICTION is Restricted
Custom Fields Custom field names and values as defined for this object

Create Invoice

Creates an invoice.

Input Comments Default
Connection
Invoice Line Items Invoice lines, must have at least 1. Each item must be wrapped in tags.
10016
345.43
oriongroup
D200
C12


10016
345.43
oriongroup
D200
C12
Customer ID The customer ID to create the invoice for.
Date Created Invoice date creation date
GL Date Posted Invoice General Ledger posted date
Due Date The due date of the invoice.
Term Name Payment term, this should be a previously created term
Record No A Summary RECORDNO for the invoice.
Invoice Number Invoice number
Reference Number A reference number for the invoice
Description The description of the invoice.
External ID An external ID for the invoice
Bill To Contact Name The name of the contact to bill to. This should be an existing contact in Intacct.
Ship To Contact Name The name of the contact to ship to. This should be an existing contact in Intacct.
Base Currency Base currency code
Currency The currency of the invoice.
Exchange Rate Date Exchange rate date for the invoice
Exchange Rate Type Exchange rate type for the invoice
No GL Do not post to GL. Use false for No, true for Yes.
Attachments ID Id of an attachment group of one or more supporting files
Custom Fields Custom field names and values as defined for this object

Create Project

Creates a new project.

Input Comments Default
Connection
Project Name Project name for the to-be-created object.
Project Category Project category for the to-be-created object.
Project ID Unique ID for the project. Required if company does not use document sequencing, or you can provide a value to use instead of the document sequence value.
Project Description Project description for the to-be-created object.
Parent Project ID Parent project ID for the to-be-created object.
Invoice with Parent Use false for No, true for Yes. (Default: false) false
Project Type Project type for the to-be-created object.
Project Status Project status for the to-be-created object.
Status Use false for Inactive, true for Active. (Default: true) true
Additional Fields Additional fields that are not covered by the standard inputs.

Create Vendor

Creates a new vendor.

Input Comments Default
Connection
Vendor ID Unique ID for the vendor. Required if company does not use document sequencing, or you can provide a value to use instead of the document sequence value.
Vendor Name
One Time One time. Use false for No, true for Yes. If you want to simplify your vendor list page by displaying only your regularly-used vendors, we recommend you select this option for vendors that you use only once or just occasionally. These vendors will not appear in the vendor list page unless you click Include one-time use at the top of the list page, in which case, you'll see all your vendors regardless of frequently of use.
Active Status Flag indicating if the status is active
Last Name Last name
First Name First name
Middle Name Middle name
Prefix Prefix for the name
Company Name Name of the company
Print Name As Determine the format the name should be printed.
Primary Phone Number Primary phone number
Secondary Phone Number Secondary phone number
Cellular Phone Number Cellular phone number
Pager Number Pager number
Fax Number Fax number
Primary Email Address Primary email address
Secondary Email Address Secondary email address
Primary URL Primary URL
Secondary URL Secondary URL
Address Line 1 First line's address
Address Line 2 Second line's address
City City name.
State/Province State or province
ZIP/Postal Code ZIP or postal code.
Country Country name.
ISO Country Code ISO country code. When ISO country codes are enabled in a company, both COUNTRY and ISOCOUNTRYCODE must be provided.
Excluded From Contact List Flag indicating if excluded from contact lists
Vendor Type ID
Parent Vendor ID
GL Group Name Name of the GL group
Tax ID Tax identification number
Form 1099 Name
Form 1099 Type
Form 1099 Box
Attachments ID Id of an attachment group of one or more supporting files
Default Expense GL Account No
Offset GL Account No
Taxable Flag indicating if taxable
Contact Tax Group Name Name of the tax group
Credit Limit Credit limit
On Hold Flag indicating if on hold
Do Not Pay
Comments Additional comments
Default Currency Default currency code
Primary Contact Name Primary contact. If blank system will use DISPLAYCONTACT.
Pay To Contact Name
Return To Contact Name
Preferred Payment Method
Send Automatic Payment Notification
Merge Payment Requests
Vendor Billing Type
Payment Priority
Payment Term A previously created payment term
Term Discount Displayed On Check Stub
ACH Enabled
ACH Bank Routing No
ACH Bank Account No
ACH Bank Account Type
ACH Bank Account Class
Vendor Account No
Location Assigned Account No Displayed On Check Stub
Restriction Type Type of restriction
Restricted Location Restricted location ID. Use if OBJECTRESTRICTION is Restricted
Restricted Department Restricted department IDs. Use if OBJECTRESTRICTION is Restricted
Custom Fields Custom field names and values as defined for this object

Delete Object

Deletes different objects in Sage Intacct.

Input Comments Default
Connection
Object Type of object to delete
Keys A key or comma-separated list (123,456) of keys (RECORDNO's) to delete

Get AP Payment

Retrieve a single AP Payment.

Input Comments Default
Connection
Field Field to retrieve, use * for all fields
Record No Record number

Get AR Adjustment

Retrieve a single AR Adjustment.

Input Comments Default
Connection
Field Field to retrieve, use * for all fields
Record No Record number

Get AR Adjustment Line

Retrieve a single AR Adjustment Line.

Input Comments Default
Connection
Field Field to retrieve, use * for all fields
Record No Record number

Get AR Advance

Retrieve a single AR Advance.

Input Comments Default
Connection
Field Field to retrieve, use * for all fields
Record No Record number

Get AR Payment

Retrieve a single AR Payment.

Input Comments Default
Connection
Field Field to retrieve, use * for all fields
Record No Record number

Get Bill

Retrieve a single bill.

Input Comments Default
Connection
Field Field to retrieve, use * for all fields
Record No Record number

Get Contact

Retrieve a single contact.

Input Comments Default
Connection
Field Field to retrieve, use * for all fields
Record No Record number

Get Customer

Retrieve a single customer.

Input Comments Default
Connection
Field Field to retrieve, use * for all fields
Record No Record number

Get Invoice

Retrieve a single invoice.

Input Comments Default
Connection
Field Field to retrieve, use * for all fields
Record No Record number

Get Project

Retrieve a project by record number.

Input Comments Default
Connection
Field Field to retrieve, use * for all fields
Record No Record number of the project to retrieve.

Get Vendor

Retrieve a single vendor.

Input Comments Default
Connection
Field Field to retrieve, use * for all fields
Record No Record number

Query and List Records

Lists specified criteria based on a query.

Input Comments Default
Connection
Field Field to retrieve, use * for all fields
Object Name Name of the object to query. Possible values are: VENDOR, APBILL, APPYMT, ARPYMT, ARADJUSTMENT, ARADJUSTMENTITEM, ARADVANCE, etc.
Query Query to filter the records

Raw Request

Send raw HTTP request to Sage Intacct

Input Comments Default
Connection
Data The raw XML function to execute. Add the structure as per the Sage Intacct API documentation. For the provided default example, you can check 'Query and List Contacts' function at https://developer.intacct.com/api/company-console/contacts/. Follow this same pattern for any other API function that you want to execute. Authentication is already handled by the action.
CONTACT

Header A list of headers to send with the request. Sage Intacct API is XML based. Content-Type: 'application/xml' header is already added.
Response Type The type of data you expect in the response. You can request json or xml data. json
Array JSON Nodes Always put child nodes from XML in an array. If toggled off, an array is created only if there is more than one. Use this when 'Response Type' is set to 'JSON'. true
Timeout The maximum time that a client will await a response to its request
Retry Delay (ms) The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. 0
Retry On All Errors If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. false
Max Retry Count The maximum number of retries to attempt. Specify 0 for no retries. 0
Use Exponential Backoff Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. false

Update AR Adjustment

Update an existing AR Adjustment.

Input Comments Default
Connection
Record Number AR Adjustment RECORDNO of bill to update.
Customer ID AR Adjustment CUSTOMERID to update.
Date Created AR Adjustment DATECREATED to update.
GL Date Posted AR Adjustment DATEPOSTED to update.
Description AR Adjustment DESCRIPTION to update.
Currency AR Adjustment CURRENCY to update.
Exchange Rate Type AR Adjustment EXCHRATETYPE to update.
Adjustment Number AR Adjustment ADJUSTMENTNO to update.
Invoice Number AR Adjustment INVOICENO to update.
AR Adjustment Line Items AR Adjustment LINEITEMS to update. Each item must be wrapped in or tags.
Action Action. Use Draft or Submit. (Default: Submit)
Additional XML Tags Additional XML tags that might not be covered by the standard inputs.

Update AR Advance

Update an existing AR Advance.

Input Comments Default
Connection
Record No AR Advance RECORDNO to update.
AR Advance Items AR Advance ARADVANCEITEMS to update. Note: To add an advance line, supply all the original lines along with the new one. To delete a line, supply only the lines that you want to keep. To modify a line, supply all the original lines and change the field values you want.
Payment Date AR Advance PAYMENTDATE to update.
Receipt Date AR Advance RECEIPTDATE to update.
Payment Method AR Advance PAYMENTMETHOD to update.
Financial Entity AR Advance FINANCIALENTITY to update.
Undeposited Account No AR Advance UNDEPOSITEDACCOUNTNO to update.
Additional XML Tags Additional XML tags that might not be covered by the standard inputs.

Update Contact

Update an existing contact.

Input Comments Default
Connection
Contact Name Full name of the contact
Print Name As Determine the format the name should be printed.
Active Status Flag indicating if the status is active
Address Line 1 First line's address
Address Line 2 Second line's address
Cellular Phone Number Cellular phone number
City City name.
Company Name Name of the company
Contact Tax Group Name Name of the tax group
Country Country name.
Fax Number Fax number
First Name First name
Last Name Last name
Middle Name Middle name
Pager Number Pager number
Prefix Prefix for the name
Primary Email Address Primary email address
Primary Phone Number Primary phone number
Primary URL Primary URL
Secondary Email Address Secondary email address
Secondary Phone Number Secondary phone number
Secondary URL Secondary URL
State/Province State or province
Tax ID Tax identification number
Taxable Flag indicating if taxable
ZIP/Postal Code ZIP or postal code.

Update Customer

Updates an existing customer in Intacct. The customer is identified by the customer ID.

Input Comments Default
Connection
Customer ID Unique ID. Required if company does not use document sequencing, or you can provide a value to use instead of the document sequence value.
Customer Name Name
One Time One time. Use false for No, true for Yes. If you want to simplify your customer list page by displaying only your regularly-used customers, we recommend you select this option for customers that you use only once or just occasionally. These customers will not appear in the customer list page unless you click Include one-time use at the top of the list page, in which case, you'll see all your customers regardless of frequency of use.
Active Status Flag indicating if the status is active
Last Name Last name
First Name First name
Middle Name Middle name
Prefix Prefix for the name
Company Name Name of the company
Print Name As Determine the format the name should be printed.
Primary Phone Number Primary phone number
Secondary Phone Number Secondary phone number
Cellular Phone Number Cellular phone number
Pager Number Pager number
Fax Number Fax number
Primary Email Address Primary email address
Secondary Email Address Secondary email address
Primary URL Primary URL
Secondary URL Secondary URL
Address Line 1 First line's address
Address Line 2 Second line's address
City City name.
State/Province State or province
ZIP/Postal Code ZIP or postal code.
Country Country name.
ISO Country Code ISO country code. When ISO country codes are enabled in a company, both COUNTRY and ISOCOUNTRYCODE must be provided.
Excluded From Contact List Flag indicating if excluded from contact lists
Customer Type ID Identifier for the type of customer
Sales Rep Employee ID Employee ID of the sales representative
Parent Customer ID Identifier of the parent customer
GL Group Name Name of the GL group
Territory ID Identifier for the territory
Attachments ID Id of an attachment group of one or more supporting files
Payment Term A previously created payment term
Offset AR GL Account No Offset AR GL account number
Default Revenue GL Account No Default AR GL account number
Shipping Method Shipping method
Resale Number Resale number
Taxable Flag indicating if taxable
Contact Tax Group Name Name of the tax group
Tax ID Tax identification number
Credit Limit Credit limit
On Hold Flag indicating if on hold
Delivery Method Delivery method. Use either Print, E-Mail, or Print#~#E-Mail for both. If using E-Mail, the customer contact must have a valid e-mail address.
Default Invoice Message Default message for invoices
Comments Additional comments
Default Currency Default currency code
Print Option AR Invoice Template Name Template name for AR invoices
Print Option OE Quote Template Name Template name for OE quotes
Print Option OE Order Template Name Template name for OE orders
Print Option OE List Template Name Template name for OE lists
Print Option OE Invoice Template Name Template name for OE invoices
Print Option OE Adjustment Template Name Template name for OE adjustments
Print Option OE Other Template Name Template name for other OE documents
Primary Contact Name Primary contact. If blank system will use DISPLAYCONTACT.
Bill To Contact Name Bill to contact. If blank system will use DISPLAYCONTACT.
Ship To Contact Name Ship to contact. If blank system will use DISPLAYCONTACT.
Restriction Type Type of restriction
Restricted Location Restricted location ID. Use if OBJECTRESTRICTION is Restricted
Restricted Department Restricted department IDs. Use if OBJECTRESTRICTION is Restricted
Custom Fields Custom field names and values as defined for this object

Update Invoice

Updates an invoice.

Input Comments Default
Connection
Record Number Invoice RECORDNO to update
Customer ID Unique ID. Required if company does not use document sequencing, or you can provide a value to use instead of the document sequence value.
Date Created Invoice date creation date
GL Date Posted Invoice General Ledger posted date
Date Due Due date. Required if not using termname.
Term Name Payment term, this should be a previously created term
Invoice Number Invoice number
Reference Number A reference number for the invoice
Description The description of the invoice.
Contact Name Full name of the contact
Base Currency Base currency code
Currency Transaction currency code
Exchange Rate Date Exchange rate date for the invoice
Exchange Rate Type The exchange rate type. Do not use if exchrate is set.
Exchange Rate Exchange rate for the invoice. Do not use if Exchange Rate Type is used.
Attachments ID Id of an attachment group of one or more supporting files
Custom Fields Custom field names and values as defined for this object
Invoice Line Items To update an existing line use otherwise to create a new line item use instead.You can mix types in the array.
10016
345.43
oriongroup
D200
C12


10016
345.43
oriongroup
D200
C12

Update Project

Updates an existing project.

Input Comments Default
Connection
Project ID Project ID to update.
Project Name Project name for the to-be-updated object.
Project Category Project category for the to-be-updated object.
Project Description Project description for the to-be-updated object.
Parent Project ID Parent project ID for the to-be-updated object.
Invoice with Parent
Project Type Project type for the to-be-updated object.
Project Status Project status for the to-be-updated object.
Status
Additional Fields Additional fields that are not covered by the standard inputs.

Update Vendor

Updates an existing vendor.

Input Comments Default
Connection
Vendor ID Unique ID for the vendor. Required if company does not use document sequencing, or you can provide a value to use instead of the document sequence value.
Vendor Name
One Time One time. Use false for No, true for Yes. If you want to simplify your vendor list page by displaying only your regularly-used vendors, we recommend you select this option for vendors that you use only once or just occasionally. These vendors will not appear in the vendor list page unless you click Include one-time use at the top of the list page, in which case, you'll see all your vendors regardless of frequently of use.
Active Status Flag indicating if the status is active
Last Name Last name
First Name First name
Middle Name Middle name
Prefix Prefix for the name
Company Name Name of the company
Print Name As Determine the format the name should be printed.
Primary Phone Number Primary phone number
Secondary Phone Number Secondary phone number
Cellular Phone Number Cellular phone number
Pager Number Pager number
Fax Number Fax number
Primary Email Address Primary email address
Secondary Email Address Secondary email address
Primary URL Primary URL
Secondary URL Secondary URL
Address Line 1 First line's address
Address Line 2 Second line's address
City City name.
State/Province State or province
ZIP/Postal Code ZIP or postal code.
Country Country name.
ISO Country Code ISO country code. When ISO country codes are enabled in a company, both COUNTRY and ISOCOUNTRYCODE must be provided.
Excluded From Contact List Flag indicating if excluded from contact lists
Vendor Type ID
Parent Vendor ID
GL Group Name Name of the GL group
Tax ID Tax identification number
Form 1099 Name
Form 1099 Type
Form 1099 Box
Attachments ID Id of an attachment group of one or more supporting files
Default Expense GL Account No
Offset GL Account No
Taxable Flag indicating if taxable
Contact Tax Group Name Name of the tax group
Credit Limit Credit limit
On Hold Flag indicating if on hold
Do Not Pay
Comments Additional comments
Default Currency Default currency code
Primary Contact Name Primary contact. If blank system will use DISPLAYCONTACT.
Pay To Contact Name
Return To Contact Name
Preferred Payment Method
Send Automatic Payment Notification
Merge Payment Requests
Vendor Billing Type
Payment Priority
Payment Term A previously created payment term
Term Discount Displayed On Check Stub
ACH Enabled
ACH Bank Routing No
ACH Bank Account No
ACH Bank Account Type
ACH Bank Account Class
Vendor Account No
Location Assigned Account No Displayed On Check Stub
Restriction Type Type of restriction
Restricted Location Restricted location ID. Use if OBJECTRESTRICTION is Restricted
Restricted Department Restricted department IDs. Use if OBJECTRESTRICTION is Restricted
Custom Fields Custom field names and values as defined for this object